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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 152.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3351,7 +3351,7 @@ class AlertingApi {
|
|
|
3351
3351
|
/**
|
|
3352
3352
|
* Alerting service.
|
|
3353
3353
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3354
|
-
* @version
|
|
3354
|
+
* @version 152.0.0
|
|
3355
3355
|
*/
|
|
3356
3356
|
|
|
3357
3357
|
/**
|
|
@@ -3665,7 +3665,7 @@ class AnalyticsApi {
|
|
|
3665
3665
|
/**
|
|
3666
3666
|
* Analytics service.
|
|
3667
3667
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3668
|
-
* @version
|
|
3668
|
+
* @version 152.0.0
|
|
3669
3669
|
*/
|
|
3670
3670
|
|
|
3671
3671
|
/**
|
|
@@ -3764,6 +3764,7 @@ class AnalyticsApi {
|
|
|
3764
3764
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
3765
3765
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
3766
3766
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
3767
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
3767
3768
|
*/
|
|
3768
3769
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
3769
3770
|
opts = opts || {};
|
|
@@ -3777,7 +3778,7 @@ class AnalyticsApi {
|
|
|
3777
3778
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
3778
3779
|
'GET',
|
|
3779
3780
|
{ 'botFlowId': botFlowId },
|
|
3780
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'] },
|
|
3781
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
3781
3782
|
{ },
|
|
3782
3783
|
{ },
|
|
3783
3784
|
null,
|
|
@@ -4326,6 +4327,31 @@ class AnalyticsApi {
|
|
|
4326
4327
|
);
|
|
4327
4328
|
}
|
|
4328
4329
|
|
|
4330
|
+
/**
|
|
4331
|
+
* Query for action aggregates
|
|
4332
|
+
*
|
|
4333
|
+
* @param {Object} body query
|
|
4334
|
+
*/
|
|
4335
|
+
postAnalyticsActionsAggregatesQuery(body) {
|
|
4336
|
+
// verify the required parameter 'body' is set
|
|
4337
|
+
if (body === undefined || body === null) {
|
|
4338
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
|
|
4339
|
+
}
|
|
4340
|
+
|
|
4341
|
+
return this.apiClient.callApi(
|
|
4342
|
+
'/api/v2/analytics/actions/aggregates/query',
|
|
4343
|
+
'POST',
|
|
4344
|
+
{ },
|
|
4345
|
+
{ },
|
|
4346
|
+
{ },
|
|
4347
|
+
{ },
|
|
4348
|
+
body,
|
|
4349
|
+
['PureCloud OAuth'],
|
|
4350
|
+
['application/json'],
|
|
4351
|
+
['application/json']
|
|
4352
|
+
);
|
|
4353
|
+
}
|
|
4354
|
+
|
|
4329
4355
|
/**
|
|
4330
4356
|
* Query for bot aggregates
|
|
4331
4357
|
*
|
|
@@ -4892,7 +4918,7 @@ class ArchitectApi {
|
|
|
4892
4918
|
/**
|
|
4893
4919
|
* Architect service.
|
|
4894
4920
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4895
|
-
* @version
|
|
4921
|
+
* @version 152.0.0
|
|
4896
4922
|
*/
|
|
4897
4923
|
|
|
4898
4924
|
/**
|
|
@@ -6485,6 +6511,7 @@ class ArchitectApi {
|
|
|
6485
6511
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
6486
6512
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
6487
6513
|
* @param {Boolean} opts.showbrief If true returns just the key value of the row (default to true)
|
|
6514
|
+
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
6488
6515
|
*/
|
|
6489
6516
|
getFlowsDatatableRows(datatableId, opts) {
|
|
6490
6517
|
opts = opts || {};
|
|
@@ -6498,7 +6525,7 @@ class ArchitectApi {
|
|
|
6498
6525
|
'/api/v2/flows/datatables/{datatableId}/rows',
|
|
6499
6526
|
'GET',
|
|
6500
6527
|
{ 'datatableId': datatableId },
|
|
6501
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'] },
|
|
6528
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'],'sortOrder': opts['sortOrder'] },
|
|
6502
6529
|
{ },
|
|
6503
6530
|
{ },
|
|
6504
6531
|
null,
|
|
@@ -6518,7 +6545,7 @@ class ArchitectApi {
|
|
|
6518
6545
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
6519
6546
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
6520
6547
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
6521
|
-
* @param {String} opts.name Name
|
|
6548
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
6522
6549
|
*/
|
|
6523
6550
|
getFlowsDatatables(opts) {
|
|
6524
6551
|
opts = opts || {};
|
|
@@ -6577,7 +6604,7 @@ class ArchitectApi {
|
|
|
6577
6604
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
6578
6605
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
6579
6606
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
6580
|
-
* @param {String} opts.name Name
|
|
6607
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
6581
6608
|
*/
|
|
6582
6609
|
getFlowsDatatablesDivisionviews(opts) {
|
|
6583
6610
|
opts = opts || {};
|
|
@@ -7938,7 +7965,7 @@ class AuditApi {
|
|
|
7938
7965
|
/**
|
|
7939
7966
|
* Audit service.
|
|
7940
7967
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7941
|
-
* @version
|
|
7968
|
+
* @version 152.0.0
|
|
7942
7969
|
*/
|
|
7943
7970
|
|
|
7944
7971
|
/**
|
|
@@ -8109,7 +8136,7 @@ class AuthorizationApi {
|
|
|
8109
8136
|
/**
|
|
8110
8137
|
* Authorization service.
|
|
8111
8138
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8112
|
-
* @version
|
|
8139
|
+
* @version 152.0.0
|
|
8113
8140
|
*/
|
|
8114
8141
|
|
|
8115
8142
|
/**
|
|
@@ -9292,7 +9319,7 @@ class BillingApi {
|
|
|
9292
9319
|
/**
|
|
9293
9320
|
* Billing service.
|
|
9294
9321
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9295
|
-
* @version
|
|
9322
|
+
* @version 152.0.0
|
|
9296
9323
|
*/
|
|
9297
9324
|
|
|
9298
9325
|
/**
|
|
@@ -9372,7 +9399,7 @@ class ChatApi {
|
|
|
9372
9399
|
/**
|
|
9373
9400
|
* Chat service.
|
|
9374
9401
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9375
|
-
* @version
|
|
9402
|
+
* @version 152.0.0
|
|
9376
9403
|
*/
|
|
9377
9404
|
|
|
9378
9405
|
/**
|
|
@@ -9463,7 +9490,7 @@ class CoachingApi {
|
|
|
9463
9490
|
/**
|
|
9464
9491
|
* Coaching service.
|
|
9465
9492
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9466
|
-
* @version
|
|
9493
|
+
* @version 152.0.0
|
|
9467
9494
|
*/
|
|
9468
9495
|
|
|
9469
9496
|
/**
|
|
@@ -10040,7 +10067,7 @@ class ContentManagementApi {
|
|
|
10040
10067
|
/**
|
|
10041
10068
|
* ContentManagement service.
|
|
10042
10069
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10043
|
-
* @version
|
|
10070
|
+
* @version 152.0.0
|
|
10044
10071
|
*/
|
|
10045
10072
|
|
|
10046
10073
|
/**
|
|
@@ -11180,7 +11207,7 @@ class ConversationsApi {
|
|
|
11180
11207
|
/**
|
|
11181
11208
|
* Conversations service.
|
|
11182
11209
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11183
|
-
* @version
|
|
11210
|
+
* @version 152.0.0
|
|
11184
11211
|
*/
|
|
11185
11212
|
|
|
11186
11213
|
/**
|
|
@@ -12859,8 +12886,9 @@ class ConversationsApi {
|
|
|
12859
12886
|
* @param {Object} opts Optional parameters
|
|
12860
12887
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
12861
12888
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12862
|
-
* @param {
|
|
12889
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value.
|
|
12863
12890
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
12891
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
12864
12892
|
*/
|
|
12865
12893
|
getConversationsMessagingIntegrations(opts) {
|
|
12866
12894
|
opts = opts || {};
|
|
@@ -12870,7 +12898,7 @@ class ConversationsApi {
|
|
|
12870
12898
|
'/api/v2/conversations/messaging/integrations',
|
|
12871
12899
|
'GET',
|
|
12872
12900
|
{ },
|
|
12873
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
12901
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
12874
12902
|
{ },
|
|
12875
12903
|
{ },
|
|
12876
12904
|
null,
|
|
@@ -12888,6 +12916,7 @@ class ConversationsApi {
|
|
|
12888
12916
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12889
12917
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
12890
12918
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
12919
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
12891
12920
|
*/
|
|
12892
12921
|
getConversationsMessagingIntegrationsFacebook(opts) {
|
|
12893
12922
|
opts = opts || {};
|
|
@@ -12897,7 +12926,7 @@ class ConversationsApi {
|
|
|
12897
12926
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
12898
12927
|
'GET',
|
|
12899
12928
|
{ },
|
|
12900
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
12929
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
12901
12930
|
{ },
|
|
12902
12931
|
{ },
|
|
12903
12932
|
null,
|
|
@@ -12944,6 +12973,7 @@ class ConversationsApi {
|
|
|
12944
12973
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12945
12974
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
12946
12975
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
12976
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
12947
12977
|
*/
|
|
12948
12978
|
getConversationsMessagingIntegrationsLine(opts) {
|
|
12949
12979
|
opts = opts || {};
|
|
@@ -12953,7 +12983,7 @@ class ConversationsApi {
|
|
|
12953
12983
|
'/api/v2/conversations/messaging/integrations/line',
|
|
12954
12984
|
'GET',
|
|
12955
12985
|
{ },
|
|
12956
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
12986
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
12957
12987
|
{ },
|
|
12958
12988
|
{ },
|
|
12959
12989
|
null,
|
|
@@ -13000,6 +13030,7 @@ class ConversationsApi {
|
|
|
13000
13030
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13001
13031
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
13002
13032
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
13033
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
13003
13034
|
*/
|
|
13004
13035
|
getConversationsMessagingIntegrationsOpen(opts) {
|
|
13005
13036
|
opts = opts || {};
|
|
@@ -13009,7 +13040,7 @@ class ConversationsApi {
|
|
|
13009
13040
|
'/api/v2/conversations/messaging/integrations/open',
|
|
13010
13041
|
'GET',
|
|
13011
13042
|
{ },
|
|
13012
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
13043
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
13013
13044
|
{ },
|
|
13014
13045
|
{ },
|
|
13015
13046
|
null,
|
|
@@ -13056,6 +13087,7 @@ class ConversationsApi {
|
|
|
13056
13087
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13057
13088
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
13058
13089
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
13090
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
13059
13091
|
*/
|
|
13060
13092
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
13061
13093
|
opts = opts || {};
|
|
@@ -13065,7 +13097,7 @@ class ConversationsApi {
|
|
|
13065
13097
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
13066
13098
|
'GET',
|
|
13067
13099
|
{ },
|
|
13068
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
13100
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
13069
13101
|
{ },
|
|
13070
13102
|
{ },
|
|
13071
13103
|
null,
|
|
@@ -13112,6 +13144,7 @@ class ConversationsApi {
|
|
|
13112
13144
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13113
13145
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
13114
13146
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
13147
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
13115
13148
|
*/
|
|
13116
13149
|
getConversationsMessagingIntegrationsWhatsapp(opts) {
|
|
13117
13150
|
opts = opts || {};
|
|
@@ -13121,7 +13154,7 @@ class ConversationsApi {
|
|
|
13121
13154
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
13122
13155
|
'GET',
|
|
13123
13156
|
{ },
|
|
13124
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
13157
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
13125
13158
|
{ },
|
|
13126
13159
|
{ },
|
|
13127
13160
|
null,
|
|
@@ -15526,6 +15559,41 @@ class ConversationsApi {
|
|
|
15526
15559
|
);
|
|
15527
15560
|
}
|
|
15528
15561
|
|
|
15562
|
+
/**
|
|
15563
|
+
* Send message typing event
|
|
15564
|
+
* Send message typing event for existing conversation/communication.
|
|
15565
|
+
* @param {String} conversationId conversationId
|
|
15566
|
+
* @param {String} communicationId communicationId
|
|
15567
|
+
* @param {Object} body MessageTypingEvent
|
|
15568
|
+
*/
|
|
15569
|
+
postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
|
|
15570
|
+
// verify the required parameter 'conversationId' is set
|
|
15571
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15572
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
|
|
15573
|
+
}
|
|
15574
|
+
// verify the required parameter 'communicationId' is set
|
|
15575
|
+
if (communicationId === undefined || communicationId === null) {
|
|
15576
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
|
|
15577
|
+
}
|
|
15578
|
+
// verify the required parameter 'body' is set
|
|
15579
|
+
if (body === undefined || body === null) {
|
|
15580
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
|
|
15581
|
+
}
|
|
15582
|
+
|
|
15583
|
+
return this.apiClient.callApi(
|
|
15584
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
|
|
15585
|
+
'POST',
|
|
15586
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
15587
|
+
{ },
|
|
15588
|
+
{ },
|
|
15589
|
+
{ },
|
|
15590
|
+
body,
|
|
15591
|
+
['PureCloud OAuth'],
|
|
15592
|
+
['application/json'],
|
|
15593
|
+
['application/json']
|
|
15594
|
+
);
|
|
15595
|
+
}
|
|
15596
|
+
|
|
15529
15597
|
/**
|
|
15530
15598
|
* Get messages in batch
|
|
15531
15599
|
* 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"]
|
|
@@ -16362,7 +16430,7 @@ class DataExtensionsApi {
|
|
|
16362
16430
|
/**
|
|
16363
16431
|
* DataExtensions service.
|
|
16364
16432
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16365
|
-
* @version
|
|
16433
|
+
* @version 152.0.0
|
|
16366
16434
|
*/
|
|
16367
16435
|
|
|
16368
16436
|
/**
|
|
@@ -16448,7 +16516,7 @@ class DownloadsApi {
|
|
|
16448
16516
|
/**
|
|
16449
16517
|
* Downloads service.
|
|
16450
16518
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
16451
|
-
* @version
|
|
16519
|
+
* @version 152.0.0
|
|
16452
16520
|
*/
|
|
16453
16521
|
|
|
16454
16522
|
/**
|
|
@@ -16500,7 +16568,7 @@ class EventsApi {
|
|
|
16500
16568
|
/**
|
|
16501
16569
|
* Events service.
|
|
16502
16570
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
16503
|
-
* @version
|
|
16571
|
+
* @version 152.0.0
|
|
16504
16572
|
*/
|
|
16505
16573
|
|
|
16506
16574
|
/**
|
|
@@ -16596,7 +16664,7 @@ class ExternalContactsApi {
|
|
|
16596
16664
|
/**
|
|
16597
16665
|
* ExternalContacts service.
|
|
16598
16666
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16599
|
-
* @version
|
|
16667
|
+
* @version 152.0.0
|
|
16600
16668
|
*/
|
|
16601
16669
|
|
|
16602
16670
|
/**
|
|
@@ -16850,6 +16918,37 @@ class ExternalContactsApi {
|
|
|
16850
16918
|
);
|
|
16851
16919
|
}
|
|
16852
16920
|
|
|
16921
|
+
/**
|
|
16922
|
+
* Retrieve all sessions for a given external contact.
|
|
16923
|
+
*
|
|
16924
|
+
* @param {String} contactId ExternalContact ID
|
|
16925
|
+
* @param {Object} opts Optional parameters
|
|
16926
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
16927
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16928
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
16929
|
+
*/
|
|
16930
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
16931
|
+
opts = opts || {};
|
|
16932
|
+
|
|
16933
|
+
// verify the required parameter 'contactId' is set
|
|
16934
|
+
if (contactId === undefined || contactId === null) {
|
|
16935
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
16936
|
+
}
|
|
16937
|
+
|
|
16938
|
+
return this.apiClient.callApi(
|
|
16939
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
16940
|
+
'GET',
|
|
16941
|
+
{ 'contactId': contactId },
|
|
16942
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
16943
|
+
{ },
|
|
16944
|
+
{ },
|
|
16945
|
+
null,
|
|
16946
|
+
['PureCloud OAuth'],
|
|
16947
|
+
['application/json'],
|
|
16948
|
+
['application/json']
|
|
16949
|
+
);
|
|
16950
|
+
}
|
|
16951
|
+
|
|
16853
16952
|
/**
|
|
16854
16953
|
* Fetch a note for an external contact
|
|
16855
16954
|
*
|
|
@@ -18523,7 +18622,7 @@ class FaxApi {
|
|
|
18523
18622
|
/**
|
|
18524
18623
|
* Fax service.
|
|
18525
18624
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
18526
|
-
* @version
|
|
18625
|
+
* @version 152.0.0
|
|
18527
18626
|
*/
|
|
18528
18627
|
|
|
18529
18628
|
/**
|
|
@@ -18694,7 +18793,7 @@ class FlowsApi {
|
|
|
18694
18793
|
/**
|
|
18695
18794
|
* Flows service.
|
|
18696
18795
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18697
|
-
* @version
|
|
18796
|
+
* @version 152.0.0
|
|
18698
18797
|
*/
|
|
18699
18798
|
|
|
18700
18799
|
/**
|
|
@@ -18765,7 +18864,7 @@ class GamificationApi {
|
|
|
18765
18864
|
/**
|
|
18766
18865
|
* Gamification service.
|
|
18767
18866
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18768
|
-
* @version
|
|
18867
|
+
* @version 152.0.0
|
|
18769
18868
|
*/
|
|
18770
18869
|
|
|
18771
18870
|
/**
|
|
@@ -18983,36 +19082,6 @@ class GamificationApi {
|
|
|
18983
19082
|
);
|
|
18984
19083
|
}
|
|
18985
19084
|
|
|
18986
|
-
/**
|
|
18987
|
-
* Gamified metric by id
|
|
18988
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
18989
|
-
* @param {String} metricId metric Id
|
|
18990
|
-
* @param {Object} opts Optional parameters
|
|
18991
|
-
* @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
|
|
18992
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
18993
|
-
*/
|
|
18994
|
-
getGamificationMetric(metricId, opts) {
|
|
18995
|
-
opts = opts || {};
|
|
18996
|
-
|
|
18997
|
-
// verify the required parameter 'metricId' is set
|
|
18998
|
-
if (metricId === undefined || metricId === null) {
|
|
18999
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
19000
|
-
}
|
|
19001
|
-
|
|
19002
|
-
return this.apiClient.callApi(
|
|
19003
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
19004
|
-
'GET',
|
|
19005
|
-
{ 'metricId': metricId },
|
|
19006
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
19007
|
-
{ },
|
|
19008
|
-
{ },
|
|
19009
|
-
null,
|
|
19010
|
-
['PureCloud OAuth'],
|
|
19011
|
-
['application/json'],
|
|
19012
|
-
['application/json']
|
|
19013
|
-
);
|
|
19014
|
-
}
|
|
19015
|
-
|
|
19016
19085
|
/**
|
|
19017
19086
|
* Metric definition by id
|
|
19018
19087
|
*
|
|
@@ -20317,40 +20386,6 @@ class GamificationApi {
|
|
|
20317
20386
|
);
|
|
20318
20387
|
}
|
|
20319
20388
|
|
|
20320
|
-
/**
|
|
20321
|
-
* Updates a metric
|
|
20322
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
20323
|
-
* @param {String} metricId metric Id
|
|
20324
|
-
* @param {Object} body Metric
|
|
20325
|
-
* @param {Object} opts Optional parameters
|
|
20326
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
20327
|
-
*/
|
|
20328
|
-
putGamificationMetric(metricId, body, opts) {
|
|
20329
|
-
opts = opts || {};
|
|
20330
|
-
|
|
20331
|
-
// verify the required parameter 'metricId' is set
|
|
20332
|
-
if (metricId === undefined || metricId === null) {
|
|
20333
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
20334
|
-
}
|
|
20335
|
-
// verify the required parameter 'body' is set
|
|
20336
|
-
if (body === undefined || body === null) {
|
|
20337
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
20338
|
-
}
|
|
20339
|
-
|
|
20340
|
-
return this.apiClient.callApi(
|
|
20341
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
20342
|
-
'PUT',
|
|
20343
|
-
{ 'metricId': metricId },
|
|
20344
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
20345
|
-
{ },
|
|
20346
|
-
{ },
|
|
20347
|
-
body,
|
|
20348
|
-
['PureCloud OAuth'],
|
|
20349
|
-
['application/json'],
|
|
20350
|
-
['application/json']
|
|
20351
|
-
);
|
|
20352
|
-
}
|
|
20353
|
-
|
|
20354
20389
|
/**
|
|
20355
20390
|
* Updates a performance profile
|
|
20356
20391
|
*
|
|
@@ -20446,7 +20481,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
20446
20481
|
/**
|
|
20447
20482
|
* GeneralDataProtectionRegulation service.
|
|
20448
20483
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
20449
|
-
* @version
|
|
20484
|
+
* @version 152.0.0
|
|
20450
20485
|
*/
|
|
20451
20486
|
|
|
20452
20487
|
/**
|
|
@@ -20576,7 +20611,7 @@ class GeolocationApi {
|
|
|
20576
20611
|
/**
|
|
20577
20612
|
* Geolocation service.
|
|
20578
20613
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20579
|
-
* @version
|
|
20614
|
+
* @version 152.0.0
|
|
20580
20615
|
*/
|
|
20581
20616
|
|
|
20582
20617
|
/**
|
|
@@ -20707,7 +20742,7 @@ class GreetingsApi {
|
|
|
20707
20742
|
/**
|
|
20708
20743
|
* Greetings service.
|
|
20709
20744
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20710
|
-
* @version
|
|
20745
|
+
* @version 152.0.0
|
|
20711
20746
|
*/
|
|
20712
20747
|
|
|
20713
20748
|
/**
|
|
@@ -21162,7 +21197,7 @@ class GroupsApi {
|
|
|
21162
21197
|
/**
|
|
21163
21198
|
* Groups service.
|
|
21164
21199
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
21165
|
-
* @version
|
|
21200
|
+
* @version 152.0.0
|
|
21166
21201
|
*/
|
|
21167
21202
|
|
|
21168
21203
|
/**
|
|
@@ -21568,7 +21603,7 @@ class IdentityProviderApi {
|
|
|
21568
21603
|
/**
|
|
21569
21604
|
* IdentityProvider service.
|
|
21570
21605
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21571
|
-
* @version
|
|
21606
|
+
* @version 152.0.0
|
|
21572
21607
|
*/
|
|
21573
21608
|
|
|
21574
21609
|
/**
|
|
@@ -22324,7 +22359,7 @@ class IntegrationsApi {
|
|
|
22324
22359
|
/**
|
|
22325
22360
|
* Integrations service.
|
|
22326
22361
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
22327
|
-
* @version
|
|
22362
|
+
* @version 152.0.0
|
|
22328
22363
|
*/
|
|
22329
22364
|
|
|
22330
22365
|
/**
|
|
@@ -23924,7 +23959,7 @@ class JourneyApi {
|
|
|
23924
23959
|
/**
|
|
23925
23960
|
* Journey service.
|
|
23926
23961
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23927
|
-
* @version
|
|
23962
|
+
* @version 152.0.0
|
|
23928
23963
|
*/
|
|
23929
23964
|
|
|
23930
23965
|
/**
|
|
@@ -24710,7 +24745,7 @@ class KnowledgeApi {
|
|
|
24710
24745
|
/**
|
|
24711
24746
|
* Knowledge service.
|
|
24712
24747
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24713
|
-
* @version
|
|
24748
|
+
* @version 152.0.0
|
|
24714
24749
|
*/
|
|
24715
24750
|
|
|
24716
24751
|
/**
|
|
@@ -25113,8 +25148,8 @@ class KnowledgeApi {
|
|
|
25113
25148
|
* @param {String} sessionId Knowledge guest session ID.
|
|
25114
25149
|
* @param {Object} opts Optional parameters
|
|
25115
25150
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
25116
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
25117
|
-
* @param {
|
|
25151
|
+
* @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.
|
|
25152
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
25118
25153
|
*/
|
|
25119
25154
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
25120
25155
|
opts = opts || {};
|
|
@@ -27143,7 +27178,7 @@ class LanguageUnderstandingApi {
|
|
|
27143
27178
|
/**
|
|
27144
27179
|
* LanguageUnderstanding service.
|
|
27145
27180
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
27146
|
-
* @version
|
|
27181
|
+
* @version 152.0.0
|
|
27147
27182
|
*/
|
|
27148
27183
|
|
|
27149
27184
|
/**
|
|
@@ -28047,7 +28082,7 @@ class LanguagesApi {
|
|
|
28047
28082
|
/**
|
|
28048
28083
|
* Languages service.
|
|
28049
28084
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
28050
|
-
* @version
|
|
28085
|
+
* @version 152.0.0
|
|
28051
28086
|
*/
|
|
28052
28087
|
|
|
28053
28088
|
/**
|
|
@@ -28315,7 +28350,7 @@ class LearningApi {
|
|
|
28315
28350
|
/**
|
|
28316
28351
|
* Learning service.
|
|
28317
28352
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
28318
|
-
* @version
|
|
28353
|
+
* @version 152.0.0
|
|
28319
28354
|
*/
|
|
28320
28355
|
|
|
28321
28356
|
/**
|
|
@@ -29075,7 +29110,7 @@ class LicenseApi {
|
|
|
29075
29110
|
/**
|
|
29076
29111
|
* License service.
|
|
29077
29112
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
29078
|
-
* @version
|
|
29113
|
+
* @version 152.0.0
|
|
29079
29114
|
*/
|
|
29080
29115
|
|
|
29081
29116
|
/**
|
|
@@ -29313,7 +29348,7 @@ class LocationsApi {
|
|
|
29313
29348
|
/**
|
|
29314
29349
|
* Locations service.
|
|
29315
29350
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
29316
|
-
* @version
|
|
29351
|
+
* @version 152.0.0
|
|
29317
29352
|
*/
|
|
29318
29353
|
|
|
29319
29354
|
/**
|
|
@@ -29549,7 +29584,7 @@ class MessagingApi {
|
|
|
29549
29584
|
/**
|
|
29550
29585
|
* Messaging service.
|
|
29551
29586
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
29552
|
-
* @version
|
|
29587
|
+
* @version 152.0.0
|
|
29553
29588
|
*/
|
|
29554
29589
|
|
|
29555
29590
|
/**
|
|
@@ -29700,7 +29735,7 @@ class MobileDevicesApi {
|
|
|
29700
29735
|
/**
|
|
29701
29736
|
* MobileDevices service.
|
|
29702
29737
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
29703
|
-
* @version
|
|
29738
|
+
* @version 152.0.0
|
|
29704
29739
|
*/
|
|
29705
29740
|
|
|
29706
29741
|
/**
|
|
@@ -29851,7 +29886,7 @@ class NotificationsApi {
|
|
|
29851
29886
|
/**
|
|
29852
29887
|
* Notifications service.
|
|
29853
29888
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
29854
|
-
* @version
|
|
29889
|
+
* @version 152.0.0
|
|
29855
29890
|
*/
|
|
29856
29891
|
|
|
29857
29892
|
/**
|
|
@@ -30076,7 +30111,7 @@ class OAuthApi {
|
|
|
30076
30111
|
/**
|
|
30077
30112
|
* OAuth service.
|
|
30078
30113
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
30079
|
-
* @version
|
|
30114
|
+
* @version 152.0.0
|
|
30080
30115
|
*/
|
|
30081
30116
|
|
|
30082
30117
|
/**
|
|
@@ -30442,7 +30477,7 @@ class ObjectsApi {
|
|
|
30442
30477
|
/**
|
|
30443
30478
|
* Objects service.
|
|
30444
30479
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
30445
|
-
* @version
|
|
30480
|
+
* @version 152.0.0
|
|
30446
30481
|
*/
|
|
30447
30482
|
|
|
30448
30483
|
/**
|
|
@@ -30713,7 +30748,7 @@ class OrganizationApi {
|
|
|
30713
30748
|
/**
|
|
30714
30749
|
* Organization service.
|
|
30715
30750
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
30716
|
-
* @version
|
|
30751
|
+
* @version 152.0.0
|
|
30717
30752
|
*/
|
|
30718
30753
|
|
|
30719
30754
|
/**
|
|
@@ -31116,7 +31151,7 @@ class OrganizationAuthorizationApi {
|
|
|
31116
31151
|
/**
|
|
31117
31152
|
* OrganizationAuthorization service.
|
|
31118
31153
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
31119
|
-
* @version
|
|
31154
|
+
* @version 152.0.0
|
|
31120
31155
|
*/
|
|
31121
31156
|
|
|
31122
31157
|
/**
|
|
@@ -32041,7 +32076,7 @@ class OutboundApi {
|
|
|
32041
32076
|
/**
|
|
32042
32077
|
* Outbound service.
|
|
32043
32078
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
32044
|
-
* @version
|
|
32079
|
+
* @version 152.0.0
|
|
32045
32080
|
*/
|
|
32046
32081
|
|
|
32047
32082
|
/**
|
|
@@ -35430,7 +35465,7 @@ class PresenceApi {
|
|
|
35430
35465
|
/**
|
|
35431
35466
|
* Presence service.
|
|
35432
35467
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
35433
|
-
* @version
|
|
35468
|
+
* @version 152.0.0
|
|
35434
35469
|
*/
|
|
35435
35470
|
|
|
35436
35471
|
/**
|
|
@@ -35524,7 +35559,7 @@ class PresenceApi {
|
|
|
35524
35559
|
* Get a list of Presence Sources
|
|
35525
35560
|
*
|
|
35526
35561
|
* @param {Object} opts Optional parameters
|
|
35527
|
-
* @param {String} opts.
|
|
35562
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
35528
35563
|
*/
|
|
35529
35564
|
getPresenceSources(opts) {
|
|
35530
35565
|
opts = opts || {};
|
|
@@ -35534,7 +35569,7 @@ class PresenceApi {
|
|
|
35534
35569
|
'/api/v2/presence/sources',
|
|
35535
35570
|
'GET',
|
|
35536
35571
|
{ },
|
|
35537
|
-
{ '
|
|
35572
|
+
{ 'deactivated': opts['deactivated'] },
|
|
35538
35573
|
{ },
|
|
35539
35574
|
{ },
|
|
35540
35575
|
null,
|
|
@@ -35936,7 +35971,7 @@ class ProcessAutomationApi {
|
|
|
35936
35971
|
/**
|
|
35937
35972
|
* ProcessAutomation service.
|
|
35938
35973
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
35939
|
-
* @version
|
|
35974
|
+
* @version 152.0.0
|
|
35940
35975
|
*/
|
|
35941
35976
|
|
|
35942
35977
|
/**
|
|
@@ -35977,7 +36012,7 @@ class ProcessAutomationApi {
|
|
|
35977
36012
|
}
|
|
35978
36013
|
|
|
35979
36014
|
/**
|
|
35980
|
-
* Retrieve a single Trigger matching id
|
|
36015
|
+
* Retrieve a single Trigger matching id
|
|
35981
36016
|
*
|
|
35982
36017
|
* @param {String} triggerId triggerId
|
|
35983
36018
|
*/
|
|
@@ -36002,13 +36037,13 @@ class ProcessAutomationApi {
|
|
|
36002
36037
|
}
|
|
36003
36038
|
|
|
36004
36039
|
/**
|
|
36005
|
-
* Retrieves all triggers
|
|
36040
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
36006
36041
|
*
|
|
36007
36042
|
* @param {Object} opts Optional parameters
|
|
36008
36043
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
36009
36044
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
36010
36045
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
36011
|
-
* @param {String} opts.topicName Topic name
|
|
36046
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
36012
36047
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
36013
36048
|
*/
|
|
36014
36049
|
getProcessautomationTriggers(opts) {
|
|
@@ -36174,7 +36209,7 @@ class QualityApi {
|
|
|
36174
36209
|
/**
|
|
36175
36210
|
* Quality service.
|
|
36176
36211
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
36177
|
-
* @version
|
|
36212
|
+
* @version 152.0.0
|
|
36178
36213
|
*/
|
|
36179
36214
|
|
|
36180
36215
|
/**
|
|
@@ -37752,7 +37787,7 @@ class RecordingApi {
|
|
|
37752
37787
|
/**
|
|
37753
37788
|
* Recording service.
|
|
37754
37789
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
37755
|
-
* @version
|
|
37790
|
+
* @version 152.0.0
|
|
37756
37791
|
*/
|
|
37757
37792
|
|
|
37758
37793
|
/**
|
|
@@ -39439,7 +39474,7 @@ class ResponseManagementApi {
|
|
|
39439
39474
|
/**
|
|
39440
39475
|
* ResponseManagement service.
|
|
39441
39476
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
39442
|
-
* @version
|
|
39477
|
+
* @version 152.0.0
|
|
39443
39478
|
*/
|
|
39444
39479
|
|
|
39445
39480
|
/**
|
|
@@ -39923,7 +39958,7 @@ class RoutingApi {
|
|
|
39923
39958
|
/**
|
|
39924
39959
|
* Routing service.
|
|
39925
39960
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
39926
|
-
* @version
|
|
39961
|
+
* @version 152.0.0
|
|
39927
39962
|
*/
|
|
39928
39963
|
|
|
39929
39964
|
/**
|
|
@@ -40232,6 +40267,31 @@ class RoutingApi {
|
|
|
40232
40267
|
);
|
|
40233
40268
|
}
|
|
40234
40269
|
|
|
40270
|
+
/**
|
|
40271
|
+
* Remove skill group definition
|
|
40272
|
+
*
|
|
40273
|
+
* @param {String} skillGroupId Skill Group ID
|
|
40274
|
+
*/
|
|
40275
|
+
deleteRoutingSkillgroup(skillGroupId) {
|
|
40276
|
+
// verify the required parameter 'skillGroupId' is set
|
|
40277
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
40278
|
+
throw 'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';
|
|
40279
|
+
}
|
|
40280
|
+
|
|
40281
|
+
return this.apiClient.callApi(
|
|
40282
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
40283
|
+
'DELETE',
|
|
40284
|
+
{ 'skillGroupId': skillGroupId },
|
|
40285
|
+
{ },
|
|
40286
|
+
{ },
|
|
40287
|
+
{ },
|
|
40288
|
+
null,
|
|
40289
|
+
['PureCloud OAuth'],
|
|
40290
|
+
['application/json'],
|
|
40291
|
+
['application/json']
|
|
40292
|
+
);
|
|
40293
|
+
}
|
|
40294
|
+
|
|
40235
40295
|
/**
|
|
40236
40296
|
* Delete an Address by Id for SMS
|
|
40237
40297
|
*
|
|
@@ -41417,6 +41477,119 @@ class RoutingApi {
|
|
|
41417
41477
|
);
|
|
41418
41478
|
}
|
|
41419
41479
|
|
|
41480
|
+
/**
|
|
41481
|
+
* Get skill group
|
|
41482
|
+
*
|
|
41483
|
+
* @param {String} skillGroupId Skill Group ID
|
|
41484
|
+
*/
|
|
41485
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
41486
|
+
// verify the required parameter 'skillGroupId' is set
|
|
41487
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
41488
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
41489
|
+
}
|
|
41490
|
+
|
|
41491
|
+
return this.apiClient.callApi(
|
|
41492
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
41493
|
+
'GET',
|
|
41494
|
+
{ 'skillGroupId': skillGroupId },
|
|
41495
|
+
{ },
|
|
41496
|
+
{ },
|
|
41497
|
+
{ },
|
|
41498
|
+
null,
|
|
41499
|
+
['PureCloud OAuth'],
|
|
41500
|
+
['application/json'],
|
|
41501
|
+
['application/json']
|
|
41502
|
+
);
|
|
41503
|
+
}
|
|
41504
|
+
|
|
41505
|
+
/**
|
|
41506
|
+
* Get skill group members
|
|
41507
|
+
*
|
|
41508
|
+
* @param {String} skillGroupId Skill Group ID
|
|
41509
|
+
* @param {Object} opts Optional parameters
|
|
41510
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41511
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
41512
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
41513
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
41514
|
+
*/
|
|
41515
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
41516
|
+
opts = opts || {};
|
|
41517
|
+
|
|
41518
|
+
// verify the required parameter 'skillGroupId' is set
|
|
41519
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
41520
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
41521
|
+
}
|
|
41522
|
+
|
|
41523
|
+
return this.apiClient.callApi(
|
|
41524
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
41525
|
+
'GET',
|
|
41526
|
+
{ 'skillGroupId': skillGroupId },
|
|
41527
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
41528
|
+
{ },
|
|
41529
|
+
{ },
|
|
41530
|
+
null,
|
|
41531
|
+
['PureCloud OAuth'],
|
|
41532
|
+
['application/json'],
|
|
41533
|
+
['application/json']
|
|
41534
|
+
);
|
|
41535
|
+
}
|
|
41536
|
+
|
|
41537
|
+
/**
|
|
41538
|
+
* Get list of member divisions for this skill group.
|
|
41539
|
+
*
|
|
41540
|
+
* @param {String} skillGroupId Skill Group ID
|
|
41541
|
+
* @param {Object} opts Optional parameters
|
|
41542
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
41543
|
+
*/
|
|
41544
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
41545
|
+
opts = opts || {};
|
|
41546
|
+
|
|
41547
|
+
// verify the required parameter 'skillGroupId' is set
|
|
41548
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
41549
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
41550
|
+
}
|
|
41551
|
+
|
|
41552
|
+
return this.apiClient.callApi(
|
|
41553
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
41554
|
+
'GET',
|
|
41555
|
+
{ 'skillGroupId': skillGroupId },
|
|
41556
|
+
{ 'expand': opts['expand'] },
|
|
41557
|
+
{ },
|
|
41558
|
+
{ },
|
|
41559
|
+
null,
|
|
41560
|
+
['PureCloud OAuth'],
|
|
41561
|
+
['application/json'],
|
|
41562
|
+
['application/json']
|
|
41563
|
+
);
|
|
41564
|
+
}
|
|
41565
|
+
|
|
41566
|
+
/**
|
|
41567
|
+
* Get skill group listing
|
|
41568
|
+
*
|
|
41569
|
+
* @param {Object} opts Optional parameters
|
|
41570
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41571
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
41572
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
41573
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
41574
|
+
*/
|
|
41575
|
+
getRoutingSkillgroups(opts) {
|
|
41576
|
+
opts = opts || {};
|
|
41577
|
+
|
|
41578
|
+
|
|
41579
|
+
return this.apiClient.callApi(
|
|
41580
|
+
'/api/v2/routing/skillgroups',
|
|
41581
|
+
'GET',
|
|
41582
|
+
{ },
|
|
41583
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
41584
|
+
{ },
|
|
41585
|
+
{ },
|
|
41586
|
+
null,
|
|
41587
|
+
['PureCloud OAuth'],
|
|
41588
|
+
['application/json'],
|
|
41589
|
+
['application/json']
|
|
41590
|
+
);
|
|
41591
|
+
}
|
|
41592
|
+
|
|
41420
41593
|
/**
|
|
41421
41594
|
* Get the list of routing skills.
|
|
41422
41595
|
*
|
|
@@ -42055,6 +42228,36 @@ class RoutingApi {
|
|
|
42055
42228
|
);
|
|
42056
42229
|
}
|
|
42057
42230
|
|
|
42231
|
+
/**
|
|
42232
|
+
* Update skill group definition
|
|
42233
|
+
*
|
|
42234
|
+
* @param {String} skillGroupId Skill Group ID
|
|
42235
|
+
* @param {Object} body Update skill groups
|
|
42236
|
+
*/
|
|
42237
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
42238
|
+
// verify the required parameter 'skillGroupId' is set
|
|
42239
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
42240
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
42241
|
+
}
|
|
42242
|
+
// verify the required parameter 'body' is set
|
|
42243
|
+
if (body === undefined || body === null) {
|
|
42244
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
42245
|
+
}
|
|
42246
|
+
|
|
42247
|
+
return this.apiClient.callApi(
|
|
42248
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
42249
|
+
'PATCH',
|
|
42250
|
+
{ 'skillGroupId': skillGroupId },
|
|
42251
|
+
{ },
|
|
42252
|
+
{ },
|
|
42253
|
+
{ },
|
|
42254
|
+
body,
|
|
42255
|
+
['PureCloud OAuth'],
|
|
42256
|
+
['application/json'],
|
|
42257
|
+
['application/json']
|
|
42258
|
+
);
|
|
42259
|
+
}
|
|
42260
|
+
|
|
42058
42261
|
/**
|
|
42059
42262
|
* Join or unjoin a queue for a user
|
|
42060
42263
|
*
|
|
@@ -42598,6 +42801,60 @@ class RoutingApi {
|
|
|
42598
42801
|
);
|
|
42599
42802
|
}
|
|
42600
42803
|
|
|
42804
|
+
/**
|
|
42805
|
+
* Add or remove member divisions for this skill group.
|
|
42806
|
+
*
|
|
42807
|
+
* @param {String} skillGroupId Skill Group ID
|
|
42808
|
+
* @param {Object} opts Optional parameters
|
|
42809
|
+
* @param {Object} opts.body
|
|
42810
|
+
*/
|
|
42811
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
42812
|
+
opts = opts || {};
|
|
42813
|
+
|
|
42814
|
+
// verify the required parameter 'skillGroupId' is set
|
|
42815
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
42816
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
42817
|
+
}
|
|
42818
|
+
|
|
42819
|
+
return this.apiClient.callApi(
|
|
42820
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
42821
|
+
'POST',
|
|
42822
|
+
{ 'skillGroupId': skillGroupId },
|
|
42823
|
+
{ },
|
|
42824
|
+
{ },
|
|
42825
|
+
{ },
|
|
42826
|
+
opts['body'],
|
|
42827
|
+
['PureCloud OAuth'],
|
|
42828
|
+
['application/json'],
|
|
42829
|
+
['application/json']
|
|
42830
|
+
);
|
|
42831
|
+
}
|
|
42832
|
+
|
|
42833
|
+
/**
|
|
42834
|
+
* Create a skill group
|
|
42835
|
+
*
|
|
42836
|
+
* @param {Object} body Create skill group
|
|
42837
|
+
*/
|
|
42838
|
+
postRoutingSkillgroups(body) {
|
|
42839
|
+
// verify the required parameter 'body' is set
|
|
42840
|
+
if (body === undefined || body === null) {
|
|
42841
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
42842
|
+
}
|
|
42843
|
+
|
|
42844
|
+
return this.apiClient.callApi(
|
|
42845
|
+
'/api/v2/routing/skillgroups',
|
|
42846
|
+
'POST',
|
|
42847
|
+
{ },
|
|
42848
|
+
{ },
|
|
42849
|
+
{ },
|
|
42850
|
+
{ },
|
|
42851
|
+
body,
|
|
42852
|
+
['PureCloud OAuth'],
|
|
42853
|
+
['application/json'],
|
|
42854
|
+
['application/json']
|
|
42855
|
+
);
|
|
42856
|
+
}
|
|
42857
|
+
|
|
42601
42858
|
/**
|
|
42602
42859
|
* Create Skill
|
|
42603
42860
|
*
|
|
@@ -43114,7 +43371,7 @@ class SCIMApi {
|
|
|
43114
43371
|
/**
|
|
43115
43372
|
* SCIM service.
|
|
43116
43373
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
43117
|
-
* @version
|
|
43374
|
+
* @version 152.0.0
|
|
43118
43375
|
*/
|
|
43119
43376
|
|
|
43120
43377
|
/**
|
|
@@ -43991,7 +44248,7 @@ class ScriptsApi {
|
|
|
43991
44248
|
/**
|
|
43992
44249
|
* Scripts service.
|
|
43993
44250
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
43994
|
-
* @version
|
|
44251
|
+
* @version 152.0.0
|
|
43995
44252
|
*/
|
|
43996
44253
|
|
|
43997
44254
|
/**
|
|
@@ -44410,7 +44667,7 @@ class SearchApi {
|
|
|
44410
44667
|
/**
|
|
44411
44668
|
* Search service.
|
|
44412
44669
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
44413
|
-
* @version
|
|
44670
|
+
* @version 152.0.0
|
|
44414
44671
|
*/
|
|
44415
44672
|
|
|
44416
44673
|
/**
|
|
@@ -44939,6 +45196,31 @@ class SearchApi {
|
|
|
44939
45196
|
);
|
|
44940
45197
|
}
|
|
44941
45198
|
|
|
45199
|
+
/**
|
|
45200
|
+
* Search users assigned to teams
|
|
45201
|
+
*
|
|
45202
|
+
* @param {Object} body Search request options
|
|
45203
|
+
*/
|
|
45204
|
+
postUsersSearchTeamsAssign(body) {
|
|
45205
|
+
// verify the required parameter 'body' is set
|
|
45206
|
+
if (body === undefined || body === null) {
|
|
45207
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
45208
|
+
}
|
|
45209
|
+
|
|
45210
|
+
return this.apiClient.callApi(
|
|
45211
|
+
'/api/v2/users/search/teams/assign',
|
|
45212
|
+
'POST',
|
|
45213
|
+
{ },
|
|
45214
|
+
{ },
|
|
45215
|
+
{ },
|
|
45216
|
+
{ },
|
|
45217
|
+
body,
|
|
45218
|
+
['PureCloud OAuth'],
|
|
45219
|
+
['application/json'],
|
|
45220
|
+
['application/json']
|
|
45221
|
+
);
|
|
45222
|
+
}
|
|
45223
|
+
|
|
44942
45224
|
/**
|
|
44943
45225
|
* Search voicemails
|
|
44944
45226
|
*
|
|
@@ -44970,7 +45252,7 @@ class SpeechTextAnalyticsApi {
|
|
|
44970
45252
|
/**
|
|
44971
45253
|
* SpeechTextAnalytics service.
|
|
44972
45254
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
44973
|
-
* @version
|
|
45255
|
+
* @version 152.0.0
|
|
44974
45256
|
*/
|
|
44975
45257
|
|
|
44976
45258
|
/**
|
|
@@ -45824,7 +46106,7 @@ class StationsApi {
|
|
|
45824
46106
|
/**
|
|
45825
46107
|
* Stations service.
|
|
45826
46108
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
45827
|
-
* @version
|
|
46109
|
+
* @version 152.0.0
|
|
45828
46110
|
*/
|
|
45829
46111
|
|
|
45830
46112
|
/**
|
|
@@ -45971,7 +46253,7 @@ class SuggestApi {
|
|
|
45971
46253
|
/**
|
|
45972
46254
|
* Suggest service.
|
|
45973
46255
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
45974
|
-
* @version
|
|
46256
|
+
* @version 152.0.0
|
|
45975
46257
|
*/
|
|
45976
46258
|
|
|
45977
46259
|
/**
|
|
@@ -46110,7 +46392,7 @@ class TeamsApi {
|
|
|
46110
46392
|
/**
|
|
46111
46393
|
* Teams service.
|
|
46112
46394
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
46113
|
-
* @version
|
|
46395
|
+
* @version 152.0.0
|
|
46114
46396
|
*/
|
|
46115
46397
|
|
|
46116
46398
|
/**
|
|
@@ -46150,6 +46432,36 @@ class TeamsApi {
|
|
|
46150
46432
|
);
|
|
46151
46433
|
}
|
|
46152
46434
|
|
|
46435
|
+
/**
|
|
46436
|
+
* Delete team members
|
|
46437
|
+
*
|
|
46438
|
+
* @param {String} teamId Team ID
|
|
46439
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
46440
|
+
*/
|
|
46441
|
+
deleteTeamMembers(teamId, id) {
|
|
46442
|
+
// verify the required parameter 'teamId' is set
|
|
46443
|
+
if (teamId === undefined || teamId === null) {
|
|
46444
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
46445
|
+
}
|
|
46446
|
+
// verify the required parameter 'id' is set
|
|
46447
|
+
if (id === undefined || id === null) {
|
|
46448
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
46449
|
+
}
|
|
46450
|
+
|
|
46451
|
+
return this.apiClient.callApi(
|
|
46452
|
+
'/api/v2/teams/{teamId}/members',
|
|
46453
|
+
'DELETE',
|
|
46454
|
+
{ 'teamId': teamId },
|
|
46455
|
+
{ 'id': id },
|
|
46456
|
+
{ },
|
|
46457
|
+
{ },
|
|
46458
|
+
null,
|
|
46459
|
+
['PureCloud OAuth'],
|
|
46460
|
+
['application/json'],
|
|
46461
|
+
['application/json']
|
|
46462
|
+
);
|
|
46463
|
+
}
|
|
46464
|
+
|
|
46153
46465
|
/**
|
|
46154
46466
|
* Get team
|
|
46155
46467
|
*
|
|
@@ -46175,6 +46487,38 @@ class TeamsApi {
|
|
|
46175
46487
|
);
|
|
46176
46488
|
}
|
|
46177
46489
|
|
|
46490
|
+
/**
|
|
46491
|
+
* Get team membership
|
|
46492
|
+
*
|
|
46493
|
+
* @param {String} teamId Team ID
|
|
46494
|
+
* @param {Object} opts Optional parameters
|
|
46495
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
46496
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
46497
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
46498
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
46499
|
+
*/
|
|
46500
|
+
getTeamMembers(teamId, opts) {
|
|
46501
|
+
opts = opts || {};
|
|
46502
|
+
|
|
46503
|
+
// verify the required parameter 'teamId' is set
|
|
46504
|
+
if (teamId === undefined || teamId === null) {
|
|
46505
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
46506
|
+
}
|
|
46507
|
+
|
|
46508
|
+
return this.apiClient.callApi(
|
|
46509
|
+
'/api/v2/teams/{teamId}/members',
|
|
46510
|
+
'GET',
|
|
46511
|
+
{ 'teamId': teamId },
|
|
46512
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
46513
|
+
{ },
|
|
46514
|
+
{ },
|
|
46515
|
+
null,
|
|
46516
|
+
['PureCloud OAuth'],
|
|
46517
|
+
['application/json'],
|
|
46518
|
+
['application/json']
|
|
46519
|
+
);
|
|
46520
|
+
}
|
|
46521
|
+
|
|
46178
46522
|
/**
|
|
46179
46523
|
* Get Team listing
|
|
46180
46524
|
*
|
|
@@ -46233,6 +46577,36 @@ class TeamsApi {
|
|
|
46233
46577
|
);
|
|
46234
46578
|
}
|
|
46235
46579
|
|
|
46580
|
+
/**
|
|
46581
|
+
* Add team members
|
|
46582
|
+
*
|
|
46583
|
+
* @param {String} teamId Team ID
|
|
46584
|
+
* @param {Object} body TeamMembers
|
|
46585
|
+
*/
|
|
46586
|
+
postTeamMembers(teamId, body) {
|
|
46587
|
+
// verify the required parameter 'teamId' is set
|
|
46588
|
+
if (teamId === undefined || teamId === null) {
|
|
46589
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
46590
|
+
}
|
|
46591
|
+
// verify the required parameter 'body' is set
|
|
46592
|
+
if (body === undefined || body === null) {
|
|
46593
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
46594
|
+
}
|
|
46595
|
+
|
|
46596
|
+
return this.apiClient.callApi(
|
|
46597
|
+
'/api/v2/teams/{teamId}/members',
|
|
46598
|
+
'POST',
|
|
46599
|
+
{ 'teamId': teamId },
|
|
46600
|
+
{ },
|
|
46601
|
+
{ },
|
|
46602
|
+
{ },
|
|
46603
|
+
body,
|
|
46604
|
+
['PureCloud OAuth'],
|
|
46605
|
+
['application/json'],
|
|
46606
|
+
['application/json']
|
|
46607
|
+
);
|
|
46608
|
+
}
|
|
46609
|
+
|
|
46236
46610
|
/**
|
|
46237
46611
|
* Create a team
|
|
46238
46612
|
*
|
|
@@ -46289,7 +46663,7 @@ class TelephonyApi {
|
|
|
46289
46663
|
/**
|
|
46290
46664
|
* Telephony service.
|
|
46291
46665
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
46292
|
-
* @version
|
|
46666
|
+
* @version 152.0.0
|
|
46293
46667
|
*/
|
|
46294
46668
|
|
|
46295
46669
|
/**
|
|
@@ -46397,7 +46771,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
46397
46771
|
/**
|
|
46398
46772
|
* TelephonyProvidersEdge service.
|
|
46399
46773
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
46400
|
-
* @version
|
|
46774
|
+
* @version 152.0.0
|
|
46401
46775
|
*/
|
|
46402
46776
|
|
|
46403
46777
|
/**
|
|
@@ -50030,7 +50404,7 @@ class TextbotsApi {
|
|
|
50030
50404
|
/**
|
|
50031
50405
|
* Textbots service.
|
|
50032
50406
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
50033
|
-
* @version
|
|
50407
|
+
* @version 152.0.0
|
|
50034
50408
|
*/
|
|
50035
50409
|
|
|
50036
50410
|
/**
|
|
@@ -50158,7 +50532,7 @@ class TokensApi {
|
|
|
50158
50532
|
/**
|
|
50159
50533
|
* Tokens service.
|
|
50160
50534
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
50161
|
-
* @version
|
|
50535
|
+
* @version 152.0.0
|
|
50162
50536
|
*/
|
|
50163
50537
|
|
|
50164
50538
|
/**
|
|
@@ -50264,7 +50638,7 @@ class UploadsApi {
|
|
|
50264
50638
|
/**
|
|
50265
50639
|
* Uploads service.
|
|
50266
50640
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
50267
|
-
* @version
|
|
50641
|
+
* @version 152.0.0
|
|
50268
50642
|
*/
|
|
50269
50643
|
|
|
50270
50644
|
/**
|
|
@@ -50440,7 +50814,7 @@ class UsageApi {
|
|
|
50440
50814
|
/**
|
|
50441
50815
|
* Usage service.
|
|
50442
50816
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
50443
|
-
* @version
|
|
50817
|
+
* @version 152.0.0
|
|
50444
50818
|
*/
|
|
50445
50819
|
|
|
50446
50820
|
/**
|
|
@@ -50511,7 +50885,7 @@ class UserRecordingsApi {
|
|
|
50511
50885
|
/**
|
|
50512
50886
|
* UserRecordings service.
|
|
50513
50887
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
50514
|
-
* @version
|
|
50888
|
+
* @version 152.0.0
|
|
50515
50889
|
*/
|
|
50516
50890
|
|
|
50517
50891
|
/**
|
|
@@ -50696,7 +51070,7 @@ class UsersApi {
|
|
|
50696
51070
|
/**
|
|
50697
51071
|
* Users service.
|
|
50698
51072
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
50699
|
-
* @version
|
|
51073
|
+
* @version 152.0.0
|
|
50700
51074
|
*/
|
|
50701
51075
|
|
|
50702
51076
|
/**
|
|
@@ -52687,6 +53061,31 @@ class UsersApi {
|
|
|
52687
53061
|
);
|
|
52688
53062
|
}
|
|
52689
53063
|
|
|
53064
|
+
/**
|
|
53065
|
+
* Search users assigned to teams
|
|
53066
|
+
*
|
|
53067
|
+
* @param {Object} body Search request options
|
|
53068
|
+
*/
|
|
53069
|
+
postUsersSearchTeamsAssign(body) {
|
|
53070
|
+
// verify the required parameter 'body' is set
|
|
53071
|
+
if (body === undefined || body === null) {
|
|
53072
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
53073
|
+
}
|
|
53074
|
+
|
|
53075
|
+
return this.apiClient.callApi(
|
|
53076
|
+
'/api/v2/users/search/teams/assign',
|
|
53077
|
+
'POST',
|
|
53078
|
+
{ },
|
|
53079
|
+
{ },
|
|
53080
|
+
{ },
|
|
53081
|
+
{ },
|
|
53082
|
+
body,
|
|
53083
|
+
['PureCloud OAuth'],
|
|
53084
|
+
['application/json'],
|
|
53085
|
+
['application/json']
|
|
53086
|
+
);
|
|
53087
|
+
}
|
|
53088
|
+
|
|
52690
53089
|
/**
|
|
52691
53090
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
52692
53091
|
*
|
|
@@ -53028,7 +53427,7 @@ class UtilitiesApi {
|
|
|
53028
53427
|
/**
|
|
53029
53428
|
* Utilities service.
|
|
53030
53429
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
53031
|
-
* @version
|
|
53430
|
+
* @version 152.0.0
|
|
53032
53431
|
*/
|
|
53033
53432
|
|
|
53034
53433
|
/**
|
|
@@ -53139,7 +53538,7 @@ class VoicemailApi {
|
|
|
53139
53538
|
/**
|
|
53140
53539
|
* Voicemail service.
|
|
53141
53540
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
53142
|
-
* @version
|
|
53541
|
+
* @version 152.0.0
|
|
53143
53542
|
*/
|
|
53144
53543
|
|
|
53145
53544
|
/**
|
|
@@ -53806,7 +54205,7 @@ class WebChatApi {
|
|
|
53806
54205
|
/**
|
|
53807
54206
|
* WebChat service.
|
|
53808
54207
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
53809
|
-
* @version
|
|
54208
|
+
* @version 152.0.0
|
|
53810
54209
|
*/
|
|
53811
54210
|
|
|
53812
54211
|
/**
|
|
@@ -54350,7 +54749,7 @@ class WebDeploymentsApi {
|
|
|
54350
54749
|
/**
|
|
54351
54750
|
* WebDeployments service.
|
|
54352
54751
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
54353
|
-
* @version
|
|
54752
|
+
* @version 152.0.0
|
|
54354
54753
|
*/
|
|
54355
54754
|
|
|
54356
54755
|
/**
|
|
@@ -54738,7 +55137,7 @@ class WebMessagingApi {
|
|
|
54738
55137
|
/**
|
|
54739
55138
|
* WebMessaging service.
|
|
54740
55139
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
54741
|
-
* @version
|
|
55140
|
+
* @version 152.0.0
|
|
54742
55141
|
*/
|
|
54743
55142
|
|
|
54744
55143
|
/**
|
|
@@ -54784,7 +55183,7 @@ class WidgetsApi {
|
|
|
54784
55183
|
/**
|
|
54785
55184
|
* Widgets service.
|
|
54786
55185
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
54787
|
-
* @version
|
|
55186
|
+
* @version 152.0.0
|
|
54788
55187
|
*/
|
|
54789
55188
|
|
|
54790
55189
|
/**
|
|
@@ -54930,7 +55329,7 @@ class WorkforceManagementApi {
|
|
|
54930
55329
|
/**
|
|
54931
55330
|
* WorkforceManagement service.
|
|
54932
55331
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
54933
|
-
* @version
|
|
55332
|
+
* @version 152.0.0
|
|
54934
55333
|
*/
|
|
54935
55334
|
|
|
54936
55335
|
/**
|
|
@@ -58710,6 +59109,76 @@ class WorkforceManagementApi {
|
|
|
58710
59109
|
);
|
|
58711
59110
|
}
|
|
58712
59111
|
|
|
59112
|
+
/**
|
|
59113
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
59114
|
+
*
|
|
59115
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59116
|
+
* @param {String} userId The ID of the user
|
|
59117
|
+
* @param {Object} body The request body
|
|
59118
|
+
*/
|
|
59119
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
59120
|
+
// verify the required parameter 'managementUnitId' is set
|
|
59121
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
59122
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
59123
|
+
}
|
|
59124
|
+
// verify the required parameter 'userId' is set
|
|
59125
|
+
if (userId === undefined || userId === null) {
|
|
59126
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
59127
|
+
}
|
|
59128
|
+
// verify the required parameter 'body' is set
|
|
59129
|
+
if (body === undefined || body === null) {
|
|
59130
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
59131
|
+
}
|
|
59132
|
+
|
|
59133
|
+
return this.apiClient.callApi(
|
|
59134
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
59135
|
+
'POST',
|
|
59136
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
59137
|
+
{ },
|
|
59138
|
+
{ },
|
|
59139
|
+
{ },
|
|
59140
|
+
body,
|
|
59141
|
+
['PureCloud OAuth'],
|
|
59142
|
+
['application/json'],
|
|
59143
|
+
['application/json']
|
|
59144
|
+
);
|
|
59145
|
+
}
|
|
59146
|
+
|
|
59147
|
+
/**
|
|
59148
|
+
* Query time off balances for dates spanned by a given time off request
|
|
59149
|
+
*
|
|
59150
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59151
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
59152
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
59153
|
+
*/
|
|
59154
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
59155
|
+
// verify the required parameter 'managementUnitId' is set
|
|
59156
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
59157
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
59158
|
+
}
|
|
59159
|
+
// verify the required parameter 'userId' is set
|
|
59160
|
+
if (userId === undefined || userId === null) {
|
|
59161
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
59162
|
+
}
|
|
59163
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
59164
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
59165
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
59166
|
+
}
|
|
59167
|
+
|
|
59168
|
+
return this.apiClient.callApi(
|
|
59169
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
59170
|
+
'POST',
|
|
59171
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
59172
|
+
{ },
|
|
59173
|
+
{ },
|
|
59174
|
+
{ },
|
|
59175
|
+
null,
|
|
59176
|
+
['PureCloud OAuth'],
|
|
59177
|
+
['application/json'],
|
|
59178
|
+
['application/json']
|
|
59179
|
+
);
|
|
59180
|
+
}
|
|
59181
|
+
|
|
58713
59182
|
/**
|
|
58714
59183
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
58715
59184
|
*
|
|
@@ -59206,7 +59675,7 @@ class WorkforceManagementApi {
|
|
|
59206
59675
|
* </pre>
|
|
59207
59676
|
* </p>
|
|
59208
59677
|
* @module purecloud-platform-client-v2/index
|
|
59209
|
-
* @version
|
|
59678
|
+
* @version 152.0.0
|
|
59210
59679
|
*/
|
|
59211
59680
|
class platformClient {
|
|
59212
59681
|
constructor() {
|