purecloud-platform-client-v2 189.1.0 → 190.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 +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.js +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +300 -112
- package/dist/web-cjs/purecloud-platform-client-v2.js +301 -115
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +822 -453
- 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 +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +86 -20
- 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 +13 -8
- 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/EmailsApi.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/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +207 -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/LogCaptureApi.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/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +2 -2
- 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 +22 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -7
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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/SettingsApi.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/TaskManagementApi.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 +516 -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 190.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1821,7 +1821,7 @@ class AlertingApi {
|
|
|
1821
1821
|
/**
|
|
1822
1822
|
* Alerting service.
|
|
1823
1823
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1824
|
-
* @version
|
|
1824
|
+
* @version 190.0.0
|
|
1825
1825
|
*/
|
|
1826
1826
|
|
|
1827
1827
|
/**
|
|
@@ -2482,7 +2482,7 @@ class AnalyticsApi {
|
|
|
2482
2482
|
/**
|
|
2483
2483
|
* Analytics service.
|
|
2484
2484
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2485
|
-
* @version
|
|
2485
|
+
* @version 190.0.0
|
|
2486
2486
|
*/
|
|
2487
2487
|
|
|
2488
2488
|
/**
|
|
@@ -5095,7 +5095,7 @@ class ArchitectApi {
|
|
|
5095
5095
|
/**
|
|
5096
5096
|
* Architect service.
|
|
5097
5097
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5098
|
-
* @version
|
|
5098
|
+
* @version 190.0.0
|
|
5099
5099
|
*/
|
|
5100
5100
|
|
|
5101
5101
|
/**
|
|
@@ -9241,7 +9241,7 @@ class AuditApi {
|
|
|
9241
9241
|
/**
|
|
9242
9242
|
* Audit service.
|
|
9243
9243
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9244
|
-
* @version
|
|
9244
|
+
* @version 190.0.0
|
|
9245
9245
|
*/
|
|
9246
9246
|
|
|
9247
9247
|
/**
|
|
@@ -9412,7 +9412,7 @@ class AuthorizationApi {
|
|
|
9412
9412
|
/**
|
|
9413
9413
|
* Authorization service.
|
|
9414
9414
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9415
|
-
* @version
|
|
9415
|
+
* @version 190.0.0
|
|
9416
9416
|
*/
|
|
9417
9417
|
|
|
9418
9418
|
/**
|
|
@@ -10642,7 +10642,7 @@ class BillingApi {
|
|
|
10642
10642
|
/**
|
|
10643
10643
|
* Billing service.
|
|
10644
10644
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10645
|
-
* @version
|
|
10645
|
+
* @version 190.0.0
|
|
10646
10646
|
*/
|
|
10647
10647
|
|
|
10648
10648
|
/**
|
|
@@ -10722,7 +10722,7 @@ class CarrierServicesApi {
|
|
|
10722
10722
|
/**
|
|
10723
10723
|
* CarrierServices service.
|
|
10724
10724
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10725
|
-
* @version
|
|
10725
|
+
* @version 190.0.0
|
|
10726
10726
|
*/
|
|
10727
10727
|
|
|
10728
10728
|
/**
|
|
@@ -10792,7 +10792,7 @@ class ChatApi {
|
|
|
10792
10792
|
/**
|
|
10793
10793
|
* Chat service.
|
|
10794
10794
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10795
|
-
* @version
|
|
10795
|
+
* @version 190.0.0
|
|
10796
10796
|
*/
|
|
10797
10797
|
|
|
10798
10798
|
/**
|
|
@@ -10812,7 +10812,6 @@ class ChatApi {
|
|
|
10812
10812
|
*
|
|
10813
10813
|
* @param {String} roomJid roomId
|
|
10814
10814
|
* @param {String} messageId messageId
|
|
10815
|
-
* deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10816
10815
|
*/
|
|
10817
10816
|
deleteChatsRoomMessage(roomJid, messageId) {
|
|
10818
10817
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10843,7 +10842,6 @@ class ChatApi {
|
|
|
10843
10842
|
*
|
|
10844
10843
|
* @param {String} roomJid roomJid
|
|
10845
10844
|
* @param {String} userId userId
|
|
10846
|
-
* deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10847
10845
|
*/
|
|
10848
10846
|
deleteChatsRoomParticipant(roomJid, userId) {
|
|
10849
10847
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10874,7 +10872,6 @@ class ChatApi {
|
|
|
10874
10872
|
*
|
|
10875
10873
|
* @param {String} roomJid roomJid
|
|
10876
10874
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
10877
|
-
* deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10878
10875
|
*/
|
|
10879
10876
|
deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) {
|
|
10880
10877
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10905,7 +10902,6 @@ class ChatApi {
|
|
|
10905
10902
|
*
|
|
10906
10903
|
* @param {String} userId userId
|
|
10907
10904
|
* @param {String} messageId messageId
|
|
10908
|
-
* deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10909
10905
|
*/
|
|
10910
10906
|
deleteChatsUserMessage(userId, messageId) {
|
|
10911
10907
|
// verify the required parameter 'userId' is set
|
|
@@ -10935,7 +10931,6 @@ class ChatApi {
|
|
|
10935
10931
|
* Get a message
|
|
10936
10932
|
*
|
|
10937
10933
|
* @param {String} messageId messageId
|
|
10938
|
-
* getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10939
10934
|
*/
|
|
10940
10935
|
getChatsMessage(messageId) {
|
|
10941
10936
|
// verify the required parameter 'messageId' is set
|
|
@@ -10961,7 +10956,6 @@ class ChatApi {
|
|
|
10961
10956
|
* Get a room
|
|
10962
10957
|
*
|
|
10963
10958
|
* @param {String} roomJid roomJid
|
|
10964
|
-
* getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10965
10959
|
*/
|
|
10966
10960
|
getChatsRoom(roomJid) {
|
|
10967
10961
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10988,7 +10982,6 @@ class ChatApi {
|
|
|
10988
10982
|
*
|
|
10989
10983
|
* @param {String} roomJid roomJid
|
|
10990
10984
|
* @param {String} messageIds messageIds, comma separated
|
|
10991
|
-
* getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10992
10985
|
*/
|
|
10993
10986
|
getChatsRoomMessage(roomJid, messageIds) {
|
|
10994
10987
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11022,7 +11015,6 @@ class ChatApi {
|
|
|
11022
11015
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11023
11016
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11024
11017
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11025
|
-
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11026
11018
|
*/
|
|
11027
11019
|
getChatsRoomMessages(roomJid, opts) {
|
|
11028
11020
|
opts = opts || {};
|
|
@@ -11046,6 +11038,61 @@ class ChatApi {
|
|
|
11046
11038
|
);
|
|
11047
11039
|
}
|
|
11048
11040
|
|
|
11041
|
+
/**
|
|
11042
|
+
* Get a room participant
|
|
11043
|
+
*
|
|
11044
|
+
* @param {String} roomJid roomJid
|
|
11045
|
+
* @param {String} participantJid participantJid
|
|
11046
|
+
*/
|
|
11047
|
+
getChatsRoomParticipant(roomJid, participantJid) {
|
|
11048
|
+
// verify the required parameter 'roomJid' is set
|
|
11049
|
+
if (roomJid === undefined || roomJid === null) {
|
|
11050
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';
|
|
11051
|
+
}
|
|
11052
|
+
// verify the required parameter 'participantJid' is set
|
|
11053
|
+
if (participantJid === undefined || participantJid === null) {
|
|
11054
|
+
throw 'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';
|
|
11055
|
+
}
|
|
11056
|
+
|
|
11057
|
+
return this.apiClient.callApi(
|
|
11058
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{participantJid}',
|
|
11059
|
+
'GET',
|
|
11060
|
+
{ 'roomJid': roomJid,'participantJid': participantJid },
|
|
11061
|
+
{ },
|
|
11062
|
+
{ },
|
|
11063
|
+
{ },
|
|
11064
|
+
null,
|
|
11065
|
+
['PureCloud OAuth'],
|
|
11066
|
+
['application/json'],
|
|
11067
|
+
['application/json']
|
|
11068
|
+
);
|
|
11069
|
+
}
|
|
11070
|
+
|
|
11071
|
+
/**
|
|
11072
|
+
* Get room participants in a room
|
|
11073
|
+
*
|
|
11074
|
+
* @param {String} roomJid roomJid
|
|
11075
|
+
*/
|
|
11076
|
+
getChatsRoomParticipants(roomJid) {
|
|
11077
|
+
// verify the required parameter 'roomJid' is set
|
|
11078
|
+
if (roomJid === undefined || roomJid === null) {
|
|
11079
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
|
|
11080
|
+
}
|
|
11081
|
+
|
|
11082
|
+
return this.apiClient.callApi(
|
|
11083
|
+
'/api/v2/chats/rooms/{roomJid}/participants',
|
|
11084
|
+
'GET',
|
|
11085
|
+
{ 'roomJid': roomJid },
|
|
11086
|
+
{ },
|
|
11087
|
+
{ },
|
|
11088
|
+
{ },
|
|
11089
|
+
null,
|
|
11090
|
+
['PureCloud OAuth'],
|
|
11091
|
+
['application/json'],
|
|
11092
|
+
['application/json']
|
|
11093
|
+
);
|
|
11094
|
+
}
|
|
11095
|
+
|
|
11049
11096
|
/**
|
|
11050
11097
|
* Get Chat Settings.
|
|
11051
11098
|
*
|
|
@@ -11074,7 +11121,6 @@ class ChatApi {
|
|
|
11074
11121
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11075
11122
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11076
11123
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11077
|
-
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11078
11124
|
*/
|
|
11079
11125
|
getChatsThreadMessages(threadId, opts) {
|
|
11080
11126
|
opts = opts || {};
|
|
@@ -11103,7 +11149,6 @@ class ChatApi {
|
|
|
11103
11149
|
*
|
|
11104
11150
|
* @param {String} userId userId
|
|
11105
11151
|
* @param {String} messageIds messageIds, comma separated
|
|
11106
|
-
* getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11107
11152
|
*/
|
|
11108
11153
|
getChatsUserMessage(userId, messageIds) {
|
|
11109
11154
|
// verify the required parameter 'userId' is set
|
|
@@ -11137,7 +11182,6 @@ class ChatApi {
|
|
|
11137
11182
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11138
11183
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11139
11184
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11140
|
-
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11141
11185
|
*/
|
|
11142
11186
|
getChatsUserMessages(userId, opts) {
|
|
11143
11187
|
opts = opts || {};
|
|
@@ -11192,7 +11236,6 @@ class ChatApi {
|
|
|
11192
11236
|
*
|
|
11193
11237
|
* @param {String} roomJid roomJid
|
|
11194
11238
|
* @param {Object} body Room properties
|
|
11195
|
-
* patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11196
11239
|
*/
|
|
11197
11240
|
patchChatsRoom(roomJid, body) {
|
|
11198
11241
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11224,7 +11267,6 @@ class ChatApi {
|
|
|
11224
11267
|
* @param {String} roomJid roomId
|
|
11225
11268
|
* @param {String} messageId messageId
|
|
11226
11269
|
* @param {Object} body messageBody
|
|
11227
|
-
* patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11228
11270
|
*/
|
|
11229
11271
|
patchChatsRoomMessage(roomJid, messageId, body) {
|
|
11230
11272
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11285,7 +11327,6 @@ class ChatApi {
|
|
|
11285
11327
|
* @param {String} userId userId
|
|
11286
11328
|
* @param {String} messageId messageId
|
|
11287
11329
|
* @param {Object} body message body
|
|
11288
|
-
* patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11289
11330
|
*/
|
|
11290
11331
|
patchChatsUserMessage(userId, messageId, body) {
|
|
11291
11332
|
// verify the required parameter 'userId' is set
|
|
@@ -11351,7 +11392,6 @@ class ChatApi {
|
|
|
11351
11392
|
*
|
|
11352
11393
|
* @param {String} roomJid roomId
|
|
11353
11394
|
* @param {Object} body messageBody
|
|
11354
|
-
* postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11355
11395
|
*/
|
|
11356
11396
|
postChatsRoomMessages(roomJid, body) {
|
|
11357
11397
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11382,7 +11422,6 @@ class ChatApi {
|
|
|
11382
11422
|
*
|
|
11383
11423
|
* @param {String} roomJid roomJid
|
|
11384
11424
|
* @param {String} userId userId
|
|
11385
|
-
* postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11386
11425
|
*/
|
|
11387
11426
|
postChatsRoomParticipant(roomJid, userId) {
|
|
11388
11427
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11413,7 +11452,6 @@ class ChatApi {
|
|
|
11413
11452
|
*
|
|
11414
11453
|
* @param {String} roomJid roomJid
|
|
11415
11454
|
* @param {Object} body Pinned Message Ids
|
|
11416
|
-
* postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11417
11455
|
*/
|
|
11418
11456
|
postChatsRoomPinnedmessages(roomJid, body) {
|
|
11419
11457
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11443,7 +11481,6 @@ class ChatApi {
|
|
|
11443
11481
|
* Create an adhoc room
|
|
11444
11482
|
*
|
|
11445
11483
|
* @param {Object} body Room properties
|
|
11446
|
-
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11447
11484
|
*/
|
|
11448
11485
|
postChatsRooms(body) {
|
|
11449
11486
|
// verify the required parameter 'body' is set
|
|
@@ -11470,7 +11507,6 @@ class ChatApi {
|
|
|
11470
11507
|
*
|
|
11471
11508
|
* @param {String} userId userId
|
|
11472
11509
|
* @param {Object} body message body
|
|
11473
|
-
* postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11474
11510
|
*/
|
|
11475
11511
|
postChatsUserMessages(userId, body) {
|
|
11476
11512
|
// verify the required parameter 'userId' is set
|
|
@@ -11496,6 +11532,36 @@ class ChatApi {
|
|
|
11496
11532
|
);
|
|
11497
11533
|
}
|
|
11498
11534
|
|
|
11535
|
+
/**
|
|
11536
|
+
* Update reactions to a message
|
|
11537
|
+
*
|
|
11538
|
+
* @param {String} messageId messageId
|
|
11539
|
+
* @param {Object} body reactionUpdate
|
|
11540
|
+
*/
|
|
11541
|
+
putChatsMessageReactions(messageId, body) {
|
|
11542
|
+
// verify the required parameter 'messageId' is set
|
|
11543
|
+
if (messageId === undefined || messageId === null) {
|
|
11544
|
+
throw 'Missing the required parameter "messageId" when calling putChatsMessageReactions';
|
|
11545
|
+
}
|
|
11546
|
+
// verify the required parameter 'body' is set
|
|
11547
|
+
if (body === undefined || body === null) {
|
|
11548
|
+
throw 'Missing the required parameter "body" when calling putChatsMessageReactions';
|
|
11549
|
+
}
|
|
11550
|
+
|
|
11551
|
+
return this.apiClient.callApi(
|
|
11552
|
+
'/api/v2/chats/messages/{messageId}/reactions',
|
|
11553
|
+
'PUT',
|
|
11554
|
+
{ 'messageId': messageId },
|
|
11555
|
+
{ },
|
|
11556
|
+
{ },
|
|
11557
|
+
{ },
|
|
11558
|
+
body,
|
|
11559
|
+
['PureCloud OAuth'],
|
|
11560
|
+
['application/json'],
|
|
11561
|
+
['application/json']
|
|
11562
|
+
);
|
|
11563
|
+
}
|
|
11564
|
+
|
|
11499
11565
|
/**
|
|
11500
11566
|
* Update Chat Settings.
|
|
11501
11567
|
*
|
|
@@ -11527,7 +11593,7 @@ class CoachingApi {
|
|
|
11527
11593
|
/**
|
|
11528
11594
|
* Coaching service.
|
|
11529
11595
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11530
|
-
* @version
|
|
11596
|
+
* @version 190.0.0
|
|
11531
11597
|
*/
|
|
11532
11598
|
|
|
11533
11599
|
/**
|
|
@@ -12104,7 +12170,7 @@ class ContentManagementApi {
|
|
|
12104
12170
|
/**
|
|
12105
12171
|
* ContentManagement service.
|
|
12106
12172
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12107
|
-
* @version
|
|
12173
|
+
* @version 190.0.0
|
|
12108
12174
|
*/
|
|
12109
12175
|
|
|
12110
12176
|
/**
|
|
@@ -13186,7 +13252,7 @@ class ConversationsApi {
|
|
|
13186
13252
|
/**
|
|
13187
13253
|
* Conversations service.
|
|
13188
13254
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13189
|
-
* @version
|
|
13255
|
+
* @version 190.0.0
|
|
13190
13256
|
*/
|
|
13191
13257
|
|
|
13192
13258
|
/**
|
|
@@ -13479,8 +13545,9 @@ class ConversationsApi {
|
|
|
13479
13545
|
|
|
13480
13546
|
/**
|
|
13481
13547
|
* Delete a Twitter messaging integration
|
|
13482
|
-
*
|
|
13548
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
13483
13549
|
* @param {String} integrationId Integration ID
|
|
13550
|
+
* @deprecated
|
|
13484
13551
|
*/
|
|
13485
13552
|
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
13486
13553
|
// verify the required parameter 'integrationId' is set
|
|
@@ -15555,14 +15622,15 @@ class ConversationsApi {
|
|
|
15555
15622
|
}
|
|
15556
15623
|
|
|
15557
15624
|
/**
|
|
15558
|
-
* Get a list of Twitter Integrations
|
|
15559
|
-
*
|
|
15625
|
+
* Get a list of Twitter Integrations (Deprecated)
|
|
15626
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15560
15627
|
* @param {Object} opts Optional parameters
|
|
15561
15628
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15562
15629
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15563
15630
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15564
15631
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
15565
15632
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
15633
|
+
* @deprecated
|
|
15566
15634
|
*/
|
|
15567
15635
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
15568
15636
|
opts = opts || {};
|
|
@@ -15583,11 +15651,12 @@ class ConversationsApi {
|
|
|
15583
15651
|
}
|
|
15584
15652
|
|
|
15585
15653
|
/**
|
|
15586
|
-
* Get a Twitter messaging integration
|
|
15587
|
-
*
|
|
15654
|
+
* Get a Twitter messaging integration (Deprecated)
|
|
15655
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15588
15656
|
* @param {String} integrationId Integration ID
|
|
15589
15657
|
* @param {Object} opts Optional parameters
|
|
15590
15658
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15659
|
+
* @deprecated
|
|
15591
15660
|
*/
|
|
15592
15661
|
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
15593
15662
|
opts = opts || {};
|
|
@@ -17206,9 +17275,10 @@ class ConversationsApi {
|
|
|
17206
17275
|
|
|
17207
17276
|
/**
|
|
17208
17277
|
* Update Twitter messaging integration
|
|
17209
|
-
*
|
|
17278
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
17210
17279
|
* @param {String} integrationId Integration ID
|
|
17211
17280
|
* @param {Object} body TwitterIntegrationRequest
|
|
17281
|
+
* @deprecated
|
|
17212
17282
|
*/
|
|
17213
17283
|
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
17214
17284
|
// verify the required parameter 'integrationId' is set
|
|
@@ -19494,8 +19564,9 @@ class ConversationsApi {
|
|
|
19494
19564
|
|
|
19495
19565
|
/**
|
|
19496
19566
|
* Create a Twitter Integration
|
|
19497
|
-
*
|
|
19567
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
19498
19568
|
* @param {Object} body TwitterIntegrationRequest
|
|
19569
|
+
* @deprecated
|
|
19499
19570
|
*/
|
|
19500
19571
|
postConversationsMessagingIntegrationsTwitter(body) {
|
|
19501
19572
|
// verify the required parameter 'body' is set
|
|
@@ -20358,7 +20429,7 @@ class DataExtensionsApi {
|
|
|
20358
20429
|
/**
|
|
20359
20430
|
* DataExtensions service.
|
|
20360
20431
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20361
|
-
* @version
|
|
20432
|
+
* @version 190.0.0
|
|
20362
20433
|
*/
|
|
20363
20434
|
|
|
20364
20435
|
/**
|
|
@@ -20444,7 +20515,7 @@ class DownloadsApi {
|
|
|
20444
20515
|
/**
|
|
20445
20516
|
* Downloads service.
|
|
20446
20517
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20447
|
-
* @version
|
|
20518
|
+
* @version 190.0.0
|
|
20448
20519
|
*/
|
|
20449
20520
|
|
|
20450
20521
|
/**
|
|
@@ -20496,7 +20567,7 @@ class EmailsApi {
|
|
|
20496
20567
|
/**
|
|
20497
20568
|
* Emails service.
|
|
20498
20569
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20499
|
-
* @version
|
|
20570
|
+
* @version 190.0.0
|
|
20500
20571
|
*/
|
|
20501
20572
|
|
|
20502
20573
|
/**
|
|
@@ -20561,7 +20632,7 @@ class EventsApi {
|
|
|
20561
20632
|
/**
|
|
20562
20633
|
* Events service.
|
|
20563
20634
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20564
|
-
* @version
|
|
20635
|
+
* @version 190.0.0
|
|
20565
20636
|
*/
|
|
20566
20637
|
|
|
20567
20638
|
/**
|
|
@@ -20657,7 +20728,7 @@ class ExternalContactsApi {
|
|
|
20657
20728
|
/**
|
|
20658
20729
|
* ExternalContacts service.
|
|
20659
20730
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20660
|
-
* @version
|
|
20731
|
+
* @version 190.0.0
|
|
20661
20732
|
*/
|
|
20662
20733
|
|
|
20663
20734
|
/**
|
|
@@ -22615,7 +22686,7 @@ class FaxApi {
|
|
|
22615
22686
|
/**
|
|
22616
22687
|
* Fax service.
|
|
22617
22688
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22618
|
-
* @version
|
|
22689
|
+
* @version 190.0.0
|
|
22619
22690
|
*/
|
|
22620
22691
|
|
|
22621
22692
|
/**
|
|
@@ -22786,7 +22857,7 @@ class FlowsApi {
|
|
|
22786
22857
|
/**
|
|
22787
22858
|
* Flows service.
|
|
22788
22859
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22789
|
-
* @version
|
|
22860
|
+
* @version 190.0.0
|
|
22790
22861
|
*/
|
|
22791
22862
|
|
|
22792
22863
|
/**
|
|
@@ -22970,7 +23041,7 @@ class GamificationApi {
|
|
|
22970
23041
|
/**
|
|
22971
23042
|
* Gamification service.
|
|
22972
23043
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22973
|
-
* @version
|
|
23044
|
+
* @version 190.0.0
|
|
22974
23045
|
*/
|
|
22975
23046
|
|
|
22976
23047
|
/**
|
|
@@ -25056,7 +25127,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25056
25127
|
/**
|
|
25057
25128
|
* GeneralDataProtectionRegulation service.
|
|
25058
25129
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25059
|
-
* @version
|
|
25130
|
+
* @version 190.0.0
|
|
25060
25131
|
*/
|
|
25061
25132
|
|
|
25062
25133
|
/**
|
|
@@ -25186,7 +25257,7 @@ class GeolocationApi {
|
|
|
25186
25257
|
/**
|
|
25187
25258
|
* Geolocation service.
|
|
25188
25259
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25189
|
-
* @version
|
|
25260
|
+
* @version 190.0.0
|
|
25190
25261
|
*/
|
|
25191
25262
|
|
|
25192
25263
|
/**
|
|
@@ -25317,7 +25388,7 @@ class GreetingsApi {
|
|
|
25317
25388
|
/**
|
|
25318
25389
|
* Greetings service.
|
|
25319
25390
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25320
|
-
* @version
|
|
25391
|
+
* @version 190.0.0
|
|
25321
25392
|
*/
|
|
25322
25393
|
|
|
25323
25394
|
/**
|
|
@@ -25772,7 +25843,7 @@ class GroupsApi {
|
|
|
25772
25843
|
/**
|
|
25773
25844
|
* Groups service.
|
|
25774
25845
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25775
|
-
* @version
|
|
25846
|
+
* @version 190.0.0
|
|
25776
25847
|
*/
|
|
25777
25848
|
|
|
25778
25849
|
/**
|
|
@@ -26291,7 +26362,7 @@ class IdentityProviderApi {
|
|
|
26291
26362
|
/**
|
|
26292
26363
|
* IdentityProvider service.
|
|
26293
26364
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26294
|
-
* @version
|
|
26365
|
+
* @version 190.0.0
|
|
26295
26366
|
*/
|
|
26296
26367
|
|
|
26297
26368
|
/**
|
|
@@ -27152,7 +27223,7 @@ class InfrastructureAsCodeApi {
|
|
|
27152
27223
|
/**
|
|
27153
27224
|
* InfrastructureAsCode service.
|
|
27154
27225
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27155
|
-
* @version
|
|
27226
|
+
* @version 190.0.0
|
|
27156
27227
|
*/
|
|
27157
27228
|
|
|
27158
27229
|
/**
|
|
@@ -27319,7 +27390,7 @@ class IntegrationsApi {
|
|
|
27319
27390
|
/**
|
|
27320
27391
|
* Integrations service.
|
|
27321
27392
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27322
|
-
* @version
|
|
27393
|
+
* @version 190.0.0
|
|
27323
27394
|
*/
|
|
27324
27395
|
|
|
27325
27396
|
/**
|
|
@@ -29670,7 +29741,7 @@ class JourneyApi {
|
|
|
29670
29741
|
/**
|
|
29671
29742
|
* Journey service.
|
|
29672
29743
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29673
|
-
* @version
|
|
29744
|
+
* @version 190.0.0
|
|
29674
29745
|
*/
|
|
29675
29746
|
|
|
29676
29747
|
/**
|
|
@@ -30520,6 +30591,109 @@ class JourneyApi {
|
|
|
30520
30591
|
);
|
|
30521
30592
|
}
|
|
30522
30593
|
|
|
30594
|
+
/**
|
|
30595
|
+
* Get the job for a journey view version.
|
|
30596
|
+
* used for long descriptions
|
|
30597
|
+
* @param {String} viewId Journey View Id
|
|
30598
|
+
* @param {String} journeyVersionId Journey View Version
|
|
30599
|
+
* @param {String} jobId JobId
|
|
30600
|
+
* getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30601
|
+
*/
|
|
30602
|
+
getJourneyViewVersionJob(viewId, journeyVersionId, jobId) {
|
|
30603
|
+
// verify the required parameter 'viewId' is set
|
|
30604
|
+
if (viewId === undefined || viewId === null) {
|
|
30605
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';
|
|
30606
|
+
}
|
|
30607
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
30608
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
30609
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';
|
|
30610
|
+
}
|
|
30611
|
+
// verify the required parameter 'jobId' is set
|
|
30612
|
+
if (jobId === undefined || jobId === null) {
|
|
30613
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';
|
|
30614
|
+
}
|
|
30615
|
+
|
|
30616
|
+
return this.apiClient.callApi(
|
|
30617
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}',
|
|
30618
|
+
'GET',
|
|
30619
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
|
|
30620
|
+
{ },
|
|
30621
|
+
{ },
|
|
30622
|
+
{ },
|
|
30623
|
+
null,
|
|
30624
|
+
['PureCloud OAuth'],
|
|
30625
|
+
['application/json'],
|
|
30626
|
+
['application/json']
|
|
30627
|
+
);
|
|
30628
|
+
}
|
|
30629
|
+
|
|
30630
|
+
/**
|
|
30631
|
+
* Get the result of a job for a journey view version.
|
|
30632
|
+
* used for long descriptions
|
|
30633
|
+
* @param {String} viewId JourneyViewResult id
|
|
30634
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
30635
|
+
* @param {String} jobId Id of the executing job
|
|
30636
|
+
* getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30637
|
+
*/
|
|
30638
|
+
getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId) {
|
|
30639
|
+
// verify the required parameter 'viewId' is set
|
|
30640
|
+
if (viewId === undefined || viewId === null) {
|
|
30641
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';
|
|
30642
|
+
}
|
|
30643
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
30644
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
30645
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';
|
|
30646
|
+
}
|
|
30647
|
+
// verify the required parameter 'jobId' is set
|
|
30648
|
+
if (jobId === undefined || jobId === null) {
|
|
30649
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';
|
|
30650
|
+
}
|
|
30651
|
+
|
|
30652
|
+
return this.apiClient.callApi(
|
|
30653
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results',
|
|
30654
|
+
'GET',
|
|
30655
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'jobId': jobId },
|
|
30656
|
+
{ },
|
|
30657
|
+
{ },
|
|
30658
|
+
{ },
|
|
30659
|
+
null,
|
|
30660
|
+
['PureCloud OAuth'],
|
|
30661
|
+
['application/json'],
|
|
30662
|
+
['application/json']
|
|
30663
|
+
);
|
|
30664
|
+
}
|
|
30665
|
+
|
|
30666
|
+
/**
|
|
30667
|
+
* Get the latest job of a journey view version.
|
|
30668
|
+
* used for long descriptions
|
|
30669
|
+
* @param {String} viewId Journey View Id
|
|
30670
|
+
* @param {String} journeyVersionId Journey View Version
|
|
30671
|
+
* getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30672
|
+
*/
|
|
30673
|
+
getJourneyViewVersionJobsLatest(viewId, journeyVersionId) {
|
|
30674
|
+
// verify the required parameter 'viewId' is set
|
|
30675
|
+
if (viewId === undefined || viewId === null) {
|
|
30676
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';
|
|
30677
|
+
}
|
|
30678
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
30679
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
30680
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';
|
|
30681
|
+
}
|
|
30682
|
+
|
|
30683
|
+
return this.apiClient.callApi(
|
|
30684
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest',
|
|
30685
|
+
'GET',
|
|
30686
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId },
|
|
30687
|
+
{ },
|
|
30688
|
+
{ },
|
|
30689
|
+
{ },
|
|
30690
|
+
null,
|
|
30691
|
+
['PureCloud OAuth'],
|
|
30692
|
+
['application/json'],
|
|
30693
|
+
['application/json']
|
|
30694
|
+
);
|
|
30695
|
+
}
|
|
30696
|
+
|
|
30523
30697
|
/**
|
|
30524
30698
|
* Get a list of Journey Views
|
|
30525
30699
|
*
|
|
@@ -30541,6 +30715,53 @@ class JourneyApi {
|
|
|
30541
30715
|
);
|
|
30542
30716
|
}
|
|
30543
30717
|
|
|
30718
|
+
/**
|
|
30719
|
+
* Get an Event Definition
|
|
30720
|
+
*
|
|
30721
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
30722
|
+
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30723
|
+
*/
|
|
30724
|
+
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
30725
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
30726
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null) {
|
|
30727
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';
|
|
30728
|
+
}
|
|
30729
|
+
|
|
30730
|
+
return this.apiClient.callApi(
|
|
30731
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
|
|
30732
|
+
'GET',
|
|
30733
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
30734
|
+
{ },
|
|
30735
|
+
{ },
|
|
30736
|
+
{ },
|
|
30737
|
+
null,
|
|
30738
|
+
['PureCloud OAuth'],
|
|
30739
|
+
['application/json'],
|
|
30740
|
+
['application/json']
|
|
30741
|
+
);
|
|
30742
|
+
}
|
|
30743
|
+
|
|
30744
|
+
/**
|
|
30745
|
+
* Get a list of Event Definitions
|
|
30746
|
+
*
|
|
30747
|
+
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30748
|
+
*/
|
|
30749
|
+
getJourneyViewsEventdefinitions() {
|
|
30750
|
+
|
|
30751
|
+
return this.apiClient.callApi(
|
|
30752
|
+
'/api/v2/journey/views/eventdefinitions',
|
|
30753
|
+
'GET',
|
|
30754
|
+
{ },
|
|
30755
|
+
{ },
|
|
30756
|
+
{ },
|
|
30757
|
+
{ },
|
|
30758
|
+
null,
|
|
30759
|
+
['PureCloud OAuth'],
|
|
30760
|
+
['application/json'],
|
|
30761
|
+
['application/json']
|
|
30762
|
+
);
|
|
30763
|
+
}
|
|
30764
|
+
|
|
30544
30765
|
/**
|
|
30545
30766
|
* Update single action map.
|
|
30546
30767
|
*
|
|
@@ -30991,6 +31212,37 @@ class JourneyApi {
|
|
|
30991
31212
|
);
|
|
30992
31213
|
}
|
|
30993
31214
|
|
|
31215
|
+
/**
|
|
31216
|
+
* Submit a job request for a journey view version.
|
|
31217
|
+
* used for long descriptions
|
|
31218
|
+
* @param {String} viewId Journey View Id
|
|
31219
|
+
* @param {String} journeyVersionId Journey View Version
|
|
31220
|
+
* postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31221
|
+
*/
|
|
31222
|
+
postJourneyViewVersionJobs(viewId, journeyVersionId) {
|
|
31223
|
+
// verify the required parameter 'viewId' is set
|
|
31224
|
+
if (viewId === undefined || viewId === null) {
|
|
31225
|
+
throw 'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';
|
|
31226
|
+
}
|
|
31227
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
31228
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
31229
|
+
throw 'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';
|
|
31230
|
+
}
|
|
31231
|
+
|
|
31232
|
+
return this.apiClient.callApi(
|
|
31233
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs',
|
|
31234
|
+
'POST',
|
|
31235
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId },
|
|
31236
|
+
{ },
|
|
31237
|
+
{ },
|
|
31238
|
+
{ },
|
|
31239
|
+
null,
|
|
31240
|
+
['PureCloud OAuth'],
|
|
31241
|
+
['application/json'],
|
|
31242
|
+
['application/json']
|
|
31243
|
+
);
|
|
31244
|
+
}
|
|
31245
|
+
|
|
30994
31246
|
/**
|
|
30995
31247
|
* Update a Journey View by ID
|
|
30996
31248
|
* creates a new version
|
|
@@ -31048,13 +31300,38 @@ class JourneyApi {
|
|
|
31048
31300
|
);
|
|
31049
31301
|
}
|
|
31050
31302
|
|
|
31303
|
+
/**
|
|
31304
|
+
* Validate whether an encoding exist for a label/value combination.
|
|
31305
|
+
* True indicates a valid encoding
|
|
31306
|
+
* @param {Object} opts Optional parameters
|
|
31307
|
+
* @param {Array.<Object>} opts.body
|
|
31308
|
+
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31309
|
+
*/
|
|
31310
|
+
postJourneyViewsEncodingsValidate(opts) {
|
|
31311
|
+
opts = opts || {};
|
|
31312
|
+
|
|
31313
|
+
|
|
31314
|
+
return this.apiClient.callApi(
|
|
31315
|
+
'/api/v2/journey/views/encodings/validate',
|
|
31316
|
+
'POST',
|
|
31317
|
+
{ },
|
|
31318
|
+
{ },
|
|
31319
|
+
{ },
|
|
31320
|
+
{ },
|
|
31321
|
+
opts['body'],
|
|
31322
|
+
['PureCloud OAuth'],
|
|
31323
|
+
['application/json'],
|
|
31324
|
+
['application/json']
|
|
31325
|
+
);
|
|
31326
|
+
}
|
|
31327
|
+
|
|
31051
31328
|
}
|
|
31052
31329
|
|
|
31053
31330
|
class KnowledgeApi {
|
|
31054
31331
|
/**
|
|
31055
31332
|
* Knowledge service.
|
|
31056
31333
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31057
|
-
* @version
|
|
31334
|
+
* @version 190.0.0
|
|
31058
31335
|
*/
|
|
31059
31336
|
|
|
31060
31337
|
/**
|
|
@@ -34297,7 +34574,7 @@ class LanguageUnderstandingApi {
|
|
|
34297
34574
|
/**
|
|
34298
34575
|
* LanguageUnderstanding service.
|
|
34299
34576
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34300
|
-
* @version
|
|
34577
|
+
* @version 190.0.0
|
|
34301
34578
|
*/
|
|
34302
34579
|
|
|
34303
34580
|
/**
|
|
@@ -35310,7 +35587,7 @@ class LanguagesApi {
|
|
|
35310
35587
|
/**
|
|
35311
35588
|
* Languages service.
|
|
35312
35589
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35313
|
-
* @version
|
|
35590
|
+
* @version 190.0.0
|
|
35314
35591
|
*/
|
|
35315
35592
|
|
|
35316
35593
|
/**
|
|
@@ -35532,7 +35809,7 @@ class LearningApi {
|
|
|
35532
35809
|
/**
|
|
35533
35810
|
* Learning service.
|
|
35534
35811
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35535
|
-
* @version
|
|
35812
|
+
* @version 190.0.0
|
|
35536
35813
|
*/
|
|
35537
35814
|
|
|
35538
35815
|
/**
|
|
@@ -36388,7 +36665,7 @@ class LicenseApi {
|
|
|
36388
36665
|
/**
|
|
36389
36666
|
* License service.
|
|
36390
36667
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36391
|
-
* @version
|
|
36668
|
+
* @version 190.0.0
|
|
36392
36669
|
*/
|
|
36393
36670
|
|
|
36394
36671
|
/**
|
|
@@ -36626,7 +36903,7 @@ class LocationsApi {
|
|
|
36626
36903
|
/**
|
|
36627
36904
|
* Locations service.
|
|
36628
36905
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36629
|
-
* @version
|
|
36906
|
+
* @version 190.0.0
|
|
36630
36907
|
*/
|
|
36631
36908
|
|
|
36632
36909
|
/**
|
|
@@ -36862,7 +37139,7 @@ class LogCaptureApi {
|
|
|
36862
37139
|
/**
|
|
36863
37140
|
* LogCapture service.
|
|
36864
37141
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
36865
|
-
* @version
|
|
37142
|
+
* @version 190.0.0
|
|
36866
37143
|
*/
|
|
36867
37144
|
|
|
36868
37145
|
/**
|
|
@@ -37062,7 +37339,7 @@ class MessagingApi {
|
|
|
37062
37339
|
/**
|
|
37063
37340
|
* Messaging service.
|
|
37064
37341
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37065
|
-
* @version
|
|
37342
|
+
* @version 190.0.0
|
|
37066
37343
|
*/
|
|
37067
37344
|
|
|
37068
37345
|
/**
|
|
@@ -37421,7 +37698,7 @@ class MobileDevicesApi {
|
|
|
37421
37698
|
/**
|
|
37422
37699
|
* MobileDevices service.
|
|
37423
37700
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37424
|
-
* @version
|
|
37701
|
+
* @version 190.0.0
|
|
37425
37702
|
*/
|
|
37426
37703
|
|
|
37427
37704
|
/**
|
|
@@ -37572,7 +37849,7 @@ class NotificationsApi {
|
|
|
37572
37849
|
/**
|
|
37573
37850
|
* Notifications service.
|
|
37574
37851
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
37575
|
-
* @version
|
|
37852
|
+
* @version 190.0.0
|
|
37576
37853
|
*/
|
|
37577
37854
|
|
|
37578
37855
|
/**
|
|
@@ -37805,7 +38082,7 @@ class OAuthApi {
|
|
|
37805
38082
|
/**
|
|
37806
38083
|
* OAuth service.
|
|
37807
38084
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37808
|
-
* @version
|
|
38085
|
+
* @version 190.0.0
|
|
37809
38086
|
*/
|
|
37810
38087
|
|
|
37811
38088
|
/**
|
|
@@ -38171,7 +38448,7 @@ class ObjectsApi {
|
|
|
38171
38448
|
/**
|
|
38172
38449
|
* Objects service.
|
|
38173
38450
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38174
|
-
* @version
|
|
38451
|
+
* @version 190.0.0
|
|
38175
38452
|
*/
|
|
38176
38453
|
|
|
38177
38454
|
/**
|
|
@@ -38441,7 +38718,7 @@ class OperationalEventsApi {
|
|
|
38441
38718
|
/**
|
|
38442
38719
|
* OperationalEvents service.
|
|
38443
38720
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38444
|
-
* @version
|
|
38721
|
+
* @version 190.0.0
|
|
38445
38722
|
*/
|
|
38446
38723
|
|
|
38447
38724
|
/**
|
|
@@ -38507,7 +38784,7 @@ class OrganizationApi {
|
|
|
38507
38784
|
/**
|
|
38508
38785
|
* Organization service.
|
|
38509
38786
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38510
|
-
* @version
|
|
38787
|
+
* @version 190.0.0
|
|
38511
38788
|
*/
|
|
38512
38789
|
|
|
38513
38790
|
/**
|
|
@@ -38664,7 +38941,7 @@ class OrganizationApi {
|
|
|
38664
38941
|
}
|
|
38665
38942
|
|
|
38666
38943
|
/**
|
|
38667
|
-
* Get
|
|
38944
|
+
* Get limit documentation
|
|
38668
38945
|
*
|
|
38669
38946
|
*/
|
|
38670
38947
|
getOrganizationsLimitsDocs() {
|
|
@@ -38962,7 +39239,7 @@ class OrganizationAuthorizationApi {
|
|
|
38962
39239
|
/**
|
|
38963
39240
|
* OrganizationAuthorization service.
|
|
38964
39241
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38965
|
-
* @version
|
|
39242
|
+
* @version 190.0.0
|
|
38966
39243
|
*/
|
|
38967
39244
|
|
|
38968
39245
|
/**
|
|
@@ -40309,7 +40586,7 @@ class OutboundApi {
|
|
|
40309
40586
|
/**
|
|
40310
40587
|
* Outbound service.
|
|
40311
40588
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40312
|
-
* @version
|
|
40589
|
+
* @version 190.0.0
|
|
40313
40590
|
*/
|
|
40314
40591
|
|
|
40315
40592
|
/**
|
|
@@ -44550,7 +44827,7 @@ class PresenceApi {
|
|
|
44550
44827
|
/**
|
|
44551
44828
|
* Presence service.
|
|
44552
44829
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
44553
|
-
* @version
|
|
44830
|
+
* @version 190.0.0
|
|
44554
44831
|
*/
|
|
44555
44832
|
|
|
44556
44833
|
/**
|
|
@@ -45294,7 +45571,7 @@ class ProcessAutomationApi {
|
|
|
45294
45571
|
/**
|
|
45295
45572
|
* ProcessAutomation service.
|
|
45296
45573
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45297
|
-
* @version
|
|
45574
|
+
* @version 190.0.0
|
|
45298
45575
|
*/
|
|
45299
45576
|
|
|
45300
45577
|
/**
|
|
@@ -45533,7 +45810,7 @@ class QualityApi {
|
|
|
45533
45810
|
/**
|
|
45534
45811
|
* Quality service.
|
|
45535
45812
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
45536
|
-
* @version
|
|
45813
|
+
* @version 190.0.0
|
|
45537
45814
|
*/
|
|
45538
45815
|
|
|
45539
45816
|
/**
|
|
@@ -47290,7 +47567,7 @@ class RecordingApi {
|
|
|
47290
47567
|
/**
|
|
47291
47568
|
* Recording service.
|
|
47292
47569
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47293
|
-
* @version
|
|
47570
|
+
* @version 190.0.0
|
|
47294
47571
|
*/
|
|
47295
47572
|
|
|
47296
47573
|
/**
|
|
@@ -48199,6 +48476,27 @@ class RecordingApi {
|
|
|
48199
48476
|
);
|
|
48200
48477
|
}
|
|
48201
48478
|
|
|
48479
|
+
/**
|
|
48480
|
+
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
48481
|
+
*
|
|
48482
|
+
* getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48483
|
+
*/
|
|
48484
|
+
getRecordingsScreensessionsDetails() {
|
|
48485
|
+
|
|
48486
|
+
return this.apiClient.callApi(
|
|
48487
|
+
'/api/v2/recordings/screensessions/details',
|
|
48488
|
+
'GET',
|
|
48489
|
+
{ },
|
|
48490
|
+
{ },
|
|
48491
|
+
{ },
|
|
48492
|
+
{ },
|
|
48493
|
+
null,
|
|
48494
|
+
['PureCloud OAuth'],
|
|
48495
|
+
['application/json'],
|
|
48496
|
+
['application/json']
|
|
48497
|
+
);
|
|
48498
|
+
}
|
|
48499
|
+
|
|
48202
48500
|
/**
|
|
48203
48501
|
* Patch a media retention policy
|
|
48204
48502
|
*
|
|
@@ -48927,7 +49225,7 @@ class ResponseManagementApi {
|
|
|
48927
49225
|
/**
|
|
48928
49226
|
* ResponseManagement service.
|
|
48929
49227
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
48930
|
-
* @version
|
|
49228
|
+
* @version 190.0.0
|
|
48931
49229
|
*/
|
|
48932
49230
|
|
|
48933
49231
|
/**
|
|
@@ -49412,7 +49710,7 @@ class RoutingApi {
|
|
|
49412
49710
|
/**
|
|
49413
49711
|
* Routing service.
|
|
49414
49712
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
49415
|
-
* @version
|
|
49713
|
+
* @version 190.0.0
|
|
49416
49714
|
*/
|
|
49417
49715
|
|
|
49418
49716
|
/**
|
|
@@ -50860,11 +51158,12 @@ class RoutingApi {
|
|
|
50860
51158
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50861
51159
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50862
51160
|
* @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
|
|
50863
|
-
* @param {String} opts.name
|
|
50864
|
-
* @param {Array.<String>} opts.id
|
|
50865
|
-
* @param {Array.<String>} opts.divisionId
|
|
50866
|
-
* @param {Array.<String>} opts.peerId
|
|
50867
|
-
* @param {
|
|
51161
|
+
* @param {String} opts.name Include only queues with the given name (leading and trailing asterisks allowed)
|
|
51162
|
+
* @param {Array.<String>} opts.id Include only queues with the specified ID(s)
|
|
51163
|
+
* @param {Array.<String>} opts.divisionId Include only queues in the specified division ID(s)
|
|
51164
|
+
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
51165
|
+
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
51166
|
+
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
50868
51167
|
*/
|
|
50869
51168
|
getRoutingQueues(opts) {
|
|
50870
51169
|
opts = opts || {};
|
|
@@ -50874,7 +51173,7 @@ class RoutingApi {
|
|
|
50874
51173
|
'/api/v2/routing/queues',
|
|
50875
51174
|
'GET',
|
|
50876
51175
|
{ },
|
|
50877
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
|
|
51176
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'cannedResponseLibraryId': opts['cannedResponseLibraryId'],'hasPeer': opts['hasPeer'] },
|
|
50878
51177
|
{ },
|
|
50879
51178
|
{ },
|
|
50880
51179
|
null,
|
|
@@ -53365,7 +53664,7 @@ class SCIMApi {
|
|
|
53365
53664
|
/**
|
|
53366
53665
|
* SCIM service.
|
|
53367
53666
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
53368
|
-
* @version
|
|
53667
|
+
* @version 190.0.0
|
|
53369
53668
|
*/
|
|
53370
53669
|
|
|
53371
53670
|
/**
|
|
@@ -54242,7 +54541,7 @@ class ScreenRecordingApi {
|
|
|
54242
54541
|
/**
|
|
54243
54542
|
* ScreenRecording service.
|
|
54244
54543
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54245
|
-
* @version
|
|
54544
|
+
* @version 190.0.0
|
|
54246
54545
|
*/
|
|
54247
54546
|
|
|
54248
54547
|
/**
|
|
@@ -54287,7 +54586,7 @@ class ScriptsApi {
|
|
|
54287
54586
|
/**
|
|
54288
54587
|
* Scripts service.
|
|
54289
54588
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54290
|
-
* @version
|
|
54589
|
+
* @version 190.0.0
|
|
54291
54590
|
*/
|
|
54292
54591
|
|
|
54293
54592
|
/**
|
|
@@ -54731,7 +55030,7 @@ class SearchApi {
|
|
|
54731
55030
|
/**
|
|
54732
55031
|
* Search service.
|
|
54733
55032
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
54734
|
-
* @version
|
|
55033
|
+
* @version 190.0.0
|
|
54735
55034
|
*/
|
|
54736
55035
|
|
|
54737
55036
|
/**
|
|
@@ -55420,7 +55719,7 @@ class SettingsApi {
|
|
|
55420
55719
|
/**
|
|
55421
55720
|
* Settings service.
|
|
55422
55721
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
55423
|
-
* @version
|
|
55722
|
+
* @version 190.0.0
|
|
55424
55723
|
*/
|
|
55425
55724
|
|
|
55426
55725
|
/**
|
|
@@ -55532,7 +55831,7 @@ class SpeechTextAnalyticsApi {
|
|
|
55532
55831
|
/**
|
|
55533
55832
|
* SpeechTextAnalytics service.
|
|
55534
55833
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
55535
|
-
* @version
|
|
55834
|
+
* @version 190.0.0
|
|
55536
55835
|
*/
|
|
55537
55836
|
|
|
55538
55837
|
/**
|
|
@@ -56646,7 +56945,7 @@ class StationsApi {
|
|
|
56646
56945
|
/**
|
|
56647
56946
|
* Stations service.
|
|
56648
56947
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
56649
|
-
* @version
|
|
56948
|
+
* @version 190.0.0
|
|
56650
56949
|
*/
|
|
56651
56950
|
|
|
56652
56951
|
/**
|
|
@@ -56748,7 +57047,7 @@ class SuggestApi {
|
|
|
56748
57047
|
/**
|
|
56749
57048
|
* Suggest service.
|
|
56750
57049
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
56751
|
-
* @version
|
|
57050
|
+
* @version 190.0.0
|
|
56752
57051
|
*/
|
|
56753
57052
|
|
|
56754
57053
|
/**
|
|
@@ -56887,7 +57186,7 @@ class TaskManagementApi {
|
|
|
56887
57186
|
/**
|
|
56888
57187
|
* TaskManagement service.
|
|
56889
57188
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
56890
|
-
* @version
|
|
57189
|
+
* @version 190.0.0
|
|
56891
57190
|
*/
|
|
56892
57191
|
|
|
56893
57192
|
/**
|
|
@@ -58194,7 +58493,7 @@ class TeamsApi {
|
|
|
58194
58493
|
/**
|
|
58195
58494
|
* Teams service.
|
|
58196
58495
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
58197
|
-
* @version
|
|
58496
|
+
* @version 190.0.0
|
|
58198
58497
|
*/
|
|
58199
58498
|
|
|
58200
58499
|
/**
|
|
@@ -58496,7 +58795,7 @@ class TelephonyApi {
|
|
|
58496
58795
|
/**
|
|
58497
58796
|
* Telephony service.
|
|
58498
58797
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
58499
|
-
* @version
|
|
58798
|
+
* @version 190.0.0
|
|
58500
58799
|
*/
|
|
58501
58800
|
|
|
58502
58801
|
/**
|
|
@@ -58678,7 +58977,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
58678
58977
|
/**
|
|
58679
58978
|
* TelephonyProvidersEdge service.
|
|
58680
58979
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
58681
|
-
* @version
|
|
58980
|
+
* @version 190.0.0
|
|
58682
58981
|
*/
|
|
58683
58982
|
|
|
58684
58983
|
/**
|
|
@@ -62027,7 +62326,7 @@ class TextbotsApi {
|
|
|
62027
62326
|
/**
|
|
62028
62327
|
* Textbots service.
|
|
62029
62328
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62030
|
-
* @version
|
|
62329
|
+
* @version 190.0.0
|
|
62031
62330
|
*/
|
|
62032
62331
|
|
|
62033
62332
|
/**
|
|
@@ -62155,7 +62454,7 @@ class TokensApi {
|
|
|
62155
62454
|
/**
|
|
62156
62455
|
* Tokens service.
|
|
62157
62456
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62158
|
-
* @version
|
|
62457
|
+
* @version 190.0.0
|
|
62159
62458
|
*/
|
|
62160
62459
|
|
|
62161
62460
|
/**
|
|
@@ -62309,7 +62608,7 @@ class UploadsApi {
|
|
|
62309
62608
|
/**
|
|
62310
62609
|
* Uploads service.
|
|
62311
62610
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
62312
|
-
* @version
|
|
62611
|
+
* @version 190.0.0
|
|
62313
62612
|
*/
|
|
62314
62613
|
|
|
62315
62614
|
/**
|
|
@@ -62578,7 +62877,7 @@ class UsageApi {
|
|
|
62578
62877
|
/**
|
|
62579
62878
|
* Usage service.
|
|
62580
62879
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
62581
|
-
* @version
|
|
62880
|
+
* @version 190.0.0
|
|
62582
62881
|
*/
|
|
62583
62882
|
|
|
62584
62883
|
/**
|
|
@@ -62788,7 +63087,7 @@ class UserRecordingsApi {
|
|
|
62788
63087
|
/**
|
|
62789
63088
|
* UserRecordings service.
|
|
62790
63089
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
62791
|
-
* @version
|
|
63090
|
+
* @version 190.0.0
|
|
62792
63091
|
*/
|
|
62793
63092
|
|
|
62794
63093
|
/**
|
|
@@ -62973,7 +63272,7 @@ class UsersApi {
|
|
|
62973
63272
|
/**
|
|
62974
63273
|
* Users service.
|
|
62975
63274
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
62976
|
-
* @version
|
|
63275
|
+
* @version 190.0.0
|
|
62977
63276
|
*/
|
|
62978
63277
|
|
|
62979
63278
|
/**
|
|
@@ -65624,7 +65923,7 @@ class UtilitiesApi {
|
|
|
65624
65923
|
/**
|
|
65625
65924
|
* Utilities service.
|
|
65626
65925
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
65627
|
-
* @version
|
|
65926
|
+
* @version 190.0.0
|
|
65628
65927
|
*/
|
|
65629
65928
|
|
|
65630
65929
|
/**
|
|
@@ -65735,7 +66034,7 @@ class VoicemailApi {
|
|
|
65735
66034
|
/**
|
|
65736
66035
|
* Voicemail service.
|
|
65737
66036
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
65738
|
-
* @version
|
|
66037
|
+
* @version 190.0.0
|
|
65739
66038
|
*/
|
|
65740
66039
|
|
|
65741
66040
|
/**
|
|
@@ -66402,7 +66701,7 @@ class WebChatApi {
|
|
|
66402
66701
|
/**
|
|
66403
66702
|
* WebChat service.
|
|
66404
66703
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
66405
|
-
* @version
|
|
66704
|
+
* @version 190.0.0
|
|
66406
66705
|
*/
|
|
66407
66706
|
|
|
66408
66707
|
/**
|
|
@@ -66951,7 +67250,7 @@ class WebDeploymentsApi {
|
|
|
66951
67250
|
/**
|
|
66952
67251
|
* WebDeployments service.
|
|
66953
67252
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
66954
|
-
* @version
|
|
67253
|
+
* @version 190.0.0
|
|
66955
67254
|
*/
|
|
66956
67255
|
|
|
66957
67256
|
/**
|
|
@@ -67478,7 +67777,7 @@ class WebMessagingApi {
|
|
|
67478
67777
|
/**
|
|
67479
67778
|
* WebMessaging service.
|
|
67480
67779
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
67481
|
-
* @version
|
|
67780
|
+
* @version 190.0.0
|
|
67482
67781
|
*/
|
|
67483
67782
|
|
|
67484
67783
|
/**
|
|
@@ -67524,7 +67823,7 @@ class WidgetsApi {
|
|
|
67524
67823
|
/**
|
|
67525
67824
|
* Widgets service.
|
|
67526
67825
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
67527
|
-
* @version
|
|
67826
|
+
* @version 190.0.0
|
|
67528
67827
|
*/
|
|
67529
67828
|
|
|
67530
67829
|
/**
|
|
@@ -67670,7 +67969,7 @@ class WorkforceManagementApi {
|
|
|
67670
67969
|
/**
|
|
67671
67970
|
* WorkforceManagement service.
|
|
67672
67971
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
67673
|
-
* @version
|
|
67972
|
+
* @version 190.0.0
|
|
67674
67973
|
*/
|
|
67675
67974
|
|
|
67676
67975
|
/**
|
|
@@ -67830,6 +68129,96 @@ class WorkforceManagementApi {
|
|
|
67830
68129
|
);
|
|
67831
68130
|
}
|
|
67832
68131
|
|
|
68132
|
+
/**
|
|
68133
|
+
* Deletes a staffing group
|
|
68134
|
+
*
|
|
68135
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68136
|
+
* @param {String} staffingGroupId The ID of the staffing group to delete
|
|
68137
|
+
*/
|
|
68138
|
+
deleteWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
|
|
68139
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68140
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68141
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
|
|
68142
|
+
}
|
|
68143
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
68144
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
68145
|
+
throw 'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
|
|
68146
|
+
}
|
|
68147
|
+
|
|
68148
|
+
return this.apiClient.callApi(
|
|
68149
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
68150
|
+
'DELETE',
|
|
68151
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
68152
|
+
{ },
|
|
68153
|
+
{ },
|
|
68154
|
+
{ },
|
|
68155
|
+
null,
|
|
68156
|
+
['PureCloud OAuth'],
|
|
68157
|
+
['application/json'],
|
|
68158
|
+
['application/json']
|
|
68159
|
+
);
|
|
68160
|
+
}
|
|
68161
|
+
|
|
68162
|
+
/**
|
|
68163
|
+
* Deletes a time-off limit object
|
|
68164
|
+
*
|
|
68165
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68166
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to delete
|
|
68167
|
+
*/
|
|
68168
|
+
deleteWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
|
|
68169
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68170
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68171
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
|
|
68172
|
+
}
|
|
68173
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
68174
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
68175
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
|
|
68176
|
+
}
|
|
68177
|
+
|
|
68178
|
+
return this.apiClient.callApi(
|
|
68179
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
|
|
68180
|
+
'DELETE',
|
|
68181
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
68182
|
+
{ },
|
|
68183
|
+
{ },
|
|
68184
|
+
{ },
|
|
68185
|
+
null,
|
|
68186
|
+
['PureCloud OAuth'],
|
|
68187
|
+
['application/json'],
|
|
68188
|
+
['application/json']
|
|
68189
|
+
);
|
|
68190
|
+
}
|
|
68191
|
+
|
|
68192
|
+
/**
|
|
68193
|
+
* Deletes a time-off plan
|
|
68194
|
+
*
|
|
68195
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68196
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to delete
|
|
68197
|
+
*/
|
|
68198
|
+
deleteWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
|
|
68199
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68200
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68201
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
|
|
68202
|
+
}
|
|
68203
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
68204
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
68205
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
|
|
68206
|
+
}
|
|
68207
|
+
|
|
68208
|
+
return this.apiClient.callApi(
|
|
68209
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
68210
|
+
'DELETE',
|
|
68211
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
68212
|
+
{ },
|
|
68213
|
+
{ },
|
|
68214
|
+
{ },
|
|
68215
|
+
null,
|
|
68216
|
+
['PureCloud OAuth'],
|
|
68217
|
+
['application/json'],
|
|
68218
|
+
['application/json']
|
|
68219
|
+
);
|
|
68220
|
+
}
|
|
68221
|
+
|
|
67833
68222
|
/**
|
|
67834
68223
|
* Delete a schedule
|
|
67835
68224
|
*
|
|
@@ -68652,6 +69041,184 @@ class WorkforceManagementApi {
|
|
|
68652
69041
|
);
|
|
68653
69042
|
}
|
|
68654
69043
|
|
|
69044
|
+
/**
|
|
69045
|
+
* Gets a staffing group
|
|
69046
|
+
*
|
|
69047
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69048
|
+
* @param {String} staffingGroupId The ID of the staffing group to fetch
|
|
69049
|
+
*/
|
|
69050
|
+
getWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
|
|
69051
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69052
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69053
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
|
|
69054
|
+
}
|
|
69055
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
69056
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
69057
|
+
throw 'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
|
|
69058
|
+
}
|
|
69059
|
+
|
|
69060
|
+
return this.apiClient.callApi(
|
|
69061
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
69062
|
+
'GET',
|
|
69063
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
69064
|
+
{ },
|
|
69065
|
+
{ },
|
|
69066
|
+
{ },
|
|
69067
|
+
null,
|
|
69068
|
+
['PureCloud OAuth'],
|
|
69069
|
+
['application/json'],
|
|
69070
|
+
['application/json']
|
|
69071
|
+
);
|
|
69072
|
+
}
|
|
69073
|
+
|
|
69074
|
+
/**
|
|
69075
|
+
* Gets a list of staffing groups
|
|
69076
|
+
*
|
|
69077
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69078
|
+
* @param {Object} opts Optional parameters
|
|
69079
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
69080
|
+
*/
|
|
69081
|
+
getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
69082
|
+
opts = opts || {};
|
|
69083
|
+
|
|
69084
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69085
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69086
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';
|
|
69087
|
+
}
|
|
69088
|
+
|
|
69089
|
+
return this.apiClient.callApi(
|
|
69090
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
69091
|
+
'GET',
|
|
69092
|
+
{ 'businessUnitId': businessUnitId },
|
|
69093
|
+
{ 'managementUnitId': opts['managementUnitId'] },
|
|
69094
|
+
{ },
|
|
69095
|
+
{ },
|
|
69096
|
+
null,
|
|
69097
|
+
['PureCloud OAuth'],
|
|
69098
|
+
['application/json'],
|
|
69099
|
+
['application/json']
|
|
69100
|
+
);
|
|
69101
|
+
}
|
|
69102
|
+
|
|
69103
|
+
/**
|
|
69104
|
+
* Gets a time-off limit object
|
|
69105
|
+
* Returns properties of time-off limit object, but not daily values
|
|
69106
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69107
|
+
* @param {String} timeOffLimitId The ID of the time-off limit to fetch
|
|
69108
|
+
*/
|
|
69109
|
+
getWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
|
|
69110
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69111
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69112
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
|
|
69113
|
+
}
|
|
69114
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
69115
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
69116
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
|
|
69117
|
+
}
|
|
69118
|
+
|
|
69119
|
+
return this.apiClient.callApi(
|
|
69120
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
|
|
69121
|
+
'GET',
|
|
69122
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
69123
|
+
{ },
|
|
69124
|
+
{ },
|
|
69125
|
+
{ },
|
|
69126
|
+
null,
|
|
69127
|
+
['PureCloud OAuth'],
|
|
69128
|
+
['application/json'],
|
|
69129
|
+
['application/json']
|
|
69130
|
+
);
|
|
69131
|
+
}
|
|
69132
|
+
|
|
69133
|
+
/**
|
|
69134
|
+
* Gets a list of time-off limit objects
|
|
69135
|
+
*
|
|
69136
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69137
|
+
* @param {Object} opts Optional parameters
|
|
69138
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific time-off limit objects
|
|
69139
|
+
*/
|
|
69140
|
+
getWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
|
|
69141
|
+
opts = opts || {};
|
|
69142
|
+
|
|
69143
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69144
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69145
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';
|
|
69146
|
+
}
|
|
69147
|
+
|
|
69148
|
+
return this.apiClient.callApi(
|
|
69149
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
69150
|
+
'GET',
|
|
69151
|
+
{ 'businessUnitId': businessUnitId },
|
|
69152
|
+
{ 'managementUnitId': opts['managementUnitId'] },
|
|
69153
|
+
{ },
|
|
69154
|
+
{ },
|
|
69155
|
+
null,
|
|
69156
|
+
['PureCloud OAuth'],
|
|
69157
|
+
['application/json'],
|
|
69158
|
+
['application/json']
|
|
69159
|
+
);
|
|
69160
|
+
}
|
|
69161
|
+
|
|
69162
|
+
/**
|
|
69163
|
+
* Gets a time-off plan
|
|
69164
|
+
*
|
|
69165
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69166
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to fetch
|
|
69167
|
+
*/
|
|
69168
|
+
getWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
|
|
69169
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69170
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69171
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
|
|
69172
|
+
}
|
|
69173
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
69174
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
69175
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
|
|
69176
|
+
}
|
|
69177
|
+
|
|
69178
|
+
return this.apiClient.callApi(
|
|
69179
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
69180
|
+
'GET',
|
|
69181
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
69182
|
+
{ },
|
|
69183
|
+
{ },
|
|
69184
|
+
{ },
|
|
69185
|
+
null,
|
|
69186
|
+
['PureCloud OAuth'],
|
|
69187
|
+
['application/json'],
|
|
69188
|
+
['application/json']
|
|
69189
|
+
);
|
|
69190
|
+
}
|
|
69191
|
+
|
|
69192
|
+
/**
|
|
69193
|
+
* Gets a list of time-off plans
|
|
69194
|
+
*
|
|
69195
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69196
|
+
* @param {Object} opts Optional parameters
|
|
69197
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
69198
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
69199
|
+
*/
|
|
69200
|
+
getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
69201
|
+
opts = opts || {};
|
|
69202
|
+
|
|
69203
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69204
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69205
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';
|
|
69206
|
+
}
|
|
69207
|
+
|
|
69208
|
+
return this.apiClient.callApi(
|
|
69209
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
69210
|
+
'GET',
|
|
69211
|
+
{ 'businessUnitId': businessUnitId },
|
|
69212
|
+
{ 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
|
|
69213
|
+
{ },
|
|
69214
|
+
{ },
|
|
69215
|
+
null,
|
|
69216
|
+
['PureCloud OAuth'],
|
|
69217
|
+
['application/json'],
|
|
69218
|
+
['application/json']
|
|
69219
|
+
);
|
|
69220
|
+
}
|
|
69221
|
+
|
|
68655
69222
|
/**
|
|
68656
69223
|
* Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
|
|
68657
69224
|
*
|
|
@@ -70464,6 +71031,74 @@ class WorkforceManagementApi {
|
|
|
70464
71031
|
);
|
|
70465
71032
|
}
|
|
70466
71033
|
|
|
71034
|
+
/**
|
|
71035
|
+
* Updates a staffing group
|
|
71036
|
+
*
|
|
71037
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71038
|
+
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
71039
|
+
* @param {Object} opts Optional parameters
|
|
71040
|
+
* @param {Object} opts.body body
|
|
71041
|
+
*/
|
|
71042
|
+
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, opts) {
|
|
71043
|
+
opts = opts || {};
|
|
71044
|
+
|
|
71045
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71046
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71047
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
71048
|
+
}
|
|
71049
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
71050
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
71051
|
+
throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
71052
|
+
}
|
|
71053
|
+
|
|
71054
|
+
return this.apiClient.callApi(
|
|
71055
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
71056
|
+
'PATCH',
|
|
71057
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
71058
|
+
{ },
|
|
71059
|
+
{ },
|
|
71060
|
+
{ },
|
|
71061
|
+
opts['body'],
|
|
71062
|
+
['PureCloud OAuth'],
|
|
71063
|
+
['application/json'],
|
|
71064
|
+
['application/json']
|
|
71065
|
+
);
|
|
71066
|
+
}
|
|
71067
|
+
|
|
71068
|
+
/**
|
|
71069
|
+
* Updates a time-off plan
|
|
71070
|
+
*
|
|
71071
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71072
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
71073
|
+
* @param {Object} opts Optional parameters
|
|
71074
|
+
* @param {Object} opts.body body
|
|
71075
|
+
*/
|
|
71076
|
+
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, opts) {
|
|
71077
|
+
opts = opts || {};
|
|
71078
|
+
|
|
71079
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71080
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71081
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
71082
|
+
}
|
|
71083
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
71084
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
71085
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
71086
|
+
}
|
|
71087
|
+
|
|
71088
|
+
return this.apiClient.callApi(
|
|
71089
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
71090
|
+
'PATCH',
|
|
71091
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
71092
|
+
{ },
|
|
71093
|
+
{ },
|
|
71094
|
+
{ },
|
|
71095
|
+
opts['body'],
|
|
71096
|
+
['PureCloud OAuth'],
|
|
71097
|
+
['application/json'],
|
|
71098
|
+
['application/json']
|
|
71099
|
+
);
|
|
71100
|
+
}
|
|
71101
|
+
|
|
70467
71102
|
/**
|
|
70468
71103
|
* Update the requested management unit
|
|
70469
71104
|
*
|
|
@@ -71255,6 +71890,151 @@ class WorkforceManagementApi {
|
|
|
71255
71890
|
);
|
|
71256
71891
|
}
|
|
71257
71892
|
|
|
71893
|
+
/**
|
|
71894
|
+
* Creates a new staffing group
|
|
71895
|
+
*
|
|
71896
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71897
|
+
* @param {Object} opts Optional parameters
|
|
71898
|
+
* @param {Object} opts.body body
|
|
71899
|
+
*/
|
|
71900
|
+
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
71901
|
+
opts = opts || {};
|
|
71902
|
+
|
|
71903
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71904
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71905
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
71906
|
+
}
|
|
71907
|
+
|
|
71908
|
+
return this.apiClient.callApi(
|
|
71909
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
71910
|
+
'POST',
|
|
71911
|
+
{ 'businessUnitId': businessUnitId },
|
|
71912
|
+
{ },
|
|
71913
|
+
{ },
|
|
71914
|
+
{ },
|
|
71915
|
+
opts['body'],
|
|
71916
|
+
['PureCloud OAuth'],
|
|
71917
|
+
['application/json'],
|
|
71918
|
+
['application/json']
|
|
71919
|
+
);
|
|
71920
|
+
}
|
|
71921
|
+
|
|
71922
|
+
/**
|
|
71923
|
+
* Gets staffing group associations for a list of user IDs
|
|
71924
|
+
*
|
|
71925
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71926
|
+
* @param {Object} opts Optional parameters
|
|
71927
|
+
* @param {Object} opts.body body
|
|
71928
|
+
*/
|
|
71929
|
+
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, opts) {
|
|
71930
|
+
opts = opts || {};
|
|
71931
|
+
|
|
71932
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71933
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71934
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
71935
|
+
}
|
|
71936
|
+
|
|
71937
|
+
return this.apiClient.callApi(
|
|
71938
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
|
|
71939
|
+
'POST',
|
|
71940
|
+
{ 'businessUnitId': businessUnitId },
|
|
71941
|
+
{ },
|
|
71942
|
+
{ },
|
|
71943
|
+
{ },
|
|
71944
|
+
opts['body'],
|
|
71945
|
+
['PureCloud OAuth'],
|
|
71946
|
+
['application/json'],
|
|
71947
|
+
['application/json']
|
|
71948
|
+
);
|
|
71949
|
+
}
|
|
71950
|
+
|
|
71951
|
+
/**
|
|
71952
|
+
* Creates a new time-off limit object
|
|
71953
|
+
*
|
|
71954
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71955
|
+
* @param {Object} opts Optional parameters
|
|
71956
|
+
* @param {Object} opts.body body
|
|
71957
|
+
*/
|
|
71958
|
+
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
|
|
71959
|
+
opts = opts || {};
|
|
71960
|
+
|
|
71961
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71962
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71963
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
71964
|
+
}
|
|
71965
|
+
|
|
71966
|
+
return this.apiClient.callApi(
|
|
71967
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
71968
|
+
'POST',
|
|
71969
|
+
{ 'businessUnitId': businessUnitId },
|
|
71970
|
+
{ },
|
|
71971
|
+
{ },
|
|
71972
|
+
{ },
|
|
71973
|
+
opts['body'],
|
|
71974
|
+
['PureCloud OAuth'],
|
|
71975
|
+
['application/json'],
|
|
71976
|
+
['application/json']
|
|
71977
|
+
);
|
|
71978
|
+
}
|
|
71979
|
+
|
|
71980
|
+
/**
|
|
71981
|
+
* Retrieves time-off limit related values based on a given set of filters.
|
|
71982
|
+
*
|
|
71983
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71984
|
+
* @param {Object} opts Optional parameters
|
|
71985
|
+
* @param {Object} opts.body body
|
|
71986
|
+
*/
|
|
71987
|
+
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId, opts) {
|
|
71988
|
+
opts = opts || {};
|
|
71989
|
+
|
|
71990
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71991
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71992
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
71993
|
+
}
|
|
71994
|
+
|
|
71995
|
+
return this.apiClient.callApi(
|
|
71996
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query',
|
|
71997
|
+
'POST',
|
|
71998
|
+
{ 'businessUnitId': businessUnitId },
|
|
71999
|
+
{ },
|
|
72000
|
+
{ },
|
|
72001
|
+
{ },
|
|
72002
|
+
opts['body'],
|
|
72003
|
+
['PureCloud OAuth'],
|
|
72004
|
+
['application/json'],
|
|
72005
|
+
['application/json']
|
|
72006
|
+
);
|
|
72007
|
+
}
|
|
72008
|
+
|
|
72009
|
+
/**
|
|
72010
|
+
* Creates a new time-off plan
|
|
72011
|
+
*
|
|
72012
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72013
|
+
* @param {Object} opts Optional parameters
|
|
72014
|
+
* @param {Object} opts.body body
|
|
72015
|
+
*/
|
|
72016
|
+
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
72017
|
+
opts = opts || {};
|
|
72018
|
+
|
|
72019
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72020
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72021
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
72022
|
+
}
|
|
72023
|
+
|
|
72024
|
+
return this.apiClient.callApi(
|
|
72025
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
72026
|
+
'POST',
|
|
72027
|
+
{ 'businessUnitId': businessUnitId },
|
|
72028
|
+
{ },
|
|
72029
|
+
{ },
|
|
72030
|
+
{ },
|
|
72031
|
+
opts['body'],
|
|
72032
|
+
['PureCloud OAuth'],
|
|
72033
|
+
['application/json'],
|
|
72034
|
+
['application/json']
|
|
72035
|
+
);
|
|
72036
|
+
}
|
|
72037
|
+
|
|
71258
72038
|
/**
|
|
71259
72039
|
* Loads agent schedule data from the schedule. Used in combination with the metadata route
|
|
71260
72040
|
*
|
|
@@ -73001,6 +73781,40 @@ class WorkforceManagementApi {
|
|
|
73001
73781
|
);
|
|
73002
73782
|
}
|
|
73003
73783
|
|
|
73784
|
+
/**
|
|
73785
|
+
* Sets daily values for a date range of time-off limit object
|
|
73786
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
73787
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73788
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
73789
|
+
* @param {Object} opts Optional parameters
|
|
73790
|
+
* @param {Object} opts.body body
|
|
73791
|
+
*/
|
|
73792
|
+
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId, opts) {
|
|
73793
|
+
opts = opts || {};
|
|
73794
|
+
|
|
73795
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73796
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73797
|
+
throw 'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
73798
|
+
}
|
|
73799
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
73800
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
73801
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
73802
|
+
}
|
|
73803
|
+
|
|
73804
|
+
return this.apiClient.callApi(
|
|
73805
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
73806
|
+
'PUT',
|
|
73807
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
73808
|
+
{ },
|
|
73809
|
+
{ },
|
|
73810
|
+
{ },
|
|
73811
|
+
opts['body'],
|
|
73812
|
+
['PureCloud OAuth'],
|
|
73813
|
+
['application/json'],
|
|
73814
|
+
['application/json']
|
|
73815
|
+
);
|
|
73816
|
+
}
|
|
73817
|
+
|
|
73004
73818
|
/**
|
|
73005
73819
|
* Sets daily values for a date range of time off limit object
|
|
73006
73820
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
@@ -73066,7 +73880,7 @@ class WorkforceManagementApi {
|
|
|
73066
73880
|
* </pre>
|
|
73067
73881
|
* </p>
|
|
73068
73882
|
* @module purecloud-platform-client-v2/index
|
|
73069
|
-
* @version
|
|
73883
|
+
* @version 190.0.0
|
|
73070
73884
|
*/
|
|
73071
73885
|
class platformClient {
|
|
73072
73886
|
constructor() {
|