purecloud-platform-client-v2 151.0.0 → 153.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +712 -150
- package/dist/web-amd/purecloud-platform-client-v2.js +712 -150
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +712 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +712 -150
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +579 -212
- 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 +30 -4
- 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 +46 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +16 -10
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +226 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +325 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -9307,7 +9307,7 @@ class Configuration {
|
|
|
9307
9307
|
|
|
9308
9308
|
/**
|
|
9309
9309
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9310
|
-
* @version
|
|
9310
|
+
* @version 153.0.0
|
|
9311
9311
|
*/
|
|
9312
9312
|
class ApiClient {
|
|
9313
9313
|
/**
|
|
@@ -10379,7 +10379,7 @@ class AlertingApi {
|
|
|
10379
10379
|
/**
|
|
10380
10380
|
* Alerting service.
|
|
10381
10381
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10382
|
-
* @version
|
|
10382
|
+
* @version 153.0.0
|
|
10383
10383
|
*/
|
|
10384
10384
|
|
|
10385
10385
|
/**
|
|
@@ -10693,7 +10693,7 @@ class AnalyticsApi {
|
|
|
10693
10693
|
/**
|
|
10694
10694
|
* Analytics service.
|
|
10695
10695
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10696
|
-
* @version
|
|
10696
|
+
* @version 153.0.0
|
|
10697
10697
|
*/
|
|
10698
10698
|
|
|
10699
10699
|
/**
|
|
@@ -10709,7 +10709,7 @@ class AnalyticsApi {
|
|
|
10709
10709
|
|
|
10710
10710
|
|
|
10711
10711
|
/**
|
|
10712
|
-
* Delete/cancel an async
|
|
10712
|
+
* Delete/cancel an async details job
|
|
10713
10713
|
*
|
|
10714
10714
|
* @param {String} jobId jobId
|
|
10715
10715
|
*/
|
|
@@ -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,
|
|
@@ -10890,7 +10891,7 @@ class AnalyticsApi {
|
|
|
10890
10891
|
}
|
|
10891
10892
|
|
|
10892
10893
|
/**
|
|
10893
|
-
* Fetch a page of results for an async
|
|
10894
|
+
* Fetch a page of results for an async details job
|
|
10894
10895
|
*
|
|
10895
10896
|
* @param {String} jobId jobId
|
|
10896
10897
|
* @param {Object} opts Optional parameters
|
|
@@ -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 153.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 153.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 153.0.0
|
|
15141
15168
|
*/
|
|
15142
15169
|
|
|
15143
15170
|
/**
|
|
@@ -15670,6 +15697,26 @@ class AuthorizationApi {
|
|
|
15670
15697
|
);
|
|
15671
15698
|
}
|
|
15672
15699
|
|
|
15700
|
+
/**
|
|
15701
|
+
* Get authorization settings
|
|
15702
|
+
*
|
|
15703
|
+
*/
|
|
15704
|
+
getAuthorizationSettings() {
|
|
15705
|
+
|
|
15706
|
+
return this.apiClient.callApi(
|
|
15707
|
+
'/api/v2/authorization/settings',
|
|
15708
|
+
'GET',
|
|
15709
|
+
{ },
|
|
15710
|
+
{ },
|
|
15711
|
+
{ },
|
|
15712
|
+
{ },
|
|
15713
|
+
null,
|
|
15714
|
+
['PureCloud OAuth'],
|
|
15715
|
+
['application/json'],
|
|
15716
|
+
['application/json']
|
|
15717
|
+
);
|
|
15718
|
+
}
|
|
15719
|
+
|
|
15673
15720
|
/**
|
|
15674
15721
|
* Returns a listing of roles and permissions for a user.
|
|
15675
15722
|
*
|
|
@@ -15794,6 +15841,31 @@ class AuthorizationApi {
|
|
|
15794
15841
|
);
|
|
15795
15842
|
}
|
|
15796
15843
|
|
|
15844
|
+
/**
|
|
15845
|
+
* Change authorization settings
|
|
15846
|
+
* Change authorization settings
|
|
15847
|
+
* @param {Object} body Authorization Settings
|
|
15848
|
+
*/
|
|
15849
|
+
patchAuthorizationSettings(body) {
|
|
15850
|
+
// verify the required parameter 'body' is set
|
|
15851
|
+
if (body === undefined || body === null) {
|
|
15852
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
15853
|
+
}
|
|
15854
|
+
|
|
15855
|
+
return this.apiClient.callApi(
|
|
15856
|
+
'/api/v2/authorization/settings',
|
|
15857
|
+
'PATCH',
|
|
15858
|
+
{ },
|
|
15859
|
+
{ },
|
|
15860
|
+
{ },
|
|
15861
|
+
{ },
|
|
15862
|
+
body,
|
|
15863
|
+
['PureCloud OAuth'],
|
|
15864
|
+
['application/json'],
|
|
15865
|
+
['application/json']
|
|
15866
|
+
);
|
|
15867
|
+
}
|
|
15868
|
+
|
|
15797
15869
|
/**
|
|
15798
15870
|
* Assign a list of objects to a division
|
|
15799
15871
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
@@ -16320,7 +16392,7 @@ class BillingApi {
|
|
|
16320
16392
|
/**
|
|
16321
16393
|
* Billing service.
|
|
16322
16394
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16323
|
-
* @version
|
|
16395
|
+
* @version 153.0.0
|
|
16324
16396
|
*/
|
|
16325
16397
|
|
|
16326
16398
|
/**
|
|
@@ -16400,7 +16472,7 @@ class ChatApi {
|
|
|
16400
16472
|
/**
|
|
16401
16473
|
* Chat service.
|
|
16402
16474
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16403
|
-
* @version
|
|
16475
|
+
* @version 153.0.0
|
|
16404
16476
|
*/
|
|
16405
16477
|
|
|
16406
16478
|
/**
|
|
@@ -16491,7 +16563,7 @@ class CoachingApi {
|
|
|
16491
16563
|
/**
|
|
16492
16564
|
* Coaching service.
|
|
16493
16565
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16494
|
-
* @version
|
|
16566
|
+
* @version 153.0.0
|
|
16495
16567
|
*/
|
|
16496
16568
|
|
|
16497
16569
|
/**
|
|
@@ -17068,7 +17140,7 @@ class ContentManagementApi {
|
|
|
17068
17140
|
/**
|
|
17069
17141
|
* ContentManagement service.
|
|
17070
17142
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17071
|
-
* @version
|
|
17143
|
+
* @version 153.0.0
|
|
17072
17144
|
*/
|
|
17073
17145
|
|
|
17074
17146
|
/**
|
|
@@ -18208,7 +18280,7 @@ class ConversationsApi {
|
|
|
18208
18280
|
/**
|
|
18209
18281
|
* Conversations service.
|
|
18210
18282
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18211
|
-
* @version
|
|
18283
|
+
* @version 153.0.0
|
|
18212
18284
|
*/
|
|
18213
18285
|
|
|
18214
18286
|
/**
|
|
@@ -18224,7 +18296,7 @@ class ConversationsApi {
|
|
|
18224
18296
|
|
|
18225
18297
|
|
|
18226
18298
|
/**
|
|
18227
|
-
* Delete/cancel an async
|
|
18299
|
+
* Delete/cancel an async details job
|
|
18228
18300
|
*
|
|
18229
18301
|
* @param {String} jobId jobId
|
|
18230
18302
|
*/
|
|
@@ -18598,7 +18670,7 @@ class ConversationsApi {
|
|
|
18598
18670
|
}
|
|
18599
18671
|
|
|
18600
18672
|
/**
|
|
18601
|
-
* Fetch a page of results for an async
|
|
18673
|
+
* Fetch a page of results for an async details job
|
|
18602
18674
|
*
|
|
18603
18675
|
* @param {String} jobId jobId
|
|
18604
18676
|
* @param {Object} opts Optional parameters
|
|
@@ -19887,8 +19959,9 @@ class ConversationsApi {
|
|
|
19887
19959
|
* @param {Object} opts Optional parameters
|
|
19888
19960
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19889
19961
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19890
|
-
* @param {
|
|
19962
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value.
|
|
19891
19963
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
19964
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
19892
19965
|
*/
|
|
19893
19966
|
getConversationsMessagingIntegrations(opts) {
|
|
19894
19967
|
opts = opts || {};
|
|
@@ -19898,7 +19971,7 @@ class ConversationsApi {
|
|
|
19898
19971
|
'/api/v2/conversations/messaging/integrations',
|
|
19899
19972
|
'GET',
|
|
19900
19973
|
{ },
|
|
19901
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
19974
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
19902
19975
|
{ },
|
|
19903
19976
|
{ },
|
|
19904
19977
|
null,
|
|
@@ -19916,6 +19989,7 @@ class ConversationsApi {
|
|
|
19916
19989
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19917
19990
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
19918
19991
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
19992
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
19919
19993
|
*/
|
|
19920
19994
|
getConversationsMessagingIntegrationsFacebook(opts) {
|
|
19921
19995
|
opts = opts || {};
|
|
@@ -19925,7 +19999,7 @@ class ConversationsApi {
|
|
|
19925
19999
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
19926
20000
|
'GET',
|
|
19927
20001
|
{ },
|
|
19928
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20002
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
19929
20003
|
{ },
|
|
19930
20004
|
{ },
|
|
19931
20005
|
null,
|
|
@@ -19972,6 +20046,7 @@ class ConversationsApi {
|
|
|
19972
20046
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19973
20047
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
19974
20048
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
20049
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
19975
20050
|
*/
|
|
19976
20051
|
getConversationsMessagingIntegrationsLine(opts) {
|
|
19977
20052
|
opts = opts || {};
|
|
@@ -19981,7 +20056,7 @@ class ConversationsApi {
|
|
|
19981
20056
|
'/api/v2/conversations/messaging/integrations/line',
|
|
19982
20057
|
'GET',
|
|
19983
20058
|
{ },
|
|
19984
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20059
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
19985
20060
|
{ },
|
|
19986
20061
|
{ },
|
|
19987
20062
|
null,
|
|
@@ -20028,6 +20103,7 @@ class ConversationsApi {
|
|
|
20028
20103
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20029
20104
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
20030
20105
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
20106
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
20031
20107
|
*/
|
|
20032
20108
|
getConversationsMessagingIntegrationsOpen(opts) {
|
|
20033
20109
|
opts = opts || {};
|
|
@@ -20037,7 +20113,7 @@ class ConversationsApi {
|
|
|
20037
20113
|
'/api/v2/conversations/messaging/integrations/open',
|
|
20038
20114
|
'GET',
|
|
20039
20115
|
{ },
|
|
20040
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20116
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
20041
20117
|
{ },
|
|
20042
20118
|
{ },
|
|
20043
20119
|
null,
|
|
@@ -20084,6 +20160,7 @@ class ConversationsApi {
|
|
|
20084
20160
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20085
20161
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
20086
20162
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
20163
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
20087
20164
|
*/
|
|
20088
20165
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
20089
20166
|
opts = opts || {};
|
|
@@ -20093,7 +20170,7 @@ class ConversationsApi {
|
|
|
20093
20170
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
20094
20171
|
'GET',
|
|
20095
20172
|
{ },
|
|
20096
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20173
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
20097
20174
|
{ },
|
|
20098
20175
|
{ },
|
|
20099
20176
|
null,
|
|
@@ -20140,6 +20217,7 @@ class ConversationsApi {
|
|
|
20140
20217
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20141
20218
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
20142
20219
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
20220
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
20143
20221
|
*/
|
|
20144
20222
|
getConversationsMessagingIntegrationsWhatsapp(opts) {
|
|
20145
20223
|
opts = opts || {};
|
|
@@ -20149,7 +20227,7 @@ class ConversationsApi {
|
|
|
20149
20227
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
20150
20228
|
'GET',
|
|
20151
20229
|
{ },
|
|
20152
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
20230
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
20153
20231
|
{ },
|
|
20154
20232
|
{ },
|
|
20155
20233
|
null,
|
|
@@ -23425,7 +23503,7 @@ class DataExtensionsApi {
|
|
|
23425
23503
|
/**
|
|
23426
23504
|
* DataExtensions service.
|
|
23427
23505
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23428
|
-
* @version
|
|
23506
|
+
* @version 153.0.0
|
|
23429
23507
|
*/
|
|
23430
23508
|
|
|
23431
23509
|
/**
|
|
@@ -23511,7 +23589,7 @@ class DownloadsApi {
|
|
|
23511
23589
|
/**
|
|
23512
23590
|
* Downloads service.
|
|
23513
23591
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
23514
|
-
* @version
|
|
23592
|
+
* @version 153.0.0
|
|
23515
23593
|
*/
|
|
23516
23594
|
|
|
23517
23595
|
/**
|
|
@@ -23563,7 +23641,7 @@ class EventsApi {
|
|
|
23563
23641
|
/**
|
|
23564
23642
|
* Events service.
|
|
23565
23643
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23566
|
-
* @version
|
|
23644
|
+
* @version 153.0.0
|
|
23567
23645
|
*/
|
|
23568
23646
|
|
|
23569
23647
|
/**
|
|
@@ -23659,7 +23737,7 @@ class ExternalContactsApi {
|
|
|
23659
23737
|
/**
|
|
23660
23738
|
* ExternalContacts service.
|
|
23661
23739
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23662
|
-
* @version
|
|
23740
|
+
* @version 153.0.0
|
|
23663
23741
|
*/
|
|
23664
23742
|
|
|
23665
23743
|
/**
|
|
@@ -25617,7 +25695,7 @@ class FaxApi {
|
|
|
25617
25695
|
/**
|
|
25618
25696
|
* Fax service.
|
|
25619
25697
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25620
|
-
* @version
|
|
25698
|
+
* @version 153.0.0
|
|
25621
25699
|
*/
|
|
25622
25700
|
|
|
25623
25701
|
/**
|
|
@@ -25788,7 +25866,7 @@ class FlowsApi {
|
|
|
25788
25866
|
/**
|
|
25789
25867
|
* Flows service.
|
|
25790
25868
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25791
|
-
* @version
|
|
25869
|
+
* @version 153.0.0
|
|
25792
25870
|
*/
|
|
25793
25871
|
|
|
25794
25872
|
/**
|
|
@@ -25859,7 +25937,7 @@ class GamificationApi {
|
|
|
25859
25937
|
/**
|
|
25860
25938
|
* Gamification service.
|
|
25861
25939
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25862
|
-
* @version
|
|
25940
|
+
* @version 153.0.0
|
|
25863
25941
|
*/
|
|
25864
25942
|
|
|
25865
25943
|
/**
|
|
@@ -26077,36 +26155,6 @@ class GamificationApi {
|
|
|
26077
26155
|
);
|
|
26078
26156
|
}
|
|
26079
26157
|
|
|
26080
|
-
/**
|
|
26081
|
-
* Gamified metric by id
|
|
26082
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
26083
|
-
* @param {String} metricId metric Id
|
|
26084
|
-
* @param {Object} opts Optional parameters
|
|
26085
|
-
* @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
|
|
26086
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
26087
|
-
*/
|
|
26088
|
-
getGamificationMetric(metricId, opts) {
|
|
26089
|
-
opts = opts || {};
|
|
26090
|
-
|
|
26091
|
-
// verify the required parameter 'metricId' is set
|
|
26092
|
-
if (metricId === undefined || metricId === null) {
|
|
26093
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
26094
|
-
}
|
|
26095
|
-
|
|
26096
|
-
return this.apiClient.callApi(
|
|
26097
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
26098
|
-
'GET',
|
|
26099
|
-
{ 'metricId': metricId },
|
|
26100
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
26101
|
-
{ },
|
|
26102
|
-
{ },
|
|
26103
|
-
null,
|
|
26104
|
-
['PureCloud OAuth'],
|
|
26105
|
-
['application/json'],
|
|
26106
|
-
['application/json']
|
|
26107
|
-
);
|
|
26108
|
-
}
|
|
26109
|
-
|
|
26110
26158
|
/**
|
|
26111
26159
|
* Metric definition by id
|
|
26112
26160
|
*
|
|
@@ -27411,40 +27459,6 @@ class GamificationApi {
|
|
|
27411
27459
|
);
|
|
27412
27460
|
}
|
|
27413
27461
|
|
|
27414
|
-
/**
|
|
27415
|
-
* Updates a metric
|
|
27416
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
27417
|
-
* @param {String} metricId metric Id
|
|
27418
|
-
* @param {Object} body Metric
|
|
27419
|
-
* @param {Object} opts Optional parameters
|
|
27420
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
27421
|
-
*/
|
|
27422
|
-
putGamificationMetric(metricId, body, opts) {
|
|
27423
|
-
opts = opts || {};
|
|
27424
|
-
|
|
27425
|
-
// verify the required parameter 'metricId' is set
|
|
27426
|
-
if (metricId === undefined || metricId === null) {
|
|
27427
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
27428
|
-
}
|
|
27429
|
-
// verify the required parameter 'body' is set
|
|
27430
|
-
if (body === undefined || body === null) {
|
|
27431
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
27432
|
-
}
|
|
27433
|
-
|
|
27434
|
-
return this.apiClient.callApi(
|
|
27435
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
27436
|
-
'PUT',
|
|
27437
|
-
{ 'metricId': metricId },
|
|
27438
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
27439
|
-
{ },
|
|
27440
|
-
{ },
|
|
27441
|
-
body,
|
|
27442
|
-
['PureCloud OAuth'],
|
|
27443
|
-
['application/json'],
|
|
27444
|
-
['application/json']
|
|
27445
|
-
);
|
|
27446
|
-
}
|
|
27447
|
-
|
|
27448
27462
|
/**
|
|
27449
27463
|
* Updates a performance profile
|
|
27450
27464
|
*
|
|
@@ -27540,7 +27554,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
27540
27554
|
/**
|
|
27541
27555
|
* GeneralDataProtectionRegulation service.
|
|
27542
27556
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27543
|
-
* @version
|
|
27557
|
+
* @version 153.0.0
|
|
27544
27558
|
*/
|
|
27545
27559
|
|
|
27546
27560
|
/**
|
|
@@ -27670,7 +27684,7 @@ class GeolocationApi {
|
|
|
27670
27684
|
/**
|
|
27671
27685
|
* Geolocation service.
|
|
27672
27686
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27673
|
-
* @version
|
|
27687
|
+
* @version 153.0.0
|
|
27674
27688
|
*/
|
|
27675
27689
|
|
|
27676
27690
|
/**
|
|
@@ -27801,7 +27815,7 @@ class GreetingsApi {
|
|
|
27801
27815
|
/**
|
|
27802
27816
|
* Greetings service.
|
|
27803
27817
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27804
|
-
* @version
|
|
27818
|
+
* @version 153.0.0
|
|
27805
27819
|
*/
|
|
27806
27820
|
|
|
27807
27821
|
/**
|
|
@@ -28256,7 +28270,7 @@ class GroupsApi {
|
|
|
28256
28270
|
/**
|
|
28257
28271
|
* Groups service.
|
|
28258
28272
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28259
|
-
* @version
|
|
28273
|
+
* @version 153.0.0
|
|
28260
28274
|
*/
|
|
28261
28275
|
|
|
28262
28276
|
/**
|
|
@@ -28662,7 +28676,7 @@ class IdentityProviderApi {
|
|
|
28662
28676
|
/**
|
|
28663
28677
|
* IdentityProvider service.
|
|
28664
28678
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28665
|
-
* @version
|
|
28679
|
+
* @version 153.0.0
|
|
28666
28680
|
*/
|
|
28667
28681
|
|
|
28668
28682
|
/**
|
|
@@ -29418,7 +29432,7 @@ class IntegrationsApi {
|
|
|
29418
29432
|
/**
|
|
29419
29433
|
* Integrations service.
|
|
29420
29434
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29421
|
-
* @version
|
|
29435
|
+
* @version 153.0.0
|
|
29422
29436
|
*/
|
|
29423
29437
|
|
|
29424
29438
|
/**
|
|
@@ -31018,7 +31032,7 @@ class JourneyApi {
|
|
|
31018
31032
|
/**
|
|
31019
31033
|
* Journey service.
|
|
31020
31034
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31021
|
-
* @version
|
|
31035
|
+
* @version 153.0.0
|
|
31022
31036
|
*/
|
|
31023
31037
|
|
|
31024
31038
|
/**
|
|
@@ -31804,7 +31818,7 @@ class KnowledgeApi {
|
|
|
31804
31818
|
/**
|
|
31805
31819
|
* Knowledge service.
|
|
31806
31820
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31807
|
-
* @version
|
|
31821
|
+
* @version 153.0.0
|
|
31808
31822
|
*/
|
|
31809
31823
|
|
|
31810
31824
|
/**
|
|
@@ -32207,8 +32221,8 @@ class KnowledgeApi {
|
|
|
32207
32221
|
* @param {String} sessionId Knowledge guest session ID.
|
|
32208
32222
|
* @param {Object} opts Optional parameters
|
|
32209
32223
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
32210
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
32211
|
-
* @param {
|
|
32224
|
+
* @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.
|
|
32225
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
32212
32226
|
*/
|
|
32213
32227
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
32214
32228
|
opts = opts || {};
|
|
@@ -34237,7 +34251,7 @@ class LanguageUnderstandingApi {
|
|
|
34237
34251
|
/**
|
|
34238
34252
|
* LanguageUnderstanding service.
|
|
34239
34253
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34240
|
-
* @version
|
|
34254
|
+
* @version 153.0.0
|
|
34241
34255
|
*/
|
|
34242
34256
|
|
|
34243
34257
|
/**
|
|
@@ -35141,7 +35155,7 @@ class LanguagesApi {
|
|
|
35141
35155
|
/**
|
|
35142
35156
|
* Languages service.
|
|
35143
35157
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35144
|
-
* @version
|
|
35158
|
+
* @version 153.0.0
|
|
35145
35159
|
*/
|
|
35146
35160
|
|
|
35147
35161
|
/**
|
|
@@ -35409,7 +35423,7 @@ class LearningApi {
|
|
|
35409
35423
|
/**
|
|
35410
35424
|
* Learning service.
|
|
35411
35425
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35412
|
-
* @version
|
|
35426
|
+
* @version 153.0.0
|
|
35413
35427
|
*/
|
|
35414
35428
|
|
|
35415
35429
|
/**
|
|
@@ -36169,7 +36183,7 @@ class LicenseApi {
|
|
|
36169
36183
|
/**
|
|
36170
36184
|
* License service.
|
|
36171
36185
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36172
|
-
* @version
|
|
36186
|
+
* @version 153.0.0
|
|
36173
36187
|
*/
|
|
36174
36188
|
|
|
36175
36189
|
/**
|
|
@@ -36407,7 +36421,7 @@ class LocationsApi {
|
|
|
36407
36421
|
/**
|
|
36408
36422
|
* Locations service.
|
|
36409
36423
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36410
|
-
* @version
|
|
36424
|
+
* @version 153.0.0
|
|
36411
36425
|
*/
|
|
36412
36426
|
|
|
36413
36427
|
/**
|
|
@@ -36643,7 +36657,7 @@ class MessagingApi {
|
|
|
36643
36657
|
/**
|
|
36644
36658
|
* Messaging service.
|
|
36645
36659
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
36646
|
-
* @version
|
|
36660
|
+
* @version 153.0.0
|
|
36647
36661
|
*/
|
|
36648
36662
|
|
|
36649
36663
|
/**
|
|
@@ -36794,7 +36808,7 @@ class MobileDevicesApi {
|
|
|
36794
36808
|
/**
|
|
36795
36809
|
* MobileDevices service.
|
|
36796
36810
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
36797
|
-
* @version
|
|
36811
|
+
* @version 153.0.0
|
|
36798
36812
|
*/
|
|
36799
36813
|
|
|
36800
36814
|
/**
|
|
@@ -36945,7 +36959,7 @@ class NotificationsApi {
|
|
|
36945
36959
|
/**
|
|
36946
36960
|
* Notifications service.
|
|
36947
36961
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
36948
|
-
* @version
|
|
36962
|
+
* @version 153.0.0
|
|
36949
36963
|
*/
|
|
36950
36964
|
|
|
36951
36965
|
/**
|
|
@@ -37170,7 +37184,7 @@ class OAuthApi {
|
|
|
37170
37184
|
/**
|
|
37171
37185
|
* OAuth service.
|
|
37172
37186
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37173
|
-
* @version
|
|
37187
|
+
* @version 153.0.0
|
|
37174
37188
|
*/
|
|
37175
37189
|
|
|
37176
37190
|
/**
|
|
@@ -37536,7 +37550,7 @@ class ObjectsApi {
|
|
|
37536
37550
|
/**
|
|
37537
37551
|
* Objects service.
|
|
37538
37552
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
37539
|
-
* @version
|
|
37553
|
+
* @version 153.0.0
|
|
37540
37554
|
*/
|
|
37541
37555
|
|
|
37542
37556
|
/**
|
|
@@ -37807,7 +37821,7 @@ class OrganizationApi {
|
|
|
37807
37821
|
/**
|
|
37808
37822
|
* Organization service.
|
|
37809
37823
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
37810
|
-
* @version
|
|
37824
|
+
* @version 153.0.0
|
|
37811
37825
|
*/
|
|
37812
37826
|
|
|
37813
37827
|
/**
|
|
@@ -38210,7 +38224,7 @@ class OrganizationAuthorizationApi {
|
|
|
38210
38224
|
/**
|
|
38211
38225
|
* OrganizationAuthorization service.
|
|
38212
38226
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38213
|
-
* @version
|
|
38227
|
+
* @version 153.0.0
|
|
38214
38228
|
*/
|
|
38215
38229
|
|
|
38216
38230
|
/**
|
|
@@ -39135,7 +39149,7 @@ class OutboundApi {
|
|
|
39135
39149
|
/**
|
|
39136
39150
|
* Outbound service.
|
|
39137
39151
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
39138
|
-
* @version
|
|
39152
|
+
* @version 153.0.0
|
|
39139
39153
|
*/
|
|
39140
39154
|
|
|
39141
39155
|
/**
|
|
@@ -42524,7 +42538,7 @@ class PresenceApi {
|
|
|
42524
42538
|
/**
|
|
42525
42539
|
* Presence service.
|
|
42526
42540
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42527
|
-
* @version
|
|
42541
|
+
* @version 153.0.0
|
|
42528
42542
|
*/
|
|
42529
42543
|
|
|
42530
42544
|
/**
|
|
@@ -43030,7 +43044,7 @@ class ProcessAutomationApi {
|
|
|
43030
43044
|
/**
|
|
43031
43045
|
* ProcessAutomation service.
|
|
43032
43046
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
43033
|
-
* @version
|
|
43047
|
+
* @version 153.0.0
|
|
43034
43048
|
*/
|
|
43035
43049
|
|
|
43036
43050
|
/**
|
|
@@ -43268,7 +43282,7 @@ class QualityApi {
|
|
|
43268
43282
|
/**
|
|
43269
43283
|
* Quality service.
|
|
43270
43284
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43271
|
-
* @version
|
|
43285
|
+
* @version 153.0.0
|
|
43272
43286
|
*/
|
|
43273
43287
|
|
|
43274
43288
|
/**
|
|
@@ -44846,7 +44860,7 @@ class RecordingApi {
|
|
|
44846
44860
|
/**
|
|
44847
44861
|
* Recording service.
|
|
44848
44862
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44849
|
-
* @version
|
|
44863
|
+
* @version 153.0.0
|
|
44850
44864
|
*/
|
|
44851
44865
|
|
|
44852
44866
|
/**
|
|
@@ -46533,7 +46547,7 @@ class ResponseManagementApi {
|
|
|
46533
46547
|
/**
|
|
46534
46548
|
* ResponseManagement service.
|
|
46535
46549
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46536
|
-
* @version
|
|
46550
|
+
* @version 153.0.0
|
|
46537
46551
|
*/
|
|
46538
46552
|
|
|
46539
46553
|
/**
|
|
@@ -47017,7 +47031,7 @@ class RoutingApi {
|
|
|
47017
47031
|
/**
|
|
47018
47032
|
* Routing service.
|
|
47019
47033
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
47020
|
-
* @version
|
|
47034
|
+
* @version 153.0.0
|
|
47021
47035
|
*/
|
|
47022
47036
|
|
|
47023
47037
|
/**
|
|
@@ -47326,6 +47340,31 @@ class RoutingApi {
|
|
|
47326
47340
|
);
|
|
47327
47341
|
}
|
|
47328
47342
|
|
|
47343
|
+
/**
|
|
47344
|
+
* Remove skill group definition
|
|
47345
|
+
*
|
|
47346
|
+
* @param {String} skillGroupId Skill Group ID
|
|
47347
|
+
*/
|
|
47348
|
+
deleteRoutingSkillgroup(skillGroupId) {
|
|
47349
|
+
// verify the required parameter 'skillGroupId' is set
|
|
47350
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
47351
|
+
throw 'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';
|
|
47352
|
+
}
|
|
47353
|
+
|
|
47354
|
+
return this.apiClient.callApi(
|
|
47355
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
47356
|
+
'DELETE',
|
|
47357
|
+
{ 'skillGroupId': skillGroupId },
|
|
47358
|
+
{ },
|
|
47359
|
+
{ },
|
|
47360
|
+
{ },
|
|
47361
|
+
null,
|
|
47362
|
+
['PureCloud OAuth'],
|
|
47363
|
+
['application/json'],
|
|
47364
|
+
['application/json']
|
|
47365
|
+
);
|
|
47366
|
+
}
|
|
47367
|
+
|
|
47329
47368
|
/**
|
|
47330
47369
|
* Delete an Address by Id for SMS
|
|
47331
47370
|
*
|
|
@@ -47718,6 +47757,8 @@ class RoutingApi {
|
|
|
47718
47757
|
* Get domains
|
|
47719
47758
|
*
|
|
47720
47759
|
* @param {Object} opts Optional parameters
|
|
47760
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47761
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47721
47762
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
47722
47763
|
*/
|
|
47723
47764
|
getRoutingEmailDomains(opts) {
|
|
@@ -47728,7 +47769,7 @@ class RoutingApi {
|
|
|
47728
47769
|
'/api/v2/routing/email/domains',
|
|
47729
47770
|
'GET',
|
|
47730
47771
|
{ },
|
|
47731
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
47772
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
47732
47773
|
{ },
|
|
47733
47774
|
{ },
|
|
47734
47775
|
null,
|
|
@@ -48511,6 +48552,119 @@ class RoutingApi {
|
|
|
48511
48552
|
);
|
|
48512
48553
|
}
|
|
48513
48554
|
|
|
48555
|
+
/**
|
|
48556
|
+
* Get skill group
|
|
48557
|
+
*
|
|
48558
|
+
* @param {String} skillGroupId Skill Group ID
|
|
48559
|
+
*/
|
|
48560
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
48561
|
+
// verify the required parameter 'skillGroupId' is set
|
|
48562
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
48563
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
48564
|
+
}
|
|
48565
|
+
|
|
48566
|
+
return this.apiClient.callApi(
|
|
48567
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
48568
|
+
'GET',
|
|
48569
|
+
{ 'skillGroupId': skillGroupId },
|
|
48570
|
+
{ },
|
|
48571
|
+
{ },
|
|
48572
|
+
{ },
|
|
48573
|
+
null,
|
|
48574
|
+
['PureCloud OAuth'],
|
|
48575
|
+
['application/json'],
|
|
48576
|
+
['application/json']
|
|
48577
|
+
);
|
|
48578
|
+
}
|
|
48579
|
+
|
|
48580
|
+
/**
|
|
48581
|
+
* Get skill group members
|
|
48582
|
+
*
|
|
48583
|
+
* @param {String} skillGroupId Skill Group ID
|
|
48584
|
+
* @param {Object} opts Optional parameters
|
|
48585
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
48586
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
48587
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
48588
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
48589
|
+
*/
|
|
48590
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
48591
|
+
opts = opts || {};
|
|
48592
|
+
|
|
48593
|
+
// verify the required parameter 'skillGroupId' is set
|
|
48594
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
48595
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
48596
|
+
}
|
|
48597
|
+
|
|
48598
|
+
return this.apiClient.callApi(
|
|
48599
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
48600
|
+
'GET',
|
|
48601
|
+
{ 'skillGroupId': skillGroupId },
|
|
48602
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
48603
|
+
{ },
|
|
48604
|
+
{ },
|
|
48605
|
+
null,
|
|
48606
|
+
['PureCloud OAuth'],
|
|
48607
|
+
['application/json'],
|
|
48608
|
+
['application/json']
|
|
48609
|
+
);
|
|
48610
|
+
}
|
|
48611
|
+
|
|
48612
|
+
/**
|
|
48613
|
+
* Get list of member divisions for this skill group.
|
|
48614
|
+
*
|
|
48615
|
+
* @param {String} skillGroupId Skill Group ID
|
|
48616
|
+
* @param {Object} opts Optional parameters
|
|
48617
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
48618
|
+
*/
|
|
48619
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
48620
|
+
opts = opts || {};
|
|
48621
|
+
|
|
48622
|
+
// verify the required parameter 'skillGroupId' is set
|
|
48623
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
48624
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
48625
|
+
}
|
|
48626
|
+
|
|
48627
|
+
return this.apiClient.callApi(
|
|
48628
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
48629
|
+
'GET',
|
|
48630
|
+
{ 'skillGroupId': skillGroupId },
|
|
48631
|
+
{ 'expand': opts['expand'] },
|
|
48632
|
+
{ },
|
|
48633
|
+
{ },
|
|
48634
|
+
null,
|
|
48635
|
+
['PureCloud OAuth'],
|
|
48636
|
+
['application/json'],
|
|
48637
|
+
['application/json']
|
|
48638
|
+
);
|
|
48639
|
+
}
|
|
48640
|
+
|
|
48641
|
+
/**
|
|
48642
|
+
* Get skill group listing
|
|
48643
|
+
*
|
|
48644
|
+
* @param {Object} opts Optional parameters
|
|
48645
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
48646
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
48647
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
48648
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
48649
|
+
*/
|
|
48650
|
+
getRoutingSkillgroups(opts) {
|
|
48651
|
+
opts = opts || {};
|
|
48652
|
+
|
|
48653
|
+
|
|
48654
|
+
return this.apiClient.callApi(
|
|
48655
|
+
'/api/v2/routing/skillgroups',
|
|
48656
|
+
'GET',
|
|
48657
|
+
{ },
|
|
48658
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
48659
|
+
{ },
|
|
48660
|
+
{ },
|
|
48661
|
+
null,
|
|
48662
|
+
['PureCloud OAuth'],
|
|
48663
|
+
['application/json'],
|
|
48664
|
+
['application/json']
|
|
48665
|
+
);
|
|
48666
|
+
}
|
|
48667
|
+
|
|
48514
48668
|
/**
|
|
48515
48669
|
* Get the list of routing skills.
|
|
48516
48670
|
*
|
|
@@ -49149,6 +49303,36 @@ class RoutingApi {
|
|
|
49149
49303
|
);
|
|
49150
49304
|
}
|
|
49151
49305
|
|
|
49306
|
+
/**
|
|
49307
|
+
* Update skill group definition
|
|
49308
|
+
*
|
|
49309
|
+
* @param {String} skillGroupId Skill Group ID
|
|
49310
|
+
* @param {Object} body Update skill groups
|
|
49311
|
+
*/
|
|
49312
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
49313
|
+
// verify the required parameter 'skillGroupId' is set
|
|
49314
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
49315
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
49316
|
+
}
|
|
49317
|
+
// verify the required parameter 'body' is set
|
|
49318
|
+
if (body === undefined || body === null) {
|
|
49319
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
49320
|
+
}
|
|
49321
|
+
|
|
49322
|
+
return this.apiClient.callApi(
|
|
49323
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
49324
|
+
'PATCH',
|
|
49325
|
+
{ 'skillGroupId': skillGroupId },
|
|
49326
|
+
{ },
|
|
49327
|
+
{ },
|
|
49328
|
+
{ },
|
|
49329
|
+
body,
|
|
49330
|
+
['PureCloud OAuth'],
|
|
49331
|
+
['application/json'],
|
|
49332
|
+
['application/json']
|
|
49333
|
+
);
|
|
49334
|
+
}
|
|
49335
|
+
|
|
49152
49336
|
/**
|
|
49153
49337
|
* Join or unjoin a queue for a user
|
|
49154
49338
|
*
|
|
@@ -49692,6 +49876,60 @@ class RoutingApi {
|
|
|
49692
49876
|
);
|
|
49693
49877
|
}
|
|
49694
49878
|
|
|
49879
|
+
/**
|
|
49880
|
+
* Add or remove member divisions for this skill group.
|
|
49881
|
+
*
|
|
49882
|
+
* @param {String} skillGroupId Skill Group ID
|
|
49883
|
+
* @param {Object} opts Optional parameters
|
|
49884
|
+
* @param {Object} opts.body
|
|
49885
|
+
*/
|
|
49886
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
49887
|
+
opts = opts || {};
|
|
49888
|
+
|
|
49889
|
+
// verify the required parameter 'skillGroupId' is set
|
|
49890
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
49891
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
49892
|
+
}
|
|
49893
|
+
|
|
49894
|
+
return this.apiClient.callApi(
|
|
49895
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
49896
|
+
'POST',
|
|
49897
|
+
{ 'skillGroupId': skillGroupId },
|
|
49898
|
+
{ },
|
|
49899
|
+
{ },
|
|
49900
|
+
{ },
|
|
49901
|
+
opts['body'],
|
|
49902
|
+
['PureCloud OAuth'],
|
|
49903
|
+
['application/json'],
|
|
49904
|
+
['application/json']
|
|
49905
|
+
);
|
|
49906
|
+
}
|
|
49907
|
+
|
|
49908
|
+
/**
|
|
49909
|
+
* Create a skill group
|
|
49910
|
+
*
|
|
49911
|
+
* @param {Object} body Create skill group
|
|
49912
|
+
*/
|
|
49913
|
+
postRoutingSkillgroups(body) {
|
|
49914
|
+
// verify the required parameter 'body' is set
|
|
49915
|
+
if (body === undefined || body === null) {
|
|
49916
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
49917
|
+
}
|
|
49918
|
+
|
|
49919
|
+
return this.apiClient.callApi(
|
|
49920
|
+
'/api/v2/routing/skillgroups',
|
|
49921
|
+
'POST',
|
|
49922
|
+
{ },
|
|
49923
|
+
{ },
|
|
49924
|
+
{ },
|
|
49925
|
+
{ },
|
|
49926
|
+
body,
|
|
49927
|
+
['PureCloud OAuth'],
|
|
49928
|
+
['application/json'],
|
|
49929
|
+
['application/json']
|
|
49930
|
+
);
|
|
49931
|
+
}
|
|
49932
|
+
|
|
49695
49933
|
/**
|
|
49696
49934
|
* Create Skill
|
|
49697
49935
|
*
|
|
@@ -50208,7 +50446,7 @@ class SCIMApi {
|
|
|
50208
50446
|
/**
|
|
50209
50447
|
* SCIM service.
|
|
50210
50448
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50211
|
-
* @version
|
|
50449
|
+
* @version 153.0.0
|
|
50212
50450
|
*/
|
|
50213
50451
|
|
|
50214
50452
|
/**
|
|
@@ -51085,7 +51323,7 @@ class ScriptsApi {
|
|
|
51085
51323
|
/**
|
|
51086
51324
|
* Scripts service.
|
|
51087
51325
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51088
|
-
* @version
|
|
51326
|
+
* @version 153.0.0
|
|
51089
51327
|
*/
|
|
51090
51328
|
|
|
51091
51329
|
/**
|
|
@@ -51504,7 +51742,7 @@ class SearchApi {
|
|
|
51504
51742
|
/**
|
|
51505
51743
|
* Search service.
|
|
51506
51744
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51507
|
-
* @version
|
|
51745
|
+
* @version 153.0.0
|
|
51508
51746
|
*/
|
|
51509
51747
|
|
|
51510
51748
|
/**
|
|
@@ -52089,7 +52327,7 @@ class SpeechTextAnalyticsApi {
|
|
|
52089
52327
|
/**
|
|
52090
52328
|
* SpeechTextAnalytics service.
|
|
52091
52329
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52092
|
-
* @version
|
|
52330
|
+
* @version 153.0.0
|
|
52093
52331
|
*/
|
|
52094
52332
|
|
|
52095
52333
|
/**
|
|
@@ -52943,7 +53181,7 @@ class StationsApi {
|
|
|
52943
53181
|
/**
|
|
52944
53182
|
* Stations service.
|
|
52945
53183
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
52946
|
-
* @version
|
|
53184
|
+
* @version 153.0.0
|
|
52947
53185
|
*/
|
|
52948
53186
|
|
|
52949
53187
|
/**
|
|
@@ -53090,7 +53328,7 @@ class SuggestApi {
|
|
|
53090
53328
|
/**
|
|
53091
53329
|
* Suggest service.
|
|
53092
53330
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53093
|
-
* @version
|
|
53331
|
+
* @version 153.0.0
|
|
53094
53332
|
*/
|
|
53095
53333
|
|
|
53096
53334
|
/**
|
|
@@ -53229,7 +53467,7 @@ class TeamsApi {
|
|
|
53229
53467
|
/**
|
|
53230
53468
|
* Teams service.
|
|
53231
53469
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
53232
|
-
* @version
|
|
53470
|
+
* @version 153.0.0
|
|
53233
53471
|
*/
|
|
53234
53472
|
|
|
53235
53473
|
/**
|
|
@@ -53500,7 +53738,7 @@ class TelephonyApi {
|
|
|
53500
53738
|
/**
|
|
53501
53739
|
* Telephony service.
|
|
53502
53740
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
53503
|
-
* @version
|
|
53741
|
+
* @version 153.0.0
|
|
53504
53742
|
*/
|
|
53505
53743
|
|
|
53506
53744
|
/**
|
|
@@ -53608,7 +53846,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
53608
53846
|
/**
|
|
53609
53847
|
* TelephonyProvidersEdge service.
|
|
53610
53848
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
53611
|
-
* @version
|
|
53849
|
+
* @version 153.0.0
|
|
53612
53850
|
*/
|
|
53613
53851
|
|
|
53614
53852
|
/**
|
|
@@ -57241,7 +57479,7 @@ class TextbotsApi {
|
|
|
57241
57479
|
/**
|
|
57242
57480
|
* Textbots service.
|
|
57243
57481
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
57244
|
-
* @version
|
|
57482
|
+
* @version 153.0.0
|
|
57245
57483
|
*/
|
|
57246
57484
|
|
|
57247
57485
|
/**
|
|
@@ -57369,7 +57607,7 @@ class TokensApi {
|
|
|
57369
57607
|
/**
|
|
57370
57608
|
* Tokens service.
|
|
57371
57609
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
57372
|
-
* @version
|
|
57610
|
+
* @version 153.0.0
|
|
57373
57611
|
*/
|
|
57374
57612
|
|
|
57375
57613
|
/**
|
|
@@ -57475,7 +57713,7 @@ class UploadsApi {
|
|
|
57475
57713
|
/**
|
|
57476
57714
|
* Uploads service.
|
|
57477
57715
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
57478
|
-
* @version
|
|
57716
|
+
* @version 153.0.0
|
|
57479
57717
|
*/
|
|
57480
57718
|
|
|
57481
57719
|
/**
|
|
@@ -57651,7 +57889,7 @@ class UsageApi {
|
|
|
57651
57889
|
/**
|
|
57652
57890
|
* Usage service.
|
|
57653
57891
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
57654
|
-
* @version
|
|
57892
|
+
* @version 153.0.0
|
|
57655
57893
|
*/
|
|
57656
57894
|
|
|
57657
57895
|
/**
|
|
@@ -57722,7 +57960,7 @@ class UserRecordingsApi {
|
|
|
57722
57960
|
/**
|
|
57723
57961
|
* UserRecordings service.
|
|
57724
57962
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
57725
|
-
* @version
|
|
57963
|
+
* @version 153.0.0
|
|
57726
57964
|
*/
|
|
57727
57965
|
|
|
57728
57966
|
/**
|
|
@@ -57907,7 +58145,7 @@ class UsersApi {
|
|
|
57907
58145
|
/**
|
|
57908
58146
|
* Users service.
|
|
57909
58147
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
57910
|
-
* @version
|
|
58148
|
+
* @version 153.0.0
|
|
57911
58149
|
*/
|
|
57912
58150
|
|
|
57913
58151
|
/**
|
|
@@ -60264,7 +60502,7 @@ class UtilitiesApi {
|
|
|
60264
60502
|
/**
|
|
60265
60503
|
* Utilities service.
|
|
60266
60504
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
60267
|
-
* @version
|
|
60505
|
+
* @version 153.0.0
|
|
60268
60506
|
*/
|
|
60269
60507
|
|
|
60270
60508
|
/**
|
|
@@ -60375,7 +60613,7 @@ class VoicemailApi {
|
|
|
60375
60613
|
/**
|
|
60376
60614
|
* Voicemail service.
|
|
60377
60615
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
60378
|
-
* @version
|
|
60616
|
+
* @version 153.0.0
|
|
60379
60617
|
*/
|
|
60380
60618
|
|
|
60381
60619
|
/**
|
|
@@ -61042,7 +61280,7 @@ class WebChatApi {
|
|
|
61042
61280
|
/**
|
|
61043
61281
|
* WebChat service.
|
|
61044
61282
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
61045
|
-
* @version
|
|
61283
|
+
* @version 153.0.0
|
|
61046
61284
|
*/
|
|
61047
61285
|
|
|
61048
61286
|
/**
|
|
@@ -61586,7 +61824,7 @@ class WebDeploymentsApi {
|
|
|
61586
61824
|
/**
|
|
61587
61825
|
* WebDeployments service.
|
|
61588
61826
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
61589
|
-
* @version
|
|
61827
|
+
* @version 153.0.0
|
|
61590
61828
|
*/
|
|
61591
61829
|
|
|
61592
61830
|
/**
|
|
@@ -61974,7 +62212,7 @@ class WebMessagingApi {
|
|
|
61974
62212
|
/**
|
|
61975
62213
|
* WebMessaging service.
|
|
61976
62214
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
61977
|
-
* @version
|
|
62215
|
+
* @version 153.0.0
|
|
61978
62216
|
*/
|
|
61979
62217
|
|
|
61980
62218
|
/**
|
|
@@ -62020,7 +62258,7 @@ class WidgetsApi {
|
|
|
62020
62258
|
/**
|
|
62021
62259
|
* Widgets service.
|
|
62022
62260
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
62023
|
-
* @version
|
|
62261
|
+
* @version 153.0.0
|
|
62024
62262
|
*/
|
|
62025
62263
|
|
|
62026
62264
|
/**
|
|
@@ -62166,7 +62404,7 @@ class WorkforceManagementApi {
|
|
|
62166
62404
|
/**
|
|
62167
62405
|
* WorkforceManagement service.
|
|
62168
62406
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
62169
|
-
* @version
|
|
62407
|
+
* @version 153.0.0
|
|
62170
62408
|
*/
|
|
62171
62409
|
|
|
62172
62410
|
/**
|
|
@@ -62586,6 +62824,56 @@ class WorkforceManagementApi {
|
|
|
62586
62824
|
);
|
|
62587
62825
|
}
|
|
62588
62826
|
|
|
62827
|
+
/**
|
|
62828
|
+
* Get an adherence explanation for the current user
|
|
62829
|
+
*
|
|
62830
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
62831
|
+
*/
|
|
62832
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
62833
|
+
// verify the required parameter 'explanationId' is set
|
|
62834
|
+
if (explanationId === undefined || explanationId === null) {
|
|
62835
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
62836
|
+
}
|
|
62837
|
+
|
|
62838
|
+
return this.apiClient.callApi(
|
|
62839
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
62840
|
+
'GET',
|
|
62841
|
+
{ 'explanationId': explanationId },
|
|
62842
|
+
{ },
|
|
62843
|
+
{ },
|
|
62844
|
+
{ },
|
|
62845
|
+
null,
|
|
62846
|
+
['PureCloud OAuth'],
|
|
62847
|
+
['application/json'],
|
|
62848
|
+
['application/json']
|
|
62849
|
+
);
|
|
62850
|
+
}
|
|
62851
|
+
|
|
62852
|
+
/**
|
|
62853
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
62854
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
62855
|
+
* @param {String} jobId The ID of the job
|
|
62856
|
+
*/
|
|
62857
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
62858
|
+
// verify the required parameter 'jobId' is set
|
|
62859
|
+
if (jobId === undefined || jobId === null) {
|
|
62860
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
62861
|
+
}
|
|
62862
|
+
|
|
62863
|
+
return this.apiClient.callApi(
|
|
62864
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
62865
|
+
'GET',
|
|
62866
|
+
{ 'jobId': jobId },
|
|
62867
|
+
{ },
|
|
62868
|
+
{ },
|
|
62869
|
+
{ },
|
|
62870
|
+
null,
|
|
62871
|
+
['PureCloud OAuth'],
|
|
62872
|
+
['application/json'],
|
|
62873
|
+
['application/json']
|
|
62874
|
+
);
|
|
62875
|
+
}
|
|
62876
|
+
|
|
62589
62877
|
/**
|
|
62590
62878
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
62591
62879
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -62636,6 +62924,36 @@ class WorkforceManagementApi {
|
|
|
62636
62924
|
);
|
|
62637
62925
|
}
|
|
62638
62926
|
|
|
62927
|
+
/**
|
|
62928
|
+
* Get an adherence explanation
|
|
62929
|
+
*
|
|
62930
|
+
* @param {String} agentId The ID of the agent to query
|
|
62931
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
62932
|
+
*/
|
|
62933
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
62934
|
+
// verify the required parameter 'agentId' is set
|
|
62935
|
+
if (agentId === undefined || agentId === null) {
|
|
62936
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
62937
|
+
}
|
|
62938
|
+
// verify the required parameter 'explanationId' is set
|
|
62939
|
+
if (explanationId === undefined || explanationId === null) {
|
|
62940
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
62941
|
+
}
|
|
62942
|
+
|
|
62943
|
+
return this.apiClient.callApi(
|
|
62944
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
62945
|
+
'GET',
|
|
62946
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
62947
|
+
{ },
|
|
62948
|
+
{ },
|
|
62949
|
+
{ },
|
|
62950
|
+
null,
|
|
62951
|
+
['PureCloud OAuth'],
|
|
62952
|
+
['application/json'],
|
|
62953
|
+
['application/json']
|
|
62954
|
+
);
|
|
62955
|
+
}
|
|
62956
|
+
|
|
62639
62957
|
/**
|
|
62640
62958
|
* Get the management unit to which the agent belongs
|
|
62641
62959
|
*
|
|
@@ -64355,6 +64673,31 @@ class WorkforceManagementApi {
|
|
|
64355
64673
|
);
|
|
64356
64674
|
}
|
|
64357
64675
|
|
|
64676
|
+
/**
|
|
64677
|
+
* Request to fetch the status of the historical shrinkage query
|
|
64678
|
+
*
|
|
64679
|
+
* @param {String} jobId jobId
|
|
64680
|
+
*/
|
|
64681
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
64682
|
+
// verify the required parameter 'jobId' is set
|
|
64683
|
+
if (jobId === undefined || jobId === null) {
|
|
64684
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
64685
|
+
}
|
|
64686
|
+
|
|
64687
|
+
return this.apiClient.callApi(
|
|
64688
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
64689
|
+
'GET',
|
|
64690
|
+
{ 'jobId': jobId },
|
|
64691
|
+
{ },
|
|
64692
|
+
{ },
|
|
64693
|
+
{ },
|
|
64694
|
+
null,
|
|
64695
|
+
['PureCloud OAuth'],
|
|
64696
|
+
['application/json'],
|
|
64697
|
+
['application/json']
|
|
64698
|
+
);
|
|
64699
|
+
}
|
|
64700
|
+
|
|
64358
64701
|
/**
|
|
64359
64702
|
* Get a time off request for the current user
|
|
64360
64703
|
*
|
|
@@ -64429,6 +64772,41 @@ class WorkforceManagementApi {
|
|
|
64429
64772
|
);
|
|
64430
64773
|
}
|
|
64431
64774
|
|
|
64775
|
+
/**
|
|
64776
|
+
* Update an adherence explanation
|
|
64777
|
+
*
|
|
64778
|
+
* @param {String} agentId The ID of the agent to query
|
|
64779
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
64780
|
+
* @param {Object} body The request body
|
|
64781
|
+
*/
|
|
64782
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
64783
|
+
// verify the required parameter 'agentId' is set
|
|
64784
|
+
if (agentId === undefined || agentId === null) {
|
|
64785
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64786
|
+
}
|
|
64787
|
+
// verify the required parameter 'explanationId' is set
|
|
64788
|
+
if (explanationId === undefined || explanationId === null) {
|
|
64789
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64790
|
+
}
|
|
64791
|
+
// verify the required parameter 'body' is set
|
|
64792
|
+
if (body === undefined || body === null) {
|
|
64793
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
64794
|
+
}
|
|
64795
|
+
|
|
64796
|
+
return this.apiClient.callApi(
|
|
64797
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
64798
|
+
'PATCH',
|
|
64799
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
64800
|
+
{ },
|
|
64801
|
+
{ },
|
|
64802
|
+
{ },
|
|
64803
|
+
body,
|
|
64804
|
+
['PureCloud OAuth'],
|
|
64805
|
+
['application/json'],
|
|
64806
|
+
['application/json']
|
|
64807
|
+
);
|
|
64808
|
+
}
|
|
64809
|
+
|
|
64432
64810
|
/**
|
|
64433
64811
|
* Update business unit
|
|
64434
64812
|
*
|
|
@@ -64868,6 +65246,61 @@ class WorkforceManagementApi {
|
|
|
64868
65246
|
);
|
|
64869
65247
|
}
|
|
64870
65248
|
|
|
65249
|
+
/**
|
|
65250
|
+
* Submit an adherence explanation for the current user
|
|
65251
|
+
*
|
|
65252
|
+
* @param {Object} body The request body
|
|
65253
|
+
*/
|
|
65254
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
65255
|
+
// verify the required parameter 'body' is set
|
|
65256
|
+
if (body === undefined || body === null) {
|
|
65257
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
65258
|
+
}
|
|
65259
|
+
|
|
65260
|
+
return this.apiClient.callApi(
|
|
65261
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
65262
|
+
'POST',
|
|
65263
|
+
{ },
|
|
65264
|
+
{ },
|
|
65265
|
+
{ },
|
|
65266
|
+
{ },
|
|
65267
|
+
body,
|
|
65268
|
+
['PureCloud OAuth'],
|
|
65269
|
+
['application/json'],
|
|
65270
|
+
['application/json']
|
|
65271
|
+
);
|
|
65272
|
+
}
|
|
65273
|
+
|
|
65274
|
+
/**
|
|
65275
|
+
* Query adherence explanations for the current user
|
|
65276
|
+
*
|
|
65277
|
+
* @param {Object} body The request body
|
|
65278
|
+
* @param {Object} opts Optional parameters
|
|
65279
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65280
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65281
|
+
*/
|
|
65282
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
65283
|
+
opts = opts || {};
|
|
65284
|
+
|
|
65285
|
+
// verify the required parameter 'body' is set
|
|
65286
|
+
if (body === undefined || body === null) {
|
|
65287
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
65288
|
+
}
|
|
65289
|
+
|
|
65290
|
+
return this.apiClient.callApi(
|
|
65291
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
65292
|
+
'POST',
|
|
65293
|
+
{ },
|
|
65294
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65295
|
+
{ },
|
|
65296
|
+
{ },
|
|
65297
|
+
body,
|
|
65298
|
+
['PureCloud OAuth'],
|
|
65299
|
+
['application/json'],
|
|
65300
|
+
['application/json']
|
|
65301
|
+
);
|
|
65302
|
+
}
|
|
65303
|
+
|
|
64871
65304
|
/**
|
|
64872
65305
|
* Request a historical adherence report for users across management units
|
|
64873
65306
|
*
|
|
@@ -64892,6 +65325,71 @@ class WorkforceManagementApi {
|
|
|
64892
65325
|
);
|
|
64893
65326
|
}
|
|
64894
65327
|
|
|
65328
|
+
/**
|
|
65329
|
+
* Add an adherence explanation for the requested user
|
|
65330
|
+
*
|
|
65331
|
+
* @param {String} agentId The ID of the agent to query
|
|
65332
|
+
* @param {Object} body The request body
|
|
65333
|
+
*/
|
|
65334
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
65335
|
+
// verify the required parameter 'agentId' is set
|
|
65336
|
+
if (agentId === undefined || agentId === null) {
|
|
65337
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
65338
|
+
}
|
|
65339
|
+
// verify the required parameter 'body' is set
|
|
65340
|
+
if (body === undefined || body === null) {
|
|
65341
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
65342
|
+
}
|
|
65343
|
+
|
|
65344
|
+
return this.apiClient.callApi(
|
|
65345
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
65346
|
+
'POST',
|
|
65347
|
+
{ 'agentId': agentId },
|
|
65348
|
+
{ },
|
|
65349
|
+
{ },
|
|
65350
|
+
{ },
|
|
65351
|
+
body,
|
|
65352
|
+
['PureCloud OAuth'],
|
|
65353
|
+
['application/json'],
|
|
65354
|
+
['application/json']
|
|
65355
|
+
);
|
|
65356
|
+
}
|
|
65357
|
+
|
|
65358
|
+
/**
|
|
65359
|
+
* Query adherence explanations for the given agent across a specified range
|
|
65360
|
+
*
|
|
65361
|
+
* @param {String} agentId The ID of the agent to query
|
|
65362
|
+
* @param {Object} body The request body
|
|
65363
|
+
* @param {Object} opts Optional parameters
|
|
65364
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65365
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65366
|
+
*/
|
|
65367
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
65368
|
+
opts = opts || {};
|
|
65369
|
+
|
|
65370
|
+
// verify the required parameter 'agentId' is set
|
|
65371
|
+
if (agentId === undefined || agentId === null) {
|
|
65372
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
65373
|
+
}
|
|
65374
|
+
// verify the required parameter 'body' is set
|
|
65375
|
+
if (body === undefined || body === null) {
|
|
65376
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
65377
|
+
}
|
|
65378
|
+
|
|
65379
|
+
return this.apiClient.callApi(
|
|
65380
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
65381
|
+
'POST',
|
|
65382
|
+
{ 'agentId': agentId },
|
|
65383
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65384
|
+
{ },
|
|
65385
|
+
{ },
|
|
65386
|
+
body,
|
|
65387
|
+
['PureCloud OAuth'],
|
|
65388
|
+
['application/json'],
|
|
65389
|
+
['application/json']
|
|
65390
|
+
);
|
|
65391
|
+
}
|
|
65392
|
+
|
|
64895
65393
|
/**
|
|
64896
65394
|
* Get published schedule for the current user
|
|
64897
65395
|
*
|
|
@@ -64945,6 +65443,41 @@ class WorkforceManagementApi {
|
|
|
64945
65443
|
);
|
|
64946
65444
|
}
|
|
64947
65445
|
|
|
65446
|
+
/**
|
|
65447
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
65448
|
+
*
|
|
65449
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
65450
|
+
* @param {Object} body The request body
|
|
65451
|
+
* @param {Object} opts Optional parameters
|
|
65452
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
65453
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
65454
|
+
*/
|
|
65455
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
65456
|
+
opts = opts || {};
|
|
65457
|
+
|
|
65458
|
+
// verify the required parameter 'businessUnitId' is set
|
|
65459
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
65460
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
65461
|
+
}
|
|
65462
|
+
// verify the required parameter 'body' is set
|
|
65463
|
+
if (body === undefined || body === null) {
|
|
65464
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
65465
|
+
}
|
|
65466
|
+
|
|
65467
|
+
return this.apiClient.callApi(
|
|
65468
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
65469
|
+
'POST',
|
|
65470
|
+
{ 'businessUnitId': businessUnitId },
|
|
65471
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
65472
|
+
{ },
|
|
65473
|
+
{ },
|
|
65474
|
+
body,
|
|
65475
|
+
['PureCloud OAuth'],
|
|
65476
|
+
['application/json'],
|
|
65477
|
+
['application/json']
|
|
65478
|
+
);
|
|
65479
|
+
}
|
|
65480
|
+
|
|
64948
65481
|
/**
|
|
64949
65482
|
* Search published schedules
|
|
64950
65483
|
*
|
|
@@ -65772,6 +66305,35 @@ class WorkforceManagementApi {
|
|
|
65772
66305
|
);
|
|
65773
66306
|
}
|
|
65774
66307
|
|
|
66308
|
+
/**
|
|
66309
|
+
* Request a historical shrinkage report
|
|
66310
|
+
* The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
|
|
66311
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
66312
|
+
* @param {Object} opts Optional parameters
|
|
66313
|
+
* @param {Object} opts.body body
|
|
66314
|
+
*/
|
|
66315
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
66316
|
+
opts = opts || {};
|
|
66317
|
+
|
|
66318
|
+
// verify the required parameter 'managementUnitId' is set
|
|
66319
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
66320
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
66321
|
+
}
|
|
66322
|
+
|
|
66323
|
+
return this.apiClient.callApi(
|
|
66324
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
66325
|
+
'POST',
|
|
66326
|
+
{ 'managementUnitId': managementUnitId },
|
|
66327
|
+
{ },
|
|
66328
|
+
{ },
|
|
66329
|
+
{ },
|
|
66330
|
+
opts['body'],
|
|
66331
|
+
['PureCloud OAuth'],
|
|
66332
|
+
['application/json'],
|
|
66333
|
+
['application/json']
|
|
66334
|
+
);
|
|
66335
|
+
}
|
|
66336
|
+
|
|
65775
66337
|
/**
|
|
65776
66338
|
* Creates a new time off limit object under management unit.
|
|
65777
66339
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -66512,7 +67074,7 @@ class WorkforceManagementApi {
|
|
|
66512
67074
|
* </pre>
|
|
66513
67075
|
* </p>
|
|
66514
67076
|
* @module purecloud-platform-client-v2/index
|
|
66515
|
-
* @version
|
|
67077
|
+
* @version 153.0.0
|
|
66516
67078
|
*/
|
|
66517
67079
|
class platformClient {
|
|
66518
67080
|
constructor() {
|