purecloud-platform-client-v2 150.0.0 → 152.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 +619 -150
- package/dist/web-amd/purecloud-platform-client-v2.js +619 -150
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +619 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +619 -150
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +272 -18
- 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 +28 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +5 -4
- 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/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +49 -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/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +32 -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 -65
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +223 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +93 -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 +26 -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 +71 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -9307,7 +9307,7 @@ class Configuration {
|
|
|
9307
9307
|
|
|
9308
9308
|
/**
|
|
9309
9309
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9310
|
-
* @version
|
|
9310
|
+
* @version 152.0.0
|
|
9311
9311
|
*/
|
|
9312
9312
|
class ApiClient {
|
|
9313
9313
|
/**
|
|
@@ -10379,7 +10379,7 @@ class AlertingApi {
|
|
|
10379
10379
|
/**
|
|
10380
10380
|
* Alerting service.
|
|
10381
10381
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10382
|
-
* @version
|
|
10382
|
+
* @version 152.0.0
|
|
10383
10383
|
*/
|
|
10384
10384
|
|
|
10385
10385
|
/**
|
|
@@ -10693,7 +10693,7 @@ class AnalyticsApi {
|
|
|
10693
10693
|
/**
|
|
10694
10694
|
* Analytics service.
|
|
10695
10695
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10696
|
-
* @version
|
|
10696
|
+
* @version 152.0.0
|
|
10697
10697
|
*/
|
|
10698
10698
|
|
|
10699
10699
|
/**
|
|
@@ -10792,6 +10792,7 @@ class AnalyticsApi {
|
|
|
10792
10792
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
10793
10793
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
10794
10794
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
10795
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
10795
10796
|
*/
|
|
10796
10797
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
10797
10798
|
opts = opts || {};
|
|
@@ -10805,7 +10806,7 @@ class AnalyticsApi {
|
|
|
10805
10806
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
10806
10807
|
'GET',
|
|
10807
10808
|
{ 'botFlowId': botFlowId },
|
|
10808
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'] },
|
|
10809
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
10809
10810
|
{ },
|
|
10810
10811
|
{ },
|
|
10811
10812
|
null,
|
|
@@ -11354,6 +11355,31 @@ class AnalyticsApi {
|
|
|
11354
11355
|
);
|
|
11355
11356
|
}
|
|
11356
11357
|
|
|
11358
|
+
/**
|
|
11359
|
+
* Query for action aggregates
|
|
11360
|
+
*
|
|
11361
|
+
* @param {Object} body query
|
|
11362
|
+
*/
|
|
11363
|
+
postAnalyticsActionsAggregatesQuery(body) {
|
|
11364
|
+
// verify the required parameter 'body' is set
|
|
11365
|
+
if (body === undefined || body === null) {
|
|
11366
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
|
|
11367
|
+
}
|
|
11368
|
+
|
|
11369
|
+
return this.apiClient.callApi(
|
|
11370
|
+
'/api/v2/analytics/actions/aggregates/query',
|
|
11371
|
+
'POST',
|
|
11372
|
+
{ },
|
|
11373
|
+
{ },
|
|
11374
|
+
{ },
|
|
11375
|
+
{ },
|
|
11376
|
+
body,
|
|
11377
|
+
['PureCloud OAuth'],
|
|
11378
|
+
['application/json'],
|
|
11379
|
+
['application/json']
|
|
11380
|
+
);
|
|
11381
|
+
}
|
|
11382
|
+
|
|
11357
11383
|
/**
|
|
11358
11384
|
* Query for bot aggregates
|
|
11359
11385
|
*
|
|
@@ -11920,7 +11946,7 @@ class ArchitectApi {
|
|
|
11920
11946
|
/**
|
|
11921
11947
|
* Architect service.
|
|
11922
11948
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
11923
|
-
* @version
|
|
11949
|
+
* @version 152.0.0
|
|
11924
11950
|
*/
|
|
11925
11951
|
|
|
11926
11952
|
/**
|
|
@@ -13513,6 +13539,7 @@ class ArchitectApi {
|
|
|
13513
13539
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13514
13540
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13515
13541
|
* @param {Boolean} opts.showbrief If true returns just the key value of the row (default to true)
|
|
13542
|
+
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
13516
13543
|
*/
|
|
13517
13544
|
getFlowsDatatableRows(datatableId, opts) {
|
|
13518
13545
|
opts = opts || {};
|
|
@@ -13526,7 +13553,7 @@ class ArchitectApi {
|
|
|
13526
13553
|
'/api/v2/flows/datatables/{datatableId}/rows',
|
|
13527
13554
|
'GET',
|
|
13528
13555
|
{ 'datatableId': datatableId },
|
|
13529
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'] },
|
|
13556
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'],'sortOrder': opts['sortOrder'] },
|
|
13530
13557
|
{ },
|
|
13531
13558
|
{ },
|
|
13532
13559
|
null,
|
|
@@ -13546,7 +13573,7 @@ class ArchitectApi {
|
|
|
13546
13573
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
13547
13574
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
13548
13575
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
13549
|
-
* @param {String} opts.name Name
|
|
13576
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
13550
13577
|
*/
|
|
13551
13578
|
getFlowsDatatables(opts) {
|
|
13552
13579
|
opts = opts || {};
|
|
@@ -13605,7 +13632,7 @@ class ArchitectApi {
|
|
|
13605
13632
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
13606
13633
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
13607
13634
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
13608
|
-
* @param {String} opts.name Name
|
|
13635
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
13609
13636
|
*/
|
|
13610
13637
|
getFlowsDatatablesDivisionviews(opts) {
|
|
13611
13638
|
opts = opts || {};
|
|
@@ -14966,7 +14993,7 @@ class AuditApi {
|
|
|
14966
14993
|
/**
|
|
14967
14994
|
* Audit service.
|
|
14968
14995
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14969
|
-
* @version
|
|
14996
|
+
* @version 152.0.0
|
|
14970
14997
|
*/
|
|
14971
14998
|
|
|
14972
14999
|
/**
|
|
@@ -15137,7 +15164,7 @@ class AuthorizationApi {
|
|
|
15137
15164
|
/**
|
|
15138
15165
|
* Authorization service.
|
|
15139
15166
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15140
|
-
* @version
|
|
15167
|
+
* @version 152.0.0
|
|
15141
15168
|
*/
|
|
15142
15169
|
|
|
15143
15170
|
/**
|
|
@@ -16320,7 +16347,7 @@ class BillingApi {
|
|
|
16320
16347
|
/**
|
|
16321
16348
|
* Billing service.
|
|
16322
16349
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16323
|
-
* @version
|
|
16350
|
+
* @version 152.0.0
|
|
16324
16351
|
*/
|
|
16325
16352
|
|
|
16326
16353
|
/**
|
|
@@ -16400,7 +16427,7 @@ class ChatApi {
|
|
|
16400
16427
|
/**
|
|
16401
16428
|
* Chat service.
|
|
16402
16429
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16403
|
-
* @version
|
|
16430
|
+
* @version 152.0.0
|
|
16404
16431
|
*/
|
|
16405
16432
|
|
|
16406
16433
|
/**
|
|
@@ -16491,7 +16518,7 @@ class CoachingApi {
|
|
|
16491
16518
|
/**
|
|
16492
16519
|
* Coaching service.
|
|
16493
16520
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16494
|
-
* @version
|
|
16521
|
+
* @version 152.0.0
|
|
16495
16522
|
*/
|
|
16496
16523
|
|
|
16497
16524
|
/**
|
|
@@ -17068,7 +17095,7 @@ class ContentManagementApi {
|
|
|
17068
17095
|
/**
|
|
17069
17096
|
* ContentManagement service.
|
|
17070
17097
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17071
|
-
* @version
|
|
17098
|
+
* @version 152.0.0
|
|
17072
17099
|
*/
|
|
17073
17100
|
|
|
17074
17101
|
/**
|
|
@@ -18208,7 +18235,7 @@ class ConversationsApi {
|
|
|
18208
18235
|
/**
|
|
18209
18236
|
* Conversations service.
|
|
18210
18237
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18211
|
-
* @version
|
|
18238
|
+
* @version 152.0.0
|
|
18212
18239
|
*/
|
|
18213
18240
|
|
|
18214
18241
|
/**
|
|
@@ -19887,8 +19914,9 @@ class ConversationsApi {
|
|
|
19887
19914
|
* @param {Object} opts Optional parameters
|
|
19888
19915
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19889
19916
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19890
|
-
* @param {
|
|
19917
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value.
|
|
19891
19918
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
19919
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
19892
19920
|
*/
|
|
19893
19921
|
getConversationsMessagingIntegrations(opts) {
|
|
19894
19922
|
opts = opts || {};
|
|
@@ -19898,7 +19926,7 @@ class ConversationsApi {
|
|
|
19898
19926
|
'/api/v2/conversations/messaging/integrations',
|
|
19899
19927
|
'GET',
|
|
19900
19928
|
{ },
|
|
19901
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
19929
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
19902
19930
|
{ },
|
|
19903
19931
|
{ },
|
|
19904
19932
|
null,
|
|
@@ -19916,6 +19944,7 @@ class ConversationsApi {
|
|
|
19916
19944
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19917
19945
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
19918
19946
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
19947
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
19919
19948
|
*/
|
|
19920
19949
|
getConversationsMessagingIntegrationsFacebook(opts) {
|
|
19921
19950
|
opts = opts || {};
|
|
@@ -19925,7 +19954,7 @@ class ConversationsApi {
|
|
|
19925
19954
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
19926
19955
|
'GET',
|
|
19927
19956
|
{ },
|
|
19928
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
19957
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
19929
19958
|
{ },
|
|
19930
19959
|
{ },
|
|
19931
19960
|
null,
|
|
@@ -19972,6 +20001,7 @@ class ConversationsApi {
|
|
|
19972
20001
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19973
20002
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
19974
20003
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
20004
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
19975
20005
|
*/
|
|
19976
20006
|
getConversationsMessagingIntegrationsLine(opts) {
|
|
19977
20007
|
opts = opts || {};
|
|
@@ -19981,7 +20011,7 @@ class ConversationsApi {
|
|
|
19981
20011
|
'/api/v2/conversations/messaging/integrations/line',
|
|
19982
20012
|
'GET',
|
|
19983
20013
|
{ },
|
|
19984
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20014
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
19985
20015
|
{ },
|
|
19986
20016
|
{ },
|
|
19987
20017
|
null,
|
|
@@ -20028,6 +20058,7 @@ class ConversationsApi {
|
|
|
20028
20058
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20029
20059
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
20030
20060
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
20061
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
20031
20062
|
*/
|
|
20032
20063
|
getConversationsMessagingIntegrationsOpen(opts) {
|
|
20033
20064
|
opts = opts || {};
|
|
@@ -20037,7 +20068,7 @@ class ConversationsApi {
|
|
|
20037
20068
|
'/api/v2/conversations/messaging/integrations/open',
|
|
20038
20069
|
'GET',
|
|
20039
20070
|
{ },
|
|
20040
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20071
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
20041
20072
|
{ },
|
|
20042
20073
|
{ },
|
|
20043
20074
|
null,
|
|
@@ -20084,6 +20115,7 @@ class ConversationsApi {
|
|
|
20084
20115
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20085
20116
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
20086
20117
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
20118
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
20087
20119
|
*/
|
|
20088
20120
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
20089
20121
|
opts = opts || {};
|
|
@@ -20093,7 +20125,7 @@ class ConversationsApi {
|
|
|
20093
20125
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
20094
20126
|
'GET',
|
|
20095
20127
|
{ },
|
|
20096
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20128
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
20097
20129
|
{ },
|
|
20098
20130
|
{ },
|
|
20099
20131
|
null,
|
|
@@ -20140,6 +20172,7 @@ class ConversationsApi {
|
|
|
20140
20172
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20141
20173
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
20142
20174
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
20175
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
20143
20176
|
*/
|
|
20144
20177
|
getConversationsMessagingIntegrationsWhatsapp(opts) {
|
|
20145
20178
|
opts = opts || {};
|
|
@@ -20149,7 +20182,7 @@ class ConversationsApi {
|
|
|
20149
20182
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
20150
20183
|
'GET',
|
|
20151
20184
|
{ },
|
|
20152
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20185
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
20153
20186
|
{ },
|
|
20154
20187
|
{ },
|
|
20155
20188
|
null,
|
|
@@ -22554,6 +22587,41 @@ class ConversationsApi {
|
|
|
22554
22587
|
);
|
|
22555
22588
|
}
|
|
22556
22589
|
|
|
22590
|
+
/**
|
|
22591
|
+
* Send message typing event
|
|
22592
|
+
* Send message typing event for existing conversation/communication.
|
|
22593
|
+
* @param {String} conversationId conversationId
|
|
22594
|
+
* @param {String} communicationId communicationId
|
|
22595
|
+
* @param {Object} body MessageTypingEvent
|
|
22596
|
+
*/
|
|
22597
|
+
postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
|
|
22598
|
+
// verify the required parameter 'conversationId' is set
|
|
22599
|
+
if (conversationId === undefined || conversationId === null) {
|
|
22600
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
|
|
22601
|
+
}
|
|
22602
|
+
// verify the required parameter 'communicationId' is set
|
|
22603
|
+
if (communicationId === undefined || communicationId === null) {
|
|
22604
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
|
|
22605
|
+
}
|
|
22606
|
+
// verify the required parameter 'body' is set
|
|
22607
|
+
if (body === undefined || body === null) {
|
|
22608
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
|
|
22609
|
+
}
|
|
22610
|
+
|
|
22611
|
+
return this.apiClient.callApi(
|
|
22612
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
|
|
22613
|
+
'POST',
|
|
22614
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
22615
|
+
{ },
|
|
22616
|
+
{ },
|
|
22617
|
+
{ },
|
|
22618
|
+
body,
|
|
22619
|
+
['PureCloud OAuth'],
|
|
22620
|
+
['application/json'],
|
|
22621
|
+
['application/json']
|
|
22622
|
+
);
|
|
22623
|
+
}
|
|
22624
|
+
|
|
22557
22625
|
/**
|
|
22558
22626
|
* Get messages in batch
|
|
22559
22627
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
@@ -23390,7 +23458,7 @@ class DataExtensionsApi {
|
|
|
23390
23458
|
/**
|
|
23391
23459
|
* DataExtensions service.
|
|
23392
23460
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23393
|
-
* @version
|
|
23461
|
+
* @version 152.0.0
|
|
23394
23462
|
*/
|
|
23395
23463
|
|
|
23396
23464
|
/**
|
|
@@ -23476,7 +23544,7 @@ class DownloadsApi {
|
|
|
23476
23544
|
/**
|
|
23477
23545
|
* Downloads service.
|
|
23478
23546
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
23479
|
-
* @version
|
|
23547
|
+
* @version 152.0.0
|
|
23480
23548
|
*/
|
|
23481
23549
|
|
|
23482
23550
|
/**
|
|
@@ -23528,7 +23596,7 @@ class EventsApi {
|
|
|
23528
23596
|
/**
|
|
23529
23597
|
* Events service.
|
|
23530
23598
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23531
|
-
* @version
|
|
23599
|
+
* @version 152.0.0
|
|
23532
23600
|
*/
|
|
23533
23601
|
|
|
23534
23602
|
/**
|
|
@@ -23624,7 +23692,7 @@ class ExternalContactsApi {
|
|
|
23624
23692
|
/**
|
|
23625
23693
|
* ExternalContacts service.
|
|
23626
23694
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23627
|
-
* @version
|
|
23695
|
+
* @version 152.0.0
|
|
23628
23696
|
*/
|
|
23629
23697
|
|
|
23630
23698
|
/**
|
|
@@ -23878,6 +23946,37 @@ class ExternalContactsApi {
|
|
|
23878
23946
|
);
|
|
23879
23947
|
}
|
|
23880
23948
|
|
|
23949
|
+
/**
|
|
23950
|
+
* Retrieve all sessions for a given external contact.
|
|
23951
|
+
*
|
|
23952
|
+
* @param {String} contactId ExternalContact ID
|
|
23953
|
+
* @param {Object} opts Optional parameters
|
|
23954
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23955
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23956
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
23957
|
+
*/
|
|
23958
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
23959
|
+
opts = opts || {};
|
|
23960
|
+
|
|
23961
|
+
// verify the required parameter 'contactId' is set
|
|
23962
|
+
if (contactId === undefined || contactId === null) {
|
|
23963
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
23964
|
+
}
|
|
23965
|
+
|
|
23966
|
+
return this.apiClient.callApi(
|
|
23967
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
23968
|
+
'GET',
|
|
23969
|
+
{ 'contactId': contactId },
|
|
23970
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
23971
|
+
{ },
|
|
23972
|
+
{ },
|
|
23973
|
+
null,
|
|
23974
|
+
['PureCloud OAuth'],
|
|
23975
|
+
['application/json'],
|
|
23976
|
+
['application/json']
|
|
23977
|
+
);
|
|
23978
|
+
}
|
|
23979
|
+
|
|
23881
23980
|
/**
|
|
23882
23981
|
* Fetch a note for an external contact
|
|
23883
23982
|
*
|
|
@@ -25551,7 +25650,7 @@ class FaxApi {
|
|
|
25551
25650
|
/**
|
|
25552
25651
|
* Fax service.
|
|
25553
25652
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25554
|
-
* @version
|
|
25653
|
+
* @version 152.0.0
|
|
25555
25654
|
*/
|
|
25556
25655
|
|
|
25557
25656
|
/**
|
|
@@ -25722,7 +25821,7 @@ class FlowsApi {
|
|
|
25722
25821
|
/**
|
|
25723
25822
|
* Flows service.
|
|
25724
25823
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25725
|
-
* @version
|
|
25824
|
+
* @version 152.0.0
|
|
25726
25825
|
*/
|
|
25727
25826
|
|
|
25728
25827
|
/**
|
|
@@ -25793,7 +25892,7 @@ class GamificationApi {
|
|
|
25793
25892
|
/**
|
|
25794
25893
|
* Gamification service.
|
|
25795
25894
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25796
|
-
* @version
|
|
25895
|
+
* @version 152.0.0
|
|
25797
25896
|
*/
|
|
25798
25897
|
|
|
25799
25898
|
/**
|
|
@@ -26011,36 +26110,6 @@ class GamificationApi {
|
|
|
26011
26110
|
);
|
|
26012
26111
|
}
|
|
26013
26112
|
|
|
26014
|
-
/**
|
|
26015
|
-
* Gamified metric by id
|
|
26016
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
26017
|
-
* @param {String} metricId metric Id
|
|
26018
|
-
* @param {Object} opts Optional parameters
|
|
26019
|
-
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
26020
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
26021
|
-
*/
|
|
26022
|
-
getGamificationMetric(metricId, opts) {
|
|
26023
|
-
opts = opts || {};
|
|
26024
|
-
|
|
26025
|
-
// verify the required parameter 'metricId' is set
|
|
26026
|
-
if (metricId === undefined || metricId === null) {
|
|
26027
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
26028
|
-
}
|
|
26029
|
-
|
|
26030
|
-
return this.apiClient.callApi(
|
|
26031
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
26032
|
-
'GET',
|
|
26033
|
-
{ 'metricId': metricId },
|
|
26034
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
26035
|
-
{ },
|
|
26036
|
-
{ },
|
|
26037
|
-
null,
|
|
26038
|
-
['PureCloud OAuth'],
|
|
26039
|
-
['application/json'],
|
|
26040
|
-
['application/json']
|
|
26041
|
-
);
|
|
26042
|
-
}
|
|
26043
|
-
|
|
26044
26113
|
/**
|
|
26045
26114
|
* Metric definition by id
|
|
26046
26115
|
*
|
|
@@ -27345,40 +27414,6 @@ class GamificationApi {
|
|
|
27345
27414
|
);
|
|
27346
27415
|
}
|
|
27347
27416
|
|
|
27348
|
-
/**
|
|
27349
|
-
* Updates a metric
|
|
27350
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
27351
|
-
* @param {String} metricId metric Id
|
|
27352
|
-
* @param {Object} body Metric
|
|
27353
|
-
* @param {Object} opts Optional parameters
|
|
27354
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
27355
|
-
*/
|
|
27356
|
-
putGamificationMetric(metricId, body, opts) {
|
|
27357
|
-
opts = opts || {};
|
|
27358
|
-
|
|
27359
|
-
// verify the required parameter 'metricId' is set
|
|
27360
|
-
if (metricId === undefined || metricId === null) {
|
|
27361
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
27362
|
-
}
|
|
27363
|
-
// verify the required parameter 'body' is set
|
|
27364
|
-
if (body === undefined || body === null) {
|
|
27365
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
27366
|
-
}
|
|
27367
|
-
|
|
27368
|
-
return this.apiClient.callApi(
|
|
27369
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
27370
|
-
'PUT',
|
|
27371
|
-
{ 'metricId': metricId },
|
|
27372
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
27373
|
-
{ },
|
|
27374
|
-
{ },
|
|
27375
|
-
body,
|
|
27376
|
-
['PureCloud OAuth'],
|
|
27377
|
-
['application/json'],
|
|
27378
|
-
['application/json']
|
|
27379
|
-
);
|
|
27380
|
-
}
|
|
27381
|
-
|
|
27382
27417
|
/**
|
|
27383
27418
|
* Updates a performance profile
|
|
27384
27419
|
*
|
|
@@ -27474,7 +27509,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
27474
27509
|
/**
|
|
27475
27510
|
* GeneralDataProtectionRegulation service.
|
|
27476
27511
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27477
|
-
* @version
|
|
27512
|
+
* @version 152.0.0
|
|
27478
27513
|
*/
|
|
27479
27514
|
|
|
27480
27515
|
/**
|
|
@@ -27604,7 +27639,7 @@ class GeolocationApi {
|
|
|
27604
27639
|
/**
|
|
27605
27640
|
* Geolocation service.
|
|
27606
27641
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27607
|
-
* @version
|
|
27642
|
+
* @version 152.0.0
|
|
27608
27643
|
*/
|
|
27609
27644
|
|
|
27610
27645
|
/**
|
|
@@ -27735,7 +27770,7 @@ class GreetingsApi {
|
|
|
27735
27770
|
/**
|
|
27736
27771
|
* Greetings service.
|
|
27737
27772
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27738
|
-
* @version
|
|
27773
|
+
* @version 152.0.0
|
|
27739
27774
|
*/
|
|
27740
27775
|
|
|
27741
27776
|
/**
|
|
@@ -28190,7 +28225,7 @@ class GroupsApi {
|
|
|
28190
28225
|
/**
|
|
28191
28226
|
* Groups service.
|
|
28192
28227
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28193
|
-
* @version
|
|
28228
|
+
* @version 152.0.0
|
|
28194
28229
|
*/
|
|
28195
28230
|
|
|
28196
28231
|
/**
|
|
@@ -28596,7 +28631,7 @@ class IdentityProviderApi {
|
|
|
28596
28631
|
/**
|
|
28597
28632
|
* IdentityProvider service.
|
|
28598
28633
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28599
|
-
* @version
|
|
28634
|
+
* @version 152.0.0
|
|
28600
28635
|
*/
|
|
28601
28636
|
|
|
28602
28637
|
/**
|
|
@@ -29352,7 +29387,7 @@ class IntegrationsApi {
|
|
|
29352
29387
|
/**
|
|
29353
29388
|
* Integrations service.
|
|
29354
29389
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29355
|
-
* @version
|
|
29390
|
+
* @version 152.0.0
|
|
29356
29391
|
*/
|
|
29357
29392
|
|
|
29358
29393
|
/**
|
|
@@ -30952,7 +30987,7 @@ class JourneyApi {
|
|
|
30952
30987
|
/**
|
|
30953
30988
|
* Journey service.
|
|
30954
30989
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30955
|
-
* @version
|
|
30990
|
+
* @version 152.0.0
|
|
30956
30991
|
*/
|
|
30957
30992
|
|
|
30958
30993
|
/**
|
|
@@ -31738,7 +31773,7 @@ class KnowledgeApi {
|
|
|
31738
31773
|
/**
|
|
31739
31774
|
* Knowledge service.
|
|
31740
31775
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31741
|
-
* @version
|
|
31776
|
+
* @version 152.0.0
|
|
31742
31777
|
*/
|
|
31743
31778
|
|
|
31744
31779
|
/**
|
|
@@ -32141,8 +32176,8 @@ class KnowledgeApi {
|
|
|
32141
32176
|
* @param {String} sessionId Knowledge guest session ID.
|
|
32142
32177
|
* @param {Object} opts Optional parameters
|
|
32143
32178
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
32144
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
32145
|
-
* @param {
|
|
32179
|
+
* @param {Boolean} opts.includeSubcategories Deprecated - Do Not Use. Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
32180
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
32146
32181
|
*/
|
|
32147
32182
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
32148
32183
|
opts = opts || {};
|
|
@@ -34171,7 +34206,7 @@ class LanguageUnderstandingApi {
|
|
|
34171
34206
|
/**
|
|
34172
34207
|
* LanguageUnderstanding service.
|
|
34173
34208
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34174
|
-
* @version
|
|
34209
|
+
* @version 152.0.0
|
|
34175
34210
|
*/
|
|
34176
34211
|
|
|
34177
34212
|
/**
|
|
@@ -35075,7 +35110,7 @@ class LanguagesApi {
|
|
|
35075
35110
|
/**
|
|
35076
35111
|
* Languages service.
|
|
35077
35112
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35078
|
-
* @version
|
|
35113
|
+
* @version 152.0.0
|
|
35079
35114
|
*/
|
|
35080
35115
|
|
|
35081
35116
|
/**
|
|
@@ -35343,7 +35378,7 @@ class LearningApi {
|
|
|
35343
35378
|
/**
|
|
35344
35379
|
* Learning service.
|
|
35345
35380
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35346
|
-
* @version
|
|
35381
|
+
* @version 152.0.0
|
|
35347
35382
|
*/
|
|
35348
35383
|
|
|
35349
35384
|
/**
|
|
@@ -36103,7 +36138,7 @@ class LicenseApi {
|
|
|
36103
36138
|
/**
|
|
36104
36139
|
* License service.
|
|
36105
36140
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36106
|
-
* @version
|
|
36141
|
+
* @version 152.0.0
|
|
36107
36142
|
*/
|
|
36108
36143
|
|
|
36109
36144
|
/**
|
|
@@ -36341,7 +36376,7 @@ class LocationsApi {
|
|
|
36341
36376
|
/**
|
|
36342
36377
|
* Locations service.
|
|
36343
36378
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36344
|
-
* @version
|
|
36379
|
+
* @version 152.0.0
|
|
36345
36380
|
*/
|
|
36346
36381
|
|
|
36347
36382
|
/**
|
|
@@ -36577,7 +36612,7 @@ class MessagingApi {
|
|
|
36577
36612
|
/**
|
|
36578
36613
|
* Messaging service.
|
|
36579
36614
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
36580
|
-
* @version
|
|
36615
|
+
* @version 152.0.0
|
|
36581
36616
|
*/
|
|
36582
36617
|
|
|
36583
36618
|
/**
|
|
@@ -36728,7 +36763,7 @@ class MobileDevicesApi {
|
|
|
36728
36763
|
/**
|
|
36729
36764
|
* MobileDevices service.
|
|
36730
36765
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
36731
|
-
* @version
|
|
36766
|
+
* @version 152.0.0
|
|
36732
36767
|
*/
|
|
36733
36768
|
|
|
36734
36769
|
/**
|
|
@@ -36879,7 +36914,7 @@ class NotificationsApi {
|
|
|
36879
36914
|
/**
|
|
36880
36915
|
* Notifications service.
|
|
36881
36916
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
36882
|
-
* @version
|
|
36917
|
+
* @version 152.0.0
|
|
36883
36918
|
*/
|
|
36884
36919
|
|
|
36885
36920
|
/**
|
|
@@ -37104,7 +37139,7 @@ class OAuthApi {
|
|
|
37104
37139
|
/**
|
|
37105
37140
|
* OAuth service.
|
|
37106
37141
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37107
|
-
* @version
|
|
37142
|
+
* @version 152.0.0
|
|
37108
37143
|
*/
|
|
37109
37144
|
|
|
37110
37145
|
/**
|
|
@@ -37470,7 +37505,7 @@ class ObjectsApi {
|
|
|
37470
37505
|
/**
|
|
37471
37506
|
* Objects service.
|
|
37472
37507
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
37473
|
-
* @version
|
|
37508
|
+
* @version 152.0.0
|
|
37474
37509
|
*/
|
|
37475
37510
|
|
|
37476
37511
|
/**
|
|
@@ -37741,7 +37776,7 @@ class OrganizationApi {
|
|
|
37741
37776
|
/**
|
|
37742
37777
|
* Organization service.
|
|
37743
37778
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
37744
|
-
* @version
|
|
37779
|
+
* @version 152.0.0
|
|
37745
37780
|
*/
|
|
37746
37781
|
|
|
37747
37782
|
/**
|
|
@@ -38144,7 +38179,7 @@ class OrganizationAuthorizationApi {
|
|
|
38144
38179
|
/**
|
|
38145
38180
|
* OrganizationAuthorization service.
|
|
38146
38181
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38147
|
-
* @version
|
|
38182
|
+
* @version 152.0.0
|
|
38148
38183
|
*/
|
|
38149
38184
|
|
|
38150
38185
|
/**
|
|
@@ -39069,7 +39104,7 @@ class OutboundApi {
|
|
|
39069
39104
|
/**
|
|
39070
39105
|
* Outbound service.
|
|
39071
39106
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
39072
|
-
* @version
|
|
39107
|
+
* @version 152.0.0
|
|
39073
39108
|
*/
|
|
39074
39109
|
|
|
39075
39110
|
/**
|
|
@@ -42458,7 +42493,7 @@ class PresenceApi {
|
|
|
42458
42493
|
/**
|
|
42459
42494
|
* Presence service.
|
|
42460
42495
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42461
|
-
* @version
|
|
42496
|
+
* @version 152.0.0
|
|
42462
42497
|
*/
|
|
42463
42498
|
|
|
42464
42499
|
/**
|
|
@@ -42552,7 +42587,7 @@ class PresenceApi {
|
|
|
42552
42587
|
* Get a list of Presence Sources
|
|
42553
42588
|
*
|
|
42554
42589
|
* @param {Object} opts Optional parameters
|
|
42555
|
-
* @param {String} opts.
|
|
42590
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
42556
42591
|
*/
|
|
42557
42592
|
getPresenceSources(opts) {
|
|
42558
42593
|
opts = opts || {};
|
|
@@ -42562,7 +42597,7 @@ class PresenceApi {
|
|
|
42562
42597
|
'/api/v2/presence/sources',
|
|
42563
42598
|
'GET',
|
|
42564
42599
|
{ },
|
|
42565
|
-
{ '
|
|
42600
|
+
{ 'deactivated': opts['deactivated'] },
|
|
42566
42601
|
{ },
|
|
42567
42602
|
{ },
|
|
42568
42603
|
null,
|
|
@@ -42964,7 +42999,7 @@ class ProcessAutomationApi {
|
|
|
42964
42999
|
/**
|
|
42965
43000
|
* ProcessAutomation service.
|
|
42966
43001
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
42967
|
-
* @version
|
|
43002
|
+
* @version 152.0.0
|
|
42968
43003
|
*/
|
|
42969
43004
|
|
|
42970
43005
|
/**
|
|
@@ -43005,7 +43040,7 @@ class ProcessAutomationApi {
|
|
|
43005
43040
|
}
|
|
43006
43041
|
|
|
43007
43042
|
/**
|
|
43008
|
-
* Retrieve a single Trigger matching id
|
|
43043
|
+
* Retrieve a single Trigger matching id
|
|
43009
43044
|
*
|
|
43010
43045
|
* @param {String} triggerId triggerId
|
|
43011
43046
|
*/
|
|
@@ -43030,13 +43065,13 @@ class ProcessAutomationApi {
|
|
|
43030
43065
|
}
|
|
43031
43066
|
|
|
43032
43067
|
/**
|
|
43033
|
-
* Retrieves all triggers
|
|
43068
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
43034
43069
|
*
|
|
43035
43070
|
* @param {Object} opts Optional parameters
|
|
43036
43071
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
43037
43072
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
43038
43073
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
43039
|
-
* @param {String} opts.topicName Topic name
|
|
43074
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
43040
43075
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
43041
43076
|
*/
|
|
43042
43077
|
getProcessautomationTriggers(opts) {
|
|
@@ -43202,7 +43237,7 @@ class QualityApi {
|
|
|
43202
43237
|
/**
|
|
43203
43238
|
* Quality service.
|
|
43204
43239
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43205
|
-
* @version
|
|
43240
|
+
* @version 152.0.0
|
|
43206
43241
|
*/
|
|
43207
43242
|
|
|
43208
43243
|
/**
|
|
@@ -44780,7 +44815,7 @@ class RecordingApi {
|
|
|
44780
44815
|
/**
|
|
44781
44816
|
* Recording service.
|
|
44782
44817
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44783
|
-
* @version
|
|
44818
|
+
* @version 152.0.0
|
|
44784
44819
|
*/
|
|
44785
44820
|
|
|
44786
44821
|
/**
|
|
@@ -46467,7 +46502,7 @@ class ResponseManagementApi {
|
|
|
46467
46502
|
/**
|
|
46468
46503
|
* ResponseManagement service.
|
|
46469
46504
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46470
|
-
* @version
|
|
46505
|
+
* @version 152.0.0
|
|
46471
46506
|
*/
|
|
46472
46507
|
|
|
46473
46508
|
/**
|
|
@@ -46951,7 +46986,7 @@ class RoutingApi {
|
|
|
46951
46986
|
/**
|
|
46952
46987
|
* Routing service.
|
|
46953
46988
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46954
|
-
* @version
|
|
46989
|
+
* @version 152.0.0
|
|
46955
46990
|
*/
|
|
46956
46991
|
|
|
46957
46992
|
/**
|
|
@@ -47260,6 +47295,31 @@ class RoutingApi {
|
|
|
47260
47295
|
);
|
|
47261
47296
|
}
|
|
47262
47297
|
|
|
47298
|
+
/**
|
|
47299
|
+
* Remove skill group definition
|
|
47300
|
+
*
|
|
47301
|
+
* @param {String} skillGroupId Skill Group ID
|
|
47302
|
+
*/
|
|
47303
|
+
deleteRoutingSkillgroup(skillGroupId) {
|
|
47304
|
+
// verify the required parameter 'skillGroupId' is set
|
|
47305
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
47306
|
+
throw 'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';
|
|
47307
|
+
}
|
|
47308
|
+
|
|
47309
|
+
return this.apiClient.callApi(
|
|
47310
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
47311
|
+
'DELETE',
|
|
47312
|
+
{ 'skillGroupId': skillGroupId },
|
|
47313
|
+
{ },
|
|
47314
|
+
{ },
|
|
47315
|
+
{ },
|
|
47316
|
+
null,
|
|
47317
|
+
['PureCloud OAuth'],
|
|
47318
|
+
['application/json'],
|
|
47319
|
+
['application/json']
|
|
47320
|
+
);
|
|
47321
|
+
}
|
|
47322
|
+
|
|
47263
47323
|
/**
|
|
47264
47324
|
* Delete an Address by Id for SMS
|
|
47265
47325
|
*
|
|
@@ -48445,6 +48505,119 @@ class RoutingApi {
|
|
|
48445
48505
|
);
|
|
48446
48506
|
}
|
|
48447
48507
|
|
|
48508
|
+
/**
|
|
48509
|
+
* Get skill group
|
|
48510
|
+
*
|
|
48511
|
+
* @param {String} skillGroupId Skill Group ID
|
|
48512
|
+
*/
|
|
48513
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
48514
|
+
// verify the required parameter 'skillGroupId' is set
|
|
48515
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
48516
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
48517
|
+
}
|
|
48518
|
+
|
|
48519
|
+
return this.apiClient.callApi(
|
|
48520
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
48521
|
+
'GET',
|
|
48522
|
+
{ 'skillGroupId': skillGroupId },
|
|
48523
|
+
{ },
|
|
48524
|
+
{ },
|
|
48525
|
+
{ },
|
|
48526
|
+
null,
|
|
48527
|
+
['PureCloud OAuth'],
|
|
48528
|
+
['application/json'],
|
|
48529
|
+
['application/json']
|
|
48530
|
+
);
|
|
48531
|
+
}
|
|
48532
|
+
|
|
48533
|
+
/**
|
|
48534
|
+
* Get skill group members
|
|
48535
|
+
*
|
|
48536
|
+
* @param {String} skillGroupId Skill Group ID
|
|
48537
|
+
* @param {Object} opts Optional parameters
|
|
48538
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
48539
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
48540
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
48541
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
48542
|
+
*/
|
|
48543
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
48544
|
+
opts = opts || {};
|
|
48545
|
+
|
|
48546
|
+
// verify the required parameter 'skillGroupId' is set
|
|
48547
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
48548
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
48549
|
+
}
|
|
48550
|
+
|
|
48551
|
+
return this.apiClient.callApi(
|
|
48552
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
48553
|
+
'GET',
|
|
48554
|
+
{ 'skillGroupId': skillGroupId },
|
|
48555
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
48556
|
+
{ },
|
|
48557
|
+
{ },
|
|
48558
|
+
null,
|
|
48559
|
+
['PureCloud OAuth'],
|
|
48560
|
+
['application/json'],
|
|
48561
|
+
['application/json']
|
|
48562
|
+
);
|
|
48563
|
+
}
|
|
48564
|
+
|
|
48565
|
+
/**
|
|
48566
|
+
* Get list of member divisions for this skill group.
|
|
48567
|
+
*
|
|
48568
|
+
* @param {String} skillGroupId Skill Group ID
|
|
48569
|
+
* @param {Object} opts Optional parameters
|
|
48570
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
48571
|
+
*/
|
|
48572
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
48573
|
+
opts = opts || {};
|
|
48574
|
+
|
|
48575
|
+
// verify the required parameter 'skillGroupId' is set
|
|
48576
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
48577
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
48578
|
+
}
|
|
48579
|
+
|
|
48580
|
+
return this.apiClient.callApi(
|
|
48581
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
48582
|
+
'GET',
|
|
48583
|
+
{ 'skillGroupId': skillGroupId },
|
|
48584
|
+
{ 'expand': opts['expand'] },
|
|
48585
|
+
{ },
|
|
48586
|
+
{ },
|
|
48587
|
+
null,
|
|
48588
|
+
['PureCloud OAuth'],
|
|
48589
|
+
['application/json'],
|
|
48590
|
+
['application/json']
|
|
48591
|
+
);
|
|
48592
|
+
}
|
|
48593
|
+
|
|
48594
|
+
/**
|
|
48595
|
+
* Get skill group listing
|
|
48596
|
+
*
|
|
48597
|
+
* @param {Object} opts Optional parameters
|
|
48598
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
48599
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
48600
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
48601
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
48602
|
+
*/
|
|
48603
|
+
getRoutingSkillgroups(opts) {
|
|
48604
|
+
opts = opts || {};
|
|
48605
|
+
|
|
48606
|
+
|
|
48607
|
+
return this.apiClient.callApi(
|
|
48608
|
+
'/api/v2/routing/skillgroups',
|
|
48609
|
+
'GET',
|
|
48610
|
+
{ },
|
|
48611
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
48612
|
+
{ },
|
|
48613
|
+
{ },
|
|
48614
|
+
null,
|
|
48615
|
+
['PureCloud OAuth'],
|
|
48616
|
+
['application/json'],
|
|
48617
|
+
['application/json']
|
|
48618
|
+
);
|
|
48619
|
+
}
|
|
48620
|
+
|
|
48448
48621
|
/**
|
|
48449
48622
|
* Get the list of routing skills.
|
|
48450
48623
|
*
|
|
@@ -49083,6 +49256,36 @@ class RoutingApi {
|
|
|
49083
49256
|
);
|
|
49084
49257
|
}
|
|
49085
49258
|
|
|
49259
|
+
/**
|
|
49260
|
+
* Update skill group definition
|
|
49261
|
+
*
|
|
49262
|
+
* @param {String} skillGroupId Skill Group ID
|
|
49263
|
+
* @param {Object} body Update skill groups
|
|
49264
|
+
*/
|
|
49265
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
49266
|
+
// verify the required parameter 'skillGroupId' is set
|
|
49267
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
49268
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
49269
|
+
}
|
|
49270
|
+
// verify the required parameter 'body' is set
|
|
49271
|
+
if (body === undefined || body === null) {
|
|
49272
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
49273
|
+
}
|
|
49274
|
+
|
|
49275
|
+
return this.apiClient.callApi(
|
|
49276
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
49277
|
+
'PATCH',
|
|
49278
|
+
{ 'skillGroupId': skillGroupId },
|
|
49279
|
+
{ },
|
|
49280
|
+
{ },
|
|
49281
|
+
{ },
|
|
49282
|
+
body,
|
|
49283
|
+
['PureCloud OAuth'],
|
|
49284
|
+
['application/json'],
|
|
49285
|
+
['application/json']
|
|
49286
|
+
);
|
|
49287
|
+
}
|
|
49288
|
+
|
|
49086
49289
|
/**
|
|
49087
49290
|
* Join or unjoin a queue for a user
|
|
49088
49291
|
*
|
|
@@ -49626,6 +49829,60 @@ class RoutingApi {
|
|
|
49626
49829
|
);
|
|
49627
49830
|
}
|
|
49628
49831
|
|
|
49832
|
+
/**
|
|
49833
|
+
* Add or remove member divisions for this skill group.
|
|
49834
|
+
*
|
|
49835
|
+
* @param {String} skillGroupId Skill Group ID
|
|
49836
|
+
* @param {Object} opts Optional parameters
|
|
49837
|
+
* @param {Object} opts.body
|
|
49838
|
+
*/
|
|
49839
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
49840
|
+
opts = opts || {};
|
|
49841
|
+
|
|
49842
|
+
// verify the required parameter 'skillGroupId' is set
|
|
49843
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
49844
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
49845
|
+
}
|
|
49846
|
+
|
|
49847
|
+
return this.apiClient.callApi(
|
|
49848
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
49849
|
+
'POST',
|
|
49850
|
+
{ 'skillGroupId': skillGroupId },
|
|
49851
|
+
{ },
|
|
49852
|
+
{ },
|
|
49853
|
+
{ },
|
|
49854
|
+
opts['body'],
|
|
49855
|
+
['PureCloud OAuth'],
|
|
49856
|
+
['application/json'],
|
|
49857
|
+
['application/json']
|
|
49858
|
+
);
|
|
49859
|
+
}
|
|
49860
|
+
|
|
49861
|
+
/**
|
|
49862
|
+
* Create a skill group
|
|
49863
|
+
*
|
|
49864
|
+
* @param {Object} body Create skill group
|
|
49865
|
+
*/
|
|
49866
|
+
postRoutingSkillgroups(body) {
|
|
49867
|
+
// verify the required parameter 'body' is set
|
|
49868
|
+
if (body === undefined || body === null) {
|
|
49869
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
49870
|
+
}
|
|
49871
|
+
|
|
49872
|
+
return this.apiClient.callApi(
|
|
49873
|
+
'/api/v2/routing/skillgroups',
|
|
49874
|
+
'POST',
|
|
49875
|
+
{ },
|
|
49876
|
+
{ },
|
|
49877
|
+
{ },
|
|
49878
|
+
{ },
|
|
49879
|
+
body,
|
|
49880
|
+
['PureCloud OAuth'],
|
|
49881
|
+
['application/json'],
|
|
49882
|
+
['application/json']
|
|
49883
|
+
);
|
|
49884
|
+
}
|
|
49885
|
+
|
|
49629
49886
|
/**
|
|
49630
49887
|
* Create Skill
|
|
49631
49888
|
*
|
|
@@ -50142,7 +50399,7 @@ class SCIMApi {
|
|
|
50142
50399
|
/**
|
|
50143
50400
|
* SCIM service.
|
|
50144
50401
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50145
|
-
* @version
|
|
50402
|
+
* @version 152.0.0
|
|
50146
50403
|
*/
|
|
50147
50404
|
|
|
50148
50405
|
/**
|
|
@@ -51019,7 +51276,7 @@ class ScriptsApi {
|
|
|
51019
51276
|
/**
|
|
51020
51277
|
* Scripts service.
|
|
51021
51278
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51022
|
-
* @version
|
|
51279
|
+
* @version 152.0.0
|
|
51023
51280
|
*/
|
|
51024
51281
|
|
|
51025
51282
|
/**
|
|
@@ -51438,7 +51695,7 @@ class SearchApi {
|
|
|
51438
51695
|
/**
|
|
51439
51696
|
* Search service.
|
|
51440
51697
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51441
|
-
* @version
|
|
51698
|
+
* @version 152.0.0
|
|
51442
51699
|
*/
|
|
51443
51700
|
|
|
51444
51701
|
/**
|
|
@@ -51967,6 +52224,31 @@ class SearchApi {
|
|
|
51967
52224
|
);
|
|
51968
52225
|
}
|
|
51969
52226
|
|
|
52227
|
+
/**
|
|
52228
|
+
* Search users assigned to teams
|
|
52229
|
+
*
|
|
52230
|
+
* @param {Object} body Search request options
|
|
52231
|
+
*/
|
|
52232
|
+
postUsersSearchTeamsAssign(body) {
|
|
52233
|
+
// verify the required parameter 'body' is set
|
|
52234
|
+
if (body === undefined || body === null) {
|
|
52235
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
52236
|
+
}
|
|
52237
|
+
|
|
52238
|
+
return this.apiClient.callApi(
|
|
52239
|
+
'/api/v2/users/search/teams/assign',
|
|
52240
|
+
'POST',
|
|
52241
|
+
{ },
|
|
52242
|
+
{ },
|
|
52243
|
+
{ },
|
|
52244
|
+
{ },
|
|
52245
|
+
body,
|
|
52246
|
+
['PureCloud OAuth'],
|
|
52247
|
+
['application/json'],
|
|
52248
|
+
['application/json']
|
|
52249
|
+
);
|
|
52250
|
+
}
|
|
52251
|
+
|
|
51970
52252
|
/**
|
|
51971
52253
|
* Search voicemails
|
|
51972
52254
|
*
|
|
@@ -51998,7 +52280,7 @@ class SpeechTextAnalyticsApi {
|
|
|
51998
52280
|
/**
|
|
51999
52281
|
* SpeechTextAnalytics service.
|
|
52000
52282
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52001
|
-
* @version
|
|
52283
|
+
* @version 152.0.0
|
|
52002
52284
|
*/
|
|
52003
52285
|
|
|
52004
52286
|
/**
|
|
@@ -52852,7 +53134,7 @@ class StationsApi {
|
|
|
52852
53134
|
/**
|
|
52853
53135
|
* Stations service.
|
|
52854
53136
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
52855
|
-
* @version
|
|
53137
|
+
* @version 152.0.0
|
|
52856
53138
|
*/
|
|
52857
53139
|
|
|
52858
53140
|
/**
|
|
@@ -52999,7 +53281,7 @@ class SuggestApi {
|
|
|
52999
53281
|
/**
|
|
53000
53282
|
* Suggest service.
|
|
53001
53283
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53002
|
-
* @version
|
|
53284
|
+
* @version 152.0.0
|
|
53003
53285
|
*/
|
|
53004
53286
|
|
|
53005
53287
|
/**
|
|
@@ -53138,7 +53420,7 @@ class TeamsApi {
|
|
|
53138
53420
|
/**
|
|
53139
53421
|
* Teams service.
|
|
53140
53422
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
53141
|
-
* @version
|
|
53423
|
+
* @version 152.0.0
|
|
53142
53424
|
*/
|
|
53143
53425
|
|
|
53144
53426
|
/**
|
|
@@ -53178,6 +53460,36 @@ class TeamsApi {
|
|
|
53178
53460
|
);
|
|
53179
53461
|
}
|
|
53180
53462
|
|
|
53463
|
+
/**
|
|
53464
|
+
* Delete team members
|
|
53465
|
+
*
|
|
53466
|
+
* @param {String} teamId Team ID
|
|
53467
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
53468
|
+
*/
|
|
53469
|
+
deleteTeamMembers(teamId, id) {
|
|
53470
|
+
// verify the required parameter 'teamId' is set
|
|
53471
|
+
if (teamId === undefined || teamId === null) {
|
|
53472
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
53473
|
+
}
|
|
53474
|
+
// verify the required parameter 'id' is set
|
|
53475
|
+
if (id === undefined || id === null) {
|
|
53476
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
53477
|
+
}
|
|
53478
|
+
|
|
53479
|
+
return this.apiClient.callApi(
|
|
53480
|
+
'/api/v2/teams/{teamId}/members',
|
|
53481
|
+
'DELETE',
|
|
53482
|
+
{ 'teamId': teamId },
|
|
53483
|
+
{ 'id': id },
|
|
53484
|
+
{ },
|
|
53485
|
+
{ },
|
|
53486
|
+
null,
|
|
53487
|
+
['PureCloud OAuth'],
|
|
53488
|
+
['application/json'],
|
|
53489
|
+
['application/json']
|
|
53490
|
+
);
|
|
53491
|
+
}
|
|
53492
|
+
|
|
53181
53493
|
/**
|
|
53182
53494
|
* Get team
|
|
53183
53495
|
*
|
|
@@ -53203,6 +53515,38 @@ class TeamsApi {
|
|
|
53203
53515
|
);
|
|
53204
53516
|
}
|
|
53205
53517
|
|
|
53518
|
+
/**
|
|
53519
|
+
* Get team membership
|
|
53520
|
+
*
|
|
53521
|
+
* @param {String} teamId Team ID
|
|
53522
|
+
* @param {Object} opts Optional parameters
|
|
53523
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
53524
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
53525
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
53526
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
53527
|
+
*/
|
|
53528
|
+
getTeamMembers(teamId, opts) {
|
|
53529
|
+
opts = opts || {};
|
|
53530
|
+
|
|
53531
|
+
// verify the required parameter 'teamId' is set
|
|
53532
|
+
if (teamId === undefined || teamId === null) {
|
|
53533
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
53534
|
+
}
|
|
53535
|
+
|
|
53536
|
+
return this.apiClient.callApi(
|
|
53537
|
+
'/api/v2/teams/{teamId}/members',
|
|
53538
|
+
'GET',
|
|
53539
|
+
{ 'teamId': teamId },
|
|
53540
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
53541
|
+
{ },
|
|
53542
|
+
{ },
|
|
53543
|
+
null,
|
|
53544
|
+
['PureCloud OAuth'],
|
|
53545
|
+
['application/json'],
|
|
53546
|
+
['application/json']
|
|
53547
|
+
);
|
|
53548
|
+
}
|
|
53549
|
+
|
|
53206
53550
|
/**
|
|
53207
53551
|
* Get Team listing
|
|
53208
53552
|
*
|
|
@@ -53261,6 +53605,36 @@ class TeamsApi {
|
|
|
53261
53605
|
);
|
|
53262
53606
|
}
|
|
53263
53607
|
|
|
53608
|
+
/**
|
|
53609
|
+
* Add team members
|
|
53610
|
+
*
|
|
53611
|
+
* @param {String} teamId Team ID
|
|
53612
|
+
* @param {Object} body TeamMembers
|
|
53613
|
+
*/
|
|
53614
|
+
postTeamMembers(teamId, body) {
|
|
53615
|
+
// verify the required parameter 'teamId' is set
|
|
53616
|
+
if (teamId === undefined || teamId === null) {
|
|
53617
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
53618
|
+
}
|
|
53619
|
+
// verify the required parameter 'body' is set
|
|
53620
|
+
if (body === undefined || body === null) {
|
|
53621
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
53622
|
+
}
|
|
53623
|
+
|
|
53624
|
+
return this.apiClient.callApi(
|
|
53625
|
+
'/api/v2/teams/{teamId}/members',
|
|
53626
|
+
'POST',
|
|
53627
|
+
{ 'teamId': teamId },
|
|
53628
|
+
{ },
|
|
53629
|
+
{ },
|
|
53630
|
+
{ },
|
|
53631
|
+
body,
|
|
53632
|
+
['PureCloud OAuth'],
|
|
53633
|
+
['application/json'],
|
|
53634
|
+
['application/json']
|
|
53635
|
+
);
|
|
53636
|
+
}
|
|
53637
|
+
|
|
53264
53638
|
/**
|
|
53265
53639
|
* Create a team
|
|
53266
53640
|
*
|
|
@@ -53317,7 +53691,7 @@ class TelephonyApi {
|
|
|
53317
53691
|
/**
|
|
53318
53692
|
* Telephony service.
|
|
53319
53693
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
53320
|
-
* @version
|
|
53694
|
+
* @version 152.0.0
|
|
53321
53695
|
*/
|
|
53322
53696
|
|
|
53323
53697
|
/**
|
|
@@ -53425,7 +53799,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
53425
53799
|
/**
|
|
53426
53800
|
* TelephonyProvidersEdge service.
|
|
53427
53801
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
53428
|
-
* @version
|
|
53802
|
+
* @version 152.0.0
|
|
53429
53803
|
*/
|
|
53430
53804
|
|
|
53431
53805
|
/**
|
|
@@ -57058,7 +57432,7 @@ class TextbotsApi {
|
|
|
57058
57432
|
/**
|
|
57059
57433
|
* Textbots service.
|
|
57060
57434
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
57061
|
-
* @version
|
|
57435
|
+
* @version 152.0.0
|
|
57062
57436
|
*/
|
|
57063
57437
|
|
|
57064
57438
|
/**
|
|
@@ -57186,7 +57560,7 @@ class TokensApi {
|
|
|
57186
57560
|
/**
|
|
57187
57561
|
* Tokens service.
|
|
57188
57562
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
57189
|
-
* @version
|
|
57563
|
+
* @version 152.0.0
|
|
57190
57564
|
*/
|
|
57191
57565
|
|
|
57192
57566
|
/**
|
|
@@ -57292,7 +57666,7 @@ class UploadsApi {
|
|
|
57292
57666
|
/**
|
|
57293
57667
|
* Uploads service.
|
|
57294
57668
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
57295
|
-
* @version
|
|
57669
|
+
* @version 152.0.0
|
|
57296
57670
|
*/
|
|
57297
57671
|
|
|
57298
57672
|
/**
|
|
@@ -57468,7 +57842,7 @@ class UsageApi {
|
|
|
57468
57842
|
/**
|
|
57469
57843
|
* Usage service.
|
|
57470
57844
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
57471
|
-
* @version
|
|
57845
|
+
* @version 152.0.0
|
|
57472
57846
|
*/
|
|
57473
57847
|
|
|
57474
57848
|
/**
|
|
@@ -57539,7 +57913,7 @@ class UserRecordingsApi {
|
|
|
57539
57913
|
/**
|
|
57540
57914
|
* UserRecordings service.
|
|
57541
57915
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
57542
|
-
* @version
|
|
57916
|
+
* @version 152.0.0
|
|
57543
57917
|
*/
|
|
57544
57918
|
|
|
57545
57919
|
/**
|
|
@@ -57724,7 +58098,7 @@ class UsersApi {
|
|
|
57724
58098
|
/**
|
|
57725
58099
|
* Users service.
|
|
57726
58100
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
57727
|
-
* @version
|
|
58101
|
+
* @version 152.0.0
|
|
57728
58102
|
*/
|
|
57729
58103
|
|
|
57730
58104
|
/**
|
|
@@ -59715,6 +60089,31 @@ class UsersApi {
|
|
|
59715
60089
|
);
|
|
59716
60090
|
}
|
|
59717
60091
|
|
|
60092
|
+
/**
|
|
60093
|
+
* Search users assigned to teams
|
|
60094
|
+
*
|
|
60095
|
+
* @param {Object} body Search request options
|
|
60096
|
+
*/
|
|
60097
|
+
postUsersSearchTeamsAssign(body) {
|
|
60098
|
+
// verify the required parameter 'body' is set
|
|
60099
|
+
if (body === undefined || body === null) {
|
|
60100
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
60101
|
+
}
|
|
60102
|
+
|
|
60103
|
+
return this.apiClient.callApi(
|
|
60104
|
+
'/api/v2/users/search/teams/assign',
|
|
60105
|
+
'POST',
|
|
60106
|
+
{ },
|
|
60107
|
+
{ },
|
|
60108
|
+
{ },
|
|
60109
|
+
{ },
|
|
60110
|
+
body,
|
|
60111
|
+
['PureCloud OAuth'],
|
|
60112
|
+
['application/json'],
|
|
60113
|
+
['application/json']
|
|
60114
|
+
);
|
|
60115
|
+
}
|
|
60116
|
+
|
|
59718
60117
|
/**
|
|
59719
60118
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
59720
60119
|
*
|
|
@@ -60056,7 +60455,7 @@ class UtilitiesApi {
|
|
|
60056
60455
|
/**
|
|
60057
60456
|
* Utilities service.
|
|
60058
60457
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
60059
|
-
* @version
|
|
60458
|
+
* @version 152.0.0
|
|
60060
60459
|
*/
|
|
60061
60460
|
|
|
60062
60461
|
/**
|
|
@@ -60167,7 +60566,7 @@ class VoicemailApi {
|
|
|
60167
60566
|
/**
|
|
60168
60567
|
* Voicemail service.
|
|
60169
60568
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
60170
|
-
* @version
|
|
60569
|
+
* @version 152.0.0
|
|
60171
60570
|
*/
|
|
60172
60571
|
|
|
60173
60572
|
/**
|
|
@@ -60834,7 +61233,7 @@ class WebChatApi {
|
|
|
60834
61233
|
/**
|
|
60835
61234
|
* WebChat service.
|
|
60836
61235
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
60837
|
-
* @version
|
|
61236
|
+
* @version 152.0.0
|
|
60838
61237
|
*/
|
|
60839
61238
|
|
|
60840
61239
|
/**
|
|
@@ -61378,7 +61777,7 @@ class WebDeploymentsApi {
|
|
|
61378
61777
|
/**
|
|
61379
61778
|
* WebDeployments service.
|
|
61380
61779
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
61381
|
-
* @version
|
|
61780
|
+
* @version 152.0.0
|
|
61382
61781
|
*/
|
|
61383
61782
|
|
|
61384
61783
|
/**
|
|
@@ -61766,7 +62165,7 @@ class WebMessagingApi {
|
|
|
61766
62165
|
/**
|
|
61767
62166
|
* WebMessaging service.
|
|
61768
62167
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
61769
|
-
* @version
|
|
62168
|
+
* @version 152.0.0
|
|
61770
62169
|
*/
|
|
61771
62170
|
|
|
61772
62171
|
/**
|
|
@@ -61812,7 +62211,7 @@ class WidgetsApi {
|
|
|
61812
62211
|
/**
|
|
61813
62212
|
* Widgets service.
|
|
61814
62213
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
61815
|
-
* @version
|
|
62214
|
+
* @version 152.0.0
|
|
61816
62215
|
*/
|
|
61817
62216
|
|
|
61818
62217
|
/**
|
|
@@ -61958,7 +62357,7 @@ class WorkforceManagementApi {
|
|
|
61958
62357
|
/**
|
|
61959
62358
|
* WorkforceManagement service.
|
|
61960
62359
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
61961
|
-
* @version
|
|
62360
|
+
* @version 152.0.0
|
|
61962
62361
|
*/
|
|
61963
62362
|
|
|
61964
62363
|
/**
|
|
@@ -65738,6 +66137,76 @@ class WorkforceManagementApi {
|
|
|
65738
66137
|
);
|
|
65739
66138
|
}
|
|
65740
66139
|
|
|
66140
|
+
/**
|
|
66141
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
66142
|
+
*
|
|
66143
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
66144
|
+
* @param {String} userId The ID of the user
|
|
66145
|
+
* @param {Object} body The request body
|
|
66146
|
+
*/
|
|
66147
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
66148
|
+
// verify the required parameter 'managementUnitId' is set
|
|
66149
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
66150
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
66151
|
+
}
|
|
66152
|
+
// verify the required parameter 'userId' is set
|
|
66153
|
+
if (userId === undefined || userId === null) {
|
|
66154
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
66155
|
+
}
|
|
66156
|
+
// verify the required parameter 'body' is set
|
|
66157
|
+
if (body === undefined || body === null) {
|
|
66158
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
66159
|
+
}
|
|
66160
|
+
|
|
66161
|
+
return this.apiClient.callApi(
|
|
66162
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
66163
|
+
'POST',
|
|
66164
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
66165
|
+
{ },
|
|
66166
|
+
{ },
|
|
66167
|
+
{ },
|
|
66168
|
+
body,
|
|
66169
|
+
['PureCloud OAuth'],
|
|
66170
|
+
['application/json'],
|
|
66171
|
+
['application/json']
|
|
66172
|
+
);
|
|
66173
|
+
}
|
|
66174
|
+
|
|
66175
|
+
/**
|
|
66176
|
+
* Query time off balances for dates spanned by a given time off request
|
|
66177
|
+
*
|
|
66178
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
66179
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
66180
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
66181
|
+
*/
|
|
66182
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
66183
|
+
// verify the required parameter 'managementUnitId' is set
|
|
66184
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
66185
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
66186
|
+
}
|
|
66187
|
+
// verify the required parameter 'userId' is set
|
|
66188
|
+
if (userId === undefined || userId === null) {
|
|
66189
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
66190
|
+
}
|
|
66191
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
66192
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
66193
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
66194
|
+
}
|
|
66195
|
+
|
|
66196
|
+
return this.apiClient.callApi(
|
|
66197
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
66198
|
+
'POST',
|
|
66199
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
66200
|
+
{ },
|
|
66201
|
+
{ },
|
|
66202
|
+
{ },
|
|
66203
|
+
null,
|
|
66204
|
+
['PureCloud OAuth'],
|
|
66205
|
+
['application/json'],
|
|
66206
|
+
['application/json']
|
|
66207
|
+
);
|
|
66208
|
+
}
|
|
66209
|
+
|
|
65741
66210
|
/**
|
|
65742
66211
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
65743
66212
|
*
|
|
@@ -66234,7 +66703,7 @@ class WorkforceManagementApi {
|
|
|
66234
66703
|
* </pre>
|
|
66235
66704
|
* </p>
|
|
66236
66705
|
* @module purecloud-platform-client-v2/index
|
|
66237
|
-
* @version
|
|
66706
|
+
* @version 152.0.0
|
|
66238
66707
|
*/
|
|
66239
66708
|
class platformClient {
|
|
66240
66709
|
constructor() {
|