purecloud-platform-client-v2 214.0.0 → 216.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 +31 -3
- package/dist/node/purecloud-platform-client-v2.js +649 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +649 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +272 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +283 -158
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +490 -255
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/AbstractHttpClient.js +29 -0
- package/src/purecloud-platform-client-v2/ApiClient.js +21 -1
- package/src/purecloud-platform-client-v2/DefaultHttpClient.js +41 -0
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +379 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +9 -4
- 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 +21 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- 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 +1 -1
- 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/LogCaptureApi.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/OperationalEventsApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -31
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +3 -3
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- 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 +1 -1
- 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 +70 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class ExternalContactsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ExternalContacts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 216.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -745,8 +745,12 @@ class ExternalContactsApi {
|
|
|
745
745
|
* Get job based on id
|
|
746
746
|
*
|
|
747
747
|
* @param {String} jobId Job id
|
|
748
|
+
* @param {Object} opts Optional parameters
|
|
749
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
748
750
|
*/
|
|
749
|
-
getExternalcontactsImportJob(jobId) {
|
|
751
|
+
getExternalcontactsImportJob(jobId, opts) {
|
|
752
|
+
opts = opts || {};
|
|
753
|
+
|
|
750
754
|
// verify the required parameter 'jobId' is set
|
|
751
755
|
if (jobId === undefined || jobId === null) {
|
|
752
756
|
throw 'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';
|
|
@@ -756,7 +760,7 @@ class ExternalContactsApi {
|
|
|
756
760
|
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
757
761
|
'GET',
|
|
758
762
|
{ 'jobId': jobId },
|
|
759
|
-
{
|
|
763
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
760
764
|
{ },
|
|
761
765
|
{ },
|
|
762
766
|
null,
|
|
@@ -770,6 +774,7 @@ class ExternalContactsApi {
|
|
|
770
774
|
* List jobs for organization
|
|
771
775
|
*
|
|
772
776
|
* @param {Object} opts Optional parameters
|
|
777
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
773
778
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
774
779
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
775
780
|
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
@@ -783,7 +788,7 @@ class ExternalContactsApi {
|
|
|
783
788
|
'/api/v2/externalcontacts/import/jobs',
|
|
784
789
|
'GET',
|
|
785
790
|
{ },
|
|
786
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
791
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
787
792
|
{ },
|
|
788
793
|
{ },
|
|
789
794
|
null,
|
|
@@ -5,7 +5,7 @@ class JourneyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Journey service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 216.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1145,6 +1145,26 @@ class JourneyApi {
|
|
|
1145
1145
|
);
|
|
1146
1146
|
}
|
|
1147
1147
|
|
|
1148
|
+
/**
|
|
1149
|
+
* Get details about the data available for journey queries including oldest and newest event dates
|
|
1150
|
+
*
|
|
1151
|
+
*/
|
|
1152
|
+
getJourneyViewsDataDetails() {
|
|
1153
|
+
|
|
1154
|
+
return this.apiClient.callApi(
|
|
1155
|
+
'/api/v2/journey/views/data/details',
|
|
1156
|
+
'GET',
|
|
1157
|
+
{ },
|
|
1158
|
+
{ },
|
|
1159
|
+
{ },
|
|
1160
|
+
{ },
|
|
1161
|
+
null,
|
|
1162
|
+
['PureCloud OAuth'],
|
|
1163
|
+
['application/json'],
|
|
1164
|
+
['application/json']
|
|
1165
|
+
);
|
|
1166
|
+
}
|
|
1167
|
+
|
|
1148
1168
|
/**
|
|
1149
1169
|
* Get an Event Definition
|
|
1150
1170
|
*
|
|
@@ -5,7 +5,7 @@ class RecordingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Recording service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 216.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -995,36 +995,6 @@ class RecordingApi {
|
|
|
995
995
|
);
|
|
996
996
|
}
|
|
997
997
|
|
|
998
|
-
/**
|
|
999
|
-
* Update a screen recording session
|
|
1000
|
-
* This API is deprecated and the functionality to stop screen recording will be no longer supported.
|
|
1001
|
-
* @param {String} recordingSessionId Screen recording session ID
|
|
1002
|
-
* @param {Object} opts Optional parameters
|
|
1003
|
-
* @param {Object} opts.body
|
|
1004
|
-
* @deprecated
|
|
1005
|
-
*/
|
|
1006
|
-
patchRecordingsScreensession(recordingSessionId, opts) {
|
|
1007
|
-
opts = opts || {};
|
|
1008
|
-
|
|
1009
|
-
// verify the required parameter 'recordingSessionId' is set
|
|
1010
|
-
if (recordingSessionId === undefined || recordingSessionId === null) {
|
|
1011
|
-
throw 'Missing the required parameter "recordingSessionId" when calling patchRecordingsScreensession';
|
|
1012
|
-
}
|
|
1013
|
-
|
|
1014
|
-
return this.apiClient.callApi(
|
|
1015
|
-
'/api/v2/recordings/screensessions/{recordingSessionId}',
|
|
1016
|
-
'PATCH',
|
|
1017
|
-
{ 'recordingSessionId': recordingSessionId },
|
|
1018
|
-
{ },
|
|
1019
|
-
{ },
|
|
1020
|
-
{ },
|
|
1021
|
-
opts['body'],
|
|
1022
|
-
['PureCloud OAuth'],
|
|
1023
|
-
['application/json'],
|
|
1024
|
-
['application/json']
|
|
1025
|
-
);
|
|
1026
|
-
}
|
|
1027
|
-
|
|
1028
998
|
/**
|
|
1029
999
|
* Create annotation
|
|
1030
1000
|
*
|
|
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SpeechTextAnalytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 216.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -173,12 +173,12 @@ class SpeechTextAnalyticsApi {
|
|
|
173
173
|
* Get the list of Speech and Text Analytics categories
|
|
174
174
|
*
|
|
175
175
|
* @param {Object} opts Optional parameters
|
|
176
|
-
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is
|
|
176
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 25. (default to 25)
|
|
177
177
|
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
178
178
|
* @param {String} opts.name The category name filter applied to the listing
|
|
179
179
|
* @param {Object} opts.sortOrder The sort order for the listing (default to asc)
|
|
180
180
|
* @param {Object} opts.sortBy The field to sort by for the listing (default to name)
|
|
181
|
-
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of
|
|
181
|
+
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 25 IDs allowed.
|
|
182
182
|
*/
|
|
183
183
|
getSpeechandtextanalyticsCategories(opts) {
|
|
184
184
|
opts = opts || {};
|