purecloud-platform-client-v2 167.0.0 → 168.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +336 -126
- package/dist/web-amd/purecloud-platform-client-v2.js +336 -126
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +336 -126
- package/dist/web-cjs/purecloud-platform-client-v2.js +336 -126
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +212 -12
- 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 +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +75 -0
- 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 +32 -1
- 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 +2 -2
- 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 +69 -4
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- 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 +26 -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 +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +3 -2
- 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/ScriptsApi.js +1 -1
- 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 -46
- package/src/purecloud-platform-client-v2/api/SuggestApi.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 +64 -6
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -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 168.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -3270,6 +3270,37 @@ class ConversationsApi {
|
|
|
3270
3270
|
);
|
|
3271
3271
|
}
|
|
3272
3272
|
|
|
3273
|
+
/**
|
|
3274
|
+
* Reset conversation draft to its initial state and/or auto-fill draft content
|
|
3275
|
+
*
|
|
3276
|
+
* @param {String} conversationId conversationId
|
|
3277
|
+
* @param {Object} opts Optional parameters
|
|
3278
|
+
* @param {Boolean} opts.autoFill autoFill
|
|
3279
|
+
* @param {Boolean} opts.discard discard
|
|
3280
|
+
* @param {Object} opts.body Draft Manipulation Request
|
|
3281
|
+
*/
|
|
3282
|
+
patchConversationsEmailMessagesDraft(conversationId, opts) {
|
|
3283
|
+
opts = opts || {};
|
|
3284
|
+
|
|
3285
|
+
// verify the required parameter 'conversationId' is set
|
|
3286
|
+
if (conversationId === undefined || conversationId === null) {
|
|
3287
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailMessagesDraft';
|
|
3288
|
+
}
|
|
3289
|
+
|
|
3290
|
+
return this.apiClient.callApi(
|
|
3291
|
+
'/api/v2/conversations/emails/{conversationId}/messages/draft',
|
|
3292
|
+
'PATCH',
|
|
3293
|
+
{ 'conversationId': conversationId },
|
|
3294
|
+
{ 'autoFill': opts['autoFill'],'discard': opts['discard'] },
|
|
3295
|
+
{ },
|
|
3296
|
+
{ },
|
|
3297
|
+
opts['body'],
|
|
3298
|
+
['PureCloud OAuth'],
|
|
3299
|
+
['application/json'],
|
|
3300
|
+
['application/json']
|
|
3301
|
+
);
|
|
3302
|
+
}
|
|
3303
|
+
|
|
3273
3304
|
/**
|
|
3274
3305
|
* Update conversation participant
|
|
3275
3306
|
*
|
|
@@ -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 168.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1549,7 +1549,7 @@ class ExternalContactsApi {
|
|
|
1549
1549
|
|
|
1550
1550
|
/**
|
|
1551
1551
|
* Merge two contacts into a new contact record
|
|
1552
|
-
*
|
|
1552
|
+
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
1553
1553
|
* @param {Object} body MergeRequest
|
|
1554
1554
|
*/
|
|
1555
1555
|
postExternalcontactsMergeContacts(body) {
|
|
@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* InfrastructureAsCode service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 168.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,68 @@ class InfrastructureAsCodeApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Get information about an accelerator
|
|
25
|
+
* Get the complete metadata specification for an accelerator, including requirements and parameters.
|
|
26
|
+
* @param {String} acceleratorId Accelerator ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object} opts.preferredLanguage Preferred Language (default to en-US)
|
|
29
|
+
*/
|
|
30
|
+
getInfrastructureascodeAccelerator(acceleratorId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
33
|
+
// verify the required parameter 'acceleratorId' is set
|
|
34
|
+
if (acceleratorId === undefined || acceleratorId === null) {
|
|
35
|
+
throw 'Missing the required parameter "acceleratorId" when calling getInfrastructureascodeAccelerator';
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
return this.apiClient.callApi(
|
|
39
|
+
'/api/v2/infrastructureascode/accelerators/{acceleratorId}',
|
|
40
|
+
'GET',
|
|
41
|
+
{ 'acceleratorId': acceleratorId },
|
|
42
|
+
{ 'preferredLanguage': opts['preferredLanguage'] },
|
|
43
|
+
{ },
|
|
44
|
+
{ },
|
|
45
|
+
null,
|
|
46
|
+
['PureCloud OAuth'],
|
|
47
|
+
['application/json'],
|
|
48
|
+
['application/json']
|
|
49
|
+
);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Get a list of available accelerators
|
|
54
|
+
* Search for accelerators that can be run.
|
|
55
|
+
* @param {Object} opts Optional parameters
|
|
56
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
57
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
58
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
59
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
60
|
+
* @param {String} opts.name Filter by name
|
|
61
|
+
* @param {String} opts.description Filter by description
|
|
62
|
+
* @param {Object} opts.origin Filter by origin
|
|
63
|
+
* @param {Object} opts.type Filter by type
|
|
64
|
+
* @param {String} opts.classification Filter by classification
|
|
65
|
+
* @param {String} opts.tags Filter by tags
|
|
66
|
+
*/
|
|
67
|
+
getInfrastructureascodeAccelerators(opts) {
|
|
68
|
+
opts = opts || {};
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
return this.apiClient.callApi(
|
|
72
|
+
'/api/v2/infrastructureascode/accelerators',
|
|
73
|
+
'GET',
|
|
74
|
+
{ },
|
|
75
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'origin': opts['origin'],'type': opts['type'],'classification': opts['classification'],'tags': opts['tags'] },
|
|
76
|
+
{ },
|
|
77
|
+
{ },
|
|
78
|
+
null,
|
|
79
|
+
['PureCloud OAuth'],
|
|
80
|
+
['application/json'],
|
|
81
|
+
['application/json']
|
|
82
|
+
);
|
|
83
|
+
}
|
|
84
|
+
|
|
23
85
|
/**
|
|
24
86
|
* Get job status and results
|
|
25
87
|
* Get the execution status of a submitted job, optionally including results and error details.
|
|
@@ -55,8 +117,11 @@ class InfrastructureAsCodeApi {
|
|
|
55
117
|
* @param {Object} opts Optional parameters
|
|
56
118
|
* @param {Number} opts.maxResults Number of jobs to show (default to 1)
|
|
57
119
|
* @param {Boolean} opts.includeErrors Include error messages (default to false)
|
|
58
|
-
* @param {Object} opts.sortBy Sort by (default to
|
|
59
|
-
* @param {Object} opts.sortOrder Sort order (default to
|
|
120
|
+
* @param {Object} opts.sortBy Sort by (default to dateSubmitted)
|
|
121
|
+
* @param {Object} opts.sortOrder Sort order (default to desc)
|
|
122
|
+
* @param {String} opts.acceleratorId Find only jobs associated with this accelerator
|
|
123
|
+
* @param {String} opts.submittedBy Find only jobs submitted by this user
|
|
124
|
+
* @param {Object} opts.status Find only jobs in this state
|
|
60
125
|
*/
|
|
61
126
|
getInfrastructureascodeJobs(opts) {
|
|
62
127
|
opts = opts || {};
|
|
@@ -66,7 +131,7 @@ class InfrastructureAsCodeApi {
|
|
|
66
131
|
'/api/v2/infrastructureascode/jobs',
|
|
67
132
|
'GET',
|
|
68
133
|
{ },
|
|
69
|
-
{ 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
134
|
+
{ 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'acceleratorId': opts['acceleratorId'],'submittedBy': opts['submittedBy'],'status': opts['status'] },
|
|
70
135
|
{ },
|
|
71
136
|
{ },
|
|
72
137
|
null,
|
|
@@ -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 168.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1769,6 +1769,31 @@ class OutboundApi {
|
|
|
1769
1769
|
);
|
|
1770
1770
|
}
|
|
1771
1771
|
|
|
1772
|
+
/**
|
|
1773
|
+
* Get messaging campaign diagnostics
|
|
1774
|
+
*
|
|
1775
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
1776
|
+
*/
|
|
1777
|
+
getOutboundMessagingcampaignDiagnostics(messagingCampaignId) {
|
|
1778
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
1779
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
1780
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignDiagnostics';
|
|
1781
|
+
}
|
|
1782
|
+
|
|
1783
|
+
return this.apiClient.callApi(
|
|
1784
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics',
|
|
1785
|
+
'GET',
|
|
1786
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
1787
|
+
{ },
|
|
1788
|
+
{ },
|
|
1789
|
+
{ },
|
|
1790
|
+
null,
|
|
1791
|
+
['PureCloud OAuth'],
|
|
1792
|
+
['application/json'],
|
|
1793
|
+
['application/json']
|
|
1794
|
+
);
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1772
1797
|
/**
|
|
1773
1798
|
* Get messaging campaign's progress
|
|
1774
1799
|
*
|
|
@@ -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 168.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1426,7 +1426,7 @@ class QualityApi {
|
|
|
1426
1426
|
* @param {String} evaluationId evaluationId
|
|
1427
1427
|
* @param {Object} body evaluation
|
|
1428
1428
|
* @param {Object} opts Optional parameters
|
|
1429
|
-
* @param {String} opts.expand evaluatorId, evaluationForm
|
|
1429
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
1430
1430
|
*/
|
|
1431
1431
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
1432
1432
|
opts = opts || {};
|
|
@@ -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 168.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -312,7 +312,7 @@ class RecordingApi {
|
|
|
312
312
|
}
|
|
313
313
|
|
|
314
314
|
/**
|
|
315
|
-
* Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if recording:recording:view permission is missing.
|
|
315
|
+
* Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.
|
|
316
316
|
*
|
|
317
317
|
* @param {String} conversationId Conversation ID
|
|
318
318
|
*/
|
|
@@ -5,7 +5,7 @@ class ResponseManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ResponseManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 168.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -102,6 +102,7 @@ class ResponseManagementApi {
|
|
|
102
102
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
103
103
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
104
104
|
* @param {Object} opts.messagingTemplateFilter Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel
|
|
105
|
+
* @param {String} opts.libraryPrefix Returns a list of libraries that contain the prefix provided
|
|
105
106
|
*/
|
|
106
107
|
getResponsemanagementLibraries(opts) {
|
|
107
108
|
opts = opts || {};
|
|
@@ -111,7 +112,7 @@ class ResponseManagementApi {
|
|
|
111
112
|
'/api/v2/responsemanagement/libraries',
|
|
112
113
|
'GET',
|
|
113
114
|
{ },
|
|
114
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'messagingTemplateFilter': opts['messagingTemplateFilter'] },
|
|
115
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'messagingTemplateFilter': opts['messagingTemplateFilter'],'libraryPrefix': opts['libraryPrefix'] },
|
|
115
116
|
{ },
|
|
116
117
|
{ },
|
|
117
118
|
null,
|