purecloud-platform-client-v2 152.0.0 → 154.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 +485 -81
- package/dist/web-amd/purecloud-platform-client-v2.js +485 -81
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +485 -81
- package/dist/web-cjs/purecloud-platform-client-v2.js +485 -81
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +784 -207
- 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 +5 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.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 +3 -3
- 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 +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/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 +3 -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/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 +31 -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 +6 -6
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +4 -2
- 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 -1
- 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 +325 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 154.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1481,7 +1481,7 @@ class AlertingApi {
|
|
|
1481
1481
|
/**
|
|
1482
1482
|
* Alerting service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 154.0.0
|
|
1485
1485
|
*/
|
|
1486
1486
|
|
|
1487
1487
|
/**
|
|
@@ -1795,7 +1795,7 @@ class AnalyticsApi {
|
|
|
1795
1795
|
/**
|
|
1796
1796
|
* Analytics service.
|
|
1797
1797
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1798
|
-
* @version
|
|
1798
|
+
* @version 154.0.0
|
|
1799
1799
|
*/
|
|
1800
1800
|
|
|
1801
1801
|
/**
|
|
@@ -1811,7 +1811,7 @@ class AnalyticsApi {
|
|
|
1811
1811
|
|
|
1812
1812
|
|
|
1813
1813
|
/**
|
|
1814
|
-
* Delete/cancel an async
|
|
1814
|
+
* Delete/cancel an async details job
|
|
1815
1815
|
*
|
|
1816
1816
|
* @param {String} jobId jobId
|
|
1817
1817
|
*/
|
|
@@ -1895,6 +1895,7 @@ class AnalyticsApi {
|
|
|
1895
1895
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
1896
1896
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
1897
1897
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
1898
|
+
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
1898
1899
|
*/
|
|
1899
1900
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
1900
1901
|
opts = opts || {};
|
|
@@ -1908,7 +1909,7 @@ class AnalyticsApi {
|
|
|
1908
1909
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
1909
1910
|
'GET',
|
|
1910
1911
|
{ 'botFlowId': botFlowId },
|
|
1911
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
1912
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
1912
1913
|
{ },
|
|
1913
1914
|
{ },
|
|
1914
1915
|
null,
|
|
@@ -1993,7 +1994,7 @@ class AnalyticsApi {
|
|
|
1993
1994
|
}
|
|
1994
1995
|
|
|
1995
1996
|
/**
|
|
1996
|
-
* Fetch a page of results for an async
|
|
1997
|
+
* Fetch a page of results for an async details job
|
|
1997
1998
|
*
|
|
1998
1999
|
* @param {String} jobId jobId
|
|
1999
2000
|
* @param {Object} opts Optional parameters
|
|
@@ -3048,7 +3049,7 @@ class ArchitectApi {
|
|
|
3048
3049
|
/**
|
|
3049
3050
|
* Architect service.
|
|
3050
3051
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3051
|
-
* @version
|
|
3052
|
+
* @version 154.0.0
|
|
3052
3053
|
*/
|
|
3053
3054
|
|
|
3054
3055
|
/**
|
|
@@ -3807,6 +3808,7 @@ class ArchitectApi {
|
|
|
3807
3808
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
3808
3809
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
3809
3810
|
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
3811
|
+
* @param {String} opts.scheduleGroup The Schedule Group of the IVR to filter by.
|
|
3810
3812
|
*/
|
|
3811
3813
|
getArchitectIvrs(opts) {
|
|
3812
3814
|
opts = opts || {};
|
|
@@ -3816,7 +3818,7 @@ class ArchitectApi {
|
|
|
3816
3818
|
'/api/v2/architect/ivrs',
|
|
3817
3819
|
'GET',
|
|
3818
3820
|
{ },
|
|
3819
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
3821
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'] },
|
|
3820
3822
|
{ },
|
|
3821
3823
|
{ },
|
|
3822
3824
|
null,
|
|
@@ -6095,7 +6097,7 @@ class AuditApi {
|
|
|
6095
6097
|
/**
|
|
6096
6098
|
* Audit service.
|
|
6097
6099
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6098
|
-
* @version
|
|
6100
|
+
* @version 154.0.0
|
|
6099
6101
|
*/
|
|
6100
6102
|
|
|
6101
6103
|
/**
|
|
@@ -6266,7 +6268,7 @@ class AuthorizationApi {
|
|
|
6266
6268
|
/**
|
|
6267
6269
|
* Authorization service.
|
|
6268
6270
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6269
|
-
* @version
|
|
6271
|
+
* @version 154.0.0
|
|
6270
6272
|
*/
|
|
6271
6273
|
|
|
6272
6274
|
/**
|
|
@@ -6799,6 +6801,26 @@ class AuthorizationApi {
|
|
|
6799
6801
|
);
|
|
6800
6802
|
}
|
|
6801
6803
|
|
|
6804
|
+
/**
|
|
6805
|
+
* Get authorization settings
|
|
6806
|
+
*
|
|
6807
|
+
*/
|
|
6808
|
+
getAuthorizationSettings() {
|
|
6809
|
+
|
|
6810
|
+
return this.apiClient.callApi(
|
|
6811
|
+
'/api/v2/authorization/settings',
|
|
6812
|
+
'GET',
|
|
6813
|
+
{ },
|
|
6814
|
+
{ },
|
|
6815
|
+
{ },
|
|
6816
|
+
{ },
|
|
6817
|
+
null,
|
|
6818
|
+
['PureCloud OAuth'],
|
|
6819
|
+
['application/json'],
|
|
6820
|
+
['application/json']
|
|
6821
|
+
);
|
|
6822
|
+
}
|
|
6823
|
+
|
|
6802
6824
|
/**
|
|
6803
6825
|
* Returns a listing of roles and permissions for a user.
|
|
6804
6826
|
*
|
|
@@ -6923,6 +6945,31 @@ class AuthorizationApi {
|
|
|
6923
6945
|
);
|
|
6924
6946
|
}
|
|
6925
6947
|
|
|
6948
|
+
/**
|
|
6949
|
+
* Change authorization settings
|
|
6950
|
+
* Change authorization settings
|
|
6951
|
+
* @param {Object} body Authorization Settings
|
|
6952
|
+
*/
|
|
6953
|
+
patchAuthorizationSettings(body) {
|
|
6954
|
+
// verify the required parameter 'body' is set
|
|
6955
|
+
if (body === undefined || body === null) {
|
|
6956
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
6957
|
+
}
|
|
6958
|
+
|
|
6959
|
+
return this.apiClient.callApi(
|
|
6960
|
+
'/api/v2/authorization/settings',
|
|
6961
|
+
'PATCH',
|
|
6962
|
+
{ },
|
|
6963
|
+
{ },
|
|
6964
|
+
{ },
|
|
6965
|
+
{ },
|
|
6966
|
+
body,
|
|
6967
|
+
['PureCloud OAuth'],
|
|
6968
|
+
['application/json'],
|
|
6969
|
+
['application/json']
|
|
6970
|
+
);
|
|
6971
|
+
}
|
|
6972
|
+
|
|
6926
6973
|
/**
|
|
6927
6974
|
* Assign a list of objects to a division
|
|
6928
6975
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
@@ -7449,7 +7496,7 @@ class BillingApi {
|
|
|
7449
7496
|
/**
|
|
7450
7497
|
* Billing service.
|
|
7451
7498
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7452
|
-
* @version
|
|
7499
|
+
* @version 154.0.0
|
|
7453
7500
|
*/
|
|
7454
7501
|
|
|
7455
7502
|
/**
|
|
@@ -7529,7 +7576,7 @@ class ChatApi {
|
|
|
7529
7576
|
/**
|
|
7530
7577
|
* Chat service.
|
|
7531
7578
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7532
|
-
* @version
|
|
7579
|
+
* @version 154.0.0
|
|
7533
7580
|
*/
|
|
7534
7581
|
|
|
7535
7582
|
/**
|
|
@@ -7620,7 +7667,7 @@ class CoachingApi {
|
|
|
7620
7667
|
/**
|
|
7621
7668
|
* Coaching service.
|
|
7622
7669
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7623
|
-
* @version
|
|
7670
|
+
* @version 154.0.0
|
|
7624
7671
|
*/
|
|
7625
7672
|
|
|
7626
7673
|
/**
|
|
@@ -8197,7 +8244,7 @@ class ContentManagementApi {
|
|
|
8197
8244
|
/**
|
|
8198
8245
|
* ContentManagement service.
|
|
8199
8246
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8200
|
-
* @version
|
|
8247
|
+
* @version 154.0.0
|
|
8201
8248
|
*/
|
|
8202
8249
|
|
|
8203
8250
|
/**
|
|
@@ -9337,7 +9384,7 @@ class ConversationsApi {
|
|
|
9337
9384
|
/**
|
|
9338
9385
|
* Conversations service.
|
|
9339
9386
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9340
|
-
* @version
|
|
9387
|
+
* @version 154.0.0
|
|
9341
9388
|
*/
|
|
9342
9389
|
|
|
9343
9390
|
/**
|
|
@@ -9353,7 +9400,7 @@ class ConversationsApi {
|
|
|
9353
9400
|
|
|
9354
9401
|
|
|
9355
9402
|
/**
|
|
9356
|
-
* Delete/cancel an async
|
|
9403
|
+
* Delete/cancel an async details job
|
|
9357
9404
|
*
|
|
9358
9405
|
* @param {String} jobId jobId
|
|
9359
9406
|
*/
|
|
@@ -9727,7 +9774,7 @@ class ConversationsApi {
|
|
|
9727
9774
|
}
|
|
9728
9775
|
|
|
9729
9776
|
/**
|
|
9730
|
-
* Fetch a page of results for an async
|
|
9777
|
+
* Fetch a page of results for an async details job
|
|
9731
9778
|
*
|
|
9732
9779
|
* @param {String} jobId jobId
|
|
9733
9780
|
* @param {Object} opts Optional parameters
|
|
@@ -14560,7 +14607,7 @@ class DataExtensionsApi {
|
|
|
14560
14607
|
/**
|
|
14561
14608
|
* DataExtensions service.
|
|
14562
14609
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14563
|
-
* @version
|
|
14610
|
+
* @version 154.0.0
|
|
14564
14611
|
*/
|
|
14565
14612
|
|
|
14566
14613
|
/**
|
|
@@ -14646,7 +14693,7 @@ class DownloadsApi {
|
|
|
14646
14693
|
/**
|
|
14647
14694
|
* Downloads service.
|
|
14648
14695
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14649
|
-
* @version
|
|
14696
|
+
* @version 154.0.0
|
|
14650
14697
|
*/
|
|
14651
14698
|
|
|
14652
14699
|
/**
|
|
@@ -14698,7 +14745,7 @@ class EventsApi {
|
|
|
14698
14745
|
/**
|
|
14699
14746
|
* Events service.
|
|
14700
14747
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14701
|
-
* @version
|
|
14748
|
+
* @version 154.0.0
|
|
14702
14749
|
*/
|
|
14703
14750
|
|
|
14704
14751
|
/**
|
|
@@ -14794,7 +14841,7 @@ class ExternalContactsApi {
|
|
|
14794
14841
|
/**
|
|
14795
14842
|
* ExternalContacts service.
|
|
14796
14843
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14797
|
-
* @version
|
|
14844
|
+
* @version 154.0.0
|
|
14798
14845
|
*/
|
|
14799
14846
|
|
|
14800
14847
|
/**
|
|
@@ -16752,7 +16799,7 @@ class FaxApi {
|
|
|
16752
16799
|
/**
|
|
16753
16800
|
* Fax service.
|
|
16754
16801
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16755
|
-
* @version
|
|
16802
|
+
* @version 154.0.0
|
|
16756
16803
|
*/
|
|
16757
16804
|
|
|
16758
16805
|
/**
|
|
@@ -16923,7 +16970,7 @@ class FlowsApi {
|
|
|
16923
16970
|
/**
|
|
16924
16971
|
* Flows service.
|
|
16925
16972
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16926
|
-
* @version
|
|
16973
|
+
* @version 154.0.0
|
|
16927
16974
|
*/
|
|
16928
16975
|
|
|
16929
16976
|
/**
|
|
@@ -16994,7 +17041,7 @@ class GamificationApi {
|
|
|
16994
17041
|
/**
|
|
16995
17042
|
* Gamification service.
|
|
16996
17043
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16997
|
-
* @version
|
|
17044
|
+
* @version 154.0.0
|
|
16998
17045
|
*/
|
|
16999
17046
|
|
|
17000
17047
|
/**
|
|
@@ -18611,7 +18658,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18611
18658
|
/**
|
|
18612
18659
|
* GeneralDataProtectionRegulation service.
|
|
18613
18660
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18614
|
-
* @version
|
|
18661
|
+
* @version 154.0.0
|
|
18615
18662
|
*/
|
|
18616
18663
|
|
|
18617
18664
|
/**
|
|
@@ -18741,7 +18788,7 @@ class GeolocationApi {
|
|
|
18741
18788
|
/**
|
|
18742
18789
|
* Geolocation service.
|
|
18743
18790
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18744
|
-
* @version
|
|
18791
|
+
* @version 154.0.0
|
|
18745
18792
|
*/
|
|
18746
18793
|
|
|
18747
18794
|
/**
|
|
@@ -18872,7 +18919,7 @@ class GreetingsApi {
|
|
|
18872
18919
|
/**
|
|
18873
18920
|
* Greetings service.
|
|
18874
18921
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18875
|
-
* @version
|
|
18922
|
+
* @version 154.0.0
|
|
18876
18923
|
*/
|
|
18877
18924
|
|
|
18878
18925
|
/**
|
|
@@ -19327,7 +19374,7 @@ class GroupsApi {
|
|
|
19327
19374
|
/**
|
|
19328
19375
|
* Groups service.
|
|
19329
19376
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19330
|
-
* @version
|
|
19377
|
+
* @version 154.0.0
|
|
19331
19378
|
*/
|
|
19332
19379
|
|
|
19333
19380
|
/**
|
|
@@ -19733,7 +19780,7 @@ class IdentityProviderApi {
|
|
|
19733
19780
|
/**
|
|
19734
19781
|
* IdentityProvider service.
|
|
19735
19782
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19736
|
-
* @version
|
|
19783
|
+
* @version 154.0.0
|
|
19737
19784
|
*/
|
|
19738
19785
|
|
|
19739
19786
|
/**
|
|
@@ -20489,7 +20536,7 @@ class IntegrationsApi {
|
|
|
20489
20536
|
/**
|
|
20490
20537
|
* Integrations service.
|
|
20491
20538
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20492
|
-
* @version
|
|
20539
|
+
* @version 154.0.0
|
|
20493
20540
|
*/
|
|
20494
20541
|
|
|
20495
20542
|
/**
|
|
@@ -22089,7 +22136,7 @@ class JourneyApi {
|
|
|
22089
22136
|
/**
|
|
22090
22137
|
* Journey service.
|
|
22091
22138
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22092
|
-
* @version
|
|
22139
|
+
* @version 154.0.0
|
|
22093
22140
|
*/
|
|
22094
22141
|
|
|
22095
22142
|
/**
|
|
@@ -22875,7 +22922,7 @@ class KnowledgeApi {
|
|
|
22875
22922
|
/**
|
|
22876
22923
|
* Knowledge service.
|
|
22877
22924
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22878
|
-
* @version
|
|
22925
|
+
* @version 154.0.0
|
|
22879
22926
|
*/
|
|
22880
22927
|
|
|
22881
22928
|
/**
|
|
@@ -25308,7 +25355,7 @@ class LanguageUnderstandingApi {
|
|
|
25308
25355
|
/**
|
|
25309
25356
|
* LanguageUnderstanding service.
|
|
25310
25357
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25311
|
-
* @version
|
|
25358
|
+
* @version 154.0.0
|
|
25312
25359
|
*/
|
|
25313
25360
|
|
|
25314
25361
|
/**
|
|
@@ -26212,7 +26259,7 @@ class LanguagesApi {
|
|
|
26212
26259
|
/**
|
|
26213
26260
|
* Languages service.
|
|
26214
26261
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26215
|
-
* @version
|
|
26262
|
+
* @version 154.0.0
|
|
26216
26263
|
*/
|
|
26217
26264
|
|
|
26218
26265
|
/**
|
|
@@ -26480,7 +26527,7 @@ class LearningApi {
|
|
|
26480
26527
|
/**
|
|
26481
26528
|
* Learning service.
|
|
26482
26529
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26483
|
-
* @version
|
|
26530
|
+
* @version 154.0.0
|
|
26484
26531
|
*/
|
|
26485
26532
|
|
|
26486
26533
|
/**
|
|
@@ -26780,6 +26827,7 @@ class LearningApi {
|
|
|
26780
26827
|
* @param {String} opts.searchTerm Search Term (searchable by name)
|
|
26781
26828
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
26782
26829
|
* @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
|
|
26830
|
+
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
26783
26831
|
*/
|
|
26784
26832
|
getLearningModules(opts) {
|
|
26785
26833
|
opts = opts || {};
|
|
@@ -26789,7 +26837,7 @@ class LearningApi {
|
|
|
26789
26837
|
'/api/v2/learning/modules',
|
|
26790
26838
|
'GET',
|
|
26791
26839
|
{ },
|
|
26792
|
-
{ 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'] },
|
|
26840
|
+
{ 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi') },
|
|
26793
26841
|
{ },
|
|
26794
26842
|
{ },
|
|
26795
26843
|
null,
|
|
@@ -27240,7 +27288,7 @@ class LicenseApi {
|
|
|
27240
27288
|
/**
|
|
27241
27289
|
* License service.
|
|
27242
27290
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27243
|
-
* @version
|
|
27291
|
+
* @version 154.0.0
|
|
27244
27292
|
*/
|
|
27245
27293
|
|
|
27246
27294
|
/**
|
|
@@ -27478,7 +27526,7 @@ class LocationsApi {
|
|
|
27478
27526
|
/**
|
|
27479
27527
|
* Locations service.
|
|
27480
27528
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27481
|
-
* @version
|
|
27529
|
+
* @version 154.0.0
|
|
27482
27530
|
*/
|
|
27483
27531
|
|
|
27484
27532
|
/**
|
|
@@ -27714,7 +27762,7 @@ class MessagingApi {
|
|
|
27714
27762
|
/**
|
|
27715
27763
|
* Messaging service.
|
|
27716
27764
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27717
|
-
* @version
|
|
27765
|
+
* @version 154.0.0
|
|
27718
27766
|
*/
|
|
27719
27767
|
|
|
27720
27768
|
/**
|
|
@@ -27865,7 +27913,7 @@ class MobileDevicesApi {
|
|
|
27865
27913
|
/**
|
|
27866
27914
|
* MobileDevices service.
|
|
27867
27915
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27868
|
-
* @version
|
|
27916
|
+
* @version 154.0.0
|
|
27869
27917
|
*/
|
|
27870
27918
|
|
|
27871
27919
|
/**
|
|
@@ -28016,7 +28064,7 @@ class NotificationsApi {
|
|
|
28016
28064
|
/**
|
|
28017
28065
|
* Notifications service.
|
|
28018
28066
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28019
|
-
* @version
|
|
28067
|
+
* @version 154.0.0
|
|
28020
28068
|
*/
|
|
28021
28069
|
|
|
28022
28070
|
/**
|
|
@@ -28241,7 +28289,7 @@ class OAuthApi {
|
|
|
28241
28289
|
/**
|
|
28242
28290
|
* OAuth service.
|
|
28243
28291
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28244
|
-
* @version
|
|
28292
|
+
* @version 154.0.0
|
|
28245
28293
|
*/
|
|
28246
28294
|
|
|
28247
28295
|
/**
|
|
@@ -28607,7 +28655,7 @@ class ObjectsApi {
|
|
|
28607
28655
|
/**
|
|
28608
28656
|
* Objects service.
|
|
28609
28657
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28610
|
-
* @version
|
|
28658
|
+
* @version 154.0.0
|
|
28611
28659
|
*/
|
|
28612
28660
|
|
|
28613
28661
|
/**
|
|
@@ -28878,7 +28926,7 @@ class OrganizationApi {
|
|
|
28878
28926
|
/**
|
|
28879
28927
|
* Organization service.
|
|
28880
28928
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28881
|
-
* @version
|
|
28929
|
+
* @version 154.0.0
|
|
28882
28930
|
*/
|
|
28883
28931
|
|
|
28884
28932
|
/**
|
|
@@ -29281,7 +29329,7 @@ class OrganizationAuthorizationApi {
|
|
|
29281
29329
|
/**
|
|
29282
29330
|
* OrganizationAuthorization service.
|
|
29283
29331
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29284
|
-
* @version
|
|
29332
|
+
* @version 154.0.0
|
|
29285
29333
|
*/
|
|
29286
29334
|
|
|
29287
29335
|
/**
|
|
@@ -30206,7 +30254,7 @@ class OutboundApi {
|
|
|
30206
30254
|
/**
|
|
30207
30255
|
* Outbound service.
|
|
30208
30256
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30209
|
-
* @version
|
|
30257
|
+
* @version 154.0.0
|
|
30210
30258
|
*/
|
|
30211
30259
|
|
|
30212
30260
|
/**
|
|
@@ -32830,6 +32878,36 @@ class OutboundApi {
|
|
|
32830
32878
|
);
|
|
32831
32879
|
}
|
|
32832
32880
|
|
|
32881
|
+
/**
|
|
32882
|
+
* Add email addresses to a DNC list.
|
|
32883
|
+
* Only Internal DNC lists may be appended to
|
|
32884
|
+
* @param {String} dncListId DncList ID
|
|
32885
|
+
* @param {Array.<String>} body DNC email addresses
|
|
32886
|
+
*/
|
|
32887
|
+
postOutboundDnclistEmailaddresses(dncListId, body) {
|
|
32888
|
+
// verify the required parameter 'dncListId' is set
|
|
32889
|
+
if (dncListId === undefined || dncListId === null) {
|
|
32890
|
+
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistEmailaddresses';
|
|
32891
|
+
}
|
|
32892
|
+
// verify the required parameter 'body' is set
|
|
32893
|
+
if (body === undefined || body === null) {
|
|
32894
|
+
throw 'Missing the required parameter "body" when calling postOutboundDnclistEmailaddresses';
|
|
32895
|
+
}
|
|
32896
|
+
|
|
32897
|
+
return this.apiClient.callApi(
|
|
32898
|
+
'/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
|
|
32899
|
+
'POST',
|
|
32900
|
+
{ 'dncListId': dncListId },
|
|
32901
|
+
{ },
|
|
32902
|
+
{ },
|
|
32903
|
+
{ },
|
|
32904
|
+
body,
|
|
32905
|
+
['PureCloud OAuth'],
|
|
32906
|
+
['application/json'],
|
|
32907
|
+
['application/json']
|
|
32908
|
+
);
|
|
32909
|
+
}
|
|
32910
|
+
|
|
32833
32911
|
/**
|
|
32834
32912
|
* Initiate the export of a dnc list.
|
|
32835
32913
|
* Returns 200 if received OK.
|
|
@@ -33595,7 +33673,7 @@ class PresenceApi {
|
|
|
33595
33673
|
/**
|
|
33596
33674
|
* Presence service.
|
|
33597
33675
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33598
|
-
* @version
|
|
33676
|
+
* @version 154.0.0
|
|
33599
33677
|
*/
|
|
33600
33678
|
|
|
33601
33679
|
/**
|
|
@@ -34101,7 +34179,7 @@ class ProcessAutomationApi {
|
|
|
34101
34179
|
/**
|
|
34102
34180
|
* ProcessAutomation service.
|
|
34103
34181
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34104
|
-
* @version
|
|
34182
|
+
* @version 154.0.0
|
|
34105
34183
|
*/
|
|
34106
34184
|
|
|
34107
34185
|
/**
|
|
@@ -34339,7 +34417,7 @@ class QualityApi {
|
|
|
34339
34417
|
/**
|
|
34340
34418
|
* Quality service.
|
|
34341
34419
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34342
|
-
* @version
|
|
34420
|
+
* @version 154.0.0
|
|
34343
34421
|
*/
|
|
34344
34422
|
|
|
34345
34423
|
/**
|
|
@@ -35917,7 +35995,7 @@ class RecordingApi {
|
|
|
35917
35995
|
/**
|
|
35918
35996
|
* Recording service.
|
|
35919
35997
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35920
|
-
* @version
|
|
35998
|
+
* @version 154.0.0
|
|
35921
35999
|
*/
|
|
35922
36000
|
|
|
35923
36001
|
/**
|
|
@@ -36619,7 +36697,7 @@ class RecordingApi {
|
|
|
36619
36697
|
}
|
|
36620
36698
|
|
|
36621
36699
|
/**
|
|
36622
|
-
* Get the local encryption settings
|
|
36700
|
+
* Get the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
36623
36701
|
*
|
|
36624
36702
|
* @param {String} settingsId Settings Id
|
|
36625
36703
|
*/
|
|
@@ -36644,7 +36722,7 @@ class RecordingApi {
|
|
|
36644
36722
|
}
|
|
36645
36723
|
|
|
36646
36724
|
/**
|
|
36647
|
-
* gets a list local key settings data
|
|
36725
|
+
* gets a list local key settings data. Replaced by API recording/keyconfigurations
|
|
36648
36726
|
*
|
|
36649
36727
|
*/
|
|
36650
36728
|
getRecordingLocalkeysSettings() {
|
|
@@ -37096,7 +37174,7 @@ class RecordingApi {
|
|
|
37096
37174
|
}
|
|
37097
37175
|
|
|
37098
37176
|
/**
|
|
37099
|
-
* create a local recording key
|
|
37177
|
+
* create a local key management recording key
|
|
37100
37178
|
*
|
|
37101
37179
|
* @param {Object} body Local Encryption body
|
|
37102
37180
|
*/
|
|
@@ -37121,7 +37199,7 @@ class RecordingApi {
|
|
|
37121
37199
|
}
|
|
37122
37200
|
|
|
37123
37201
|
/**
|
|
37124
|
-
* create settings for local key creation
|
|
37202
|
+
* create settings for local key creation. Replaced by API recording/keyconfigurations
|
|
37125
37203
|
*
|
|
37126
37204
|
* @param {Object} body Local Encryption Configuration
|
|
37127
37205
|
*/
|
|
@@ -37464,7 +37542,7 @@ class RecordingApi {
|
|
|
37464
37542
|
}
|
|
37465
37543
|
|
|
37466
37544
|
/**
|
|
37467
|
-
* Update the local encryption settings
|
|
37545
|
+
* Update the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
37468
37546
|
*
|
|
37469
37547
|
* @param {String} settingsId Settings Id
|
|
37470
37548
|
* @param {Object} body Local Encryption metadata
|
|
@@ -37604,7 +37682,7 @@ class ResponseManagementApi {
|
|
|
37604
37682
|
/**
|
|
37605
37683
|
* ResponseManagement service.
|
|
37606
37684
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37607
|
-
* @version
|
|
37685
|
+
* @version 154.0.0
|
|
37608
37686
|
*/
|
|
37609
37687
|
|
|
37610
37688
|
/**
|
|
@@ -38088,7 +38166,7 @@ class RoutingApi {
|
|
|
38088
38166
|
/**
|
|
38089
38167
|
* Routing service.
|
|
38090
38168
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38091
|
-
* @version
|
|
38169
|
+
* @version 154.0.0
|
|
38092
38170
|
*/
|
|
38093
38171
|
|
|
38094
38172
|
/**
|
|
@@ -38814,6 +38892,8 @@ class RoutingApi {
|
|
|
38814
38892
|
* Get domains
|
|
38815
38893
|
*
|
|
38816
38894
|
* @param {Object} opts Optional parameters
|
|
38895
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38896
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38817
38897
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
38818
38898
|
*/
|
|
38819
38899
|
getRoutingEmailDomains(opts) {
|
|
@@ -38824,7 +38904,7 @@ class RoutingApi {
|
|
|
38824
38904
|
'/api/v2/routing/email/domains',
|
|
38825
38905
|
'GET',
|
|
38826
38906
|
{ },
|
|
38827
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
38907
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
38828
38908
|
{ },
|
|
38829
38909
|
{ },
|
|
38830
38910
|
null,
|
|
@@ -41501,7 +41581,7 @@ class SCIMApi {
|
|
|
41501
41581
|
/**
|
|
41502
41582
|
* SCIM service.
|
|
41503
41583
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41504
|
-
* @version
|
|
41584
|
+
* @version 154.0.0
|
|
41505
41585
|
*/
|
|
41506
41586
|
|
|
41507
41587
|
/**
|
|
@@ -42378,7 +42458,7 @@ class ScriptsApi {
|
|
|
42378
42458
|
/**
|
|
42379
42459
|
* Scripts service.
|
|
42380
42460
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42381
|
-
* @version
|
|
42461
|
+
* @version 154.0.0
|
|
42382
42462
|
*/
|
|
42383
42463
|
|
|
42384
42464
|
/**
|
|
@@ -42797,7 +42877,7 @@ class SearchApi {
|
|
|
42797
42877
|
/**
|
|
42798
42878
|
* Search service.
|
|
42799
42879
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42800
|
-
* @version
|
|
42880
|
+
* @version 154.0.0
|
|
42801
42881
|
*/
|
|
42802
42882
|
|
|
42803
42883
|
/**
|
|
@@ -43382,7 +43462,7 @@ class SpeechTextAnalyticsApi {
|
|
|
43382
43462
|
/**
|
|
43383
43463
|
* SpeechTextAnalytics service.
|
|
43384
43464
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43385
|
-
* @version
|
|
43465
|
+
* @version 154.0.0
|
|
43386
43466
|
*/
|
|
43387
43467
|
|
|
43388
43468
|
/**
|
|
@@ -44236,7 +44316,7 @@ class StationsApi {
|
|
|
44236
44316
|
/**
|
|
44237
44317
|
* Stations service.
|
|
44238
44318
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44239
|
-
* @version
|
|
44319
|
+
* @version 154.0.0
|
|
44240
44320
|
*/
|
|
44241
44321
|
|
|
44242
44322
|
/**
|
|
@@ -44383,7 +44463,7 @@ class SuggestApi {
|
|
|
44383
44463
|
/**
|
|
44384
44464
|
* Suggest service.
|
|
44385
44465
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44386
|
-
* @version
|
|
44466
|
+
* @version 154.0.0
|
|
44387
44467
|
*/
|
|
44388
44468
|
|
|
44389
44469
|
/**
|
|
@@ -44522,7 +44602,7 @@ class TeamsApi {
|
|
|
44522
44602
|
/**
|
|
44523
44603
|
* Teams service.
|
|
44524
44604
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44525
|
-
* @version
|
|
44605
|
+
* @version 154.0.0
|
|
44526
44606
|
*/
|
|
44527
44607
|
|
|
44528
44608
|
/**
|
|
@@ -44793,7 +44873,7 @@ class TelephonyApi {
|
|
|
44793
44873
|
/**
|
|
44794
44874
|
* Telephony service.
|
|
44795
44875
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44796
|
-
* @version
|
|
44876
|
+
* @version 154.0.0
|
|
44797
44877
|
*/
|
|
44798
44878
|
|
|
44799
44879
|
/**
|
|
@@ -44901,7 +44981,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
44901
44981
|
/**
|
|
44902
44982
|
* TelephonyProvidersEdge service.
|
|
44903
44983
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44904
|
-
* @version
|
|
44984
|
+
* @version 154.0.0
|
|
44905
44985
|
*/
|
|
44906
44986
|
|
|
44907
44987
|
/**
|
|
@@ -48534,7 +48614,7 @@ class TextbotsApi {
|
|
|
48534
48614
|
/**
|
|
48535
48615
|
* Textbots service.
|
|
48536
48616
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48537
|
-
* @version
|
|
48617
|
+
* @version 154.0.0
|
|
48538
48618
|
*/
|
|
48539
48619
|
|
|
48540
48620
|
/**
|
|
@@ -48662,7 +48742,7 @@ class TokensApi {
|
|
|
48662
48742
|
/**
|
|
48663
48743
|
* Tokens service.
|
|
48664
48744
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48665
|
-
* @version
|
|
48745
|
+
* @version 154.0.0
|
|
48666
48746
|
*/
|
|
48667
48747
|
|
|
48668
48748
|
/**
|
|
@@ -48768,7 +48848,7 @@ class UploadsApi {
|
|
|
48768
48848
|
/**
|
|
48769
48849
|
* Uploads service.
|
|
48770
48850
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48771
|
-
* @version
|
|
48851
|
+
* @version 154.0.0
|
|
48772
48852
|
*/
|
|
48773
48853
|
|
|
48774
48854
|
/**
|
|
@@ -48944,7 +49024,7 @@ class UsageApi {
|
|
|
48944
49024
|
/**
|
|
48945
49025
|
* Usage service.
|
|
48946
49026
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48947
|
-
* @version
|
|
49027
|
+
* @version 154.0.0
|
|
48948
49028
|
*/
|
|
48949
49029
|
|
|
48950
49030
|
/**
|
|
@@ -49015,7 +49095,7 @@ class UserRecordingsApi {
|
|
|
49015
49095
|
/**
|
|
49016
49096
|
* UserRecordings service.
|
|
49017
49097
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49018
|
-
* @version
|
|
49098
|
+
* @version 154.0.0
|
|
49019
49099
|
*/
|
|
49020
49100
|
|
|
49021
49101
|
/**
|
|
@@ -49200,7 +49280,7 @@ class UsersApi {
|
|
|
49200
49280
|
/**
|
|
49201
49281
|
* Users service.
|
|
49202
49282
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49203
|
-
* @version
|
|
49283
|
+
* @version 154.0.0
|
|
49204
49284
|
*/
|
|
49205
49285
|
|
|
49206
49286
|
/**
|
|
@@ -51557,7 +51637,7 @@ class UtilitiesApi {
|
|
|
51557
51637
|
/**
|
|
51558
51638
|
* Utilities service.
|
|
51559
51639
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51560
|
-
* @version
|
|
51640
|
+
* @version 154.0.0
|
|
51561
51641
|
*/
|
|
51562
51642
|
|
|
51563
51643
|
/**
|
|
@@ -51668,7 +51748,7 @@ class VoicemailApi {
|
|
|
51668
51748
|
/**
|
|
51669
51749
|
* Voicemail service.
|
|
51670
51750
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51671
|
-
* @version
|
|
51751
|
+
* @version 154.0.0
|
|
51672
51752
|
*/
|
|
51673
51753
|
|
|
51674
51754
|
/**
|
|
@@ -52335,7 +52415,7 @@ class WebChatApi {
|
|
|
52335
52415
|
/**
|
|
52336
52416
|
* WebChat service.
|
|
52337
52417
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52338
|
-
* @version
|
|
52418
|
+
* @version 154.0.0
|
|
52339
52419
|
*/
|
|
52340
52420
|
|
|
52341
52421
|
/**
|
|
@@ -52879,7 +52959,7 @@ class WebDeploymentsApi {
|
|
|
52879
52959
|
/**
|
|
52880
52960
|
* WebDeployments service.
|
|
52881
52961
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52882
|
-
* @version
|
|
52962
|
+
* @version 154.0.0
|
|
52883
52963
|
*/
|
|
52884
52964
|
|
|
52885
52965
|
/**
|
|
@@ -53267,7 +53347,7 @@ class WebMessagingApi {
|
|
|
53267
53347
|
/**
|
|
53268
53348
|
* WebMessaging service.
|
|
53269
53349
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53270
|
-
* @version
|
|
53350
|
+
* @version 154.0.0
|
|
53271
53351
|
*/
|
|
53272
53352
|
|
|
53273
53353
|
/**
|
|
@@ -53313,7 +53393,7 @@ class WidgetsApi {
|
|
|
53313
53393
|
/**
|
|
53314
53394
|
* Widgets service.
|
|
53315
53395
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53316
|
-
* @version
|
|
53396
|
+
* @version 154.0.0
|
|
53317
53397
|
*/
|
|
53318
53398
|
|
|
53319
53399
|
/**
|
|
@@ -53459,7 +53539,7 @@ class WorkforceManagementApi {
|
|
|
53459
53539
|
/**
|
|
53460
53540
|
* WorkforceManagement service.
|
|
53461
53541
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53462
|
-
* @version
|
|
53542
|
+
* @version 154.0.0
|
|
53463
53543
|
*/
|
|
53464
53544
|
|
|
53465
53545
|
/**
|
|
@@ -53879,6 +53959,56 @@ class WorkforceManagementApi {
|
|
|
53879
53959
|
);
|
|
53880
53960
|
}
|
|
53881
53961
|
|
|
53962
|
+
/**
|
|
53963
|
+
* Get an adherence explanation for the current user
|
|
53964
|
+
*
|
|
53965
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
53966
|
+
*/
|
|
53967
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
53968
|
+
// verify the required parameter 'explanationId' is set
|
|
53969
|
+
if (explanationId === undefined || explanationId === null) {
|
|
53970
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
53971
|
+
}
|
|
53972
|
+
|
|
53973
|
+
return this.apiClient.callApi(
|
|
53974
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
53975
|
+
'GET',
|
|
53976
|
+
{ 'explanationId': explanationId },
|
|
53977
|
+
{ },
|
|
53978
|
+
{ },
|
|
53979
|
+
{ },
|
|
53980
|
+
null,
|
|
53981
|
+
['PureCloud OAuth'],
|
|
53982
|
+
['application/json'],
|
|
53983
|
+
['application/json']
|
|
53984
|
+
);
|
|
53985
|
+
}
|
|
53986
|
+
|
|
53987
|
+
/**
|
|
53988
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
53989
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
53990
|
+
* @param {String} jobId The ID of the job
|
|
53991
|
+
*/
|
|
53992
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
53993
|
+
// verify the required parameter 'jobId' is set
|
|
53994
|
+
if (jobId === undefined || jobId === null) {
|
|
53995
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
53996
|
+
}
|
|
53997
|
+
|
|
53998
|
+
return this.apiClient.callApi(
|
|
53999
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
54000
|
+
'GET',
|
|
54001
|
+
{ 'jobId': jobId },
|
|
54002
|
+
{ },
|
|
54003
|
+
{ },
|
|
54004
|
+
{ },
|
|
54005
|
+
null,
|
|
54006
|
+
['PureCloud OAuth'],
|
|
54007
|
+
['application/json'],
|
|
54008
|
+
['application/json']
|
|
54009
|
+
);
|
|
54010
|
+
}
|
|
54011
|
+
|
|
53882
54012
|
/**
|
|
53883
54013
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
53884
54014
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -53929,6 +54059,36 @@ class WorkforceManagementApi {
|
|
|
53929
54059
|
);
|
|
53930
54060
|
}
|
|
53931
54061
|
|
|
54062
|
+
/**
|
|
54063
|
+
* Get an adherence explanation
|
|
54064
|
+
*
|
|
54065
|
+
* @param {String} agentId The ID of the agent to query
|
|
54066
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
54067
|
+
*/
|
|
54068
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
54069
|
+
// verify the required parameter 'agentId' is set
|
|
54070
|
+
if (agentId === undefined || agentId === null) {
|
|
54071
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54072
|
+
}
|
|
54073
|
+
// verify the required parameter 'explanationId' is set
|
|
54074
|
+
if (explanationId === undefined || explanationId === null) {
|
|
54075
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54076
|
+
}
|
|
54077
|
+
|
|
54078
|
+
return this.apiClient.callApi(
|
|
54079
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
54080
|
+
'GET',
|
|
54081
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
54082
|
+
{ },
|
|
54083
|
+
{ },
|
|
54084
|
+
{ },
|
|
54085
|
+
null,
|
|
54086
|
+
['PureCloud OAuth'],
|
|
54087
|
+
['application/json'],
|
|
54088
|
+
['application/json']
|
|
54089
|
+
);
|
|
54090
|
+
}
|
|
54091
|
+
|
|
53932
54092
|
/**
|
|
53933
54093
|
* Get the management unit to which the agent belongs
|
|
53934
54094
|
*
|
|
@@ -55648,6 +55808,31 @@ class WorkforceManagementApi {
|
|
|
55648
55808
|
);
|
|
55649
55809
|
}
|
|
55650
55810
|
|
|
55811
|
+
/**
|
|
55812
|
+
* Request to fetch the status of the historical shrinkage query
|
|
55813
|
+
*
|
|
55814
|
+
* @param {String} jobId jobId
|
|
55815
|
+
*/
|
|
55816
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
55817
|
+
// verify the required parameter 'jobId' is set
|
|
55818
|
+
if (jobId === undefined || jobId === null) {
|
|
55819
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
55820
|
+
}
|
|
55821
|
+
|
|
55822
|
+
return this.apiClient.callApi(
|
|
55823
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
55824
|
+
'GET',
|
|
55825
|
+
{ 'jobId': jobId },
|
|
55826
|
+
{ },
|
|
55827
|
+
{ },
|
|
55828
|
+
{ },
|
|
55829
|
+
null,
|
|
55830
|
+
['PureCloud OAuth'],
|
|
55831
|
+
['application/json'],
|
|
55832
|
+
['application/json']
|
|
55833
|
+
);
|
|
55834
|
+
}
|
|
55835
|
+
|
|
55651
55836
|
/**
|
|
55652
55837
|
* Get a time off request for the current user
|
|
55653
55838
|
*
|
|
@@ -55722,6 +55907,41 @@ class WorkforceManagementApi {
|
|
|
55722
55907
|
);
|
|
55723
55908
|
}
|
|
55724
55909
|
|
|
55910
|
+
/**
|
|
55911
|
+
* Update an adherence explanation
|
|
55912
|
+
*
|
|
55913
|
+
* @param {String} agentId The ID of the agent to query
|
|
55914
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55915
|
+
* @param {Object} body The request body
|
|
55916
|
+
*/
|
|
55917
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
55918
|
+
// verify the required parameter 'agentId' is set
|
|
55919
|
+
if (agentId === undefined || agentId === null) {
|
|
55920
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55921
|
+
}
|
|
55922
|
+
// verify the required parameter 'explanationId' is set
|
|
55923
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55924
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55925
|
+
}
|
|
55926
|
+
// verify the required parameter 'body' is set
|
|
55927
|
+
if (body === undefined || body === null) {
|
|
55928
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55929
|
+
}
|
|
55930
|
+
|
|
55931
|
+
return this.apiClient.callApi(
|
|
55932
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
55933
|
+
'PATCH',
|
|
55934
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
55935
|
+
{ },
|
|
55936
|
+
{ },
|
|
55937
|
+
{ },
|
|
55938
|
+
body,
|
|
55939
|
+
['PureCloud OAuth'],
|
|
55940
|
+
['application/json'],
|
|
55941
|
+
['application/json']
|
|
55942
|
+
);
|
|
55943
|
+
}
|
|
55944
|
+
|
|
55725
55945
|
/**
|
|
55726
55946
|
* Update business unit
|
|
55727
55947
|
*
|
|
@@ -56161,6 +56381,61 @@ class WorkforceManagementApi {
|
|
|
56161
56381
|
);
|
|
56162
56382
|
}
|
|
56163
56383
|
|
|
56384
|
+
/**
|
|
56385
|
+
* Submit an adherence explanation for the current user
|
|
56386
|
+
*
|
|
56387
|
+
* @param {Object} body The request body
|
|
56388
|
+
*/
|
|
56389
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
56390
|
+
// verify the required parameter 'body' is set
|
|
56391
|
+
if (body === undefined || body === null) {
|
|
56392
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
56393
|
+
}
|
|
56394
|
+
|
|
56395
|
+
return this.apiClient.callApi(
|
|
56396
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
56397
|
+
'POST',
|
|
56398
|
+
{ },
|
|
56399
|
+
{ },
|
|
56400
|
+
{ },
|
|
56401
|
+
{ },
|
|
56402
|
+
body,
|
|
56403
|
+
['PureCloud OAuth'],
|
|
56404
|
+
['application/json'],
|
|
56405
|
+
['application/json']
|
|
56406
|
+
);
|
|
56407
|
+
}
|
|
56408
|
+
|
|
56409
|
+
/**
|
|
56410
|
+
* Query adherence explanations for the current user
|
|
56411
|
+
*
|
|
56412
|
+
* @param {Object} body The request body
|
|
56413
|
+
* @param {Object} opts Optional parameters
|
|
56414
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56415
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56416
|
+
*/
|
|
56417
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
56418
|
+
opts = opts || {};
|
|
56419
|
+
|
|
56420
|
+
// verify the required parameter 'body' is set
|
|
56421
|
+
if (body === undefined || body === null) {
|
|
56422
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
56423
|
+
}
|
|
56424
|
+
|
|
56425
|
+
return this.apiClient.callApi(
|
|
56426
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
56427
|
+
'POST',
|
|
56428
|
+
{ },
|
|
56429
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56430
|
+
{ },
|
|
56431
|
+
{ },
|
|
56432
|
+
body,
|
|
56433
|
+
['PureCloud OAuth'],
|
|
56434
|
+
['application/json'],
|
|
56435
|
+
['application/json']
|
|
56436
|
+
);
|
|
56437
|
+
}
|
|
56438
|
+
|
|
56164
56439
|
/**
|
|
56165
56440
|
* Request a historical adherence report for users across management units
|
|
56166
56441
|
*
|
|
@@ -56185,6 +56460,71 @@ class WorkforceManagementApi {
|
|
|
56185
56460
|
);
|
|
56186
56461
|
}
|
|
56187
56462
|
|
|
56463
|
+
/**
|
|
56464
|
+
* Add an adherence explanation for the requested user
|
|
56465
|
+
*
|
|
56466
|
+
* @param {String} agentId The ID of the agent to query
|
|
56467
|
+
* @param {Object} body The request body
|
|
56468
|
+
*/
|
|
56469
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
56470
|
+
// verify the required parameter 'agentId' is set
|
|
56471
|
+
if (agentId === undefined || agentId === null) {
|
|
56472
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56473
|
+
}
|
|
56474
|
+
// verify the required parameter 'body' is set
|
|
56475
|
+
if (body === undefined || body === null) {
|
|
56476
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56477
|
+
}
|
|
56478
|
+
|
|
56479
|
+
return this.apiClient.callApi(
|
|
56480
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
56481
|
+
'POST',
|
|
56482
|
+
{ 'agentId': agentId },
|
|
56483
|
+
{ },
|
|
56484
|
+
{ },
|
|
56485
|
+
{ },
|
|
56486
|
+
body,
|
|
56487
|
+
['PureCloud OAuth'],
|
|
56488
|
+
['application/json'],
|
|
56489
|
+
['application/json']
|
|
56490
|
+
);
|
|
56491
|
+
}
|
|
56492
|
+
|
|
56493
|
+
/**
|
|
56494
|
+
* Query adherence explanations for the given agent across a specified range
|
|
56495
|
+
*
|
|
56496
|
+
* @param {String} agentId The ID of the agent to query
|
|
56497
|
+
* @param {Object} body The request body
|
|
56498
|
+
* @param {Object} opts Optional parameters
|
|
56499
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56500
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56501
|
+
*/
|
|
56502
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
56503
|
+
opts = opts || {};
|
|
56504
|
+
|
|
56505
|
+
// verify the required parameter 'agentId' is set
|
|
56506
|
+
if (agentId === undefined || agentId === null) {
|
|
56507
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56508
|
+
}
|
|
56509
|
+
// verify the required parameter 'body' is set
|
|
56510
|
+
if (body === undefined || body === null) {
|
|
56511
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56512
|
+
}
|
|
56513
|
+
|
|
56514
|
+
return this.apiClient.callApi(
|
|
56515
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
56516
|
+
'POST',
|
|
56517
|
+
{ 'agentId': agentId },
|
|
56518
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56519
|
+
{ },
|
|
56520
|
+
{ },
|
|
56521
|
+
body,
|
|
56522
|
+
['PureCloud OAuth'],
|
|
56523
|
+
['application/json'],
|
|
56524
|
+
['application/json']
|
|
56525
|
+
);
|
|
56526
|
+
}
|
|
56527
|
+
|
|
56188
56528
|
/**
|
|
56189
56529
|
* Get published schedule for the current user
|
|
56190
56530
|
*
|
|
@@ -56238,6 +56578,41 @@ class WorkforceManagementApi {
|
|
|
56238
56578
|
);
|
|
56239
56579
|
}
|
|
56240
56580
|
|
|
56581
|
+
/**
|
|
56582
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
56583
|
+
*
|
|
56584
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
56585
|
+
* @param {Object} body The request body
|
|
56586
|
+
* @param {Object} opts Optional parameters
|
|
56587
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56588
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56589
|
+
*/
|
|
56590
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
56591
|
+
opts = opts || {};
|
|
56592
|
+
|
|
56593
|
+
// verify the required parameter 'businessUnitId' is set
|
|
56594
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
56595
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56596
|
+
}
|
|
56597
|
+
// verify the required parameter 'body' is set
|
|
56598
|
+
if (body === undefined || body === null) {
|
|
56599
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56600
|
+
}
|
|
56601
|
+
|
|
56602
|
+
return this.apiClient.callApi(
|
|
56603
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
56604
|
+
'POST',
|
|
56605
|
+
{ 'businessUnitId': businessUnitId },
|
|
56606
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56607
|
+
{ },
|
|
56608
|
+
{ },
|
|
56609
|
+
body,
|
|
56610
|
+
['PureCloud OAuth'],
|
|
56611
|
+
['application/json'],
|
|
56612
|
+
['application/json']
|
|
56613
|
+
);
|
|
56614
|
+
}
|
|
56615
|
+
|
|
56241
56616
|
/**
|
|
56242
56617
|
* Search published schedules
|
|
56243
56618
|
*
|
|
@@ -57065,6 +57440,35 @@ class WorkforceManagementApi {
|
|
|
57065
57440
|
);
|
|
57066
57441
|
}
|
|
57067
57442
|
|
|
57443
|
+
/**
|
|
57444
|
+
* Request a historical shrinkage report
|
|
57445
|
+
* The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
|
|
57446
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57447
|
+
* @param {Object} opts Optional parameters
|
|
57448
|
+
* @param {Object} opts.body body
|
|
57449
|
+
*/
|
|
57450
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
57451
|
+
opts = opts || {};
|
|
57452
|
+
|
|
57453
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57454
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57455
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
57456
|
+
}
|
|
57457
|
+
|
|
57458
|
+
return this.apiClient.callApi(
|
|
57459
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
57460
|
+
'POST',
|
|
57461
|
+
{ 'managementUnitId': managementUnitId },
|
|
57462
|
+
{ },
|
|
57463
|
+
{ },
|
|
57464
|
+
{ },
|
|
57465
|
+
opts['body'],
|
|
57466
|
+
['PureCloud OAuth'],
|
|
57467
|
+
['application/json'],
|
|
57468
|
+
['application/json']
|
|
57469
|
+
);
|
|
57470
|
+
}
|
|
57471
|
+
|
|
57068
57472
|
/**
|
|
57069
57473
|
* Creates a new time off limit object under management unit.
|
|
57070
57474
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -57805,7 +58209,7 @@ class WorkforceManagementApi {
|
|
|
57805
58209
|
* </pre>
|
|
57806
58210
|
* </p>
|
|
57807
58211
|
* @module purecloud-platform-client-v2/index
|
|
57808
|
-
* @version
|
|
58212
|
+
* @version 154.0.0
|
|
57809
58213
|
*/
|
|
57810
58214
|
class platformClient {
|
|
57811
58215
|
constructor() {
|