purecloud-platform-client-v2 215.0.0 → 217.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 +1303 -493
- package/dist/web-amd/purecloud-platform-client-v2.js +1303 -493
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +435 -231
- package/dist/web-cjs/purecloud-platform-client-v2.js +441 -235
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +826 -472
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- 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 -305
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +112 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +387 -8
- 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 -5
- 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 +174 -2
- 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 +175 -7
- 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 +5 -3
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +21 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +13 -11
- 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 +9 -8
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +3 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +19 -7
- 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 +4 -59
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +182 -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 -3
- 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 +58 -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 IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 217.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -214,6 +214,7 @@ class IntegrationsApi {
|
|
|
214
214
|
* @param {String} actionId actionId
|
|
215
215
|
* @param {Object} opts Optional parameters
|
|
216
216
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
217
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
217
218
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
218
219
|
*/
|
|
219
220
|
getIntegrationsAction(actionId, opts) {
|
|
@@ -228,7 +229,7 @@ class IntegrationsApi {
|
|
|
228
229
|
'/api/v2/integrations/actions/{actionId}',
|
|
229
230
|
'GET',
|
|
230
231
|
{ 'actionId': actionId },
|
|
231
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
232
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
232
233
|
{ },
|
|
233
234
|
{ },
|
|
234
235
|
null,
|
|
@@ -244,6 +245,7 @@ class IntegrationsApi {
|
|
|
244
245
|
* @param {String} actionId actionId
|
|
245
246
|
* @param {Object} opts Optional parameters
|
|
246
247
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
248
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
247
249
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
248
250
|
*/
|
|
249
251
|
getIntegrationsActionDraft(actionId, opts) {
|
|
@@ -258,7 +260,7 @@ class IntegrationsApi {
|
|
|
258
260
|
'/api/v2/integrations/actions/{actionId}/draft',
|
|
259
261
|
'GET',
|
|
260
262
|
{ 'actionId': actionId },
|
|
261
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
263
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
262
264
|
{ },
|
|
263
265
|
{ },
|
|
264
266
|
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 217.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 KnowledgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Knowledge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 217.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1536,7 +1536,6 @@ class KnowledgeApi {
|
|
|
1536
1536
|
* @param {String} parseJobId Parse job ID
|
|
1537
1537
|
* @param {Object} opts Optional parameters
|
|
1538
1538
|
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
1539
|
-
* getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1540
1539
|
*/
|
|
1541
1540
|
getKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, opts) {
|
|
1542
1541
|
opts = opts || {};
|
|
@@ -1806,7 +1805,6 @@ class KnowledgeApi {
|
|
|
1806
1805
|
*
|
|
1807
1806
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1808
1807
|
* @param {String} jobId Upload job ID
|
|
1809
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1810
1808
|
*/
|
|
1811
1809
|
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
1812
1810
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2347,7 +2345,6 @@ class KnowledgeApi {
|
|
|
2347
2345
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2348
2346
|
* @param {String} parseJobId Parse job ID
|
|
2349
2347
|
* @param {Object} body
|
|
2350
|
-
* patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2351
2348
|
*/
|
|
2352
2349
|
patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, body) {
|
|
2353
2350
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3508,7 +3505,6 @@ class KnowledgeApi {
|
|
|
3508
3505
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3509
3506
|
* @param {String} parseJobId Parse job ID
|
|
3510
3507
|
* @param {Object} body
|
|
3511
|
-
* postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3512
3508
|
*/
|
|
3513
3509
|
postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId, parseJobId, body) {
|
|
3514
3510
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3543,7 +3539,6 @@ class KnowledgeApi {
|
|
|
3543
3539
|
*
|
|
3544
3540
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3545
3541
|
* @param {Object} body
|
|
3546
|
-
* postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3547
3542
|
*/
|
|
3548
3543
|
postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId, body) {
|
|
3549
3544
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3634,8 +3629,12 @@ class KnowledgeApi {
|
|
|
3634
3629
|
*
|
|
3635
3630
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3636
3631
|
* @param {String} sourceId Source ID
|
|
3632
|
+
* @param {Object} opts Optional parameters
|
|
3633
|
+
* @param {Object} opts.body
|
|
3637
3634
|
*/
|
|
3638
|
-
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
3635
|
+
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
3636
|
+
opts = opts || {};
|
|
3637
|
+
|
|
3639
3638
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
3640
3639
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
3641
3640
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';
|
|
@@ -3652,7 +3651,7 @@ class KnowledgeApi {
|
|
|
3652
3651
|
{ },
|
|
3653
3652
|
{ },
|
|
3654
3653
|
{ },
|
|
3655
|
-
|
|
3654
|
+
opts['body'],
|
|
3656
3655
|
['PureCloud OAuth'],
|
|
3657
3656
|
['application/json'],
|
|
3658
3657
|
['application/json']
|
|
@@ -3694,8 +3693,12 @@ class KnowledgeApi {
|
|
|
3694
3693
|
*
|
|
3695
3694
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3696
3695
|
* @param {String} sourceId Source ID
|
|
3696
|
+
* @param {Object} opts Optional parameters
|
|
3697
|
+
* @param {Object} opts.body
|
|
3697
3698
|
*/
|
|
3698
|
-
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
3699
|
+
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
3700
|
+
opts = opts || {};
|
|
3701
|
+
|
|
3699
3702
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
3700
3703
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
3701
3704
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';
|
|
@@ -3712,7 +3715,7 @@ class KnowledgeApi {
|
|
|
3712
3715
|
{ },
|
|
3713
3716
|
{ },
|
|
3714
3717
|
{ },
|
|
3715
|
-
|
|
3718
|
+
opts['body'],
|
|
3716
3719
|
['PureCloud OAuth'],
|
|
3717
3720
|
['application/json'],
|
|
3718
3721
|
['application/json']
|
|
@@ -3754,7 +3757,6 @@ class KnowledgeApi {
|
|
|
3754
3757
|
*
|
|
3755
3758
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3756
3759
|
* @param {Object} body uploadRequest
|
|
3757
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3758
3760
|
*/
|
|
3759
3761
|
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
3760
3762
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -5,7 +5,7 @@ class ObjectsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Objects service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 217.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -25,7 +25,7 @@ class ObjectsApi {
|
|
|
25
25
|
*
|
|
26
26
|
* @param {String} divisionId Division ID
|
|
27
27
|
* @param {Object} opts Optional parameters
|
|
28
|
-
* @param {Boolean} opts.force Force delete this division
|
|
28
|
+
* @param {Boolean} opts.force DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (default to false)
|
|
29
29
|
*/
|
|
30
30
|
deleteAuthorizationDivision(divisionId, opts) {
|
|
31
31
|
opts = opts || {};
|
|
@@ -189,16 +189,17 @@ class ObjectsApi {
|
|
|
189
189
|
* Recreate a previously deleted division.
|
|
190
190
|
*
|
|
191
191
|
* @param {String} divisionId Division ID
|
|
192
|
-
* @param {Object}
|
|
193
|
-
* @param {Object} opts.body Recreated division data
|
|
192
|
+
* @param {Object} body Recreated division data
|
|
194
193
|
*/
|
|
195
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
196
|
-
opts = opts || {};
|
|
197
|
-
|
|
194
|
+
postAuthorizationDivisionRestore(divisionId, body) {
|
|
198
195
|
// verify the required parameter 'divisionId' is set
|
|
199
196
|
if (divisionId === undefined || divisionId === null) {
|
|
200
197
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
201
198
|
}
|
|
199
|
+
// verify the required parameter 'body' is set
|
|
200
|
+
if (body === undefined || body === null) {
|
|
201
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
202
|
+
}
|
|
202
203
|
|
|
203
204
|
return this.apiClient.callApi(
|
|
204
205
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -207,7 +208,7 @@ class ObjectsApi {
|
|
|
207
208
|
{ },
|
|
208
209
|
{ },
|
|
209
210
|
{ },
|
|
210
|
-
|
|
211
|
+
body,
|
|
211
212
|
['PureCloud OAuth'],
|
|
212
213
|
['application/json'],
|
|
213
214
|
['application/json']
|
|
@@ -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 217.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -234,6 +234,7 @@ class OrganizationApi {
|
|
|
234
234
|
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
235
235
|
* @param {String} opts.entityId entity id of the count
|
|
236
236
|
* @param {String} opts.userId userid of the count
|
|
237
|
+
* @deprecated
|
|
237
238
|
*/
|
|
238
239
|
getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
|
|
239
240
|
opts = opts || {};
|
|
@@ -291,6 +292,7 @@ class OrganizationApi {
|
|
|
291
292
|
* @param {String} opts.entityId entity id of the count
|
|
292
293
|
* @param {String} opts.userId userid of the count
|
|
293
294
|
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
295
|
+
* @deprecated
|
|
294
296
|
*/
|
|
295
297
|
getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
|
|
296
298
|
opts = opts || {};
|
|
@@ -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 217.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2834,8 +2834,12 @@ class OutboundApi {
|
|
|
2834
2834
|
* Update the outbound settings for this organization
|
|
2835
2835
|
*
|
|
2836
2836
|
* @param {Object} body outboundSettings
|
|
2837
|
+
* @param {Object} opts Optional parameters
|
|
2838
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
2837
2839
|
*/
|
|
2838
|
-
patchOutboundSettings(body) {
|
|
2840
|
+
patchOutboundSettings(body, opts) {
|
|
2841
|
+
opts = opts || {};
|
|
2842
|
+
|
|
2839
2843
|
// verify the required parameter 'body' is set
|
|
2840
2844
|
if (body === undefined || body === null) {
|
|
2841
2845
|
throw 'Missing the required parameter "body" when calling patchOutboundSettings';
|
|
@@ -2845,7 +2849,7 @@ class OutboundApi {
|
|
|
2845
2849
|
'/api/v2/outbound/settings',
|
|
2846
2850
|
'PATCH',
|
|
2847
2851
|
{ },
|
|
2848
|
-
{
|
|
2852
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
2849
2853
|
{ },
|
|
2850
2854
|
{ },
|
|
2851
2855
|
body,
|
|
@@ -3065,8 +3069,12 @@ class OutboundApi {
|
|
|
3065
3069
|
* Create a campaign.
|
|
3066
3070
|
*
|
|
3067
3071
|
* @param {Object} body Campaign
|
|
3072
|
+
* @param {Object} opts Optional parameters
|
|
3073
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
3068
3074
|
*/
|
|
3069
|
-
postOutboundCampaigns(body) {
|
|
3075
|
+
postOutboundCampaigns(body, opts) {
|
|
3076
|
+
opts = opts || {};
|
|
3077
|
+
|
|
3070
3078
|
// verify the required parameter 'body' is set
|
|
3071
3079
|
if (body === undefined || body === null) {
|
|
3072
3080
|
throw 'Missing the required parameter "body" when calling postOutboundCampaigns';
|
|
@@ -3076,7 +3084,7 @@ class OutboundApi {
|
|
|
3076
3084
|
'/api/v2/outbound/campaigns',
|
|
3077
3085
|
'POST',
|
|
3078
3086
|
{ },
|
|
3079
|
-
{
|
|
3087
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
3080
3088
|
{ },
|
|
3081
3089
|
{ },
|
|
3082
3090
|
body,
|
|
@@ -3980,8 +3988,12 @@ class OutboundApi {
|
|
|
3980
3988
|
*
|
|
3981
3989
|
* @param {String} campaignId Campaign ID
|
|
3982
3990
|
* @param {Object} body Campaign
|
|
3991
|
+
* @param {Object} opts Optional parameters
|
|
3992
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
3983
3993
|
*/
|
|
3984
|
-
putOutboundCampaign(campaignId, body) {
|
|
3994
|
+
putOutboundCampaign(campaignId, body, opts) {
|
|
3995
|
+
opts = opts || {};
|
|
3996
|
+
|
|
3985
3997
|
// verify the required parameter 'campaignId' is set
|
|
3986
3998
|
if (campaignId === undefined || campaignId === null) {
|
|
3987
3999
|
throw 'Missing the required parameter "campaignId" when calling putOutboundCampaign';
|
|
@@ -3995,7 +4007,7 @@ class OutboundApi {
|
|
|
3995
4007
|
'/api/v2/outbound/campaigns/{campaignId}',
|
|
3996
4008
|
'PUT',
|
|
3997
4009
|
{ 'campaignId': campaignId },
|
|
3998
|
-
{
|
|
4010
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
3999
4011
|
{ },
|
|
4000
4012
|
{ },
|
|
4001
4013
|
body,
|
|
@@ -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 217.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -217,7 +217,7 @@ class RecordingApi {
|
|
|
217
217
|
* @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
|
|
218
218
|
* @param {Object} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
219
219
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
220
|
-
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
220
|
+
* @param {String} opts.locale The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
221
221
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
222
222
|
*/
|
|
223
223
|
getConversationRecording(conversationId, recordingId, opts) {
|
|
@@ -374,6 +374,7 @@ class RecordingApi {
|
|
|
374
374
|
* @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
375
375
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
376
376
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
377
|
+
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
377
378
|
*/
|
|
378
379
|
getConversationRecordings(conversationId, opts) {
|
|
379
380
|
opts = opts || {};
|
|
@@ -387,7 +388,7 @@ class RecordingApi {
|
|
|
387
388
|
'/api/v2/conversations/{conversationId}/recordings',
|
|
388
389
|
'GET',
|
|
389
390
|
{ 'conversationId': conversationId },
|
|
390
|
-
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
391
|
+
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'] },
|
|
391
392
|
{ },
|
|
392
393
|
{ },
|
|
393
394
|
null,
|
|
@@ -889,32 +890,6 @@ class RecordingApi {
|
|
|
889
890
|
);
|
|
890
891
|
}
|
|
891
892
|
|
|
892
|
-
/**
|
|
893
|
-
* Retrieves a paged listing of screen recording sessions
|
|
894
|
-
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
895
|
-
* @param {Object} opts Optional parameters
|
|
896
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
897
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
898
|
-
* @deprecated
|
|
899
|
-
*/
|
|
900
|
-
getRecordingsScreensessions(opts) {
|
|
901
|
-
opts = opts || {};
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
return this.apiClient.callApi(
|
|
905
|
-
'/api/v2/recordings/screensessions',
|
|
906
|
-
'GET',
|
|
907
|
-
{ },
|
|
908
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
909
|
-
{ },
|
|
910
|
-
{ },
|
|
911
|
-
null,
|
|
912
|
-
['PureCloud OAuth'],
|
|
913
|
-
['application/json'],
|
|
914
|
-
['application/json']
|
|
915
|
-
);
|
|
916
|
-
}
|
|
917
|
-
|
|
918
893
|
/**
|
|
919
894
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
920
895
|
*
|
|
@@ -995,36 +970,6 @@ class RecordingApi {
|
|
|
995
970
|
);
|
|
996
971
|
}
|
|
997
972
|
|
|
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
973
|
/**
|
|
1029
974
|
* Create annotation
|
|
1030
975
|
*
|