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
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 152.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1481,7 +1481,7 @@ class AlertingApi {
|
|
|
1481
1481
|
/**
|
|
1482
1482
|
* Alerting service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 152.0.0
|
|
1485
1485
|
*/
|
|
1486
1486
|
|
|
1487
1487
|
/**
|
|
@@ -1795,7 +1795,7 @@ class AnalyticsApi {
|
|
|
1795
1795
|
/**
|
|
1796
1796
|
* Analytics service.
|
|
1797
1797
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1798
|
-
* @version
|
|
1798
|
+
* @version 152.0.0
|
|
1799
1799
|
*/
|
|
1800
1800
|
|
|
1801
1801
|
/**
|
|
@@ -1894,6 +1894,7 @@ class AnalyticsApi {
|
|
|
1894
1894
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
1895
1895
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
1896
1896
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
1897
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
1897
1898
|
*/
|
|
1898
1899
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
1899
1900
|
opts = opts || {};
|
|
@@ -1907,7 +1908,7 @@ class AnalyticsApi {
|
|
|
1907
1908
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
1908
1909
|
'GET',
|
|
1909
1910
|
{ 'botFlowId': botFlowId },
|
|
1910
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'] },
|
|
1911
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
1911
1912
|
{ },
|
|
1912
1913
|
{ },
|
|
1913
1914
|
null,
|
|
@@ -2456,6 +2457,31 @@ class AnalyticsApi {
|
|
|
2456
2457
|
);
|
|
2457
2458
|
}
|
|
2458
2459
|
|
|
2460
|
+
/**
|
|
2461
|
+
* Query for action aggregates
|
|
2462
|
+
*
|
|
2463
|
+
* @param {Object} body query
|
|
2464
|
+
*/
|
|
2465
|
+
postAnalyticsActionsAggregatesQuery(body) {
|
|
2466
|
+
// verify the required parameter 'body' is set
|
|
2467
|
+
if (body === undefined || body === null) {
|
|
2468
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
|
|
2469
|
+
}
|
|
2470
|
+
|
|
2471
|
+
return this.apiClient.callApi(
|
|
2472
|
+
'/api/v2/analytics/actions/aggregates/query',
|
|
2473
|
+
'POST',
|
|
2474
|
+
{ },
|
|
2475
|
+
{ },
|
|
2476
|
+
{ },
|
|
2477
|
+
{ },
|
|
2478
|
+
body,
|
|
2479
|
+
['PureCloud OAuth'],
|
|
2480
|
+
['application/json'],
|
|
2481
|
+
['application/json']
|
|
2482
|
+
);
|
|
2483
|
+
}
|
|
2484
|
+
|
|
2459
2485
|
/**
|
|
2460
2486
|
* Query for bot aggregates
|
|
2461
2487
|
*
|
|
@@ -3022,7 +3048,7 @@ class ArchitectApi {
|
|
|
3022
3048
|
/**
|
|
3023
3049
|
* Architect service.
|
|
3024
3050
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3025
|
-
* @version
|
|
3051
|
+
* @version 152.0.0
|
|
3026
3052
|
*/
|
|
3027
3053
|
|
|
3028
3054
|
/**
|
|
@@ -4615,6 +4641,7 @@ class ArchitectApi {
|
|
|
4615
4641
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
4616
4642
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
4617
4643
|
* @param {Boolean} opts.showbrief If true returns just the key value of the row (default to true)
|
|
4644
|
+
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
4618
4645
|
*/
|
|
4619
4646
|
getFlowsDatatableRows(datatableId, opts) {
|
|
4620
4647
|
opts = opts || {};
|
|
@@ -4628,7 +4655,7 @@ class ArchitectApi {
|
|
|
4628
4655
|
'/api/v2/flows/datatables/{datatableId}/rows',
|
|
4629
4656
|
'GET',
|
|
4630
4657
|
{ 'datatableId': datatableId },
|
|
4631
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'] },
|
|
4658
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'],'sortOrder': opts['sortOrder'] },
|
|
4632
4659
|
{ },
|
|
4633
4660
|
{ },
|
|
4634
4661
|
null,
|
|
@@ -4648,7 +4675,7 @@ class ArchitectApi {
|
|
|
4648
4675
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
4649
4676
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
4650
4677
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
4651
|
-
* @param {String} opts.name Name
|
|
4678
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
4652
4679
|
*/
|
|
4653
4680
|
getFlowsDatatables(opts) {
|
|
4654
4681
|
opts = opts || {};
|
|
@@ -4707,7 +4734,7 @@ class ArchitectApi {
|
|
|
4707
4734
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
4708
4735
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
4709
4736
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
4710
|
-
* @param {String} opts.name Name
|
|
4737
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
4711
4738
|
*/
|
|
4712
4739
|
getFlowsDatatablesDivisionviews(opts) {
|
|
4713
4740
|
opts = opts || {};
|
|
@@ -6068,7 +6095,7 @@ class AuditApi {
|
|
|
6068
6095
|
/**
|
|
6069
6096
|
* Audit service.
|
|
6070
6097
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6071
|
-
* @version
|
|
6098
|
+
* @version 152.0.0
|
|
6072
6099
|
*/
|
|
6073
6100
|
|
|
6074
6101
|
/**
|
|
@@ -6239,7 +6266,7 @@ class AuthorizationApi {
|
|
|
6239
6266
|
/**
|
|
6240
6267
|
* Authorization service.
|
|
6241
6268
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6242
|
-
* @version
|
|
6269
|
+
* @version 152.0.0
|
|
6243
6270
|
*/
|
|
6244
6271
|
|
|
6245
6272
|
/**
|
|
@@ -7422,7 +7449,7 @@ class BillingApi {
|
|
|
7422
7449
|
/**
|
|
7423
7450
|
* Billing service.
|
|
7424
7451
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7425
|
-
* @version
|
|
7452
|
+
* @version 152.0.0
|
|
7426
7453
|
*/
|
|
7427
7454
|
|
|
7428
7455
|
/**
|
|
@@ -7502,7 +7529,7 @@ class ChatApi {
|
|
|
7502
7529
|
/**
|
|
7503
7530
|
* Chat service.
|
|
7504
7531
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7505
|
-
* @version
|
|
7532
|
+
* @version 152.0.0
|
|
7506
7533
|
*/
|
|
7507
7534
|
|
|
7508
7535
|
/**
|
|
@@ -7593,7 +7620,7 @@ class CoachingApi {
|
|
|
7593
7620
|
/**
|
|
7594
7621
|
* Coaching service.
|
|
7595
7622
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7596
|
-
* @version
|
|
7623
|
+
* @version 152.0.0
|
|
7597
7624
|
*/
|
|
7598
7625
|
|
|
7599
7626
|
/**
|
|
@@ -8170,7 +8197,7 @@ class ContentManagementApi {
|
|
|
8170
8197
|
/**
|
|
8171
8198
|
* ContentManagement service.
|
|
8172
8199
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8173
|
-
* @version
|
|
8200
|
+
* @version 152.0.0
|
|
8174
8201
|
*/
|
|
8175
8202
|
|
|
8176
8203
|
/**
|
|
@@ -9310,7 +9337,7 @@ class ConversationsApi {
|
|
|
9310
9337
|
/**
|
|
9311
9338
|
* Conversations service.
|
|
9312
9339
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9313
|
-
* @version
|
|
9340
|
+
* @version 152.0.0
|
|
9314
9341
|
*/
|
|
9315
9342
|
|
|
9316
9343
|
/**
|
|
@@ -10989,8 +11016,9 @@ class ConversationsApi {
|
|
|
10989
11016
|
* @param {Object} opts Optional parameters
|
|
10990
11017
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10991
11018
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10992
|
-
* @param {
|
|
11019
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value.
|
|
10993
11020
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11021
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
10994
11022
|
*/
|
|
10995
11023
|
getConversationsMessagingIntegrations(opts) {
|
|
10996
11024
|
opts = opts || {};
|
|
@@ -11000,7 +11028,7 @@ class ConversationsApi {
|
|
|
11000
11028
|
'/api/v2/conversations/messaging/integrations',
|
|
11001
11029
|
'GET',
|
|
11002
11030
|
{ },
|
|
11003
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11031
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11004
11032
|
{ },
|
|
11005
11033
|
{ },
|
|
11006
11034
|
null,
|
|
@@ -11018,6 +11046,7 @@ class ConversationsApi {
|
|
|
11018
11046
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11019
11047
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11020
11048
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11049
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11021
11050
|
*/
|
|
11022
11051
|
getConversationsMessagingIntegrationsFacebook(opts) {
|
|
11023
11052
|
opts = opts || {};
|
|
@@ -11027,7 +11056,7 @@ class ConversationsApi {
|
|
|
11027
11056
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
11028
11057
|
'GET',
|
|
11029
11058
|
{ },
|
|
11030
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11059
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11031
11060
|
{ },
|
|
11032
11061
|
{ },
|
|
11033
11062
|
null,
|
|
@@ -11074,6 +11103,7 @@ class ConversationsApi {
|
|
|
11074
11103
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11075
11104
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11076
11105
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11106
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11077
11107
|
*/
|
|
11078
11108
|
getConversationsMessagingIntegrationsLine(opts) {
|
|
11079
11109
|
opts = opts || {};
|
|
@@ -11083,7 +11113,7 @@ class ConversationsApi {
|
|
|
11083
11113
|
'/api/v2/conversations/messaging/integrations/line',
|
|
11084
11114
|
'GET',
|
|
11085
11115
|
{ },
|
|
11086
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11116
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11087
11117
|
{ },
|
|
11088
11118
|
{ },
|
|
11089
11119
|
null,
|
|
@@ -11130,6 +11160,7 @@ class ConversationsApi {
|
|
|
11130
11160
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11131
11161
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11132
11162
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11163
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11133
11164
|
*/
|
|
11134
11165
|
getConversationsMessagingIntegrationsOpen(opts) {
|
|
11135
11166
|
opts = opts || {};
|
|
@@ -11139,7 +11170,7 @@ class ConversationsApi {
|
|
|
11139
11170
|
'/api/v2/conversations/messaging/integrations/open',
|
|
11140
11171
|
'GET',
|
|
11141
11172
|
{ },
|
|
11142
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11173
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11143
11174
|
{ },
|
|
11144
11175
|
{ },
|
|
11145
11176
|
null,
|
|
@@ -11186,6 +11217,7 @@ class ConversationsApi {
|
|
|
11186
11217
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11187
11218
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11188
11219
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11220
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11189
11221
|
*/
|
|
11190
11222
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
11191
11223
|
opts = opts || {};
|
|
@@ -11195,7 +11227,7 @@ class ConversationsApi {
|
|
|
11195
11227
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
11196
11228
|
'GET',
|
|
11197
11229
|
{ },
|
|
11198
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11230
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11199
11231
|
{ },
|
|
11200
11232
|
{ },
|
|
11201
11233
|
null,
|
|
@@ -11242,6 +11274,7 @@ class ConversationsApi {
|
|
|
11242
11274
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11243
11275
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11244
11276
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11277
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11245
11278
|
*/
|
|
11246
11279
|
getConversationsMessagingIntegrationsWhatsapp(opts) {
|
|
11247
11280
|
opts = opts || {};
|
|
@@ -11251,7 +11284,7 @@ class ConversationsApi {
|
|
|
11251
11284
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
11252
11285
|
'GET',
|
|
11253
11286
|
{ },
|
|
11254
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11287
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11255
11288
|
{ },
|
|
11256
11289
|
{ },
|
|
11257
11290
|
null,
|
|
@@ -13656,6 +13689,41 @@ class ConversationsApi {
|
|
|
13656
13689
|
);
|
|
13657
13690
|
}
|
|
13658
13691
|
|
|
13692
|
+
/**
|
|
13693
|
+
* Send message typing event
|
|
13694
|
+
* Send message typing event for existing conversation/communication.
|
|
13695
|
+
* @param {String} conversationId conversationId
|
|
13696
|
+
* @param {String} communicationId communicationId
|
|
13697
|
+
* @param {Object} body MessageTypingEvent
|
|
13698
|
+
*/
|
|
13699
|
+
postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
|
|
13700
|
+
// verify the required parameter 'conversationId' is set
|
|
13701
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13702
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
|
|
13703
|
+
}
|
|
13704
|
+
// verify the required parameter 'communicationId' is set
|
|
13705
|
+
if (communicationId === undefined || communicationId === null) {
|
|
13706
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
|
|
13707
|
+
}
|
|
13708
|
+
// verify the required parameter 'body' is set
|
|
13709
|
+
if (body === undefined || body === null) {
|
|
13710
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
|
|
13711
|
+
}
|
|
13712
|
+
|
|
13713
|
+
return this.apiClient.callApi(
|
|
13714
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
|
|
13715
|
+
'POST',
|
|
13716
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
13717
|
+
{ },
|
|
13718
|
+
{ },
|
|
13719
|
+
{ },
|
|
13720
|
+
body,
|
|
13721
|
+
['PureCloud OAuth'],
|
|
13722
|
+
['application/json'],
|
|
13723
|
+
['application/json']
|
|
13724
|
+
);
|
|
13725
|
+
}
|
|
13726
|
+
|
|
13659
13727
|
/**
|
|
13660
13728
|
* Get messages in batch
|
|
13661
13729
|
* 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"]
|
|
@@ -14492,7 +14560,7 @@ class DataExtensionsApi {
|
|
|
14492
14560
|
/**
|
|
14493
14561
|
* DataExtensions service.
|
|
14494
14562
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14495
|
-
* @version
|
|
14563
|
+
* @version 152.0.0
|
|
14496
14564
|
*/
|
|
14497
14565
|
|
|
14498
14566
|
/**
|
|
@@ -14578,7 +14646,7 @@ class DownloadsApi {
|
|
|
14578
14646
|
/**
|
|
14579
14647
|
* Downloads service.
|
|
14580
14648
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14581
|
-
* @version
|
|
14649
|
+
* @version 152.0.0
|
|
14582
14650
|
*/
|
|
14583
14651
|
|
|
14584
14652
|
/**
|
|
@@ -14630,7 +14698,7 @@ class EventsApi {
|
|
|
14630
14698
|
/**
|
|
14631
14699
|
* Events service.
|
|
14632
14700
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14633
|
-
* @version
|
|
14701
|
+
* @version 152.0.0
|
|
14634
14702
|
*/
|
|
14635
14703
|
|
|
14636
14704
|
/**
|
|
@@ -14726,7 +14794,7 @@ class ExternalContactsApi {
|
|
|
14726
14794
|
/**
|
|
14727
14795
|
* ExternalContacts service.
|
|
14728
14796
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14729
|
-
* @version
|
|
14797
|
+
* @version 152.0.0
|
|
14730
14798
|
*/
|
|
14731
14799
|
|
|
14732
14800
|
/**
|
|
@@ -14980,6 +15048,37 @@ class ExternalContactsApi {
|
|
|
14980
15048
|
);
|
|
14981
15049
|
}
|
|
14982
15050
|
|
|
15051
|
+
/**
|
|
15052
|
+
* Retrieve all sessions for a given external contact.
|
|
15053
|
+
*
|
|
15054
|
+
* @param {String} contactId ExternalContact ID
|
|
15055
|
+
* @param {Object} opts Optional parameters
|
|
15056
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
15057
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15058
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
15059
|
+
*/
|
|
15060
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
15061
|
+
opts = opts || {};
|
|
15062
|
+
|
|
15063
|
+
// verify the required parameter 'contactId' is set
|
|
15064
|
+
if (contactId === undefined || contactId === null) {
|
|
15065
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
15066
|
+
}
|
|
15067
|
+
|
|
15068
|
+
return this.apiClient.callApi(
|
|
15069
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
15070
|
+
'GET',
|
|
15071
|
+
{ 'contactId': contactId },
|
|
15072
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
15073
|
+
{ },
|
|
15074
|
+
{ },
|
|
15075
|
+
null,
|
|
15076
|
+
['PureCloud OAuth'],
|
|
15077
|
+
['application/json'],
|
|
15078
|
+
['application/json']
|
|
15079
|
+
);
|
|
15080
|
+
}
|
|
15081
|
+
|
|
14983
15082
|
/**
|
|
14984
15083
|
* Fetch a note for an external contact
|
|
14985
15084
|
*
|
|
@@ -16653,7 +16752,7 @@ class FaxApi {
|
|
|
16653
16752
|
/**
|
|
16654
16753
|
* Fax service.
|
|
16655
16754
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16656
|
-
* @version
|
|
16755
|
+
* @version 152.0.0
|
|
16657
16756
|
*/
|
|
16658
16757
|
|
|
16659
16758
|
/**
|
|
@@ -16824,7 +16923,7 @@ class FlowsApi {
|
|
|
16824
16923
|
/**
|
|
16825
16924
|
* Flows service.
|
|
16826
16925
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16827
|
-
* @version
|
|
16926
|
+
* @version 152.0.0
|
|
16828
16927
|
*/
|
|
16829
16928
|
|
|
16830
16929
|
/**
|
|
@@ -16895,7 +16994,7 @@ class GamificationApi {
|
|
|
16895
16994
|
/**
|
|
16896
16995
|
* Gamification service.
|
|
16897
16996
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16898
|
-
* @version
|
|
16997
|
+
* @version 152.0.0
|
|
16899
16998
|
*/
|
|
16900
16999
|
|
|
16901
17000
|
/**
|
|
@@ -17113,36 +17212,6 @@ class GamificationApi {
|
|
|
17113
17212
|
);
|
|
17114
17213
|
}
|
|
17115
17214
|
|
|
17116
|
-
/**
|
|
17117
|
-
* Gamified metric by id
|
|
17118
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
17119
|
-
* @param {String} metricId metric Id
|
|
17120
|
-
* @param {Object} opts Optional parameters
|
|
17121
|
-
* @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
|
|
17122
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
17123
|
-
*/
|
|
17124
|
-
getGamificationMetric(metricId, opts) {
|
|
17125
|
-
opts = opts || {};
|
|
17126
|
-
|
|
17127
|
-
// verify the required parameter 'metricId' is set
|
|
17128
|
-
if (metricId === undefined || metricId === null) {
|
|
17129
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
17130
|
-
}
|
|
17131
|
-
|
|
17132
|
-
return this.apiClient.callApi(
|
|
17133
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
17134
|
-
'GET',
|
|
17135
|
-
{ 'metricId': metricId },
|
|
17136
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
17137
|
-
{ },
|
|
17138
|
-
{ },
|
|
17139
|
-
null,
|
|
17140
|
-
['PureCloud OAuth'],
|
|
17141
|
-
['application/json'],
|
|
17142
|
-
['application/json']
|
|
17143
|
-
);
|
|
17144
|
-
}
|
|
17145
|
-
|
|
17146
17215
|
/**
|
|
17147
17216
|
* Metric definition by id
|
|
17148
17217
|
*
|
|
@@ -18447,40 +18516,6 @@ class GamificationApi {
|
|
|
18447
18516
|
);
|
|
18448
18517
|
}
|
|
18449
18518
|
|
|
18450
|
-
/**
|
|
18451
|
-
* Updates a metric
|
|
18452
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
18453
|
-
* @param {String} metricId metric Id
|
|
18454
|
-
* @param {Object} body Metric
|
|
18455
|
-
* @param {Object} opts Optional parameters
|
|
18456
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
18457
|
-
*/
|
|
18458
|
-
putGamificationMetric(metricId, body, opts) {
|
|
18459
|
-
opts = opts || {};
|
|
18460
|
-
|
|
18461
|
-
// verify the required parameter 'metricId' is set
|
|
18462
|
-
if (metricId === undefined || metricId === null) {
|
|
18463
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
18464
|
-
}
|
|
18465
|
-
// verify the required parameter 'body' is set
|
|
18466
|
-
if (body === undefined || body === null) {
|
|
18467
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
18468
|
-
}
|
|
18469
|
-
|
|
18470
|
-
return this.apiClient.callApi(
|
|
18471
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
18472
|
-
'PUT',
|
|
18473
|
-
{ 'metricId': metricId },
|
|
18474
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
18475
|
-
{ },
|
|
18476
|
-
{ },
|
|
18477
|
-
body,
|
|
18478
|
-
['PureCloud OAuth'],
|
|
18479
|
-
['application/json'],
|
|
18480
|
-
['application/json']
|
|
18481
|
-
);
|
|
18482
|
-
}
|
|
18483
|
-
|
|
18484
18519
|
/**
|
|
18485
18520
|
* Updates a performance profile
|
|
18486
18521
|
*
|
|
@@ -18576,7 +18611,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18576
18611
|
/**
|
|
18577
18612
|
* GeneralDataProtectionRegulation service.
|
|
18578
18613
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18579
|
-
* @version
|
|
18614
|
+
* @version 152.0.0
|
|
18580
18615
|
*/
|
|
18581
18616
|
|
|
18582
18617
|
/**
|
|
@@ -18706,7 +18741,7 @@ class GeolocationApi {
|
|
|
18706
18741
|
/**
|
|
18707
18742
|
* Geolocation service.
|
|
18708
18743
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18709
|
-
* @version
|
|
18744
|
+
* @version 152.0.0
|
|
18710
18745
|
*/
|
|
18711
18746
|
|
|
18712
18747
|
/**
|
|
@@ -18837,7 +18872,7 @@ class GreetingsApi {
|
|
|
18837
18872
|
/**
|
|
18838
18873
|
* Greetings service.
|
|
18839
18874
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18840
|
-
* @version
|
|
18875
|
+
* @version 152.0.0
|
|
18841
18876
|
*/
|
|
18842
18877
|
|
|
18843
18878
|
/**
|
|
@@ -19292,7 +19327,7 @@ class GroupsApi {
|
|
|
19292
19327
|
/**
|
|
19293
19328
|
* Groups service.
|
|
19294
19329
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19295
|
-
* @version
|
|
19330
|
+
* @version 152.0.0
|
|
19296
19331
|
*/
|
|
19297
19332
|
|
|
19298
19333
|
/**
|
|
@@ -19698,7 +19733,7 @@ class IdentityProviderApi {
|
|
|
19698
19733
|
/**
|
|
19699
19734
|
* IdentityProvider service.
|
|
19700
19735
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19701
|
-
* @version
|
|
19736
|
+
* @version 152.0.0
|
|
19702
19737
|
*/
|
|
19703
19738
|
|
|
19704
19739
|
/**
|
|
@@ -20454,7 +20489,7 @@ class IntegrationsApi {
|
|
|
20454
20489
|
/**
|
|
20455
20490
|
* Integrations service.
|
|
20456
20491
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20457
|
-
* @version
|
|
20492
|
+
* @version 152.0.0
|
|
20458
20493
|
*/
|
|
20459
20494
|
|
|
20460
20495
|
/**
|
|
@@ -22054,7 +22089,7 @@ class JourneyApi {
|
|
|
22054
22089
|
/**
|
|
22055
22090
|
* Journey service.
|
|
22056
22091
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22057
|
-
* @version
|
|
22092
|
+
* @version 152.0.0
|
|
22058
22093
|
*/
|
|
22059
22094
|
|
|
22060
22095
|
/**
|
|
@@ -22840,7 +22875,7 @@ class KnowledgeApi {
|
|
|
22840
22875
|
/**
|
|
22841
22876
|
* Knowledge service.
|
|
22842
22877
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22843
|
-
* @version
|
|
22878
|
+
* @version 152.0.0
|
|
22844
22879
|
*/
|
|
22845
22880
|
|
|
22846
22881
|
/**
|
|
@@ -23243,8 +23278,8 @@ class KnowledgeApi {
|
|
|
23243
23278
|
* @param {String} sessionId Knowledge guest session ID.
|
|
23244
23279
|
* @param {Object} opts Optional parameters
|
|
23245
23280
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23246
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23247
|
-
* @param {
|
|
23281
|
+
* @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.
|
|
23282
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
23248
23283
|
*/
|
|
23249
23284
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
23250
23285
|
opts = opts || {};
|
|
@@ -25273,7 +25308,7 @@ class LanguageUnderstandingApi {
|
|
|
25273
25308
|
/**
|
|
25274
25309
|
* LanguageUnderstanding service.
|
|
25275
25310
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25276
|
-
* @version
|
|
25311
|
+
* @version 152.0.0
|
|
25277
25312
|
*/
|
|
25278
25313
|
|
|
25279
25314
|
/**
|
|
@@ -26177,7 +26212,7 @@ class LanguagesApi {
|
|
|
26177
26212
|
/**
|
|
26178
26213
|
* Languages service.
|
|
26179
26214
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26180
|
-
* @version
|
|
26215
|
+
* @version 152.0.0
|
|
26181
26216
|
*/
|
|
26182
26217
|
|
|
26183
26218
|
/**
|
|
@@ -26445,7 +26480,7 @@ class LearningApi {
|
|
|
26445
26480
|
/**
|
|
26446
26481
|
* Learning service.
|
|
26447
26482
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26448
|
-
* @version
|
|
26483
|
+
* @version 152.0.0
|
|
26449
26484
|
*/
|
|
26450
26485
|
|
|
26451
26486
|
/**
|
|
@@ -27205,7 +27240,7 @@ class LicenseApi {
|
|
|
27205
27240
|
/**
|
|
27206
27241
|
* License service.
|
|
27207
27242
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27208
|
-
* @version
|
|
27243
|
+
* @version 152.0.0
|
|
27209
27244
|
*/
|
|
27210
27245
|
|
|
27211
27246
|
/**
|
|
@@ -27443,7 +27478,7 @@ class LocationsApi {
|
|
|
27443
27478
|
/**
|
|
27444
27479
|
* Locations service.
|
|
27445
27480
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27446
|
-
* @version
|
|
27481
|
+
* @version 152.0.0
|
|
27447
27482
|
*/
|
|
27448
27483
|
|
|
27449
27484
|
/**
|
|
@@ -27679,7 +27714,7 @@ class MessagingApi {
|
|
|
27679
27714
|
/**
|
|
27680
27715
|
* Messaging service.
|
|
27681
27716
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27682
|
-
* @version
|
|
27717
|
+
* @version 152.0.0
|
|
27683
27718
|
*/
|
|
27684
27719
|
|
|
27685
27720
|
/**
|
|
@@ -27830,7 +27865,7 @@ class MobileDevicesApi {
|
|
|
27830
27865
|
/**
|
|
27831
27866
|
* MobileDevices service.
|
|
27832
27867
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27833
|
-
* @version
|
|
27868
|
+
* @version 152.0.0
|
|
27834
27869
|
*/
|
|
27835
27870
|
|
|
27836
27871
|
/**
|
|
@@ -27981,7 +28016,7 @@ class NotificationsApi {
|
|
|
27981
28016
|
/**
|
|
27982
28017
|
* Notifications service.
|
|
27983
28018
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27984
|
-
* @version
|
|
28019
|
+
* @version 152.0.0
|
|
27985
28020
|
*/
|
|
27986
28021
|
|
|
27987
28022
|
/**
|
|
@@ -28206,7 +28241,7 @@ class OAuthApi {
|
|
|
28206
28241
|
/**
|
|
28207
28242
|
* OAuth service.
|
|
28208
28243
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28209
|
-
* @version
|
|
28244
|
+
* @version 152.0.0
|
|
28210
28245
|
*/
|
|
28211
28246
|
|
|
28212
28247
|
/**
|
|
@@ -28572,7 +28607,7 @@ class ObjectsApi {
|
|
|
28572
28607
|
/**
|
|
28573
28608
|
* Objects service.
|
|
28574
28609
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28575
|
-
* @version
|
|
28610
|
+
* @version 152.0.0
|
|
28576
28611
|
*/
|
|
28577
28612
|
|
|
28578
28613
|
/**
|
|
@@ -28843,7 +28878,7 @@ class OrganizationApi {
|
|
|
28843
28878
|
/**
|
|
28844
28879
|
* Organization service.
|
|
28845
28880
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28846
|
-
* @version
|
|
28881
|
+
* @version 152.0.0
|
|
28847
28882
|
*/
|
|
28848
28883
|
|
|
28849
28884
|
/**
|
|
@@ -29246,7 +29281,7 @@ class OrganizationAuthorizationApi {
|
|
|
29246
29281
|
/**
|
|
29247
29282
|
* OrganizationAuthorization service.
|
|
29248
29283
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29249
|
-
* @version
|
|
29284
|
+
* @version 152.0.0
|
|
29250
29285
|
*/
|
|
29251
29286
|
|
|
29252
29287
|
/**
|
|
@@ -30171,7 +30206,7 @@ class OutboundApi {
|
|
|
30171
30206
|
/**
|
|
30172
30207
|
* Outbound service.
|
|
30173
30208
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30174
|
-
* @version
|
|
30209
|
+
* @version 152.0.0
|
|
30175
30210
|
*/
|
|
30176
30211
|
|
|
30177
30212
|
/**
|
|
@@ -33560,7 +33595,7 @@ class PresenceApi {
|
|
|
33560
33595
|
/**
|
|
33561
33596
|
* Presence service.
|
|
33562
33597
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33563
|
-
* @version
|
|
33598
|
+
* @version 152.0.0
|
|
33564
33599
|
*/
|
|
33565
33600
|
|
|
33566
33601
|
/**
|
|
@@ -33654,7 +33689,7 @@ class PresenceApi {
|
|
|
33654
33689
|
* Get a list of Presence Sources
|
|
33655
33690
|
*
|
|
33656
33691
|
* @param {Object} opts Optional parameters
|
|
33657
|
-
* @param {String} opts.
|
|
33692
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
33658
33693
|
*/
|
|
33659
33694
|
getPresenceSources(opts) {
|
|
33660
33695
|
opts = opts || {};
|
|
@@ -33664,7 +33699,7 @@ class PresenceApi {
|
|
|
33664
33699
|
'/api/v2/presence/sources',
|
|
33665
33700
|
'GET',
|
|
33666
33701
|
{ },
|
|
33667
|
-
{ '
|
|
33702
|
+
{ 'deactivated': opts['deactivated'] },
|
|
33668
33703
|
{ },
|
|
33669
33704
|
{ },
|
|
33670
33705
|
null,
|
|
@@ -34066,7 +34101,7 @@ class ProcessAutomationApi {
|
|
|
34066
34101
|
/**
|
|
34067
34102
|
* ProcessAutomation service.
|
|
34068
34103
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34069
|
-
* @version
|
|
34104
|
+
* @version 152.0.0
|
|
34070
34105
|
*/
|
|
34071
34106
|
|
|
34072
34107
|
/**
|
|
@@ -34107,7 +34142,7 @@ class ProcessAutomationApi {
|
|
|
34107
34142
|
}
|
|
34108
34143
|
|
|
34109
34144
|
/**
|
|
34110
|
-
* Retrieve a single Trigger matching id
|
|
34145
|
+
* Retrieve a single Trigger matching id
|
|
34111
34146
|
*
|
|
34112
34147
|
* @param {String} triggerId triggerId
|
|
34113
34148
|
*/
|
|
@@ -34132,13 +34167,13 @@ class ProcessAutomationApi {
|
|
|
34132
34167
|
}
|
|
34133
34168
|
|
|
34134
34169
|
/**
|
|
34135
|
-
* Retrieves all triggers
|
|
34170
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
34136
34171
|
*
|
|
34137
34172
|
* @param {Object} opts Optional parameters
|
|
34138
34173
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
34139
34174
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
34140
34175
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
34141
|
-
* @param {String} opts.topicName Topic name
|
|
34176
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
34142
34177
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
34143
34178
|
*/
|
|
34144
34179
|
getProcessautomationTriggers(opts) {
|
|
@@ -34304,7 +34339,7 @@ class QualityApi {
|
|
|
34304
34339
|
/**
|
|
34305
34340
|
* Quality service.
|
|
34306
34341
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34307
|
-
* @version
|
|
34342
|
+
* @version 152.0.0
|
|
34308
34343
|
*/
|
|
34309
34344
|
|
|
34310
34345
|
/**
|
|
@@ -35882,7 +35917,7 @@ class RecordingApi {
|
|
|
35882
35917
|
/**
|
|
35883
35918
|
* Recording service.
|
|
35884
35919
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35885
|
-
* @version
|
|
35920
|
+
* @version 152.0.0
|
|
35886
35921
|
*/
|
|
35887
35922
|
|
|
35888
35923
|
/**
|
|
@@ -37569,7 +37604,7 @@ class ResponseManagementApi {
|
|
|
37569
37604
|
/**
|
|
37570
37605
|
* ResponseManagement service.
|
|
37571
37606
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37572
|
-
* @version
|
|
37607
|
+
* @version 152.0.0
|
|
37573
37608
|
*/
|
|
37574
37609
|
|
|
37575
37610
|
/**
|
|
@@ -38053,7 +38088,7 @@ class RoutingApi {
|
|
|
38053
38088
|
/**
|
|
38054
38089
|
* Routing service.
|
|
38055
38090
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38056
|
-
* @version
|
|
38091
|
+
* @version 152.0.0
|
|
38057
38092
|
*/
|
|
38058
38093
|
|
|
38059
38094
|
/**
|
|
@@ -38362,6 +38397,31 @@ class RoutingApi {
|
|
|
38362
38397
|
);
|
|
38363
38398
|
}
|
|
38364
38399
|
|
|
38400
|
+
/**
|
|
38401
|
+
* Remove skill group definition
|
|
38402
|
+
*
|
|
38403
|
+
* @param {String} skillGroupId Skill Group ID
|
|
38404
|
+
*/
|
|
38405
|
+
deleteRoutingSkillgroup(skillGroupId) {
|
|
38406
|
+
// verify the required parameter 'skillGroupId' is set
|
|
38407
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
38408
|
+
throw 'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';
|
|
38409
|
+
}
|
|
38410
|
+
|
|
38411
|
+
return this.apiClient.callApi(
|
|
38412
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
38413
|
+
'DELETE',
|
|
38414
|
+
{ 'skillGroupId': skillGroupId },
|
|
38415
|
+
{ },
|
|
38416
|
+
{ },
|
|
38417
|
+
{ },
|
|
38418
|
+
null,
|
|
38419
|
+
['PureCloud OAuth'],
|
|
38420
|
+
['application/json'],
|
|
38421
|
+
['application/json']
|
|
38422
|
+
);
|
|
38423
|
+
}
|
|
38424
|
+
|
|
38365
38425
|
/**
|
|
38366
38426
|
* Delete an Address by Id for SMS
|
|
38367
38427
|
*
|
|
@@ -39547,6 +39607,119 @@ class RoutingApi {
|
|
|
39547
39607
|
);
|
|
39548
39608
|
}
|
|
39549
39609
|
|
|
39610
|
+
/**
|
|
39611
|
+
* Get skill group
|
|
39612
|
+
*
|
|
39613
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39614
|
+
*/
|
|
39615
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
39616
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39617
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39618
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
39619
|
+
}
|
|
39620
|
+
|
|
39621
|
+
return this.apiClient.callApi(
|
|
39622
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
39623
|
+
'GET',
|
|
39624
|
+
{ 'skillGroupId': skillGroupId },
|
|
39625
|
+
{ },
|
|
39626
|
+
{ },
|
|
39627
|
+
{ },
|
|
39628
|
+
null,
|
|
39629
|
+
['PureCloud OAuth'],
|
|
39630
|
+
['application/json'],
|
|
39631
|
+
['application/json']
|
|
39632
|
+
);
|
|
39633
|
+
}
|
|
39634
|
+
|
|
39635
|
+
/**
|
|
39636
|
+
* Get skill group members
|
|
39637
|
+
*
|
|
39638
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39639
|
+
* @param {Object} opts Optional parameters
|
|
39640
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39641
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
39642
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
39643
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
39644
|
+
*/
|
|
39645
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
39646
|
+
opts = opts || {};
|
|
39647
|
+
|
|
39648
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39649
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39650
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
39651
|
+
}
|
|
39652
|
+
|
|
39653
|
+
return this.apiClient.callApi(
|
|
39654
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
39655
|
+
'GET',
|
|
39656
|
+
{ 'skillGroupId': skillGroupId },
|
|
39657
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
39658
|
+
{ },
|
|
39659
|
+
{ },
|
|
39660
|
+
null,
|
|
39661
|
+
['PureCloud OAuth'],
|
|
39662
|
+
['application/json'],
|
|
39663
|
+
['application/json']
|
|
39664
|
+
);
|
|
39665
|
+
}
|
|
39666
|
+
|
|
39667
|
+
/**
|
|
39668
|
+
* Get list of member divisions for this skill group.
|
|
39669
|
+
*
|
|
39670
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39671
|
+
* @param {Object} opts Optional parameters
|
|
39672
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
39673
|
+
*/
|
|
39674
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
39675
|
+
opts = opts || {};
|
|
39676
|
+
|
|
39677
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39678
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39679
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
39680
|
+
}
|
|
39681
|
+
|
|
39682
|
+
return this.apiClient.callApi(
|
|
39683
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
39684
|
+
'GET',
|
|
39685
|
+
{ 'skillGroupId': skillGroupId },
|
|
39686
|
+
{ 'expand': opts['expand'] },
|
|
39687
|
+
{ },
|
|
39688
|
+
{ },
|
|
39689
|
+
null,
|
|
39690
|
+
['PureCloud OAuth'],
|
|
39691
|
+
['application/json'],
|
|
39692
|
+
['application/json']
|
|
39693
|
+
);
|
|
39694
|
+
}
|
|
39695
|
+
|
|
39696
|
+
/**
|
|
39697
|
+
* Get skill group listing
|
|
39698
|
+
*
|
|
39699
|
+
* @param {Object} opts Optional parameters
|
|
39700
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39701
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
39702
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
39703
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
39704
|
+
*/
|
|
39705
|
+
getRoutingSkillgroups(opts) {
|
|
39706
|
+
opts = opts || {};
|
|
39707
|
+
|
|
39708
|
+
|
|
39709
|
+
return this.apiClient.callApi(
|
|
39710
|
+
'/api/v2/routing/skillgroups',
|
|
39711
|
+
'GET',
|
|
39712
|
+
{ },
|
|
39713
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
39714
|
+
{ },
|
|
39715
|
+
{ },
|
|
39716
|
+
null,
|
|
39717
|
+
['PureCloud OAuth'],
|
|
39718
|
+
['application/json'],
|
|
39719
|
+
['application/json']
|
|
39720
|
+
);
|
|
39721
|
+
}
|
|
39722
|
+
|
|
39550
39723
|
/**
|
|
39551
39724
|
* Get the list of routing skills.
|
|
39552
39725
|
*
|
|
@@ -40185,6 +40358,36 @@ class RoutingApi {
|
|
|
40185
40358
|
);
|
|
40186
40359
|
}
|
|
40187
40360
|
|
|
40361
|
+
/**
|
|
40362
|
+
* Update skill group definition
|
|
40363
|
+
*
|
|
40364
|
+
* @param {String} skillGroupId Skill Group ID
|
|
40365
|
+
* @param {Object} body Update skill groups
|
|
40366
|
+
*/
|
|
40367
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
40368
|
+
// verify the required parameter 'skillGroupId' is set
|
|
40369
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
40370
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
40371
|
+
}
|
|
40372
|
+
// verify the required parameter 'body' is set
|
|
40373
|
+
if (body === undefined || body === null) {
|
|
40374
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
40375
|
+
}
|
|
40376
|
+
|
|
40377
|
+
return this.apiClient.callApi(
|
|
40378
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
40379
|
+
'PATCH',
|
|
40380
|
+
{ 'skillGroupId': skillGroupId },
|
|
40381
|
+
{ },
|
|
40382
|
+
{ },
|
|
40383
|
+
{ },
|
|
40384
|
+
body,
|
|
40385
|
+
['PureCloud OAuth'],
|
|
40386
|
+
['application/json'],
|
|
40387
|
+
['application/json']
|
|
40388
|
+
);
|
|
40389
|
+
}
|
|
40390
|
+
|
|
40188
40391
|
/**
|
|
40189
40392
|
* Join or unjoin a queue for a user
|
|
40190
40393
|
*
|
|
@@ -40728,6 +40931,60 @@ class RoutingApi {
|
|
|
40728
40931
|
);
|
|
40729
40932
|
}
|
|
40730
40933
|
|
|
40934
|
+
/**
|
|
40935
|
+
* Add or remove member divisions for this skill group.
|
|
40936
|
+
*
|
|
40937
|
+
* @param {String} skillGroupId Skill Group ID
|
|
40938
|
+
* @param {Object} opts Optional parameters
|
|
40939
|
+
* @param {Object} opts.body
|
|
40940
|
+
*/
|
|
40941
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
40942
|
+
opts = opts || {};
|
|
40943
|
+
|
|
40944
|
+
// verify the required parameter 'skillGroupId' is set
|
|
40945
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
40946
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
40947
|
+
}
|
|
40948
|
+
|
|
40949
|
+
return this.apiClient.callApi(
|
|
40950
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
40951
|
+
'POST',
|
|
40952
|
+
{ 'skillGroupId': skillGroupId },
|
|
40953
|
+
{ },
|
|
40954
|
+
{ },
|
|
40955
|
+
{ },
|
|
40956
|
+
opts['body'],
|
|
40957
|
+
['PureCloud OAuth'],
|
|
40958
|
+
['application/json'],
|
|
40959
|
+
['application/json']
|
|
40960
|
+
);
|
|
40961
|
+
}
|
|
40962
|
+
|
|
40963
|
+
/**
|
|
40964
|
+
* Create a skill group
|
|
40965
|
+
*
|
|
40966
|
+
* @param {Object} body Create skill group
|
|
40967
|
+
*/
|
|
40968
|
+
postRoutingSkillgroups(body) {
|
|
40969
|
+
// verify the required parameter 'body' is set
|
|
40970
|
+
if (body === undefined || body === null) {
|
|
40971
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
40972
|
+
}
|
|
40973
|
+
|
|
40974
|
+
return this.apiClient.callApi(
|
|
40975
|
+
'/api/v2/routing/skillgroups',
|
|
40976
|
+
'POST',
|
|
40977
|
+
{ },
|
|
40978
|
+
{ },
|
|
40979
|
+
{ },
|
|
40980
|
+
{ },
|
|
40981
|
+
body,
|
|
40982
|
+
['PureCloud OAuth'],
|
|
40983
|
+
['application/json'],
|
|
40984
|
+
['application/json']
|
|
40985
|
+
);
|
|
40986
|
+
}
|
|
40987
|
+
|
|
40731
40988
|
/**
|
|
40732
40989
|
* Create Skill
|
|
40733
40990
|
*
|
|
@@ -41244,7 +41501,7 @@ class SCIMApi {
|
|
|
41244
41501
|
/**
|
|
41245
41502
|
* SCIM service.
|
|
41246
41503
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41247
|
-
* @version
|
|
41504
|
+
* @version 152.0.0
|
|
41248
41505
|
*/
|
|
41249
41506
|
|
|
41250
41507
|
/**
|
|
@@ -42121,7 +42378,7 @@ class ScriptsApi {
|
|
|
42121
42378
|
/**
|
|
42122
42379
|
* Scripts service.
|
|
42123
42380
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42124
|
-
* @version
|
|
42381
|
+
* @version 152.0.0
|
|
42125
42382
|
*/
|
|
42126
42383
|
|
|
42127
42384
|
/**
|
|
@@ -42540,7 +42797,7 @@ class SearchApi {
|
|
|
42540
42797
|
/**
|
|
42541
42798
|
* Search service.
|
|
42542
42799
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42543
|
-
* @version
|
|
42800
|
+
* @version 152.0.0
|
|
42544
42801
|
*/
|
|
42545
42802
|
|
|
42546
42803
|
/**
|
|
@@ -43069,6 +43326,31 @@ class SearchApi {
|
|
|
43069
43326
|
);
|
|
43070
43327
|
}
|
|
43071
43328
|
|
|
43329
|
+
/**
|
|
43330
|
+
* Search users assigned to teams
|
|
43331
|
+
*
|
|
43332
|
+
* @param {Object} body Search request options
|
|
43333
|
+
*/
|
|
43334
|
+
postUsersSearchTeamsAssign(body) {
|
|
43335
|
+
// verify the required parameter 'body' is set
|
|
43336
|
+
if (body === undefined || body === null) {
|
|
43337
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
43338
|
+
}
|
|
43339
|
+
|
|
43340
|
+
return this.apiClient.callApi(
|
|
43341
|
+
'/api/v2/users/search/teams/assign',
|
|
43342
|
+
'POST',
|
|
43343
|
+
{ },
|
|
43344
|
+
{ },
|
|
43345
|
+
{ },
|
|
43346
|
+
{ },
|
|
43347
|
+
body,
|
|
43348
|
+
['PureCloud OAuth'],
|
|
43349
|
+
['application/json'],
|
|
43350
|
+
['application/json']
|
|
43351
|
+
);
|
|
43352
|
+
}
|
|
43353
|
+
|
|
43072
43354
|
/**
|
|
43073
43355
|
* Search voicemails
|
|
43074
43356
|
*
|
|
@@ -43100,7 +43382,7 @@ class SpeechTextAnalyticsApi {
|
|
|
43100
43382
|
/**
|
|
43101
43383
|
* SpeechTextAnalytics service.
|
|
43102
43384
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43103
|
-
* @version
|
|
43385
|
+
* @version 152.0.0
|
|
43104
43386
|
*/
|
|
43105
43387
|
|
|
43106
43388
|
/**
|
|
@@ -43954,7 +44236,7 @@ class StationsApi {
|
|
|
43954
44236
|
/**
|
|
43955
44237
|
* Stations service.
|
|
43956
44238
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
43957
|
-
* @version
|
|
44239
|
+
* @version 152.0.0
|
|
43958
44240
|
*/
|
|
43959
44241
|
|
|
43960
44242
|
/**
|
|
@@ -44101,7 +44383,7 @@ class SuggestApi {
|
|
|
44101
44383
|
/**
|
|
44102
44384
|
* Suggest service.
|
|
44103
44385
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44104
|
-
* @version
|
|
44386
|
+
* @version 152.0.0
|
|
44105
44387
|
*/
|
|
44106
44388
|
|
|
44107
44389
|
/**
|
|
@@ -44240,7 +44522,7 @@ class TeamsApi {
|
|
|
44240
44522
|
/**
|
|
44241
44523
|
* Teams service.
|
|
44242
44524
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44243
|
-
* @version
|
|
44525
|
+
* @version 152.0.0
|
|
44244
44526
|
*/
|
|
44245
44527
|
|
|
44246
44528
|
/**
|
|
@@ -44280,6 +44562,36 @@ class TeamsApi {
|
|
|
44280
44562
|
);
|
|
44281
44563
|
}
|
|
44282
44564
|
|
|
44565
|
+
/**
|
|
44566
|
+
* Delete team members
|
|
44567
|
+
*
|
|
44568
|
+
* @param {String} teamId Team ID
|
|
44569
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
44570
|
+
*/
|
|
44571
|
+
deleteTeamMembers(teamId, id) {
|
|
44572
|
+
// verify the required parameter 'teamId' is set
|
|
44573
|
+
if (teamId === undefined || teamId === null) {
|
|
44574
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
44575
|
+
}
|
|
44576
|
+
// verify the required parameter 'id' is set
|
|
44577
|
+
if (id === undefined || id === null) {
|
|
44578
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
44579
|
+
}
|
|
44580
|
+
|
|
44581
|
+
return this.apiClient.callApi(
|
|
44582
|
+
'/api/v2/teams/{teamId}/members',
|
|
44583
|
+
'DELETE',
|
|
44584
|
+
{ 'teamId': teamId },
|
|
44585
|
+
{ 'id': id },
|
|
44586
|
+
{ },
|
|
44587
|
+
{ },
|
|
44588
|
+
null,
|
|
44589
|
+
['PureCloud OAuth'],
|
|
44590
|
+
['application/json'],
|
|
44591
|
+
['application/json']
|
|
44592
|
+
);
|
|
44593
|
+
}
|
|
44594
|
+
|
|
44283
44595
|
/**
|
|
44284
44596
|
* Get team
|
|
44285
44597
|
*
|
|
@@ -44305,6 +44617,38 @@ class TeamsApi {
|
|
|
44305
44617
|
);
|
|
44306
44618
|
}
|
|
44307
44619
|
|
|
44620
|
+
/**
|
|
44621
|
+
* Get team membership
|
|
44622
|
+
*
|
|
44623
|
+
* @param {String} teamId Team ID
|
|
44624
|
+
* @param {Object} opts Optional parameters
|
|
44625
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44626
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
44627
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
44628
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
44629
|
+
*/
|
|
44630
|
+
getTeamMembers(teamId, opts) {
|
|
44631
|
+
opts = opts || {};
|
|
44632
|
+
|
|
44633
|
+
// verify the required parameter 'teamId' is set
|
|
44634
|
+
if (teamId === undefined || teamId === null) {
|
|
44635
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
44636
|
+
}
|
|
44637
|
+
|
|
44638
|
+
return this.apiClient.callApi(
|
|
44639
|
+
'/api/v2/teams/{teamId}/members',
|
|
44640
|
+
'GET',
|
|
44641
|
+
{ 'teamId': teamId },
|
|
44642
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
44643
|
+
{ },
|
|
44644
|
+
{ },
|
|
44645
|
+
null,
|
|
44646
|
+
['PureCloud OAuth'],
|
|
44647
|
+
['application/json'],
|
|
44648
|
+
['application/json']
|
|
44649
|
+
);
|
|
44650
|
+
}
|
|
44651
|
+
|
|
44308
44652
|
/**
|
|
44309
44653
|
* Get Team listing
|
|
44310
44654
|
*
|
|
@@ -44363,6 +44707,36 @@ class TeamsApi {
|
|
|
44363
44707
|
);
|
|
44364
44708
|
}
|
|
44365
44709
|
|
|
44710
|
+
/**
|
|
44711
|
+
* Add team members
|
|
44712
|
+
*
|
|
44713
|
+
* @param {String} teamId Team ID
|
|
44714
|
+
* @param {Object} body TeamMembers
|
|
44715
|
+
*/
|
|
44716
|
+
postTeamMembers(teamId, body) {
|
|
44717
|
+
// verify the required parameter 'teamId' is set
|
|
44718
|
+
if (teamId === undefined || teamId === null) {
|
|
44719
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
44720
|
+
}
|
|
44721
|
+
// verify the required parameter 'body' is set
|
|
44722
|
+
if (body === undefined || body === null) {
|
|
44723
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
44724
|
+
}
|
|
44725
|
+
|
|
44726
|
+
return this.apiClient.callApi(
|
|
44727
|
+
'/api/v2/teams/{teamId}/members',
|
|
44728
|
+
'POST',
|
|
44729
|
+
{ 'teamId': teamId },
|
|
44730
|
+
{ },
|
|
44731
|
+
{ },
|
|
44732
|
+
{ },
|
|
44733
|
+
body,
|
|
44734
|
+
['PureCloud OAuth'],
|
|
44735
|
+
['application/json'],
|
|
44736
|
+
['application/json']
|
|
44737
|
+
);
|
|
44738
|
+
}
|
|
44739
|
+
|
|
44366
44740
|
/**
|
|
44367
44741
|
* Create a team
|
|
44368
44742
|
*
|
|
@@ -44419,7 +44793,7 @@ class TelephonyApi {
|
|
|
44419
44793
|
/**
|
|
44420
44794
|
* Telephony service.
|
|
44421
44795
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44422
|
-
* @version
|
|
44796
|
+
* @version 152.0.0
|
|
44423
44797
|
*/
|
|
44424
44798
|
|
|
44425
44799
|
/**
|
|
@@ -44527,7 +44901,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
44527
44901
|
/**
|
|
44528
44902
|
* TelephonyProvidersEdge service.
|
|
44529
44903
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44530
|
-
* @version
|
|
44904
|
+
* @version 152.0.0
|
|
44531
44905
|
*/
|
|
44532
44906
|
|
|
44533
44907
|
/**
|
|
@@ -48160,7 +48534,7 @@ class TextbotsApi {
|
|
|
48160
48534
|
/**
|
|
48161
48535
|
* Textbots service.
|
|
48162
48536
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48163
|
-
* @version
|
|
48537
|
+
* @version 152.0.0
|
|
48164
48538
|
*/
|
|
48165
48539
|
|
|
48166
48540
|
/**
|
|
@@ -48288,7 +48662,7 @@ class TokensApi {
|
|
|
48288
48662
|
/**
|
|
48289
48663
|
* Tokens service.
|
|
48290
48664
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48291
|
-
* @version
|
|
48665
|
+
* @version 152.0.0
|
|
48292
48666
|
*/
|
|
48293
48667
|
|
|
48294
48668
|
/**
|
|
@@ -48394,7 +48768,7 @@ class UploadsApi {
|
|
|
48394
48768
|
/**
|
|
48395
48769
|
* Uploads service.
|
|
48396
48770
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48397
|
-
* @version
|
|
48771
|
+
* @version 152.0.0
|
|
48398
48772
|
*/
|
|
48399
48773
|
|
|
48400
48774
|
/**
|
|
@@ -48570,7 +48944,7 @@ class UsageApi {
|
|
|
48570
48944
|
/**
|
|
48571
48945
|
* Usage service.
|
|
48572
48946
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48573
|
-
* @version
|
|
48947
|
+
* @version 152.0.0
|
|
48574
48948
|
*/
|
|
48575
48949
|
|
|
48576
48950
|
/**
|
|
@@ -48641,7 +49015,7 @@ class UserRecordingsApi {
|
|
|
48641
49015
|
/**
|
|
48642
49016
|
* UserRecordings service.
|
|
48643
49017
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
48644
|
-
* @version
|
|
49018
|
+
* @version 152.0.0
|
|
48645
49019
|
*/
|
|
48646
49020
|
|
|
48647
49021
|
/**
|
|
@@ -48826,7 +49200,7 @@ class UsersApi {
|
|
|
48826
49200
|
/**
|
|
48827
49201
|
* Users service.
|
|
48828
49202
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
48829
|
-
* @version
|
|
49203
|
+
* @version 152.0.0
|
|
48830
49204
|
*/
|
|
48831
49205
|
|
|
48832
49206
|
/**
|
|
@@ -50817,6 +51191,31 @@ class UsersApi {
|
|
|
50817
51191
|
);
|
|
50818
51192
|
}
|
|
50819
51193
|
|
|
51194
|
+
/**
|
|
51195
|
+
* Search users assigned to teams
|
|
51196
|
+
*
|
|
51197
|
+
* @param {Object} body Search request options
|
|
51198
|
+
*/
|
|
51199
|
+
postUsersSearchTeamsAssign(body) {
|
|
51200
|
+
// verify the required parameter 'body' is set
|
|
51201
|
+
if (body === undefined || body === null) {
|
|
51202
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
51203
|
+
}
|
|
51204
|
+
|
|
51205
|
+
return this.apiClient.callApi(
|
|
51206
|
+
'/api/v2/users/search/teams/assign',
|
|
51207
|
+
'POST',
|
|
51208
|
+
{ },
|
|
51209
|
+
{ },
|
|
51210
|
+
{ },
|
|
51211
|
+
{ },
|
|
51212
|
+
body,
|
|
51213
|
+
['PureCloud OAuth'],
|
|
51214
|
+
['application/json'],
|
|
51215
|
+
['application/json']
|
|
51216
|
+
);
|
|
51217
|
+
}
|
|
51218
|
+
|
|
50820
51219
|
/**
|
|
50821
51220
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
50822
51221
|
*
|
|
@@ -51158,7 +51557,7 @@ class UtilitiesApi {
|
|
|
51158
51557
|
/**
|
|
51159
51558
|
* Utilities service.
|
|
51160
51559
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51161
|
-
* @version
|
|
51560
|
+
* @version 152.0.0
|
|
51162
51561
|
*/
|
|
51163
51562
|
|
|
51164
51563
|
/**
|
|
@@ -51269,7 +51668,7 @@ class VoicemailApi {
|
|
|
51269
51668
|
/**
|
|
51270
51669
|
* Voicemail service.
|
|
51271
51670
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51272
|
-
* @version
|
|
51671
|
+
* @version 152.0.0
|
|
51273
51672
|
*/
|
|
51274
51673
|
|
|
51275
51674
|
/**
|
|
@@ -51936,7 +52335,7 @@ class WebChatApi {
|
|
|
51936
52335
|
/**
|
|
51937
52336
|
* WebChat service.
|
|
51938
52337
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
51939
|
-
* @version
|
|
52338
|
+
* @version 152.0.0
|
|
51940
52339
|
*/
|
|
51941
52340
|
|
|
51942
52341
|
/**
|
|
@@ -52480,7 +52879,7 @@ class WebDeploymentsApi {
|
|
|
52480
52879
|
/**
|
|
52481
52880
|
* WebDeployments service.
|
|
52482
52881
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52483
|
-
* @version
|
|
52882
|
+
* @version 152.0.0
|
|
52484
52883
|
*/
|
|
52485
52884
|
|
|
52486
52885
|
/**
|
|
@@ -52868,7 +53267,7 @@ class WebMessagingApi {
|
|
|
52868
53267
|
/**
|
|
52869
53268
|
* WebMessaging service.
|
|
52870
53269
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
52871
|
-
* @version
|
|
53270
|
+
* @version 152.0.0
|
|
52872
53271
|
*/
|
|
52873
53272
|
|
|
52874
53273
|
/**
|
|
@@ -52914,7 +53313,7 @@ class WidgetsApi {
|
|
|
52914
53313
|
/**
|
|
52915
53314
|
* Widgets service.
|
|
52916
53315
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
52917
|
-
* @version
|
|
53316
|
+
* @version 152.0.0
|
|
52918
53317
|
*/
|
|
52919
53318
|
|
|
52920
53319
|
/**
|
|
@@ -53060,7 +53459,7 @@ class WorkforceManagementApi {
|
|
|
53060
53459
|
/**
|
|
53061
53460
|
* WorkforceManagement service.
|
|
53062
53461
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53063
|
-
* @version
|
|
53462
|
+
* @version 152.0.0
|
|
53064
53463
|
*/
|
|
53065
53464
|
|
|
53066
53465
|
/**
|
|
@@ -56840,6 +57239,76 @@ class WorkforceManagementApi {
|
|
|
56840
57239
|
);
|
|
56841
57240
|
}
|
|
56842
57241
|
|
|
57242
|
+
/**
|
|
57243
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
57244
|
+
*
|
|
57245
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57246
|
+
* @param {String} userId The ID of the user
|
|
57247
|
+
* @param {Object} body The request body
|
|
57248
|
+
*/
|
|
57249
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
57250
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57251
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57252
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57253
|
+
}
|
|
57254
|
+
// verify the required parameter 'userId' is set
|
|
57255
|
+
if (userId === undefined || userId === null) {
|
|
57256
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57257
|
+
}
|
|
57258
|
+
// verify the required parameter 'body' is set
|
|
57259
|
+
if (body === undefined || body === null) {
|
|
57260
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57261
|
+
}
|
|
57262
|
+
|
|
57263
|
+
return this.apiClient.callApi(
|
|
57264
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
57265
|
+
'POST',
|
|
57266
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
57267
|
+
{ },
|
|
57268
|
+
{ },
|
|
57269
|
+
{ },
|
|
57270
|
+
body,
|
|
57271
|
+
['PureCloud OAuth'],
|
|
57272
|
+
['application/json'],
|
|
57273
|
+
['application/json']
|
|
57274
|
+
);
|
|
57275
|
+
}
|
|
57276
|
+
|
|
57277
|
+
/**
|
|
57278
|
+
* Query time off balances for dates spanned by a given time off request
|
|
57279
|
+
*
|
|
57280
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
57281
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
57282
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
57283
|
+
*/
|
|
57284
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
57285
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57286
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57287
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57288
|
+
}
|
|
57289
|
+
// verify the required parameter 'userId' is set
|
|
57290
|
+
if (userId === undefined || userId === null) {
|
|
57291
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57292
|
+
}
|
|
57293
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
57294
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
57295
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57296
|
+
}
|
|
57297
|
+
|
|
57298
|
+
return this.apiClient.callApi(
|
|
57299
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
57300
|
+
'POST',
|
|
57301
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
57302
|
+
{ },
|
|
57303
|
+
{ },
|
|
57304
|
+
{ },
|
|
57305
|
+
null,
|
|
57306
|
+
['PureCloud OAuth'],
|
|
57307
|
+
['application/json'],
|
|
57308
|
+
['application/json']
|
|
57309
|
+
);
|
|
57310
|
+
}
|
|
57311
|
+
|
|
56843
57312
|
/**
|
|
56844
57313
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
56845
57314
|
*
|
|
@@ -57336,7 +57805,7 @@ class WorkforceManagementApi {
|
|
|
57336
57805
|
* </pre>
|
|
57337
57806
|
* </p>
|
|
57338
57807
|
* @module purecloud-platform-client-v2/index
|
|
57339
|
-
* @version
|
|
57808
|
+
* @version 152.0.0
|
|
57340
57809
|
*/
|
|
57341
57810
|
class platformClient {
|
|
57342
57811
|
constructor() {
|