purecloud-platform-client-v2 134.0.1 → 136.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/README.md +32 -29
- package/dist/node/purecloud-platform-client-v2.js +637 -214
- package/dist/web-amd/purecloud-platform-client-v2.js +637 -214
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +637 -214
- package/dist/web-cjs/purecloud-platform-client-v2.js +647 -225
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +895 -425
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +50 -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/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 +5 -5
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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 +29 -29
- 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/IntegrationsApi.js +11 -9
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -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/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 +226 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +132 -5
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
- package/src/purecloud-platform-client-v2/api/SearchApi.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/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 +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 +51 -51
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@ import Configuration from './configuration.js';
|
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6
|
-
* @version
|
|
6
|
+
* @version 136.1.0
|
|
7
7
|
*/
|
|
8
8
|
class ApiClient {
|
|
9
9
|
/**
|
|
@@ -950,7 +950,7 @@ class ApiClient {
|
|
|
950
950
|
|
|
951
951
|
// set header parameters
|
|
952
952
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
953
|
-
//request.set({ 'purecloud-sdk': '
|
|
953
|
+
//request.set({ 'purecloud-sdk': '136.1.0' });
|
|
954
954
|
|
|
955
955
|
// set request timeout
|
|
956
956
|
request.timeout(that.timeout);
|
|
@@ -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 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1769,6 +1769,35 @@ class ArchitectApi {
|
|
|
1769
1769
|
);
|
|
1770
1770
|
}
|
|
1771
1771
|
|
|
1772
|
+
/**
|
|
1773
|
+
* Fetch Architect Job Status
|
|
1774
|
+
*
|
|
1775
|
+
* @param {String} jobId Job ID
|
|
1776
|
+
* @param {Object} opts Optional parameters
|
|
1777
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
1778
|
+
*/
|
|
1779
|
+
getFlowsJob(jobId, opts) {
|
|
1780
|
+
opts = opts || {};
|
|
1781
|
+
|
|
1782
|
+
// verify the required parameter 'jobId' is set
|
|
1783
|
+
if (jobId === undefined || jobId === null) {
|
|
1784
|
+
throw 'Missing the required parameter "jobId" when calling getFlowsJob';
|
|
1785
|
+
}
|
|
1786
|
+
|
|
1787
|
+
return this.apiClient.callApi(
|
|
1788
|
+
'/api/v2/flows/jobs/{jobId}',
|
|
1789
|
+
'GET',
|
|
1790
|
+
{ 'jobId': jobId },
|
|
1791
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1792
|
+
{ },
|
|
1793
|
+
{ },
|
|
1794
|
+
null,
|
|
1795
|
+
['PureCloud OAuth'],
|
|
1796
|
+
['application/json'],
|
|
1797
|
+
['application/json']
|
|
1798
|
+
);
|
|
1799
|
+
}
|
|
1800
|
+
|
|
1772
1801
|
/**
|
|
1773
1802
|
* Get a flow milestone
|
|
1774
1803
|
* Returns a specified flow milestone
|
|
@@ -2571,6 +2600,26 @@ class ArchitectApi {
|
|
|
2571
2600
|
);
|
|
2572
2601
|
}
|
|
2573
2602
|
|
|
2603
|
+
/**
|
|
2604
|
+
* Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
|
|
2605
|
+
*
|
|
2606
|
+
*/
|
|
2607
|
+
postFlowsJobs() {
|
|
2608
|
+
|
|
2609
|
+
return this.apiClient.callApi(
|
|
2610
|
+
'/api/v2/flows/jobs',
|
|
2611
|
+
'POST',
|
|
2612
|
+
{ },
|
|
2613
|
+
{ },
|
|
2614
|
+
{ },
|
|
2615
|
+
{ },
|
|
2616
|
+
null,
|
|
2617
|
+
['PureCloud OAuth'],
|
|
2618
|
+
['application/json'],
|
|
2619
|
+
['application/json']
|
|
2620
|
+
);
|
|
2621
|
+
}
|
|
2622
|
+
|
|
2574
2623
|
/**
|
|
2575
2624
|
* Create a flow milestone
|
|
2576
2625
|
*
|
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1910,7 +1910,7 @@ class ConversationsApi {
|
|
|
1910
1910
|
/**
|
|
1911
1911
|
* Get a list of Messaging Stickers
|
|
1912
1912
|
*
|
|
1913
|
-
* @param {
|
|
1913
|
+
* @param {Object} messengerType Messenger Type
|
|
1914
1914
|
* @param {Object} opts Optional parameters
|
|
1915
1915
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1916
1916
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -2098,7 +2098,7 @@ class ConversationsApi {
|
|
|
2098
2098
|
}
|
|
2099
2099
|
|
|
2100
2100
|
/**
|
|
2101
|
-
* Update a conversation by setting
|
|
2101
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2102
2102
|
*
|
|
2103
2103
|
* @param {String} conversationId conversationId
|
|
2104
2104
|
* @param {Object} body Conversation
|
|
@@ -3084,8 +3084,8 @@ class ConversationsApi {
|
|
|
3084
3084
|
}
|
|
3085
3085
|
|
|
3086
3086
|
/**
|
|
3087
|
-
* Update or activate a WhatsApp messaging integration
|
|
3088
|
-
* The following steps are required in order to fully activate a
|
|
3087
|
+
* Update or activate a WhatsApp messaging integration
|
|
3088
|
+
* The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
3089
3089
|
* @param {String} integrationId Integration ID
|
|
3090
3090
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
3091
3091
|
*/
|
|
@@ -5,7 +5,7 @@ class GamificationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Gamification service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -251,18 +251,18 @@ class GamificationApi {
|
|
|
251
251
|
/**
|
|
252
252
|
* Performance profile by id
|
|
253
253
|
*
|
|
254
|
-
* @param {String} performanceProfileId
|
|
254
|
+
* @param {String} profileId performanceProfileId
|
|
255
255
|
*/
|
|
256
|
-
getGamificationProfile(
|
|
257
|
-
// verify the required parameter '
|
|
258
|
-
if (
|
|
259
|
-
throw 'Missing the required parameter "
|
|
256
|
+
getGamificationProfile(profileId) {
|
|
257
|
+
// verify the required parameter 'profileId' is set
|
|
258
|
+
if (profileId === undefined || profileId === null) {
|
|
259
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
260
260
|
}
|
|
261
261
|
|
|
262
262
|
return this.apiClient.callApi(
|
|
263
|
-
'/api/v2/gamification/profiles/{
|
|
263
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
264
264
|
'GET',
|
|
265
|
-
{ '
|
|
265
|
+
{ 'profileId': profileId },
|
|
266
266
|
{ },
|
|
267
267
|
{ },
|
|
268
268
|
{ },
|
|
@@ -1105,18 +1105,18 @@ class GamificationApi {
|
|
|
1105
1105
|
/**
|
|
1106
1106
|
* Activate a performance profile
|
|
1107
1107
|
*
|
|
1108
|
-
* @param {String} performanceProfileId
|
|
1108
|
+
* @param {String} profileId performanceProfileId
|
|
1109
1109
|
*/
|
|
1110
|
-
postGamificationProfileActivate(
|
|
1111
|
-
// verify the required parameter '
|
|
1112
|
-
if (
|
|
1113
|
-
throw 'Missing the required parameter "
|
|
1110
|
+
postGamificationProfileActivate(profileId) {
|
|
1111
|
+
// verify the required parameter 'profileId' is set
|
|
1112
|
+
if (profileId === undefined || profileId === null) {
|
|
1113
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
1114
1114
|
}
|
|
1115
1115
|
|
|
1116
1116
|
return this.apiClient.callApi(
|
|
1117
|
-
'/api/v2/gamification/profiles/{
|
|
1117
|
+
'/api/v2/gamification/profiles/{profileId}/activate',
|
|
1118
1118
|
'POST',
|
|
1119
|
-
{ '
|
|
1119
|
+
{ 'profileId': profileId },
|
|
1120
1120
|
{ },
|
|
1121
1121
|
{ },
|
|
1122
1122
|
{ },
|
|
@@ -1130,18 +1130,18 @@ class GamificationApi {
|
|
|
1130
1130
|
/**
|
|
1131
1131
|
* Deactivate a performance profile
|
|
1132
1132
|
*
|
|
1133
|
-
* @param {String} performanceProfileId
|
|
1133
|
+
* @param {String} profileId performanceProfileId
|
|
1134
1134
|
*/
|
|
1135
|
-
postGamificationProfileDeactivate(
|
|
1136
|
-
// verify the required parameter '
|
|
1137
|
-
if (
|
|
1138
|
-
throw 'Missing the required parameter "
|
|
1135
|
+
postGamificationProfileDeactivate(profileId) {
|
|
1136
|
+
// verify the required parameter 'profileId' is set
|
|
1137
|
+
if (profileId === undefined || profileId === null) {
|
|
1138
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
1139
1139
|
}
|
|
1140
1140
|
|
|
1141
1141
|
return this.apiClient.callApi(
|
|
1142
|
-
'/api/v2/gamification/profiles/{
|
|
1142
|
+
'/api/v2/gamification/profiles/{profileId}/deactivate',
|
|
1143
1143
|
'POST',
|
|
1144
|
-
{ '
|
|
1144
|
+
{ 'profileId': profileId },
|
|
1145
1145
|
{ },
|
|
1146
1146
|
{ },
|
|
1147
1147
|
{ },
|
|
@@ -1343,22 +1343,22 @@ class GamificationApi {
|
|
|
1343
1343
|
/**
|
|
1344
1344
|
* Updates a performance profile
|
|
1345
1345
|
*
|
|
1346
|
-
* @param {String} performanceProfileId
|
|
1346
|
+
* @param {String} profileId performanceProfileId
|
|
1347
1347
|
* @param {Object} opts Optional parameters
|
|
1348
1348
|
* @param {Object} opts.body performanceProfile
|
|
1349
1349
|
*/
|
|
1350
|
-
putGamificationProfile(
|
|
1350
|
+
putGamificationProfile(profileId, opts) {
|
|
1351
1351
|
opts = opts || {};
|
|
1352
1352
|
|
|
1353
|
-
// verify the required parameter '
|
|
1354
|
-
if (
|
|
1355
|
-
throw 'Missing the required parameter "
|
|
1353
|
+
// verify the required parameter 'profileId' is set
|
|
1354
|
+
if (profileId === undefined || profileId === null) {
|
|
1355
|
+
throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
|
|
1356
1356
|
}
|
|
1357
1357
|
|
|
1358
1358
|
return this.apiClient.callApi(
|
|
1359
|
-
'/api/v2/gamification/profiles/{
|
|
1359
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
1360
1360
|
'PUT',
|
|
1361
|
-
{ '
|
|
1361
|
+
{ 'profileId': profileId },
|
|
1362
1362
|
{ },
|
|
1363
1363
|
{ },
|
|
1364
1364
|
{ },
|
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -423,9 +423,10 @@ class IntegrationsApi {
|
|
|
423
423
|
* @param {String} opts.previousPage Previous page token
|
|
424
424
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
425
425
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
426
|
-
* @param {String} opts.category Filter by category name
|
|
427
|
-
* @param {String} opts.name Filter by
|
|
428
|
-
* @param {
|
|
426
|
+
* @param {String} opts.category Filter by category name.
|
|
427
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
428
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
429
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
429
430
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
430
431
|
*/
|
|
431
432
|
getIntegrationsActions(opts) {
|
|
@@ -436,7 +437,7 @@ class IntegrationsApi {
|
|
|
436
437
|
'/api/v2/integrations/actions',
|
|
437
438
|
'GET',
|
|
438
439
|
{ },
|
|
439
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
440
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
440
441
|
{ },
|
|
441
442
|
{ },
|
|
442
443
|
null,
|
|
@@ -486,9 +487,10 @@ class IntegrationsApi {
|
|
|
486
487
|
* @param {String} opts.previousPage Previous page token
|
|
487
488
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
488
489
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
489
|
-
* @param {String} opts.category Filter by category name
|
|
490
|
-
* @param {String} opts.name Filter by
|
|
491
|
-
* @param {
|
|
490
|
+
* @param {String} opts.category Filter by category name.
|
|
491
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
492
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
493
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
492
494
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
493
495
|
*/
|
|
494
496
|
getIntegrationsActionsDrafts(opts) {
|
|
@@ -499,7 +501,7 @@ class IntegrationsApi {
|
|
|
499
501
|
'/api/v2/integrations/actions/drafts',
|
|
500
502
|
'GET',
|
|
501
503
|
{ },
|
|
502
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
504
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
503
505
|
{ },
|
|
504
506
|
{ },
|
|
505
507
|
null,
|