purecloud-platform-client-v2 182.1.0 → 184.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +786 -127
- package/dist/web-amd/purecloud-platform-client-v2.js +786 -127
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +295 -119
- package/dist/web-cjs/purecloud-platform-client-v2.js +295 -119
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +554 -229
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +30 -19
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +149 -5
- 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 +7 -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 -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 +1 -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/EmailsApi.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 +2 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +4 -8
- 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 +39 -2
- 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 +75 -0
- 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 +7 -8
- 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 +401 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -6
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +7 -4
- 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 +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/SettingsApi.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 +1 -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 +7 -1
|
@@ -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 184.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -305,6 +305,56 @@ class OutboundApi {
|
|
|
305
305
|
);
|
|
306
306
|
}
|
|
307
307
|
|
|
308
|
+
/**
|
|
309
|
+
* Delete Contact List Template
|
|
310
|
+
*
|
|
311
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
312
|
+
*/
|
|
313
|
+
deleteOutboundContactlisttemplate(contactListTemplateId) {
|
|
314
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
315
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
316
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
return this.apiClient.callApi(
|
|
320
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
321
|
+
'DELETE',
|
|
322
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
323
|
+
{ },
|
|
324
|
+
{ },
|
|
325
|
+
{ },
|
|
326
|
+
null,
|
|
327
|
+
['PureCloud OAuth'],
|
|
328
|
+
['application/json'],
|
|
329
|
+
['application/json']
|
|
330
|
+
);
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* Delete multiple contact list templates.
|
|
335
|
+
*
|
|
336
|
+
* @param {Array.<String>} id contact list template id(s) to delete
|
|
337
|
+
*/
|
|
338
|
+
deleteOutboundContactlisttemplates(id) {
|
|
339
|
+
// verify the required parameter 'id' is set
|
|
340
|
+
if (id === undefined || id === null) {
|
|
341
|
+
throw 'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
return this.apiClient.callApi(
|
|
345
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
346
|
+
'DELETE',
|
|
347
|
+
{ },
|
|
348
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
349
|
+
{ },
|
|
350
|
+
{ },
|
|
351
|
+
null,
|
|
352
|
+
['PureCloud OAuth'],
|
|
353
|
+
['application/json'],
|
|
354
|
+
['application/json']
|
|
355
|
+
);
|
|
356
|
+
}
|
|
357
|
+
|
|
308
358
|
/**
|
|
309
359
|
* Delete an Outbound Digital Rule Set
|
|
310
360
|
*
|
|
@@ -442,6 +492,56 @@ class OutboundApi {
|
|
|
442
492
|
);
|
|
443
493
|
}
|
|
444
494
|
|
|
495
|
+
/**
|
|
496
|
+
* Delete Import Template
|
|
497
|
+
*
|
|
498
|
+
* @param {String} importTemplateId Import Template ID
|
|
499
|
+
*/
|
|
500
|
+
deleteOutboundImporttemplate(importTemplateId) {
|
|
501
|
+
// verify the required parameter 'importTemplateId' is set
|
|
502
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
503
|
+
throw 'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
return this.apiClient.callApi(
|
|
507
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
508
|
+
'DELETE',
|
|
509
|
+
{ 'importTemplateId': importTemplateId },
|
|
510
|
+
{ },
|
|
511
|
+
{ },
|
|
512
|
+
{ },
|
|
513
|
+
null,
|
|
514
|
+
['PureCloud OAuth'],
|
|
515
|
+
['application/json'],
|
|
516
|
+
['application/json']
|
|
517
|
+
);
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
/**
|
|
521
|
+
* Delete multiple import templates.
|
|
522
|
+
*
|
|
523
|
+
* @param {Array.<String>} id import template id(s) to delete
|
|
524
|
+
*/
|
|
525
|
+
deleteOutboundImporttemplates(id) {
|
|
526
|
+
// verify the required parameter 'id' is set
|
|
527
|
+
if (id === undefined || id === null) {
|
|
528
|
+
throw 'Missing the required parameter "id" when calling deleteOutboundImporttemplates';
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
return this.apiClient.callApi(
|
|
532
|
+
'/api/v2/outbound/importtemplates',
|
|
533
|
+
'DELETE',
|
|
534
|
+
{ },
|
|
535
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
536
|
+
{ },
|
|
537
|
+
{ },
|
|
538
|
+
null,
|
|
539
|
+
['PureCloud OAuth'],
|
|
540
|
+
['application/json'],
|
|
541
|
+
['application/json']
|
|
542
|
+
);
|
|
543
|
+
}
|
|
544
|
+
|
|
445
545
|
/**
|
|
446
546
|
* Delete an Outbound Messaging Campaign
|
|
447
547
|
*
|
|
@@ -1454,6 +1554,61 @@ class OutboundApi {
|
|
|
1454
1554
|
);
|
|
1455
1555
|
}
|
|
1456
1556
|
|
|
1557
|
+
/**
|
|
1558
|
+
* Get Contact List Template
|
|
1559
|
+
*
|
|
1560
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
1561
|
+
*/
|
|
1562
|
+
getOutboundContactlisttemplate(contactListTemplateId) {
|
|
1563
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
1564
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
1565
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';
|
|
1566
|
+
}
|
|
1567
|
+
|
|
1568
|
+
return this.apiClient.callApi(
|
|
1569
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
1570
|
+
'GET',
|
|
1571
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
1572
|
+
{ },
|
|
1573
|
+
{ },
|
|
1574
|
+
{ },
|
|
1575
|
+
null,
|
|
1576
|
+
['PureCloud OAuth'],
|
|
1577
|
+
['application/json'],
|
|
1578
|
+
['application/json']
|
|
1579
|
+
);
|
|
1580
|
+
}
|
|
1581
|
+
|
|
1582
|
+
/**
|
|
1583
|
+
* Query a list of contact list templates
|
|
1584
|
+
*
|
|
1585
|
+
* @param {Object} opts Optional parameters
|
|
1586
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
1587
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1588
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
1589
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
1590
|
+
* @param {String} opts.name Name
|
|
1591
|
+
* @param {String} opts.sortBy Sort by
|
|
1592
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1593
|
+
*/
|
|
1594
|
+
getOutboundContactlisttemplates(opts) {
|
|
1595
|
+
opts = opts || {};
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
return this.apiClient.callApi(
|
|
1599
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
1600
|
+
'GET',
|
|
1601
|
+
{ },
|
|
1602
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
1603
|
+
{ },
|
|
1604
|
+
{ },
|
|
1605
|
+
null,
|
|
1606
|
+
['PureCloud OAuth'],
|
|
1607
|
+
['application/json'],
|
|
1608
|
+
['application/json']
|
|
1609
|
+
);
|
|
1610
|
+
}
|
|
1611
|
+
|
|
1457
1612
|
/**
|
|
1458
1613
|
* Get an Outbound Digital Rule Set
|
|
1459
1614
|
*
|
|
@@ -1744,6 +1899,91 @@ class OutboundApi {
|
|
|
1744
1899
|
);
|
|
1745
1900
|
}
|
|
1746
1901
|
|
|
1902
|
+
/**
|
|
1903
|
+
* Get Import Template
|
|
1904
|
+
*
|
|
1905
|
+
* @param {String} importTemplateId Import Template ID
|
|
1906
|
+
*/
|
|
1907
|
+
getOutboundImporttemplate(importTemplateId) {
|
|
1908
|
+
// verify the required parameter 'importTemplateId' is set
|
|
1909
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
1910
|
+
throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';
|
|
1911
|
+
}
|
|
1912
|
+
|
|
1913
|
+
return this.apiClient.callApi(
|
|
1914
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
1915
|
+
'GET',
|
|
1916
|
+
{ 'importTemplateId': importTemplateId },
|
|
1917
|
+
{ },
|
|
1918
|
+
{ },
|
|
1919
|
+
{ },
|
|
1920
|
+
null,
|
|
1921
|
+
['PureCloud OAuth'],
|
|
1922
|
+
['application/json'],
|
|
1923
|
+
['application/json']
|
|
1924
|
+
);
|
|
1925
|
+
}
|
|
1926
|
+
|
|
1927
|
+
/**
|
|
1928
|
+
* Get the import status for an import template.
|
|
1929
|
+
*
|
|
1930
|
+
* @param {String} importTemplateId importTemplateId
|
|
1931
|
+
* @param {Object} opts Optional parameters
|
|
1932
|
+
* @param {String} opts.listNamePrefix listNamePrefix
|
|
1933
|
+
*/
|
|
1934
|
+
getOutboundImporttemplateImportstatus(importTemplateId, opts) {
|
|
1935
|
+
opts = opts || {};
|
|
1936
|
+
|
|
1937
|
+
// verify the required parameter 'importTemplateId' is set
|
|
1938
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
1939
|
+
throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplateImportstatus';
|
|
1940
|
+
}
|
|
1941
|
+
|
|
1942
|
+
return this.apiClient.callApi(
|
|
1943
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}/importstatus',
|
|
1944
|
+
'GET',
|
|
1945
|
+
{ 'importTemplateId': importTemplateId },
|
|
1946
|
+
{ 'listNamePrefix': opts['listNamePrefix'] },
|
|
1947
|
+
{ },
|
|
1948
|
+
{ },
|
|
1949
|
+
null,
|
|
1950
|
+
['PureCloud OAuth'],
|
|
1951
|
+
['application/json'],
|
|
1952
|
+
['application/json']
|
|
1953
|
+
);
|
|
1954
|
+
}
|
|
1955
|
+
|
|
1956
|
+
/**
|
|
1957
|
+
* Query Import Templates
|
|
1958
|
+
*
|
|
1959
|
+
* @param {Object} opts Optional parameters
|
|
1960
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
1961
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1962
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
1963
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
1964
|
+
* @param {String} opts.name Name
|
|
1965
|
+
* @param {String} opts.sortBy Sort by
|
|
1966
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1967
|
+
* @param {String} opts.contactListTemplateId Contact List Template ID
|
|
1968
|
+
*/
|
|
1969
|
+
getOutboundImporttemplates(opts) {
|
|
1970
|
+
opts = opts || {};
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
return this.apiClient.callApi(
|
|
1974
|
+
'/api/v2/outbound/importtemplates',
|
|
1975
|
+
'GET',
|
|
1976
|
+
{ },
|
|
1977
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
|
|
1978
|
+
{ },
|
|
1979
|
+
{ },
|
|
1980
|
+
null,
|
|
1981
|
+
['PureCloud OAuth'],
|
|
1982
|
+
['application/json'],
|
|
1983
|
+
['application/json']
|
|
1984
|
+
);
|
|
1985
|
+
}
|
|
1986
|
+
|
|
1747
1987
|
/**
|
|
1748
1988
|
* Get an Outbound Messaging Campaign
|
|
1749
1989
|
*
|
|
@@ -2782,6 +3022,56 @@ class OutboundApi {
|
|
|
2782
3022
|
);
|
|
2783
3023
|
}
|
|
2784
3024
|
|
|
3025
|
+
/**
|
|
3026
|
+
* Create Contact List Template
|
|
3027
|
+
*
|
|
3028
|
+
* @param {Object} body ContactListTemplate
|
|
3029
|
+
*/
|
|
3030
|
+
postOutboundContactlisttemplates(body) {
|
|
3031
|
+
// verify the required parameter 'body' is set
|
|
3032
|
+
if (body === undefined || body === null) {
|
|
3033
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplates';
|
|
3034
|
+
}
|
|
3035
|
+
|
|
3036
|
+
return this.apiClient.callApi(
|
|
3037
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
3038
|
+
'POST',
|
|
3039
|
+
{ },
|
|
3040
|
+
{ },
|
|
3041
|
+
{ },
|
|
3042
|
+
{ },
|
|
3043
|
+
body,
|
|
3044
|
+
['PureCloud OAuth'],
|
|
3045
|
+
['application/json'],
|
|
3046
|
+
['application/json']
|
|
3047
|
+
);
|
|
3048
|
+
}
|
|
3049
|
+
|
|
3050
|
+
/**
|
|
3051
|
+
* Add multiple contact list templates
|
|
3052
|
+
*
|
|
3053
|
+
* @param {Array.<Object>} body contact list template(s) to add
|
|
3054
|
+
*/
|
|
3055
|
+
postOutboundContactlisttemplatesBulkAdd(body) {
|
|
3056
|
+
// verify the required parameter 'body' is set
|
|
3057
|
+
if (body === undefined || body === null) {
|
|
3058
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';
|
|
3059
|
+
}
|
|
3060
|
+
|
|
3061
|
+
return this.apiClient.callApi(
|
|
3062
|
+
'/api/v2/outbound/contactlisttemplates/bulk/add',
|
|
3063
|
+
'POST',
|
|
3064
|
+
{ },
|
|
3065
|
+
{ },
|
|
3066
|
+
{ },
|
|
3067
|
+
{ },
|
|
3068
|
+
body,
|
|
3069
|
+
['PureCloud OAuth'],
|
|
3070
|
+
['application/json'],
|
|
3071
|
+
['application/json']
|
|
3072
|
+
);
|
|
3073
|
+
}
|
|
3074
|
+
|
|
2785
3075
|
/**
|
|
2786
3076
|
* Add phone numbers to a Dialer DNC list.
|
|
2787
3077
|
*
|
|
@@ -2946,6 +3236,56 @@ class OutboundApi {
|
|
|
2946
3236
|
);
|
|
2947
3237
|
}
|
|
2948
3238
|
|
|
3239
|
+
/**
|
|
3240
|
+
* Create Import Template
|
|
3241
|
+
*
|
|
3242
|
+
* @param {Object} body ImportTemplate
|
|
3243
|
+
*/
|
|
3244
|
+
postOutboundImporttemplates(body) {
|
|
3245
|
+
// verify the required parameter 'body' is set
|
|
3246
|
+
if (body === undefined || body === null) {
|
|
3247
|
+
throw 'Missing the required parameter "body" when calling postOutboundImporttemplates';
|
|
3248
|
+
}
|
|
3249
|
+
|
|
3250
|
+
return this.apiClient.callApi(
|
|
3251
|
+
'/api/v2/outbound/importtemplates',
|
|
3252
|
+
'POST',
|
|
3253
|
+
{ },
|
|
3254
|
+
{ },
|
|
3255
|
+
{ },
|
|
3256
|
+
{ },
|
|
3257
|
+
body,
|
|
3258
|
+
['PureCloud OAuth'],
|
|
3259
|
+
['application/json'],
|
|
3260
|
+
['application/json']
|
|
3261
|
+
);
|
|
3262
|
+
}
|
|
3263
|
+
|
|
3264
|
+
/**
|
|
3265
|
+
* Add multiple import templates
|
|
3266
|
+
*
|
|
3267
|
+
* @param {Array.<Object>} body import template(s) to add
|
|
3268
|
+
*/
|
|
3269
|
+
postOutboundImporttemplatesBulkAdd(body) {
|
|
3270
|
+
// verify the required parameter 'body' is set
|
|
3271
|
+
if (body === undefined || body === null) {
|
|
3272
|
+
throw 'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';
|
|
3273
|
+
}
|
|
3274
|
+
|
|
3275
|
+
return this.apiClient.callApi(
|
|
3276
|
+
'/api/v2/outbound/importtemplates/bulk/add',
|
|
3277
|
+
'POST',
|
|
3278
|
+
{ },
|
|
3279
|
+
{ },
|
|
3280
|
+
{ },
|
|
3281
|
+
{ },
|
|
3282
|
+
body,
|
|
3283
|
+
['PureCloud OAuth'],
|
|
3284
|
+
['application/json'],
|
|
3285
|
+
['application/json']
|
|
3286
|
+
);
|
|
3287
|
+
}
|
|
3288
|
+
|
|
2949
3289
|
/**
|
|
2950
3290
|
* Create a Messaging Campaign
|
|
2951
3291
|
*
|
|
@@ -3326,6 +3666,36 @@ class OutboundApi {
|
|
|
3326
3666
|
);
|
|
3327
3667
|
}
|
|
3328
3668
|
|
|
3669
|
+
/**
|
|
3670
|
+
* Update a contact list template.
|
|
3671
|
+
*
|
|
3672
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
3673
|
+
* @param {Object} body ContactListTemplate
|
|
3674
|
+
*/
|
|
3675
|
+
putOutboundContactlisttemplate(contactListTemplateId, body) {
|
|
3676
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
3677
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
3678
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';
|
|
3679
|
+
}
|
|
3680
|
+
// verify the required parameter 'body' is set
|
|
3681
|
+
if (body === undefined || body === null) {
|
|
3682
|
+
throw 'Missing the required parameter "body" when calling putOutboundContactlisttemplate';
|
|
3683
|
+
}
|
|
3684
|
+
|
|
3685
|
+
return this.apiClient.callApi(
|
|
3686
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
3687
|
+
'PUT',
|
|
3688
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
3689
|
+
{ },
|
|
3690
|
+
{ },
|
|
3691
|
+
{ },
|
|
3692
|
+
body,
|
|
3693
|
+
['PureCloud OAuth'],
|
|
3694
|
+
['application/json'],
|
|
3695
|
+
['application/json']
|
|
3696
|
+
);
|
|
3697
|
+
}
|
|
3698
|
+
|
|
3329
3699
|
/**
|
|
3330
3700
|
* Update an Outbound Digital Rule Set
|
|
3331
3701
|
*
|
|
@@ -3386,6 +3756,36 @@ class OutboundApi {
|
|
|
3386
3756
|
);
|
|
3387
3757
|
}
|
|
3388
3758
|
|
|
3759
|
+
/**
|
|
3760
|
+
* Update Import Template
|
|
3761
|
+
*
|
|
3762
|
+
* @param {String} importTemplateId Import Template ID
|
|
3763
|
+
* @param {Object} body importTemplate
|
|
3764
|
+
*/
|
|
3765
|
+
putOutboundImporttemplate(importTemplateId, body) {
|
|
3766
|
+
// verify the required parameter 'importTemplateId' is set
|
|
3767
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
3768
|
+
throw 'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';
|
|
3769
|
+
}
|
|
3770
|
+
// verify the required parameter 'body' is set
|
|
3771
|
+
if (body === undefined || body === null) {
|
|
3772
|
+
throw 'Missing the required parameter "body" when calling putOutboundImporttemplate';
|
|
3773
|
+
}
|
|
3774
|
+
|
|
3775
|
+
return this.apiClient.callApi(
|
|
3776
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
3777
|
+
'PUT',
|
|
3778
|
+
{ 'importTemplateId': importTemplateId },
|
|
3779
|
+
{ },
|
|
3780
|
+
{ },
|
|
3781
|
+
{ },
|
|
3782
|
+
body,
|
|
3783
|
+
['PureCloud OAuth'],
|
|
3784
|
+
['application/json'],
|
|
3785
|
+
['application/json']
|
|
3786
|
+
);
|
|
3787
|
+
}
|
|
3788
|
+
|
|
3389
3789
|
/**
|
|
3390
3790
|
* Update an Outbound Messaging Campaign
|
|
3391
3791
|
*
|
|
@@ -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 184.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,6 @@ class PresenceApi {
|
|
|
24
24
|
* Delete a Presence Definition
|
|
25
25
|
*
|
|
26
26
|
* @param {String} definitionId Presence Definition ID
|
|
27
|
-
* deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
27
|
*/
|
|
29
28
|
deletePresenceDefinition0(definitionId) {
|
|
30
29
|
// verify the required parameter 'definitionId' is set
|
|
@@ -102,7 +101,6 @@ class PresenceApi {
|
|
|
102
101
|
* @param {String} definitionId Presence Definition ID
|
|
103
102
|
* @param {Object} opts Optional parameters
|
|
104
103
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
105
|
-
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
106
104
|
*/
|
|
107
105
|
getPresenceDefinition0(definitionId, opts) {
|
|
108
106
|
opts = opts || {};
|
|
@@ -133,7 +131,6 @@ class PresenceApi {
|
|
|
133
131
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
134
132
|
* @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.
|
|
135
133
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
136
|
-
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
137
134
|
*/
|
|
138
135
|
getPresenceDefinitions0(opts) {
|
|
139
136
|
opts = opts || {};
|
|
@@ -500,7 +497,6 @@ class PresenceApi {
|
|
|
500
497
|
* Create a Presence Definition
|
|
501
498
|
*
|
|
502
499
|
* @param {Object} body The Presence Definition to create
|
|
503
|
-
* postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
504
500
|
*/
|
|
505
501
|
postPresenceDefinitions0(body) {
|
|
506
502
|
// verify the required parameter 'body' is set
|
|
@@ -577,7 +573,6 @@ class PresenceApi {
|
|
|
577
573
|
*
|
|
578
574
|
* @param {String} definitionId Presence Definition ID
|
|
579
575
|
* @param {Object} body The updated Presence Definition
|
|
580
|
-
* putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
581
576
|
*/
|
|
582
577
|
putPresenceDefinition0(definitionId, body) {
|
|
583
578
|
// verify the required parameter 'definitionId' is set
|
|
@@ -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 184.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -288,6 +288,7 @@ class QualityApi {
|
|
|
288
288
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
289
289
|
* @param {String} opts.name name
|
|
290
290
|
* @param {String} opts.group group id
|
|
291
|
+
* @param {String} opts.agentTeamId team id of agents requested
|
|
291
292
|
* @param {String} opts.formContextId shared id between form versions
|
|
292
293
|
*/
|
|
293
294
|
getQualityAgentsActivity(opts) {
|
|
@@ -298,7 +299,7 @@ class QualityApi {
|
|
|
298
299
|
'/api/v2/quality/agents/activity',
|
|
299
300
|
'GET',
|
|
300
301
|
{ },
|
|
301
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'formContextId': opts['formContextId'] },
|
|
302
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'agentTeamId': opts['agentTeamId'],'formContextId': opts['formContextId'] },
|
|
302
303
|
{ },
|
|
303
304
|
{ },
|
|
304
305
|
null,
|
|
@@ -502,6 +503,7 @@ class QualityApi {
|
|
|
502
503
|
* @param {String} opts.previousPage Previous page token
|
|
503
504
|
* @param {String} opts.conversationId conversationId specified
|
|
504
505
|
* @param {String} opts.agentUserId user id of the agent
|
|
506
|
+
* @param {String} opts.agentTeamId team id of the agent
|
|
505
507
|
* @param {String} opts.evaluatorUserId evaluator user id
|
|
506
508
|
* @param {String} opts.assigneeUserId assignee user id
|
|
507
509
|
* @param {String} opts.queueId queue id
|
|
@@ -523,7 +525,7 @@ class QualityApi {
|
|
|
523
525
|
'/api/v2/quality/evaluations/query',
|
|
524
526
|
'GET',
|
|
525
527
|
{ },
|
|
526
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
528
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
527
529
|
{ },
|
|
528
530
|
{ },
|
|
529
531
|
null,
|
|
@@ -548,6 +550,7 @@ class QualityApi {
|
|
|
548
550
|
* @param {String} opts.name Evaluator name
|
|
549
551
|
* @param {Array.<String>} opts.permission permission strings
|
|
550
552
|
* @param {String} opts.group group id
|
|
553
|
+
* @param {String} opts.agentTeamId team id of agents to be considered
|
|
551
554
|
*/
|
|
552
555
|
getQualityEvaluatorsActivity(opts) {
|
|
553
556
|
opts = opts || {};
|
|
@@ -557,7 +560,7 @@ class QualityApi {
|
|
|
557
560
|
'/api/v2/quality/evaluators/activity',
|
|
558
561
|
'GET',
|
|
559
562
|
{ },
|
|
560
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'name': opts['name'],'permission': this.apiClient.buildCollectionParam(opts['permission'], 'multi'),'group': opts['group'] },
|
|
563
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'name': opts['name'],'permission': this.apiClient.buildCollectionParam(opts['permission'], 'multi'),'group': opts['group'],'agentTeamId': opts['agentTeamId'] },
|
|
561
564
|
{ },
|
|
562
565
|
{ },
|
|
563
566
|
null,
|