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
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 153.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1481,7 +1481,7 @@ class AlertingApi {
|
|
|
1481
1481
|
/**
|
|
1482
1482
|
* Alerting service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 153.0.0
|
|
1485
1485
|
*/
|
|
1486
1486
|
|
|
1487
1487
|
/**
|
|
@@ -1795,7 +1795,7 @@ class AnalyticsApi {
|
|
|
1795
1795
|
/**
|
|
1796
1796
|
* Analytics service.
|
|
1797
1797
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1798
|
-
* @version
|
|
1798
|
+
* @version 153.0.0
|
|
1799
1799
|
*/
|
|
1800
1800
|
|
|
1801
1801
|
/**
|
|
@@ -1811,7 +1811,7 @@ class AnalyticsApi {
|
|
|
1811
1811
|
|
|
1812
1812
|
|
|
1813
1813
|
/**
|
|
1814
|
-
* Delete/cancel an async
|
|
1814
|
+
* Delete/cancel an async details job
|
|
1815
1815
|
*
|
|
1816
1816
|
* @param {String} jobId jobId
|
|
1817
1817
|
*/
|
|
@@ -1993,7 +1993,7 @@ class AnalyticsApi {
|
|
|
1993
1993
|
}
|
|
1994
1994
|
|
|
1995
1995
|
/**
|
|
1996
|
-
* Fetch a page of results for an async
|
|
1996
|
+
* Fetch a page of results for an async details job
|
|
1997
1997
|
*
|
|
1998
1998
|
* @param {String} jobId jobId
|
|
1999
1999
|
* @param {Object} opts Optional parameters
|
|
@@ -3048,7 +3048,7 @@ class ArchitectApi {
|
|
|
3048
3048
|
/**
|
|
3049
3049
|
* Architect service.
|
|
3050
3050
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3051
|
-
* @version
|
|
3051
|
+
* @version 153.0.0
|
|
3052
3052
|
*/
|
|
3053
3053
|
|
|
3054
3054
|
/**
|
|
@@ -6095,7 +6095,7 @@ class AuditApi {
|
|
|
6095
6095
|
/**
|
|
6096
6096
|
* Audit service.
|
|
6097
6097
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6098
|
-
* @version
|
|
6098
|
+
* @version 153.0.0
|
|
6099
6099
|
*/
|
|
6100
6100
|
|
|
6101
6101
|
/**
|
|
@@ -6266,7 +6266,7 @@ class AuthorizationApi {
|
|
|
6266
6266
|
/**
|
|
6267
6267
|
* Authorization service.
|
|
6268
6268
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6269
|
-
* @version
|
|
6269
|
+
* @version 153.0.0
|
|
6270
6270
|
*/
|
|
6271
6271
|
|
|
6272
6272
|
/**
|
|
@@ -6799,6 +6799,26 @@ class AuthorizationApi {
|
|
|
6799
6799
|
);
|
|
6800
6800
|
}
|
|
6801
6801
|
|
|
6802
|
+
/**
|
|
6803
|
+
* Get authorization settings
|
|
6804
|
+
*
|
|
6805
|
+
*/
|
|
6806
|
+
getAuthorizationSettings() {
|
|
6807
|
+
|
|
6808
|
+
return this.apiClient.callApi(
|
|
6809
|
+
'/api/v2/authorization/settings',
|
|
6810
|
+
'GET',
|
|
6811
|
+
{ },
|
|
6812
|
+
{ },
|
|
6813
|
+
{ },
|
|
6814
|
+
{ },
|
|
6815
|
+
null,
|
|
6816
|
+
['PureCloud OAuth'],
|
|
6817
|
+
['application/json'],
|
|
6818
|
+
['application/json']
|
|
6819
|
+
);
|
|
6820
|
+
}
|
|
6821
|
+
|
|
6802
6822
|
/**
|
|
6803
6823
|
* Returns a listing of roles and permissions for a user.
|
|
6804
6824
|
*
|
|
@@ -6923,6 +6943,31 @@ class AuthorizationApi {
|
|
|
6923
6943
|
);
|
|
6924
6944
|
}
|
|
6925
6945
|
|
|
6946
|
+
/**
|
|
6947
|
+
* Change authorization settings
|
|
6948
|
+
* Change authorization settings
|
|
6949
|
+
* @param {Object} body Authorization Settings
|
|
6950
|
+
*/
|
|
6951
|
+
patchAuthorizationSettings(body) {
|
|
6952
|
+
// verify the required parameter 'body' is set
|
|
6953
|
+
if (body === undefined || body === null) {
|
|
6954
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
6955
|
+
}
|
|
6956
|
+
|
|
6957
|
+
return this.apiClient.callApi(
|
|
6958
|
+
'/api/v2/authorization/settings',
|
|
6959
|
+
'PATCH',
|
|
6960
|
+
{ },
|
|
6961
|
+
{ },
|
|
6962
|
+
{ },
|
|
6963
|
+
{ },
|
|
6964
|
+
body,
|
|
6965
|
+
['PureCloud OAuth'],
|
|
6966
|
+
['application/json'],
|
|
6967
|
+
['application/json']
|
|
6968
|
+
);
|
|
6969
|
+
}
|
|
6970
|
+
|
|
6926
6971
|
/**
|
|
6927
6972
|
* Assign a list of objects to a division
|
|
6928
6973
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
@@ -7449,7 +7494,7 @@ class BillingApi {
|
|
|
7449
7494
|
/**
|
|
7450
7495
|
* Billing service.
|
|
7451
7496
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7452
|
-
* @version
|
|
7497
|
+
* @version 153.0.0
|
|
7453
7498
|
*/
|
|
7454
7499
|
|
|
7455
7500
|
/**
|
|
@@ -7529,7 +7574,7 @@ class ChatApi {
|
|
|
7529
7574
|
/**
|
|
7530
7575
|
* Chat service.
|
|
7531
7576
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7532
|
-
* @version
|
|
7577
|
+
* @version 153.0.0
|
|
7533
7578
|
*/
|
|
7534
7579
|
|
|
7535
7580
|
/**
|
|
@@ -7620,7 +7665,7 @@ class CoachingApi {
|
|
|
7620
7665
|
/**
|
|
7621
7666
|
* Coaching service.
|
|
7622
7667
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7623
|
-
* @version
|
|
7668
|
+
* @version 153.0.0
|
|
7624
7669
|
*/
|
|
7625
7670
|
|
|
7626
7671
|
/**
|
|
@@ -8197,7 +8242,7 @@ class ContentManagementApi {
|
|
|
8197
8242
|
/**
|
|
8198
8243
|
* ContentManagement service.
|
|
8199
8244
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8200
|
-
* @version
|
|
8245
|
+
* @version 153.0.0
|
|
8201
8246
|
*/
|
|
8202
8247
|
|
|
8203
8248
|
/**
|
|
@@ -9337,7 +9382,7 @@ class ConversationsApi {
|
|
|
9337
9382
|
/**
|
|
9338
9383
|
* Conversations service.
|
|
9339
9384
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9340
|
-
* @version
|
|
9385
|
+
* @version 153.0.0
|
|
9341
9386
|
*/
|
|
9342
9387
|
|
|
9343
9388
|
/**
|
|
@@ -9353,7 +9398,7 @@ class ConversationsApi {
|
|
|
9353
9398
|
|
|
9354
9399
|
|
|
9355
9400
|
/**
|
|
9356
|
-
* Delete/cancel an async
|
|
9401
|
+
* Delete/cancel an async details job
|
|
9357
9402
|
*
|
|
9358
9403
|
* @param {String} jobId jobId
|
|
9359
9404
|
*/
|
|
@@ -9727,7 +9772,7 @@ class ConversationsApi {
|
|
|
9727
9772
|
}
|
|
9728
9773
|
|
|
9729
9774
|
/**
|
|
9730
|
-
* Fetch a page of results for an async
|
|
9775
|
+
* Fetch a page of results for an async details job
|
|
9731
9776
|
*
|
|
9732
9777
|
* @param {String} jobId jobId
|
|
9733
9778
|
* @param {Object} opts Optional parameters
|
|
@@ -14560,7 +14605,7 @@ class DataExtensionsApi {
|
|
|
14560
14605
|
/**
|
|
14561
14606
|
* DataExtensions service.
|
|
14562
14607
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14563
|
-
* @version
|
|
14608
|
+
* @version 153.0.0
|
|
14564
14609
|
*/
|
|
14565
14610
|
|
|
14566
14611
|
/**
|
|
@@ -14646,7 +14691,7 @@ class DownloadsApi {
|
|
|
14646
14691
|
/**
|
|
14647
14692
|
* Downloads service.
|
|
14648
14693
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14649
|
-
* @version
|
|
14694
|
+
* @version 153.0.0
|
|
14650
14695
|
*/
|
|
14651
14696
|
|
|
14652
14697
|
/**
|
|
@@ -14698,7 +14743,7 @@ class EventsApi {
|
|
|
14698
14743
|
/**
|
|
14699
14744
|
* Events service.
|
|
14700
14745
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14701
|
-
* @version
|
|
14746
|
+
* @version 153.0.0
|
|
14702
14747
|
*/
|
|
14703
14748
|
|
|
14704
14749
|
/**
|
|
@@ -14794,7 +14839,7 @@ class ExternalContactsApi {
|
|
|
14794
14839
|
/**
|
|
14795
14840
|
* ExternalContacts service.
|
|
14796
14841
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14797
|
-
* @version
|
|
14842
|
+
* @version 153.0.0
|
|
14798
14843
|
*/
|
|
14799
14844
|
|
|
14800
14845
|
/**
|
|
@@ -16752,7 +16797,7 @@ class FaxApi {
|
|
|
16752
16797
|
/**
|
|
16753
16798
|
* Fax service.
|
|
16754
16799
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16755
|
-
* @version
|
|
16800
|
+
* @version 153.0.0
|
|
16756
16801
|
*/
|
|
16757
16802
|
|
|
16758
16803
|
/**
|
|
@@ -16923,7 +16968,7 @@ class FlowsApi {
|
|
|
16923
16968
|
/**
|
|
16924
16969
|
* Flows service.
|
|
16925
16970
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16926
|
-
* @version
|
|
16971
|
+
* @version 153.0.0
|
|
16927
16972
|
*/
|
|
16928
16973
|
|
|
16929
16974
|
/**
|
|
@@ -16994,7 +17039,7 @@ class GamificationApi {
|
|
|
16994
17039
|
/**
|
|
16995
17040
|
* Gamification service.
|
|
16996
17041
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16997
|
-
* @version
|
|
17042
|
+
* @version 153.0.0
|
|
16998
17043
|
*/
|
|
16999
17044
|
|
|
17000
17045
|
/**
|
|
@@ -18611,7 +18656,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18611
18656
|
/**
|
|
18612
18657
|
* GeneralDataProtectionRegulation service.
|
|
18613
18658
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18614
|
-
* @version
|
|
18659
|
+
* @version 153.0.0
|
|
18615
18660
|
*/
|
|
18616
18661
|
|
|
18617
18662
|
/**
|
|
@@ -18741,7 +18786,7 @@ class GeolocationApi {
|
|
|
18741
18786
|
/**
|
|
18742
18787
|
* Geolocation service.
|
|
18743
18788
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18744
|
-
* @version
|
|
18789
|
+
* @version 153.0.0
|
|
18745
18790
|
*/
|
|
18746
18791
|
|
|
18747
18792
|
/**
|
|
@@ -18872,7 +18917,7 @@ class GreetingsApi {
|
|
|
18872
18917
|
/**
|
|
18873
18918
|
* Greetings service.
|
|
18874
18919
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18875
|
-
* @version
|
|
18920
|
+
* @version 153.0.0
|
|
18876
18921
|
*/
|
|
18877
18922
|
|
|
18878
18923
|
/**
|
|
@@ -19327,7 +19372,7 @@ class GroupsApi {
|
|
|
19327
19372
|
/**
|
|
19328
19373
|
* Groups service.
|
|
19329
19374
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19330
|
-
* @version
|
|
19375
|
+
* @version 153.0.0
|
|
19331
19376
|
*/
|
|
19332
19377
|
|
|
19333
19378
|
/**
|
|
@@ -19733,7 +19778,7 @@ class IdentityProviderApi {
|
|
|
19733
19778
|
/**
|
|
19734
19779
|
* IdentityProvider service.
|
|
19735
19780
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19736
|
-
* @version
|
|
19781
|
+
* @version 153.0.0
|
|
19737
19782
|
*/
|
|
19738
19783
|
|
|
19739
19784
|
/**
|
|
@@ -20489,7 +20534,7 @@ class IntegrationsApi {
|
|
|
20489
20534
|
/**
|
|
20490
20535
|
* Integrations service.
|
|
20491
20536
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20492
|
-
* @version
|
|
20537
|
+
* @version 153.0.0
|
|
20493
20538
|
*/
|
|
20494
20539
|
|
|
20495
20540
|
/**
|
|
@@ -22089,7 +22134,7 @@ class JourneyApi {
|
|
|
22089
22134
|
/**
|
|
22090
22135
|
* Journey service.
|
|
22091
22136
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22092
|
-
* @version
|
|
22137
|
+
* @version 153.0.0
|
|
22093
22138
|
*/
|
|
22094
22139
|
|
|
22095
22140
|
/**
|
|
@@ -22875,7 +22920,7 @@ class KnowledgeApi {
|
|
|
22875
22920
|
/**
|
|
22876
22921
|
* Knowledge service.
|
|
22877
22922
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22878
|
-
* @version
|
|
22923
|
+
* @version 153.0.0
|
|
22879
22924
|
*/
|
|
22880
22925
|
|
|
22881
22926
|
/**
|
|
@@ -25308,7 +25353,7 @@ class LanguageUnderstandingApi {
|
|
|
25308
25353
|
/**
|
|
25309
25354
|
* LanguageUnderstanding service.
|
|
25310
25355
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25311
|
-
* @version
|
|
25356
|
+
* @version 153.0.0
|
|
25312
25357
|
*/
|
|
25313
25358
|
|
|
25314
25359
|
/**
|
|
@@ -26212,7 +26257,7 @@ class LanguagesApi {
|
|
|
26212
26257
|
/**
|
|
26213
26258
|
* Languages service.
|
|
26214
26259
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26215
|
-
* @version
|
|
26260
|
+
* @version 153.0.0
|
|
26216
26261
|
*/
|
|
26217
26262
|
|
|
26218
26263
|
/**
|
|
@@ -26480,7 +26525,7 @@ class LearningApi {
|
|
|
26480
26525
|
/**
|
|
26481
26526
|
* Learning service.
|
|
26482
26527
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26483
|
-
* @version
|
|
26528
|
+
* @version 153.0.0
|
|
26484
26529
|
*/
|
|
26485
26530
|
|
|
26486
26531
|
/**
|
|
@@ -27240,7 +27285,7 @@ class LicenseApi {
|
|
|
27240
27285
|
/**
|
|
27241
27286
|
* License service.
|
|
27242
27287
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27243
|
-
* @version
|
|
27288
|
+
* @version 153.0.0
|
|
27244
27289
|
*/
|
|
27245
27290
|
|
|
27246
27291
|
/**
|
|
@@ -27478,7 +27523,7 @@ class LocationsApi {
|
|
|
27478
27523
|
/**
|
|
27479
27524
|
* Locations service.
|
|
27480
27525
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27481
|
-
* @version
|
|
27526
|
+
* @version 153.0.0
|
|
27482
27527
|
*/
|
|
27483
27528
|
|
|
27484
27529
|
/**
|
|
@@ -27714,7 +27759,7 @@ class MessagingApi {
|
|
|
27714
27759
|
/**
|
|
27715
27760
|
* Messaging service.
|
|
27716
27761
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27717
|
-
* @version
|
|
27762
|
+
* @version 153.0.0
|
|
27718
27763
|
*/
|
|
27719
27764
|
|
|
27720
27765
|
/**
|
|
@@ -27865,7 +27910,7 @@ class MobileDevicesApi {
|
|
|
27865
27910
|
/**
|
|
27866
27911
|
* MobileDevices service.
|
|
27867
27912
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27868
|
-
* @version
|
|
27913
|
+
* @version 153.0.0
|
|
27869
27914
|
*/
|
|
27870
27915
|
|
|
27871
27916
|
/**
|
|
@@ -28016,7 +28061,7 @@ class NotificationsApi {
|
|
|
28016
28061
|
/**
|
|
28017
28062
|
* Notifications service.
|
|
28018
28063
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28019
|
-
* @version
|
|
28064
|
+
* @version 153.0.0
|
|
28020
28065
|
*/
|
|
28021
28066
|
|
|
28022
28067
|
/**
|
|
@@ -28241,7 +28286,7 @@ class OAuthApi {
|
|
|
28241
28286
|
/**
|
|
28242
28287
|
* OAuth service.
|
|
28243
28288
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28244
|
-
* @version
|
|
28289
|
+
* @version 153.0.0
|
|
28245
28290
|
*/
|
|
28246
28291
|
|
|
28247
28292
|
/**
|
|
@@ -28607,7 +28652,7 @@ class ObjectsApi {
|
|
|
28607
28652
|
/**
|
|
28608
28653
|
* Objects service.
|
|
28609
28654
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28610
|
-
* @version
|
|
28655
|
+
* @version 153.0.0
|
|
28611
28656
|
*/
|
|
28612
28657
|
|
|
28613
28658
|
/**
|
|
@@ -28878,7 +28923,7 @@ class OrganizationApi {
|
|
|
28878
28923
|
/**
|
|
28879
28924
|
* Organization service.
|
|
28880
28925
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28881
|
-
* @version
|
|
28926
|
+
* @version 153.0.0
|
|
28882
28927
|
*/
|
|
28883
28928
|
|
|
28884
28929
|
/**
|
|
@@ -29281,7 +29326,7 @@ class OrganizationAuthorizationApi {
|
|
|
29281
29326
|
/**
|
|
29282
29327
|
* OrganizationAuthorization service.
|
|
29283
29328
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29284
|
-
* @version
|
|
29329
|
+
* @version 153.0.0
|
|
29285
29330
|
*/
|
|
29286
29331
|
|
|
29287
29332
|
/**
|
|
@@ -30206,7 +30251,7 @@ class OutboundApi {
|
|
|
30206
30251
|
/**
|
|
30207
30252
|
* Outbound service.
|
|
30208
30253
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30209
|
-
* @version
|
|
30254
|
+
* @version 153.0.0
|
|
30210
30255
|
*/
|
|
30211
30256
|
|
|
30212
30257
|
/**
|
|
@@ -33595,7 +33640,7 @@ class PresenceApi {
|
|
|
33595
33640
|
/**
|
|
33596
33641
|
* Presence service.
|
|
33597
33642
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33598
|
-
* @version
|
|
33643
|
+
* @version 153.0.0
|
|
33599
33644
|
*/
|
|
33600
33645
|
|
|
33601
33646
|
/**
|
|
@@ -34101,7 +34146,7 @@ class ProcessAutomationApi {
|
|
|
34101
34146
|
/**
|
|
34102
34147
|
* ProcessAutomation service.
|
|
34103
34148
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34104
|
-
* @version
|
|
34149
|
+
* @version 153.0.0
|
|
34105
34150
|
*/
|
|
34106
34151
|
|
|
34107
34152
|
/**
|
|
@@ -34339,7 +34384,7 @@ class QualityApi {
|
|
|
34339
34384
|
/**
|
|
34340
34385
|
* Quality service.
|
|
34341
34386
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34342
|
-
* @version
|
|
34387
|
+
* @version 153.0.0
|
|
34343
34388
|
*/
|
|
34344
34389
|
|
|
34345
34390
|
/**
|
|
@@ -35917,7 +35962,7 @@ class RecordingApi {
|
|
|
35917
35962
|
/**
|
|
35918
35963
|
* Recording service.
|
|
35919
35964
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35920
|
-
* @version
|
|
35965
|
+
* @version 153.0.0
|
|
35921
35966
|
*/
|
|
35922
35967
|
|
|
35923
35968
|
/**
|
|
@@ -37604,7 +37649,7 @@ class ResponseManagementApi {
|
|
|
37604
37649
|
/**
|
|
37605
37650
|
* ResponseManagement service.
|
|
37606
37651
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37607
|
-
* @version
|
|
37652
|
+
* @version 153.0.0
|
|
37608
37653
|
*/
|
|
37609
37654
|
|
|
37610
37655
|
/**
|
|
@@ -38088,7 +38133,7 @@ class RoutingApi {
|
|
|
38088
38133
|
/**
|
|
38089
38134
|
* Routing service.
|
|
38090
38135
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38091
|
-
* @version
|
|
38136
|
+
* @version 153.0.0
|
|
38092
38137
|
*/
|
|
38093
38138
|
|
|
38094
38139
|
/**
|
|
@@ -38814,6 +38859,8 @@ class RoutingApi {
|
|
|
38814
38859
|
* Get domains
|
|
38815
38860
|
*
|
|
38816
38861
|
* @param {Object} opts Optional parameters
|
|
38862
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38863
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38817
38864
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
38818
38865
|
*/
|
|
38819
38866
|
getRoutingEmailDomains(opts) {
|
|
@@ -38824,7 +38871,7 @@ class RoutingApi {
|
|
|
38824
38871
|
'/api/v2/routing/email/domains',
|
|
38825
38872
|
'GET',
|
|
38826
38873
|
{ },
|
|
38827
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
38874
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
38828
38875
|
{ },
|
|
38829
38876
|
{ },
|
|
38830
38877
|
null,
|
|
@@ -41501,7 +41548,7 @@ class SCIMApi {
|
|
|
41501
41548
|
/**
|
|
41502
41549
|
* SCIM service.
|
|
41503
41550
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41504
|
-
* @version
|
|
41551
|
+
* @version 153.0.0
|
|
41505
41552
|
*/
|
|
41506
41553
|
|
|
41507
41554
|
/**
|
|
@@ -42378,7 +42425,7 @@ class ScriptsApi {
|
|
|
42378
42425
|
/**
|
|
42379
42426
|
* Scripts service.
|
|
42380
42427
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42381
|
-
* @version
|
|
42428
|
+
* @version 153.0.0
|
|
42382
42429
|
*/
|
|
42383
42430
|
|
|
42384
42431
|
/**
|
|
@@ -42797,7 +42844,7 @@ class SearchApi {
|
|
|
42797
42844
|
/**
|
|
42798
42845
|
* Search service.
|
|
42799
42846
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42800
|
-
* @version
|
|
42847
|
+
* @version 153.0.0
|
|
42801
42848
|
*/
|
|
42802
42849
|
|
|
42803
42850
|
/**
|
|
@@ -43382,7 +43429,7 @@ class SpeechTextAnalyticsApi {
|
|
|
43382
43429
|
/**
|
|
43383
43430
|
* SpeechTextAnalytics service.
|
|
43384
43431
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43385
|
-
* @version
|
|
43432
|
+
* @version 153.0.0
|
|
43386
43433
|
*/
|
|
43387
43434
|
|
|
43388
43435
|
/**
|
|
@@ -44236,7 +44283,7 @@ class StationsApi {
|
|
|
44236
44283
|
/**
|
|
44237
44284
|
* Stations service.
|
|
44238
44285
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44239
|
-
* @version
|
|
44286
|
+
* @version 153.0.0
|
|
44240
44287
|
*/
|
|
44241
44288
|
|
|
44242
44289
|
/**
|
|
@@ -44383,7 +44430,7 @@ class SuggestApi {
|
|
|
44383
44430
|
/**
|
|
44384
44431
|
* Suggest service.
|
|
44385
44432
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44386
|
-
* @version
|
|
44433
|
+
* @version 153.0.0
|
|
44387
44434
|
*/
|
|
44388
44435
|
|
|
44389
44436
|
/**
|
|
@@ -44522,7 +44569,7 @@ class TeamsApi {
|
|
|
44522
44569
|
/**
|
|
44523
44570
|
* Teams service.
|
|
44524
44571
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44525
|
-
* @version
|
|
44572
|
+
* @version 153.0.0
|
|
44526
44573
|
*/
|
|
44527
44574
|
|
|
44528
44575
|
/**
|
|
@@ -44793,7 +44840,7 @@ class TelephonyApi {
|
|
|
44793
44840
|
/**
|
|
44794
44841
|
* Telephony service.
|
|
44795
44842
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44796
|
-
* @version
|
|
44843
|
+
* @version 153.0.0
|
|
44797
44844
|
*/
|
|
44798
44845
|
|
|
44799
44846
|
/**
|
|
@@ -44901,7 +44948,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
44901
44948
|
/**
|
|
44902
44949
|
* TelephonyProvidersEdge service.
|
|
44903
44950
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44904
|
-
* @version
|
|
44951
|
+
* @version 153.0.0
|
|
44905
44952
|
*/
|
|
44906
44953
|
|
|
44907
44954
|
/**
|
|
@@ -48534,7 +48581,7 @@ class TextbotsApi {
|
|
|
48534
48581
|
/**
|
|
48535
48582
|
* Textbots service.
|
|
48536
48583
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48537
|
-
* @version
|
|
48584
|
+
* @version 153.0.0
|
|
48538
48585
|
*/
|
|
48539
48586
|
|
|
48540
48587
|
/**
|
|
@@ -48662,7 +48709,7 @@ class TokensApi {
|
|
|
48662
48709
|
/**
|
|
48663
48710
|
* Tokens service.
|
|
48664
48711
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48665
|
-
* @version
|
|
48712
|
+
* @version 153.0.0
|
|
48666
48713
|
*/
|
|
48667
48714
|
|
|
48668
48715
|
/**
|
|
@@ -48768,7 +48815,7 @@ class UploadsApi {
|
|
|
48768
48815
|
/**
|
|
48769
48816
|
* Uploads service.
|
|
48770
48817
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48771
|
-
* @version
|
|
48818
|
+
* @version 153.0.0
|
|
48772
48819
|
*/
|
|
48773
48820
|
|
|
48774
48821
|
/**
|
|
@@ -48944,7 +48991,7 @@ class UsageApi {
|
|
|
48944
48991
|
/**
|
|
48945
48992
|
* Usage service.
|
|
48946
48993
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48947
|
-
* @version
|
|
48994
|
+
* @version 153.0.0
|
|
48948
48995
|
*/
|
|
48949
48996
|
|
|
48950
48997
|
/**
|
|
@@ -49015,7 +49062,7 @@ class UserRecordingsApi {
|
|
|
49015
49062
|
/**
|
|
49016
49063
|
* UserRecordings service.
|
|
49017
49064
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49018
|
-
* @version
|
|
49065
|
+
* @version 153.0.0
|
|
49019
49066
|
*/
|
|
49020
49067
|
|
|
49021
49068
|
/**
|
|
@@ -49200,7 +49247,7 @@ class UsersApi {
|
|
|
49200
49247
|
/**
|
|
49201
49248
|
* Users service.
|
|
49202
49249
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49203
|
-
* @version
|
|
49250
|
+
* @version 153.0.0
|
|
49204
49251
|
*/
|
|
49205
49252
|
|
|
49206
49253
|
/**
|
|
@@ -51557,7 +51604,7 @@ class UtilitiesApi {
|
|
|
51557
51604
|
/**
|
|
51558
51605
|
* Utilities service.
|
|
51559
51606
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51560
|
-
* @version
|
|
51607
|
+
* @version 153.0.0
|
|
51561
51608
|
*/
|
|
51562
51609
|
|
|
51563
51610
|
/**
|
|
@@ -51668,7 +51715,7 @@ class VoicemailApi {
|
|
|
51668
51715
|
/**
|
|
51669
51716
|
* Voicemail service.
|
|
51670
51717
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51671
|
-
* @version
|
|
51718
|
+
* @version 153.0.0
|
|
51672
51719
|
*/
|
|
51673
51720
|
|
|
51674
51721
|
/**
|
|
@@ -52335,7 +52382,7 @@ class WebChatApi {
|
|
|
52335
52382
|
/**
|
|
52336
52383
|
* WebChat service.
|
|
52337
52384
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52338
|
-
* @version
|
|
52385
|
+
* @version 153.0.0
|
|
52339
52386
|
*/
|
|
52340
52387
|
|
|
52341
52388
|
/**
|
|
@@ -52879,7 +52926,7 @@ class WebDeploymentsApi {
|
|
|
52879
52926
|
/**
|
|
52880
52927
|
* WebDeployments service.
|
|
52881
52928
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52882
|
-
* @version
|
|
52929
|
+
* @version 153.0.0
|
|
52883
52930
|
*/
|
|
52884
52931
|
|
|
52885
52932
|
/**
|
|
@@ -53267,7 +53314,7 @@ class WebMessagingApi {
|
|
|
53267
53314
|
/**
|
|
53268
53315
|
* WebMessaging service.
|
|
53269
53316
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53270
|
-
* @version
|
|
53317
|
+
* @version 153.0.0
|
|
53271
53318
|
*/
|
|
53272
53319
|
|
|
53273
53320
|
/**
|
|
@@ -53313,7 +53360,7 @@ class WidgetsApi {
|
|
|
53313
53360
|
/**
|
|
53314
53361
|
* Widgets service.
|
|
53315
53362
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53316
|
-
* @version
|
|
53363
|
+
* @version 153.0.0
|
|
53317
53364
|
*/
|
|
53318
53365
|
|
|
53319
53366
|
/**
|
|
@@ -53459,7 +53506,7 @@ class WorkforceManagementApi {
|
|
|
53459
53506
|
/**
|
|
53460
53507
|
* WorkforceManagement service.
|
|
53461
53508
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53462
|
-
* @version
|
|
53509
|
+
* @version 153.0.0
|
|
53463
53510
|
*/
|
|
53464
53511
|
|
|
53465
53512
|
/**
|
|
@@ -53879,6 +53926,56 @@ class WorkforceManagementApi {
|
|
|
53879
53926
|
);
|
|
53880
53927
|
}
|
|
53881
53928
|
|
|
53929
|
+
/**
|
|
53930
|
+
* Get an adherence explanation for the current user
|
|
53931
|
+
*
|
|
53932
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
53933
|
+
*/
|
|
53934
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
53935
|
+
// verify the required parameter 'explanationId' is set
|
|
53936
|
+
if (explanationId === undefined || explanationId === null) {
|
|
53937
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
53938
|
+
}
|
|
53939
|
+
|
|
53940
|
+
return this.apiClient.callApi(
|
|
53941
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
53942
|
+
'GET',
|
|
53943
|
+
{ 'explanationId': explanationId },
|
|
53944
|
+
{ },
|
|
53945
|
+
{ },
|
|
53946
|
+
{ },
|
|
53947
|
+
null,
|
|
53948
|
+
['PureCloud OAuth'],
|
|
53949
|
+
['application/json'],
|
|
53950
|
+
['application/json']
|
|
53951
|
+
);
|
|
53952
|
+
}
|
|
53953
|
+
|
|
53954
|
+
/**
|
|
53955
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
53956
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
53957
|
+
* @param {String} jobId The ID of the job
|
|
53958
|
+
*/
|
|
53959
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
53960
|
+
// verify the required parameter 'jobId' is set
|
|
53961
|
+
if (jobId === undefined || jobId === null) {
|
|
53962
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
53963
|
+
}
|
|
53964
|
+
|
|
53965
|
+
return this.apiClient.callApi(
|
|
53966
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
53967
|
+
'GET',
|
|
53968
|
+
{ 'jobId': jobId },
|
|
53969
|
+
{ },
|
|
53970
|
+
{ },
|
|
53971
|
+
{ },
|
|
53972
|
+
null,
|
|
53973
|
+
['PureCloud OAuth'],
|
|
53974
|
+
['application/json'],
|
|
53975
|
+
['application/json']
|
|
53976
|
+
);
|
|
53977
|
+
}
|
|
53978
|
+
|
|
53882
53979
|
/**
|
|
53883
53980
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
53884
53981
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -53929,6 +54026,36 @@ class WorkforceManagementApi {
|
|
|
53929
54026
|
);
|
|
53930
54027
|
}
|
|
53931
54028
|
|
|
54029
|
+
/**
|
|
54030
|
+
* Get an adherence explanation
|
|
54031
|
+
*
|
|
54032
|
+
* @param {String} agentId The ID of the agent to query
|
|
54033
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
54034
|
+
*/
|
|
54035
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
54036
|
+
// verify the required parameter 'agentId' is set
|
|
54037
|
+
if (agentId === undefined || agentId === null) {
|
|
54038
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54039
|
+
}
|
|
54040
|
+
// verify the required parameter 'explanationId' is set
|
|
54041
|
+
if (explanationId === undefined || explanationId === null) {
|
|
54042
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54043
|
+
}
|
|
54044
|
+
|
|
54045
|
+
return this.apiClient.callApi(
|
|
54046
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
54047
|
+
'GET',
|
|
54048
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
54049
|
+
{ },
|
|
54050
|
+
{ },
|
|
54051
|
+
{ },
|
|
54052
|
+
null,
|
|
54053
|
+
['PureCloud OAuth'],
|
|
54054
|
+
['application/json'],
|
|
54055
|
+
['application/json']
|
|
54056
|
+
);
|
|
54057
|
+
}
|
|
54058
|
+
|
|
53932
54059
|
/**
|
|
53933
54060
|
* Get the management unit to which the agent belongs
|
|
53934
54061
|
*
|
|
@@ -55648,6 +55775,31 @@ class WorkforceManagementApi {
|
|
|
55648
55775
|
);
|
|
55649
55776
|
}
|
|
55650
55777
|
|
|
55778
|
+
/**
|
|
55779
|
+
* Request to fetch the status of the historical shrinkage query
|
|
55780
|
+
*
|
|
55781
|
+
* @param {String} jobId jobId
|
|
55782
|
+
*/
|
|
55783
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
55784
|
+
// verify the required parameter 'jobId' is set
|
|
55785
|
+
if (jobId === undefined || jobId === null) {
|
|
55786
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
55787
|
+
}
|
|
55788
|
+
|
|
55789
|
+
return this.apiClient.callApi(
|
|
55790
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
55791
|
+
'GET',
|
|
55792
|
+
{ 'jobId': jobId },
|
|
55793
|
+
{ },
|
|
55794
|
+
{ },
|
|
55795
|
+
{ },
|
|
55796
|
+
null,
|
|
55797
|
+
['PureCloud OAuth'],
|
|
55798
|
+
['application/json'],
|
|
55799
|
+
['application/json']
|
|
55800
|
+
);
|
|
55801
|
+
}
|
|
55802
|
+
|
|
55651
55803
|
/**
|
|
55652
55804
|
* Get a time off request for the current user
|
|
55653
55805
|
*
|
|
@@ -55722,6 +55874,41 @@ class WorkforceManagementApi {
|
|
|
55722
55874
|
);
|
|
55723
55875
|
}
|
|
55724
55876
|
|
|
55877
|
+
/**
|
|
55878
|
+
* Update an adherence explanation
|
|
55879
|
+
*
|
|
55880
|
+
* @param {String} agentId The ID of the agent to query
|
|
55881
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55882
|
+
* @param {Object} body The request body
|
|
55883
|
+
*/
|
|
55884
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
55885
|
+
// verify the required parameter 'agentId' is set
|
|
55886
|
+
if (agentId === undefined || agentId === null) {
|
|
55887
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55888
|
+
}
|
|
55889
|
+
// verify the required parameter 'explanationId' is set
|
|
55890
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55891
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55892
|
+
}
|
|
55893
|
+
// verify the required parameter 'body' is set
|
|
55894
|
+
if (body === undefined || body === null) {
|
|
55895
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55896
|
+
}
|
|
55897
|
+
|
|
55898
|
+
return this.apiClient.callApi(
|
|
55899
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
55900
|
+
'PATCH',
|
|
55901
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
55902
|
+
{ },
|
|
55903
|
+
{ },
|
|
55904
|
+
{ },
|
|
55905
|
+
body,
|
|
55906
|
+
['PureCloud OAuth'],
|
|
55907
|
+
['application/json'],
|
|
55908
|
+
['application/json']
|
|
55909
|
+
);
|
|
55910
|
+
}
|
|
55911
|
+
|
|
55725
55912
|
/**
|
|
55726
55913
|
* Update business unit
|
|
55727
55914
|
*
|
|
@@ -56161,6 +56348,61 @@ class WorkforceManagementApi {
|
|
|
56161
56348
|
);
|
|
56162
56349
|
}
|
|
56163
56350
|
|
|
56351
|
+
/**
|
|
56352
|
+
* Submit an adherence explanation for the current user
|
|
56353
|
+
*
|
|
56354
|
+
* @param {Object} body The request body
|
|
56355
|
+
*/
|
|
56356
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
56357
|
+
// verify the required parameter 'body' is set
|
|
56358
|
+
if (body === undefined || body === null) {
|
|
56359
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
56360
|
+
}
|
|
56361
|
+
|
|
56362
|
+
return this.apiClient.callApi(
|
|
56363
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
56364
|
+
'POST',
|
|
56365
|
+
{ },
|
|
56366
|
+
{ },
|
|
56367
|
+
{ },
|
|
56368
|
+
{ },
|
|
56369
|
+
body,
|
|
56370
|
+
['PureCloud OAuth'],
|
|
56371
|
+
['application/json'],
|
|
56372
|
+
['application/json']
|
|
56373
|
+
);
|
|
56374
|
+
}
|
|
56375
|
+
|
|
56376
|
+
/**
|
|
56377
|
+
* Query adherence explanations for the current user
|
|
56378
|
+
*
|
|
56379
|
+
* @param {Object} body The request body
|
|
56380
|
+
* @param {Object} opts Optional parameters
|
|
56381
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56382
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56383
|
+
*/
|
|
56384
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
56385
|
+
opts = opts || {};
|
|
56386
|
+
|
|
56387
|
+
// verify the required parameter 'body' is set
|
|
56388
|
+
if (body === undefined || body === null) {
|
|
56389
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
56390
|
+
}
|
|
56391
|
+
|
|
56392
|
+
return this.apiClient.callApi(
|
|
56393
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
56394
|
+
'POST',
|
|
56395
|
+
{ },
|
|
56396
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56397
|
+
{ },
|
|
56398
|
+
{ },
|
|
56399
|
+
body,
|
|
56400
|
+
['PureCloud OAuth'],
|
|
56401
|
+
['application/json'],
|
|
56402
|
+
['application/json']
|
|
56403
|
+
);
|
|
56404
|
+
}
|
|
56405
|
+
|
|
56164
56406
|
/**
|
|
56165
56407
|
* Request a historical adherence report for users across management units
|
|
56166
56408
|
*
|
|
@@ -56185,6 +56427,71 @@ class WorkforceManagementApi {
|
|
|
56185
56427
|
);
|
|
56186
56428
|
}
|
|
56187
56429
|
|
|
56430
|
+
/**
|
|
56431
|
+
* Add an adherence explanation for the requested user
|
|
56432
|
+
*
|
|
56433
|
+
* @param {String} agentId The ID of the agent to query
|
|
56434
|
+
* @param {Object} body The request body
|
|
56435
|
+
*/
|
|
56436
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
56437
|
+
// verify the required parameter 'agentId' is set
|
|
56438
|
+
if (agentId === undefined || agentId === null) {
|
|
56439
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56440
|
+
}
|
|
56441
|
+
// verify the required parameter 'body' is set
|
|
56442
|
+
if (body === undefined || body === null) {
|
|
56443
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56444
|
+
}
|
|
56445
|
+
|
|
56446
|
+
return this.apiClient.callApi(
|
|
56447
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
56448
|
+
'POST',
|
|
56449
|
+
{ 'agentId': agentId },
|
|
56450
|
+
{ },
|
|
56451
|
+
{ },
|
|
56452
|
+
{ },
|
|
56453
|
+
body,
|
|
56454
|
+
['PureCloud OAuth'],
|
|
56455
|
+
['application/json'],
|
|
56456
|
+
['application/json']
|
|
56457
|
+
);
|
|
56458
|
+
}
|
|
56459
|
+
|
|
56460
|
+
/**
|
|
56461
|
+
* Query adherence explanations for the given agent across a specified range
|
|
56462
|
+
*
|
|
56463
|
+
* @param {String} agentId The ID of the agent to query
|
|
56464
|
+
* @param {Object} body The request body
|
|
56465
|
+
* @param {Object} opts Optional parameters
|
|
56466
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56467
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56468
|
+
*/
|
|
56469
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
56470
|
+
opts = opts || {};
|
|
56471
|
+
|
|
56472
|
+
// verify the required parameter 'agentId' is set
|
|
56473
|
+
if (agentId === undefined || agentId === null) {
|
|
56474
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56475
|
+
}
|
|
56476
|
+
// verify the required parameter 'body' is set
|
|
56477
|
+
if (body === undefined || body === null) {
|
|
56478
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56479
|
+
}
|
|
56480
|
+
|
|
56481
|
+
return this.apiClient.callApi(
|
|
56482
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
56483
|
+
'POST',
|
|
56484
|
+
{ 'agentId': agentId },
|
|
56485
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56486
|
+
{ },
|
|
56487
|
+
{ },
|
|
56488
|
+
body,
|
|
56489
|
+
['PureCloud OAuth'],
|
|
56490
|
+
['application/json'],
|
|
56491
|
+
['application/json']
|
|
56492
|
+
);
|
|
56493
|
+
}
|
|
56494
|
+
|
|
56188
56495
|
/**
|
|
56189
56496
|
* Get published schedule for the current user
|
|
56190
56497
|
*
|
|
@@ -56238,6 +56545,41 @@ class WorkforceManagementApi {
|
|
|
56238
56545
|
);
|
|
56239
56546
|
}
|
|
56240
56547
|
|
|
56548
|
+
/**
|
|
56549
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
56550
|
+
*
|
|
56551
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
56552
|
+
* @param {Object} body The request body
|
|
56553
|
+
* @param {Object} opts Optional parameters
|
|
56554
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56555
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56556
|
+
*/
|
|
56557
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
56558
|
+
opts = opts || {};
|
|
56559
|
+
|
|
56560
|
+
// verify the required parameter 'businessUnitId' is set
|
|
56561
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
56562
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56563
|
+
}
|
|
56564
|
+
// verify the required parameter 'body' is set
|
|
56565
|
+
if (body === undefined || body === null) {
|
|
56566
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56567
|
+
}
|
|
56568
|
+
|
|
56569
|
+
return this.apiClient.callApi(
|
|
56570
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
56571
|
+
'POST',
|
|
56572
|
+
{ 'businessUnitId': businessUnitId },
|
|
56573
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56574
|
+
{ },
|
|
56575
|
+
{ },
|
|
56576
|
+
body,
|
|
56577
|
+
['PureCloud OAuth'],
|
|
56578
|
+
['application/json'],
|
|
56579
|
+
['application/json']
|
|
56580
|
+
);
|
|
56581
|
+
}
|
|
56582
|
+
|
|
56241
56583
|
/**
|
|
56242
56584
|
* Search published schedules
|
|
56243
56585
|
*
|
|
@@ -57065,6 +57407,35 @@ class WorkforceManagementApi {
|
|
|
57065
57407
|
);
|
|
57066
57408
|
}
|
|
57067
57409
|
|
|
57410
|
+
/**
|
|
57411
|
+
* Request a historical shrinkage report
|
|
57412
|
+
* 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.
|
|
57413
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57414
|
+
* @param {Object} opts Optional parameters
|
|
57415
|
+
* @param {Object} opts.body body
|
|
57416
|
+
*/
|
|
57417
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
57418
|
+
opts = opts || {};
|
|
57419
|
+
|
|
57420
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57421
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57422
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
57423
|
+
}
|
|
57424
|
+
|
|
57425
|
+
return this.apiClient.callApi(
|
|
57426
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
57427
|
+
'POST',
|
|
57428
|
+
{ 'managementUnitId': managementUnitId },
|
|
57429
|
+
{ },
|
|
57430
|
+
{ },
|
|
57431
|
+
{ },
|
|
57432
|
+
opts['body'],
|
|
57433
|
+
['PureCloud OAuth'],
|
|
57434
|
+
['application/json'],
|
|
57435
|
+
['application/json']
|
|
57436
|
+
);
|
|
57437
|
+
}
|
|
57438
|
+
|
|
57068
57439
|
/**
|
|
57069
57440
|
* Creates a new time off limit object under management unit.
|
|
57070
57441
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -57805,7 +58176,7 @@ class WorkforceManagementApi {
|
|
|
57805
58176
|
* </pre>
|
|
57806
58177
|
* </p>
|
|
57807
58178
|
* @module purecloud-platform-client-v2/index
|
|
57808
|
-
* @version
|
|
58179
|
+
* @version 153.0.0
|
|
57809
58180
|
*/
|
|
57810
58181
|
class platformClient {
|
|
57811
58182
|
constructor() {
|