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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 154.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3351,7 +3351,7 @@ class AlertingApi {
|
|
|
3351
3351
|
/**
|
|
3352
3352
|
* Alerting service.
|
|
3353
3353
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3354
|
-
* @version
|
|
3354
|
+
* @version 154.0.0
|
|
3355
3355
|
*/
|
|
3356
3356
|
|
|
3357
3357
|
/**
|
|
@@ -3665,7 +3665,7 @@ class AnalyticsApi {
|
|
|
3665
3665
|
/**
|
|
3666
3666
|
* Analytics service.
|
|
3667
3667
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3668
|
-
* @version
|
|
3668
|
+
* @version 154.0.0
|
|
3669
3669
|
*/
|
|
3670
3670
|
|
|
3671
3671
|
/**
|
|
@@ -3681,7 +3681,7 @@ class AnalyticsApi {
|
|
|
3681
3681
|
|
|
3682
3682
|
|
|
3683
3683
|
/**
|
|
3684
|
-
* Delete/cancel an async
|
|
3684
|
+
* Delete/cancel an async details job
|
|
3685
3685
|
*
|
|
3686
3686
|
* @param {String} jobId jobId
|
|
3687
3687
|
*/
|
|
@@ -3765,6 +3765,7 @@ class AnalyticsApi {
|
|
|
3765
3765
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
3766
3766
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
3767
3767
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
3768
|
+
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
3768
3769
|
*/
|
|
3769
3770
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
3770
3771
|
opts = opts || {};
|
|
@@ -3778,7 +3779,7 @@ class AnalyticsApi {
|
|
|
3778
3779
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
3779
3780
|
'GET',
|
|
3780
3781
|
{ 'botFlowId': botFlowId },
|
|
3781
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
3782
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
3782
3783
|
{ },
|
|
3783
3784
|
{ },
|
|
3784
3785
|
null,
|
|
@@ -3863,7 +3864,7 @@ class AnalyticsApi {
|
|
|
3863
3864
|
}
|
|
3864
3865
|
|
|
3865
3866
|
/**
|
|
3866
|
-
* Fetch a page of results for an async
|
|
3867
|
+
* Fetch a page of results for an async details job
|
|
3867
3868
|
*
|
|
3868
3869
|
* @param {String} jobId jobId
|
|
3869
3870
|
* @param {Object} opts Optional parameters
|
|
@@ -4918,7 +4919,7 @@ class ArchitectApi {
|
|
|
4918
4919
|
/**
|
|
4919
4920
|
* Architect service.
|
|
4920
4921
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4921
|
-
* @version
|
|
4922
|
+
* @version 154.0.0
|
|
4922
4923
|
*/
|
|
4923
4924
|
|
|
4924
4925
|
/**
|
|
@@ -5677,6 +5678,7 @@ class ArchitectApi {
|
|
|
5677
5678
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5678
5679
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
5679
5680
|
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
5681
|
+
* @param {String} opts.scheduleGroup The Schedule Group of the IVR to filter by.
|
|
5680
5682
|
*/
|
|
5681
5683
|
getArchitectIvrs(opts) {
|
|
5682
5684
|
opts = opts || {};
|
|
@@ -5686,7 +5688,7 @@ class ArchitectApi {
|
|
|
5686
5688
|
'/api/v2/architect/ivrs',
|
|
5687
5689
|
'GET',
|
|
5688
5690
|
{ },
|
|
5689
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
5691
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'] },
|
|
5690
5692
|
{ },
|
|
5691
5693
|
{ },
|
|
5692
5694
|
null,
|
|
@@ -7965,7 +7967,7 @@ class AuditApi {
|
|
|
7965
7967
|
/**
|
|
7966
7968
|
* Audit service.
|
|
7967
7969
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7968
|
-
* @version
|
|
7970
|
+
* @version 154.0.0
|
|
7969
7971
|
*/
|
|
7970
7972
|
|
|
7971
7973
|
/**
|
|
@@ -8136,7 +8138,7 @@ class AuthorizationApi {
|
|
|
8136
8138
|
/**
|
|
8137
8139
|
* Authorization service.
|
|
8138
8140
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8139
|
-
* @version
|
|
8141
|
+
* @version 154.0.0
|
|
8140
8142
|
*/
|
|
8141
8143
|
|
|
8142
8144
|
/**
|
|
@@ -8669,6 +8671,26 @@ class AuthorizationApi {
|
|
|
8669
8671
|
);
|
|
8670
8672
|
}
|
|
8671
8673
|
|
|
8674
|
+
/**
|
|
8675
|
+
* Get authorization settings
|
|
8676
|
+
*
|
|
8677
|
+
*/
|
|
8678
|
+
getAuthorizationSettings() {
|
|
8679
|
+
|
|
8680
|
+
return this.apiClient.callApi(
|
|
8681
|
+
'/api/v2/authorization/settings',
|
|
8682
|
+
'GET',
|
|
8683
|
+
{ },
|
|
8684
|
+
{ },
|
|
8685
|
+
{ },
|
|
8686
|
+
{ },
|
|
8687
|
+
null,
|
|
8688
|
+
['PureCloud OAuth'],
|
|
8689
|
+
['application/json'],
|
|
8690
|
+
['application/json']
|
|
8691
|
+
);
|
|
8692
|
+
}
|
|
8693
|
+
|
|
8672
8694
|
/**
|
|
8673
8695
|
* Returns a listing of roles and permissions for a user.
|
|
8674
8696
|
*
|
|
@@ -8793,6 +8815,31 @@ class AuthorizationApi {
|
|
|
8793
8815
|
);
|
|
8794
8816
|
}
|
|
8795
8817
|
|
|
8818
|
+
/**
|
|
8819
|
+
* Change authorization settings
|
|
8820
|
+
* Change authorization settings
|
|
8821
|
+
* @param {Object} body Authorization Settings
|
|
8822
|
+
*/
|
|
8823
|
+
patchAuthorizationSettings(body) {
|
|
8824
|
+
// verify the required parameter 'body' is set
|
|
8825
|
+
if (body === undefined || body === null) {
|
|
8826
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
8827
|
+
}
|
|
8828
|
+
|
|
8829
|
+
return this.apiClient.callApi(
|
|
8830
|
+
'/api/v2/authorization/settings',
|
|
8831
|
+
'PATCH',
|
|
8832
|
+
{ },
|
|
8833
|
+
{ },
|
|
8834
|
+
{ },
|
|
8835
|
+
{ },
|
|
8836
|
+
body,
|
|
8837
|
+
['PureCloud OAuth'],
|
|
8838
|
+
['application/json'],
|
|
8839
|
+
['application/json']
|
|
8840
|
+
);
|
|
8841
|
+
}
|
|
8842
|
+
|
|
8796
8843
|
/**
|
|
8797
8844
|
* Assign a list of objects to a division
|
|
8798
8845
|
* 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"]
|
|
@@ -9319,7 +9366,7 @@ class BillingApi {
|
|
|
9319
9366
|
/**
|
|
9320
9367
|
* Billing service.
|
|
9321
9368
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9322
|
-
* @version
|
|
9369
|
+
* @version 154.0.0
|
|
9323
9370
|
*/
|
|
9324
9371
|
|
|
9325
9372
|
/**
|
|
@@ -9399,7 +9446,7 @@ class ChatApi {
|
|
|
9399
9446
|
/**
|
|
9400
9447
|
* Chat service.
|
|
9401
9448
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9402
|
-
* @version
|
|
9449
|
+
* @version 154.0.0
|
|
9403
9450
|
*/
|
|
9404
9451
|
|
|
9405
9452
|
/**
|
|
@@ -9490,7 +9537,7 @@ class CoachingApi {
|
|
|
9490
9537
|
/**
|
|
9491
9538
|
* Coaching service.
|
|
9492
9539
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9493
|
-
* @version
|
|
9540
|
+
* @version 154.0.0
|
|
9494
9541
|
*/
|
|
9495
9542
|
|
|
9496
9543
|
/**
|
|
@@ -10067,7 +10114,7 @@ class ContentManagementApi {
|
|
|
10067
10114
|
/**
|
|
10068
10115
|
* ContentManagement service.
|
|
10069
10116
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10070
|
-
* @version
|
|
10117
|
+
* @version 154.0.0
|
|
10071
10118
|
*/
|
|
10072
10119
|
|
|
10073
10120
|
/**
|
|
@@ -11207,7 +11254,7 @@ class ConversationsApi {
|
|
|
11207
11254
|
/**
|
|
11208
11255
|
* Conversations service.
|
|
11209
11256
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11210
|
-
* @version
|
|
11257
|
+
* @version 154.0.0
|
|
11211
11258
|
*/
|
|
11212
11259
|
|
|
11213
11260
|
/**
|
|
@@ -11223,7 +11270,7 @@ class ConversationsApi {
|
|
|
11223
11270
|
|
|
11224
11271
|
|
|
11225
11272
|
/**
|
|
11226
|
-
* Delete/cancel an async
|
|
11273
|
+
* Delete/cancel an async details job
|
|
11227
11274
|
*
|
|
11228
11275
|
* @param {String} jobId jobId
|
|
11229
11276
|
*/
|
|
@@ -11597,7 +11644,7 @@ class ConversationsApi {
|
|
|
11597
11644
|
}
|
|
11598
11645
|
|
|
11599
11646
|
/**
|
|
11600
|
-
* Fetch a page of results for an async
|
|
11647
|
+
* Fetch a page of results for an async details job
|
|
11601
11648
|
*
|
|
11602
11649
|
* @param {String} jobId jobId
|
|
11603
11650
|
* @param {Object} opts Optional parameters
|
|
@@ -16430,7 +16477,7 @@ class DataExtensionsApi {
|
|
|
16430
16477
|
/**
|
|
16431
16478
|
* DataExtensions service.
|
|
16432
16479
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16433
|
-
* @version
|
|
16480
|
+
* @version 154.0.0
|
|
16434
16481
|
*/
|
|
16435
16482
|
|
|
16436
16483
|
/**
|
|
@@ -16516,7 +16563,7 @@ class DownloadsApi {
|
|
|
16516
16563
|
/**
|
|
16517
16564
|
* Downloads service.
|
|
16518
16565
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
16519
|
-
* @version
|
|
16566
|
+
* @version 154.0.0
|
|
16520
16567
|
*/
|
|
16521
16568
|
|
|
16522
16569
|
/**
|
|
@@ -16568,7 +16615,7 @@ class EventsApi {
|
|
|
16568
16615
|
/**
|
|
16569
16616
|
* Events service.
|
|
16570
16617
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
16571
|
-
* @version
|
|
16618
|
+
* @version 154.0.0
|
|
16572
16619
|
*/
|
|
16573
16620
|
|
|
16574
16621
|
/**
|
|
@@ -16664,7 +16711,7 @@ class ExternalContactsApi {
|
|
|
16664
16711
|
/**
|
|
16665
16712
|
* ExternalContacts service.
|
|
16666
16713
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16667
|
-
* @version
|
|
16714
|
+
* @version 154.0.0
|
|
16668
16715
|
*/
|
|
16669
16716
|
|
|
16670
16717
|
/**
|
|
@@ -18622,7 +18669,7 @@ class FaxApi {
|
|
|
18622
18669
|
/**
|
|
18623
18670
|
* Fax service.
|
|
18624
18671
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
18625
|
-
* @version
|
|
18672
|
+
* @version 154.0.0
|
|
18626
18673
|
*/
|
|
18627
18674
|
|
|
18628
18675
|
/**
|
|
@@ -18793,7 +18840,7 @@ class FlowsApi {
|
|
|
18793
18840
|
/**
|
|
18794
18841
|
* Flows service.
|
|
18795
18842
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18796
|
-
* @version
|
|
18843
|
+
* @version 154.0.0
|
|
18797
18844
|
*/
|
|
18798
18845
|
|
|
18799
18846
|
/**
|
|
@@ -18864,7 +18911,7 @@ class GamificationApi {
|
|
|
18864
18911
|
/**
|
|
18865
18912
|
* Gamification service.
|
|
18866
18913
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18867
|
-
* @version
|
|
18914
|
+
* @version 154.0.0
|
|
18868
18915
|
*/
|
|
18869
18916
|
|
|
18870
18917
|
/**
|
|
@@ -20481,7 +20528,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
20481
20528
|
/**
|
|
20482
20529
|
* GeneralDataProtectionRegulation service.
|
|
20483
20530
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
20484
|
-
* @version
|
|
20531
|
+
* @version 154.0.0
|
|
20485
20532
|
*/
|
|
20486
20533
|
|
|
20487
20534
|
/**
|
|
@@ -20611,7 +20658,7 @@ class GeolocationApi {
|
|
|
20611
20658
|
/**
|
|
20612
20659
|
* Geolocation service.
|
|
20613
20660
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20614
|
-
* @version
|
|
20661
|
+
* @version 154.0.0
|
|
20615
20662
|
*/
|
|
20616
20663
|
|
|
20617
20664
|
/**
|
|
@@ -20742,7 +20789,7 @@ class GreetingsApi {
|
|
|
20742
20789
|
/**
|
|
20743
20790
|
* Greetings service.
|
|
20744
20791
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20745
|
-
* @version
|
|
20792
|
+
* @version 154.0.0
|
|
20746
20793
|
*/
|
|
20747
20794
|
|
|
20748
20795
|
/**
|
|
@@ -21197,7 +21244,7 @@ class GroupsApi {
|
|
|
21197
21244
|
/**
|
|
21198
21245
|
* Groups service.
|
|
21199
21246
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
21200
|
-
* @version
|
|
21247
|
+
* @version 154.0.0
|
|
21201
21248
|
*/
|
|
21202
21249
|
|
|
21203
21250
|
/**
|
|
@@ -21603,7 +21650,7 @@ class IdentityProviderApi {
|
|
|
21603
21650
|
/**
|
|
21604
21651
|
* IdentityProvider service.
|
|
21605
21652
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21606
|
-
* @version
|
|
21653
|
+
* @version 154.0.0
|
|
21607
21654
|
*/
|
|
21608
21655
|
|
|
21609
21656
|
/**
|
|
@@ -22359,7 +22406,7 @@ class IntegrationsApi {
|
|
|
22359
22406
|
/**
|
|
22360
22407
|
* Integrations service.
|
|
22361
22408
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
22362
|
-
* @version
|
|
22409
|
+
* @version 154.0.0
|
|
22363
22410
|
*/
|
|
22364
22411
|
|
|
22365
22412
|
/**
|
|
@@ -23959,7 +24006,7 @@ class JourneyApi {
|
|
|
23959
24006
|
/**
|
|
23960
24007
|
* Journey service.
|
|
23961
24008
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23962
|
-
* @version
|
|
24009
|
+
* @version 154.0.0
|
|
23963
24010
|
*/
|
|
23964
24011
|
|
|
23965
24012
|
/**
|
|
@@ -24745,7 +24792,7 @@ class KnowledgeApi {
|
|
|
24745
24792
|
/**
|
|
24746
24793
|
* Knowledge service.
|
|
24747
24794
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24748
|
-
* @version
|
|
24795
|
+
* @version 154.0.0
|
|
24749
24796
|
*/
|
|
24750
24797
|
|
|
24751
24798
|
/**
|
|
@@ -27178,7 +27225,7 @@ class LanguageUnderstandingApi {
|
|
|
27178
27225
|
/**
|
|
27179
27226
|
* LanguageUnderstanding service.
|
|
27180
27227
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
27181
|
-
* @version
|
|
27228
|
+
* @version 154.0.0
|
|
27182
27229
|
*/
|
|
27183
27230
|
|
|
27184
27231
|
/**
|
|
@@ -28082,7 +28129,7 @@ class LanguagesApi {
|
|
|
28082
28129
|
/**
|
|
28083
28130
|
* Languages service.
|
|
28084
28131
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
28085
|
-
* @version
|
|
28132
|
+
* @version 154.0.0
|
|
28086
28133
|
*/
|
|
28087
28134
|
|
|
28088
28135
|
/**
|
|
@@ -28350,7 +28397,7 @@ class LearningApi {
|
|
|
28350
28397
|
/**
|
|
28351
28398
|
* Learning service.
|
|
28352
28399
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
28353
|
-
* @version
|
|
28400
|
+
* @version 154.0.0
|
|
28354
28401
|
*/
|
|
28355
28402
|
|
|
28356
28403
|
/**
|
|
@@ -28650,6 +28697,7 @@ class LearningApi {
|
|
|
28650
28697
|
* @param {String} opts.searchTerm Search Term (searchable by name)
|
|
28651
28698
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
28652
28699
|
* @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)
|
|
28700
|
+
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
28653
28701
|
*/
|
|
28654
28702
|
getLearningModules(opts) {
|
|
28655
28703
|
opts = opts || {};
|
|
@@ -28659,7 +28707,7 @@ class LearningApi {
|
|
|
28659
28707
|
'/api/v2/learning/modules',
|
|
28660
28708
|
'GET',
|
|
28661
28709
|
{ },
|
|
28662
|
-
{ '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'] },
|
|
28710
|
+
{ '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') },
|
|
28663
28711
|
{ },
|
|
28664
28712
|
{ },
|
|
28665
28713
|
null,
|
|
@@ -29110,7 +29158,7 @@ class LicenseApi {
|
|
|
29110
29158
|
/**
|
|
29111
29159
|
* License service.
|
|
29112
29160
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
29113
|
-
* @version
|
|
29161
|
+
* @version 154.0.0
|
|
29114
29162
|
*/
|
|
29115
29163
|
|
|
29116
29164
|
/**
|
|
@@ -29348,7 +29396,7 @@ class LocationsApi {
|
|
|
29348
29396
|
/**
|
|
29349
29397
|
* Locations service.
|
|
29350
29398
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
29351
|
-
* @version
|
|
29399
|
+
* @version 154.0.0
|
|
29352
29400
|
*/
|
|
29353
29401
|
|
|
29354
29402
|
/**
|
|
@@ -29584,7 +29632,7 @@ class MessagingApi {
|
|
|
29584
29632
|
/**
|
|
29585
29633
|
* Messaging service.
|
|
29586
29634
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
29587
|
-
* @version
|
|
29635
|
+
* @version 154.0.0
|
|
29588
29636
|
*/
|
|
29589
29637
|
|
|
29590
29638
|
/**
|
|
@@ -29735,7 +29783,7 @@ class MobileDevicesApi {
|
|
|
29735
29783
|
/**
|
|
29736
29784
|
* MobileDevices service.
|
|
29737
29785
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
29738
|
-
* @version
|
|
29786
|
+
* @version 154.0.0
|
|
29739
29787
|
*/
|
|
29740
29788
|
|
|
29741
29789
|
/**
|
|
@@ -29886,7 +29934,7 @@ class NotificationsApi {
|
|
|
29886
29934
|
/**
|
|
29887
29935
|
* Notifications service.
|
|
29888
29936
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
29889
|
-
* @version
|
|
29937
|
+
* @version 154.0.0
|
|
29890
29938
|
*/
|
|
29891
29939
|
|
|
29892
29940
|
/**
|
|
@@ -30111,7 +30159,7 @@ class OAuthApi {
|
|
|
30111
30159
|
/**
|
|
30112
30160
|
* OAuth service.
|
|
30113
30161
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
30114
|
-
* @version
|
|
30162
|
+
* @version 154.0.0
|
|
30115
30163
|
*/
|
|
30116
30164
|
|
|
30117
30165
|
/**
|
|
@@ -30477,7 +30525,7 @@ class ObjectsApi {
|
|
|
30477
30525
|
/**
|
|
30478
30526
|
* Objects service.
|
|
30479
30527
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
30480
|
-
* @version
|
|
30528
|
+
* @version 154.0.0
|
|
30481
30529
|
*/
|
|
30482
30530
|
|
|
30483
30531
|
/**
|
|
@@ -30748,7 +30796,7 @@ class OrganizationApi {
|
|
|
30748
30796
|
/**
|
|
30749
30797
|
* Organization service.
|
|
30750
30798
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
30751
|
-
* @version
|
|
30799
|
+
* @version 154.0.0
|
|
30752
30800
|
*/
|
|
30753
30801
|
|
|
30754
30802
|
/**
|
|
@@ -31151,7 +31199,7 @@ class OrganizationAuthorizationApi {
|
|
|
31151
31199
|
/**
|
|
31152
31200
|
* OrganizationAuthorization service.
|
|
31153
31201
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
31154
|
-
* @version
|
|
31202
|
+
* @version 154.0.0
|
|
31155
31203
|
*/
|
|
31156
31204
|
|
|
31157
31205
|
/**
|
|
@@ -32076,7 +32124,7 @@ class OutboundApi {
|
|
|
32076
32124
|
/**
|
|
32077
32125
|
* Outbound service.
|
|
32078
32126
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
32079
|
-
* @version
|
|
32127
|
+
* @version 154.0.0
|
|
32080
32128
|
*/
|
|
32081
32129
|
|
|
32082
32130
|
/**
|
|
@@ -34700,6 +34748,36 @@ class OutboundApi {
|
|
|
34700
34748
|
);
|
|
34701
34749
|
}
|
|
34702
34750
|
|
|
34751
|
+
/**
|
|
34752
|
+
* Add email addresses to a DNC list.
|
|
34753
|
+
* Only Internal DNC lists may be appended to
|
|
34754
|
+
* @param {String} dncListId DncList ID
|
|
34755
|
+
* @param {Array.<String>} body DNC email addresses
|
|
34756
|
+
*/
|
|
34757
|
+
postOutboundDnclistEmailaddresses(dncListId, body) {
|
|
34758
|
+
// verify the required parameter 'dncListId' is set
|
|
34759
|
+
if (dncListId === undefined || dncListId === null) {
|
|
34760
|
+
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistEmailaddresses';
|
|
34761
|
+
}
|
|
34762
|
+
// verify the required parameter 'body' is set
|
|
34763
|
+
if (body === undefined || body === null) {
|
|
34764
|
+
throw 'Missing the required parameter "body" when calling postOutboundDnclistEmailaddresses';
|
|
34765
|
+
}
|
|
34766
|
+
|
|
34767
|
+
return this.apiClient.callApi(
|
|
34768
|
+
'/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
|
|
34769
|
+
'POST',
|
|
34770
|
+
{ 'dncListId': dncListId },
|
|
34771
|
+
{ },
|
|
34772
|
+
{ },
|
|
34773
|
+
{ },
|
|
34774
|
+
body,
|
|
34775
|
+
['PureCloud OAuth'],
|
|
34776
|
+
['application/json'],
|
|
34777
|
+
['application/json']
|
|
34778
|
+
);
|
|
34779
|
+
}
|
|
34780
|
+
|
|
34703
34781
|
/**
|
|
34704
34782
|
* Initiate the export of a dnc list.
|
|
34705
34783
|
* Returns 200 if received OK.
|
|
@@ -35465,7 +35543,7 @@ class PresenceApi {
|
|
|
35465
35543
|
/**
|
|
35466
35544
|
* Presence service.
|
|
35467
35545
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
35468
|
-
* @version
|
|
35546
|
+
* @version 154.0.0
|
|
35469
35547
|
*/
|
|
35470
35548
|
|
|
35471
35549
|
/**
|
|
@@ -35971,7 +36049,7 @@ class ProcessAutomationApi {
|
|
|
35971
36049
|
/**
|
|
35972
36050
|
* ProcessAutomation service.
|
|
35973
36051
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
35974
|
-
* @version
|
|
36052
|
+
* @version 154.0.0
|
|
35975
36053
|
*/
|
|
35976
36054
|
|
|
35977
36055
|
/**
|
|
@@ -36209,7 +36287,7 @@ class QualityApi {
|
|
|
36209
36287
|
/**
|
|
36210
36288
|
* Quality service.
|
|
36211
36289
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
36212
|
-
* @version
|
|
36290
|
+
* @version 154.0.0
|
|
36213
36291
|
*/
|
|
36214
36292
|
|
|
36215
36293
|
/**
|
|
@@ -37787,7 +37865,7 @@ class RecordingApi {
|
|
|
37787
37865
|
/**
|
|
37788
37866
|
* Recording service.
|
|
37789
37867
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
37790
|
-
* @version
|
|
37868
|
+
* @version 154.0.0
|
|
37791
37869
|
*/
|
|
37792
37870
|
|
|
37793
37871
|
/**
|
|
@@ -38489,7 +38567,7 @@ class RecordingApi {
|
|
|
38489
38567
|
}
|
|
38490
38568
|
|
|
38491
38569
|
/**
|
|
38492
|
-
* Get the local encryption settings
|
|
38570
|
+
* Get the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
38493
38571
|
*
|
|
38494
38572
|
* @param {String} settingsId Settings Id
|
|
38495
38573
|
*/
|
|
@@ -38514,7 +38592,7 @@ class RecordingApi {
|
|
|
38514
38592
|
}
|
|
38515
38593
|
|
|
38516
38594
|
/**
|
|
38517
|
-
* gets a list local key settings data
|
|
38595
|
+
* gets a list local key settings data. Replaced by API recording/keyconfigurations
|
|
38518
38596
|
*
|
|
38519
38597
|
*/
|
|
38520
38598
|
getRecordingLocalkeysSettings() {
|
|
@@ -38966,7 +39044,7 @@ class RecordingApi {
|
|
|
38966
39044
|
}
|
|
38967
39045
|
|
|
38968
39046
|
/**
|
|
38969
|
-
* create a local recording key
|
|
39047
|
+
* create a local key management recording key
|
|
38970
39048
|
*
|
|
38971
39049
|
* @param {Object} body Local Encryption body
|
|
38972
39050
|
*/
|
|
@@ -38991,7 +39069,7 @@ class RecordingApi {
|
|
|
38991
39069
|
}
|
|
38992
39070
|
|
|
38993
39071
|
/**
|
|
38994
|
-
* create settings for local key creation
|
|
39072
|
+
* create settings for local key creation. Replaced by API recording/keyconfigurations
|
|
38995
39073
|
*
|
|
38996
39074
|
* @param {Object} body Local Encryption Configuration
|
|
38997
39075
|
*/
|
|
@@ -39334,7 +39412,7 @@ class RecordingApi {
|
|
|
39334
39412
|
}
|
|
39335
39413
|
|
|
39336
39414
|
/**
|
|
39337
|
-
* Update the local encryption settings
|
|
39415
|
+
* Update the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
39338
39416
|
*
|
|
39339
39417
|
* @param {String} settingsId Settings Id
|
|
39340
39418
|
* @param {Object} body Local Encryption metadata
|
|
@@ -39474,7 +39552,7 @@ class ResponseManagementApi {
|
|
|
39474
39552
|
/**
|
|
39475
39553
|
* ResponseManagement service.
|
|
39476
39554
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
39477
|
-
* @version
|
|
39555
|
+
* @version 154.0.0
|
|
39478
39556
|
*/
|
|
39479
39557
|
|
|
39480
39558
|
/**
|
|
@@ -39958,7 +40036,7 @@ class RoutingApi {
|
|
|
39958
40036
|
/**
|
|
39959
40037
|
* Routing service.
|
|
39960
40038
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
39961
|
-
* @version
|
|
40039
|
+
* @version 154.0.0
|
|
39962
40040
|
*/
|
|
39963
40041
|
|
|
39964
40042
|
/**
|
|
@@ -40684,6 +40762,8 @@ class RoutingApi {
|
|
|
40684
40762
|
* Get domains
|
|
40685
40763
|
*
|
|
40686
40764
|
* @param {Object} opts Optional parameters
|
|
40765
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
40766
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40687
40767
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
40688
40768
|
*/
|
|
40689
40769
|
getRoutingEmailDomains(opts) {
|
|
@@ -40694,7 +40774,7 @@ class RoutingApi {
|
|
|
40694
40774
|
'/api/v2/routing/email/domains',
|
|
40695
40775
|
'GET',
|
|
40696
40776
|
{ },
|
|
40697
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
40777
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
40698
40778
|
{ },
|
|
40699
40779
|
{ },
|
|
40700
40780
|
null,
|
|
@@ -43371,7 +43451,7 @@ class SCIMApi {
|
|
|
43371
43451
|
/**
|
|
43372
43452
|
* SCIM service.
|
|
43373
43453
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
43374
|
-
* @version
|
|
43454
|
+
* @version 154.0.0
|
|
43375
43455
|
*/
|
|
43376
43456
|
|
|
43377
43457
|
/**
|
|
@@ -44248,7 +44328,7 @@ class ScriptsApi {
|
|
|
44248
44328
|
/**
|
|
44249
44329
|
* Scripts service.
|
|
44250
44330
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
44251
|
-
* @version
|
|
44331
|
+
* @version 154.0.0
|
|
44252
44332
|
*/
|
|
44253
44333
|
|
|
44254
44334
|
/**
|
|
@@ -44667,7 +44747,7 @@ class SearchApi {
|
|
|
44667
44747
|
/**
|
|
44668
44748
|
* Search service.
|
|
44669
44749
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
44670
|
-
* @version
|
|
44750
|
+
* @version 154.0.0
|
|
44671
44751
|
*/
|
|
44672
44752
|
|
|
44673
44753
|
/**
|
|
@@ -45252,7 +45332,7 @@ class SpeechTextAnalyticsApi {
|
|
|
45252
45332
|
/**
|
|
45253
45333
|
* SpeechTextAnalytics service.
|
|
45254
45334
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
45255
|
-
* @version
|
|
45335
|
+
* @version 154.0.0
|
|
45256
45336
|
*/
|
|
45257
45337
|
|
|
45258
45338
|
/**
|
|
@@ -46106,7 +46186,7 @@ class StationsApi {
|
|
|
46106
46186
|
/**
|
|
46107
46187
|
* Stations service.
|
|
46108
46188
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
46109
|
-
* @version
|
|
46189
|
+
* @version 154.0.0
|
|
46110
46190
|
*/
|
|
46111
46191
|
|
|
46112
46192
|
/**
|
|
@@ -46253,7 +46333,7 @@ class SuggestApi {
|
|
|
46253
46333
|
/**
|
|
46254
46334
|
* Suggest service.
|
|
46255
46335
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
46256
|
-
* @version
|
|
46336
|
+
* @version 154.0.0
|
|
46257
46337
|
*/
|
|
46258
46338
|
|
|
46259
46339
|
/**
|
|
@@ -46392,7 +46472,7 @@ class TeamsApi {
|
|
|
46392
46472
|
/**
|
|
46393
46473
|
* Teams service.
|
|
46394
46474
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
46395
|
-
* @version
|
|
46475
|
+
* @version 154.0.0
|
|
46396
46476
|
*/
|
|
46397
46477
|
|
|
46398
46478
|
/**
|
|
@@ -46663,7 +46743,7 @@ class TelephonyApi {
|
|
|
46663
46743
|
/**
|
|
46664
46744
|
* Telephony service.
|
|
46665
46745
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
46666
|
-
* @version
|
|
46746
|
+
* @version 154.0.0
|
|
46667
46747
|
*/
|
|
46668
46748
|
|
|
46669
46749
|
/**
|
|
@@ -46771,7 +46851,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
46771
46851
|
/**
|
|
46772
46852
|
* TelephonyProvidersEdge service.
|
|
46773
46853
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
46774
|
-
* @version
|
|
46854
|
+
* @version 154.0.0
|
|
46775
46855
|
*/
|
|
46776
46856
|
|
|
46777
46857
|
/**
|
|
@@ -50404,7 +50484,7 @@ class TextbotsApi {
|
|
|
50404
50484
|
/**
|
|
50405
50485
|
* Textbots service.
|
|
50406
50486
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
50407
|
-
* @version
|
|
50487
|
+
* @version 154.0.0
|
|
50408
50488
|
*/
|
|
50409
50489
|
|
|
50410
50490
|
/**
|
|
@@ -50532,7 +50612,7 @@ class TokensApi {
|
|
|
50532
50612
|
/**
|
|
50533
50613
|
* Tokens service.
|
|
50534
50614
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
50535
|
-
* @version
|
|
50615
|
+
* @version 154.0.0
|
|
50536
50616
|
*/
|
|
50537
50617
|
|
|
50538
50618
|
/**
|
|
@@ -50638,7 +50718,7 @@ class UploadsApi {
|
|
|
50638
50718
|
/**
|
|
50639
50719
|
* Uploads service.
|
|
50640
50720
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
50641
|
-
* @version
|
|
50721
|
+
* @version 154.0.0
|
|
50642
50722
|
*/
|
|
50643
50723
|
|
|
50644
50724
|
/**
|
|
@@ -50814,7 +50894,7 @@ class UsageApi {
|
|
|
50814
50894
|
/**
|
|
50815
50895
|
* Usage service.
|
|
50816
50896
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
50817
|
-
* @version
|
|
50897
|
+
* @version 154.0.0
|
|
50818
50898
|
*/
|
|
50819
50899
|
|
|
50820
50900
|
/**
|
|
@@ -50885,7 +50965,7 @@ class UserRecordingsApi {
|
|
|
50885
50965
|
/**
|
|
50886
50966
|
* UserRecordings service.
|
|
50887
50967
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
50888
|
-
* @version
|
|
50968
|
+
* @version 154.0.0
|
|
50889
50969
|
*/
|
|
50890
50970
|
|
|
50891
50971
|
/**
|
|
@@ -51070,7 +51150,7 @@ class UsersApi {
|
|
|
51070
51150
|
/**
|
|
51071
51151
|
* Users service.
|
|
51072
51152
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
51073
|
-
* @version
|
|
51153
|
+
* @version 154.0.0
|
|
51074
51154
|
*/
|
|
51075
51155
|
|
|
51076
51156
|
/**
|
|
@@ -53427,7 +53507,7 @@ class UtilitiesApi {
|
|
|
53427
53507
|
/**
|
|
53428
53508
|
* Utilities service.
|
|
53429
53509
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
53430
|
-
* @version
|
|
53510
|
+
* @version 154.0.0
|
|
53431
53511
|
*/
|
|
53432
53512
|
|
|
53433
53513
|
/**
|
|
@@ -53538,7 +53618,7 @@ class VoicemailApi {
|
|
|
53538
53618
|
/**
|
|
53539
53619
|
* Voicemail service.
|
|
53540
53620
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
53541
|
-
* @version
|
|
53621
|
+
* @version 154.0.0
|
|
53542
53622
|
*/
|
|
53543
53623
|
|
|
53544
53624
|
/**
|
|
@@ -54205,7 +54285,7 @@ class WebChatApi {
|
|
|
54205
54285
|
/**
|
|
54206
54286
|
* WebChat service.
|
|
54207
54287
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
54208
|
-
* @version
|
|
54288
|
+
* @version 154.0.0
|
|
54209
54289
|
*/
|
|
54210
54290
|
|
|
54211
54291
|
/**
|
|
@@ -54749,7 +54829,7 @@ class WebDeploymentsApi {
|
|
|
54749
54829
|
/**
|
|
54750
54830
|
* WebDeployments service.
|
|
54751
54831
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
54752
|
-
* @version
|
|
54832
|
+
* @version 154.0.0
|
|
54753
54833
|
*/
|
|
54754
54834
|
|
|
54755
54835
|
/**
|
|
@@ -55137,7 +55217,7 @@ class WebMessagingApi {
|
|
|
55137
55217
|
/**
|
|
55138
55218
|
* WebMessaging service.
|
|
55139
55219
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
55140
|
-
* @version
|
|
55220
|
+
* @version 154.0.0
|
|
55141
55221
|
*/
|
|
55142
55222
|
|
|
55143
55223
|
/**
|
|
@@ -55183,7 +55263,7 @@ class WidgetsApi {
|
|
|
55183
55263
|
/**
|
|
55184
55264
|
* Widgets service.
|
|
55185
55265
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
55186
|
-
* @version
|
|
55266
|
+
* @version 154.0.0
|
|
55187
55267
|
*/
|
|
55188
55268
|
|
|
55189
55269
|
/**
|
|
@@ -55329,7 +55409,7 @@ class WorkforceManagementApi {
|
|
|
55329
55409
|
/**
|
|
55330
55410
|
* WorkforceManagement service.
|
|
55331
55411
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
55332
|
-
* @version
|
|
55412
|
+
* @version 154.0.0
|
|
55333
55413
|
*/
|
|
55334
55414
|
|
|
55335
55415
|
/**
|
|
@@ -55749,6 +55829,56 @@ class WorkforceManagementApi {
|
|
|
55749
55829
|
);
|
|
55750
55830
|
}
|
|
55751
55831
|
|
|
55832
|
+
/**
|
|
55833
|
+
* Get an adherence explanation for the current user
|
|
55834
|
+
*
|
|
55835
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55836
|
+
*/
|
|
55837
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
55838
|
+
// verify the required parameter 'explanationId' is set
|
|
55839
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55840
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
55841
|
+
}
|
|
55842
|
+
|
|
55843
|
+
return this.apiClient.callApi(
|
|
55844
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
55845
|
+
'GET',
|
|
55846
|
+
{ 'explanationId': explanationId },
|
|
55847
|
+
{ },
|
|
55848
|
+
{ },
|
|
55849
|
+
{ },
|
|
55850
|
+
null,
|
|
55851
|
+
['PureCloud OAuth'],
|
|
55852
|
+
['application/json'],
|
|
55853
|
+
['application/json']
|
|
55854
|
+
);
|
|
55855
|
+
}
|
|
55856
|
+
|
|
55857
|
+
/**
|
|
55858
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
55859
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
55860
|
+
* @param {String} jobId The ID of the job
|
|
55861
|
+
*/
|
|
55862
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
55863
|
+
// verify the required parameter 'jobId' is set
|
|
55864
|
+
if (jobId === undefined || jobId === null) {
|
|
55865
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
55866
|
+
}
|
|
55867
|
+
|
|
55868
|
+
return this.apiClient.callApi(
|
|
55869
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
55870
|
+
'GET',
|
|
55871
|
+
{ 'jobId': jobId },
|
|
55872
|
+
{ },
|
|
55873
|
+
{ },
|
|
55874
|
+
{ },
|
|
55875
|
+
null,
|
|
55876
|
+
['PureCloud OAuth'],
|
|
55877
|
+
['application/json'],
|
|
55878
|
+
['application/json']
|
|
55879
|
+
);
|
|
55880
|
+
}
|
|
55881
|
+
|
|
55752
55882
|
/**
|
|
55753
55883
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
55754
55884
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -55799,6 +55929,36 @@ class WorkforceManagementApi {
|
|
|
55799
55929
|
);
|
|
55800
55930
|
}
|
|
55801
55931
|
|
|
55932
|
+
/**
|
|
55933
|
+
* Get an adherence explanation
|
|
55934
|
+
*
|
|
55935
|
+
* @param {String} agentId The ID of the agent to query
|
|
55936
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55937
|
+
*/
|
|
55938
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
55939
|
+
// verify the required parameter 'agentId' is set
|
|
55940
|
+
if (agentId === undefined || agentId === null) {
|
|
55941
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
55942
|
+
}
|
|
55943
|
+
// verify the required parameter 'explanationId' is set
|
|
55944
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55945
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
55946
|
+
}
|
|
55947
|
+
|
|
55948
|
+
return this.apiClient.callApi(
|
|
55949
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
55950
|
+
'GET',
|
|
55951
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
55952
|
+
{ },
|
|
55953
|
+
{ },
|
|
55954
|
+
{ },
|
|
55955
|
+
null,
|
|
55956
|
+
['PureCloud OAuth'],
|
|
55957
|
+
['application/json'],
|
|
55958
|
+
['application/json']
|
|
55959
|
+
);
|
|
55960
|
+
}
|
|
55961
|
+
|
|
55802
55962
|
/**
|
|
55803
55963
|
* Get the management unit to which the agent belongs
|
|
55804
55964
|
*
|
|
@@ -57518,6 +57678,31 @@ class WorkforceManagementApi {
|
|
|
57518
57678
|
);
|
|
57519
57679
|
}
|
|
57520
57680
|
|
|
57681
|
+
/**
|
|
57682
|
+
* Request to fetch the status of the historical shrinkage query
|
|
57683
|
+
*
|
|
57684
|
+
* @param {String} jobId jobId
|
|
57685
|
+
*/
|
|
57686
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
57687
|
+
// verify the required parameter 'jobId' is set
|
|
57688
|
+
if (jobId === undefined || jobId === null) {
|
|
57689
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
57690
|
+
}
|
|
57691
|
+
|
|
57692
|
+
return this.apiClient.callApi(
|
|
57693
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
57694
|
+
'GET',
|
|
57695
|
+
{ 'jobId': jobId },
|
|
57696
|
+
{ },
|
|
57697
|
+
{ },
|
|
57698
|
+
{ },
|
|
57699
|
+
null,
|
|
57700
|
+
['PureCloud OAuth'],
|
|
57701
|
+
['application/json'],
|
|
57702
|
+
['application/json']
|
|
57703
|
+
);
|
|
57704
|
+
}
|
|
57705
|
+
|
|
57521
57706
|
/**
|
|
57522
57707
|
* Get a time off request for the current user
|
|
57523
57708
|
*
|
|
@@ -57592,6 +57777,41 @@ class WorkforceManagementApi {
|
|
|
57592
57777
|
);
|
|
57593
57778
|
}
|
|
57594
57779
|
|
|
57780
|
+
/**
|
|
57781
|
+
* Update an adherence explanation
|
|
57782
|
+
*
|
|
57783
|
+
* @param {String} agentId The ID of the agent to query
|
|
57784
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
57785
|
+
* @param {Object} body The request body
|
|
57786
|
+
*/
|
|
57787
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
57788
|
+
// verify the required parameter 'agentId' is set
|
|
57789
|
+
if (agentId === undefined || agentId === null) {
|
|
57790
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
57791
|
+
}
|
|
57792
|
+
// verify the required parameter 'explanationId' is set
|
|
57793
|
+
if (explanationId === undefined || explanationId === null) {
|
|
57794
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
57795
|
+
}
|
|
57796
|
+
// verify the required parameter 'body' is set
|
|
57797
|
+
if (body === undefined || body === null) {
|
|
57798
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
57799
|
+
}
|
|
57800
|
+
|
|
57801
|
+
return this.apiClient.callApi(
|
|
57802
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
57803
|
+
'PATCH',
|
|
57804
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
57805
|
+
{ },
|
|
57806
|
+
{ },
|
|
57807
|
+
{ },
|
|
57808
|
+
body,
|
|
57809
|
+
['PureCloud OAuth'],
|
|
57810
|
+
['application/json'],
|
|
57811
|
+
['application/json']
|
|
57812
|
+
);
|
|
57813
|
+
}
|
|
57814
|
+
|
|
57595
57815
|
/**
|
|
57596
57816
|
* Update business unit
|
|
57597
57817
|
*
|
|
@@ -58031,6 +58251,61 @@ class WorkforceManagementApi {
|
|
|
58031
58251
|
);
|
|
58032
58252
|
}
|
|
58033
58253
|
|
|
58254
|
+
/**
|
|
58255
|
+
* Submit an adherence explanation for the current user
|
|
58256
|
+
*
|
|
58257
|
+
* @param {Object} body The request body
|
|
58258
|
+
*/
|
|
58259
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
58260
|
+
// verify the required parameter 'body' is set
|
|
58261
|
+
if (body === undefined || body === null) {
|
|
58262
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
58263
|
+
}
|
|
58264
|
+
|
|
58265
|
+
return this.apiClient.callApi(
|
|
58266
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
58267
|
+
'POST',
|
|
58268
|
+
{ },
|
|
58269
|
+
{ },
|
|
58270
|
+
{ },
|
|
58271
|
+
{ },
|
|
58272
|
+
body,
|
|
58273
|
+
['PureCloud OAuth'],
|
|
58274
|
+
['application/json'],
|
|
58275
|
+
['application/json']
|
|
58276
|
+
);
|
|
58277
|
+
}
|
|
58278
|
+
|
|
58279
|
+
/**
|
|
58280
|
+
* Query adherence explanations for the current user
|
|
58281
|
+
*
|
|
58282
|
+
* @param {Object} body The request body
|
|
58283
|
+
* @param {Object} opts Optional parameters
|
|
58284
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
58285
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
58286
|
+
*/
|
|
58287
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
58288
|
+
opts = opts || {};
|
|
58289
|
+
|
|
58290
|
+
// verify the required parameter 'body' is set
|
|
58291
|
+
if (body === undefined || body === null) {
|
|
58292
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
58293
|
+
}
|
|
58294
|
+
|
|
58295
|
+
return this.apiClient.callApi(
|
|
58296
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
58297
|
+
'POST',
|
|
58298
|
+
{ },
|
|
58299
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
58300
|
+
{ },
|
|
58301
|
+
{ },
|
|
58302
|
+
body,
|
|
58303
|
+
['PureCloud OAuth'],
|
|
58304
|
+
['application/json'],
|
|
58305
|
+
['application/json']
|
|
58306
|
+
);
|
|
58307
|
+
}
|
|
58308
|
+
|
|
58034
58309
|
/**
|
|
58035
58310
|
* Request a historical adherence report for users across management units
|
|
58036
58311
|
*
|
|
@@ -58055,6 +58330,71 @@ class WorkforceManagementApi {
|
|
|
58055
58330
|
);
|
|
58056
58331
|
}
|
|
58057
58332
|
|
|
58333
|
+
/**
|
|
58334
|
+
* Add an adherence explanation for the requested user
|
|
58335
|
+
*
|
|
58336
|
+
* @param {String} agentId The ID of the agent to query
|
|
58337
|
+
* @param {Object} body The request body
|
|
58338
|
+
*/
|
|
58339
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
58340
|
+
// verify the required parameter 'agentId' is set
|
|
58341
|
+
if (agentId === undefined || agentId === null) {
|
|
58342
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
58343
|
+
}
|
|
58344
|
+
// verify the required parameter 'body' is set
|
|
58345
|
+
if (body === undefined || body === null) {
|
|
58346
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
58347
|
+
}
|
|
58348
|
+
|
|
58349
|
+
return this.apiClient.callApi(
|
|
58350
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
58351
|
+
'POST',
|
|
58352
|
+
{ 'agentId': agentId },
|
|
58353
|
+
{ },
|
|
58354
|
+
{ },
|
|
58355
|
+
{ },
|
|
58356
|
+
body,
|
|
58357
|
+
['PureCloud OAuth'],
|
|
58358
|
+
['application/json'],
|
|
58359
|
+
['application/json']
|
|
58360
|
+
);
|
|
58361
|
+
}
|
|
58362
|
+
|
|
58363
|
+
/**
|
|
58364
|
+
* Query adherence explanations for the given agent across a specified range
|
|
58365
|
+
*
|
|
58366
|
+
* @param {String} agentId The ID of the agent to query
|
|
58367
|
+
* @param {Object} body The request body
|
|
58368
|
+
* @param {Object} opts Optional parameters
|
|
58369
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
58370
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
58371
|
+
*/
|
|
58372
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
58373
|
+
opts = opts || {};
|
|
58374
|
+
|
|
58375
|
+
// verify the required parameter 'agentId' is set
|
|
58376
|
+
if (agentId === undefined || agentId === null) {
|
|
58377
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
58378
|
+
}
|
|
58379
|
+
// verify the required parameter 'body' is set
|
|
58380
|
+
if (body === undefined || body === null) {
|
|
58381
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
58382
|
+
}
|
|
58383
|
+
|
|
58384
|
+
return this.apiClient.callApi(
|
|
58385
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
58386
|
+
'POST',
|
|
58387
|
+
{ 'agentId': agentId },
|
|
58388
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
58389
|
+
{ },
|
|
58390
|
+
{ },
|
|
58391
|
+
body,
|
|
58392
|
+
['PureCloud OAuth'],
|
|
58393
|
+
['application/json'],
|
|
58394
|
+
['application/json']
|
|
58395
|
+
);
|
|
58396
|
+
}
|
|
58397
|
+
|
|
58058
58398
|
/**
|
|
58059
58399
|
* Get published schedule for the current user
|
|
58060
58400
|
*
|
|
@@ -58108,6 +58448,41 @@ class WorkforceManagementApi {
|
|
|
58108
58448
|
);
|
|
58109
58449
|
}
|
|
58110
58450
|
|
|
58451
|
+
/**
|
|
58452
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
58453
|
+
*
|
|
58454
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
58455
|
+
* @param {Object} body The request body
|
|
58456
|
+
* @param {Object} opts Optional parameters
|
|
58457
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
58458
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
58459
|
+
*/
|
|
58460
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
58461
|
+
opts = opts || {};
|
|
58462
|
+
|
|
58463
|
+
// verify the required parameter 'businessUnitId' is set
|
|
58464
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
58465
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
58466
|
+
}
|
|
58467
|
+
// verify the required parameter 'body' is set
|
|
58468
|
+
if (body === undefined || body === null) {
|
|
58469
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
58470
|
+
}
|
|
58471
|
+
|
|
58472
|
+
return this.apiClient.callApi(
|
|
58473
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
58474
|
+
'POST',
|
|
58475
|
+
{ 'businessUnitId': businessUnitId },
|
|
58476
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
58477
|
+
{ },
|
|
58478
|
+
{ },
|
|
58479
|
+
body,
|
|
58480
|
+
['PureCloud OAuth'],
|
|
58481
|
+
['application/json'],
|
|
58482
|
+
['application/json']
|
|
58483
|
+
);
|
|
58484
|
+
}
|
|
58485
|
+
|
|
58111
58486
|
/**
|
|
58112
58487
|
* Search published schedules
|
|
58113
58488
|
*
|
|
@@ -58935,6 +59310,35 @@ class WorkforceManagementApi {
|
|
|
58935
59310
|
);
|
|
58936
59311
|
}
|
|
58937
59312
|
|
|
59313
|
+
/**
|
|
59314
|
+
* Request a historical shrinkage report
|
|
59315
|
+
* 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.
|
|
59316
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59317
|
+
* @param {Object} opts Optional parameters
|
|
59318
|
+
* @param {Object} opts.body body
|
|
59319
|
+
*/
|
|
59320
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
59321
|
+
opts = opts || {};
|
|
59322
|
+
|
|
59323
|
+
// verify the required parameter 'managementUnitId' is set
|
|
59324
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
59325
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
59326
|
+
}
|
|
59327
|
+
|
|
59328
|
+
return this.apiClient.callApi(
|
|
59329
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
59330
|
+
'POST',
|
|
59331
|
+
{ 'managementUnitId': managementUnitId },
|
|
59332
|
+
{ },
|
|
59333
|
+
{ },
|
|
59334
|
+
{ },
|
|
59335
|
+
opts['body'],
|
|
59336
|
+
['PureCloud OAuth'],
|
|
59337
|
+
['application/json'],
|
|
59338
|
+
['application/json']
|
|
59339
|
+
);
|
|
59340
|
+
}
|
|
59341
|
+
|
|
58938
59342
|
/**
|
|
58939
59343
|
* Creates a new time off limit object under management unit.
|
|
58940
59344
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -59675,7 +60079,7 @@ class WorkforceManagementApi {
|
|
|
59675
60079
|
* </pre>
|
|
59676
60080
|
* </p>
|
|
59677
60081
|
* @module purecloud-platform-client-v2/index
|
|
59678
|
-
* @version
|
|
60082
|
+
* @version 154.0.0
|
|
59679
60083
|
*/
|
|
59680
60084
|
class platformClient {
|
|
59681
60085
|
constructor() {
|