purecloud-platform-client-v2 152.0.0 → 153.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 +444 -73
- package/dist/web-amd/purecloud-platform-client-v2.js +444 -73
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +444 -73
- package/dist/web-cjs/purecloud-platform-client-v2.js +444 -73
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +212 -3
- 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 +3 -3
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +1 -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 +1 -1
- 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 153.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 153.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 153.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
|
*/
|
|
@@ -10891,7 +10891,7 @@ class AnalyticsApi {
|
|
|
10891
10891
|
}
|
|
10892
10892
|
|
|
10893
10893
|
/**
|
|
10894
|
-
* Fetch a page of results for an async
|
|
10894
|
+
* Fetch a page of results for an async details job
|
|
10895
10895
|
*
|
|
10896
10896
|
* @param {String} jobId jobId
|
|
10897
10897
|
* @param {Object} opts Optional parameters
|
|
@@ -11946,7 +11946,7 @@ class ArchitectApi {
|
|
|
11946
11946
|
/**
|
|
11947
11947
|
* Architect service.
|
|
11948
11948
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
11949
|
-
* @version
|
|
11949
|
+
* @version 153.0.0
|
|
11950
11950
|
*/
|
|
11951
11951
|
|
|
11952
11952
|
/**
|
|
@@ -14993,7 +14993,7 @@ class AuditApi {
|
|
|
14993
14993
|
/**
|
|
14994
14994
|
* Audit service.
|
|
14995
14995
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14996
|
-
* @version
|
|
14996
|
+
* @version 153.0.0
|
|
14997
14997
|
*/
|
|
14998
14998
|
|
|
14999
14999
|
/**
|
|
@@ -15164,7 +15164,7 @@ class AuthorizationApi {
|
|
|
15164
15164
|
/**
|
|
15165
15165
|
* Authorization service.
|
|
15166
15166
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15167
|
-
* @version
|
|
15167
|
+
* @version 153.0.0
|
|
15168
15168
|
*/
|
|
15169
15169
|
|
|
15170
15170
|
/**
|
|
@@ -15697,6 +15697,26 @@ class AuthorizationApi {
|
|
|
15697
15697
|
);
|
|
15698
15698
|
}
|
|
15699
15699
|
|
|
15700
|
+
/**
|
|
15701
|
+
* Get authorization settings
|
|
15702
|
+
*
|
|
15703
|
+
*/
|
|
15704
|
+
getAuthorizationSettings() {
|
|
15705
|
+
|
|
15706
|
+
return this.apiClient.callApi(
|
|
15707
|
+
'/api/v2/authorization/settings',
|
|
15708
|
+
'GET',
|
|
15709
|
+
{ },
|
|
15710
|
+
{ },
|
|
15711
|
+
{ },
|
|
15712
|
+
{ },
|
|
15713
|
+
null,
|
|
15714
|
+
['PureCloud OAuth'],
|
|
15715
|
+
['application/json'],
|
|
15716
|
+
['application/json']
|
|
15717
|
+
);
|
|
15718
|
+
}
|
|
15719
|
+
|
|
15700
15720
|
/**
|
|
15701
15721
|
* Returns a listing of roles and permissions for a user.
|
|
15702
15722
|
*
|
|
@@ -15821,6 +15841,31 @@ class AuthorizationApi {
|
|
|
15821
15841
|
);
|
|
15822
15842
|
}
|
|
15823
15843
|
|
|
15844
|
+
/**
|
|
15845
|
+
* Change authorization settings
|
|
15846
|
+
* Change authorization settings
|
|
15847
|
+
* @param {Object} body Authorization Settings
|
|
15848
|
+
*/
|
|
15849
|
+
patchAuthorizationSettings(body) {
|
|
15850
|
+
// verify the required parameter 'body' is set
|
|
15851
|
+
if (body === undefined || body === null) {
|
|
15852
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
15853
|
+
}
|
|
15854
|
+
|
|
15855
|
+
return this.apiClient.callApi(
|
|
15856
|
+
'/api/v2/authorization/settings',
|
|
15857
|
+
'PATCH',
|
|
15858
|
+
{ },
|
|
15859
|
+
{ },
|
|
15860
|
+
{ },
|
|
15861
|
+
{ },
|
|
15862
|
+
body,
|
|
15863
|
+
['PureCloud OAuth'],
|
|
15864
|
+
['application/json'],
|
|
15865
|
+
['application/json']
|
|
15866
|
+
);
|
|
15867
|
+
}
|
|
15868
|
+
|
|
15824
15869
|
/**
|
|
15825
15870
|
* Assign a list of objects to a division
|
|
15826
15871
|
* 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 +16392,7 @@ class BillingApi {
|
|
|
16347
16392
|
/**
|
|
16348
16393
|
* Billing service.
|
|
16349
16394
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16350
|
-
* @version
|
|
16395
|
+
* @version 153.0.0
|
|
16351
16396
|
*/
|
|
16352
16397
|
|
|
16353
16398
|
/**
|
|
@@ -16427,7 +16472,7 @@ class ChatApi {
|
|
|
16427
16472
|
/**
|
|
16428
16473
|
* Chat service.
|
|
16429
16474
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16430
|
-
* @version
|
|
16475
|
+
* @version 153.0.0
|
|
16431
16476
|
*/
|
|
16432
16477
|
|
|
16433
16478
|
/**
|
|
@@ -16518,7 +16563,7 @@ class CoachingApi {
|
|
|
16518
16563
|
/**
|
|
16519
16564
|
* Coaching service.
|
|
16520
16565
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16521
|
-
* @version
|
|
16566
|
+
* @version 153.0.0
|
|
16522
16567
|
*/
|
|
16523
16568
|
|
|
16524
16569
|
/**
|
|
@@ -17095,7 +17140,7 @@ class ContentManagementApi {
|
|
|
17095
17140
|
/**
|
|
17096
17141
|
* ContentManagement service.
|
|
17097
17142
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17098
|
-
* @version
|
|
17143
|
+
* @version 153.0.0
|
|
17099
17144
|
*/
|
|
17100
17145
|
|
|
17101
17146
|
/**
|
|
@@ -18235,7 +18280,7 @@ class ConversationsApi {
|
|
|
18235
18280
|
/**
|
|
18236
18281
|
* Conversations service.
|
|
18237
18282
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18238
|
-
* @version
|
|
18283
|
+
* @version 153.0.0
|
|
18239
18284
|
*/
|
|
18240
18285
|
|
|
18241
18286
|
/**
|
|
@@ -18251,7 +18296,7 @@ class ConversationsApi {
|
|
|
18251
18296
|
|
|
18252
18297
|
|
|
18253
18298
|
/**
|
|
18254
|
-
* Delete/cancel an async
|
|
18299
|
+
* Delete/cancel an async details job
|
|
18255
18300
|
*
|
|
18256
18301
|
* @param {String} jobId jobId
|
|
18257
18302
|
*/
|
|
@@ -18625,7 +18670,7 @@ class ConversationsApi {
|
|
|
18625
18670
|
}
|
|
18626
18671
|
|
|
18627
18672
|
/**
|
|
18628
|
-
* Fetch a page of results for an async
|
|
18673
|
+
* Fetch a page of results for an async details job
|
|
18629
18674
|
*
|
|
18630
18675
|
* @param {String} jobId jobId
|
|
18631
18676
|
* @param {Object} opts Optional parameters
|
|
@@ -23458,7 +23503,7 @@ class DataExtensionsApi {
|
|
|
23458
23503
|
/**
|
|
23459
23504
|
* DataExtensions service.
|
|
23460
23505
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23461
|
-
* @version
|
|
23506
|
+
* @version 153.0.0
|
|
23462
23507
|
*/
|
|
23463
23508
|
|
|
23464
23509
|
/**
|
|
@@ -23544,7 +23589,7 @@ class DownloadsApi {
|
|
|
23544
23589
|
/**
|
|
23545
23590
|
* Downloads service.
|
|
23546
23591
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
23547
|
-
* @version
|
|
23592
|
+
* @version 153.0.0
|
|
23548
23593
|
*/
|
|
23549
23594
|
|
|
23550
23595
|
/**
|
|
@@ -23596,7 +23641,7 @@ class EventsApi {
|
|
|
23596
23641
|
/**
|
|
23597
23642
|
* Events service.
|
|
23598
23643
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23599
|
-
* @version
|
|
23644
|
+
* @version 153.0.0
|
|
23600
23645
|
*/
|
|
23601
23646
|
|
|
23602
23647
|
/**
|
|
@@ -23692,7 +23737,7 @@ class ExternalContactsApi {
|
|
|
23692
23737
|
/**
|
|
23693
23738
|
* ExternalContacts service.
|
|
23694
23739
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23695
|
-
* @version
|
|
23740
|
+
* @version 153.0.0
|
|
23696
23741
|
*/
|
|
23697
23742
|
|
|
23698
23743
|
/**
|
|
@@ -25650,7 +25695,7 @@ class FaxApi {
|
|
|
25650
25695
|
/**
|
|
25651
25696
|
* Fax service.
|
|
25652
25697
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25653
|
-
* @version
|
|
25698
|
+
* @version 153.0.0
|
|
25654
25699
|
*/
|
|
25655
25700
|
|
|
25656
25701
|
/**
|
|
@@ -25821,7 +25866,7 @@ class FlowsApi {
|
|
|
25821
25866
|
/**
|
|
25822
25867
|
* Flows service.
|
|
25823
25868
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25824
|
-
* @version
|
|
25869
|
+
* @version 153.0.0
|
|
25825
25870
|
*/
|
|
25826
25871
|
|
|
25827
25872
|
/**
|
|
@@ -25892,7 +25937,7 @@ class GamificationApi {
|
|
|
25892
25937
|
/**
|
|
25893
25938
|
* Gamification service.
|
|
25894
25939
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25895
|
-
* @version
|
|
25940
|
+
* @version 153.0.0
|
|
25896
25941
|
*/
|
|
25897
25942
|
|
|
25898
25943
|
/**
|
|
@@ -27509,7 +27554,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
27509
27554
|
/**
|
|
27510
27555
|
* GeneralDataProtectionRegulation service.
|
|
27511
27556
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27512
|
-
* @version
|
|
27557
|
+
* @version 153.0.0
|
|
27513
27558
|
*/
|
|
27514
27559
|
|
|
27515
27560
|
/**
|
|
@@ -27639,7 +27684,7 @@ class GeolocationApi {
|
|
|
27639
27684
|
/**
|
|
27640
27685
|
* Geolocation service.
|
|
27641
27686
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27642
|
-
* @version
|
|
27687
|
+
* @version 153.0.0
|
|
27643
27688
|
*/
|
|
27644
27689
|
|
|
27645
27690
|
/**
|
|
@@ -27770,7 +27815,7 @@ class GreetingsApi {
|
|
|
27770
27815
|
/**
|
|
27771
27816
|
* Greetings service.
|
|
27772
27817
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27773
|
-
* @version
|
|
27818
|
+
* @version 153.0.0
|
|
27774
27819
|
*/
|
|
27775
27820
|
|
|
27776
27821
|
/**
|
|
@@ -28225,7 +28270,7 @@ class GroupsApi {
|
|
|
28225
28270
|
/**
|
|
28226
28271
|
* Groups service.
|
|
28227
28272
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28228
|
-
* @version
|
|
28273
|
+
* @version 153.0.0
|
|
28229
28274
|
*/
|
|
28230
28275
|
|
|
28231
28276
|
/**
|
|
@@ -28631,7 +28676,7 @@ class IdentityProviderApi {
|
|
|
28631
28676
|
/**
|
|
28632
28677
|
* IdentityProvider service.
|
|
28633
28678
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28634
|
-
* @version
|
|
28679
|
+
* @version 153.0.0
|
|
28635
28680
|
*/
|
|
28636
28681
|
|
|
28637
28682
|
/**
|
|
@@ -29387,7 +29432,7 @@ class IntegrationsApi {
|
|
|
29387
29432
|
/**
|
|
29388
29433
|
* Integrations service.
|
|
29389
29434
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29390
|
-
* @version
|
|
29435
|
+
* @version 153.0.0
|
|
29391
29436
|
*/
|
|
29392
29437
|
|
|
29393
29438
|
/**
|
|
@@ -30987,7 +31032,7 @@ class JourneyApi {
|
|
|
30987
31032
|
/**
|
|
30988
31033
|
* Journey service.
|
|
30989
31034
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30990
|
-
* @version
|
|
31035
|
+
* @version 153.0.0
|
|
30991
31036
|
*/
|
|
30992
31037
|
|
|
30993
31038
|
/**
|
|
@@ -31773,7 +31818,7 @@ class KnowledgeApi {
|
|
|
31773
31818
|
/**
|
|
31774
31819
|
* Knowledge service.
|
|
31775
31820
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31776
|
-
* @version
|
|
31821
|
+
* @version 153.0.0
|
|
31777
31822
|
*/
|
|
31778
31823
|
|
|
31779
31824
|
/**
|
|
@@ -34206,7 +34251,7 @@ class LanguageUnderstandingApi {
|
|
|
34206
34251
|
/**
|
|
34207
34252
|
* LanguageUnderstanding service.
|
|
34208
34253
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34209
|
-
* @version
|
|
34254
|
+
* @version 153.0.0
|
|
34210
34255
|
*/
|
|
34211
34256
|
|
|
34212
34257
|
/**
|
|
@@ -35110,7 +35155,7 @@ class LanguagesApi {
|
|
|
35110
35155
|
/**
|
|
35111
35156
|
* Languages service.
|
|
35112
35157
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35113
|
-
* @version
|
|
35158
|
+
* @version 153.0.0
|
|
35114
35159
|
*/
|
|
35115
35160
|
|
|
35116
35161
|
/**
|
|
@@ -35378,7 +35423,7 @@ class LearningApi {
|
|
|
35378
35423
|
/**
|
|
35379
35424
|
* Learning service.
|
|
35380
35425
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35381
|
-
* @version
|
|
35426
|
+
* @version 153.0.0
|
|
35382
35427
|
*/
|
|
35383
35428
|
|
|
35384
35429
|
/**
|
|
@@ -36138,7 +36183,7 @@ class LicenseApi {
|
|
|
36138
36183
|
/**
|
|
36139
36184
|
* License service.
|
|
36140
36185
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36141
|
-
* @version
|
|
36186
|
+
* @version 153.0.0
|
|
36142
36187
|
*/
|
|
36143
36188
|
|
|
36144
36189
|
/**
|
|
@@ -36376,7 +36421,7 @@ class LocationsApi {
|
|
|
36376
36421
|
/**
|
|
36377
36422
|
* Locations service.
|
|
36378
36423
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36379
|
-
* @version
|
|
36424
|
+
* @version 153.0.0
|
|
36380
36425
|
*/
|
|
36381
36426
|
|
|
36382
36427
|
/**
|
|
@@ -36612,7 +36657,7 @@ class MessagingApi {
|
|
|
36612
36657
|
/**
|
|
36613
36658
|
* Messaging service.
|
|
36614
36659
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
36615
|
-
* @version
|
|
36660
|
+
* @version 153.0.0
|
|
36616
36661
|
*/
|
|
36617
36662
|
|
|
36618
36663
|
/**
|
|
@@ -36763,7 +36808,7 @@ class MobileDevicesApi {
|
|
|
36763
36808
|
/**
|
|
36764
36809
|
* MobileDevices service.
|
|
36765
36810
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
36766
|
-
* @version
|
|
36811
|
+
* @version 153.0.0
|
|
36767
36812
|
*/
|
|
36768
36813
|
|
|
36769
36814
|
/**
|
|
@@ -36914,7 +36959,7 @@ class NotificationsApi {
|
|
|
36914
36959
|
/**
|
|
36915
36960
|
* Notifications service.
|
|
36916
36961
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
36917
|
-
* @version
|
|
36962
|
+
* @version 153.0.0
|
|
36918
36963
|
*/
|
|
36919
36964
|
|
|
36920
36965
|
/**
|
|
@@ -37139,7 +37184,7 @@ class OAuthApi {
|
|
|
37139
37184
|
/**
|
|
37140
37185
|
* OAuth service.
|
|
37141
37186
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37142
|
-
* @version
|
|
37187
|
+
* @version 153.0.0
|
|
37143
37188
|
*/
|
|
37144
37189
|
|
|
37145
37190
|
/**
|
|
@@ -37505,7 +37550,7 @@ class ObjectsApi {
|
|
|
37505
37550
|
/**
|
|
37506
37551
|
* Objects service.
|
|
37507
37552
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
37508
|
-
* @version
|
|
37553
|
+
* @version 153.0.0
|
|
37509
37554
|
*/
|
|
37510
37555
|
|
|
37511
37556
|
/**
|
|
@@ -37776,7 +37821,7 @@ class OrganizationApi {
|
|
|
37776
37821
|
/**
|
|
37777
37822
|
* Organization service.
|
|
37778
37823
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
37779
|
-
* @version
|
|
37824
|
+
* @version 153.0.0
|
|
37780
37825
|
*/
|
|
37781
37826
|
|
|
37782
37827
|
/**
|
|
@@ -38179,7 +38224,7 @@ class OrganizationAuthorizationApi {
|
|
|
38179
38224
|
/**
|
|
38180
38225
|
* OrganizationAuthorization service.
|
|
38181
38226
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38182
|
-
* @version
|
|
38227
|
+
* @version 153.0.0
|
|
38183
38228
|
*/
|
|
38184
38229
|
|
|
38185
38230
|
/**
|
|
@@ -39104,7 +39149,7 @@ class OutboundApi {
|
|
|
39104
39149
|
/**
|
|
39105
39150
|
* Outbound service.
|
|
39106
39151
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
39107
|
-
* @version
|
|
39152
|
+
* @version 153.0.0
|
|
39108
39153
|
*/
|
|
39109
39154
|
|
|
39110
39155
|
/**
|
|
@@ -42493,7 +42538,7 @@ class PresenceApi {
|
|
|
42493
42538
|
/**
|
|
42494
42539
|
* Presence service.
|
|
42495
42540
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42496
|
-
* @version
|
|
42541
|
+
* @version 153.0.0
|
|
42497
42542
|
*/
|
|
42498
42543
|
|
|
42499
42544
|
/**
|
|
@@ -42999,7 +43044,7 @@ class ProcessAutomationApi {
|
|
|
42999
43044
|
/**
|
|
43000
43045
|
* ProcessAutomation service.
|
|
43001
43046
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
43002
|
-
* @version
|
|
43047
|
+
* @version 153.0.0
|
|
43003
43048
|
*/
|
|
43004
43049
|
|
|
43005
43050
|
/**
|
|
@@ -43237,7 +43282,7 @@ class QualityApi {
|
|
|
43237
43282
|
/**
|
|
43238
43283
|
* Quality service.
|
|
43239
43284
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43240
|
-
* @version
|
|
43285
|
+
* @version 153.0.0
|
|
43241
43286
|
*/
|
|
43242
43287
|
|
|
43243
43288
|
/**
|
|
@@ -44815,7 +44860,7 @@ class RecordingApi {
|
|
|
44815
44860
|
/**
|
|
44816
44861
|
* Recording service.
|
|
44817
44862
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44818
|
-
* @version
|
|
44863
|
+
* @version 153.0.0
|
|
44819
44864
|
*/
|
|
44820
44865
|
|
|
44821
44866
|
/**
|
|
@@ -46502,7 +46547,7 @@ class ResponseManagementApi {
|
|
|
46502
46547
|
/**
|
|
46503
46548
|
* ResponseManagement service.
|
|
46504
46549
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46505
|
-
* @version
|
|
46550
|
+
* @version 153.0.0
|
|
46506
46551
|
*/
|
|
46507
46552
|
|
|
46508
46553
|
/**
|
|
@@ -46986,7 +47031,7 @@ class RoutingApi {
|
|
|
46986
47031
|
/**
|
|
46987
47032
|
* Routing service.
|
|
46988
47033
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46989
|
-
* @version
|
|
47034
|
+
* @version 153.0.0
|
|
46990
47035
|
*/
|
|
46991
47036
|
|
|
46992
47037
|
/**
|
|
@@ -47712,6 +47757,8 @@ class RoutingApi {
|
|
|
47712
47757
|
* Get domains
|
|
47713
47758
|
*
|
|
47714
47759
|
* @param {Object} opts Optional parameters
|
|
47760
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47761
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47715
47762
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
47716
47763
|
*/
|
|
47717
47764
|
getRoutingEmailDomains(opts) {
|
|
@@ -47722,7 +47769,7 @@ class RoutingApi {
|
|
|
47722
47769
|
'/api/v2/routing/email/domains',
|
|
47723
47770
|
'GET',
|
|
47724
47771
|
{ },
|
|
47725
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
47772
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
47726
47773
|
{ },
|
|
47727
47774
|
{ },
|
|
47728
47775
|
null,
|
|
@@ -50399,7 +50446,7 @@ class SCIMApi {
|
|
|
50399
50446
|
/**
|
|
50400
50447
|
* SCIM service.
|
|
50401
50448
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50402
|
-
* @version
|
|
50449
|
+
* @version 153.0.0
|
|
50403
50450
|
*/
|
|
50404
50451
|
|
|
50405
50452
|
/**
|
|
@@ -51276,7 +51323,7 @@ class ScriptsApi {
|
|
|
51276
51323
|
/**
|
|
51277
51324
|
* Scripts service.
|
|
51278
51325
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51279
|
-
* @version
|
|
51326
|
+
* @version 153.0.0
|
|
51280
51327
|
*/
|
|
51281
51328
|
|
|
51282
51329
|
/**
|
|
@@ -51695,7 +51742,7 @@ class SearchApi {
|
|
|
51695
51742
|
/**
|
|
51696
51743
|
* Search service.
|
|
51697
51744
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51698
|
-
* @version
|
|
51745
|
+
* @version 153.0.0
|
|
51699
51746
|
*/
|
|
51700
51747
|
|
|
51701
51748
|
/**
|
|
@@ -52280,7 +52327,7 @@ class SpeechTextAnalyticsApi {
|
|
|
52280
52327
|
/**
|
|
52281
52328
|
* SpeechTextAnalytics service.
|
|
52282
52329
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52283
|
-
* @version
|
|
52330
|
+
* @version 153.0.0
|
|
52284
52331
|
*/
|
|
52285
52332
|
|
|
52286
52333
|
/**
|
|
@@ -53134,7 +53181,7 @@ class StationsApi {
|
|
|
53134
53181
|
/**
|
|
53135
53182
|
* Stations service.
|
|
53136
53183
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
53137
|
-
* @version
|
|
53184
|
+
* @version 153.0.0
|
|
53138
53185
|
*/
|
|
53139
53186
|
|
|
53140
53187
|
/**
|
|
@@ -53281,7 +53328,7 @@ class SuggestApi {
|
|
|
53281
53328
|
/**
|
|
53282
53329
|
* Suggest service.
|
|
53283
53330
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53284
|
-
* @version
|
|
53331
|
+
* @version 153.0.0
|
|
53285
53332
|
*/
|
|
53286
53333
|
|
|
53287
53334
|
/**
|
|
@@ -53420,7 +53467,7 @@ class TeamsApi {
|
|
|
53420
53467
|
/**
|
|
53421
53468
|
* Teams service.
|
|
53422
53469
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
53423
|
-
* @version
|
|
53470
|
+
* @version 153.0.0
|
|
53424
53471
|
*/
|
|
53425
53472
|
|
|
53426
53473
|
/**
|
|
@@ -53691,7 +53738,7 @@ class TelephonyApi {
|
|
|
53691
53738
|
/**
|
|
53692
53739
|
* Telephony service.
|
|
53693
53740
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
53694
|
-
* @version
|
|
53741
|
+
* @version 153.0.0
|
|
53695
53742
|
*/
|
|
53696
53743
|
|
|
53697
53744
|
/**
|
|
@@ -53799,7 +53846,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
53799
53846
|
/**
|
|
53800
53847
|
* TelephonyProvidersEdge service.
|
|
53801
53848
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
53802
|
-
* @version
|
|
53849
|
+
* @version 153.0.0
|
|
53803
53850
|
*/
|
|
53804
53851
|
|
|
53805
53852
|
/**
|
|
@@ -57432,7 +57479,7 @@ class TextbotsApi {
|
|
|
57432
57479
|
/**
|
|
57433
57480
|
* Textbots service.
|
|
57434
57481
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
57435
|
-
* @version
|
|
57482
|
+
* @version 153.0.0
|
|
57436
57483
|
*/
|
|
57437
57484
|
|
|
57438
57485
|
/**
|
|
@@ -57560,7 +57607,7 @@ class TokensApi {
|
|
|
57560
57607
|
/**
|
|
57561
57608
|
* Tokens service.
|
|
57562
57609
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
57563
|
-
* @version
|
|
57610
|
+
* @version 153.0.0
|
|
57564
57611
|
*/
|
|
57565
57612
|
|
|
57566
57613
|
/**
|
|
@@ -57666,7 +57713,7 @@ class UploadsApi {
|
|
|
57666
57713
|
/**
|
|
57667
57714
|
* Uploads service.
|
|
57668
57715
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
57669
|
-
* @version
|
|
57716
|
+
* @version 153.0.0
|
|
57670
57717
|
*/
|
|
57671
57718
|
|
|
57672
57719
|
/**
|
|
@@ -57842,7 +57889,7 @@ class UsageApi {
|
|
|
57842
57889
|
/**
|
|
57843
57890
|
* Usage service.
|
|
57844
57891
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
57845
|
-
* @version
|
|
57892
|
+
* @version 153.0.0
|
|
57846
57893
|
*/
|
|
57847
57894
|
|
|
57848
57895
|
/**
|
|
@@ -57913,7 +57960,7 @@ class UserRecordingsApi {
|
|
|
57913
57960
|
/**
|
|
57914
57961
|
* UserRecordings service.
|
|
57915
57962
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
57916
|
-
* @version
|
|
57963
|
+
* @version 153.0.0
|
|
57917
57964
|
*/
|
|
57918
57965
|
|
|
57919
57966
|
/**
|
|
@@ -58098,7 +58145,7 @@ class UsersApi {
|
|
|
58098
58145
|
/**
|
|
58099
58146
|
* Users service.
|
|
58100
58147
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
58101
|
-
* @version
|
|
58148
|
+
* @version 153.0.0
|
|
58102
58149
|
*/
|
|
58103
58150
|
|
|
58104
58151
|
/**
|
|
@@ -60455,7 +60502,7 @@ class UtilitiesApi {
|
|
|
60455
60502
|
/**
|
|
60456
60503
|
* Utilities service.
|
|
60457
60504
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
60458
|
-
* @version
|
|
60505
|
+
* @version 153.0.0
|
|
60459
60506
|
*/
|
|
60460
60507
|
|
|
60461
60508
|
/**
|
|
@@ -60566,7 +60613,7 @@ class VoicemailApi {
|
|
|
60566
60613
|
/**
|
|
60567
60614
|
* Voicemail service.
|
|
60568
60615
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
60569
|
-
* @version
|
|
60616
|
+
* @version 153.0.0
|
|
60570
60617
|
*/
|
|
60571
60618
|
|
|
60572
60619
|
/**
|
|
@@ -61233,7 +61280,7 @@ class WebChatApi {
|
|
|
61233
61280
|
/**
|
|
61234
61281
|
* WebChat service.
|
|
61235
61282
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
61236
|
-
* @version
|
|
61283
|
+
* @version 153.0.0
|
|
61237
61284
|
*/
|
|
61238
61285
|
|
|
61239
61286
|
/**
|
|
@@ -61777,7 +61824,7 @@ class WebDeploymentsApi {
|
|
|
61777
61824
|
/**
|
|
61778
61825
|
* WebDeployments service.
|
|
61779
61826
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
61780
|
-
* @version
|
|
61827
|
+
* @version 153.0.0
|
|
61781
61828
|
*/
|
|
61782
61829
|
|
|
61783
61830
|
/**
|
|
@@ -62165,7 +62212,7 @@ class WebMessagingApi {
|
|
|
62165
62212
|
/**
|
|
62166
62213
|
* WebMessaging service.
|
|
62167
62214
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
62168
|
-
* @version
|
|
62215
|
+
* @version 153.0.0
|
|
62169
62216
|
*/
|
|
62170
62217
|
|
|
62171
62218
|
/**
|
|
@@ -62211,7 +62258,7 @@ class WidgetsApi {
|
|
|
62211
62258
|
/**
|
|
62212
62259
|
* Widgets service.
|
|
62213
62260
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
62214
|
-
* @version
|
|
62261
|
+
* @version 153.0.0
|
|
62215
62262
|
*/
|
|
62216
62263
|
|
|
62217
62264
|
/**
|
|
@@ -62357,7 +62404,7 @@ class WorkforceManagementApi {
|
|
|
62357
62404
|
/**
|
|
62358
62405
|
* WorkforceManagement service.
|
|
62359
62406
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
62360
|
-
* @version
|
|
62407
|
+
* @version 153.0.0
|
|
62361
62408
|
*/
|
|
62362
62409
|
|
|
62363
62410
|
/**
|
|
@@ -62777,6 +62824,56 @@ class WorkforceManagementApi {
|
|
|
62777
62824
|
);
|
|
62778
62825
|
}
|
|
62779
62826
|
|
|
62827
|
+
/**
|
|
62828
|
+
* Get an adherence explanation for the current user
|
|
62829
|
+
*
|
|
62830
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
62831
|
+
*/
|
|
62832
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
62833
|
+
// verify the required parameter 'explanationId' is set
|
|
62834
|
+
if (explanationId === undefined || explanationId === null) {
|
|
62835
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
62836
|
+
}
|
|
62837
|
+
|
|
62838
|
+
return this.apiClient.callApi(
|
|
62839
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
62840
|
+
'GET',
|
|
62841
|
+
{ 'explanationId': explanationId },
|
|
62842
|
+
{ },
|
|
62843
|
+
{ },
|
|
62844
|
+
{ },
|
|
62845
|
+
null,
|
|
62846
|
+
['PureCloud OAuth'],
|
|
62847
|
+
['application/json'],
|
|
62848
|
+
['application/json']
|
|
62849
|
+
);
|
|
62850
|
+
}
|
|
62851
|
+
|
|
62852
|
+
/**
|
|
62853
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
62854
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
62855
|
+
* @param {String} jobId The ID of the job
|
|
62856
|
+
*/
|
|
62857
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
62858
|
+
// verify the required parameter 'jobId' is set
|
|
62859
|
+
if (jobId === undefined || jobId === null) {
|
|
62860
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
62861
|
+
}
|
|
62862
|
+
|
|
62863
|
+
return this.apiClient.callApi(
|
|
62864
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
62865
|
+
'GET',
|
|
62866
|
+
{ 'jobId': jobId },
|
|
62867
|
+
{ },
|
|
62868
|
+
{ },
|
|
62869
|
+
{ },
|
|
62870
|
+
null,
|
|
62871
|
+
['PureCloud OAuth'],
|
|
62872
|
+
['application/json'],
|
|
62873
|
+
['application/json']
|
|
62874
|
+
);
|
|
62875
|
+
}
|
|
62876
|
+
|
|
62780
62877
|
/**
|
|
62781
62878
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
62782
62879
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -62827,6 +62924,36 @@ class WorkforceManagementApi {
|
|
|
62827
62924
|
);
|
|
62828
62925
|
}
|
|
62829
62926
|
|
|
62927
|
+
/**
|
|
62928
|
+
* Get an adherence explanation
|
|
62929
|
+
*
|
|
62930
|
+
* @param {String} agentId The ID of the agent to query
|
|
62931
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
62932
|
+
*/
|
|
62933
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
62934
|
+
// verify the required parameter 'agentId' is set
|
|
62935
|
+
if (agentId === undefined || agentId === null) {
|
|
62936
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
62937
|
+
}
|
|
62938
|
+
// verify the required parameter 'explanationId' is set
|
|
62939
|
+
if (explanationId === undefined || explanationId === null) {
|
|
62940
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
62941
|
+
}
|
|
62942
|
+
|
|
62943
|
+
return this.apiClient.callApi(
|
|
62944
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
62945
|
+
'GET',
|
|
62946
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
62947
|
+
{ },
|
|
62948
|
+
{ },
|
|
62949
|
+
{ },
|
|
62950
|
+
null,
|
|
62951
|
+
['PureCloud OAuth'],
|
|
62952
|
+
['application/json'],
|
|
62953
|
+
['application/json']
|
|
62954
|
+
);
|
|
62955
|
+
}
|
|
62956
|
+
|
|
62830
62957
|
/**
|
|
62831
62958
|
* Get the management unit to which the agent belongs
|
|
62832
62959
|
*
|
|
@@ -64546,6 +64673,31 @@ class WorkforceManagementApi {
|
|
|
64546
64673
|
);
|
|
64547
64674
|
}
|
|
64548
64675
|
|
|
64676
|
+
/**
|
|
64677
|
+
* Request to fetch the status of the historical shrinkage query
|
|
64678
|
+
*
|
|
64679
|
+
* @param {String} jobId jobId
|
|
64680
|
+
*/
|
|
64681
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
64682
|
+
// verify the required parameter 'jobId' is set
|
|
64683
|
+
if (jobId === undefined || jobId === null) {
|
|
64684
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
64685
|
+
}
|
|
64686
|
+
|
|
64687
|
+
return this.apiClient.callApi(
|
|
64688
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
64689
|
+
'GET',
|
|
64690
|
+
{ 'jobId': jobId },
|
|
64691
|
+
{ },
|
|
64692
|
+
{ },
|
|
64693
|
+
{ },
|
|
64694
|
+
null,
|
|
64695
|
+
['PureCloud OAuth'],
|
|
64696
|
+
['application/json'],
|
|
64697
|
+
['application/json']
|
|
64698
|
+
);
|
|
64699
|
+
}
|
|
64700
|
+
|
|
64549
64701
|
/**
|
|
64550
64702
|
* Get a time off request for the current user
|
|
64551
64703
|
*
|
|
@@ -64620,6 +64772,41 @@ class WorkforceManagementApi {
|
|
|
64620
64772
|
);
|
|
64621
64773
|
}
|
|
64622
64774
|
|
|
64775
|
+
/**
|
|
64776
|
+
* Update an adherence explanation
|
|
64777
|
+
*
|
|
64778
|
+
* @param {String} agentId The ID of the agent to query
|
|
64779
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
64780
|
+
* @param {Object} body The request body
|
|
64781
|
+
*/
|
|
64782
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
64783
|
+
// verify the required parameter 'agentId' is set
|
|
64784
|
+
if (agentId === undefined || agentId === null) {
|
|
64785
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64786
|
+
}
|
|
64787
|
+
// verify the required parameter 'explanationId' is set
|
|
64788
|
+
if (explanationId === undefined || explanationId === null) {
|
|
64789
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64790
|
+
}
|
|
64791
|
+
// verify the required parameter 'body' is set
|
|
64792
|
+
if (body === undefined || body === null) {
|
|
64793
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64794
|
+
}
|
|
64795
|
+
|
|
64796
|
+
return this.apiClient.callApi(
|
|
64797
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
64798
|
+
'PATCH',
|
|
64799
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
64800
|
+
{ },
|
|
64801
|
+
{ },
|
|
64802
|
+
{ },
|
|
64803
|
+
body,
|
|
64804
|
+
['PureCloud OAuth'],
|
|
64805
|
+
['application/json'],
|
|
64806
|
+
['application/json']
|
|
64807
|
+
);
|
|
64808
|
+
}
|
|
64809
|
+
|
|
64623
64810
|
/**
|
|
64624
64811
|
* Update business unit
|
|
64625
64812
|
*
|
|
@@ -65059,6 +65246,61 @@ class WorkforceManagementApi {
|
|
|
65059
65246
|
);
|
|
65060
65247
|
}
|
|
65061
65248
|
|
|
65249
|
+
/**
|
|
65250
|
+
* Submit an adherence explanation for the current user
|
|
65251
|
+
*
|
|
65252
|
+
* @param {Object} body The request body
|
|
65253
|
+
*/
|
|
65254
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
65255
|
+
// verify the required parameter 'body' is set
|
|
65256
|
+
if (body === undefined || body === null) {
|
|
65257
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
65258
|
+
}
|
|
65259
|
+
|
|
65260
|
+
return this.apiClient.callApi(
|
|
65261
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
65262
|
+
'POST',
|
|
65263
|
+
{ },
|
|
65264
|
+
{ },
|
|
65265
|
+
{ },
|
|
65266
|
+
{ },
|
|
65267
|
+
body,
|
|
65268
|
+
['PureCloud OAuth'],
|
|
65269
|
+
['application/json'],
|
|
65270
|
+
['application/json']
|
|
65271
|
+
);
|
|
65272
|
+
}
|
|
65273
|
+
|
|
65274
|
+
/**
|
|
65275
|
+
* Query adherence explanations for the current user
|
|
65276
|
+
*
|
|
65277
|
+
* @param {Object} body The request body
|
|
65278
|
+
* @param {Object} opts Optional parameters
|
|
65279
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65280
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65281
|
+
*/
|
|
65282
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
65283
|
+
opts = opts || {};
|
|
65284
|
+
|
|
65285
|
+
// verify the required parameter 'body' is set
|
|
65286
|
+
if (body === undefined || body === null) {
|
|
65287
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
65288
|
+
}
|
|
65289
|
+
|
|
65290
|
+
return this.apiClient.callApi(
|
|
65291
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
65292
|
+
'POST',
|
|
65293
|
+
{ },
|
|
65294
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65295
|
+
{ },
|
|
65296
|
+
{ },
|
|
65297
|
+
body,
|
|
65298
|
+
['PureCloud OAuth'],
|
|
65299
|
+
['application/json'],
|
|
65300
|
+
['application/json']
|
|
65301
|
+
);
|
|
65302
|
+
}
|
|
65303
|
+
|
|
65062
65304
|
/**
|
|
65063
65305
|
* Request a historical adherence report for users across management units
|
|
65064
65306
|
*
|
|
@@ -65083,6 +65325,71 @@ class WorkforceManagementApi {
|
|
|
65083
65325
|
);
|
|
65084
65326
|
}
|
|
65085
65327
|
|
|
65328
|
+
/**
|
|
65329
|
+
* Add an adherence explanation for the requested user
|
|
65330
|
+
*
|
|
65331
|
+
* @param {String} agentId The ID of the agent to query
|
|
65332
|
+
* @param {Object} body The request body
|
|
65333
|
+
*/
|
|
65334
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
65335
|
+
// verify the required parameter 'agentId' is set
|
|
65336
|
+
if (agentId === undefined || agentId === null) {
|
|
65337
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
65338
|
+
}
|
|
65339
|
+
// verify the required parameter 'body' is set
|
|
65340
|
+
if (body === undefined || body === null) {
|
|
65341
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
65342
|
+
}
|
|
65343
|
+
|
|
65344
|
+
return this.apiClient.callApi(
|
|
65345
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
65346
|
+
'POST',
|
|
65347
|
+
{ 'agentId': agentId },
|
|
65348
|
+
{ },
|
|
65349
|
+
{ },
|
|
65350
|
+
{ },
|
|
65351
|
+
body,
|
|
65352
|
+
['PureCloud OAuth'],
|
|
65353
|
+
['application/json'],
|
|
65354
|
+
['application/json']
|
|
65355
|
+
);
|
|
65356
|
+
}
|
|
65357
|
+
|
|
65358
|
+
/**
|
|
65359
|
+
* Query adherence explanations for the given agent across a specified range
|
|
65360
|
+
*
|
|
65361
|
+
* @param {String} agentId The ID of the agent to query
|
|
65362
|
+
* @param {Object} body The request body
|
|
65363
|
+
* @param {Object} opts Optional parameters
|
|
65364
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65365
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65366
|
+
*/
|
|
65367
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
65368
|
+
opts = opts || {};
|
|
65369
|
+
|
|
65370
|
+
// verify the required parameter 'agentId' is set
|
|
65371
|
+
if (agentId === undefined || agentId === null) {
|
|
65372
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
65373
|
+
}
|
|
65374
|
+
// verify the required parameter 'body' is set
|
|
65375
|
+
if (body === undefined || body === null) {
|
|
65376
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
65377
|
+
}
|
|
65378
|
+
|
|
65379
|
+
return this.apiClient.callApi(
|
|
65380
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
65381
|
+
'POST',
|
|
65382
|
+
{ 'agentId': agentId },
|
|
65383
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65384
|
+
{ },
|
|
65385
|
+
{ },
|
|
65386
|
+
body,
|
|
65387
|
+
['PureCloud OAuth'],
|
|
65388
|
+
['application/json'],
|
|
65389
|
+
['application/json']
|
|
65390
|
+
);
|
|
65391
|
+
}
|
|
65392
|
+
|
|
65086
65393
|
/**
|
|
65087
65394
|
* Get published schedule for the current user
|
|
65088
65395
|
*
|
|
@@ -65136,6 +65443,41 @@ class WorkforceManagementApi {
|
|
|
65136
65443
|
);
|
|
65137
65444
|
}
|
|
65138
65445
|
|
|
65446
|
+
/**
|
|
65447
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
65448
|
+
*
|
|
65449
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
65450
|
+
* @param {Object} body The request body
|
|
65451
|
+
* @param {Object} opts Optional parameters
|
|
65452
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65453
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65454
|
+
*/
|
|
65455
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
65456
|
+
opts = opts || {};
|
|
65457
|
+
|
|
65458
|
+
// verify the required parameter 'businessUnitId' is set
|
|
65459
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
65460
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
65461
|
+
}
|
|
65462
|
+
// verify the required parameter 'body' is set
|
|
65463
|
+
if (body === undefined || body === null) {
|
|
65464
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
65465
|
+
}
|
|
65466
|
+
|
|
65467
|
+
return this.apiClient.callApi(
|
|
65468
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
65469
|
+
'POST',
|
|
65470
|
+
{ 'businessUnitId': businessUnitId },
|
|
65471
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65472
|
+
{ },
|
|
65473
|
+
{ },
|
|
65474
|
+
body,
|
|
65475
|
+
['PureCloud OAuth'],
|
|
65476
|
+
['application/json'],
|
|
65477
|
+
['application/json']
|
|
65478
|
+
);
|
|
65479
|
+
}
|
|
65480
|
+
|
|
65139
65481
|
/**
|
|
65140
65482
|
* Search published schedules
|
|
65141
65483
|
*
|
|
@@ -65963,6 +66305,35 @@ class WorkforceManagementApi {
|
|
|
65963
66305
|
);
|
|
65964
66306
|
}
|
|
65965
66307
|
|
|
66308
|
+
/**
|
|
66309
|
+
* Request a historical shrinkage report
|
|
66310
|
+
* 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.
|
|
66311
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
66312
|
+
* @param {Object} opts Optional parameters
|
|
66313
|
+
* @param {Object} opts.body body
|
|
66314
|
+
*/
|
|
66315
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
66316
|
+
opts = opts || {};
|
|
66317
|
+
|
|
66318
|
+
// verify the required parameter 'managementUnitId' is set
|
|
66319
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
66320
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
66321
|
+
}
|
|
66322
|
+
|
|
66323
|
+
return this.apiClient.callApi(
|
|
66324
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
66325
|
+
'POST',
|
|
66326
|
+
{ 'managementUnitId': managementUnitId },
|
|
66327
|
+
{ },
|
|
66328
|
+
{ },
|
|
66329
|
+
{ },
|
|
66330
|
+
opts['body'],
|
|
66331
|
+
['PureCloud OAuth'],
|
|
66332
|
+
['application/json'],
|
|
66333
|
+
['application/json']
|
|
66334
|
+
);
|
|
66335
|
+
}
|
|
66336
|
+
|
|
65966
66337
|
/**
|
|
65967
66338
|
* Creates a new time off limit object under management unit.
|
|
65968
66339
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -66703,7 +67074,7 @@ class WorkforceManagementApi {
|
|
|
66703
67074
|
* </pre>
|
|
66704
67075
|
* </p>
|
|
66705
67076
|
* @module purecloud-platform-client-v2/index
|
|
66706
|
-
* @version
|
|
67077
|
+
* @version 153.0.0
|
|
66707
67078
|
*/
|
|
66708
67079
|
class platformClient {
|
|
66709
67080
|
constructor() {
|