purecloud-platform-client-v2 191.0.0 → 192.1.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 +448 -170
- package/dist/web-amd/purecloud-platform-client-v2.js +448 -170
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +211 -128
- package/dist/web-cjs/purecloud-platform-client-v2.js +259 -163
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +528 -258
- 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 +13 -5
- 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 +127 -39
- 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 +61 -16
- 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 +45 -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 +3 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +22 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +4 -3
- 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 +3 -3
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- 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 +2 -2
- 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 +79 -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 -22
- 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 +8 -3
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -5
- 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 +5 -3
- 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 +1 -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 192.1.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 192.1.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 192.1.0
|
|
2486
2486
|
*/
|
|
2487
2487
|
|
|
2488
2488
|
/**
|
|
@@ -5256,7 +5256,7 @@ class ArchitectApi {
|
|
|
5256
5256
|
/**
|
|
5257
5257
|
* Architect service.
|
|
5258
5258
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5259
|
-
* @version
|
|
5259
|
+
* @version 192.1.0
|
|
5260
5260
|
*/
|
|
5261
5261
|
|
|
5262
5262
|
/**
|
|
@@ -9402,7 +9402,7 @@ class AuditApi {
|
|
|
9402
9402
|
/**
|
|
9403
9403
|
* Audit service.
|
|
9404
9404
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9405
|
-
* @version
|
|
9405
|
+
* @version 192.1.0
|
|
9406
9406
|
*/
|
|
9407
9407
|
|
|
9408
9408
|
/**
|
|
@@ -9573,7 +9573,7 @@ class AuthorizationApi {
|
|
|
9573
9573
|
/**
|
|
9574
9574
|
* Authorization service.
|
|
9575
9575
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9576
|
-
* @version
|
|
9576
|
+
* @version 192.1.0
|
|
9577
9577
|
*/
|
|
9578
9578
|
|
|
9579
9579
|
/**
|
|
@@ -10133,8 +10133,12 @@ class AuthorizationApi {
|
|
|
10133
10133
|
* Returns a listing of roles and permissions for a user.
|
|
10134
10134
|
*
|
|
10135
10135
|
* @param {String} subjectId Subject ID (user or group)
|
|
10136
|
+
* @param {Object} opts Optional parameters
|
|
10137
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
10136
10138
|
*/
|
|
10137
|
-
getAuthorizationSubject(subjectId) {
|
|
10139
|
+
getAuthorizationSubject(subjectId, opts) {
|
|
10140
|
+
opts = opts || {};
|
|
10141
|
+
|
|
10138
10142
|
// verify the required parameter 'subjectId' is set
|
|
10139
10143
|
if (subjectId === undefined || subjectId === null) {
|
|
10140
10144
|
throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
|
|
@@ -10144,7 +10148,7 @@ class AuthorizationApi {
|
|
|
10144
10148
|
'/api/v2/authorization/subjects/{subjectId}',
|
|
10145
10149
|
'GET',
|
|
10146
10150
|
{ 'subjectId': subjectId },
|
|
10147
|
-
{
|
|
10151
|
+
{ 'includeDuplicates': opts['includeDuplicates'] },
|
|
10148
10152
|
{ },
|
|
10149
10153
|
{ },
|
|
10150
10154
|
null,
|
|
@@ -10157,14 +10161,18 @@ class AuthorizationApi {
|
|
|
10157
10161
|
/**
|
|
10158
10162
|
* Returns a listing of roles and permissions for the currently authenticated user.
|
|
10159
10163
|
*
|
|
10164
|
+
* @param {Object} opts Optional parameters
|
|
10165
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
10160
10166
|
*/
|
|
10161
|
-
getAuthorizationSubjectsMe() {
|
|
10167
|
+
getAuthorizationSubjectsMe(opts) {
|
|
10168
|
+
opts = opts || {};
|
|
10169
|
+
|
|
10162
10170
|
|
|
10163
10171
|
return this.apiClient.callApi(
|
|
10164
10172
|
'/api/v2/authorization/subjects/me',
|
|
10165
10173
|
'GET',
|
|
10166
10174
|
{ },
|
|
10167
|
-
{
|
|
10175
|
+
{ 'includeDuplicates': opts['includeDuplicates'] },
|
|
10168
10176
|
{ },
|
|
10169
10177
|
{ },
|
|
10170
10178
|
null,
|
|
@@ -10803,7 +10811,7 @@ class BillingApi {
|
|
|
10803
10811
|
/**
|
|
10804
10812
|
* Billing service.
|
|
10805
10813
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10806
|
-
* @version
|
|
10814
|
+
* @version 192.1.0
|
|
10807
10815
|
*/
|
|
10808
10816
|
|
|
10809
10817
|
/**
|
|
@@ -10883,7 +10891,7 @@ class CarrierServicesApi {
|
|
|
10883
10891
|
/**
|
|
10884
10892
|
* CarrierServices service.
|
|
10885
10893
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10886
|
-
* @version
|
|
10894
|
+
* @version 192.1.0
|
|
10887
10895
|
*/
|
|
10888
10896
|
|
|
10889
10897
|
/**
|
|
@@ -10953,7 +10961,7 @@ class ChatApi {
|
|
|
10953
10961
|
/**
|
|
10954
10962
|
* Chat service.
|
|
10955
10963
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10956
|
-
* @version
|
|
10964
|
+
* @version 192.1.0
|
|
10957
10965
|
*/
|
|
10958
10966
|
|
|
10959
10967
|
/**
|
|
@@ -10999,25 +11007,25 @@ class ChatApi {
|
|
|
10999
11007
|
}
|
|
11000
11008
|
|
|
11001
11009
|
/**
|
|
11002
|
-
* Remove a
|
|
11010
|
+
* Remove a pinned message from a room
|
|
11003
11011
|
*
|
|
11004
11012
|
* @param {String} roomJid roomJid
|
|
11005
|
-
* @param {String}
|
|
11013
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
11006
11014
|
*/
|
|
11007
|
-
|
|
11015
|
+
deleteChatsRoomMessagesPin(roomJid, pinnedMessageId) {
|
|
11008
11016
|
// verify the required parameter 'roomJid' is set
|
|
11009
11017
|
if (roomJid === undefined || roomJid === null) {
|
|
11010
|
-
throw 'Missing the required parameter "roomJid" when calling
|
|
11018
|
+
throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';
|
|
11011
11019
|
}
|
|
11012
|
-
// verify the required parameter '
|
|
11013
|
-
if (
|
|
11014
|
-
throw 'Missing the required parameter "
|
|
11020
|
+
// verify the required parameter 'pinnedMessageId' is set
|
|
11021
|
+
if (pinnedMessageId === undefined || pinnedMessageId === null) {
|
|
11022
|
+
throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomMessagesPin';
|
|
11015
11023
|
}
|
|
11016
11024
|
|
|
11017
11025
|
return this.apiClient.callApi(
|
|
11018
|
-
'/api/v2/chats/rooms/{roomJid}/
|
|
11026
|
+
'/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}',
|
|
11019
11027
|
'DELETE',
|
|
11020
|
-
{ 'roomJid': roomJid,'
|
|
11028
|
+
{ 'roomJid': roomJid,'pinnedMessageId': pinnedMessageId },
|
|
11021
11029
|
{ },
|
|
11022
11030
|
{ },
|
|
11023
11031
|
{ },
|
|
@@ -11029,25 +11037,25 @@ class ChatApi {
|
|
|
11029
11037
|
}
|
|
11030
11038
|
|
|
11031
11039
|
/**
|
|
11032
|
-
* Remove a
|
|
11040
|
+
* Remove a user from a room.
|
|
11033
11041
|
*
|
|
11034
11042
|
* @param {String} roomJid roomJid
|
|
11035
|
-
* @param {String}
|
|
11043
|
+
* @param {String} userId userId
|
|
11036
11044
|
*/
|
|
11037
|
-
|
|
11045
|
+
deleteChatsRoomParticipant(roomJid, userId) {
|
|
11038
11046
|
// verify the required parameter 'roomJid' is set
|
|
11039
11047
|
if (roomJid === undefined || roomJid === null) {
|
|
11040
|
-
throw 'Missing the required parameter "roomJid" when calling
|
|
11048
|
+
throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';
|
|
11041
11049
|
}
|
|
11042
|
-
// verify the required parameter '
|
|
11043
|
-
if (
|
|
11044
|
-
throw 'Missing the required parameter "
|
|
11050
|
+
// verify the required parameter 'userId' is set
|
|
11051
|
+
if (userId === undefined || userId === null) {
|
|
11052
|
+
throw 'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';
|
|
11045
11053
|
}
|
|
11046
11054
|
|
|
11047
11055
|
return this.apiClient.callApi(
|
|
11048
|
-
'/api/v2/chats/rooms/{roomJid}/
|
|
11056
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{userId}',
|
|
11049
11057
|
'DELETE',
|
|
11050
|
-
{ 'roomJid': roomJid,'
|
|
11058
|
+
{ 'roomJid': roomJid,'userId': userId },
|
|
11051
11059
|
{ },
|
|
11052
11060
|
{ },
|
|
11053
11061
|
{ },
|
|
@@ -11088,6 +11096,37 @@ class ChatApi {
|
|
|
11088
11096
|
);
|
|
11089
11097
|
}
|
|
11090
11098
|
|
|
11099
|
+
/**
|
|
11100
|
+
* Remove a pinned message from a 1on1
|
|
11101
|
+
*
|
|
11102
|
+
* @param {String} userId userId
|
|
11103
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
11104
|
+
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11105
|
+
*/
|
|
11106
|
+
deleteChatsUserMessagesPin(userId, pinnedMessageId) {
|
|
11107
|
+
// verify the required parameter 'userId' is set
|
|
11108
|
+
if (userId === undefined || userId === null) {
|
|
11109
|
+
throw 'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';
|
|
11110
|
+
}
|
|
11111
|
+
// verify the required parameter 'pinnedMessageId' is set
|
|
11112
|
+
if (pinnedMessageId === undefined || pinnedMessageId === null) {
|
|
11113
|
+
throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsUserMessagesPin';
|
|
11114
|
+
}
|
|
11115
|
+
|
|
11116
|
+
return this.apiClient.callApi(
|
|
11117
|
+
'/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}',
|
|
11118
|
+
'DELETE',
|
|
11119
|
+
{ 'userId': userId,'pinnedMessageId': pinnedMessageId },
|
|
11120
|
+
{ },
|
|
11121
|
+
{ },
|
|
11122
|
+
{ },
|
|
11123
|
+
null,
|
|
11124
|
+
['PureCloud OAuth'],
|
|
11125
|
+
['application/json'],
|
|
11126
|
+
['application/json']
|
|
11127
|
+
);
|
|
11128
|
+
}
|
|
11129
|
+
|
|
11091
11130
|
/**
|
|
11092
11131
|
* Get a message
|
|
11093
11132
|
*
|
|
@@ -11305,6 +11344,32 @@ class ChatApi {
|
|
|
11305
11344
|
);
|
|
11306
11345
|
}
|
|
11307
11346
|
|
|
11347
|
+
/**
|
|
11348
|
+
* Get information for a 1on1
|
|
11349
|
+
*
|
|
11350
|
+
* @param {String} userId userId
|
|
11351
|
+
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11352
|
+
*/
|
|
11353
|
+
getChatsUser(userId) {
|
|
11354
|
+
// verify the required parameter 'userId' is set
|
|
11355
|
+
if (userId === undefined || userId === null) {
|
|
11356
|
+
throw 'Missing the required parameter "userId" when calling getChatsUser';
|
|
11357
|
+
}
|
|
11358
|
+
|
|
11359
|
+
return this.apiClient.callApi(
|
|
11360
|
+
'/api/v2/chats/users/{userId}',
|
|
11361
|
+
'GET',
|
|
11362
|
+
{ 'userId': userId },
|
|
11363
|
+
{ },
|
|
11364
|
+
{ },
|
|
11365
|
+
{ },
|
|
11366
|
+
null,
|
|
11367
|
+
['PureCloud OAuth'],
|
|
11368
|
+
['application/json'],
|
|
11369
|
+
['application/json']
|
|
11370
|
+
);
|
|
11371
|
+
}
|
|
11372
|
+
|
|
11308
11373
|
/**
|
|
11309
11374
|
* Get messages by id(s) from a 1on1
|
|
11310
11375
|
*
|
|
@@ -11579,29 +11644,29 @@ class ChatApi {
|
|
|
11579
11644
|
}
|
|
11580
11645
|
|
|
11581
11646
|
/**
|
|
11582
|
-
*
|
|
11647
|
+
* Add pinned messages for a room, up to a maximum of 5 pinned messages
|
|
11583
11648
|
*
|
|
11584
11649
|
* @param {String} roomJid roomJid
|
|
11585
|
-
* @param {
|
|
11650
|
+
* @param {Object} body Pinned Message Ids
|
|
11586
11651
|
*/
|
|
11587
|
-
|
|
11652
|
+
postChatsRoomMessagesPins(roomJid, body) {
|
|
11588
11653
|
// verify the required parameter 'roomJid' is set
|
|
11589
11654
|
if (roomJid === undefined || roomJid === null) {
|
|
11590
|
-
throw 'Missing the required parameter "roomJid" when calling
|
|
11655
|
+
throw 'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';
|
|
11591
11656
|
}
|
|
11592
|
-
// verify the required parameter '
|
|
11593
|
-
if (
|
|
11594
|
-
throw 'Missing the required parameter "
|
|
11657
|
+
// verify the required parameter 'body' is set
|
|
11658
|
+
if (body === undefined || body === null) {
|
|
11659
|
+
throw 'Missing the required parameter "body" when calling postChatsRoomMessagesPins';
|
|
11595
11660
|
}
|
|
11596
11661
|
|
|
11597
11662
|
return this.apiClient.callApi(
|
|
11598
|
-
'/api/v2/chats/rooms/{roomJid}/
|
|
11663
|
+
'/api/v2/chats/rooms/{roomJid}/messages/pins',
|
|
11599
11664
|
'POST',
|
|
11600
|
-
{ 'roomJid': roomJid
|
|
11665
|
+
{ 'roomJid': roomJid },
|
|
11601
11666
|
{ },
|
|
11602
11667
|
{ },
|
|
11603
11668
|
{ },
|
|
11604
|
-
|
|
11669
|
+
body,
|
|
11605
11670
|
['PureCloud OAuth'],
|
|
11606
11671
|
['application/json'],
|
|
11607
11672
|
['application/json']
|
|
@@ -11609,29 +11674,29 @@ class ChatApi {
|
|
|
11609
11674
|
}
|
|
11610
11675
|
|
|
11611
11676
|
/**
|
|
11612
|
-
*
|
|
11677
|
+
* Join a room
|
|
11613
11678
|
*
|
|
11614
11679
|
* @param {String} roomJid roomJid
|
|
11615
|
-
* @param {
|
|
11680
|
+
* @param {String} userId userId
|
|
11616
11681
|
*/
|
|
11617
|
-
|
|
11682
|
+
postChatsRoomParticipant(roomJid, userId) {
|
|
11618
11683
|
// verify the required parameter 'roomJid' is set
|
|
11619
11684
|
if (roomJid === undefined || roomJid === null) {
|
|
11620
|
-
throw 'Missing the required parameter "roomJid" when calling
|
|
11685
|
+
throw 'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';
|
|
11621
11686
|
}
|
|
11622
|
-
// verify the required parameter '
|
|
11623
|
-
if (
|
|
11624
|
-
throw 'Missing the required parameter "
|
|
11687
|
+
// verify the required parameter 'userId' is set
|
|
11688
|
+
if (userId === undefined || userId === null) {
|
|
11689
|
+
throw 'Missing the required parameter "userId" when calling postChatsRoomParticipant';
|
|
11625
11690
|
}
|
|
11626
11691
|
|
|
11627
11692
|
return this.apiClient.callApi(
|
|
11628
|
-
'/api/v2/chats/rooms/{roomJid}/
|
|
11693
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{userId}',
|
|
11629
11694
|
'POST',
|
|
11630
|
-
{ 'roomJid': roomJid },
|
|
11695
|
+
{ 'roomJid': roomJid,'userId': userId },
|
|
11631
11696
|
{ },
|
|
11632
11697
|
{ },
|
|
11633
11698
|
{ },
|
|
11634
|
-
|
|
11699
|
+
null,
|
|
11635
11700
|
['PureCloud OAuth'],
|
|
11636
11701
|
['application/json'],
|
|
11637
11702
|
['application/json']
|
|
@@ -11693,6 +11758,37 @@ class ChatApi {
|
|
|
11693
11758
|
);
|
|
11694
11759
|
}
|
|
11695
11760
|
|
|
11761
|
+
/**
|
|
11762
|
+
* Add pinned messages for a 1on1, up to a maximum of 5 pinned messages
|
|
11763
|
+
*
|
|
11764
|
+
* @param {String} userId userId
|
|
11765
|
+
* @param {Object} body Pinned Message Ids
|
|
11766
|
+
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11767
|
+
*/
|
|
11768
|
+
postChatsUserMessagesPins(userId, body) {
|
|
11769
|
+
// verify the required parameter 'userId' is set
|
|
11770
|
+
if (userId === undefined || userId === null) {
|
|
11771
|
+
throw 'Missing the required parameter "userId" when calling postChatsUserMessagesPins';
|
|
11772
|
+
}
|
|
11773
|
+
// verify the required parameter 'body' is set
|
|
11774
|
+
if (body === undefined || body === null) {
|
|
11775
|
+
throw 'Missing the required parameter "body" when calling postChatsUserMessagesPins';
|
|
11776
|
+
}
|
|
11777
|
+
|
|
11778
|
+
return this.apiClient.callApi(
|
|
11779
|
+
'/api/v2/chats/users/{userId}/messages/pins',
|
|
11780
|
+
'POST',
|
|
11781
|
+
{ 'userId': userId },
|
|
11782
|
+
{ },
|
|
11783
|
+
{ },
|
|
11784
|
+
{ },
|
|
11785
|
+
body,
|
|
11786
|
+
['PureCloud OAuth'],
|
|
11787
|
+
['application/json'],
|
|
11788
|
+
['application/json']
|
|
11789
|
+
);
|
|
11790
|
+
}
|
|
11791
|
+
|
|
11696
11792
|
/**
|
|
11697
11793
|
* Update reactions to a message
|
|
11698
11794
|
*
|
|
@@ -11754,7 +11850,7 @@ class CoachingApi {
|
|
|
11754
11850
|
/**
|
|
11755
11851
|
* Coaching service.
|
|
11756
11852
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11757
|
-
* @version
|
|
11853
|
+
* @version 192.1.0
|
|
11758
11854
|
*/
|
|
11759
11855
|
|
|
11760
11856
|
/**
|
|
@@ -12331,7 +12427,7 @@ class ContentManagementApi {
|
|
|
12331
12427
|
/**
|
|
12332
12428
|
* ContentManagement service.
|
|
12333
12429
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12334
|
-
* @version
|
|
12430
|
+
* @version 192.1.0
|
|
12335
12431
|
*/
|
|
12336
12432
|
|
|
12337
12433
|
/**
|
|
@@ -13413,7 +13509,7 @@ class ConversationsApi {
|
|
|
13413
13509
|
/**
|
|
13414
13510
|
* Conversations service.
|
|
13415
13511
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13416
|
-
* @version
|
|
13512
|
+
* @version 192.1.0
|
|
13417
13513
|
*/
|
|
13418
13514
|
|
|
13419
13515
|
/**
|
|
@@ -14788,12 +14884,13 @@ class ConversationsApi {
|
|
|
14788
14884
|
|
|
14789
14885
|
/**
|
|
14790
14886
|
* Get the wrap-up for this conversation communication.
|
|
14791
|
-
*
|
|
14887
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
14792
14888
|
* @param {String} conversationId conversationId
|
|
14793
14889
|
* @param {String} participantId participantId
|
|
14794
14890
|
* @param {String} communicationId communicationId
|
|
14795
14891
|
* @param {Object} opts Optional parameters
|
|
14796
14892
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
14893
|
+
* @deprecated
|
|
14797
14894
|
*/
|
|
14798
14895
|
getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
14799
14896
|
opts = opts || {};
|
|
@@ -14827,11 +14924,12 @@ class ConversationsApi {
|
|
|
14827
14924
|
|
|
14828
14925
|
/**
|
|
14829
14926
|
* Get the wrap-up for this conversation participant.
|
|
14830
|
-
*
|
|
14927
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
14831
14928
|
* @param {String} conversationId conversationId
|
|
14832
14929
|
* @param {String} participantId participantId
|
|
14833
14930
|
* @param {Object} opts Optional parameters
|
|
14834
14931
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
14932
|
+
* @deprecated
|
|
14835
14933
|
*/
|
|
14836
14934
|
getConversationsCobrowsesessionParticipantWrapup(conversationId, participantId, opts) {
|
|
14837
14935
|
opts = opts || {};
|
|
@@ -14861,9 +14959,10 @@ class ConversationsApi {
|
|
|
14861
14959
|
|
|
14862
14960
|
/**
|
|
14863
14961
|
* Get list of wrapup codes for this conversation participant
|
|
14864
|
-
*
|
|
14962
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
14865
14963
|
* @param {String} conversationId conversationId
|
|
14866
14964
|
* @param {String} participantId participantId
|
|
14965
|
+
* @deprecated
|
|
14867
14966
|
*/
|
|
14868
14967
|
getConversationsCobrowsesessionParticipantWrapupcodes(conversationId, participantId) {
|
|
14869
14968
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15989,12 +16088,13 @@ class ConversationsApi {
|
|
|
15989
16088
|
}
|
|
15990
16089
|
|
|
15991
16090
|
/**
|
|
15992
|
-
* Get a list of Messaging Stickers
|
|
15993
|
-
*
|
|
16091
|
+
* Get a list of Messaging Stickers (Deprecated)
|
|
16092
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
15994
16093
|
* @param {Object} messengerType Messenger Type
|
|
15995
16094
|
* @param {Object} opts Optional parameters
|
|
15996
16095
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15997
16096
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16097
|
+
* @deprecated
|
|
15998
16098
|
*/
|
|
15999
16099
|
getConversationsMessagingSticker(messengerType, opts) {
|
|
16000
16100
|
opts = opts || {};
|
|
@@ -16110,12 +16210,13 @@ class ConversationsApi {
|
|
|
16110
16210
|
|
|
16111
16211
|
/**
|
|
16112
16212
|
* Get the wrap-up for this conversation communication.
|
|
16113
|
-
*
|
|
16213
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
16114
16214
|
* @param {String} conversationId conversationId
|
|
16115
16215
|
* @param {String} participantId participantId
|
|
16116
16216
|
* @param {String} communicationId communicationId
|
|
16117
16217
|
* @param {Object} opts Optional parameters
|
|
16118
16218
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
16219
|
+
* @deprecated
|
|
16119
16220
|
*/
|
|
16120
16221
|
getConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
16121
16222
|
opts = opts || {};
|
|
@@ -16397,6 +16498,37 @@ class ConversationsApi {
|
|
|
16397
16498
|
);
|
|
16398
16499
|
}
|
|
16399
16500
|
|
|
16501
|
+
/**
|
|
16502
|
+
* Update the utilization label on a conversation. When there is no value provided, the system default label is applied
|
|
16503
|
+
*
|
|
16504
|
+
* @param {String} conversationId conversation ID
|
|
16505
|
+
* @param {Object} body Conversation Utilization Label
|
|
16506
|
+
* patchConversationUtilizationlabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16507
|
+
*/
|
|
16508
|
+
patchConversationUtilizationlabel(conversationId, body) {
|
|
16509
|
+
// verify the required parameter 'conversationId' is set
|
|
16510
|
+
if (conversationId === undefined || conversationId === null) {
|
|
16511
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationUtilizationlabel';
|
|
16512
|
+
}
|
|
16513
|
+
// verify the required parameter 'body' is set
|
|
16514
|
+
if (body === undefined || body === null) {
|
|
16515
|
+
throw 'Missing the required parameter "body" when calling patchConversationUtilizationlabel';
|
|
16516
|
+
}
|
|
16517
|
+
|
|
16518
|
+
return this.apiClient.callApi(
|
|
16519
|
+
'/api/v2/conversations/{conversationId}/utilizationlabel',
|
|
16520
|
+
'PATCH',
|
|
16521
|
+
{ 'conversationId': conversationId },
|
|
16522
|
+
{ },
|
|
16523
|
+
{ },
|
|
16524
|
+
{ },
|
|
16525
|
+
body,
|
|
16526
|
+
['PureCloud OAuth'],
|
|
16527
|
+
['application/json'],
|
|
16528
|
+
['application/json']
|
|
16529
|
+
);
|
|
16530
|
+
}
|
|
16531
|
+
|
|
16400
16532
|
/**
|
|
16401
16533
|
* Update after-call work for this conversation communication.
|
|
16402
16534
|
*
|
|
@@ -16919,9 +17051,10 @@ class ConversationsApi {
|
|
|
16919
17051
|
|
|
16920
17052
|
/**
|
|
16921
17053
|
* Update a conversation by disconnecting all of the participants
|
|
16922
|
-
*
|
|
17054
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
16923
17055
|
* @param {String} conversationId conversationId
|
|
16924
17056
|
* @param {Object} body Conversation
|
|
17057
|
+
* @deprecated
|
|
16925
17058
|
*/
|
|
16926
17059
|
patchConversationsCobrowsesession(conversationId, body) {
|
|
16927
17060
|
// verify the required parameter 'conversationId' is set
|
|
@@ -16949,11 +17082,12 @@ class ConversationsApi {
|
|
|
16949
17082
|
|
|
16950
17083
|
/**
|
|
16951
17084
|
* Update conversation participant
|
|
16952
|
-
*
|
|
17085
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
16953
17086
|
* @param {String} conversationId conversationId
|
|
16954
17087
|
* @param {String} participantId participantId
|
|
16955
17088
|
* @param {Object} opts Optional parameters
|
|
16956
17089
|
* @param {Object} opts.body
|
|
17090
|
+
* @deprecated
|
|
16957
17091
|
*/
|
|
16958
17092
|
patchConversationsCobrowsesessionParticipant(conversationId, participantId, opts) {
|
|
16959
17093
|
opts = opts || {};
|
|
@@ -16983,11 +17117,12 @@ class ConversationsApi {
|
|
|
16983
17117
|
|
|
16984
17118
|
/**
|
|
16985
17119
|
* Update the attributes on a conversation participant.
|
|
16986
|
-
*
|
|
17120
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
16987
17121
|
* @param {String} conversationId conversationId
|
|
16988
17122
|
* @param {String} participantId participantId
|
|
16989
17123
|
* @param {Object} opts Optional parameters
|
|
16990
17124
|
* @param {Object} opts.body
|
|
17125
|
+
* @deprecated
|
|
16991
17126
|
*/
|
|
16992
17127
|
patchConversationsCobrowsesessionParticipantAttributes(conversationId, participantId, opts) {
|
|
16993
17128
|
opts = opts || {};
|
|
@@ -17017,11 +17152,12 @@ class ConversationsApi {
|
|
|
17017
17152
|
|
|
17018
17153
|
/**
|
|
17019
17154
|
* Update conversation participant's communication by disconnecting it.
|
|
17020
|
-
*
|
|
17155
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
17021
17156
|
* @param {String} conversationId conversationId
|
|
17022
17157
|
* @param {String} participantId participantId
|
|
17023
17158
|
* @param {String} communicationId communicationId
|
|
17024
17159
|
* @param {Object} body Participant
|
|
17160
|
+
* @deprecated
|
|
17025
17161
|
*/
|
|
17026
17162
|
patchConversationsCobrowsesessionParticipantCommunication(conversationId, participantId, communicationId, body) {
|
|
17027
17163
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18879,12 +19015,13 @@ class ConversationsApi {
|
|
|
18879
19015
|
|
|
18880
19016
|
/**
|
|
18881
19017
|
* Apply wrap-up for this conversation communication
|
|
18882
|
-
*
|
|
19018
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
18883
19019
|
* @param {String} conversationId conversationId
|
|
18884
19020
|
* @param {String} participantId participantId
|
|
18885
19021
|
* @param {String} communicationId communicationId
|
|
18886
19022
|
* @param {Object} opts Optional parameters
|
|
18887
19023
|
* @param {Object} opts.body Wrap-up
|
|
19024
|
+
* @deprecated
|
|
18888
19025
|
*/
|
|
18889
19026
|
postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18890
19027
|
opts = opts || {};
|
|
@@ -18918,11 +19055,12 @@ class ConversationsApi {
|
|
|
18918
19055
|
|
|
18919
19056
|
/**
|
|
18920
19057
|
* Replace this participant with the specified user and/or address
|
|
18921
|
-
*
|
|
19058
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
18922
19059
|
* @param {String} conversationId conversationId
|
|
18923
19060
|
* @param {String} participantId participantId
|
|
18924
19061
|
* @param {Object} opts Optional parameters
|
|
18925
19062
|
* @param {Object} opts.body
|
|
19063
|
+
* @deprecated
|
|
18926
19064
|
*/
|
|
18927
19065
|
postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
|
|
18928
19066
|
opts = opts || {};
|
|
@@ -19619,8 +19757,9 @@ class ConversationsApi {
|
|
|
19619
19757
|
|
|
19620
19758
|
/**
|
|
19621
19759
|
* Send an inbound Open Message
|
|
19622
|
-
*
|
|
19760
|
+
* [This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
19623
19761
|
* @param {Object} body NormalizedMessage
|
|
19762
|
+
* @deprecated
|
|
19624
19763
|
*/
|
|
19625
19764
|
postConversationsMessagesInboundOpen(body) {
|
|
19626
19765
|
// verify the required parameter 'body' is set
|
|
@@ -19897,12 +20036,13 @@ class ConversationsApi {
|
|
|
19897
20036
|
|
|
19898
20037
|
/**
|
|
19899
20038
|
* Apply wrap-up for this conversation communication
|
|
19900
|
-
*
|
|
20039
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
19901
20040
|
* @param {String} conversationId conversationId
|
|
19902
20041
|
* @param {String} participantId participantId
|
|
19903
20042
|
* @param {String} communicationId communicationId
|
|
19904
20043
|
* @param {Object} opts Optional parameters
|
|
19905
20044
|
* @param {Object} opts.body Wrap-up
|
|
20045
|
+
* @deprecated
|
|
19906
20046
|
*/
|
|
19907
20047
|
postConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
19908
20048
|
opts = opts || {};
|
|
@@ -20516,9 +20656,10 @@ class ConversationsApi {
|
|
|
20516
20656
|
|
|
20517
20657
|
/**
|
|
20518
20658
|
* Update a conversation by setting its recording state
|
|
20519
|
-
*
|
|
20659
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20520
20660
|
* @param {String} conversationId conversationId
|
|
20521
20661
|
* @param {Object} body SetRecordingState
|
|
20662
|
+
* @deprecated
|
|
20522
20663
|
*/
|
|
20523
20664
|
putConversationsScreenshareRecordingstate(conversationId, body) {
|
|
20524
20665
|
// verify the required parameter 'conversationId' is set
|
|
@@ -20610,7 +20751,7 @@ class DataExtensionsApi {
|
|
|
20610
20751
|
/**
|
|
20611
20752
|
* DataExtensions service.
|
|
20612
20753
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20613
|
-
* @version
|
|
20754
|
+
* @version 192.1.0
|
|
20614
20755
|
*/
|
|
20615
20756
|
|
|
20616
20757
|
/**
|
|
@@ -20696,7 +20837,7 @@ class DownloadsApi {
|
|
|
20696
20837
|
/**
|
|
20697
20838
|
* Downloads service.
|
|
20698
20839
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20699
|
-
* @version
|
|
20840
|
+
* @version 192.1.0
|
|
20700
20841
|
*/
|
|
20701
20842
|
|
|
20702
20843
|
/**
|
|
@@ -20748,7 +20889,7 @@ class EmailsApi {
|
|
|
20748
20889
|
/**
|
|
20749
20890
|
* Emails service.
|
|
20750
20891
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20751
|
-
* @version
|
|
20892
|
+
* @version 192.1.0
|
|
20752
20893
|
*/
|
|
20753
20894
|
|
|
20754
20895
|
/**
|
|
@@ -20813,7 +20954,7 @@ class EventsApi {
|
|
|
20813
20954
|
/**
|
|
20814
20955
|
* Events service.
|
|
20815
20956
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20816
|
-
* @version
|
|
20957
|
+
* @version 192.1.0
|
|
20817
20958
|
*/
|
|
20818
20959
|
|
|
20819
20960
|
/**
|
|
@@ -20909,7 +21050,7 @@ class ExternalContactsApi {
|
|
|
20909
21050
|
/**
|
|
20910
21051
|
* ExternalContacts service.
|
|
20911
21052
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20912
|
-
* @version
|
|
21053
|
+
* @version 192.1.0
|
|
20913
21054
|
*/
|
|
20914
21055
|
|
|
20915
21056
|
/**
|
|
@@ -22867,7 +23008,7 @@ class FaxApi {
|
|
|
22867
23008
|
/**
|
|
22868
23009
|
* Fax service.
|
|
22869
23010
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22870
|
-
* @version
|
|
23011
|
+
* @version 192.1.0
|
|
22871
23012
|
*/
|
|
22872
23013
|
|
|
22873
23014
|
/**
|
|
@@ -22982,6 +23123,26 @@ class FaxApi {
|
|
|
22982
23123
|
);
|
|
22983
23124
|
}
|
|
22984
23125
|
|
|
23126
|
+
/**
|
|
23127
|
+
* Get organization config for given organization
|
|
23128
|
+
*
|
|
23129
|
+
*/
|
|
23130
|
+
getFaxSettings() {
|
|
23131
|
+
|
|
23132
|
+
return this.apiClient.callApi(
|
|
23133
|
+
'/api/v2/fax/settings',
|
|
23134
|
+
'GET',
|
|
23135
|
+
{ },
|
|
23136
|
+
{ },
|
|
23137
|
+
{ },
|
|
23138
|
+
{ },
|
|
23139
|
+
null,
|
|
23140
|
+
['PureCloud OAuth'],
|
|
23141
|
+
['application/json'],
|
|
23142
|
+
['application/json']
|
|
23143
|
+
);
|
|
23144
|
+
}
|
|
23145
|
+
|
|
22985
23146
|
/**
|
|
22986
23147
|
* Get fax summary
|
|
22987
23148
|
*
|
|
@@ -23032,13 +23193,37 @@ class FaxApi {
|
|
|
23032
23193
|
);
|
|
23033
23194
|
}
|
|
23034
23195
|
|
|
23196
|
+
/**
|
|
23197
|
+
* Update/write organization config for given organization
|
|
23198
|
+
*
|
|
23199
|
+
* @param {Object} opts Optional parameters
|
|
23200
|
+
* @param {Object} opts.body
|
|
23201
|
+
*/
|
|
23202
|
+
putFaxSettings(opts) {
|
|
23203
|
+
opts = opts || {};
|
|
23204
|
+
|
|
23205
|
+
|
|
23206
|
+
return this.apiClient.callApi(
|
|
23207
|
+
'/api/v2/fax/settings',
|
|
23208
|
+
'PUT',
|
|
23209
|
+
{ },
|
|
23210
|
+
{ },
|
|
23211
|
+
{ },
|
|
23212
|
+
{ },
|
|
23213
|
+
opts['body'],
|
|
23214
|
+
['PureCloud OAuth'],
|
|
23215
|
+
['application/json'],
|
|
23216
|
+
['application/json']
|
|
23217
|
+
);
|
|
23218
|
+
}
|
|
23219
|
+
|
|
23035
23220
|
}
|
|
23036
23221
|
|
|
23037
23222
|
class FlowsApi {
|
|
23038
23223
|
/**
|
|
23039
23224
|
* Flows service.
|
|
23040
23225
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23041
|
-
* @version
|
|
23226
|
+
* @version 192.1.0
|
|
23042
23227
|
*/
|
|
23043
23228
|
|
|
23044
23229
|
/**
|
|
@@ -23222,7 +23407,7 @@ class GamificationApi {
|
|
|
23222
23407
|
/**
|
|
23223
23408
|
* Gamification service.
|
|
23224
23409
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23225
|
-
* @version
|
|
23410
|
+
* @version 192.1.0
|
|
23226
23411
|
*/
|
|
23227
23412
|
|
|
23228
23413
|
/**
|
|
@@ -25308,7 +25493,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25308
25493
|
/**
|
|
25309
25494
|
* GeneralDataProtectionRegulation service.
|
|
25310
25495
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25311
|
-
* @version
|
|
25496
|
+
* @version 192.1.0
|
|
25312
25497
|
*/
|
|
25313
25498
|
|
|
25314
25499
|
/**
|
|
@@ -25438,7 +25623,7 @@ class GeolocationApi {
|
|
|
25438
25623
|
/**
|
|
25439
25624
|
* Geolocation service.
|
|
25440
25625
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25441
|
-
* @version
|
|
25626
|
+
* @version 192.1.0
|
|
25442
25627
|
*/
|
|
25443
25628
|
|
|
25444
25629
|
/**
|
|
@@ -25569,7 +25754,7 @@ class GreetingsApi {
|
|
|
25569
25754
|
/**
|
|
25570
25755
|
* Greetings service.
|
|
25571
25756
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25572
|
-
* @version
|
|
25757
|
+
* @version 192.1.0
|
|
25573
25758
|
*/
|
|
25574
25759
|
|
|
25575
25760
|
/**
|
|
@@ -26024,7 +26209,7 @@ class GroupsApi {
|
|
|
26024
26209
|
/**
|
|
26025
26210
|
* Groups service.
|
|
26026
26211
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26027
|
-
* @version
|
|
26212
|
+
* @version 192.1.0
|
|
26028
26213
|
*/
|
|
26029
26214
|
|
|
26030
26215
|
/**
|
|
@@ -26543,7 +26728,7 @@ class IdentityProviderApi {
|
|
|
26543
26728
|
/**
|
|
26544
26729
|
* IdentityProvider service.
|
|
26545
26730
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26546
|
-
* @version
|
|
26731
|
+
* @version 192.1.0
|
|
26547
26732
|
*/
|
|
26548
26733
|
|
|
26549
26734
|
/**
|
|
@@ -27404,7 +27589,7 @@ class InfrastructureAsCodeApi {
|
|
|
27404
27589
|
/**
|
|
27405
27590
|
* InfrastructureAsCode service.
|
|
27406
27591
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27407
|
-
* @version
|
|
27592
|
+
* @version 192.1.0
|
|
27408
27593
|
*/
|
|
27409
27594
|
|
|
27410
27595
|
/**
|
|
@@ -27571,7 +27756,7 @@ class IntegrationsApi {
|
|
|
27571
27756
|
/**
|
|
27572
27757
|
* Integrations service.
|
|
27573
27758
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27574
|
-
* @version
|
|
27759
|
+
* @version 192.1.0
|
|
27575
27760
|
*/
|
|
27576
27761
|
|
|
27577
27762
|
/**
|
|
@@ -28330,7 +28515,7 @@ class IntegrationsApi {
|
|
|
28330
28515
|
|
|
28331
28516
|
/**
|
|
28332
28517
|
* UC integration client application configuration.
|
|
28333
|
-
* This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
28518
|
+
* Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
28334
28519
|
* @param {Object} opts Optional parameters
|
|
28335
28520
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
28336
28521
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -28338,6 +28523,7 @@ class IntegrationsApi {
|
|
|
28338
28523
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
28339
28524
|
* @param {String} opts.nextPage next page token
|
|
28340
28525
|
* @param {String} opts.previousPage Previous page token
|
|
28526
|
+
* @deprecated
|
|
28341
28527
|
*/
|
|
28342
28528
|
getIntegrationsClientappsUnifiedcommunications(opts) {
|
|
28343
28529
|
opts = opts || {};
|
|
@@ -29922,7 +30108,7 @@ class JourneyApi {
|
|
|
29922
30108
|
/**
|
|
29923
30109
|
* Journey service.
|
|
29924
30110
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29925
|
-
* @version
|
|
30111
|
+
* @version 192.1.0
|
|
29926
30112
|
*/
|
|
29927
30113
|
|
|
29928
30114
|
/**
|
|
@@ -31276,7 +31462,6 @@ class JourneyApi {
|
|
|
31276
31462
|
*
|
|
31277
31463
|
* @param {Object} opts Optional parameters
|
|
31278
31464
|
* @param {Object} opts.body
|
|
31279
|
-
* postJourneyFlowsPathsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31280
31465
|
*/
|
|
31281
31466
|
postJourneyFlowsPathsQuery(opts) {
|
|
31282
31467
|
opts = opts || {};
|
|
@@ -31512,7 +31697,7 @@ class KnowledgeApi {
|
|
|
31512
31697
|
/**
|
|
31513
31698
|
* Knowledge service.
|
|
31514
31699
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31515
|
-
* @version
|
|
31700
|
+
* @version 192.1.0
|
|
31516
31701
|
*/
|
|
31517
31702
|
|
|
31518
31703
|
/**
|
|
@@ -34755,7 +34940,7 @@ class LanguageUnderstandingApi {
|
|
|
34755
34940
|
/**
|
|
34756
34941
|
* LanguageUnderstanding service.
|
|
34757
34942
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34758
|
-
* @version
|
|
34943
|
+
* @version 192.1.0
|
|
34759
34944
|
*/
|
|
34760
34945
|
|
|
34761
34946
|
/**
|
|
@@ -35395,6 +35580,27 @@ class LanguageUnderstandingApi {
|
|
|
35395
35580
|
);
|
|
35396
35581
|
}
|
|
35397
35582
|
|
|
35583
|
+
/**
|
|
35584
|
+
* Get Organization Configuration
|
|
35585
|
+
*
|
|
35586
|
+
* getLanguageunderstandingSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35587
|
+
*/
|
|
35588
|
+
getLanguageunderstandingSettings() {
|
|
35589
|
+
|
|
35590
|
+
return this.apiClient.callApi(
|
|
35591
|
+
'/api/v2/languageunderstanding/settings',
|
|
35592
|
+
'GET',
|
|
35593
|
+
{ },
|
|
35594
|
+
{ },
|
|
35595
|
+
{ },
|
|
35596
|
+
{ },
|
|
35597
|
+
null,
|
|
35598
|
+
['PureCloud OAuth'],
|
|
35599
|
+
['application/json'],
|
|
35600
|
+
['application/json']
|
|
35601
|
+
);
|
|
35602
|
+
}
|
|
35603
|
+
|
|
35398
35604
|
/**
|
|
35399
35605
|
* Update an NLU Domain.
|
|
35400
35606
|
*
|
|
@@ -35768,7 +35974,7 @@ class LanguagesApi {
|
|
|
35768
35974
|
/**
|
|
35769
35975
|
* Languages service.
|
|
35770
35976
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35771
|
-
* @version
|
|
35977
|
+
* @version 192.1.0
|
|
35772
35978
|
*/
|
|
35773
35979
|
|
|
35774
35980
|
/**
|
|
@@ -35990,7 +36196,7 @@ class LearningApi {
|
|
|
35990
36196
|
/**
|
|
35991
36197
|
* Learning service.
|
|
35992
36198
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35993
|
-
* @version
|
|
36199
|
+
* @version 192.1.0
|
|
35994
36200
|
*/
|
|
35995
36201
|
|
|
35996
36202
|
/**
|
|
@@ -36845,7 +37051,7 @@ class LicenseApi {
|
|
|
36845
37051
|
/**
|
|
36846
37052
|
* License service.
|
|
36847
37053
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36848
|
-
* @version
|
|
37054
|
+
* @version 192.1.0
|
|
36849
37055
|
*/
|
|
36850
37056
|
|
|
36851
37057
|
/**
|
|
@@ -37083,7 +37289,7 @@ class LocationsApi {
|
|
|
37083
37289
|
/**
|
|
37084
37290
|
* Locations service.
|
|
37085
37291
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37086
|
-
* @version
|
|
37292
|
+
* @version 192.1.0
|
|
37087
37293
|
*/
|
|
37088
37294
|
|
|
37089
37295
|
/**
|
|
@@ -37319,7 +37525,7 @@ class LogCaptureApi {
|
|
|
37319
37525
|
/**
|
|
37320
37526
|
* LogCapture service.
|
|
37321
37527
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37322
|
-
* @version
|
|
37528
|
+
* @version 192.1.0
|
|
37323
37529
|
*/
|
|
37324
37530
|
|
|
37325
37531
|
/**
|
|
@@ -37519,7 +37725,7 @@ class MessagingApi {
|
|
|
37519
37725
|
/**
|
|
37520
37726
|
* Messaging service.
|
|
37521
37727
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37522
|
-
* @version
|
|
37728
|
+
* @version 192.1.0
|
|
37523
37729
|
*/
|
|
37524
37730
|
|
|
37525
37731
|
/**
|
|
@@ -37878,7 +38084,7 @@ class MobileDevicesApi {
|
|
|
37878
38084
|
/**
|
|
37879
38085
|
* MobileDevices service.
|
|
37880
38086
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37881
|
-
* @version
|
|
38087
|
+
* @version 192.1.0
|
|
37882
38088
|
*/
|
|
37883
38089
|
|
|
37884
38090
|
/**
|
|
@@ -38029,7 +38235,7 @@ class NotificationsApi {
|
|
|
38029
38235
|
/**
|
|
38030
38236
|
* Notifications service.
|
|
38031
38237
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38032
|
-
* @version
|
|
38238
|
+
* @version 192.1.0
|
|
38033
38239
|
*/
|
|
38034
38240
|
|
|
38035
38241
|
/**
|
|
@@ -38262,7 +38468,7 @@ class OAuthApi {
|
|
|
38262
38468
|
/**
|
|
38263
38469
|
* OAuth service.
|
|
38264
38470
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38265
|
-
* @version
|
|
38471
|
+
* @version 192.1.0
|
|
38266
38472
|
*/
|
|
38267
38473
|
|
|
38268
38474
|
/**
|
|
@@ -38628,7 +38834,7 @@ class ObjectsApi {
|
|
|
38628
38834
|
/**
|
|
38629
38835
|
* Objects service.
|
|
38630
38836
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38631
|
-
* @version
|
|
38837
|
+
* @version 192.1.0
|
|
38632
38838
|
*/
|
|
38633
38839
|
|
|
38634
38840
|
/**
|
|
@@ -38898,7 +39104,7 @@ class OperationalEventsApi {
|
|
|
38898
39104
|
/**
|
|
38899
39105
|
* OperationalEvents service.
|
|
38900
39106
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38901
|
-
* @version
|
|
39107
|
+
* @version 192.1.0
|
|
38902
39108
|
*/
|
|
38903
39109
|
|
|
38904
39110
|
/**
|
|
@@ -38964,7 +39170,7 @@ class OrganizationApi {
|
|
|
38964
39170
|
/**
|
|
38965
39171
|
* Organization service.
|
|
38966
39172
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38967
|
-
* @version
|
|
39173
|
+
* @version 192.1.0
|
|
38968
39174
|
*/
|
|
38969
39175
|
|
|
38970
39176
|
/**
|
|
@@ -39419,7 +39625,7 @@ class OrganizationAuthorizationApi {
|
|
|
39419
39625
|
/**
|
|
39420
39626
|
* OrganizationAuthorization service.
|
|
39421
39627
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39422
|
-
* @version
|
|
39628
|
+
* @version 192.1.0
|
|
39423
39629
|
*/
|
|
39424
39630
|
|
|
39425
39631
|
/**
|
|
@@ -40766,7 +40972,7 @@ class OutboundApi {
|
|
|
40766
40972
|
/**
|
|
40767
40973
|
* Outbound service.
|
|
40768
40974
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40769
|
-
* @version
|
|
40975
|
+
* @version 192.1.0
|
|
40770
40976
|
*/
|
|
40771
40977
|
|
|
40772
40978
|
/**
|
|
@@ -43489,8 +43695,8 @@ class OutboundApi {
|
|
|
43489
43695
|
}
|
|
43490
43696
|
|
|
43491
43697
|
/**
|
|
43492
|
-
* Retrieves audits for dialer.
|
|
43493
|
-
*
|
|
43698
|
+
* Retrieves audits for dialer. (Deprecated)
|
|
43699
|
+
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
43494
43700
|
* @param {Object} body AuditSearch
|
|
43495
43701
|
* @param {Object} opts Optional parameters
|
|
43496
43702
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -43498,6 +43704,7 @@ class OutboundApi {
|
|
|
43498
43704
|
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
43499
43705
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
43500
43706
|
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
43707
|
+
* @deprecated
|
|
43501
43708
|
*/
|
|
43502
43709
|
postOutboundAudits(body, opts) {
|
|
43503
43710
|
opts = opts || {};
|
|
@@ -45007,7 +45214,7 @@ class PresenceApi {
|
|
|
45007
45214
|
/**
|
|
45008
45215
|
* Presence service.
|
|
45009
45216
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45010
|
-
* @version
|
|
45217
|
+
* @version 192.1.0
|
|
45011
45218
|
*/
|
|
45012
45219
|
|
|
45013
45220
|
/**
|
|
@@ -45751,7 +45958,7 @@ class ProcessAutomationApi {
|
|
|
45751
45958
|
/**
|
|
45752
45959
|
* ProcessAutomation service.
|
|
45753
45960
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45754
|
-
* @version
|
|
45961
|
+
* @version 192.1.0
|
|
45755
45962
|
*/
|
|
45756
45963
|
|
|
45757
45964
|
/**
|
|
@@ -45990,7 +46197,7 @@ class QualityApi {
|
|
|
45990
46197
|
/**
|
|
45991
46198
|
* Quality service.
|
|
45992
46199
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
45993
|
-
* @version
|
|
46200
|
+
* @version 192.1.0
|
|
45994
46201
|
*/
|
|
45995
46202
|
|
|
45996
46203
|
/**
|
|
@@ -46326,7 +46533,7 @@ class QualityApi {
|
|
|
46326
46533
|
|
|
46327
46534
|
/**
|
|
46328
46535
|
* Get the list of calibrations
|
|
46329
|
-
*
|
|
46536
|
+
* NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
|
|
46330
46537
|
* @param {String} calibratorId user id of calibrator
|
|
46331
46538
|
* @param {Object} opts Optional parameters
|
|
46332
46539
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -46478,7 +46685,7 @@ class QualityApi {
|
|
|
46478
46685
|
|
|
46479
46686
|
/**
|
|
46480
46687
|
* Queries Evaluations and returns a paged list
|
|
46481
|
-
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
46688
|
+
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch.
|
|
46482
46689
|
* @param {Object} opts Optional parameters
|
|
46483
46690
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
46484
46691
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -47747,7 +47954,7 @@ class RecordingApi {
|
|
|
47747
47954
|
/**
|
|
47748
47955
|
* Recording service.
|
|
47749
47956
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47750
|
-
* @version
|
|
47957
|
+
* @version 192.1.0
|
|
47751
47958
|
*/
|
|
47752
47959
|
|
|
47753
47960
|
/**
|
|
@@ -48660,7 +48867,6 @@ class RecordingApi {
|
|
|
48660
48867
|
/**
|
|
48661
48868
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
48662
48869
|
*
|
|
48663
|
-
* getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48664
48870
|
*/
|
|
48665
48871
|
getRecordingsScreensessionsDetails() {
|
|
48666
48872
|
|
|
@@ -49406,7 +49612,7 @@ class ResponseManagementApi {
|
|
|
49406
49612
|
/**
|
|
49407
49613
|
* ResponseManagement service.
|
|
49408
49614
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49409
|
-
* @version
|
|
49615
|
+
* @version 192.1.0
|
|
49410
49616
|
*/
|
|
49411
49617
|
|
|
49412
49618
|
/**
|
|
@@ -49916,7 +50122,7 @@ class RoutingApi {
|
|
|
49916
50122
|
/**
|
|
49917
50123
|
* Routing service.
|
|
49918
50124
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
49919
|
-
* @version
|
|
50125
|
+
* @version 192.1.0
|
|
49920
50126
|
*/
|
|
49921
50127
|
|
|
49922
50128
|
/**
|
|
@@ -53896,7 +54102,7 @@ class SCIMApi {
|
|
|
53896
54102
|
/**
|
|
53897
54103
|
* SCIM service.
|
|
53898
54104
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
53899
|
-
* @version
|
|
54105
|
+
* @version 192.1.0
|
|
53900
54106
|
*/
|
|
53901
54107
|
|
|
53902
54108
|
/**
|
|
@@ -54773,7 +54979,7 @@ class ScreenRecordingApi {
|
|
|
54773
54979
|
/**
|
|
54774
54980
|
* ScreenRecording service.
|
|
54775
54981
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54776
|
-
* @version
|
|
54982
|
+
* @version 192.1.0
|
|
54777
54983
|
*/
|
|
54778
54984
|
|
|
54779
54985
|
/**
|
|
@@ -54818,7 +55024,7 @@ class ScriptsApi {
|
|
|
54818
55024
|
/**
|
|
54819
55025
|
* Scripts service.
|
|
54820
55026
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54821
|
-
* @version
|
|
55027
|
+
* @version 192.1.0
|
|
54822
55028
|
*/
|
|
54823
55029
|
|
|
54824
55030
|
/**
|
|
@@ -55262,7 +55468,7 @@ class SearchApi {
|
|
|
55262
55468
|
/**
|
|
55263
55469
|
* Search service.
|
|
55264
55470
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55265
|
-
* @version
|
|
55471
|
+
* @version 192.1.0
|
|
55266
55472
|
*/
|
|
55267
55473
|
|
|
55268
55474
|
/**
|
|
@@ -55951,7 +56157,7 @@ class SettingsApi {
|
|
|
55951
56157
|
/**
|
|
55952
56158
|
* Settings service.
|
|
55953
56159
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
55954
|
-
* @version
|
|
56160
|
+
* @version 192.1.0
|
|
55955
56161
|
*/
|
|
55956
56162
|
|
|
55957
56163
|
/**
|
|
@@ -56063,7 +56269,7 @@ class SpeechTextAnalyticsApi {
|
|
|
56063
56269
|
/**
|
|
56064
56270
|
* SpeechTextAnalytics service.
|
|
56065
56271
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56066
|
-
* @version
|
|
56272
|
+
* @version 192.1.0
|
|
56067
56273
|
*/
|
|
56068
56274
|
|
|
56069
56275
|
/**
|
|
@@ -56653,7 +56859,7 @@ class SpeechTextAnalyticsApi {
|
|
|
56653
56859
|
*
|
|
56654
56860
|
* @param {Object} opts Optional parameters
|
|
56655
56861
|
* @param {String} opts.nextPage The key for listing the next page
|
|
56656
|
-
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
56862
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 500. (default to 20)
|
|
56657
56863
|
* @param {Object} opts.state Topic state. Defaults to latest
|
|
56658
56864
|
* @param {String} opts.name Case insensitive partial name to filter by
|
|
56659
56865
|
* @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
@@ -57177,7 +57383,7 @@ class StationsApi {
|
|
|
57177
57383
|
/**
|
|
57178
57384
|
* Stations service.
|
|
57179
57385
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57180
|
-
* @version
|
|
57386
|
+
* @version 192.1.0
|
|
57181
57387
|
*/
|
|
57182
57388
|
|
|
57183
57389
|
/**
|
|
@@ -57279,7 +57485,7 @@ class SuggestApi {
|
|
|
57279
57485
|
/**
|
|
57280
57486
|
* Suggest service.
|
|
57281
57487
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57282
|
-
* @version
|
|
57488
|
+
* @version 192.1.0
|
|
57283
57489
|
*/
|
|
57284
57490
|
|
|
57285
57491
|
/**
|
|
@@ -57418,7 +57624,7 @@ class TaskManagementApi {
|
|
|
57418
57624
|
/**
|
|
57419
57625
|
* TaskManagement service.
|
|
57420
57626
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57421
|
-
* @version
|
|
57627
|
+
* @version 192.1.0
|
|
57422
57628
|
*/
|
|
57423
57629
|
|
|
57424
57630
|
/**
|
|
@@ -57885,6 +58091,58 @@ class TaskManagementApi {
|
|
|
57885
58091
|
);
|
|
57886
58092
|
}
|
|
57887
58093
|
|
|
58094
|
+
/**
|
|
58095
|
+
* Get the workitem query job associated with the job id.
|
|
58096
|
+
*
|
|
58097
|
+
* @param {String} jobId jobId
|
|
58098
|
+
* getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58099
|
+
*/
|
|
58100
|
+
getTaskmanagementWorkitemsQueryJob(jobId) {
|
|
58101
|
+
// verify the required parameter 'jobId' is set
|
|
58102
|
+
if (jobId === undefined || jobId === null) {
|
|
58103
|
+
throw 'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJob';
|
|
58104
|
+
}
|
|
58105
|
+
|
|
58106
|
+
return this.apiClient.callApi(
|
|
58107
|
+
'/api/v2/taskmanagement/workitems/query/jobs/{jobId}',
|
|
58108
|
+
'GET',
|
|
58109
|
+
{ 'jobId': jobId },
|
|
58110
|
+
{ },
|
|
58111
|
+
{ },
|
|
58112
|
+
{ },
|
|
58113
|
+
null,
|
|
58114
|
+
['PureCloud OAuth'],
|
|
58115
|
+
['application/json'],
|
|
58116
|
+
['application/json']
|
|
58117
|
+
);
|
|
58118
|
+
}
|
|
58119
|
+
|
|
58120
|
+
/**
|
|
58121
|
+
* Get results from for workitem query job
|
|
58122
|
+
*
|
|
58123
|
+
* @param {String} jobId jobId
|
|
58124
|
+
* getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58125
|
+
*/
|
|
58126
|
+
getTaskmanagementWorkitemsQueryJobResults(jobId) {
|
|
58127
|
+
// verify the required parameter 'jobId' is set
|
|
58128
|
+
if (jobId === undefined || jobId === null) {
|
|
58129
|
+
throw 'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJobResults';
|
|
58130
|
+
}
|
|
58131
|
+
|
|
58132
|
+
return this.apiClient.callApi(
|
|
58133
|
+
'/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results',
|
|
58134
|
+
'GET',
|
|
58135
|
+
{ 'jobId': jobId },
|
|
58136
|
+
{ },
|
|
58137
|
+
{ },
|
|
58138
|
+
{ },
|
|
58139
|
+
null,
|
|
58140
|
+
['PureCloud OAuth'],
|
|
58141
|
+
['application/json'],
|
|
58142
|
+
['application/json']
|
|
58143
|
+
);
|
|
58144
|
+
}
|
|
58145
|
+
|
|
57888
58146
|
/**
|
|
57889
58147
|
* Get a schema
|
|
57890
58148
|
*
|
|
@@ -58581,6 +58839,32 @@ class TaskManagementApi {
|
|
|
58581
58839
|
);
|
|
58582
58840
|
}
|
|
58583
58841
|
|
|
58842
|
+
/**
|
|
58843
|
+
* Create a workitem query job
|
|
58844
|
+
*
|
|
58845
|
+
* @param {Object} body WorkitemQueryJobCreate
|
|
58846
|
+
* postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58847
|
+
*/
|
|
58848
|
+
postTaskmanagementWorkitemsQueryJobs(body) {
|
|
58849
|
+
// verify the required parameter 'body' is set
|
|
58850
|
+
if (body === undefined || body === null) {
|
|
58851
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQueryJobs';
|
|
58852
|
+
}
|
|
58853
|
+
|
|
58854
|
+
return this.apiClient.callApi(
|
|
58855
|
+
'/api/v2/taskmanagement/workitems/query/jobs',
|
|
58856
|
+
'POST',
|
|
58857
|
+
{ },
|
|
58858
|
+
{ },
|
|
58859
|
+
{ },
|
|
58860
|
+
{ },
|
|
58861
|
+
body,
|
|
58862
|
+
['PureCloud OAuth'],
|
|
58863
|
+
['application/json'],
|
|
58864
|
+
['application/json']
|
|
58865
|
+
);
|
|
58866
|
+
}
|
|
58867
|
+
|
|
58584
58868
|
/**
|
|
58585
58869
|
* Create a schema
|
|
58586
58870
|
*
|
|
@@ -58725,7 +59009,7 @@ class TeamsApi {
|
|
|
58725
59009
|
/**
|
|
58726
59010
|
* Teams service.
|
|
58727
59011
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
58728
|
-
* @version
|
|
59012
|
+
* @version 192.1.0
|
|
58729
59013
|
*/
|
|
58730
59014
|
|
|
58731
59015
|
/**
|
|
@@ -59027,7 +59311,7 @@ class TelephonyApi {
|
|
|
59027
59311
|
/**
|
|
59028
59312
|
* Telephony service.
|
|
59029
59313
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59030
|
-
* @version
|
|
59314
|
+
* @version 192.1.0
|
|
59031
59315
|
*/
|
|
59032
59316
|
|
|
59033
59317
|
/**
|
|
@@ -59209,7 +59493,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
59209
59493
|
/**
|
|
59210
59494
|
* TelephonyProvidersEdge service.
|
|
59211
59495
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59212
|
-
* @version
|
|
59496
|
+
* @version 192.1.0
|
|
59213
59497
|
*/
|
|
59214
59498
|
|
|
59215
59499
|
/**
|
|
@@ -59976,27 +60260,6 @@ class TelephonyProvidersEdgeApi {
|
|
|
59976
60260
|
);
|
|
59977
60261
|
}
|
|
59978
60262
|
|
|
59979
|
-
/**
|
|
59980
|
-
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
59981
|
-
*
|
|
59982
|
-
* @deprecated
|
|
59983
|
-
*/
|
|
59984
|
-
getTelephonyProvidersEdgesAvailablelanguages() {
|
|
59985
|
-
|
|
59986
|
-
return this.apiClient.callApi(
|
|
59987
|
-
'/api/v2/telephony/providers/edges/availablelanguages',
|
|
59988
|
-
'GET',
|
|
59989
|
-
{ },
|
|
59990
|
-
{ },
|
|
59991
|
-
{ },
|
|
59992
|
-
{ },
|
|
59993
|
-
null,
|
|
59994
|
-
['PureCloud OAuth'],
|
|
59995
|
-
['application/json'],
|
|
59996
|
-
['application/json']
|
|
59997
|
-
);
|
|
59998
|
-
}
|
|
59999
|
-
|
|
60000
60263
|
/**
|
|
60001
60264
|
* Get the list of certificate authorities.
|
|
60002
60265
|
*
|
|
@@ -62558,7 +62821,7 @@ class TextbotsApi {
|
|
|
62558
62821
|
/**
|
|
62559
62822
|
* Textbots service.
|
|
62560
62823
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62561
|
-
* @version
|
|
62824
|
+
* @version 192.1.0
|
|
62562
62825
|
*/
|
|
62563
62826
|
|
|
62564
62827
|
/**
|
|
@@ -62686,7 +62949,7 @@ class TokensApi {
|
|
|
62686
62949
|
/**
|
|
62687
62950
|
* Tokens service.
|
|
62688
62951
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62689
|
-
* @version
|
|
62952
|
+
* @version 192.1.0
|
|
62690
62953
|
*/
|
|
62691
62954
|
|
|
62692
62955
|
/**
|
|
@@ -62840,7 +63103,7 @@ class UploadsApi {
|
|
|
62840
63103
|
/**
|
|
62841
63104
|
* Uploads service.
|
|
62842
63105
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
62843
|
-
* @version
|
|
63106
|
+
* @version 192.1.0
|
|
62844
63107
|
*/
|
|
62845
63108
|
|
|
62846
63109
|
/**
|
|
@@ -63109,7 +63372,7 @@ class UsageApi {
|
|
|
63109
63372
|
/**
|
|
63110
63373
|
* Usage service.
|
|
63111
63374
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63112
|
-
* @version
|
|
63375
|
+
* @version 192.1.0
|
|
63113
63376
|
*/
|
|
63114
63377
|
|
|
63115
63378
|
/**
|
|
@@ -63212,8 +63475,13 @@ class UsageApi {
|
|
|
63212
63475
|
* Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
|
|
63213
63476
|
*
|
|
63214
63477
|
* @param {String} executionId ID of the search execution
|
|
63478
|
+
* @param {Object} opts Optional parameters
|
|
63479
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned
|
|
63480
|
+
* @param {Number} opts.pageSize The max number of entities to be returned per request. Maximum page size of 1000
|
|
63215
63481
|
*/
|
|
63216
|
-
getUsageSimplesearchExecutionIdResults(executionId) {
|
|
63482
|
+
getUsageSimplesearchExecutionIdResults(executionId, opts) {
|
|
63483
|
+
opts = opts || {};
|
|
63484
|
+
|
|
63217
63485
|
// verify the required parameter 'executionId' is set
|
|
63218
63486
|
if (executionId === undefined || executionId === null) {
|
|
63219
63487
|
throw 'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';
|
|
@@ -63223,7 +63491,7 @@ class UsageApi {
|
|
|
63223
63491
|
'/api/v2/usage/simplesearch/{executionId}/results',
|
|
63224
63492
|
'GET',
|
|
63225
63493
|
{ 'executionId': executionId },
|
|
63226
|
-
{
|
|
63494
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
63227
63495
|
{ },
|
|
63228
63496
|
{ },
|
|
63229
63497
|
null,
|
|
@@ -63319,7 +63587,7 @@ class UserRecordingsApi {
|
|
|
63319
63587
|
/**
|
|
63320
63588
|
* UserRecordings service.
|
|
63321
63589
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63322
|
-
* @version
|
|
63590
|
+
* @version 192.1.0
|
|
63323
63591
|
*/
|
|
63324
63592
|
|
|
63325
63593
|
/**
|
|
@@ -63504,7 +63772,7 @@ class UsersApi {
|
|
|
63504
63772
|
/**
|
|
63505
63773
|
* Users service.
|
|
63506
63774
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63507
|
-
* @version
|
|
63775
|
+
* @version 192.1.0
|
|
63508
63776
|
*/
|
|
63509
63777
|
|
|
63510
63778
|
/**
|
|
@@ -64000,8 +64268,12 @@ class UsersApi {
|
|
|
64000
64268
|
* Returns a listing of roles and permissions for a user.
|
|
64001
64269
|
*
|
|
64002
64270
|
* @param {String} subjectId Subject ID (user or group)
|
|
64271
|
+
* @param {Object} opts Optional parameters
|
|
64272
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
64003
64273
|
*/
|
|
64004
|
-
getAuthorizationSubject(subjectId) {
|
|
64274
|
+
getAuthorizationSubject(subjectId, opts) {
|
|
64275
|
+
opts = opts || {};
|
|
64276
|
+
|
|
64005
64277
|
// verify the required parameter 'subjectId' is set
|
|
64006
64278
|
if (subjectId === undefined || subjectId === null) {
|
|
64007
64279
|
throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
|
|
@@ -64011,7 +64283,7 @@ class UsersApi {
|
|
|
64011
64283
|
'/api/v2/authorization/subjects/{subjectId}',
|
|
64012
64284
|
'GET',
|
|
64013
64285
|
{ 'subjectId': subjectId },
|
|
64014
|
-
{
|
|
64286
|
+
{ 'includeDuplicates': opts['includeDuplicates'] },
|
|
64015
64287
|
{ },
|
|
64016
64288
|
{ },
|
|
64017
64289
|
null,
|
|
@@ -64024,14 +64296,18 @@ class UsersApi {
|
|
|
64024
64296
|
/**
|
|
64025
64297
|
* Returns a listing of roles and permissions for the currently authenticated user.
|
|
64026
64298
|
*
|
|
64299
|
+
* @param {Object} opts Optional parameters
|
|
64300
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
64027
64301
|
*/
|
|
64028
|
-
getAuthorizationSubjectsMe() {
|
|
64302
|
+
getAuthorizationSubjectsMe(opts) {
|
|
64303
|
+
opts = opts || {};
|
|
64304
|
+
|
|
64029
64305
|
|
|
64030
64306
|
return this.apiClient.callApi(
|
|
64031
64307
|
'/api/v2/authorization/subjects/me',
|
|
64032
64308
|
'GET',
|
|
64033
64309
|
{ },
|
|
64034
|
-
{
|
|
64310
|
+
{ 'includeDuplicates': opts['includeDuplicates'] },
|
|
64035
64311
|
{ },
|
|
64036
64312
|
{ },
|
|
64037
64313
|
null,
|
|
@@ -66155,7 +66431,7 @@ class UtilitiesApi {
|
|
|
66155
66431
|
/**
|
|
66156
66432
|
* Utilities service.
|
|
66157
66433
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66158
|
-
* @version
|
|
66434
|
+
* @version 192.1.0
|
|
66159
66435
|
*/
|
|
66160
66436
|
|
|
66161
66437
|
/**
|
|
@@ -66266,7 +66542,7 @@ class VoicemailApi {
|
|
|
66266
66542
|
/**
|
|
66267
66543
|
* Voicemail service.
|
|
66268
66544
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66269
|
-
* @version
|
|
66545
|
+
* @version 192.1.0
|
|
66270
66546
|
*/
|
|
66271
66547
|
|
|
66272
66548
|
/**
|
|
@@ -66933,7 +67209,7 @@ class WebChatApi {
|
|
|
66933
67209
|
/**
|
|
66934
67210
|
* WebChat service.
|
|
66935
67211
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
66936
|
-
* @version
|
|
67212
|
+
* @version 192.1.0
|
|
66937
67213
|
*/
|
|
66938
67214
|
|
|
66939
67215
|
/**
|
|
@@ -67073,9 +67349,10 @@ class WebChatApi {
|
|
|
67073
67349
|
|
|
67074
67350
|
/**
|
|
67075
67351
|
* Get a media request in the conversation
|
|
67076
|
-
*
|
|
67352
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
67077
67353
|
* @param {String} conversationId conversationId
|
|
67078
67354
|
* @param {String} mediaRequestId mediaRequestId
|
|
67355
|
+
* @deprecated
|
|
67079
67356
|
*/
|
|
67080
67357
|
getWebchatGuestConversationMediarequest(conversationId, mediaRequestId) {
|
|
67081
67358
|
// verify the required parameter 'conversationId' is set
|
|
@@ -67271,10 +67548,11 @@ class WebChatApi {
|
|
|
67271
67548
|
|
|
67272
67549
|
/**
|
|
67273
67550
|
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
67274
|
-
*
|
|
67551
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
67275
67552
|
* @param {String} conversationId conversationId
|
|
67276
67553
|
* @param {String} mediaRequestId mediaRequestId
|
|
67277
67554
|
* @param {Object} body Request
|
|
67555
|
+
* @deprecated
|
|
67278
67556
|
*/
|
|
67279
67557
|
patchWebchatGuestConversationMediarequest(conversationId, mediaRequestId, body) {
|
|
67280
67558
|
// verify the required parameter 'conversationId' is set
|
|
@@ -67482,7 +67760,7 @@ class WebDeploymentsApi {
|
|
|
67482
67760
|
/**
|
|
67483
67761
|
* WebDeployments service.
|
|
67484
67762
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67485
|
-
* @version
|
|
67763
|
+
* @version 192.1.0
|
|
67486
67764
|
*/
|
|
67487
67765
|
|
|
67488
67766
|
/**
|
|
@@ -68009,7 +68287,7 @@ class WebMessagingApi {
|
|
|
68009
68287
|
/**
|
|
68010
68288
|
* WebMessaging service.
|
|
68011
68289
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68012
|
-
* @version
|
|
68290
|
+
* @version 192.1.0
|
|
68013
68291
|
*/
|
|
68014
68292
|
|
|
68015
68293
|
/**
|
|
@@ -68055,7 +68333,7 @@ class WidgetsApi {
|
|
|
68055
68333
|
/**
|
|
68056
68334
|
* Widgets service.
|
|
68057
68335
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68058
|
-
* @version
|
|
68336
|
+
* @version 192.1.0
|
|
68059
68337
|
*/
|
|
68060
68338
|
|
|
68061
68339
|
/**
|
|
@@ -68201,7 +68479,7 @@ class WorkforceManagementApi {
|
|
|
68201
68479
|
/**
|
|
68202
68480
|
* WorkforceManagement service.
|
|
68203
68481
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68204
|
-
* @version
|
|
68482
|
+
* @version 192.1.0
|
|
68205
68483
|
*/
|
|
68206
68484
|
|
|
68207
68485
|
/**
|
|
@@ -74112,7 +74390,7 @@ class WorkforceManagementApi {
|
|
|
74112
74390
|
* </pre>
|
|
74113
74391
|
* </p>
|
|
74114
74392
|
* @module purecloud-platform-client-v2/index
|
|
74115
|
-
* @version
|
|
74393
|
+
* @version 192.1.0
|
|
74116
74394
|
*/
|
|
74117
74395
|
class platformClient {
|
|
74118
74396
|
constructor() {
|