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
|
@@ -9307,7 +9307,7 @@ class Configuration {
|
|
|
9307
9307
|
|
|
9308
9308
|
/**
|
|
9309
9309
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9310
|
-
* @version
|
|
9310
|
+
* @version 154.0.0
|
|
9311
9311
|
*/
|
|
9312
9312
|
class ApiClient {
|
|
9313
9313
|
/**
|
|
@@ -10379,7 +10379,7 @@ class AlertingApi {
|
|
|
10379
10379
|
/**
|
|
10380
10380
|
* Alerting service.
|
|
10381
10381
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10382
|
-
* @version
|
|
10382
|
+
* @version 154.0.0
|
|
10383
10383
|
*/
|
|
10384
10384
|
|
|
10385
10385
|
/**
|
|
@@ -10693,7 +10693,7 @@ class AnalyticsApi {
|
|
|
10693
10693
|
/**
|
|
10694
10694
|
* Analytics service.
|
|
10695
10695
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10696
|
-
* @version
|
|
10696
|
+
* @version 154.0.0
|
|
10697
10697
|
*/
|
|
10698
10698
|
|
|
10699
10699
|
/**
|
|
@@ -10709,7 +10709,7 @@ class AnalyticsApi {
|
|
|
10709
10709
|
|
|
10710
10710
|
|
|
10711
10711
|
/**
|
|
10712
|
-
* Delete/cancel an async
|
|
10712
|
+
* Delete/cancel an async details job
|
|
10713
10713
|
*
|
|
10714
10714
|
* @param {String} jobId jobId
|
|
10715
10715
|
*/
|
|
@@ -10793,6 +10793,7 @@ class AnalyticsApi {
|
|
|
10793
10793
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
10794
10794
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
10795
10795
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
10796
|
+
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
10796
10797
|
*/
|
|
10797
10798
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
10798
10799
|
opts = opts || {};
|
|
@@ -10806,7 +10807,7 @@ class AnalyticsApi {
|
|
|
10806
10807
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
10807
10808
|
'GET',
|
|
10808
10809
|
{ 'botFlowId': botFlowId },
|
|
10809
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
10810
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
10810
10811
|
{ },
|
|
10811
10812
|
{ },
|
|
10812
10813
|
null,
|
|
@@ -10891,7 +10892,7 @@ class AnalyticsApi {
|
|
|
10891
10892
|
}
|
|
10892
10893
|
|
|
10893
10894
|
/**
|
|
10894
|
-
* Fetch a page of results for an async
|
|
10895
|
+
* Fetch a page of results for an async details job
|
|
10895
10896
|
*
|
|
10896
10897
|
* @param {String} jobId jobId
|
|
10897
10898
|
* @param {Object} opts Optional parameters
|
|
@@ -11946,7 +11947,7 @@ class ArchitectApi {
|
|
|
11946
11947
|
/**
|
|
11947
11948
|
* Architect service.
|
|
11948
11949
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
11949
|
-
* @version
|
|
11950
|
+
* @version 154.0.0
|
|
11950
11951
|
*/
|
|
11951
11952
|
|
|
11952
11953
|
/**
|
|
@@ -12705,6 +12706,7 @@ class ArchitectApi {
|
|
|
12705
12706
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
12706
12707
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
12707
12708
|
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
12709
|
+
* @param {String} opts.scheduleGroup The Schedule Group of the IVR to filter by.
|
|
12708
12710
|
*/
|
|
12709
12711
|
getArchitectIvrs(opts) {
|
|
12710
12712
|
opts = opts || {};
|
|
@@ -12714,7 +12716,7 @@ class ArchitectApi {
|
|
|
12714
12716
|
'/api/v2/architect/ivrs',
|
|
12715
12717
|
'GET',
|
|
12716
12718
|
{ },
|
|
12717
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
12719
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'] },
|
|
12718
12720
|
{ },
|
|
12719
12721
|
{ },
|
|
12720
12722
|
null,
|
|
@@ -14993,7 +14995,7 @@ class AuditApi {
|
|
|
14993
14995
|
/**
|
|
14994
14996
|
* Audit service.
|
|
14995
14997
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14996
|
-
* @version
|
|
14998
|
+
* @version 154.0.0
|
|
14997
14999
|
*/
|
|
14998
15000
|
|
|
14999
15001
|
/**
|
|
@@ -15164,7 +15166,7 @@ class AuthorizationApi {
|
|
|
15164
15166
|
/**
|
|
15165
15167
|
* Authorization service.
|
|
15166
15168
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15167
|
-
* @version
|
|
15169
|
+
* @version 154.0.0
|
|
15168
15170
|
*/
|
|
15169
15171
|
|
|
15170
15172
|
/**
|
|
@@ -15697,6 +15699,26 @@ class AuthorizationApi {
|
|
|
15697
15699
|
);
|
|
15698
15700
|
}
|
|
15699
15701
|
|
|
15702
|
+
/**
|
|
15703
|
+
* Get authorization settings
|
|
15704
|
+
*
|
|
15705
|
+
*/
|
|
15706
|
+
getAuthorizationSettings() {
|
|
15707
|
+
|
|
15708
|
+
return this.apiClient.callApi(
|
|
15709
|
+
'/api/v2/authorization/settings',
|
|
15710
|
+
'GET',
|
|
15711
|
+
{ },
|
|
15712
|
+
{ },
|
|
15713
|
+
{ },
|
|
15714
|
+
{ },
|
|
15715
|
+
null,
|
|
15716
|
+
['PureCloud OAuth'],
|
|
15717
|
+
['application/json'],
|
|
15718
|
+
['application/json']
|
|
15719
|
+
);
|
|
15720
|
+
}
|
|
15721
|
+
|
|
15700
15722
|
/**
|
|
15701
15723
|
* Returns a listing of roles and permissions for a user.
|
|
15702
15724
|
*
|
|
@@ -15821,6 +15843,31 @@ class AuthorizationApi {
|
|
|
15821
15843
|
);
|
|
15822
15844
|
}
|
|
15823
15845
|
|
|
15846
|
+
/**
|
|
15847
|
+
* Change authorization settings
|
|
15848
|
+
* Change authorization settings
|
|
15849
|
+
* @param {Object} body Authorization Settings
|
|
15850
|
+
*/
|
|
15851
|
+
patchAuthorizationSettings(body) {
|
|
15852
|
+
// verify the required parameter 'body' is set
|
|
15853
|
+
if (body === undefined || body === null) {
|
|
15854
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
15855
|
+
}
|
|
15856
|
+
|
|
15857
|
+
return this.apiClient.callApi(
|
|
15858
|
+
'/api/v2/authorization/settings',
|
|
15859
|
+
'PATCH',
|
|
15860
|
+
{ },
|
|
15861
|
+
{ },
|
|
15862
|
+
{ },
|
|
15863
|
+
{ },
|
|
15864
|
+
body,
|
|
15865
|
+
['PureCloud OAuth'],
|
|
15866
|
+
['application/json'],
|
|
15867
|
+
['application/json']
|
|
15868
|
+
);
|
|
15869
|
+
}
|
|
15870
|
+
|
|
15824
15871
|
/**
|
|
15825
15872
|
* Assign a list of objects to a division
|
|
15826
15873
|
* 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"]
|
|
@@ -16347,7 +16394,7 @@ class BillingApi {
|
|
|
16347
16394
|
/**
|
|
16348
16395
|
* Billing service.
|
|
16349
16396
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16350
|
-
* @version
|
|
16397
|
+
* @version 154.0.0
|
|
16351
16398
|
*/
|
|
16352
16399
|
|
|
16353
16400
|
/**
|
|
@@ -16427,7 +16474,7 @@ class ChatApi {
|
|
|
16427
16474
|
/**
|
|
16428
16475
|
* Chat service.
|
|
16429
16476
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16430
|
-
* @version
|
|
16477
|
+
* @version 154.0.0
|
|
16431
16478
|
*/
|
|
16432
16479
|
|
|
16433
16480
|
/**
|
|
@@ -16518,7 +16565,7 @@ class CoachingApi {
|
|
|
16518
16565
|
/**
|
|
16519
16566
|
* Coaching service.
|
|
16520
16567
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16521
|
-
* @version
|
|
16568
|
+
* @version 154.0.0
|
|
16522
16569
|
*/
|
|
16523
16570
|
|
|
16524
16571
|
/**
|
|
@@ -17095,7 +17142,7 @@ class ContentManagementApi {
|
|
|
17095
17142
|
/**
|
|
17096
17143
|
* ContentManagement service.
|
|
17097
17144
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17098
|
-
* @version
|
|
17145
|
+
* @version 154.0.0
|
|
17099
17146
|
*/
|
|
17100
17147
|
|
|
17101
17148
|
/**
|
|
@@ -18235,7 +18282,7 @@ class ConversationsApi {
|
|
|
18235
18282
|
/**
|
|
18236
18283
|
* Conversations service.
|
|
18237
18284
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18238
|
-
* @version
|
|
18285
|
+
* @version 154.0.0
|
|
18239
18286
|
*/
|
|
18240
18287
|
|
|
18241
18288
|
/**
|
|
@@ -18251,7 +18298,7 @@ class ConversationsApi {
|
|
|
18251
18298
|
|
|
18252
18299
|
|
|
18253
18300
|
/**
|
|
18254
|
-
* Delete/cancel an async
|
|
18301
|
+
* Delete/cancel an async details job
|
|
18255
18302
|
*
|
|
18256
18303
|
* @param {String} jobId jobId
|
|
18257
18304
|
*/
|
|
@@ -18625,7 +18672,7 @@ class ConversationsApi {
|
|
|
18625
18672
|
}
|
|
18626
18673
|
|
|
18627
18674
|
/**
|
|
18628
|
-
* Fetch a page of results for an async
|
|
18675
|
+
* Fetch a page of results for an async details job
|
|
18629
18676
|
*
|
|
18630
18677
|
* @param {String} jobId jobId
|
|
18631
18678
|
* @param {Object} opts Optional parameters
|
|
@@ -23458,7 +23505,7 @@ class DataExtensionsApi {
|
|
|
23458
23505
|
/**
|
|
23459
23506
|
* DataExtensions service.
|
|
23460
23507
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23461
|
-
* @version
|
|
23508
|
+
* @version 154.0.0
|
|
23462
23509
|
*/
|
|
23463
23510
|
|
|
23464
23511
|
/**
|
|
@@ -23544,7 +23591,7 @@ class DownloadsApi {
|
|
|
23544
23591
|
/**
|
|
23545
23592
|
* Downloads service.
|
|
23546
23593
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
23547
|
-
* @version
|
|
23594
|
+
* @version 154.0.0
|
|
23548
23595
|
*/
|
|
23549
23596
|
|
|
23550
23597
|
/**
|
|
@@ -23596,7 +23643,7 @@ class EventsApi {
|
|
|
23596
23643
|
/**
|
|
23597
23644
|
* Events service.
|
|
23598
23645
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23599
|
-
* @version
|
|
23646
|
+
* @version 154.0.0
|
|
23600
23647
|
*/
|
|
23601
23648
|
|
|
23602
23649
|
/**
|
|
@@ -23692,7 +23739,7 @@ class ExternalContactsApi {
|
|
|
23692
23739
|
/**
|
|
23693
23740
|
* ExternalContacts service.
|
|
23694
23741
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23695
|
-
* @version
|
|
23742
|
+
* @version 154.0.0
|
|
23696
23743
|
*/
|
|
23697
23744
|
|
|
23698
23745
|
/**
|
|
@@ -25650,7 +25697,7 @@ class FaxApi {
|
|
|
25650
25697
|
/**
|
|
25651
25698
|
* Fax service.
|
|
25652
25699
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25653
|
-
* @version
|
|
25700
|
+
* @version 154.0.0
|
|
25654
25701
|
*/
|
|
25655
25702
|
|
|
25656
25703
|
/**
|
|
@@ -25821,7 +25868,7 @@ class FlowsApi {
|
|
|
25821
25868
|
/**
|
|
25822
25869
|
* Flows service.
|
|
25823
25870
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25824
|
-
* @version
|
|
25871
|
+
* @version 154.0.0
|
|
25825
25872
|
*/
|
|
25826
25873
|
|
|
25827
25874
|
/**
|
|
@@ -25892,7 +25939,7 @@ class GamificationApi {
|
|
|
25892
25939
|
/**
|
|
25893
25940
|
* Gamification service.
|
|
25894
25941
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25895
|
-
* @version
|
|
25942
|
+
* @version 154.0.0
|
|
25896
25943
|
*/
|
|
25897
25944
|
|
|
25898
25945
|
/**
|
|
@@ -27509,7 +27556,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
27509
27556
|
/**
|
|
27510
27557
|
* GeneralDataProtectionRegulation service.
|
|
27511
27558
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27512
|
-
* @version
|
|
27559
|
+
* @version 154.0.0
|
|
27513
27560
|
*/
|
|
27514
27561
|
|
|
27515
27562
|
/**
|
|
@@ -27639,7 +27686,7 @@ class GeolocationApi {
|
|
|
27639
27686
|
/**
|
|
27640
27687
|
* Geolocation service.
|
|
27641
27688
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27642
|
-
* @version
|
|
27689
|
+
* @version 154.0.0
|
|
27643
27690
|
*/
|
|
27644
27691
|
|
|
27645
27692
|
/**
|
|
@@ -27770,7 +27817,7 @@ class GreetingsApi {
|
|
|
27770
27817
|
/**
|
|
27771
27818
|
* Greetings service.
|
|
27772
27819
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27773
|
-
* @version
|
|
27820
|
+
* @version 154.0.0
|
|
27774
27821
|
*/
|
|
27775
27822
|
|
|
27776
27823
|
/**
|
|
@@ -28225,7 +28272,7 @@ class GroupsApi {
|
|
|
28225
28272
|
/**
|
|
28226
28273
|
* Groups service.
|
|
28227
28274
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28228
|
-
* @version
|
|
28275
|
+
* @version 154.0.0
|
|
28229
28276
|
*/
|
|
28230
28277
|
|
|
28231
28278
|
/**
|
|
@@ -28631,7 +28678,7 @@ class IdentityProviderApi {
|
|
|
28631
28678
|
/**
|
|
28632
28679
|
* IdentityProvider service.
|
|
28633
28680
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28634
|
-
* @version
|
|
28681
|
+
* @version 154.0.0
|
|
28635
28682
|
*/
|
|
28636
28683
|
|
|
28637
28684
|
/**
|
|
@@ -29387,7 +29434,7 @@ class IntegrationsApi {
|
|
|
29387
29434
|
/**
|
|
29388
29435
|
* Integrations service.
|
|
29389
29436
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29390
|
-
* @version
|
|
29437
|
+
* @version 154.0.0
|
|
29391
29438
|
*/
|
|
29392
29439
|
|
|
29393
29440
|
/**
|
|
@@ -30987,7 +31034,7 @@ class JourneyApi {
|
|
|
30987
31034
|
/**
|
|
30988
31035
|
* Journey service.
|
|
30989
31036
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30990
|
-
* @version
|
|
31037
|
+
* @version 154.0.0
|
|
30991
31038
|
*/
|
|
30992
31039
|
|
|
30993
31040
|
/**
|
|
@@ -31773,7 +31820,7 @@ class KnowledgeApi {
|
|
|
31773
31820
|
/**
|
|
31774
31821
|
* Knowledge service.
|
|
31775
31822
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31776
|
-
* @version
|
|
31823
|
+
* @version 154.0.0
|
|
31777
31824
|
*/
|
|
31778
31825
|
|
|
31779
31826
|
/**
|
|
@@ -34206,7 +34253,7 @@ class LanguageUnderstandingApi {
|
|
|
34206
34253
|
/**
|
|
34207
34254
|
* LanguageUnderstanding service.
|
|
34208
34255
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34209
|
-
* @version
|
|
34256
|
+
* @version 154.0.0
|
|
34210
34257
|
*/
|
|
34211
34258
|
|
|
34212
34259
|
/**
|
|
@@ -35110,7 +35157,7 @@ class LanguagesApi {
|
|
|
35110
35157
|
/**
|
|
35111
35158
|
* Languages service.
|
|
35112
35159
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35113
|
-
* @version
|
|
35160
|
+
* @version 154.0.0
|
|
35114
35161
|
*/
|
|
35115
35162
|
|
|
35116
35163
|
/**
|
|
@@ -35378,7 +35425,7 @@ class LearningApi {
|
|
|
35378
35425
|
/**
|
|
35379
35426
|
* Learning service.
|
|
35380
35427
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35381
|
-
* @version
|
|
35428
|
+
* @version 154.0.0
|
|
35382
35429
|
*/
|
|
35383
35430
|
|
|
35384
35431
|
/**
|
|
@@ -35678,6 +35725,7 @@ class LearningApi {
|
|
|
35678
35725
|
* @param {String} opts.searchTerm Search Term (searchable by name)
|
|
35679
35726
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
35680
35727
|
* @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)
|
|
35728
|
+
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
35681
35729
|
*/
|
|
35682
35730
|
getLearningModules(opts) {
|
|
35683
35731
|
opts = opts || {};
|
|
@@ -35687,7 +35735,7 @@ class LearningApi {
|
|
|
35687
35735
|
'/api/v2/learning/modules',
|
|
35688
35736
|
'GET',
|
|
35689
35737
|
{ },
|
|
35690
|
-
{ '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'] },
|
|
35738
|
+
{ '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') },
|
|
35691
35739
|
{ },
|
|
35692
35740
|
{ },
|
|
35693
35741
|
null,
|
|
@@ -36138,7 +36186,7 @@ class LicenseApi {
|
|
|
36138
36186
|
/**
|
|
36139
36187
|
* License service.
|
|
36140
36188
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36141
|
-
* @version
|
|
36189
|
+
* @version 154.0.0
|
|
36142
36190
|
*/
|
|
36143
36191
|
|
|
36144
36192
|
/**
|
|
@@ -36376,7 +36424,7 @@ class LocationsApi {
|
|
|
36376
36424
|
/**
|
|
36377
36425
|
* Locations service.
|
|
36378
36426
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36379
|
-
* @version
|
|
36427
|
+
* @version 154.0.0
|
|
36380
36428
|
*/
|
|
36381
36429
|
|
|
36382
36430
|
/**
|
|
@@ -36612,7 +36660,7 @@ class MessagingApi {
|
|
|
36612
36660
|
/**
|
|
36613
36661
|
* Messaging service.
|
|
36614
36662
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
36615
|
-
* @version
|
|
36663
|
+
* @version 154.0.0
|
|
36616
36664
|
*/
|
|
36617
36665
|
|
|
36618
36666
|
/**
|
|
@@ -36763,7 +36811,7 @@ class MobileDevicesApi {
|
|
|
36763
36811
|
/**
|
|
36764
36812
|
* MobileDevices service.
|
|
36765
36813
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
36766
|
-
* @version
|
|
36814
|
+
* @version 154.0.0
|
|
36767
36815
|
*/
|
|
36768
36816
|
|
|
36769
36817
|
/**
|
|
@@ -36914,7 +36962,7 @@ class NotificationsApi {
|
|
|
36914
36962
|
/**
|
|
36915
36963
|
* Notifications service.
|
|
36916
36964
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
36917
|
-
* @version
|
|
36965
|
+
* @version 154.0.0
|
|
36918
36966
|
*/
|
|
36919
36967
|
|
|
36920
36968
|
/**
|
|
@@ -37139,7 +37187,7 @@ class OAuthApi {
|
|
|
37139
37187
|
/**
|
|
37140
37188
|
* OAuth service.
|
|
37141
37189
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37142
|
-
* @version
|
|
37190
|
+
* @version 154.0.0
|
|
37143
37191
|
*/
|
|
37144
37192
|
|
|
37145
37193
|
/**
|
|
@@ -37505,7 +37553,7 @@ class ObjectsApi {
|
|
|
37505
37553
|
/**
|
|
37506
37554
|
* Objects service.
|
|
37507
37555
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
37508
|
-
* @version
|
|
37556
|
+
* @version 154.0.0
|
|
37509
37557
|
*/
|
|
37510
37558
|
|
|
37511
37559
|
/**
|
|
@@ -37776,7 +37824,7 @@ class OrganizationApi {
|
|
|
37776
37824
|
/**
|
|
37777
37825
|
* Organization service.
|
|
37778
37826
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
37779
|
-
* @version
|
|
37827
|
+
* @version 154.0.0
|
|
37780
37828
|
*/
|
|
37781
37829
|
|
|
37782
37830
|
/**
|
|
@@ -38179,7 +38227,7 @@ class OrganizationAuthorizationApi {
|
|
|
38179
38227
|
/**
|
|
38180
38228
|
* OrganizationAuthorization service.
|
|
38181
38229
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38182
|
-
* @version
|
|
38230
|
+
* @version 154.0.0
|
|
38183
38231
|
*/
|
|
38184
38232
|
|
|
38185
38233
|
/**
|
|
@@ -39104,7 +39152,7 @@ class OutboundApi {
|
|
|
39104
39152
|
/**
|
|
39105
39153
|
* Outbound service.
|
|
39106
39154
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
39107
|
-
* @version
|
|
39155
|
+
* @version 154.0.0
|
|
39108
39156
|
*/
|
|
39109
39157
|
|
|
39110
39158
|
/**
|
|
@@ -41728,6 +41776,36 @@ class OutboundApi {
|
|
|
41728
41776
|
);
|
|
41729
41777
|
}
|
|
41730
41778
|
|
|
41779
|
+
/**
|
|
41780
|
+
* Add email addresses to a DNC list.
|
|
41781
|
+
* Only Internal DNC lists may be appended to
|
|
41782
|
+
* @param {String} dncListId DncList ID
|
|
41783
|
+
* @param {Array.<String>} body DNC email addresses
|
|
41784
|
+
*/
|
|
41785
|
+
postOutboundDnclistEmailaddresses(dncListId, body) {
|
|
41786
|
+
// verify the required parameter 'dncListId' is set
|
|
41787
|
+
if (dncListId === undefined || dncListId === null) {
|
|
41788
|
+
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistEmailaddresses';
|
|
41789
|
+
}
|
|
41790
|
+
// verify the required parameter 'body' is set
|
|
41791
|
+
if (body === undefined || body === null) {
|
|
41792
|
+
throw 'Missing the required parameter "body" when calling postOutboundDnclistEmailaddresses';
|
|
41793
|
+
}
|
|
41794
|
+
|
|
41795
|
+
return this.apiClient.callApi(
|
|
41796
|
+
'/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
|
|
41797
|
+
'POST',
|
|
41798
|
+
{ 'dncListId': dncListId },
|
|
41799
|
+
{ },
|
|
41800
|
+
{ },
|
|
41801
|
+
{ },
|
|
41802
|
+
body,
|
|
41803
|
+
['PureCloud OAuth'],
|
|
41804
|
+
['application/json'],
|
|
41805
|
+
['application/json']
|
|
41806
|
+
);
|
|
41807
|
+
}
|
|
41808
|
+
|
|
41731
41809
|
/**
|
|
41732
41810
|
* Initiate the export of a dnc list.
|
|
41733
41811
|
* Returns 200 if received OK.
|
|
@@ -42493,7 +42571,7 @@ class PresenceApi {
|
|
|
42493
42571
|
/**
|
|
42494
42572
|
* Presence service.
|
|
42495
42573
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42496
|
-
* @version
|
|
42574
|
+
* @version 154.0.0
|
|
42497
42575
|
*/
|
|
42498
42576
|
|
|
42499
42577
|
/**
|
|
@@ -42999,7 +43077,7 @@ class ProcessAutomationApi {
|
|
|
42999
43077
|
/**
|
|
43000
43078
|
* ProcessAutomation service.
|
|
43001
43079
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
43002
|
-
* @version
|
|
43080
|
+
* @version 154.0.0
|
|
43003
43081
|
*/
|
|
43004
43082
|
|
|
43005
43083
|
/**
|
|
@@ -43237,7 +43315,7 @@ class QualityApi {
|
|
|
43237
43315
|
/**
|
|
43238
43316
|
* Quality service.
|
|
43239
43317
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43240
|
-
* @version
|
|
43318
|
+
* @version 154.0.0
|
|
43241
43319
|
*/
|
|
43242
43320
|
|
|
43243
43321
|
/**
|
|
@@ -44815,7 +44893,7 @@ class RecordingApi {
|
|
|
44815
44893
|
/**
|
|
44816
44894
|
* Recording service.
|
|
44817
44895
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44818
|
-
* @version
|
|
44896
|
+
* @version 154.0.0
|
|
44819
44897
|
*/
|
|
44820
44898
|
|
|
44821
44899
|
/**
|
|
@@ -45517,7 +45595,7 @@ class RecordingApi {
|
|
|
45517
45595
|
}
|
|
45518
45596
|
|
|
45519
45597
|
/**
|
|
45520
|
-
* Get the local encryption settings
|
|
45598
|
+
* Get the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
45521
45599
|
*
|
|
45522
45600
|
* @param {String} settingsId Settings Id
|
|
45523
45601
|
*/
|
|
@@ -45542,7 +45620,7 @@ class RecordingApi {
|
|
|
45542
45620
|
}
|
|
45543
45621
|
|
|
45544
45622
|
/**
|
|
45545
|
-
* gets a list local key settings data
|
|
45623
|
+
* gets a list local key settings data. Replaced by API recording/keyconfigurations
|
|
45546
45624
|
*
|
|
45547
45625
|
*/
|
|
45548
45626
|
getRecordingLocalkeysSettings() {
|
|
@@ -45994,7 +46072,7 @@ class RecordingApi {
|
|
|
45994
46072
|
}
|
|
45995
46073
|
|
|
45996
46074
|
/**
|
|
45997
|
-
* create a local recording key
|
|
46075
|
+
* create a local key management recording key
|
|
45998
46076
|
*
|
|
45999
46077
|
* @param {Object} body Local Encryption body
|
|
46000
46078
|
*/
|
|
@@ -46019,7 +46097,7 @@ class RecordingApi {
|
|
|
46019
46097
|
}
|
|
46020
46098
|
|
|
46021
46099
|
/**
|
|
46022
|
-
* create settings for local key creation
|
|
46100
|
+
* create settings for local key creation. Replaced by API recording/keyconfigurations
|
|
46023
46101
|
*
|
|
46024
46102
|
* @param {Object} body Local Encryption Configuration
|
|
46025
46103
|
*/
|
|
@@ -46362,7 +46440,7 @@ class RecordingApi {
|
|
|
46362
46440
|
}
|
|
46363
46441
|
|
|
46364
46442
|
/**
|
|
46365
|
-
* Update the local encryption settings
|
|
46443
|
+
* Update the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
46366
46444
|
*
|
|
46367
46445
|
* @param {String} settingsId Settings Id
|
|
46368
46446
|
* @param {Object} body Local Encryption metadata
|
|
@@ -46502,7 +46580,7 @@ class ResponseManagementApi {
|
|
|
46502
46580
|
/**
|
|
46503
46581
|
* ResponseManagement service.
|
|
46504
46582
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46505
|
-
* @version
|
|
46583
|
+
* @version 154.0.0
|
|
46506
46584
|
*/
|
|
46507
46585
|
|
|
46508
46586
|
/**
|
|
@@ -46986,7 +47064,7 @@ class RoutingApi {
|
|
|
46986
47064
|
/**
|
|
46987
47065
|
* Routing service.
|
|
46988
47066
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46989
|
-
* @version
|
|
47067
|
+
* @version 154.0.0
|
|
46990
47068
|
*/
|
|
46991
47069
|
|
|
46992
47070
|
/**
|
|
@@ -47712,6 +47790,8 @@ class RoutingApi {
|
|
|
47712
47790
|
* Get domains
|
|
47713
47791
|
*
|
|
47714
47792
|
* @param {Object} opts Optional parameters
|
|
47793
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47794
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47715
47795
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
47716
47796
|
*/
|
|
47717
47797
|
getRoutingEmailDomains(opts) {
|
|
@@ -47722,7 +47802,7 @@ class RoutingApi {
|
|
|
47722
47802
|
'/api/v2/routing/email/domains',
|
|
47723
47803
|
'GET',
|
|
47724
47804
|
{ },
|
|
47725
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
47805
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
47726
47806
|
{ },
|
|
47727
47807
|
{ },
|
|
47728
47808
|
null,
|
|
@@ -50399,7 +50479,7 @@ class SCIMApi {
|
|
|
50399
50479
|
/**
|
|
50400
50480
|
* SCIM service.
|
|
50401
50481
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50402
|
-
* @version
|
|
50482
|
+
* @version 154.0.0
|
|
50403
50483
|
*/
|
|
50404
50484
|
|
|
50405
50485
|
/**
|
|
@@ -51276,7 +51356,7 @@ class ScriptsApi {
|
|
|
51276
51356
|
/**
|
|
51277
51357
|
* Scripts service.
|
|
51278
51358
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51279
|
-
* @version
|
|
51359
|
+
* @version 154.0.0
|
|
51280
51360
|
*/
|
|
51281
51361
|
|
|
51282
51362
|
/**
|
|
@@ -51695,7 +51775,7 @@ class SearchApi {
|
|
|
51695
51775
|
/**
|
|
51696
51776
|
* Search service.
|
|
51697
51777
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51698
|
-
* @version
|
|
51778
|
+
* @version 154.0.0
|
|
51699
51779
|
*/
|
|
51700
51780
|
|
|
51701
51781
|
/**
|
|
@@ -52280,7 +52360,7 @@ class SpeechTextAnalyticsApi {
|
|
|
52280
52360
|
/**
|
|
52281
52361
|
* SpeechTextAnalytics service.
|
|
52282
52362
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52283
|
-
* @version
|
|
52363
|
+
* @version 154.0.0
|
|
52284
52364
|
*/
|
|
52285
52365
|
|
|
52286
52366
|
/**
|
|
@@ -53134,7 +53214,7 @@ class StationsApi {
|
|
|
53134
53214
|
/**
|
|
53135
53215
|
* Stations service.
|
|
53136
53216
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
53137
|
-
* @version
|
|
53217
|
+
* @version 154.0.0
|
|
53138
53218
|
*/
|
|
53139
53219
|
|
|
53140
53220
|
/**
|
|
@@ -53281,7 +53361,7 @@ class SuggestApi {
|
|
|
53281
53361
|
/**
|
|
53282
53362
|
* Suggest service.
|
|
53283
53363
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53284
|
-
* @version
|
|
53364
|
+
* @version 154.0.0
|
|
53285
53365
|
*/
|
|
53286
53366
|
|
|
53287
53367
|
/**
|
|
@@ -53420,7 +53500,7 @@ class TeamsApi {
|
|
|
53420
53500
|
/**
|
|
53421
53501
|
* Teams service.
|
|
53422
53502
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
53423
|
-
* @version
|
|
53503
|
+
* @version 154.0.0
|
|
53424
53504
|
*/
|
|
53425
53505
|
|
|
53426
53506
|
/**
|
|
@@ -53691,7 +53771,7 @@ class TelephonyApi {
|
|
|
53691
53771
|
/**
|
|
53692
53772
|
* Telephony service.
|
|
53693
53773
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
53694
|
-
* @version
|
|
53774
|
+
* @version 154.0.0
|
|
53695
53775
|
*/
|
|
53696
53776
|
|
|
53697
53777
|
/**
|
|
@@ -53799,7 +53879,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
53799
53879
|
/**
|
|
53800
53880
|
* TelephonyProvidersEdge service.
|
|
53801
53881
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
53802
|
-
* @version
|
|
53882
|
+
* @version 154.0.0
|
|
53803
53883
|
*/
|
|
53804
53884
|
|
|
53805
53885
|
/**
|
|
@@ -57432,7 +57512,7 @@ class TextbotsApi {
|
|
|
57432
57512
|
/**
|
|
57433
57513
|
* Textbots service.
|
|
57434
57514
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
57435
|
-
* @version
|
|
57515
|
+
* @version 154.0.0
|
|
57436
57516
|
*/
|
|
57437
57517
|
|
|
57438
57518
|
/**
|
|
@@ -57560,7 +57640,7 @@ class TokensApi {
|
|
|
57560
57640
|
/**
|
|
57561
57641
|
* Tokens service.
|
|
57562
57642
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
57563
|
-
* @version
|
|
57643
|
+
* @version 154.0.0
|
|
57564
57644
|
*/
|
|
57565
57645
|
|
|
57566
57646
|
/**
|
|
@@ -57666,7 +57746,7 @@ class UploadsApi {
|
|
|
57666
57746
|
/**
|
|
57667
57747
|
* Uploads service.
|
|
57668
57748
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
57669
|
-
* @version
|
|
57749
|
+
* @version 154.0.0
|
|
57670
57750
|
*/
|
|
57671
57751
|
|
|
57672
57752
|
/**
|
|
@@ -57842,7 +57922,7 @@ class UsageApi {
|
|
|
57842
57922
|
/**
|
|
57843
57923
|
* Usage service.
|
|
57844
57924
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
57845
|
-
* @version
|
|
57925
|
+
* @version 154.0.0
|
|
57846
57926
|
*/
|
|
57847
57927
|
|
|
57848
57928
|
/**
|
|
@@ -57913,7 +57993,7 @@ class UserRecordingsApi {
|
|
|
57913
57993
|
/**
|
|
57914
57994
|
* UserRecordings service.
|
|
57915
57995
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
57916
|
-
* @version
|
|
57996
|
+
* @version 154.0.0
|
|
57917
57997
|
*/
|
|
57918
57998
|
|
|
57919
57999
|
/**
|
|
@@ -58098,7 +58178,7 @@ class UsersApi {
|
|
|
58098
58178
|
/**
|
|
58099
58179
|
* Users service.
|
|
58100
58180
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
58101
|
-
* @version
|
|
58181
|
+
* @version 154.0.0
|
|
58102
58182
|
*/
|
|
58103
58183
|
|
|
58104
58184
|
/**
|
|
@@ -60455,7 +60535,7 @@ class UtilitiesApi {
|
|
|
60455
60535
|
/**
|
|
60456
60536
|
* Utilities service.
|
|
60457
60537
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
60458
|
-
* @version
|
|
60538
|
+
* @version 154.0.0
|
|
60459
60539
|
*/
|
|
60460
60540
|
|
|
60461
60541
|
/**
|
|
@@ -60566,7 +60646,7 @@ class VoicemailApi {
|
|
|
60566
60646
|
/**
|
|
60567
60647
|
* Voicemail service.
|
|
60568
60648
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
60569
|
-
* @version
|
|
60649
|
+
* @version 154.0.0
|
|
60570
60650
|
*/
|
|
60571
60651
|
|
|
60572
60652
|
/**
|
|
@@ -61233,7 +61313,7 @@ class WebChatApi {
|
|
|
61233
61313
|
/**
|
|
61234
61314
|
* WebChat service.
|
|
61235
61315
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
61236
|
-
* @version
|
|
61316
|
+
* @version 154.0.0
|
|
61237
61317
|
*/
|
|
61238
61318
|
|
|
61239
61319
|
/**
|
|
@@ -61777,7 +61857,7 @@ class WebDeploymentsApi {
|
|
|
61777
61857
|
/**
|
|
61778
61858
|
* WebDeployments service.
|
|
61779
61859
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
61780
|
-
* @version
|
|
61860
|
+
* @version 154.0.0
|
|
61781
61861
|
*/
|
|
61782
61862
|
|
|
61783
61863
|
/**
|
|
@@ -62165,7 +62245,7 @@ class WebMessagingApi {
|
|
|
62165
62245
|
/**
|
|
62166
62246
|
* WebMessaging service.
|
|
62167
62247
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
62168
|
-
* @version
|
|
62248
|
+
* @version 154.0.0
|
|
62169
62249
|
*/
|
|
62170
62250
|
|
|
62171
62251
|
/**
|
|
@@ -62211,7 +62291,7 @@ class WidgetsApi {
|
|
|
62211
62291
|
/**
|
|
62212
62292
|
* Widgets service.
|
|
62213
62293
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
62214
|
-
* @version
|
|
62294
|
+
* @version 154.0.0
|
|
62215
62295
|
*/
|
|
62216
62296
|
|
|
62217
62297
|
/**
|
|
@@ -62357,7 +62437,7 @@ class WorkforceManagementApi {
|
|
|
62357
62437
|
/**
|
|
62358
62438
|
* WorkforceManagement service.
|
|
62359
62439
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
62360
|
-
* @version
|
|
62440
|
+
* @version 154.0.0
|
|
62361
62441
|
*/
|
|
62362
62442
|
|
|
62363
62443
|
/**
|
|
@@ -62777,6 +62857,56 @@ class WorkforceManagementApi {
|
|
|
62777
62857
|
);
|
|
62778
62858
|
}
|
|
62779
62859
|
|
|
62860
|
+
/**
|
|
62861
|
+
* Get an adherence explanation for the current user
|
|
62862
|
+
*
|
|
62863
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
62864
|
+
*/
|
|
62865
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
62866
|
+
// verify the required parameter 'explanationId' is set
|
|
62867
|
+
if (explanationId === undefined || explanationId === null) {
|
|
62868
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
62869
|
+
}
|
|
62870
|
+
|
|
62871
|
+
return this.apiClient.callApi(
|
|
62872
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
62873
|
+
'GET',
|
|
62874
|
+
{ 'explanationId': explanationId },
|
|
62875
|
+
{ },
|
|
62876
|
+
{ },
|
|
62877
|
+
{ },
|
|
62878
|
+
null,
|
|
62879
|
+
['PureCloud OAuth'],
|
|
62880
|
+
['application/json'],
|
|
62881
|
+
['application/json']
|
|
62882
|
+
);
|
|
62883
|
+
}
|
|
62884
|
+
|
|
62885
|
+
/**
|
|
62886
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
62887
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
62888
|
+
* @param {String} jobId The ID of the job
|
|
62889
|
+
*/
|
|
62890
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
62891
|
+
// verify the required parameter 'jobId' is set
|
|
62892
|
+
if (jobId === undefined || jobId === null) {
|
|
62893
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
62894
|
+
}
|
|
62895
|
+
|
|
62896
|
+
return this.apiClient.callApi(
|
|
62897
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
62898
|
+
'GET',
|
|
62899
|
+
{ 'jobId': jobId },
|
|
62900
|
+
{ },
|
|
62901
|
+
{ },
|
|
62902
|
+
{ },
|
|
62903
|
+
null,
|
|
62904
|
+
['PureCloud OAuth'],
|
|
62905
|
+
['application/json'],
|
|
62906
|
+
['application/json']
|
|
62907
|
+
);
|
|
62908
|
+
}
|
|
62909
|
+
|
|
62780
62910
|
/**
|
|
62781
62911
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
62782
62912
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -62827,6 +62957,36 @@ class WorkforceManagementApi {
|
|
|
62827
62957
|
);
|
|
62828
62958
|
}
|
|
62829
62959
|
|
|
62960
|
+
/**
|
|
62961
|
+
* Get an adherence explanation
|
|
62962
|
+
*
|
|
62963
|
+
* @param {String} agentId The ID of the agent to query
|
|
62964
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
62965
|
+
*/
|
|
62966
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
62967
|
+
// verify the required parameter 'agentId' is set
|
|
62968
|
+
if (agentId === undefined || agentId === null) {
|
|
62969
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
62970
|
+
}
|
|
62971
|
+
// verify the required parameter 'explanationId' is set
|
|
62972
|
+
if (explanationId === undefined || explanationId === null) {
|
|
62973
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
62974
|
+
}
|
|
62975
|
+
|
|
62976
|
+
return this.apiClient.callApi(
|
|
62977
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
62978
|
+
'GET',
|
|
62979
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
62980
|
+
{ },
|
|
62981
|
+
{ },
|
|
62982
|
+
{ },
|
|
62983
|
+
null,
|
|
62984
|
+
['PureCloud OAuth'],
|
|
62985
|
+
['application/json'],
|
|
62986
|
+
['application/json']
|
|
62987
|
+
);
|
|
62988
|
+
}
|
|
62989
|
+
|
|
62830
62990
|
/**
|
|
62831
62991
|
* Get the management unit to which the agent belongs
|
|
62832
62992
|
*
|
|
@@ -64546,6 +64706,31 @@ class WorkforceManagementApi {
|
|
|
64546
64706
|
);
|
|
64547
64707
|
}
|
|
64548
64708
|
|
|
64709
|
+
/**
|
|
64710
|
+
* Request to fetch the status of the historical shrinkage query
|
|
64711
|
+
*
|
|
64712
|
+
* @param {String} jobId jobId
|
|
64713
|
+
*/
|
|
64714
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
64715
|
+
// verify the required parameter 'jobId' is set
|
|
64716
|
+
if (jobId === undefined || jobId === null) {
|
|
64717
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
64718
|
+
}
|
|
64719
|
+
|
|
64720
|
+
return this.apiClient.callApi(
|
|
64721
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
64722
|
+
'GET',
|
|
64723
|
+
{ 'jobId': jobId },
|
|
64724
|
+
{ },
|
|
64725
|
+
{ },
|
|
64726
|
+
{ },
|
|
64727
|
+
null,
|
|
64728
|
+
['PureCloud OAuth'],
|
|
64729
|
+
['application/json'],
|
|
64730
|
+
['application/json']
|
|
64731
|
+
);
|
|
64732
|
+
}
|
|
64733
|
+
|
|
64549
64734
|
/**
|
|
64550
64735
|
* Get a time off request for the current user
|
|
64551
64736
|
*
|
|
@@ -64620,6 +64805,41 @@ class WorkforceManagementApi {
|
|
|
64620
64805
|
);
|
|
64621
64806
|
}
|
|
64622
64807
|
|
|
64808
|
+
/**
|
|
64809
|
+
* Update an adherence explanation
|
|
64810
|
+
*
|
|
64811
|
+
* @param {String} agentId The ID of the agent to query
|
|
64812
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
64813
|
+
* @param {Object} body The request body
|
|
64814
|
+
*/
|
|
64815
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
64816
|
+
// verify the required parameter 'agentId' is set
|
|
64817
|
+
if (agentId === undefined || agentId === null) {
|
|
64818
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64819
|
+
}
|
|
64820
|
+
// verify the required parameter 'explanationId' is set
|
|
64821
|
+
if (explanationId === undefined || explanationId === null) {
|
|
64822
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64823
|
+
}
|
|
64824
|
+
// verify the required parameter 'body' is set
|
|
64825
|
+
if (body === undefined || body === null) {
|
|
64826
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64827
|
+
}
|
|
64828
|
+
|
|
64829
|
+
return this.apiClient.callApi(
|
|
64830
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
64831
|
+
'PATCH',
|
|
64832
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
64833
|
+
{ },
|
|
64834
|
+
{ },
|
|
64835
|
+
{ },
|
|
64836
|
+
body,
|
|
64837
|
+
['PureCloud OAuth'],
|
|
64838
|
+
['application/json'],
|
|
64839
|
+
['application/json']
|
|
64840
|
+
);
|
|
64841
|
+
}
|
|
64842
|
+
|
|
64623
64843
|
/**
|
|
64624
64844
|
* Update business unit
|
|
64625
64845
|
*
|
|
@@ -65059,6 +65279,61 @@ class WorkforceManagementApi {
|
|
|
65059
65279
|
);
|
|
65060
65280
|
}
|
|
65061
65281
|
|
|
65282
|
+
/**
|
|
65283
|
+
* Submit an adherence explanation for the current user
|
|
65284
|
+
*
|
|
65285
|
+
* @param {Object} body The request body
|
|
65286
|
+
*/
|
|
65287
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
65288
|
+
// verify the required parameter 'body' is set
|
|
65289
|
+
if (body === undefined || body === null) {
|
|
65290
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
65291
|
+
}
|
|
65292
|
+
|
|
65293
|
+
return this.apiClient.callApi(
|
|
65294
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
65295
|
+
'POST',
|
|
65296
|
+
{ },
|
|
65297
|
+
{ },
|
|
65298
|
+
{ },
|
|
65299
|
+
{ },
|
|
65300
|
+
body,
|
|
65301
|
+
['PureCloud OAuth'],
|
|
65302
|
+
['application/json'],
|
|
65303
|
+
['application/json']
|
|
65304
|
+
);
|
|
65305
|
+
}
|
|
65306
|
+
|
|
65307
|
+
/**
|
|
65308
|
+
* Query adherence explanations for the current user
|
|
65309
|
+
*
|
|
65310
|
+
* @param {Object} body The request body
|
|
65311
|
+
* @param {Object} opts Optional parameters
|
|
65312
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65313
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65314
|
+
*/
|
|
65315
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
65316
|
+
opts = opts || {};
|
|
65317
|
+
|
|
65318
|
+
// verify the required parameter 'body' is set
|
|
65319
|
+
if (body === undefined || body === null) {
|
|
65320
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
65321
|
+
}
|
|
65322
|
+
|
|
65323
|
+
return this.apiClient.callApi(
|
|
65324
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
65325
|
+
'POST',
|
|
65326
|
+
{ },
|
|
65327
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65328
|
+
{ },
|
|
65329
|
+
{ },
|
|
65330
|
+
body,
|
|
65331
|
+
['PureCloud OAuth'],
|
|
65332
|
+
['application/json'],
|
|
65333
|
+
['application/json']
|
|
65334
|
+
);
|
|
65335
|
+
}
|
|
65336
|
+
|
|
65062
65337
|
/**
|
|
65063
65338
|
* Request a historical adherence report for users across management units
|
|
65064
65339
|
*
|
|
@@ -65083,6 +65358,71 @@ class WorkforceManagementApi {
|
|
|
65083
65358
|
);
|
|
65084
65359
|
}
|
|
65085
65360
|
|
|
65361
|
+
/**
|
|
65362
|
+
* Add an adherence explanation for the requested user
|
|
65363
|
+
*
|
|
65364
|
+
* @param {String} agentId The ID of the agent to query
|
|
65365
|
+
* @param {Object} body The request body
|
|
65366
|
+
*/
|
|
65367
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
65368
|
+
// verify the required parameter 'agentId' is set
|
|
65369
|
+
if (agentId === undefined || agentId === null) {
|
|
65370
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
65371
|
+
}
|
|
65372
|
+
// verify the required parameter 'body' is set
|
|
65373
|
+
if (body === undefined || body === null) {
|
|
65374
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
65375
|
+
}
|
|
65376
|
+
|
|
65377
|
+
return this.apiClient.callApi(
|
|
65378
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
65379
|
+
'POST',
|
|
65380
|
+
{ 'agentId': agentId },
|
|
65381
|
+
{ },
|
|
65382
|
+
{ },
|
|
65383
|
+
{ },
|
|
65384
|
+
body,
|
|
65385
|
+
['PureCloud OAuth'],
|
|
65386
|
+
['application/json'],
|
|
65387
|
+
['application/json']
|
|
65388
|
+
);
|
|
65389
|
+
}
|
|
65390
|
+
|
|
65391
|
+
/**
|
|
65392
|
+
* Query adherence explanations for the given agent across a specified range
|
|
65393
|
+
*
|
|
65394
|
+
* @param {String} agentId The ID of the agent to query
|
|
65395
|
+
* @param {Object} body The request body
|
|
65396
|
+
* @param {Object} opts Optional parameters
|
|
65397
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65398
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65399
|
+
*/
|
|
65400
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
65401
|
+
opts = opts || {};
|
|
65402
|
+
|
|
65403
|
+
// verify the required parameter 'agentId' is set
|
|
65404
|
+
if (agentId === undefined || agentId === null) {
|
|
65405
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
65406
|
+
}
|
|
65407
|
+
// verify the required parameter 'body' is set
|
|
65408
|
+
if (body === undefined || body === null) {
|
|
65409
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
65410
|
+
}
|
|
65411
|
+
|
|
65412
|
+
return this.apiClient.callApi(
|
|
65413
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
65414
|
+
'POST',
|
|
65415
|
+
{ 'agentId': agentId },
|
|
65416
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65417
|
+
{ },
|
|
65418
|
+
{ },
|
|
65419
|
+
body,
|
|
65420
|
+
['PureCloud OAuth'],
|
|
65421
|
+
['application/json'],
|
|
65422
|
+
['application/json']
|
|
65423
|
+
);
|
|
65424
|
+
}
|
|
65425
|
+
|
|
65086
65426
|
/**
|
|
65087
65427
|
* Get published schedule for the current user
|
|
65088
65428
|
*
|
|
@@ -65136,6 +65476,41 @@ class WorkforceManagementApi {
|
|
|
65136
65476
|
);
|
|
65137
65477
|
}
|
|
65138
65478
|
|
|
65479
|
+
/**
|
|
65480
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
65481
|
+
*
|
|
65482
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
65483
|
+
* @param {Object} body The request body
|
|
65484
|
+
* @param {Object} opts Optional parameters
|
|
65485
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65486
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65487
|
+
*/
|
|
65488
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
65489
|
+
opts = opts || {};
|
|
65490
|
+
|
|
65491
|
+
// verify the required parameter 'businessUnitId' is set
|
|
65492
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
65493
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
65494
|
+
}
|
|
65495
|
+
// verify the required parameter 'body' is set
|
|
65496
|
+
if (body === undefined || body === null) {
|
|
65497
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
65498
|
+
}
|
|
65499
|
+
|
|
65500
|
+
return this.apiClient.callApi(
|
|
65501
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
65502
|
+
'POST',
|
|
65503
|
+
{ 'businessUnitId': businessUnitId },
|
|
65504
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65505
|
+
{ },
|
|
65506
|
+
{ },
|
|
65507
|
+
body,
|
|
65508
|
+
['PureCloud OAuth'],
|
|
65509
|
+
['application/json'],
|
|
65510
|
+
['application/json']
|
|
65511
|
+
);
|
|
65512
|
+
}
|
|
65513
|
+
|
|
65139
65514
|
/**
|
|
65140
65515
|
* Search published schedules
|
|
65141
65516
|
*
|
|
@@ -65963,6 +66338,35 @@ class WorkforceManagementApi {
|
|
|
65963
66338
|
);
|
|
65964
66339
|
}
|
|
65965
66340
|
|
|
66341
|
+
/**
|
|
66342
|
+
* Request a historical shrinkage report
|
|
66343
|
+
* 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.
|
|
66344
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
66345
|
+
* @param {Object} opts Optional parameters
|
|
66346
|
+
* @param {Object} opts.body body
|
|
66347
|
+
*/
|
|
66348
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
66349
|
+
opts = opts || {};
|
|
66350
|
+
|
|
66351
|
+
// verify the required parameter 'managementUnitId' is set
|
|
66352
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
66353
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
66354
|
+
}
|
|
66355
|
+
|
|
66356
|
+
return this.apiClient.callApi(
|
|
66357
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
66358
|
+
'POST',
|
|
66359
|
+
{ 'managementUnitId': managementUnitId },
|
|
66360
|
+
{ },
|
|
66361
|
+
{ },
|
|
66362
|
+
{ },
|
|
66363
|
+
opts['body'],
|
|
66364
|
+
['PureCloud OAuth'],
|
|
66365
|
+
['application/json'],
|
|
66366
|
+
['application/json']
|
|
66367
|
+
);
|
|
66368
|
+
}
|
|
66369
|
+
|
|
65966
66370
|
/**
|
|
65967
66371
|
* Creates a new time off limit object under management unit.
|
|
65968
66372
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -66703,7 +67107,7 @@ class WorkforceManagementApi {
|
|
|
66703
67107
|
* </pre>
|
|
66704
67108
|
* </p>
|
|
66705
67109
|
* @module purecloud-platform-client-v2/index
|
|
66706
|
-
* @version
|
|
67110
|
+
* @version 154.0.0
|
|
66707
67111
|
*/
|
|
66708
67112
|
class platformClient {
|
|
66709
67113
|
constructor() {
|