purecloud-platform-client-v2 229.2.0 → 230.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +381 -112
- package/dist/web-amd/purecloud-platform-client-v2.js +381 -112
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +161 -93
- package/dist/web-cjs/purecloud-platform-client-v2.js +161 -93
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +425 -287
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +110 -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 -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/BusinessRulesApi.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 +86 -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 +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 +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/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 +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -28
- 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 +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 +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 +101 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -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 230.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1058,7 +1058,7 @@ class RecordingApi {
|
|
|
1058
1058
|
|
|
1059
1059
|
/**
|
|
1060
1060
|
* Create a recording bulk job.
|
|
1061
|
-
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.
|
|
1061
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected. It is recommended to query over smaller time periods so your request does not time out.
|
|
1062
1062
|
* @param {Object} body query
|
|
1063
1063
|
*/
|
|
1064
1064
|
postRecordingJobs(body) {
|
|
@@ -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 230.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -989,31 +989,6 @@ class RoutingApi {
|
|
|
989
989
|
);
|
|
990
990
|
}
|
|
991
991
|
|
|
992
|
-
/**
|
|
993
|
-
* Search a domain across organizations
|
|
994
|
-
*
|
|
995
|
-
* @param {String} domainId domain ID
|
|
996
|
-
*/
|
|
997
|
-
getRoutingEmailOutboundDomainSearch(domainId) {
|
|
998
|
-
// verify the required parameter 'domainId' is set
|
|
999
|
-
if (domainId === undefined || domainId === null || domainId === '') {
|
|
1000
|
-
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';
|
|
1001
|
-
}
|
|
1002
|
-
|
|
1003
|
-
return this.apiClient.callApi(
|
|
1004
|
-
'/api/v2/routing/email/outbound/domains/{domainId}/search',
|
|
1005
|
-
'GET',
|
|
1006
|
-
{ 'domainId': domainId },
|
|
1007
|
-
{ },
|
|
1008
|
-
{ },
|
|
1009
|
-
{ },
|
|
1010
|
-
null,
|
|
1011
|
-
['PureCloud OAuth'],
|
|
1012
|
-
['application/json'],
|
|
1013
|
-
['application/json']
|
|
1014
|
-
);
|
|
1015
|
-
}
|
|
1016
|
-
|
|
1017
992
|
/**
|
|
1018
993
|
* Get outbound domains
|
|
1019
994
|
*
|
|
@@ -3248,8 +3223,8 @@ class RoutingApi {
|
|
|
3248
3223
|
}
|
|
3249
3224
|
|
|
3250
3225
|
/**
|
|
3251
|
-
* Tests the custom SMTP server integration connection set on this domain
|
|
3252
|
-
* The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.
|
|
3226
|
+
* Tests the custom SMTP server integration connection set on this ACD domain
|
|
3227
|
+
* The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.
|
|
3253
3228
|
* @param {String} domainId domain ID
|
|
3254
3229
|
* @param {Object} opts Optional parameters
|
|
3255
3230
|
* @param {Object} opts.body TestMessage
|
|
@@ -5,7 +5,7 @@ class WebMessagingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WebMessaging service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 230.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,36 @@ class WebMessagingApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Delete device information
|
|
25
|
+
*
|
|
26
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
27
|
+
* @param {String} tokenId Device token id or cookie id
|
|
28
|
+
*/
|
|
29
|
+
deleteWebmessagingDeploymentPushdevice(deploymentId, tokenId) {
|
|
30
|
+
// verify the required parameter 'deploymentId' is set
|
|
31
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
32
|
+
throw 'Missing the required parameter "deploymentId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
33
|
+
}
|
|
34
|
+
// verify the required parameter 'tokenId' is set
|
|
35
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
36
|
+
throw 'Missing the required parameter "tokenId" when calling deleteWebmessagingDeploymentPushdevice';
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
return this.apiClient.callApi(
|
|
40
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
41
|
+
'DELETE',
|
|
42
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
43
|
+
{ },
|
|
44
|
+
{ },
|
|
45
|
+
{ },
|
|
46
|
+
null,
|
|
47
|
+
['PureCloud OAuth'],
|
|
48
|
+
['application/json'],
|
|
49
|
+
['application/json']
|
|
50
|
+
);
|
|
51
|
+
}
|
|
52
|
+
|
|
23
53
|
/**
|
|
24
54
|
* Get the messages for a web messaging session.
|
|
25
55
|
*
|
|
@@ -45,6 +75,76 @@ class WebMessagingApi {
|
|
|
45
75
|
);
|
|
46
76
|
}
|
|
47
77
|
|
|
78
|
+
/**
|
|
79
|
+
* Edit device information
|
|
80
|
+
*
|
|
81
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
82
|
+
* @param {String} tokenId Device token id or cookie id
|
|
83
|
+
* @param {Object} body Request body
|
|
84
|
+
*/
|
|
85
|
+
patchWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
86
|
+
// verify the required parameter 'deploymentId' is set
|
|
87
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
88
|
+
throw 'Missing the required parameter "deploymentId" when calling patchWebmessagingDeploymentPushdevice';
|
|
89
|
+
}
|
|
90
|
+
// verify the required parameter 'tokenId' is set
|
|
91
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
92
|
+
throw 'Missing the required parameter "tokenId" when calling patchWebmessagingDeploymentPushdevice';
|
|
93
|
+
}
|
|
94
|
+
// verify the required parameter 'body' is set
|
|
95
|
+
if (body === undefined || body === null) {
|
|
96
|
+
throw 'Missing the required parameter "body" when calling patchWebmessagingDeploymentPushdevice';
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
return this.apiClient.callApi(
|
|
100
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
101
|
+
'PATCH',
|
|
102
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
103
|
+
{ },
|
|
104
|
+
{ },
|
|
105
|
+
{ },
|
|
106
|
+
body,
|
|
107
|
+
['PureCloud OAuth'],
|
|
108
|
+
['application/json'],
|
|
109
|
+
['application/json']
|
|
110
|
+
);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* Add a new device information
|
|
115
|
+
*
|
|
116
|
+
* @param {String} deploymentId WebMessaging deployment id
|
|
117
|
+
* @param {String} tokenId Device token id or cookie id
|
|
118
|
+
* @param {Object} body Request body
|
|
119
|
+
*/
|
|
120
|
+
postWebmessagingDeploymentPushdevice(deploymentId, tokenId, body) {
|
|
121
|
+
// verify the required parameter 'deploymentId' is set
|
|
122
|
+
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
123
|
+
throw 'Missing the required parameter "deploymentId" when calling postWebmessagingDeploymentPushdevice';
|
|
124
|
+
}
|
|
125
|
+
// verify the required parameter 'tokenId' is set
|
|
126
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
127
|
+
throw 'Missing the required parameter "tokenId" when calling postWebmessagingDeploymentPushdevice';
|
|
128
|
+
}
|
|
129
|
+
// verify the required parameter 'body' is set
|
|
130
|
+
if (body === undefined || body === null) {
|
|
131
|
+
throw 'Missing the required parameter "body" when calling postWebmessagingDeploymentPushdevice';
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
return this.apiClient.callApi(
|
|
135
|
+
'/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}',
|
|
136
|
+
'POST',
|
|
137
|
+
{ 'deploymentId': deploymentId,'tokenId': tokenId },
|
|
138
|
+
{ },
|
|
139
|
+
{ },
|
|
140
|
+
{ },
|
|
141
|
+
body,
|
|
142
|
+
['PureCloud OAuth'],
|
|
143
|
+
['application/json'],
|
|
144
|
+
['application/json']
|
|
145
|
+
);
|
|
146
|
+
}
|
|
147
|
+
|
|
48
148
|
}
|
|
49
149
|
|
|
50
150
|
|