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
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 152.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1478,7 +1478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1478
1478
|
/**
|
|
1479
1479
|
* Alerting service.
|
|
1480
1480
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1481
|
-
* @version
|
|
1481
|
+
* @version 152.0.0
|
|
1482
1482
|
*/
|
|
1483
1483
|
|
|
1484
1484
|
/**
|
|
@@ -1792,7 +1792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1792
1792
|
/**
|
|
1793
1793
|
* Analytics service.
|
|
1794
1794
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1795
|
-
* @version
|
|
1795
|
+
* @version 152.0.0
|
|
1796
1796
|
*/
|
|
1797
1797
|
|
|
1798
1798
|
/**
|
|
@@ -1891,6 +1891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1891
1891
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
1892
1892
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
1893
1893
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
1894
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
1894
1895
|
*/
|
|
1895
1896
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
1896
1897
|
opts = opts || {};
|
|
@@ -1904,7 +1905,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1904
1905
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
1905
1906
|
'GET',
|
|
1906
1907
|
{ 'botFlowId': botFlowId },
|
|
1907
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'] },
|
|
1908
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
1908
1909
|
{ },
|
|
1909
1910
|
{ },
|
|
1910
1911
|
null,
|
|
@@ -2453,6 +2454,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2453
2454
|
);
|
|
2454
2455
|
}
|
|
2455
2456
|
|
|
2457
|
+
/**
|
|
2458
|
+
* Query for action aggregates
|
|
2459
|
+
*
|
|
2460
|
+
* @param {Object} body query
|
|
2461
|
+
*/
|
|
2462
|
+
postAnalyticsActionsAggregatesQuery(body) {
|
|
2463
|
+
// verify the required parameter 'body' is set
|
|
2464
|
+
if (body === undefined || body === null) {
|
|
2465
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
|
|
2466
|
+
}
|
|
2467
|
+
|
|
2468
|
+
return this.apiClient.callApi(
|
|
2469
|
+
'/api/v2/analytics/actions/aggregates/query',
|
|
2470
|
+
'POST',
|
|
2471
|
+
{ },
|
|
2472
|
+
{ },
|
|
2473
|
+
{ },
|
|
2474
|
+
{ },
|
|
2475
|
+
body,
|
|
2476
|
+
['PureCloud OAuth'],
|
|
2477
|
+
['application/json'],
|
|
2478
|
+
['application/json']
|
|
2479
|
+
);
|
|
2480
|
+
}
|
|
2481
|
+
|
|
2456
2482
|
/**
|
|
2457
2483
|
* Query for bot aggregates
|
|
2458
2484
|
*
|
|
@@ -3019,7 +3045,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3019
3045
|
/**
|
|
3020
3046
|
* Architect service.
|
|
3021
3047
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3022
|
-
* @version
|
|
3048
|
+
* @version 152.0.0
|
|
3023
3049
|
*/
|
|
3024
3050
|
|
|
3025
3051
|
/**
|
|
@@ -4612,6 +4638,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4612
4638
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
4613
4639
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
4614
4640
|
* @param {Boolean} opts.showbrief If true returns just the key value of the row (default to true)
|
|
4641
|
+
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
4615
4642
|
*/
|
|
4616
4643
|
getFlowsDatatableRows(datatableId, opts) {
|
|
4617
4644
|
opts = opts || {};
|
|
@@ -4625,7 +4652,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4625
4652
|
'/api/v2/flows/datatables/{datatableId}/rows',
|
|
4626
4653
|
'GET',
|
|
4627
4654
|
{ 'datatableId': datatableId },
|
|
4628
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'] },
|
|
4655
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'],'sortOrder': opts['sortOrder'] },
|
|
4629
4656
|
{ },
|
|
4630
4657
|
{ },
|
|
4631
4658
|
null,
|
|
@@ -4645,7 +4672,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4645
4672
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
4646
4673
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
4647
4674
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
4648
|
-
* @param {String} opts.name Name
|
|
4675
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
4649
4676
|
*/
|
|
4650
4677
|
getFlowsDatatables(opts) {
|
|
4651
4678
|
opts = opts || {};
|
|
@@ -4704,7 +4731,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4704
4731
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
4705
4732
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
4706
4733
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
4707
|
-
* @param {String} opts.name Name
|
|
4734
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
4708
4735
|
*/
|
|
4709
4736
|
getFlowsDatatablesDivisionviews(opts) {
|
|
4710
4737
|
opts = opts || {};
|
|
@@ -6065,7 +6092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6065
6092
|
/**
|
|
6066
6093
|
* Audit service.
|
|
6067
6094
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6068
|
-
* @version
|
|
6095
|
+
* @version 152.0.0
|
|
6069
6096
|
*/
|
|
6070
6097
|
|
|
6071
6098
|
/**
|
|
@@ -6236,7 +6263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6236
6263
|
/**
|
|
6237
6264
|
* Authorization service.
|
|
6238
6265
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6239
|
-
* @version
|
|
6266
|
+
* @version 152.0.0
|
|
6240
6267
|
*/
|
|
6241
6268
|
|
|
6242
6269
|
/**
|
|
@@ -7419,7 +7446,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7419
7446
|
/**
|
|
7420
7447
|
* Billing service.
|
|
7421
7448
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7422
|
-
* @version
|
|
7449
|
+
* @version 152.0.0
|
|
7423
7450
|
*/
|
|
7424
7451
|
|
|
7425
7452
|
/**
|
|
@@ -7499,7 +7526,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7499
7526
|
/**
|
|
7500
7527
|
* Chat service.
|
|
7501
7528
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7502
|
-
* @version
|
|
7529
|
+
* @version 152.0.0
|
|
7503
7530
|
*/
|
|
7504
7531
|
|
|
7505
7532
|
/**
|
|
@@ -7590,7 +7617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7590
7617
|
/**
|
|
7591
7618
|
* Coaching service.
|
|
7592
7619
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7593
|
-
* @version
|
|
7620
|
+
* @version 152.0.0
|
|
7594
7621
|
*/
|
|
7595
7622
|
|
|
7596
7623
|
/**
|
|
@@ -8167,7 +8194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8167
8194
|
/**
|
|
8168
8195
|
* ContentManagement service.
|
|
8169
8196
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8170
|
-
* @version
|
|
8197
|
+
* @version 152.0.0
|
|
8171
8198
|
*/
|
|
8172
8199
|
|
|
8173
8200
|
/**
|
|
@@ -9307,7 +9334,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9307
9334
|
/**
|
|
9308
9335
|
* Conversations service.
|
|
9309
9336
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9310
|
-
* @version
|
|
9337
|
+
* @version 152.0.0
|
|
9311
9338
|
*/
|
|
9312
9339
|
|
|
9313
9340
|
/**
|
|
@@ -10986,8 +11013,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10986
11013
|
* @param {Object} opts Optional parameters
|
|
10987
11014
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10988
11015
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10989
|
-
* @param {
|
|
11016
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value.
|
|
10990
11017
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11018
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
10991
11019
|
*/
|
|
10992
11020
|
getConversationsMessagingIntegrations(opts) {
|
|
10993
11021
|
opts = opts || {};
|
|
@@ -10997,7 +11025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10997
11025
|
'/api/v2/conversations/messaging/integrations',
|
|
10998
11026
|
'GET',
|
|
10999
11027
|
{ },
|
|
11000
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11028
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11001
11029
|
{ },
|
|
11002
11030
|
{ },
|
|
11003
11031
|
null,
|
|
@@ -11015,6 +11043,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11015
11043
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11016
11044
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11017
11045
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11046
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11018
11047
|
*/
|
|
11019
11048
|
getConversationsMessagingIntegrationsFacebook(opts) {
|
|
11020
11049
|
opts = opts || {};
|
|
@@ -11024,7 +11053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11024
11053
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
11025
11054
|
'GET',
|
|
11026
11055
|
{ },
|
|
11027
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11056
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11028
11057
|
{ },
|
|
11029
11058
|
{ },
|
|
11030
11059
|
null,
|
|
@@ -11071,6 +11100,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11071
11100
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11072
11101
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11073
11102
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11103
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11074
11104
|
*/
|
|
11075
11105
|
getConversationsMessagingIntegrationsLine(opts) {
|
|
11076
11106
|
opts = opts || {};
|
|
@@ -11080,7 +11110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11080
11110
|
'/api/v2/conversations/messaging/integrations/line',
|
|
11081
11111
|
'GET',
|
|
11082
11112
|
{ },
|
|
11083
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11113
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11084
11114
|
{ },
|
|
11085
11115
|
{ },
|
|
11086
11116
|
null,
|
|
@@ -11127,6 +11157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11127
11157
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11128
11158
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11129
11159
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11160
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11130
11161
|
*/
|
|
11131
11162
|
getConversationsMessagingIntegrationsOpen(opts) {
|
|
11132
11163
|
opts = opts || {};
|
|
@@ -11136,7 +11167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11136
11167
|
'/api/v2/conversations/messaging/integrations/open',
|
|
11137
11168
|
'GET',
|
|
11138
11169
|
{ },
|
|
11139
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11170
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11140
11171
|
{ },
|
|
11141
11172
|
{ },
|
|
11142
11173
|
null,
|
|
@@ -11183,6 +11214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11183
11214
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11184
11215
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11185
11216
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11217
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11186
11218
|
*/
|
|
11187
11219
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
11188
11220
|
opts = opts || {};
|
|
@@ -11192,7 +11224,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11192
11224
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
11193
11225
|
'GET',
|
|
11194
11226
|
{ },
|
|
11195
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11227
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11196
11228
|
{ },
|
|
11197
11229
|
{ },
|
|
11198
11230
|
null,
|
|
@@ -11239,6 +11271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11239
11271
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11240
11272
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11241
11273
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11274
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11242
11275
|
*/
|
|
11243
11276
|
getConversationsMessagingIntegrationsWhatsapp(opts) {
|
|
11244
11277
|
opts = opts || {};
|
|
@@ -11248,7 +11281,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11248
11281
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
11249
11282
|
'GET',
|
|
11250
11283
|
{ },
|
|
11251
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11284
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11252
11285
|
{ },
|
|
11253
11286
|
{ },
|
|
11254
11287
|
null,
|
|
@@ -13653,6 +13686,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13653
13686
|
);
|
|
13654
13687
|
}
|
|
13655
13688
|
|
|
13689
|
+
/**
|
|
13690
|
+
* Send message typing event
|
|
13691
|
+
* Send message typing event for existing conversation/communication.
|
|
13692
|
+
* @param {String} conversationId conversationId
|
|
13693
|
+
* @param {String} communicationId communicationId
|
|
13694
|
+
* @param {Object} body MessageTypingEvent
|
|
13695
|
+
*/
|
|
13696
|
+
postConversationsMessageCommunicationTyping(conversationId, communicationId, body) {
|
|
13697
|
+
// verify the required parameter 'conversationId' is set
|
|
13698
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13699
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';
|
|
13700
|
+
}
|
|
13701
|
+
// verify the required parameter 'communicationId' is set
|
|
13702
|
+
if (communicationId === undefined || communicationId === null) {
|
|
13703
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';
|
|
13704
|
+
}
|
|
13705
|
+
// verify the required parameter 'body' is set
|
|
13706
|
+
if (body === undefined || body === null) {
|
|
13707
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';
|
|
13708
|
+
}
|
|
13709
|
+
|
|
13710
|
+
return this.apiClient.callApi(
|
|
13711
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing',
|
|
13712
|
+
'POST',
|
|
13713
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
13714
|
+
{ },
|
|
13715
|
+
{ },
|
|
13716
|
+
{ },
|
|
13717
|
+
body,
|
|
13718
|
+
['PureCloud OAuth'],
|
|
13719
|
+
['application/json'],
|
|
13720
|
+
['application/json']
|
|
13721
|
+
);
|
|
13722
|
+
}
|
|
13723
|
+
|
|
13656
13724
|
/**
|
|
13657
13725
|
* Get messages in batch
|
|
13658
13726
|
* 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"]
|
|
@@ -14489,7 +14557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14489
14557
|
/**
|
|
14490
14558
|
* DataExtensions service.
|
|
14491
14559
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14492
|
-
* @version
|
|
14560
|
+
* @version 152.0.0
|
|
14493
14561
|
*/
|
|
14494
14562
|
|
|
14495
14563
|
/**
|
|
@@ -14575,7 +14643,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14575
14643
|
/**
|
|
14576
14644
|
* Downloads service.
|
|
14577
14645
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14578
|
-
* @version
|
|
14646
|
+
* @version 152.0.0
|
|
14579
14647
|
*/
|
|
14580
14648
|
|
|
14581
14649
|
/**
|
|
@@ -14627,7 +14695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14627
14695
|
/**
|
|
14628
14696
|
* Events service.
|
|
14629
14697
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14630
|
-
* @version
|
|
14698
|
+
* @version 152.0.0
|
|
14631
14699
|
*/
|
|
14632
14700
|
|
|
14633
14701
|
/**
|
|
@@ -14723,7 +14791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14723
14791
|
/**
|
|
14724
14792
|
* ExternalContacts service.
|
|
14725
14793
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14726
|
-
* @version
|
|
14794
|
+
* @version 152.0.0
|
|
14727
14795
|
*/
|
|
14728
14796
|
|
|
14729
14797
|
/**
|
|
@@ -14977,6 +15045,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14977
15045
|
);
|
|
14978
15046
|
}
|
|
14979
15047
|
|
|
15048
|
+
/**
|
|
15049
|
+
* Retrieve all sessions for a given external contact.
|
|
15050
|
+
*
|
|
15051
|
+
* @param {String} contactId ExternalContact ID
|
|
15052
|
+
* @param {Object} opts Optional parameters
|
|
15053
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
15054
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15055
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
15056
|
+
*/
|
|
15057
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
15058
|
+
opts = opts || {};
|
|
15059
|
+
|
|
15060
|
+
// verify the required parameter 'contactId' is set
|
|
15061
|
+
if (contactId === undefined || contactId === null) {
|
|
15062
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
15063
|
+
}
|
|
15064
|
+
|
|
15065
|
+
return this.apiClient.callApi(
|
|
15066
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
15067
|
+
'GET',
|
|
15068
|
+
{ 'contactId': contactId },
|
|
15069
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
15070
|
+
{ },
|
|
15071
|
+
{ },
|
|
15072
|
+
null,
|
|
15073
|
+
['PureCloud OAuth'],
|
|
15074
|
+
['application/json'],
|
|
15075
|
+
['application/json']
|
|
15076
|
+
);
|
|
15077
|
+
}
|
|
15078
|
+
|
|
14980
15079
|
/**
|
|
14981
15080
|
* Fetch a note for an external contact
|
|
14982
15081
|
*
|
|
@@ -16650,7 +16749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16650
16749
|
/**
|
|
16651
16750
|
* Fax service.
|
|
16652
16751
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16653
|
-
* @version
|
|
16752
|
+
* @version 152.0.0
|
|
16654
16753
|
*/
|
|
16655
16754
|
|
|
16656
16755
|
/**
|
|
@@ -16821,7 +16920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16821
16920
|
/**
|
|
16822
16921
|
* Flows service.
|
|
16823
16922
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16824
|
-
* @version
|
|
16923
|
+
* @version 152.0.0
|
|
16825
16924
|
*/
|
|
16826
16925
|
|
|
16827
16926
|
/**
|
|
@@ -16892,7 +16991,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16892
16991
|
/**
|
|
16893
16992
|
* Gamification service.
|
|
16894
16993
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16895
|
-
* @version
|
|
16994
|
+
* @version 152.0.0
|
|
16896
16995
|
*/
|
|
16897
16996
|
|
|
16898
16997
|
/**
|
|
@@ -17110,36 +17209,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17110
17209
|
);
|
|
17111
17210
|
}
|
|
17112
17211
|
|
|
17113
|
-
/**
|
|
17114
|
-
* Gamified metric by id
|
|
17115
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
17116
|
-
* @param {String} metricId metric Id
|
|
17117
|
-
* @param {Object} opts Optional parameters
|
|
17118
|
-
* @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
|
|
17119
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
17120
|
-
*/
|
|
17121
|
-
getGamificationMetric(metricId, opts) {
|
|
17122
|
-
opts = opts || {};
|
|
17123
|
-
|
|
17124
|
-
// verify the required parameter 'metricId' is set
|
|
17125
|
-
if (metricId === undefined || metricId === null) {
|
|
17126
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
17127
|
-
}
|
|
17128
|
-
|
|
17129
|
-
return this.apiClient.callApi(
|
|
17130
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
17131
|
-
'GET',
|
|
17132
|
-
{ 'metricId': metricId },
|
|
17133
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
17134
|
-
{ },
|
|
17135
|
-
{ },
|
|
17136
|
-
null,
|
|
17137
|
-
['PureCloud OAuth'],
|
|
17138
|
-
['application/json'],
|
|
17139
|
-
['application/json']
|
|
17140
|
-
);
|
|
17141
|
-
}
|
|
17142
|
-
|
|
17143
17212
|
/**
|
|
17144
17213
|
* Metric definition by id
|
|
17145
17214
|
*
|
|
@@ -18444,40 +18513,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18444
18513
|
);
|
|
18445
18514
|
}
|
|
18446
18515
|
|
|
18447
|
-
/**
|
|
18448
|
-
* Updates a metric
|
|
18449
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
18450
|
-
* @param {String} metricId metric Id
|
|
18451
|
-
* @param {Object} body Metric
|
|
18452
|
-
* @param {Object} opts Optional parameters
|
|
18453
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
18454
|
-
*/
|
|
18455
|
-
putGamificationMetric(metricId, body, opts) {
|
|
18456
|
-
opts = opts || {};
|
|
18457
|
-
|
|
18458
|
-
// verify the required parameter 'metricId' is set
|
|
18459
|
-
if (metricId === undefined || metricId === null) {
|
|
18460
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
18461
|
-
}
|
|
18462
|
-
// verify the required parameter 'body' is set
|
|
18463
|
-
if (body === undefined || body === null) {
|
|
18464
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
18465
|
-
}
|
|
18466
|
-
|
|
18467
|
-
return this.apiClient.callApi(
|
|
18468
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
18469
|
-
'PUT',
|
|
18470
|
-
{ 'metricId': metricId },
|
|
18471
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
18472
|
-
{ },
|
|
18473
|
-
{ },
|
|
18474
|
-
body,
|
|
18475
|
-
['PureCloud OAuth'],
|
|
18476
|
-
['application/json'],
|
|
18477
|
-
['application/json']
|
|
18478
|
-
);
|
|
18479
|
-
}
|
|
18480
|
-
|
|
18481
18516
|
/**
|
|
18482
18517
|
* Updates a performance profile
|
|
18483
18518
|
*
|
|
@@ -18573,7 +18608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18573
18608
|
/**
|
|
18574
18609
|
* GeneralDataProtectionRegulation service.
|
|
18575
18610
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18576
|
-
* @version
|
|
18611
|
+
* @version 152.0.0
|
|
18577
18612
|
*/
|
|
18578
18613
|
|
|
18579
18614
|
/**
|
|
@@ -18703,7 +18738,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18703
18738
|
/**
|
|
18704
18739
|
* Geolocation service.
|
|
18705
18740
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18706
|
-
* @version
|
|
18741
|
+
* @version 152.0.0
|
|
18707
18742
|
*/
|
|
18708
18743
|
|
|
18709
18744
|
/**
|
|
@@ -18834,7 +18869,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18834
18869
|
/**
|
|
18835
18870
|
* Greetings service.
|
|
18836
18871
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18837
|
-
* @version
|
|
18872
|
+
* @version 152.0.0
|
|
18838
18873
|
*/
|
|
18839
18874
|
|
|
18840
18875
|
/**
|
|
@@ -19289,7 +19324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19289
19324
|
/**
|
|
19290
19325
|
* Groups service.
|
|
19291
19326
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19292
|
-
* @version
|
|
19327
|
+
* @version 152.0.0
|
|
19293
19328
|
*/
|
|
19294
19329
|
|
|
19295
19330
|
/**
|
|
@@ -19695,7 +19730,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19695
19730
|
/**
|
|
19696
19731
|
* IdentityProvider service.
|
|
19697
19732
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19698
|
-
* @version
|
|
19733
|
+
* @version 152.0.0
|
|
19699
19734
|
*/
|
|
19700
19735
|
|
|
19701
19736
|
/**
|
|
@@ -20451,7 +20486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20451
20486
|
/**
|
|
20452
20487
|
* Integrations service.
|
|
20453
20488
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20454
|
-
* @version
|
|
20489
|
+
* @version 152.0.0
|
|
20455
20490
|
*/
|
|
20456
20491
|
|
|
20457
20492
|
/**
|
|
@@ -22051,7 +22086,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22051
22086
|
/**
|
|
22052
22087
|
* Journey service.
|
|
22053
22088
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22054
|
-
* @version
|
|
22089
|
+
* @version 152.0.0
|
|
22055
22090
|
*/
|
|
22056
22091
|
|
|
22057
22092
|
/**
|
|
@@ -22837,7 +22872,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22837
22872
|
/**
|
|
22838
22873
|
* Knowledge service.
|
|
22839
22874
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22840
|
-
* @version
|
|
22875
|
+
* @version 152.0.0
|
|
22841
22876
|
*/
|
|
22842
22877
|
|
|
22843
22878
|
/**
|
|
@@ -23240,8 +23275,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23240
23275
|
* @param {String} sessionId Knowledge guest session ID.
|
|
23241
23276
|
* @param {Object} opts Optional parameters
|
|
23242
23277
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23243
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23244
|
-
* @param {
|
|
23278
|
+
* @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.
|
|
23279
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
23245
23280
|
*/
|
|
23246
23281
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
23247
23282
|
opts = opts || {};
|
|
@@ -25270,7 +25305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25270
25305
|
/**
|
|
25271
25306
|
* LanguageUnderstanding service.
|
|
25272
25307
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25273
|
-
* @version
|
|
25308
|
+
* @version 152.0.0
|
|
25274
25309
|
*/
|
|
25275
25310
|
|
|
25276
25311
|
/**
|
|
@@ -26174,7 +26209,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26174
26209
|
/**
|
|
26175
26210
|
* Languages service.
|
|
26176
26211
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26177
|
-
* @version
|
|
26212
|
+
* @version 152.0.0
|
|
26178
26213
|
*/
|
|
26179
26214
|
|
|
26180
26215
|
/**
|
|
@@ -26442,7 +26477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26442
26477
|
/**
|
|
26443
26478
|
* Learning service.
|
|
26444
26479
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26445
|
-
* @version
|
|
26480
|
+
* @version 152.0.0
|
|
26446
26481
|
*/
|
|
26447
26482
|
|
|
26448
26483
|
/**
|
|
@@ -27202,7 +27237,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27202
27237
|
/**
|
|
27203
27238
|
* License service.
|
|
27204
27239
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27205
|
-
* @version
|
|
27240
|
+
* @version 152.0.0
|
|
27206
27241
|
*/
|
|
27207
27242
|
|
|
27208
27243
|
/**
|
|
@@ -27440,7 +27475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27440
27475
|
/**
|
|
27441
27476
|
* Locations service.
|
|
27442
27477
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27443
|
-
* @version
|
|
27478
|
+
* @version 152.0.0
|
|
27444
27479
|
*/
|
|
27445
27480
|
|
|
27446
27481
|
/**
|
|
@@ -27676,7 +27711,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27676
27711
|
/**
|
|
27677
27712
|
* Messaging service.
|
|
27678
27713
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27679
|
-
* @version
|
|
27714
|
+
* @version 152.0.0
|
|
27680
27715
|
*/
|
|
27681
27716
|
|
|
27682
27717
|
/**
|
|
@@ -27827,7 +27862,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27827
27862
|
/**
|
|
27828
27863
|
* MobileDevices service.
|
|
27829
27864
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27830
|
-
* @version
|
|
27865
|
+
* @version 152.0.0
|
|
27831
27866
|
*/
|
|
27832
27867
|
|
|
27833
27868
|
/**
|
|
@@ -27978,7 +28013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27978
28013
|
/**
|
|
27979
28014
|
* Notifications service.
|
|
27980
28015
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27981
|
-
* @version
|
|
28016
|
+
* @version 152.0.0
|
|
27982
28017
|
*/
|
|
27983
28018
|
|
|
27984
28019
|
/**
|
|
@@ -28203,7 +28238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28203
28238
|
/**
|
|
28204
28239
|
* OAuth service.
|
|
28205
28240
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28206
|
-
* @version
|
|
28241
|
+
* @version 152.0.0
|
|
28207
28242
|
*/
|
|
28208
28243
|
|
|
28209
28244
|
/**
|
|
@@ -28569,7 +28604,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28569
28604
|
/**
|
|
28570
28605
|
* Objects service.
|
|
28571
28606
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28572
|
-
* @version
|
|
28607
|
+
* @version 152.0.0
|
|
28573
28608
|
*/
|
|
28574
28609
|
|
|
28575
28610
|
/**
|
|
@@ -28840,7 +28875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28840
28875
|
/**
|
|
28841
28876
|
* Organization service.
|
|
28842
28877
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28843
|
-
* @version
|
|
28878
|
+
* @version 152.0.0
|
|
28844
28879
|
*/
|
|
28845
28880
|
|
|
28846
28881
|
/**
|
|
@@ -29243,7 +29278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29243
29278
|
/**
|
|
29244
29279
|
* OrganizationAuthorization service.
|
|
29245
29280
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29246
|
-
* @version
|
|
29281
|
+
* @version 152.0.0
|
|
29247
29282
|
*/
|
|
29248
29283
|
|
|
29249
29284
|
/**
|
|
@@ -30168,7 +30203,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30168
30203
|
/**
|
|
30169
30204
|
* Outbound service.
|
|
30170
30205
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30171
|
-
* @version
|
|
30206
|
+
* @version 152.0.0
|
|
30172
30207
|
*/
|
|
30173
30208
|
|
|
30174
30209
|
/**
|
|
@@ -33557,7 +33592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33557
33592
|
/**
|
|
33558
33593
|
* Presence service.
|
|
33559
33594
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33560
|
-
* @version
|
|
33595
|
+
* @version 152.0.0
|
|
33561
33596
|
*/
|
|
33562
33597
|
|
|
33563
33598
|
/**
|
|
@@ -33651,7 +33686,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33651
33686
|
* Get a list of Presence Sources
|
|
33652
33687
|
*
|
|
33653
33688
|
* @param {Object} opts Optional parameters
|
|
33654
|
-
* @param {String} opts.
|
|
33689
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
33655
33690
|
*/
|
|
33656
33691
|
getPresenceSources(opts) {
|
|
33657
33692
|
opts = opts || {};
|
|
@@ -33661,7 +33696,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33661
33696
|
'/api/v2/presence/sources',
|
|
33662
33697
|
'GET',
|
|
33663
33698
|
{ },
|
|
33664
|
-
{ '
|
|
33699
|
+
{ 'deactivated': opts['deactivated'] },
|
|
33665
33700
|
{ },
|
|
33666
33701
|
{ },
|
|
33667
33702
|
null,
|
|
@@ -34063,7 +34098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34063
34098
|
/**
|
|
34064
34099
|
* ProcessAutomation service.
|
|
34065
34100
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34066
|
-
* @version
|
|
34101
|
+
* @version 152.0.0
|
|
34067
34102
|
*/
|
|
34068
34103
|
|
|
34069
34104
|
/**
|
|
@@ -34104,7 +34139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34104
34139
|
}
|
|
34105
34140
|
|
|
34106
34141
|
/**
|
|
34107
|
-
* Retrieve a single Trigger matching id
|
|
34142
|
+
* Retrieve a single Trigger matching id
|
|
34108
34143
|
*
|
|
34109
34144
|
* @param {String} triggerId triggerId
|
|
34110
34145
|
*/
|
|
@@ -34129,13 +34164,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34129
34164
|
}
|
|
34130
34165
|
|
|
34131
34166
|
/**
|
|
34132
|
-
* Retrieves all triggers
|
|
34167
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
34133
34168
|
*
|
|
34134
34169
|
* @param {Object} opts Optional parameters
|
|
34135
34170
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
34136
34171
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
34137
34172
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
34138
|
-
* @param {String} opts.topicName Topic name
|
|
34173
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
34139
34174
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
34140
34175
|
*/
|
|
34141
34176
|
getProcessautomationTriggers(opts) {
|
|
@@ -34301,7 +34336,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34301
34336
|
/**
|
|
34302
34337
|
* Quality service.
|
|
34303
34338
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34304
|
-
* @version
|
|
34339
|
+
* @version 152.0.0
|
|
34305
34340
|
*/
|
|
34306
34341
|
|
|
34307
34342
|
/**
|
|
@@ -35879,7 +35914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35879
35914
|
/**
|
|
35880
35915
|
* Recording service.
|
|
35881
35916
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35882
|
-
* @version
|
|
35917
|
+
* @version 152.0.0
|
|
35883
35918
|
*/
|
|
35884
35919
|
|
|
35885
35920
|
/**
|
|
@@ -37566,7 +37601,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37566
37601
|
/**
|
|
37567
37602
|
* ResponseManagement service.
|
|
37568
37603
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37569
|
-
* @version
|
|
37604
|
+
* @version 152.0.0
|
|
37570
37605
|
*/
|
|
37571
37606
|
|
|
37572
37607
|
/**
|
|
@@ -38050,7 +38085,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38050
38085
|
/**
|
|
38051
38086
|
* Routing service.
|
|
38052
38087
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38053
|
-
* @version
|
|
38088
|
+
* @version 152.0.0
|
|
38054
38089
|
*/
|
|
38055
38090
|
|
|
38056
38091
|
/**
|
|
@@ -38359,6 +38394,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38359
38394
|
);
|
|
38360
38395
|
}
|
|
38361
38396
|
|
|
38397
|
+
/**
|
|
38398
|
+
* Remove skill group definition
|
|
38399
|
+
*
|
|
38400
|
+
* @param {String} skillGroupId Skill Group ID
|
|
38401
|
+
*/
|
|
38402
|
+
deleteRoutingSkillgroup(skillGroupId) {
|
|
38403
|
+
// verify the required parameter 'skillGroupId' is set
|
|
38404
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
38405
|
+
throw 'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';
|
|
38406
|
+
}
|
|
38407
|
+
|
|
38408
|
+
return this.apiClient.callApi(
|
|
38409
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
38410
|
+
'DELETE',
|
|
38411
|
+
{ 'skillGroupId': skillGroupId },
|
|
38412
|
+
{ },
|
|
38413
|
+
{ },
|
|
38414
|
+
{ },
|
|
38415
|
+
null,
|
|
38416
|
+
['PureCloud OAuth'],
|
|
38417
|
+
['application/json'],
|
|
38418
|
+
['application/json']
|
|
38419
|
+
);
|
|
38420
|
+
}
|
|
38421
|
+
|
|
38362
38422
|
/**
|
|
38363
38423
|
* Delete an Address by Id for SMS
|
|
38364
38424
|
*
|
|
@@ -39544,6 +39604,119 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39544
39604
|
);
|
|
39545
39605
|
}
|
|
39546
39606
|
|
|
39607
|
+
/**
|
|
39608
|
+
* Get skill group
|
|
39609
|
+
*
|
|
39610
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39611
|
+
*/
|
|
39612
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
39613
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39614
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39615
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
39616
|
+
}
|
|
39617
|
+
|
|
39618
|
+
return this.apiClient.callApi(
|
|
39619
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
39620
|
+
'GET',
|
|
39621
|
+
{ 'skillGroupId': skillGroupId },
|
|
39622
|
+
{ },
|
|
39623
|
+
{ },
|
|
39624
|
+
{ },
|
|
39625
|
+
null,
|
|
39626
|
+
['PureCloud OAuth'],
|
|
39627
|
+
['application/json'],
|
|
39628
|
+
['application/json']
|
|
39629
|
+
);
|
|
39630
|
+
}
|
|
39631
|
+
|
|
39632
|
+
/**
|
|
39633
|
+
* Get skill group members
|
|
39634
|
+
*
|
|
39635
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39636
|
+
* @param {Object} opts Optional parameters
|
|
39637
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39638
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
39639
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
39640
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
39641
|
+
*/
|
|
39642
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
39643
|
+
opts = opts || {};
|
|
39644
|
+
|
|
39645
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39646
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39647
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
39648
|
+
}
|
|
39649
|
+
|
|
39650
|
+
return this.apiClient.callApi(
|
|
39651
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
39652
|
+
'GET',
|
|
39653
|
+
{ 'skillGroupId': skillGroupId },
|
|
39654
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
39655
|
+
{ },
|
|
39656
|
+
{ },
|
|
39657
|
+
null,
|
|
39658
|
+
['PureCloud OAuth'],
|
|
39659
|
+
['application/json'],
|
|
39660
|
+
['application/json']
|
|
39661
|
+
);
|
|
39662
|
+
}
|
|
39663
|
+
|
|
39664
|
+
/**
|
|
39665
|
+
* Get list of member divisions for this skill group.
|
|
39666
|
+
*
|
|
39667
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39668
|
+
* @param {Object} opts Optional parameters
|
|
39669
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
39670
|
+
*/
|
|
39671
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
39672
|
+
opts = opts || {};
|
|
39673
|
+
|
|
39674
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39675
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39676
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
39677
|
+
}
|
|
39678
|
+
|
|
39679
|
+
return this.apiClient.callApi(
|
|
39680
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
39681
|
+
'GET',
|
|
39682
|
+
{ 'skillGroupId': skillGroupId },
|
|
39683
|
+
{ 'expand': opts['expand'] },
|
|
39684
|
+
{ },
|
|
39685
|
+
{ },
|
|
39686
|
+
null,
|
|
39687
|
+
['PureCloud OAuth'],
|
|
39688
|
+
['application/json'],
|
|
39689
|
+
['application/json']
|
|
39690
|
+
);
|
|
39691
|
+
}
|
|
39692
|
+
|
|
39693
|
+
/**
|
|
39694
|
+
* Get skill group listing
|
|
39695
|
+
*
|
|
39696
|
+
* @param {Object} opts Optional parameters
|
|
39697
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39698
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
39699
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
39700
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
39701
|
+
*/
|
|
39702
|
+
getRoutingSkillgroups(opts) {
|
|
39703
|
+
opts = opts || {};
|
|
39704
|
+
|
|
39705
|
+
|
|
39706
|
+
return this.apiClient.callApi(
|
|
39707
|
+
'/api/v2/routing/skillgroups',
|
|
39708
|
+
'GET',
|
|
39709
|
+
{ },
|
|
39710
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
39711
|
+
{ },
|
|
39712
|
+
{ },
|
|
39713
|
+
null,
|
|
39714
|
+
['PureCloud OAuth'],
|
|
39715
|
+
['application/json'],
|
|
39716
|
+
['application/json']
|
|
39717
|
+
);
|
|
39718
|
+
}
|
|
39719
|
+
|
|
39547
39720
|
/**
|
|
39548
39721
|
* Get the list of routing skills.
|
|
39549
39722
|
*
|
|
@@ -40182,6 +40355,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40182
40355
|
);
|
|
40183
40356
|
}
|
|
40184
40357
|
|
|
40358
|
+
/**
|
|
40359
|
+
* Update skill group definition
|
|
40360
|
+
*
|
|
40361
|
+
* @param {String} skillGroupId Skill Group ID
|
|
40362
|
+
* @param {Object} body Update skill groups
|
|
40363
|
+
*/
|
|
40364
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
40365
|
+
// verify the required parameter 'skillGroupId' is set
|
|
40366
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
40367
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
40368
|
+
}
|
|
40369
|
+
// verify the required parameter 'body' is set
|
|
40370
|
+
if (body === undefined || body === null) {
|
|
40371
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
40372
|
+
}
|
|
40373
|
+
|
|
40374
|
+
return this.apiClient.callApi(
|
|
40375
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
40376
|
+
'PATCH',
|
|
40377
|
+
{ 'skillGroupId': skillGroupId },
|
|
40378
|
+
{ },
|
|
40379
|
+
{ },
|
|
40380
|
+
{ },
|
|
40381
|
+
body,
|
|
40382
|
+
['PureCloud OAuth'],
|
|
40383
|
+
['application/json'],
|
|
40384
|
+
['application/json']
|
|
40385
|
+
);
|
|
40386
|
+
}
|
|
40387
|
+
|
|
40185
40388
|
/**
|
|
40186
40389
|
* Join or unjoin a queue for a user
|
|
40187
40390
|
*
|
|
@@ -40725,6 +40928,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40725
40928
|
);
|
|
40726
40929
|
}
|
|
40727
40930
|
|
|
40931
|
+
/**
|
|
40932
|
+
* Add or remove member divisions for this skill group.
|
|
40933
|
+
*
|
|
40934
|
+
* @param {String} skillGroupId Skill Group ID
|
|
40935
|
+
* @param {Object} opts Optional parameters
|
|
40936
|
+
* @param {Object} opts.body
|
|
40937
|
+
*/
|
|
40938
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
40939
|
+
opts = opts || {};
|
|
40940
|
+
|
|
40941
|
+
// verify the required parameter 'skillGroupId' is set
|
|
40942
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
40943
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
40944
|
+
}
|
|
40945
|
+
|
|
40946
|
+
return this.apiClient.callApi(
|
|
40947
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
40948
|
+
'POST',
|
|
40949
|
+
{ 'skillGroupId': skillGroupId },
|
|
40950
|
+
{ },
|
|
40951
|
+
{ },
|
|
40952
|
+
{ },
|
|
40953
|
+
opts['body'],
|
|
40954
|
+
['PureCloud OAuth'],
|
|
40955
|
+
['application/json'],
|
|
40956
|
+
['application/json']
|
|
40957
|
+
);
|
|
40958
|
+
}
|
|
40959
|
+
|
|
40960
|
+
/**
|
|
40961
|
+
* Create a skill group
|
|
40962
|
+
*
|
|
40963
|
+
* @param {Object} body Create skill group
|
|
40964
|
+
*/
|
|
40965
|
+
postRoutingSkillgroups(body) {
|
|
40966
|
+
// verify the required parameter 'body' is set
|
|
40967
|
+
if (body === undefined || body === null) {
|
|
40968
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
40969
|
+
}
|
|
40970
|
+
|
|
40971
|
+
return this.apiClient.callApi(
|
|
40972
|
+
'/api/v2/routing/skillgroups',
|
|
40973
|
+
'POST',
|
|
40974
|
+
{ },
|
|
40975
|
+
{ },
|
|
40976
|
+
{ },
|
|
40977
|
+
{ },
|
|
40978
|
+
body,
|
|
40979
|
+
['PureCloud OAuth'],
|
|
40980
|
+
['application/json'],
|
|
40981
|
+
['application/json']
|
|
40982
|
+
);
|
|
40983
|
+
}
|
|
40984
|
+
|
|
40728
40985
|
/**
|
|
40729
40986
|
* Create Skill
|
|
40730
40987
|
*
|
|
@@ -41241,7 +41498,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41241
41498
|
/**
|
|
41242
41499
|
* SCIM service.
|
|
41243
41500
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41244
|
-
* @version
|
|
41501
|
+
* @version 152.0.0
|
|
41245
41502
|
*/
|
|
41246
41503
|
|
|
41247
41504
|
/**
|
|
@@ -42118,7 +42375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42118
42375
|
/**
|
|
42119
42376
|
* Scripts service.
|
|
42120
42377
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42121
|
-
* @version
|
|
42378
|
+
* @version 152.0.0
|
|
42122
42379
|
*/
|
|
42123
42380
|
|
|
42124
42381
|
/**
|
|
@@ -42537,7 +42794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42537
42794
|
/**
|
|
42538
42795
|
* Search service.
|
|
42539
42796
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42540
|
-
* @version
|
|
42797
|
+
* @version 152.0.0
|
|
42541
42798
|
*/
|
|
42542
42799
|
|
|
42543
42800
|
/**
|
|
@@ -43066,6 +43323,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43066
43323
|
);
|
|
43067
43324
|
}
|
|
43068
43325
|
|
|
43326
|
+
/**
|
|
43327
|
+
* Search users assigned to teams
|
|
43328
|
+
*
|
|
43329
|
+
* @param {Object} body Search request options
|
|
43330
|
+
*/
|
|
43331
|
+
postUsersSearchTeamsAssign(body) {
|
|
43332
|
+
// verify the required parameter 'body' is set
|
|
43333
|
+
if (body === undefined || body === null) {
|
|
43334
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
43335
|
+
}
|
|
43336
|
+
|
|
43337
|
+
return this.apiClient.callApi(
|
|
43338
|
+
'/api/v2/users/search/teams/assign',
|
|
43339
|
+
'POST',
|
|
43340
|
+
{ },
|
|
43341
|
+
{ },
|
|
43342
|
+
{ },
|
|
43343
|
+
{ },
|
|
43344
|
+
body,
|
|
43345
|
+
['PureCloud OAuth'],
|
|
43346
|
+
['application/json'],
|
|
43347
|
+
['application/json']
|
|
43348
|
+
);
|
|
43349
|
+
}
|
|
43350
|
+
|
|
43069
43351
|
/**
|
|
43070
43352
|
* Search voicemails
|
|
43071
43353
|
*
|
|
@@ -43097,7 +43379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43097
43379
|
/**
|
|
43098
43380
|
* SpeechTextAnalytics service.
|
|
43099
43381
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43100
|
-
* @version
|
|
43382
|
+
* @version 152.0.0
|
|
43101
43383
|
*/
|
|
43102
43384
|
|
|
43103
43385
|
/**
|
|
@@ -43951,7 +44233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43951
44233
|
/**
|
|
43952
44234
|
* Stations service.
|
|
43953
44235
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
43954
|
-
* @version
|
|
44236
|
+
* @version 152.0.0
|
|
43955
44237
|
*/
|
|
43956
44238
|
|
|
43957
44239
|
/**
|
|
@@ -44098,7 +44380,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44098
44380
|
/**
|
|
44099
44381
|
* Suggest service.
|
|
44100
44382
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44101
|
-
* @version
|
|
44383
|
+
* @version 152.0.0
|
|
44102
44384
|
*/
|
|
44103
44385
|
|
|
44104
44386
|
/**
|
|
@@ -44237,7 +44519,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44237
44519
|
/**
|
|
44238
44520
|
* Teams service.
|
|
44239
44521
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44240
|
-
* @version
|
|
44522
|
+
* @version 152.0.0
|
|
44241
44523
|
*/
|
|
44242
44524
|
|
|
44243
44525
|
/**
|
|
@@ -44277,6 +44559,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44277
44559
|
);
|
|
44278
44560
|
}
|
|
44279
44561
|
|
|
44562
|
+
/**
|
|
44563
|
+
* Delete team members
|
|
44564
|
+
*
|
|
44565
|
+
* @param {String} teamId Team ID
|
|
44566
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
44567
|
+
*/
|
|
44568
|
+
deleteTeamMembers(teamId, id) {
|
|
44569
|
+
// verify the required parameter 'teamId' is set
|
|
44570
|
+
if (teamId === undefined || teamId === null) {
|
|
44571
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
44572
|
+
}
|
|
44573
|
+
// verify the required parameter 'id' is set
|
|
44574
|
+
if (id === undefined || id === null) {
|
|
44575
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
44576
|
+
}
|
|
44577
|
+
|
|
44578
|
+
return this.apiClient.callApi(
|
|
44579
|
+
'/api/v2/teams/{teamId}/members',
|
|
44580
|
+
'DELETE',
|
|
44581
|
+
{ 'teamId': teamId },
|
|
44582
|
+
{ 'id': id },
|
|
44583
|
+
{ },
|
|
44584
|
+
{ },
|
|
44585
|
+
null,
|
|
44586
|
+
['PureCloud OAuth'],
|
|
44587
|
+
['application/json'],
|
|
44588
|
+
['application/json']
|
|
44589
|
+
);
|
|
44590
|
+
}
|
|
44591
|
+
|
|
44280
44592
|
/**
|
|
44281
44593
|
* Get team
|
|
44282
44594
|
*
|
|
@@ -44302,6 +44614,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44302
44614
|
);
|
|
44303
44615
|
}
|
|
44304
44616
|
|
|
44617
|
+
/**
|
|
44618
|
+
* Get team membership
|
|
44619
|
+
*
|
|
44620
|
+
* @param {String} teamId Team ID
|
|
44621
|
+
* @param {Object} opts Optional parameters
|
|
44622
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44623
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
44624
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
44625
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
44626
|
+
*/
|
|
44627
|
+
getTeamMembers(teamId, opts) {
|
|
44628
|
+
opts = opts || {};
|
|
44629
|
+
|
|
44630
|
+
// verify the required parameter 'teamId' is set
|
|
44631
|
+
if (teamId === undefined || teamId === null) {
|
|
44632
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
44633
|
+
}
|
|
44634
|
+
|
|
44635
|
+
return this.apiClient.callApi(
|
|
44636
|
+
'/api/v2/teams/{teamId}/members',
|
|
44637
|
+
'GET',
|
|
44638
|
+
{ 'teamId': teamId },
|
|
44639
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
44640
|
+
{ },
|
|
44641
|
+
{ },
|
|
44642
|
+
null,
|
|
44643
|
+
['PureCloud OAuth'],
|
|
44644
|
+
['application/json'],
|
|
44645
|
+
['application/json']
|
|
44646
|
+
);
|
|
44647
|
+
}
|
|
44648
|
+
|
|
44305
44649
|
/**
|
|
44306
44650
|
* Get Team listing
|
|
44307
44651
|
*
|
|
@@ -44360,6 +44704,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44360
44704
|
);
|
|
44361
44705
|
}
|
|
44362
44706
|
|
|
44707
|
+
/**
|
|
44708
|
+
* Add team members
|
|
44709
|
+
*
|
|
44710
|
+
* @param {String} teamId Team ID
|
|
44711
|
+
* @param {Object} body TeamMembers
|
|
44712
|
+
*/
|
|
44713
|
+
postTeamMembers(teamId, body) {
|
|
44714
|
+
// verify the required parameter 'teamId' is set
|
|
44715
|
+
if (teamId === undefined || teamId === null) {
|
|
44716
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
44717
|
+
}
|
|
44718
|
+
// verify the required parameter 'body' is set
|
|
44719
|
+
if (body === undefined || body === null) {
|
|
44720
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
44721
|
+
}
|
|
44722
|
+
|
|
44723
|
+
return this.apiClient.callApi(
|
|
44724
|
+
'/api/v2/teams/{teamId}/members',
|
|
44725
|
+
'POST',
|
|
44726
|
+
{ 'teamId': teamId },
|
|
44727
|
+
{ },
|
|
44728
|
+
{ },
|
|
44729
|
+
{ },
|
|
44730
|
+
body,
|
|
44731
|
+
['PureCloud OAuth'],
|
|
44732
|
+
['application/json'],
|
|
44733
|
+
['application/json']
|
|
44734
|
+
);
|
|
44735
|
+
}
|
|
44736
|
+
|
|
44363
44737
|
/**
|
|
44364
44738
|
* Create a team
|
|
44365
44739
|
*
|
|
@@ -44416,7 +44790,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44416
44790
|
/**
|
|
44417
44791
|
* Telephony service.
|
|
44418
44792
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44419
|
-
* @version
|
|
44793
|
+
* @version 152.0.0
|
|
44420
44794
|
*/
|
|
44421
44795
|
|
|
44422
44796
|
/**
|
|
@@ -44524,7 +44898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44524
44898
|
/**
|
|
44525
44899
|
* TelephonyProvidersEdge service.
|
|
44526
44900
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44527
|
-
* @version
|
|
44901
|
+
* @version 152.0.0
|
|
44528
44902
|
*/
|
|
44529
44903
|
|
|
44530
44904
|
/**
|
|
@@ -48157,7 +48531,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48157
48531
|
/**
|
|
48158
48532
|
* Textbots service.
|
|
48159
48533
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48160
|
-
* @version
|
|
48534
|
+
* @version 152.0.0
|
|
48161
48535
|
*/
|
|
48162
48536
|
|
|
48163
48537
|
/**
|
|
@@ -48285,7 +48659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48285
48659
|
/**
|
|
48286
48660
|
* Tokens service.
|
|
48287
48661
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48288
|
-
* @version
|
|
48662
|
+
* @version 152.0.0
|
|
48289
48663
|
*/
|
|
48290
48664
|
|
|
48291
48665
|
/**
|
|
@@ -48391,7 +48765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48391
48765
|
/**
|
|
48392
48766
|
* Uploads service.
|
|
48393
48767
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48394
|
-
* @version
|
|
48768
|
+
* @version 152.0.0
|
|
48395
48769
|
*/
|
|
48396
48770
|
|
|
48397
48771
|
/**
|
|
@@ -48567,7 +48941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48567
48941
|
/**
|
|
48568
48942
|
* Usage service.
|
|
48569
48943
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48570
|
-
* @version
|
|
48944
|
+
* @version 152.0.0
|
|
48571
48945
|
*/
|
|
48572
48946
|
|
|
48573
48947
|
/**
|
|
@@ -48638,7 +49012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48638
49012
|
/**
|
|
48639
49013
|
* UserRecordings service.
|
|
48640
49014
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
48641
|
-
* @version
|
|
49015
|
+
* @version 152.0.0
|
|
48642
49016
|
*/
|
|
48643
49017
|
|
|
48644
49018
|
/**
|
|
@@ -48823,7 +49197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48823
49197
|
/**
|
|
48824
49198
|
* Users service.
|
|
48825
49199
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
48826
|
-
* @version
|
|
49200
|
+
* @version 152.0.0
|
|
48827
49201
|
*/
|
|
48828
49202
|
|
|
48829
49203
|
/**
|
|
@@ -50814,6 +51188,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50814
51188
|
);
|
|
50815
51189
|
}
|
|
50816
51190
|
|
|
51191
|
+
/**
|
|
51192
|
+
* Search users assigned to teams
|
|
51193
|
+
*
|
|
51194
|
+
* @param {Object} body Search request options
|
|
51195
|
+
*/
|
|
51196
|
+
postUsersSearchTeamsAssign(body) {
|
|
51197
|
+
// verify the required parameter 'body' is set
|
|
51198
|
+
if (body === undefined || body === null) {
|
|
51199
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
51200
|
+
}
|
|
51201
|
+
|
|
51202
|
+
return this.apiClient.callApi(
|
|
51203
|
+
'/api/v2/users/search/teams/assign',
|
|
51204
|
+
'POST',
|
|
51205
|
+
{ },
|
|
51206
|
+
{ },
|
|
51207
|
+
{ },
|
|
51208
|
+
{ },
|
|
51209
|
+
body,
|
|
51210
|
+
['PureCloud OAuth'],
|
|
51211
|
+
['application/json'],
|
|
51212
|
+
['application/json']
|
|
51213
|
+
);
|
|
51214
|
+
}
|
|
51215
|
+
|
|
50817
51216
|
/**
|
|
50818
51217
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
50819
51218
|
*
|
|
@@ -51155,7 +51554,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51155
51554
|
/**
|
|
51156
51555
|
* Utilities service.
|
|
51157
51556
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51158
|
-
* @version
|
|
51557
|
+
* @version 152.0.0
|
|
51159
51558
|
*/
|
|
51160
51559
|
|
|
51161
51560
|
/**
|
|
@@ -51266,7 +51665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51266
51665
|
/**
|
|
51267
51666
|
* Voicemail service.
|
|
51268
51667
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51269
|
-
* @version
|
|
51668
|
+
* @version 152.0.0
|
|
51270
51669
|
*/
|
|
51271
51670
|
|
|
51272
51671
|
/**
|
|
@@ -51933,7 +52332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51933
52332
|
/**
|
|
51934
52333
|
* WebChat service.
|
|
51935
52334
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
51936
|
-
* @version
|
|
52335
|
+
* @version 152.0.0
|
|
51937
52336
|
*/
|
|
51938
52337
|
|
|
51939
52338
|
/**
|
|
@@ -52477,7 +52876,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52477
52876
|
/**
|
|
52478
52877
|
* WebDeployments service.
|
|
52479
52878
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52480
|
-
* @version
|
|
52879
|
+
* @version 152.0.0
|
|
52481
52880
|
*/
|
|
52482
52881
|
|
|
52483
52882
|
/**
|
|
@@ -52865,7 +53264,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52865
53264
|
/**
|
|
52866
53265
|
* WebMessaging service.
|
|
52867
53266
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
52868
|
-
* @version
|
|
53267
|
+
* @version 152.0.0
|
|
52869
53268
|
*/
|
|
52870
53269
|
|
|
52871
53270
|
/**
|
|
@@ -52911,7 +53310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52911
53310
|
/**
|
|
52912
53311
|
* Widgets service.
|
|
52913
53312
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
52914
|
-
* @version
|
|
53313
|
+
* @version 152.0.0
|
|
52915
53314
|
*/
|
|
52916
53315
|
|
|
52917
53316
|
/**
|
|
@@ -53057,7 +53456,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53057
53456
|
/**
|
|
53058
53457
|
* WorkforceManagement service.
|
|
53059
53458
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53060
|
-
* @version
|
|
53459
|
+
* @version 152.0.0
|
|
53061
53460
|
*/
|
|
53062
53461
|
|
|
53063
53462
|
/**
|
|
@@ -56837,6 +57236,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56837
57236
|
);
|
|
56838
57237
|
}
|
|
56839
57238
|
|
|
57239
|
+
/**
|
|
57240
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
57241
|
+
*
|
|
57242
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57243
|
+
* @param {String} userId The ID of the user
|
|
57244
|
+
* @param {Object} body The request body
|
|
57245
|
+
*/
|
|
57246
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
57247
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57248
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57249
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57250
|
+
}
|
|
57251
|
+
// verify the required parameter 'userId' is set
|
|
57252
|
+
if (userId === undefined || userId === null) {
|
|
57253
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57254
|
+
}
|
|
57255
|
+
// verify the required parameter 'body' is set
|
|
57256
|
+
if (body === undefined || body === null) {
|
|
57257
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
57258
|
+
}
|
|
57259
|
+
|
|
57260
|
+
return this.apiClient.callApi(
|
|
57261
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
57262
|
+
'POST',
|
|
57263
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
57264
|
+
{ },
|
|
57265
|
+
{ },
|
|
57266
|
+
{ },
|
|
57267
|
+
body,
|
|
57268
|
+
['PureCloud OAuth'],
|
|
57269
|
+
['application/json'],
|
|
57270
|
+
['application/json']
|
|
57271
|
+
);
|
|
57272
|
+
}
|
|
57273
|
+
|
|
57274
|
+
/**
|
|
57275
|
+
* Query time off balances for dates spanned by a given time off request
|
|
57276
|
+
*
|
|
57277
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
57278
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
57279
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
57280
|
+
*/
|
|
57281
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
57282
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57283
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57284
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57285
|
+
}
|
|
57286
|
+
// verify the required parameter 'userId' is set
|
|
57287
|
+
if (userId === undefined || userId === null) {
|
|
57288
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57289
|
+
}
|
|
57290
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
57291
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
57292
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
57293
|
+
}
|
|
57294
|
+
|
|
57295
|
+
return this.apiClient.callApi(
|
|
57296
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
57297
|
+
'POST',
|
|
57298
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
57299
|
+
{ },
|
|
57300
|
+
{ },
|
|
57301
|
+
{ },
|
|
57302
|
+
null,
|
|
57303
|
+
['PureCloud OAuth'],
|
|
57304
|
+
['application/json'],
|
|
57305
|
+
['application/json']
|
|
57306
|
+
);
|
|
57307
|
+
}
|
|
57308
|
+
|
|
56840
57309
|
/**
|
|
56841
57310
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
56842
57311
|
*
|
|
@@ -57333,7 +57802,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57333
57802
|
* </pre>
|
|
57334
57803
|
* </p>
|
|
57335
57804
|
* @module purecloud-platform-client-v2/index
|
|
57336
|
-
* @version
|
|
57805
|
+
* @version 152.0.0
|
|
57337
57806
|
*/
|
|
57338
57807
|
class platformClient {
|
|
57339
57808
|
constructor() {
|