purecloud-platform-client-v2 169.1.0 → 170.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 +6 -4
- package/dist/node/purecloud-platform-client-v2.js +774 -365
- package/dist/web-amd/purecloud-platform-client-v2.js +774 -365
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +774 -365
- package/dist/web-cjs/purecloud-platform-client-v2.js +774 -365
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +211 -35
- 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 +44 -44
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
- 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 +4 -4
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +362 -7
- 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/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 +5 -5
- 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 +9 -9
- 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 +41 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -45
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -29
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
- 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 +6 -6
- 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 +8 -8
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +69 -16
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +16 -16
- 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 +13 -13
- 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 +5 -5
- 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 +50 -46
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +3 -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 +13 -13
- 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 +6 -6
- 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 +6 -6
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class MessagingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Messaging service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,7 @@ class MessagingApi {
|
|
|
24
24
|
* Delete a supported content profile
|
|
25
25
|
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
26
26
|
* @param {String} supportedContentId Supported Content ID
|
|
27
|
-
|
|
27
|
+
* @deprecated
|
|
28
28
|
*/
|
|
29
29
|
deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
30
30
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -52,7 +52,7 @@ class MessagingApi {
|
|
|
52
52
|
* @param {Object} opts Optional parameters
|
|
53
53
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
54
54
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
55
|
-
|
|
55
|
+
* @deprecated
|
|
56
56
|
*/
|
|
57
57
|
getMessagingSupportedcontent(opts) {
|
|
58
58
|
opts = opts || {};
|
|
@@ -76,7 +76,7 @@ class MessagingApi {
|
|
|
76
76
|
* Get a supported content profile
|
|
77
77
|
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
78
78
|
* @param {String} supportedContentId Supported Content ID
|
|
79
|
-
|
|
79
|
+
* @deprecated
|
|
80
80
|
*/
|
|
81
81
|
getMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
82
82
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -103,7 +103,7 @@ class MessagingApi {
|
|
|
103
103
|
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
104
104
|
* @param {String} supportedContentId Supported Content ID
|
|
105
105
|
* @param {Object} body SupportedContent
|
|
106
|
-
|
|
106
|
+
* @deprecated
|
|
107
107
|
*/
|
|
108
108
|
patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
|
|
109
109
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -133,7 +133,7 @@ class MessagingApi {
|
|
|
133
133
|
* Create a Supported Content profile
|
|
134
134
|
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
135
135
|
* @param {Object} body SupportedContent
|
|
136
|
-
|
|
136
|
+
* @deprecated
|
|
137
137
|
*/
|
|
138
138
|
postMessagingSupportedcontent(body) {
|
|
139
139
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class OrganizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Organization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,7 @@ class OrganizationApi {
|
|
|
24
24
|
* Fetch field config for an entity type
|
|
25
25
|
*
|
|
26
26
|
* @param {Object} type Field type
|
|
27
|
-
|
|
27
|
+
* @deprecated
|
|
28
28
|
*/
|
|
29
29
|
getFieldconfig(type) {
|
|
30
30
|
// verify the required parameter 'type' is set
|
|
@@ -69,7 +69,7 @@ class OrganizationApi {
|
|
|
69
69
|
/**
|
|
70
70
|
* Get the list of domains that will be allowed to embed PureCloud applications
|
|
71
71
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
72
|
-
|
|
72
|
+
* @deprecated
|
|
73
73
|
*/
|
|
74
74
|
getOrganizationsEmbeddedintegration() {
|
|
75
75
|
|
|
@@ -90,7 +90,7 @@ class OrganizationApi {
|
|
|
90
90
|
/**
|
|
91
91
|
* Get organization IP address whitelist settings
|
|
92
92
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
93
|
-
|
|
93
|
+
* @deprecated
|
|
94
94
|
*/
|
|
95
95
|
getOrganizationsIpaddressauthentication() {
|
|
96
96
|
|
|
@@ -279,7 +279,7 @@ class OrganizationApi {
|
|
|
279
279
|
/**
|
|
280
280
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
281
281
|
*
|
|
282
|
-
|
|
282
|
+
* @deprecated
|
|
283
283
|
*/
|
|
284
284
|
getOrganizationsWhitelist() {
|
|
285
285
|
|
|
@@ -356,7 +356,7 @@ class OrganizationApi {
|
|
|
356
356
|
* Update the list of domains that will be allowed to embed PureCloud applications
|
|
357
357
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
358
358
|
* @param {Object} body Whitelist settings
|
|
359
|
-
|
|
359
|
+
* @deprecated
|
|
360
360
|
*/
|
|
361
361
|
putOrganizationsEmbeddedintegration(body) {
|
|
362
362
|
// verify the required parameter 'body' is set
|
|
@@ -382,7 +382,7 @@ class OrganizationApi {
|
|
|
382
382
|
* Update organization IP address whitelist settings
|
|
383
383
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
384
384
|
* @param {Object} body IP address Whitelist settings
|
|
385
|
-
|
|
385
|
+
* @deprecated
|
|
386
386
|
*/
|
|
387
387
|
putOrganizationsIpaddressauthentication(body) {
|
|
388
388
|
// verify the required parameter 'body' is set
|
|
@@ -432,7 +432,7 @@ class OrganizationApi {
|
|
|
432
432
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
433
433
|
*
|
|
434
434
|
* @param {Object} body Whitelist settings
|
|
435
|
-
|
|
435
|
+
* @deprecated
|
|
436
436
|
*/
|
|
437
437
|
putOrganizationsWhitelist(body) {
|
|
438
438
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* OrganizationAuthorization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -199,7 +199,7 @@ class OrganizationAuthorizationApi {
|
|
|
199
199
|
* Delete Bulk Org Trustees
|
|
200
200
|
*
|
|
201
201
|
* @param {Array.<String>} id Comma separated list of trustee ids to remove
|
|
202
|
-
*
|
|
202
|
+
* deleteOrgauthorizationTrustees is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
203
203
|
*/
|
|
204
204
|
deleteOrgauthorizationTrustees(id) {
|
|
205
205
|
// verify the required parameter 'id' is set
|
|
@@ -340,7 +340,7 @@ class OrganizationAuthorizationApi {
|
|
|
340
340
|
* Delete Bulk Org Trustors
|
|
341
341
|
*
|
|
342
342
|
* @param {Array.<String>} id Comma separated list of trustor ids to remove
|
|
343
|
-
*
|
|
343
|
+
* deleteOrgauthorizationTrustors is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
344
344
|
*/
|
|
345
345
|
deleteOrgauthorizationTrustors(id) {
|
|
346
346
|
// verify the required parameter 'id' is set
|
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2490,7 +2490,7 @@ class OutboundApi {
|
|
|
2490
2490
|
* This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
|
|
2491
2491
|
* @param {String} campaignId Campaign ID
|
|
2492
2492
|
* @param {Object} body ContactCallbackRequest
|
|
2493
|
-
|
|
2493
|
+
* @deprecated
|
|
2494
2494
|
*/
|
|
2495
2495
|
postOutboundCampaignCallbackSchedule(campaignId, body) {
|
|
2496
2496
|
// verify the required parameter 'campaignId' is set
|
|
@@ -5,7 +5,7 @@ class PresenceApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Presence service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,12 +24,12 @@ class PresenceApi {
|
|
|
24
24
|
* Delete a Presence Definition
|
|
25
25
|
*
|
|
26
26
|
* @param {String} definitionId Presence Definition ID
|
|
27
|
-
*
|
|
27
|
+
* deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
deletePresenceDefinition0(definitionId) {
|
|
30
30
|
// verify the required parameter 'definitionId' is set
|
|
31
31
|
if (definitionId === undefined || definitionId === null) {
|
|
32
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
32
|
+
throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
|
|
33
33
|
}
|
|
34
34
|
|
|
35
35
|
return this.apiClient.callApi(
|
|
@@ -100,12 +100,12 @@ class PresenceApi {
|
|
|
100
100
|
* Get a Presence Definition
|
|
101
101
|
*
|
|
102
102
|
* @param {String} definitionId Presence Definition ID
|
|
103
|
-
*
|
|
103
|
+
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
104
104
|
*/
|
|
105
|
-
|
|
105
|
+
getPresenceDefinition0(definitionId) {
|
|
106
106
|
// verify the required parameter 'definitionId' is set
|
|
107
107
|
if (definitionId === undefined || definitionId === null) {
|
|
108
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
108
|
+
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
109
109
|
}
|
|
110
110
|
|
|
111
111
|
return this.apiClient.callApi(
|
|
@@ -128,9 +128,9 @@ class PresenceApi {
|
|
|
128
128
|
* @param {Object} opts Optional parameters
|
|
129
129
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
130
130
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
131
|
-
*
|
|
131
|
+
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
132
132
|
*/
|
|
133
|
-
|
|
133
|
+
getPresenceDefinitions0(opts) {
|
|
134
134
|
opts = opts || {};
|
|
135
135
|
|
|
136
136
|
|
|
@@ -373,6 +373,59 @@ class PresenceApi {
|
|
|
373
373
|
);
|
|
374
374
|
}
|
|
375
375
|
|
|
376
|
+
/**
|
|
377
|
+
* Get bulk user presences for a single presence source
|
|
378
|
+
*
|
|
379
|
+
* @param {String} sourceId The requested presence source ID.
|
|
380
|
+
* @param {Object} opts Optional parameters
|
|
381
|
+
* @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
|
|
382
|
+
*/
|
|
383
|
+
getUsersPresenceBulk(sourceId, opts) {
|
|
384
|
+
opts = opts || {};
|
|
385
|
+
|
|
386
|
+
// verify the required parameter 'sourceId' is set
|
|
387
|
+
if (sourceId === undefined || sourceId === null) {
|
|
388
|
+
throw 'Missing the required parameter "sourceId" when calling getUsersPresenceBulk';
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
return this.apiClient.callApi(
|
|
392
|
+
'/api/v2/users/presences/{sourceId}/bulk',
|
|
393
|
+
'GET',
|
|
394
|
+
{ 'sourceId': sourceId },
|
|
395
|
+
{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
396
|
+
{ },
|
|
397
|
+
{ },
|
|
398
|
+
null,
|
|
399
|
+
['PureCloud OAuth'],
|
|
400
|
+
['application/json'],
|
|
401
|
+
['application/json']
|
|
402
|
+
);
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
/**
|
|
406
|
+
* Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
|
|
407
|
+
*
|
|
408
|
+
* @param {Object} opts Optional parameters
|
|
409
|
+
* @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
|
|
410
|
+
*/
|
|
411
|
+
getUsersPresencesPurecloudBulk(opts) {
|
|
412
|
+
opts = opts || {};
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
return this.apiClient.callApi(
|
|
416
|
+
'/api/v2/users/presences/purecloud/bulk',
|
|
417
|
+
'GET',
|
|
418
|
+
{ },
|
|
419
|
+
{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
420
|
+
{ },
|
|
421
|
+
{ },
|
|
422
|
+
null,
|
|
423
|
+
['PureCloud OAuth'],
|
|
424
|
+
['application/json'],
|
|
425
|
+
['application/json']
|
|
426
|
+
);
|
|
427
|
+
}
|
|
428
|
+
|
|
376
429
|
/**
|
|
377
430
|
* Patch a user's Presence
|
|
378
431
|
* Patch a users presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -442,12 +495,12 @@ class PresenceApi {
|
|
|
442
495
|
* Create a Presence Definition
|
|
443
496
|
*
|
|
444
497
|
* @param {Object} body The Presence Definition to create
|
|
445
|
-
*
|
|
498
|
+
* postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
446
499
|
*/
|
|
447
|
-
|
|
500
|
+
postPresenceDefinitions0(body) {
|
|
448
501
|
// verify the required parameter 'body' is set
|
|
449
502
|
if (body === undefined || body === null) {
|
|
450
|
-
throw 'Missing the required parameter "body" when calling
|
|
503
|
+
throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
|
|
451
504
|
}
|
|
452
505
|
|
|
453
506
|
return this.apiClient.callApi(
|
|
@@ -519,16 +572,16 @@ class PresenceApi {
|
|
|
519
572
|
*
|
|
520
573
|
* @param {String} definitionId Presence Definition ID
|
|
521
574
|
* @param {Object} body The updated Presence Definition
|
|
522
|
-
*
|
|
575
|
+
* putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
523
576
|
*/
|
|
524
|
-
|
|
577
|
+
putPresenceDefinition0(definitionId, body) {
|
|
525
578
|
// verify the required parameter 'definitionId' is set
|
|
526
579
|
if (definitionId === undefined || definitionId === null) {
|
|
527
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
580
|
+
throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
|
|
528
581
|
}
|
|
529
582
|
// verify the required parameter 'body' is set
|
|
530
583
|
if (body === undefined || body === null) {
|
|
531
|
-
throw 'Missing the required parameter "body" when calling
|
|
584
|
+
throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
|
|
532
585
|
}
|
|
533
586
|
|
|
534
587
|
return this.apiClient.callApi(
|
|
@@ -5,7 +5,7 @@ class QualityApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Quality service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -88,7 +88,7 @@ class QualityApi {
|
|
|
88
88
|
* Delete an evaluation form.
|
|
89
89
|
*
|
|
90
90
|
* @param {String} formId Form ID
|
|
91
|
-
|
|
91
|
+
* @deprecated
|
|
92
92
|
*/
|
|
93
93
|
deleteQualityForm(formId) {
|
|
94
94
|
// verify the required parameter 'formId' is set
|
|
@@ -164,7 +164,7 @@ class QualityApi {
|
|
|
164
164
|
* Get status for async query for evaluation aggregates
|
|
165
165
|
*
|
|
166
166
|
* @param {String} jobId jobId
|
|
167
|
-
*
|
|
167
|
+
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
168
168
|
*/
|
|
169
169
|
getAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
170
170
|
// verify the required parameter 'jobId' is set
|
|
@@ -192,7 +192,7 @@ class QualityApi {
|
|
|
192
192
|
* @param {String} jobId jobId
|
|
193
193
|
* @param {Object} opts Optional parameters
|
|
194
194
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
195
|
-
*
|
|
195
|
+
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
196
196
|
*/
|
|
197
197
|
getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
|
|
198
198
|
opts = opts || {};
|
|
@@ -220,7 +220,7 @@ class QualityApi {
|
|
|
220
220
|
* Get status for async query for survey aggregates
|
|
221
221
|
*
|
|
222
222
|
* @param {String} jobId jobId
|
|
223
|
-
*
|
|
223
|
+
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
224
224
|
*/
|
|
225
225
|
getAnalyticsSurveysAggregatesJob(jobId) {
|
|
226
226
|
// verify the required parameter 'jobId' is set
|
|
@@ -248,7 +248,7 @@ class QualityApi {
|
|
|
248
248
|
* @param {String} jobId jobId
|
|
249
249
|
* @param {Object} opts Optional parameters
|
|
250
250
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
251
|
-
*
|
|
251
|
+
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
252
252
|
*/
|
|
253
253
|
getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
|
|
254
254
|
opts = opts || {};
|
|
@@ -569,7 +569,7 @@ class QualityApi {
|
|
|
569
569
|
* Get an evaluation form
|
|
570
570
|
*
|
|
571
571
|
* @param {String} formId Form ID
|
|
572
|
-
|
|
572
|
+
* @deprecated
|
|
573
573
|
*/
|
|
574
574
|
getQualityForm(formId) {
|
|
575
575
|
// verify the required parameter 'formId' is set
|
|
@@ -598,7 +598,7 @@ class QualityApi {
|
|
|
598
598
|
* @param {Object} opts Optional parameters
|
|
599
599
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
600
600
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
601
|
-
|
|
601
|
+
* @deprecated
|
|
602
602
|
*/
|
|
603
603
|
getQualityFormVersions(formId, opts) {
|
|
604
604
|
opts = opts || {};
|
|
@@ -634,7 +634,7 @@ class QualityApi {
|
|
|
634
634
|
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
635
635
|
* @param {String} opts.name Name
|
|
636
636
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
637
|
-
|
|
637
|
+
* @deprecated
|
|
638
638
|
*/
|
|
639
639
|
getQualityForms(opts) {
|
|
640
640
|
opts = opts || {};
|
|
@@ -910,7 +910,7 @@ class QualityApi {
|
|
|
910
910
|
* Get the published evaluation forms.
|
|
911
911
|
*
|
|
912
912
|
* @param {String} formId Form ID
|
|
913
|
-
|
|
913
|
+
* @deprecated
|
|
914
914
|
*/
|
|
915
915
|
getQualityPublishedform(formId) {
|
|
916
916
|
// verify the required parameter 'formId' is set
|
|
@@ -940,7 +940,7 @@ class QualityApi {
|
|
|
940
940
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
941
941
|
* @param {String} opts.name Name
|
|
942
942
|
* @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
|
|
943
|
-
|
|
943
|
+
* @deprecated
|
|
944
944
|
*/
|
|
945
945
|
getQualityPublishedforms(opts) {
|
|
946
946
|
opts = opts || {};
|
|
@@ -1148,7 +1148,7 @@ class QualityApi {
|
|
|
1148
1148
|
* Query for evaluation aggregates asynchronously
|
|
1149
1149
|
*
|
|
1150
1150
|
* @param {Object} body query
|
|
1151
|
-
*
|
|
1151
|
+
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1152
1152
|
*/
|
|
1153
1153
|
postAnalyticsEvaluationsAggregatesJobs(body) {
|
|
1154
1154
|
// verify the required parameter 'body' is set
|
|
@@ -1199,7 +1199,7 @@ class QualityApi {
|
|
|
1199
1199
|
* Query for survey aggregates asynchronously
|
|
1200
1200
|
*
|
|
1201
1201
|
* @param {Object} body query
|
|
1202
|
-
*
|
|
1202
|
+
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1203
1203
|
*/
|
|
1204
1204
|
postAnalyticsSurveysAggregatesJobs(body) {
|
|
1205
1205
|
// verify the required parameter 'body' is set
|
|
@@ -1388,7 +1388,7 @@ class QualityApi {
|
|
|
1388
1388
|
* Create an evaluation form.
|
|
1389
1389
|
*
|
|
1390
1390
|
* @param {Object} body Evaluation form
|
|
1391
|
-
|
|
1391
|
+
* @deprecated
|
|
1392
1392
|
*/
|
|
1393
1393
|
postQualityForms(body) {
|
|
1394
1394
|
// verify the required parameter 'body' is set
|
|
@@ -1464,7 +1464,7 @@ class QualityApi {
|
|
|
1464
1464
|
* Publish an evaluation form.
|
|
1465
1465
|
*
|
|
1466
1466
|
* @param {Object} body Publish request containing id of form to publish
|
|
1467
|
-
|
|
1467
|
+
* @deprecated
|
|
1468
1468
|
*/
|
|
1469
1469
|
postQualityPublishedforms(body) {
|
|
1470
1470
|
// verify the required parameter 'body' is set
|
|
@@ -1635,7 +1635,7 @@ class QualityApi {
|
|
|
1635
1635
|
*
|
|
1636
1636
|
* @param {String} formId Form ID
|
|
1637
1637
|
* @param {Object} body Evaluation form
|
|
1638
|
-
|
|
1638
|
+
* @deprecated
|
|
1639
1639
|
*/
|
|
1640
1640
|
putQualityForm(formId, body) {
|
|
1641
1641
|
// verify the required parameter 'formId' is set
|
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -239,7 +239,7 @@ class RoutingApi {
|
|
|
239
239
|
*
|
|
240
240
|
* @param {String} queueId Queue ID
|
|
241
241
|
* @param {String} memberId Member ID
|
|
242
|
-
|
|
242
|
+
* @deprecated
|
|
243
243
|
*/
|
|
244
244
|
deleteRoutingQueueUser(queueId, memberId) {
|
|
245
245
|
// verify the required parameter 'queueId' is set
|
|
@@ -466,7 +466,7 @@ class RoutingApi {
|
|
|
466
466
|
* @param {String} tagId Utilization Tag ID
|
|
467
467
|
* @param {Object} opts Optional parameters
|
|
468
468
|
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
469
|
-
*
|
|
469
|
+
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
470
470
|
*/
|
|
471
471
|
deleteRoutingUtilizationTag(tagId, opts) {
|
|
472
472
|
opts = opts || {};
|
|
@@ -1361,7 +1361,7 @@ class RoutingApi {
|
|
|
1361
1361
|
* @param {Array.<String>} opts.languages Filter by language
|
|
1362
1362
|
* @param {Array.<String>} opts.routingStatus Filter by routing status
|
|
1363
1363
|
* @param {Array.<String>} opts.presence Filter by presence
|
|
1364
|
-
|
|
1364
|
+
* @deprecated
|
|
1365
1365
|
*/
|
|
1366
1366
|
getRoutingQueueUsers(queueId, opts) {
|
|
1367
1367
|
opts = opts || {};
|
|
@@ -1953,7 +1953,7 @@ class RoutingApi {
|
|
|
1953
1953
|
* Get details about this utilization tag
|
|
1954
1954
|
*
|
|
1955
1955
|
* @param {String} tagId Utilization Tag ID
|
|
1956
|
-
*
|
|
1956
|
+
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1957
1957
|
*/
|
|
1958
1958
|
getRoutingUtilizationTag(tagId) {
|
|
1959
1959
|
// verify the required parameter 'tagId' is set
|
|
@@ -1979,7 +1979,7 @@ class RoutingApi {
|
|
|
1979
1979
|
* Get list of agent ids associated with a utilization tag
|
|
1980
1980
|
*
|
|
1981
1981
|
* @param {String} tagId Utilization Tag ID
|
|
1982
|
-
*
|
|
1982
|
+
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1983
1983
|
*/
|
|
1984
1984
|
getRoutingUtilizationTagAgents(tagId) {
|
|
1985
1985
|
// verify the required parameter 'tagId' is set
|
|
@@ -2009,7 +2009,7 @@ class RoutingApi {
|
|
|
2009
2009
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2010
2010
|
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
2011
2011
|
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
2012
|
-
*
|
|
2012
|
+
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2013
2013
|
*/
|
|
2014
2014
|
getRoutingUtilizationTags(opts) {
|
|
2015
2015
|
opts = opts || {};
|
|
@@ -2399,7 +2399,7 @@ class RoutingApi {
|
|
|
2399
2399
|
* @param {String} queueId Queue ID
|
|
2400
2400
|
* @param {String} memberId Member ID
|
|
2401
2401
|
* @param {Object} body Queue Member
|
|
2402
|
-
|
|
2402
|
+
* @deprecated
|
|
2403
2403
|
*/
|
|
2404
2404
|
patchRoutingQueueUser(queueId, memberId, body) {
|
|
2405
2405
|
// verify the required parameter 'queueId' is set
|
|
@@ -2434,7 +2434,7 @@ class RoutingApi {
|
|
|
2434
2434
|
*
|
|
2435
2435
|
* @param {String} queueId Queue ID
|
|
2436
2436
|
* @param {Array.<Object>} body Queue Members
|
|
2437
|
-
|
|
2437
|
+
* @deprecated
|
|
2438
2438
|
*/
|
|
2439
2439
|
patchRoutingQueueUsers(queueId, body) {
|
|
2440
2440
|
// verify the required parameter 'queueId' is set
|
|
@@ -2711,7 +2711,7 @@ class RoutingApi {
|
|
|
2711
2711
|
* @param {Object} opts Optional parameters
|
|
2712
2712
|
* @param {Number} opts.pageSize The desired page size
|
|
2713
2713
|
* @param {Number} opts.pageNumber The desired page number
|
|
2714
|
-
*
|
|
2714
|
+
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2715
2715
|
*/
|
|
2716
2716
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
2717
2717
|
opts = opts || {};
|
|
@@ -3007,7 +3007,7 @@ class RoutingApi {
|
|
|
3007
3007
|
* @param {Array.<Object>} body Queue Members
|
|
3008
3008
|
* @param {Object} opts Optional parameters
|
|
3009
3009
|
* @param {Boolean} opts._delete True to delete queue members (default to false)
|
|
3010
|
-
|
|
3010
|
+
* @deprecated
|
|
3011
3011
|
*/
|
|
3012
3012
|
postRoutingQueueUsers(queueId, body, opts) {
|
|
3013
3013
|
opts = opts || {};
|
|
@@ -3223,7 +3223,7 @@ class RoutingApi {
|
|
|
3223
3223
|
* Imports a phone number for SMS
|
|
3224
3224
|
*
|
|
3225
3225
|
* @param {Object} body SmsPhoneNumber
|
|
3226
|
-
*
|
|
3226
|
+
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3227
3227
|
*/
|
|
3228
3228
|
postRoutingSmsPhonenumbersImport(body) {
|
|
3229
3229
|
// verify the required parameter 'body' is set
|
|
@@ -3249,7 +3249,7 @@ class RoutingApi {
|
|
|
3249
3249
|
* Create an utilization tag
|
|
3250
3250
|
*
|
|
3251
3251
|
* @param {Object} body UtilizationTag
|
|
3252
|
-
*
|
|
3252
|
+
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3253
3253
|
*/
|
|
3254
3254
|
postRoutingUtilizationTags(body) {
|
|
3255
3255
|
// verify the required parameter 'body' is set
|