purecloud-platform-client-v2 151.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 +336 -145
- package/dist/web-amd/purecloud-platform-client-v2.js +336 -145
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +336 -145
- package/dist/web-cjs/purecloud-platform-client-v2.js +336 -145
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +367 -209
- 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 +14 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -65
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 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,
|
|
@@ -14527,7 +14560,7 @@ class DataExtensionsApi {
|
|
|
14527
14560
|
/**
|
|
14528
14561
|
* DataExtensions service.
|
|
14529
14562
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14530
|
-
* @version
|
|
14563
|
+
* @version 152.0.0
|
|
14531
14564
|
*/
|
|
14532
14565
|
|
|
14533
14566
|
/**
|
|
@@ -14613,7 +14646,7 @@ class DownloadsApi {
|
|
|
14613
14646
|
/**
|
|
14614
14647
|
* Downloads service.
|
|
14615
14648
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14616
|
-
* @version
|
|
14649
|
+
* @version 152.0.0
|
|
14617
14650
|
*/
|
|
14618
14651
|
|
|
14619
14652
|
/**
|
|
@@ -14665,7 +14698,7 @@ class EventsApi {
|
|
|
14665
14698
|
/**
|
|
14666
14699
|
* Events service.
|
|
14667
14700
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14668
|
-
* @version
|
|
14701
|
+
* @version 152.0.0
|
|
14669
14702
|
*/
|
|
14670
14703
|
|
|
14671
14704
|
/**
|
|
@@ -14761,7 +14794,7 @@ class ExternalContactsApi {
|
|
|
14761
14794
|
/**
|
|
14762
14795
|
* ExternalContacts service.
|
|
14763
14796
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14764
|
-
* @version
|
|
14797
|
+
* @version 152.0.0
|
|
14765
14798
|
*/
|
|
14766
14799
|
|
|
14767
14800
|
/**
|
|
@@ -16719,7 +16752,7 @@ class FaxApi {
|
|
|
16719
16752
|
/**
|
|
16720
16753
|
* Fax service.
|
|
16721
16754
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16722
|
-
* @version
|
|
16755
|
+
* @version 152.0.0
|
|
16723
16756
|
*/
|
|
16724
16757
|
|
|
16725
16758
|
/**
|
|
@@ -16890,7 +16923,7 @@ class FlowsApi {
|
|
|
16890
16923
|
/**
|
|
16891
16924
|
* Flows service.
|
|
16892
16925
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16893
|
-
* @version
|
|
16926
|
+
* @version 152.0.0
|
|
16894
16927
|
*/
|
|
16895
16928
|
|
|
16896
16929
|
/**
|
|
@@ -16961,7 +16994,7 @@ class GamificationApi {
|
|
|
16961
16994
|
/**
|
|
16962
16995
|
* Gamification service.
|
|
16963
16996
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16964
|
-
* @version
|
|
16997
|
+
* @version 152.0.0
|
|
16965
16998
|
*/
|
|
16966
16999
|
|
|
16967
17000
|
/**
|
|
@@ -17179,36 +17212,6 @@ class GamificationApi {
|
|
|
17179
17212
|
);
|
|
17180
17213
|
}
|
|
17181
17214
|
|
|
17182
|
-
/**
|
|
17183
|
-
* Gamified metric by id
|
|
17184
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
17185
|
-
* @param {String} metricId metric Id
|
|
17186
|
-
* @param {Object} opts Optional parameters
|
|
17187
|
-
* @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
|
|
17188
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
17189
|
-
*/
|
|
17190
|
-
getGamificationMetric(metricId, opts) {
|
|
17191
|
-
opts = opts || {};
|
|
17192
|
-
|
|
17193
|
-
// verify the required parameter 'metricId' is set
|
|
17194
|
-
if (metricId === undefined || metricId === null) {
|
|
17195
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
17196
|
-
}
|
|
17197
|
-
|
|
17198
|
-
return this.apiClient.callApi(
|
|
17199
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
17200
|
-
'GET',
|
|
17201
|
-
{ 'metricId': metricId },
|
|
17202
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
17203
|
-
{ },
|
|
17204
|
-
{ },
|
|
17205
|
-
null,
|
|
17206
|
-
['PureCloud OAuth'],
|
|
17207
|
-
['application/json'],
|
|
17208
|
-
['application/json']
|
|
17209
|
-
);
|
|
17210
|
-
}
|
|
17211
|
-
|
|
17212
17215
|
/**
|
|
17213
17216
|
* Metric definition by id
|
|
17214
17217
|
*
|
|
@@ -18513,40 +18516,6 @@ class GamificationApi {
|
|
|
18513
18516
|
);
|
|
18514
18517
|
}
|
|
18515
18518
|
|
|
18516
|
-
/**
|
|
18517
|
-
* Updates a metric
|
|
18518
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
18519
|
-
* @param {String} metricId metric Id
|
|
18520
|
-
* @param {Object} body Metric
|
|
18521
|
-
* @param {Object} opts Optional parameters
|
|
18522
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
18523
|
-
*/
|
|
18524
|
-
putGamificationMetric(metricId, body, opts) {
|
|
18525
|
-
opts = opts || {};
|
|
18526
|
-
|
|
18527
|
-
// verify the required parameter 'metricId' is set
|
|
18528
|
-
if (metricId === undefined || metricId === null) {
|
|
18529
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
18530
|
-
}
|
|
18531
|
-
// verify the required parameter 'body' is set
|
|
18532
|
-
if (body === undefined || body === null) {
|
|
18533
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
18534
|
-
}
|
|
18535
|
-
|
|
18536
|
-
return this.apiClient.callApi(
|
|
18537
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
18538
|
-
'PUT',
|
|
18539
|
-
{ 'metricId': metricId },
|
|
18540
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
18541
|
-
{ },
|
|
18542
|
-
{ },
|
|
18543
|
-
body,
|
|
18544
|
-
['PureCloud OAuth'],
|
|
18545
|
-
['application/json'],
|
|
18546
|
-
['application/json']
|
|
18547
|
-
);
|
|
18548
|
-
}
|
|
18549
|
-
|
|
18550
18519
|
/**
|
|
18551
18520
|
* Updates a performance profile
|
|
18552
18521
|
*
|
|
@@ -18642,7 +18611,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18642
18611
|
/**
|
|
18643
18612
|
* GeneralDataProtectionRegulation service.
|
|
18644
18613
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18645
|
-
* @version
|
|
18614
|
+
* @version 152.0.0
|
|
18646
18615
|
*/
|
|
18647
18616
|
|
|
18648
18617
|
/**
|
|
@@ -18772,7 +18741,7 @@ class GeolocationApi {
|
|
|
18772
18741
|
/**
|
|
18773
18742
|
* Geolocation service.
|
|
18774
18743
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18775
|
-
* @version
|
|
18744
|
+
* @version 152.0.0
|
|
18776
18745
|
*/
|
|
18777
18746
|
|
|
18778
18747
|
/**
|
|
@@ -18903,7 +18872,7 @@ class GreetingsApi {
|
|
|
18903
18872
|
/**
|
|
18904
18873
|
* Greetings service.
|
|
18905
18874
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18906
|
-
* @version
|
|
18875
|
+
* @version 152.0.0
|
|
18907
18876
|
*/
|
|
18908
18877
|
|
|
18909
18878
|
/**
|
|
@@ -19358,7 +19327,7 @@ class GroupsApi {
|
|
|
19358
19327
|
/**
|
|
19359
19328
|
* Groups service.
|
|
19360
19329
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19361
|
-
* @version
|
|
19330
|
+
* @version 152.0.0
|
|
19362
19331
|
*/
|
|
19363
19332
|
|
|
19364
19333
|
/**
|
|
@@ -19764,7 +19733,7 @@ class IdentityProviderApi {
|
|
|
19764
19733
|
/**
|
|
19765
19734
|
* IdentityProvider service.
|
|
19766
19735
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19767
|
-
* @version
|
|
19736
|
+
* @version 152.0.0
|
|
19768
19737
|
*/
|
|
19769
19738
|
|
|
19770
19739
|
/**
|
|
@@ -20520,7 +20489,7 @@ class IntegrationsApi {
|
|
|
20520
20489
|
/**
|
|
20521
20490
|
* Integrations service.
|
|
20522
20491
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20523
|
-
* @version
|
|
20492
|
+
* @version 152.0.0
|
|
20524
20493
|
*/
|
|
20525
20494
|
|
|
20526
20495
|
/**
|
|
@@ -22120,7 +22089,7 @@ class JourneyApi {
|
|
|
22120
22089
|
/**
|
|
22121
22090
|
* Journey service.
|
|
22122
22091
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22123
|
-
* @version
|
|
22092
|
+
* @version 152.0.0
|
|
22124
22093
|
*/
|
|
22125
22094
|
|
|
22126
22095
|
/**
|
|
@@ -22906,7 +22875,7 @@ class KnowledgeApi {
|
|
|
22906
22875
|
/**
|
|
22907
22876
|
* Knowledge service.
|
|
22908
22877
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22909
|
-
* @version
|
|
22878
|
+
* @version 152.0.0
|
|
22910
22879
|
*/
|
|
22911
22880
|
|
|
22912
22881
|
/**
|
|
@@ -23309,8 +23278,8 @@ class KnowledgeApi {
|
|
|
23309
23278
|
* @param {String} sessionId Knowledge guest session ID.
|
|
23310
23279
|
* @param {Object} opts Optional parameters
|
|
23311
23280
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23312
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23313
|
-
* @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)
|
|
23314
23283
|
*/
|
|
23315
23284
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
23316
23285
|
opts = opts || {};
|
|
@@ -25339,7 +25308,7 @@ class LanguageUnderstandingApi {
|
|
|
25339
25308
|
/**
|
|
25340
25309
|
* LanguageUnderstanding service.
|
|
25341
25310
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25342
|
-
* @version
|
|
25311
|
+
* @version 152.0.0
|
|
25343
25312
|
*/
|
|
25344
25313
|
|
|
25345
25314
|
/**
|
|
@@ -26243,7 +26212,7 @@ class LanguagesApi {
|
|
|
26243
26212
|
/**
|
|
26244
26213
|
* Languages service.
|
|
26245
26214
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26246
|
-
* @version
|
|
26215
|
+
* @version 152.0.0
|
|
26247
26216
|
*/
|
|
26248
26217
|
|
|
26249
26218
|
/**
|
|
@@ -26511,7 +26480,7 @@ class LearningApi {
|
|
|
26511
26480
|
/**
|
|
26512
26481
|
* Learning service.
|
|
26513
26482
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26514
|
-
* @version
|
|
26483
|
+
* @version 152.0.0
|
|
26515
26484
|
*/
|
|
26516
26485
|
|
|
26517
26486
|
/**
|
|
@@ -27271,7 +27240,7 @@ class LicenseApi {
|
|
|
27271
27240
|
/**
|
|
27272
27241
|
* License service.
|
|
27273
27242
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27274
|
-
* @version
|
|
27243
|
+
* @version 152.0.0
|
|
27275
27244
|
*/
|
|
27276
27245
|
|
|
27277
27246
|
/**
|
|
@@ -27509,7 +27478,7 @@ class LocationsApi {
|
|
|
27509
27478
|
/**
|
|
27510
27479
|
* Locations service.
|
|
27511
27480
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27512
|
-
* @version
|
|
27481
|
+
* @version 152.0.0
|
|
27513
27482
|
*/
|
|
27514
27483
|
|
|
27515
27484
|
/**
|
|
@@ -27745,7 +27714,7 @@ class MessagingApi {
|
|
|
27745
27714
|
/**
|
|
27746
27715
|
* Messaging service.
|
|
27747
27716
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27748
|
-
* @version
|
|
27717
|
+
* @version 152.0.0
|
|
27749
27718
|
*/
|
|
27750
27719
|
|
|
27751
27720
|
/**
|
|
@@ -27896,7 +27865,7 @@ class MobileDevicesApi {
|
|
|
27896
27865
|
/**
|
|
27897
27866
|
* MobileDevices service.
|
|
27898
27867
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27899
|
-
* @version
|
|
27868
|
+
* @version 152.0.0
|
|
27900
27869
|
*/
|
|
27901
27870
|
|
|
27902
27871
|
/**
|
|
@@ -28047,7 +28016,7 @@ class NotificationsApi {
|
|
|
28047
28016
|
/**
|
|
28048
28017
|
* Notifications service.
|
|
28049
28018
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28050
|
-
* @version
|
|
28019
|
+
* @version 152.0.0
|
|
28051
28020
|
*/
|
|
28052
28021
|
|
|
28053
28022
|
/**
|
|
@@ -28272,7 +28241,7 @@ class OAuthApi {
|
|
|
28272
28241
|
/**
|
|
28273
28242
|
* OAuth service.
|
|
28274
28243
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28275
|
-
* @version
|
|
28244
|
+
* @version 152.0.0
|
|
28276
28245
|
*/
|
|
28277
28246
|
|
|
28278
28247
|
/**
|
|
@@ -28638,7 +28607,7 @@ class ObjectsApi {
|
|
|
28638
28607
|
/**
|
|
28639
28608
|
* Objects service.
|
|
28640
28609
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28641
|
-
* @version
|
|
28610
|
+
* @version 152.0.0
|
|
28642
28611
|
*/
|
|
28643
28612
|
|
|
28644
28613
|
/**
|
|
@@ -28909,7 +28878,7 @@ class OrganizationApi {
|
|
|
28909
28878
|
/**
|
|
28910
28879
|
* Organization service.
|
|
28911
28880
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28912
|
-
* @version
|
|
28881
|
+
* @version 152.0.0
|
|
28913
28882
|
*/
|
|
28914
28883
|
|
|
28915
28884
|
/**
|
|
@@ -29312,7 +29281,7 @@ class OrganizationAuthorizationApi {
|
|
|
29312
29281
|
/**
|
|
29313
29282
|
* OrganizationAuthorization service.
|
|
29314
29283
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29315
|
-
* @version
|
|
29284
|
+
* @version 152.0.0
|
|
29316
29285
|
*/
|
|
29317
29286
|
|
|
29318
29287
|
/**
|
|
@@ -30237,7 +30206,7 @@ class OutboundApi {
|
|
|
30237
30206
|
/**
|
|
30238
30207
|
* Outbound service.
|
|
30239
30208
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30240
|
-
* @version
|
|
30209
|
+
* @version 152.0.0
|
|
30241
30210
|
*/
|
|
30242
30211
|
|
|
30243
30212
|
/**
|
|
@@ -33626,7 +33595,7 @@ class PresenceApi {
|
|
|
33626
33595
|
/**
|
|
33627
33596
|
* Presence service.
|
|
33628
33597
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33629
|
-
* @version
|
|
33598
|
+
* @version 152.0.0
|
|
33630
33599
|
*/
|
|
33631
33600
|
|
|
33632
33601
|
/**
|
|
@@ -34132,7 +34101,7 @@ class ProcessAutomationApi {
|
|
|
34132
34101
|
/**
|
|
34133
34102
|
* ProcessAutomation service.
|
|
34134
34103
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34135
|
-
* @version
|
|
34104
|
+
* @version 152.0.0
|
|
34136
34105
|
*/
|
|
34137
34106
|
|
|
34138
34107
|
/**
|
|
@@ -34370,7 +34339,7 @@ class QualityApi {
|
|
|
34370
34339
|
/**
|
|
34371
34340
|
* Quality service.
|
|
34372
34341
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34373
|
-
* @version
|
|
34342
|
+
* @version 152.0.0
|
|
34374
34343
|
*/
|
|
34375
34344
|
|
|
34376
34345
|
/**
|
|
@@ -35948,7 +35917,7 @@ class RecordingApi {
|
|
|
35948
35917
|
/**
|
|
35949
35918
|
* Recording service.
|
|
35950
35919
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35951
|
-
* @version
|
|
35920
|
+
* @version 152.0.0
|
|
35952
35921
|
*/
|
|
35953
35922
|
|
|
35954
35923
|
/**
|
|
@@ -37635,7 +37604,7 @@ class ResponseManagementApi {
|
|
|
37635
37604
|
/**
|
|
37636
37605
|
* ResponseManagement service.
|
|
37637
37606
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37638
|
-
* @version
|
|
37607
|
+
* @version 152.0.0
|
|
37639
37608
|
*/
|
|
37640
37609
|
|
|
37641
37610
|
/**
|
|
@@ -38119,7 +38088,7 @@ class RoutingApi {
|
|
|
38119
38088
|
/**
|
|
38120
38089
|
* Routing service.
|
|
38121
38090
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38122
|
-
* @version
|
|
38091
|
+
* @version 152.0.0
|
|
38123
38092
|
*/
|
|
38124
38093
|
|
|
38125
38094
|
/**
|
|
@@ -38428,6 +38397,31 @@ class RoutingApi {
|
|
|
38428
38397
|
);
|
|
38429
38398
|
}
|
|
38430
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
|
+
|
|
38431
38425
|
/**
|
|
38432
38426
|
* Delete an Address by Id for SMS
|
|
38433
38427
|
*
|
|
@@ -39613,6 +39607,119 @@ class RoutingApi {
|
|
|
39613
39607
|
);
|
|
39614
39608
|
}
|
|
39615
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
|
+
|
|
39616
39723
|
/**
|
|
39617
39724
|
* Get the list of routing skills.
|
|
39618
39725
|
*
|
|
@@ -40251,6 +40358,36 @@ class RoutingApi {
|
|
|
40251
40358
|
);
|
|
40252
40359
|
}
|
|
40253
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
|
+
|
|
40254
40391
|
/**
|
|
40255
40392
|
* Join or unjoin a queue for a user
|
|
40256
40393
|
*
|
|
@@ -40794,6 +40931,60 @@ class RoutingApi {
|
|
|
40794
40931
|
);
|
|
40795
40932
|
}
|
|
40796
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
|
+
|
|
40797
40988
|
/**
|
|
40798
40989
|
* Create Skill
|
|
40799
40990
|
*
|
|
@@ -41310,7 +41501,7 @@ class SCIMApi {
|
|
|
41310
41501
|
/**
|
|
41311
41502
|
* SCIM service.
|
|
41312
41503
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41313
|
-
* @version
|
|
41504
|
+
* @version 152.0.0
|
|
41314
41505
|
*/
|
|
41315
41506
|
|
|
41316
41507
|
/**
|
|
@@ -42187,7 +42378,7 @@ class ScriptsApi {
|
|
|
42187
42378
|
/**
|
|
42188
42379
|
* Scripts service.
|
|
42189
42380
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42190
|
-
* @version
|
|
42381
|
+
* @version 152.0.0
|
|
42191
42382
|
*/
|
|
42192
42383
|
|
|
42193
42384
|
/**
|
|
@@ -42606,7 +42797,7 @@ class SearchApi {
|
|
|
42606
42797
|
/**
|
|
42607
42798
|
* Search service.
|
|
42608
42799
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42609
|
-
* @version
|
|
42800
|
+
* @version 152.0.0
|
|
42610
42801
|
*/
|
|
42611
42802
|
|
|
42612
42803
|
/**
|
|
@@ -43191,7 +43382,7 @@ class SpeechTextAnalyticsApi {
|
|
|
43191
43382
|
/**
|
|
43192
43383
|
* SpeechTextAnalytics service.
|
|
43193
43384
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43194
|
-
* @version
|
|
43385
|
+
* @version 152.0.0
|
|
43195
43386
|
*/
|
|
43196
43387
|
|
|
43197
43388
|
/**
|
|
@@ -44045,7 +44236,7 @@ class StationsApi {
|
|
|
44045
44236
|
/**
|
|
44046
44237
|
* Stations service.
|
|
44047
44238
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44048
|
-
* @version
|
|
44239
|
+
* @version 152.0.0
|
|
44049
44240
|
*/
|
|
44050
44241
|
|
|
44051
44242
|
/**
|
|
@@ -44192,7 +44383,7 @@ class SuggestApi {
|
|
|
44192
44383
|
/**
|
|
44193
44384
|
* Suggest service.
|
|
44194
44385
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44195
|
-
* @version
|
|
44386
|
+
* @version 152.0.0
|
|
44196
44387
|
*/
|
|
44197
44388
|
|
|
44198
44389
|
/**
|
|
@@ -44331,7 +44522,7 @@ class TeamsApi {
|
|
|
44331
44522
|
/**
|
|
44332
44523
|
* Teams service.
|
|
44333
44524
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44334
|
-
* @version
|
|
44525
|
+
* @version 152.0.0
|
|
44335
44526
|
*/
|
|
44336
44527
|
|
|
44337
44528
|
/**
|
|
@@ -44602,7 +44793,7 @@ class TelephonyApi {
|
|
|
44602
44793
|
/**
|
|
44603
44794
|
* Telephony service.
|
|
44604
44795
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44605
|
-
* @version
|
|
44796
|
+
* @version 152.0.0
|
|
44606
44797
|
*/
|
|
44607
44798
|
|
|
44608
44799
|
/**
|
|
@@ -44710,7 +44901,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
44710
44901
|
/**
|
|
44711
44902
|
* TelephonyProvidersEdge service.
|
|
44712
44903
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44713
|
-
* @version
|
|
44904
|
+
* @version 152.0.0
|
|
44714
44905
|
*/
|
|
44715
44906
|
|
|
44716
44907
|
/**
|
|
@@ -48343,7 +48534,7 @@ class TextbotsApi {
|
|
|
48343
48534
|
/**
|
|
48344
48535
|
* Textbots service.
|
|
48345
48536
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48346
|
-
* @version
|
|
48537
|
+
* @version 152.0.0
|
|
48347
48538
|
*/
|
|
48348
48539
|
|
|
48349
48540
|
/**
|
|
@@ -48471,7 +48662,7 @@ class TokensApi {
|
|
|
48471
48662
|
/**
|
|
48472
48663
|
* Tokens service.
|
|
48473
48664
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48474
|
-
* @version
|
|
48665
|
+
* @version 152.0.0
|
|
48475
48666
|
*/
|
|
48476
48667
|
|
|
48477
48668
|
/**
|
|
@@ -48577,7 +48768,7 @@ class UploadsApi {
|
|
|
48577
48768
|
/**
|
|
48578
48769
|
* Uploads service.
|
|
48579
48770
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48580
|
-
* @version
|
|
48771
|
+
* @version 152.0.0
|
|
48581
48772
|
*/
|
|
48582
48773
|
|
|
48583
48774
|
/**
|
|
@@ -48753,7 +48944,7 @@ class UsageApi {
|
|
|
48753
48944
|
/**
|
|
48754
48945
|
* Usage service.
|
|
48755
48946
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48756
|
-
* @version
|
|
48947
|
+
* @version 152.0.0
|
|
48757
48948
|
*/
|
|
48758
48949
|
|
|
48759
48950
|
/**
|
|
@@ -48824,7 +49015,7 @@ class UserRecordingsApi {
|
|
|
48824
49015
|
/**
|
|
48825
49016
|
* UserRecordings service.
|
|
48826
49017
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
48827
|
-
* @version
|
|
49018
|
+
* @version 152.0.0
|
|
48828
49019
|
*/
|
|
48829
49020
|
|
|
48830
49021
|
/**
|
|
@@ -49009,7 +49200,7 @@ class UsersApi {
|
|
|
49009
49200
|
/**
|
|
49010
49201
|
* Users service.
|
|
49011
49202
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49012
|
-
* @version
|
|
49203
|
+
* @version 152.0.0
|
|
49013
49204
|
*/
|
|
49014
49205
|
|
|
49015
49206
|
/**
|
|
@@ -51366,7 +51557,7 @@ class UtilitiesApi {
|
|
|
51366
51557
|
/**
|
|
51367
51558
|
* Utilities service.
|
|
51368
51559
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51369
|
-
* @version
|
|
51560
|
+
* @version 152.0.0
|
|
51370
51561
|
*/
|
|
51371
51562
|
|
|
51372
51563
|
/**
|
|
@@ -51477,7 +51668,7 @@ class VoicemailApi {
|
|
|
51477
51668
|
/**
|
|
51478
51669
|
* Voicemail service.
|
|
51479
51670
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51480
|
-
* @version
|
|
51671
|
+
* @version 152.0.0
|
|
51481
51672
|
*/
|
|
51482
51673
|
|
|
51483
51674
|
/**
|
|
@@ -52144,7 +52335,7 @@ class WebChatApi {
|
|
|
52144
52335
|
/**
|
|
52145
52336
|
* WebChat service.
|
|
52146
52337
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52147
|
-
* @version
|
|
52338
|
+
* @version 152.0.0
|
|
52148
52339
|
*/
|
|
52149
52340
|
|
|
52150
52341
|
/**
|
|
@@ -52688,7 +52879,7 @@ class WebDeploymentsApi {
|
|
|
52688
52879
|
/**
|
|
52689
52880
|
* WebDeployments service.
|
|
52690
52881
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52691
|
-
* @version
|
|
52882
|
+
* @version 152.0.0
|
|
52692
52883
|
*/
|
|
52693
52884
|
|
|
52694
52885
|
/**
|
|
@@ -53076,7 +53267,7 @@ class WebMessagingApi {
|
|
|
53076
53267
|
/**
|
|
53077
53268
|
* WebMessaging service.
|
|
53078
53269
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53079
|
-
* @version
|
|
53270
|
+
* @version 152.0.0
|
|
53080
53271
|
*/
|
|
53081
53272
|
|
|
53082
53273
|
/**
|
|
@@ -53122,7 +53313,7 @@ class WidgetsApi {
|
|
|
53122
53313
|
/**
|
|
53123
53314
|
* Widgets service.
|
|
53124
53315
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53125
|
-
* @version
|
|
53316
|
+
* @version 152.0.0
|
|
53126
53317
|
*/
|
|
53127
53318
|
|
|
53128
53319
|
/**
|
|
@@ -53268,7 +53459,7 @@ class WorkforceManagementApi {
|
|
|
53268
53459
|
/**
|
|
53269
53460
|
* WorkforceManagement service.
|
|
53270
53461
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53271
|
-
* @version
|
|
53462
|
+
* @version 152.0.0
|
|
53272
53463
|
*/
|
|
53273
53464
|
|
|
53274
53465
|
/**
|
|
@@ -57614,7 +57805,7 @@ class WorkforceManagementApi {
|
|
|
57614
57805
|
* </pre>
|
|
57615
57806
|
* </p>
|
|
57616
57807
|
* @module purecloud-platform-client-v2/index
|
|
57617
|
-
* @version
|
|
57808
|
+
* @version 152.0.0
|
|
57618
57809
|
*/
|
|
57619
57810
|
class platformClient {
|
|
57620
57811
|
constructor() {
|