purecloud-platform-client-v2 185.0.0 → 187.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 +1019 -245
- package/dist/web-amd/purecloud-platform-client-v2.js +1019 -245
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +357 -172
- package/dist/web-cjs/purecloud-platform-client-v2.js +362 -174
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +674 -222
- package/package.json +2 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +25 -7
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +61 -22
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -62
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +38 -3
- 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/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +7 -7
- 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 -1
- 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 +106 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +161 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -34
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +63 -1
- 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/LogCaptureApi.js +131 -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 +2 -3
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.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 +186 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -6
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- 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 +80 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +50 -0
- 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/SettingsApi.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/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -3
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -29
- 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 +32 -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 +7 -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 187.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1818,7 +1818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1818
1818
|
/**
|
|
1819
1819
|
* Alerting service.
|
|
1820
1820
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1821
|
-
* @version
|
|
1821
|
+
* @version 187.0.0
|
|
1822
1822
|
*/
|
|
1823
1823
|
|
|
1824
1824
|
/**
|
|
@@ -2479,7 +2479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2479
2479
|
/**
|
|
2480
2480
|
* Analytics service.
|
|
2481
2481
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2482
|
-
* @version
|
|
2482
|
+
* @version 187.0.0
|
|
2483
2483
|
*/
|
|
2484
2484
|
|
|
2485
2485
|
/**
|
|
@@ -5069,7 +5069,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5069
5069
|
/**
|
|
5070
5070
|
* Architect service.
|
|
5071
5071
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5072
|
-
* @version
|
|
5072
|
+
* @version 187.0.0
|
|
5073
5073
|
*/
|
|
5074
5074
|
|
|
5075
5075
|
/**
|
|
@@ -6125,8 +6125,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6125
6125
|
* Get specified user prompt
|
|
6126
6126
|
*
|
|
6127
6127
|
* @param {String} promptId Prompt ID
|
|
6128
|
+
* @param {Object} opts Optional parameters
|
|
6129
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
6130
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
6131
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
6128
6132
|
*/
|
|
6129
|
-
getArchitectPrompt(promptId) {
|
|
6133
|
+
getArchitectPrompt(promptId, opts) {
|
|
6134
|
+
opts = opts || {};
|
|
6135
|
+
|
|
6130
6136
|
// verify the required parameter 'promptId' is set
|
|
6131
6137
|
if (promptId === undefined || promptId === null) {
|
|
6132
6138
|
throw 'Missing the required parameter "promptId" when calling getArchitectPrompt';
|
|
@@ -6136,7 +6142,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6136
6142
|
'/api/v2/architect/prompts/{promptId}',
|
|
6137
6143
|
'GET',
|
|
6138
6144
|
{ 'promptId': promptId },
|
|
6139
|
-
{
|
|
6145
|
+
{ 'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
6140
6146
|
{ },
|
|
6141
6147
|
{ },
|
|
6142
6148
|
null,
|
|
@@ -6255,6 +6261,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6255
6261
|
* @param {String} opts.nameOrDescription Name or description
|
|
6256
6262
|
* @param {String} opts.sortBy Sort by (default to id)
|
|
6257
6263
|
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
6264
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
6265
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
6266
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
6258
6267
|
*/
|
|
6259
6268
|
getArchitectPrompts(opts) {
|
|
6260
6269
|
opts = opts || {};
|
|
@@ -6264,7 +6273,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6264
6273
|
'/api/v2/architect/prompts',
|
|
6265
6274
|
'GET',
|
|
6266
6275
|
{ },
|
|
6267
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': this.apiClient.buildCollectionParam(opts['name'], 'multi'),'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
6276
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': this.apiClient.buildCollectionParam(opts['name'], 'multi'),'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
6268
6277
|
{ },
|
|
6269
6278
|
{ },
|
|
6270
6279
|
null,
|
|
@@ -6447,8 +6456,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6447
6456
|
* Get a system prompt
|
|
6448
6457
|
*
|
|
6449
6458
|
* @param {String} promptId promptId
|
|
6459
|
+
* @param {Object} opts Optional parameters
|
|
6460
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
6461
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
6462
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
6450
6463
|
*/
|
|
6451
|
-
getArchitectSystemprompt(promptId) {
|
|
6464
|
+
getArchitectSystemprompt(promptId, opts) {
|
|
6465
|
+
opts = opts || {};
|
|
6466
|
+
|
|
6452
6467
|
// verify the required parameter 'promptId' is set
|
|
6453
6468
|
if (promptId === undefined || promptId === null) {
|
|
6454
6469
|
throw 'Missing the required parameter "promptId" when calling getArchitectSystemprompt';
|
|
@@ -6458,7 +6473,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6458
6473
|
'/api/v2/architect/systemprompts/{promptId}',
|
|
6459
6474
|
'GET',
|
|
6460
6475
|
{ 'promptId': promptId },
|
|
6461
|
-
{
|
|
6476
|
+
{ 'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
6462
6477
|
{ },
|
|
6463
6478
|
{ },
|
|
6464
6479
|
null,
|
|
@@ -6579,6 +6594,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6579
6594
|
* @param {String} opts.name Name
|
|
6580
6595
|
* @param {String} opts.description Description
|
|
6581
6596
|
* @param {String} opts.nameOrDescription Name or description
|
|
6597
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
6598
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
6599
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
6582
6600
|
*/
|
|
6583
6601
|
getArchitectSystemprompts(opts) {
|
|
6584
6602
|
opts = opts || {};
|
|
@@ -6588,7 +6606,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6588
6606
|
'/api/v2/architect/systemprompts',
|
|
6589
6607
|
'GET',
|
|
6590
6608
|
{ },
|
|
6591
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'] },
|
|
6609
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
6592
6610
|
{ },
|
|
6593
6611
|
{ },
|
|
6594
6612
|
null,
|
|
@@ -8904,7 +8922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8904
8922
|
/**
|
|
8905
8923
|
* Audit service.
|
|
8906
8924
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8907
|
-
* @version
|
|
8925
|
+
* @version 187.0.0
|
|
8908
8926
|
*/
|
|
8909
8927
|
|
|
8910
8928
|
/**
|
|
@@ -9075,7 +9093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9075
9093
|
/**
|
|
9076
9094
|
* Authorization service.
|
|
9077
9095
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9078
|
-
* @version
|
|
9096
|
+
* @version 187.0.0
|
|
9079
9097
|
*/
|
|
9080
9098
|
|
|
9081
9099
|
/**
|
|
@@ -9249,7 +9267,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9249
9267
|
* @param {String} opts.nextPage next page token
|
|
9250
9268
|
* @param {String} opts.previousPage Previous page token
|
|
9251
9269
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
9252
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
9253
9270
|
* @param {String} opts.name Search term to filter by division name
|
|
9254
9271
|
*/
|
|
9255
9272
|
getAuthorizationDivisions(opts) {
|
|
@@ -9260,7 +9277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9260
9277
|
'/api/v2/authorization/divisions',
|
|
9261
9278
|
'GET',
|
|
9262
9279
|
{ },
|
|
9263
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'
|
|
9280
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
9264
9281
|
{ },
|
|
9265
9282
|
{ },
|
|
9266
9283
|
null,
|
|
@@ -10305,7 +10322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10305
10322
|
/**
|
|
10306
10323
|
* Billing service.
|
|
10307
10324
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10308
|
-
* @version
|
|
10325
|
+
* @version 187.0.0
|
|
10309
10326
|
*/
|
|
10310
10327
|
|
|
10311
10328
|
/**
|
|
@@ -10385,7 +10402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10385
10402
|
/**
|
|
10386
10403
|
* CarrierServices service.
|
|
10387
10404
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10388
|
-
* @version
|
|
10405
|
+
* @version 187.0.0
|
|
10389
10406
|
*/
|
|
10390
10407
|
|
|
10391
10408
|
/**
|
|
@@ -10455,7 +10472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10455
10472
|
/**
|
|
10456
10473
|
* Chat service.
|
|
10457
10474
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10458
|
-
* @version
|
|
10475
|
+
* @version 187.0.0
|
|
10459
10476
|
*/
|
|
10460
10477
|
|
|
10461
10478
|
/**
|
|
@@ -10682,12 +10699,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10682
10699
|
*
|
|
10683
10700
|
* @param {String} roomJid roomJid
|
|
10684
10701
|
* @param {Object} opts Optional parameters
|
|
10685
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10686
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10687
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
10688
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10689
|
-
* @param {String} opts.nextPage next page token
|
|
10690
|
-
* @param {String} opts.previousPage Previous page token
|
|
10691
10702
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10692
10703
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10693
10704
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -10705,7 +10716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10705
10716
|
'/api/v2/chats/rooms/{roomJid}/messages',
|
|
10706
10717
|
'GET',
|
|
10707
10718
|
{ 'roomJid': roomJid },
|
|
10708
|
-
{ '
|
|
10719
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10709
10720
|
{ },
|
|
10710
10721
|
{ },
|
|
10711
10722
|
null,
|
|
@@ -10740,12 +10751,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10740
10751
|
*
|
|
10741
10752
|
* @param {String} threadId threadId
|
|
10742
10753
|
* @param {Object} opts Optional parameters
|
|
10743
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10744
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10745
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
10746
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10747
|
-
* @param {String} opts.nextPage next page token
|
|
10748
|
-
* @param {String} opts.previousPage Previous page token
|
|
10749
10754
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10750
10755
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10751
10756
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -10763,7 +10768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10763
10768
|
'/api/v2/chats/threads/{threadId}/messages',
|
|
10764
10769
|
'GET',
|
|
10765
10770
|
{ 'threadId': threadId },
|
|
10766
|
-
{ '
|
|
10771
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10767
10772
|
{ },
|
|
10768
10773
|
{ },
|
|
10769
10774
|
null,
|
|
@@ -10809,12 +10814,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10809
10814
|
*
|
|
10810
10815
|
* @param {String} userId userId
|
|
10811
10816
|
* @param {Object} opts Optional parameters
|
|
10812
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10813
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10814
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
10815
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10816
|
-
* @param {String} opts.nextPage next page token
|
|
10817
|
-
* @param {String} opts.previousPage Previous page token
|
|
10818
10817
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10819
10818
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10820
10819
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -10832,7 +10831,33 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10832
10831
|
'/api/v2/chats/users/{userId}/messages',
|
|
10833
10832
|
'GET',
|
|
10834
10833
|
{ 'userId': userId },
|
|
10835
|
-
{ '
|
|
10834
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10835
|
+
{ },
|
|
10836
|
+
{ },
|
|
10837
|
+
null,
|
|
10838
|
+
['PureCloud OAuth'],
|
|
10839
|
+
['application/json'],
|
|
10840
|
+
['application/json']
|
|
10841
|
+
);
|
|
10842
|
+
}
|
|
10843
|
+
|
|
10844
|
+
/**
|
|
10845
|
+
* Get a user's chat settings
|
|
10846
|
+
*
|
|
10847
|
+
* @param {String} userId User ID
|
|
10848
|
+
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10849
|
+
*/
|
|
10850
|
+
getChatsUserSettings(userId) {
|
|
10851
|
+
// verify the required parameter 'userId' is set
|
|
10852
|
+
if (userId === undefined || userId === null) {
|
|
10853
|
+
throw 'Missing the required parameter "userId" when calling getChatsUserSettings';
|
|
10854
|
+
}
|
|
10855
|
+
|
|
10856
|
+
return this.apiClient.callApi(
|
|
10857
|
+
'/api/v2/chats/users/{userId}/settings',
|
|
10858
|
+
'GET',
|
|
10859
|
+
{ 'userId': userId },
|
|
10860
|
+
{ },
|
|
10836
10861
|
{ },
|
|
10837
10862
|
{ },
|
|
10838
10863
|
null,
|
|
@@ -10970,6 +10995,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10970
10995
|
);
|
|
10971
10996
|
}
|
|
10972
10997
|
|
|
10998
|
+
/**
|
|
10999
|
+
* Update a user's chat settings
|
|
11000
|
+
*
|
|
11001
|
+
* @param {String} userId User ID
|
|
11002
|
+
* @param {Object} body
|
|
11003
|
+
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11004
|
+
*/
|
|
11005
|
+
patchChatsUserSettings(userId, body) {
|
|
11006
|
+
// verify the required parameter 'userId' is set
|
|
11007
|
+
if (userId === undefined || userId === null) {
|
|
11008
|
+
throw 'Missing the required parameter "userId" when calling patchChatsUserSettings';
|
|
11009
|
+
}
|
|
11010
|
+
// verify the required parameter 'body' is set
|
|
11011
|
+
if (body === undefined || body === null) {
|
|
11012
|
+
throw 'Missing the required parameter "body" when calling patchChatsUserSettings';
|
|
11013
|
+
}
|
|
11014
|
+
|
|
11015
|
+
return this.apiClient.callApi(
|
|
11016
|
+
'/api/v2/chats/users/{userId}/settings',
|
|
11017
|
+
'PATCH',
|
|
11018
|
+
{ 'userId': userId },
|
|
11019
|
+
{ },
|
|
11020
|
+
{ },
|
|
11021
|
+
{ },
|
|
11022
|
+
body,
|
|
11023
|
+
['PureCloud OAuth'],
|
|
11024
|
+
['application/json'],
|
|
11025
|
+
['application/json']
|
|
11026
|
+
);
|
|
11027
|
+
}
|
|
11028
|
+
|
|
10973
11029
|
/**
|
|
10974
11030
|
* Send a message to a room
|
|
10975
11031
|
*
|
|
@@ -11151,7 +11207,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11151
11207
|
/**
|
|
11152
11208
|
* Coaching service.
|
|
11153
11209
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11154
|
-
* @version
|
|
11210
|
+
* @version 187.0.0
|
|
11155
11211
|
*/
|
|
11156
11212
|
|
|
11157
11213
|
/**
|
|
@@ -11728,7 +11784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11728
11784
|
/**
|
|
11729
11785
|
* ContentManagement service.
|
|
11730
11786
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11731
|
-
* @version
|
|
11787
|
+
* @version 187.0.0
|
|
11732
11788
|
*/
|
|
11733
11789
|
|
|
11734
11790
|
/**
|
|
@@ -11940,41 +11996,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11940
11996
|
);
|
|
11941
11997
|
}
|
|
11942
11998
|
|
|
11943
|
-
/**
|
|
11944
|
-
* Get a list of audits for a document.
|
|
11945
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
11946
|
-
* @param {String} documentId Document ID
|
|
11947
|
-
* @param {Object} opts Optional parameters
|
|
11948
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11949
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11950
|
-
* @param {String} opts.transactionFilter Transaction filter
|
|
11951
|
-
* @param {String} opts.level level (default to USER)
|
|
11952
|
-
* @param {String} opts.sortBy Sort by
|
|
11953
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
11954
|
-
* @deprecated
|
|
11955
|
-
*/
|
|
11956
|
-
getContentmanagementDocumentAudits(documentId, opts) {
|
|
11957
|
-
opts = opts || {};
|
|
11958
|
-
|
|
11959
|
-
// verify the required parameter 'documentId' is set
|
|
11960
|
-
if (documentId === undefined || documentId === null) {
|
|
11961
|
-
throw 'Missing the required parameter "documentId" when calling getContentmanagementDocumentAudits';
|
|
11962
|
-
}
|
|
11963
|
-
|
|
11964
|
-
return this.apiClient.callApi(
|
|
11965
|
-
'/api/v2/contentmanagement/documents/{documentId}/audits',
|
|
11966
|
-
'GET',
|
|
11967
|
-
{ 'documentId': documentId },
|
|
11968
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'transactionFilter': opts['transactionFilter'],'level': opts['level'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
11969
|
-
{ },
|
|
11970
|
-
{ },
|
|
11971
|
-
null,
|
|
11972
|
-
['PureCloud OAuth'],
|
|
11973
|
-
['application/json'],
|
|
11974
|
-
['application/json']
|
|
11975
|
-
);
|
|
11976
|
-
}
|
|
11977
|
-
|
|
11978
11999
|
/**
|
|
11979
12000
|
* Download a document.
|
|
11980
12001
|
*
|
|
@@ -12496,32 +12517,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12496
12517
|
);
|
|
12497
12518
|
}
|
|
12498
12519
|
|
|
12499
|
-
/**
|
|
12500
|
-
* Query audits
|
|
12501
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
12502
|
-
* @param {Object} body Allows for a filtered query returning facet information
|
|
12503
|
-
* @deprecated
|
|
12504
|
-
*/
|
|
12505
|
-
postContentmanagementAuditquery(body) {
|
|
12506
|
-
// verify the required parameter 'body' is set
|
|
12507
|
-
if (body === undefined || body === null) {
|
|
12508
|
-
throw 'Missing the required parameter "body" when calling postContentmanagementAuditquery';
|
|
12509
|
-
}
|
|
12510
|
-
|
|
12511
|
-
return this.apiClient.callApi(
|
|
12512
|
-
'/api/v2/contentmanagement/auditquery',
|
|
12513
|
-
'POST',
|
|
12514
|
-
{ },
|
|
12515
|
-
{ },
|
|
12516
|
-
{ },
|
|
12517
|
-
{ },
|
|
12518
|
-
body,
|
|
12519
|
-
['PureCloud OAuth'],
|
|
12520
|
-
['application/json'],
|
|
12521
|
-
['application/json']
|
|
12522
|
-
);
|
|
12523
|
-
}
|
|
12524
|
-
|
|
12525
12520
|
/**
|
|
12526
12521
|
* Update a document.
|
|
12527
12522
|
*
|
|
@@ -12871,7 +12866,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12871
12866
|
/**
|
|
12872
12867
|
* Conversations service.
|
|
12873
12868
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12874
|
-
* @version
|
|
12869
|
+
* @version 187.0.0
|
|
12875
12870
|
*/
|
|
12876
12871
|
|
|
12877
12872
|
/**
|
|
@@ -17574,6 +17569,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17574
17569
|
);
|
|
17575
17570
|
}
|
|
17576
17571
|
|
|
17572
|
+
/**
|
|
17573
|
+
* Submit feedback for the summary.
|
|
17574
|
+
*
|
|
17575
|
+
* @param {String} conversationId Conversation ID
|
|
17576
|
+
* @param {String} summaryId Summary ID
|
|
17577
|
+
* @param {Object} opts Optional parameters
|
|
17578
|
+
* @param {Object} opts.body
|
|
17579
|
+
*/
|
|
17580
|
+
postConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
17581
|
+
opts = opts || {};
|
|
17582
|
+
|
|
17583
|
+
// verify the required parameter 'conversationId' is set
|
|
17584
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17585
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSummaryFeedback';
|
|
17586
|
+
}
|
|
17587
|
+
// verify the required parameter 'summaryId' is set
|
|
17588
|
+
if (summaryId === undefined || summaryId === null) {
|
|
17589
|
+
throw 'Missing the required parameter "summaryId" when calling postConversationSummaryFeedback';
|
|
17590
|
+
}
|
|
17591
|
+
|
|
17592
|
+
return this.apiClient.callApi(
|
|
17593
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback',
|
|
17594
|
+
'POST',
|
|
17595
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
17596
|
+
{ },
|
|
17597
|
+
{ },
|
|
17598
|
+
{ },
|
|
17599
|
+
opts['body'],
|
|
17600
|
+
['PureCloud OAuth'],
|
|
17601
|
+
['application/json'],
|
|
17602
|
+
['application/json']
|
|
17603
|
+
);
|
|
17604
|
+
}
|
|
17605
|
+
|
|
17577
17606
|
/**
|
|
17578
17607
|
* Place a new call as part of a callback conversation.
|
|
17579
17608
|
*
|
|
@@ -19097,9 +19126,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19097
19126
|
}
|
|
19098
19127
|
|
|
19099
19128
|
/**
|
|
19100
|
-
* Create a LINE messenger Integration
|
|
19101
|
-
*
|
|
19129
|
+
* Create a LINE messenger Integration (Deprecated)
|
|
19130
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
19102
19131
|
* @param {Object} body LineIntegrationRequest
|
|
19132
|
+
* @deprecated
|
|
19103
19133
|
*/
|
|
19104
19134
|
postConversationsMessagingIntegrationsLine(body) {
|
|
19105
19135
|
// verify the required parameter 'body' is set
|
|
@@ -20011,7 +20041,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20011
20041
|
/**
|
|
20012
20042
|
* DataExtensions service.
|
|
20013
20043
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20014
|
-
* @version
|
|
20044
|
+
* @version 187.0.0
|
|
20015
20045
|
*/
|
|
20016
20046
|
|
|
20017
20047
|
/**
|
|
@@ -20097,7 +20127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20097
20127
|
/**
|
|
20098
20128
|
* Downloads service.
|
|
20099
20129
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20100
|
-
* @version
|
|
20130
|
+
* @version 187.0.0
|
|
20101
20131
|
*/
|
|
20102
20132
|
|
|
20103
20133
|
/**
|
|
@@ -20149,7 +20179,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20149
20179
|
/**
|
|
20150
20180
|
* Emails service.
|
|
20151
20181
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20152
|
-
* @version
|
|
20182
|
+
* @version 187.0.0
|
|
20153
20183
|
*/
|
|
20154
20184
|
|
|
20155
20185
|
/**
|
|
@@ -20214,7 +20244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20214
20244
|
/**
|
|
20215
20245
|
* Events service.
|
|
20216
20246
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20217
|
-
* @version
|
|
20247
|
+
* @version 187.0.0
|
|
20218
20248
|
*/
|
|
20219
20249
|
|
|
20220
20250
|
/**
|
|
@@ -20310,7 +20340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20310
20340
|
/**
|
|
20311
20341
|
* ExternalContacts service.
|
|
20312
20342
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20313
|
-
* @version
|
|
20343
|
+
* @version 187.0.0
|
|
20314
20344
|
*/
|
|
20315
20345
|
|
|
20316
20346
|
/**
|
|
@@ -20636,7 +20666,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20636
20666
|
* @param {Object} opts Optional parameters
|
|
20637
20667
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20638
20668
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20639
|
-
* @param {String} opts.sortOrder
|
|
20669
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
20640
20670
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20641
20671
|
*/
|
|
20642
20672
|
getExternalcontactsContactNotes(contactId, opts) {
|
|
@@ -20697,7 +20727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20697
20727
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20698
20728
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20699
20729
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
20700
|
-
* @param {String} opts.sortOrder
|
|
20730
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
20701
20731
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20702
20732
|
*/
|
|
20703
20733
|
getExternalcontactsContacts(opts) {
|
|
@@ -20856,7 +20886,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20856
20886
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20857
20887
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20858
20888
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
20859
|
-
* @param {String} opts.sortOrder
|
|
20889
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
20860
20890
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20861
20891
|
*/
|
|
20862
20892
|
getExternalcontactsOrganizationContacts(externalOrganizationId, opts) {
|
|
@@ -20922,7 +20952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20922
20952
|
* @param {Object} opts Optional parameters
|
|
20923
20953
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20924
20954
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20925
|
-
* @param {String} opts.sortOrder
|
|
20955
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
20926
20956
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20927
20957
|
*/
|
|
20928
20958
|
getExternalcontactsOrganizationNotes(externalOrganizationId, opts) {
|
|
@@ -20955,7 +20985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20955
20985
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
20956
20986
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20957
20987
|
* @param {Object} opts.expand which fields, if any, to expand
|
|
20958
|
-
* @param {String} opts.sortOrder
|
|
20988
|
+
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
20959
20989
|
*/
|
|
20960
20990
|
getExternalcontactsOrganizationRelationships(externalOrganizationId, opts) {
|
|
20961
20991
|
opts = opts || {};
|
|
@@ -20987,7 +21017,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20987
21017
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
20988
21018
|
* @param {String} opts.q Search query
|
|
20989
21019
|
* @param {Array.<String>} opts.trustorId Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested
|
|
20990
|
-
* @param {String} opts.sortOrder
|
|
21020
|
+
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
20991
21021
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
20992
21022
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
20993
21023
|
*/
|
|
@@ -22268,7 +22298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22268
22298
|
/**
|
|
22269
22299
|
* Fax service.
|
|
22270
22300
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22271
|
-
* @version
|
|
22301
|
+
* @version 187.0.0
|
|
22272
22302
|
*/
|
|
22273
22303
|
|
|
22274
22304
|
/**
|
|
@@ -22439,7 +22469,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22439
22469
|
/**
|
|
22440
22470
|
* Flows service.
|
|
22441
22471
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22442
|
-
* @version
|
|
22472
|
+
* @version 187.0.0
|
|
22443
22473
|
*/
|
|
22444
22474
|
|
|
22445
22475
|
/**
|
|
@@ -22623,7 +22653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22623
22653
|
/**
|
|
22624
22654
|
* Gamification service.
|
|
22625
22655
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22626
|
-
* @version
|
|
22656
|
+
* @version 187.0.0
|
|
22627
22657
|
*/
|
|
22628
22658
|
|
|
22629
22659
|
/**
|
|
@@ -24709,7 +24739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24709
24739
|
/**
|
|
24710
24740
|
* GeneralDataProtectionRegulation service.
|
|
24711
24741
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24712
|
-
* @version
|
|
24742
|
+
* @version 187.0.0
|
|
24713
24743
|
*/
|
|
24714
24744
|
|
|
24715
24745
|
/**
|
|
@@ -24839,7 +24869,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24839
24869
|
/**
|
|
24840
24870
|
* Geolocation service.
|
|
24841
24871
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24842
|
-
* @version
|
|
24872
|
+
* @version 187.0.0
|
|
24843
24873
|
*/
|
|
24844
24874
|
|
|
24845
24875
|
/**
|
|
@@ -24970,7 +25000,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24970
25000
|
/**
|
|
24971
25001
|
* Greetings service.
|
|
24972
25002
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24973
|
-
* @version
|
|
25003
|
+
* @version 187.0.0
|
|
24974
25004
|
*/
|
|
24975
25005
|
|
|
24976
25006
|
/**
|
|
@@ -25425,7 +25455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25425
25455
|
/**
|
|
25426
25456
|
* Groups service.
|
|
25427
25457
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25428
|
-
* @version
|
|
25458
|
+
* @version 187.0.0
|
|
25429
25459
|
*/
|
|
25430
25460
|
|
|
25431
25461
|
/**
|
|
@@ -25944,7 +25974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25944
25974
|
/**
|
|
25945
25975
|
* IdentityProvider service.
|
|
25946
25976
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25947
|
-
* @version
|
|
25977
|
+
* @version 187.0.0
|
|
25948
25978
|
*/
|
|
25949
25979
|
|
|
25950
25980
|
/**
|
|
@@ -25959,6 +25989,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25959
25989
|
}
|
|
25960
25990
|
|
|
25961
25991
|
|
|
25992
|
+
/**
|
|
25993
|
+
* Delete Identity Provider
|
|
25994
|
+
*
|
|
25995
|
+
* @param {String} providerId Provider ID
|
|
25996
|
+
*/
|
|
25997
|
+
deleteIdentityprovider(providerId) {
|
|
25998
|
+
// verify the required parameter 'providerId' is set
|
|
25999
|
+
if (providerId === undefined || providerId === null) {
|
|
26000
|
+
throw 'Missing the required parameter "providerId" when calling deleteIdentityprovider';
|
|
26001
|
+
}
|
|
26002
|
+
|
|
26003
|
+
return this.apiClient.callApi(
|
|
26004
|
+
'/api/v2/identityproviders/{providerId}',
|
|
26005
|
+
'DELETE',
|
|
26006
|
+
{ 'providerId': providerId },
|
|
26007
|
+
{ },
|
|
26008
|
+
{ },
|
|
26009
|
+
{ },
|
|
26010
|
+
null,
|
|
26011
|
+
['PureCloud OAuth'],
|
|
26012
|
+
['application/json'],
|
|
26013
|
+
['application/json']
|
|
26014
|
+
);
|
|
26015
|
+
}
|
|
26016
|
+
|
|
25962
26017
|
/**
|
|
25963
26018
|
* Delete ADFS Identity Provider
|
|
25964
26019
|
*
|
|
@@ -26179,6 +26234,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26179
26234
|
);
|
|
26180
26235
|
}
|
|
26181
26236
|
|
|
26237
|
+
/**
|
|
26238
|
+
* Get Identity Provider
|
|
26239
|
+
*
|
|
26240
|
+
* @param {String} providerId Provider ID
|
|
26241
|
+
*/
|
|
26242
|
+
getIdentityprovider(providerId) {
|
|
26243
|
+
// verify the required parameter 'providerId' is set
|
|
26244
|
+
if (providerId === undefined || providerId === null) {
|
|
26245
|
+
throw 'Missing the required parameter "providerId" when calling getIdentityprovider';
|
|
26246
|
+
}
|
|
26247
|
+
|
|
26248
|
+
return this.apiClient.callApi(
|
|
26249
|
+
'/api/v2/identityproviders/{providerId}',
|
|
26250
|
+
'GET',
|
|
26251
|
+
{ 'providerId': providerId },
|
|
26252
|
+
{ },
|
|
26253
|
+
{ },
|
|
26254
|
+
{ },
|
|
26255
|
+
null,
|
|
26256
|
+
['PureCloud OAuth'],
|
|
26257
|
+
['application/json'],
|
|
26258
|
+
['application/json']
|
|
26259
|
+
);
|
|
26260
|
+
}
|
|
26261
|
+
|
|
26182
26262
|
/**
|
|
26183
26263
|
* The list of identity providers
|
|
26184
26264
|
*
|
|
@@ -26419,6 +26499,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26419
26499
|
);
|
|
26420
26500
|
}
|
|
26421
26501
|
|
|
26502
|
+
/**
|
|
26503
|
+
* Create Identity Provider
|
|
26504
|
+
*
|
|
26505
|
+
* @param {Object} body Provider
|
|
26506
|
+
*/
|
|
26507
|
+
postIdentityproviders(body) {
|
|
26508
|
+
// verify the required parameter 'body' is set
|
|
26509
|
+
if (body === undefined || body === null) {
|
|
26510
|
+
throw 'Missing the required parameter "body" when calling postIdentityproviders';
|
|
26511
|
+
}
|
|
26512
|
+
|
|
26513
|
+
return this.apiClient.callApi(
|
|
26514
|
+
'/api/v2/identityproviders',
|
|
26515
|
+
'POST',
|
|
26516
|
+
{ },
|
|
26517
|
+
{ },
|
|
26518
|
+
{ },
|
|
26519
|
+
{ },
|
|
26520
|
+
body,
|
|
26521
|
+
['PureCloud OAuth'],
|
|
26522
|
+
['application/json'],
|
|
26523
|
+
['application/json']
|
|
26524
|
+
);
|
|
26525
|
+
}
|
|
26526
|
+
|
|
26527
|
+
/**
|
|
26528
|
+
* Update Identity Provider
|
|
26529
|
+
*
|
|
26530
|
+
* @param {String} providerId Provider ID
|
|
26531
|
+
* @param {Object} body Provider
|
|
26532
|
+
*/
|
|
26533
|
+
putIdentityprovider(providerId, body) {
|
|
26534
|
+
// verify the required parameter 'providerId' is set
|
|
26535
|
+
if (providerId === undefined || providerId === null) {
|
|
26536
|
+
throw 'Missing the required parameter "providerId" when calling putIdentityprovider';
|
|
26537
|
+
}
|
|
26538
|
+
// verify the required parameter 'body' is set
|
|
26539
|
+
if (body === undefined || body === null) {
|
|
26540
|
+
throw 'Missing the required parameter "body" when calling putIdentityprovider';
|
|
26541
|
+
}
|
|
26542
|
+
|
|
26543
|
+
return this.apiClient.callApi(
|
|
26544
|
+
'/api/v2/identityproviders/{providerId}',
|
|
26545
|
+
'PUT',
|
|
26546
|
+
{ 'providerId': providerId },
|
|
26547
|
+
{ },
|
|
26548
|
+
{ },
|
|
26549
|
+
{ },
|
|
26550
|
+
body,
|
|
26551
|
+
['PureCloud OAuth'],
|
|
26552
|
+
['application/json'],
|
|
26553
|
+
['application/json']
|
|
26554
|
+
);
|
|
26555
|
+
}
|
|
26556
|
+
|
|
26422
26557
|
/**
|
|
26423
26558
|
* Update/Create ADFS Identity Provider
|
|
26424
26559
|
*
|
|
@@ -26700,7 +26835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26700
26835
|
/**
|
|
26701
26836
|
* InfrastructureAsCode service.
|
|
26702
26837
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26703
|
-
* @version
|
|
26838
|
+
* @version 187.0.0
|
|
26704
26839
|
*/
|
|
26705
26840
|
|
|
26706
26841
|
/**
|
|
@@ -26867,7 +27002,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26867
27002
|
/**
|
|
26868
27003
|
* Integrations service.
|
|
26869
27004
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26870
|
-
* @version
|
|
27005
|
+
* @version 187.0.0
|
|
26871
27006
|
*/
|
|
26872
27007
|
|
|
26873
27008
|
/**
|
|
@@ -27130,6 +27265,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27130
27265
|
);
|
|
27131
27266
|
}
|
|
27132
27267
|
|
|
27268
|
+
/**
|
|
27269
|
+
* Get draft function settings for Action
|
|
27270
|
+
*
|
|
27271
|
+
* @param {String} actionId actionId
|
|
27272
|
+
* getIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27273
|
+
*/
|
|
27274
|
+
getIntegrationsActionDraftFunction(actionId) {
|
|
27275
|
+
// verify the required parameter 'actionId' is set
|
|
27276
|
+
if (actionId === undefined || actionId === null) {
|
|
27277
|
+
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftFunction';
|
|
27278
|
+
}
|
|
27279
|
+
|
|
27280
|
+
return this.apiClient.callApi(
|
|
27281
|
+
'/api/v2/integrations/actions/{actionId}/draft/function',
|
|
27282
|
+
'GET',
|
|
27283
|
+
{ 'actionId': actionId },
|
|
27284
|
+
{ },
|
|
27285
|
+
{ },
|
|
27286
|
+
{ },
|
|
27287
|
+
null,
|
|
27288
|
+
['PureCloud OAuth'],
|
|
27289
|
+
['application/json'],
|
|
27290
|
+
['application/json']
|
|
27291
|
+
);
|
|
27292
|
+
}
|
|
27293
|
+
|
|
27133
27294
|
/**
|
|
27134
27295
|
* Retrieve schema for a Draft based on filename.
|
|
27135
27296
|
*
|
|
@@ -27215,6 +27376,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27215
27376
|
);
|
|
27216
27377
|
}
|
|
27217
27378
|
|
|
27379
|
+
/**
|
|
27380
|
+
* Get published function settings for Action
|
|
27381
|
+
*
|
|
27382
|
+
* @param {String} actionId actionId
|
|
27383
|
+
* getIntegrationsActionFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27384
|
+
*/
|
|
27385
|
+
getIntegrationsActionFunction(actionId) {
|
|
27386
|
+
// verify the required parameter 'actionId' is set
|
|
27387
|
+
if (actionId === undefined || actionId === null) {
|
|
27388
|
+
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionFunction';
|
|
27389
|
+
}
|
|
27390
|
+
|
|
27391
|
+
return this.apiClient.callApi(
|
|
27392
|
+
'/api/v2/integrations/actions/{actionId}/function',
|
|
27393
|
+
'GET',
|
|
27394
|
+
{ 'actionId': actionId },
|
|
27395
|
+
{ },
|
|
27396
|
+
{ },
|
|
27397
|
+
{ },
|
|
27398
|
+
null,
|
|
27399
|
+
['PureCloud OAuth'],
|
|
27400
|
+
['application/json'],
|
|
27401
|
+
['application/json']
|
|
27402
|
+
);
|
|
27403
|
+
}
|
|
27404
|
+
|
|
27218
27405
|
/**
|
|
27219
27406
|
* Retrieve schema for an action based on filename.
|
|
27220
27407
|
*
|
|
@@ -27339,6 +27526,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27339
27526
|
);
|
|
27340
27527
|
}
|
|
27341
27528
|
|
|
27529
|
+
/**
|
|
27530
|
+
* Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.
|
|
27531
|
+
*
|
|
27532
|
+
* @param {Object} opts Optional parameters
|
|
27533
|
+
* @param {Object} opts.status Indicates the validity of the certificate in question.
|
|
27534
|
+
* @param {Object} opts.type Indicates the type of the certificate.
|
|
27535
|
+
*/
|
|
27536
|
+
getIntegrationsActionsCertificates(opts) {
|
|
27537
|
+
opts = opts || {};
|
|
27538
|
+
|
|
27539
|
+
|
|
27540
|
+
return this.apiClient.callApi(
|
|
27541
|
+
'/api/v2/integrations/actions/certificates',
|
|
27542
|
+
'GET',
|
|
27543
|
+
{ },
|
|
27544
|
+
{ 'status': opts['status'],'type': opts['type'] },
|
|
27545
|
+
{ },
|
|
27546
|
+
{ },
|
|
27547
|
+
null,
|
|
27548
|
+
['PureCloud OAuth'],
|
|
27549
|
+
['application/json'],
|
|
27550
|
+
['application/json']
|
|
27551
|
+
);
|
|
27552
|
+
}
|
|
27553
|
+
|
|
27342
27554
|
/**
|
|
27343
27555
|
* Retrieves all action drafts associated with the filters passed in via query param.
|
|
27344
27556
|
*
|
|
@@ -27373,6 +27585,27 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27373
27585
|
);
|
|
27374
27586
|
}
|
|
27375
27587
|
|
|
27588
|
+
/**
|
|
27589
|
+
* Get action function settings for Action
|
|
27590
|
+
*
|
|
27591
|
+
* getIntegrationsActionsFunctionsRuntimes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27592
|
+
*/
|
|
27593
|
+
getIntegrationsActionsFunctionsRuntimes() {
|
|
27594
|
+
|
|
27595
|
+
return this.apiClient.callApi(
|
|
27596
|
+
'/api/v2/integrations/actions/functions/runtimes',
|
|
27597
|
+
'GET',
|
|
27598
|
+
{ },
|
|
27599
|
+
{ },
|
|
27600
|
+
{ },
|
|
27601
|
+
{ },
|
|
27602
|
+
null,
|
|
27603
|
+
['PureCloud OAuth'],
|
|
27604
|
+
['application/json'],
|
|
27605
|
+
['application/json']
|
|
27606
|
+
);
|
|
27607
|
+
}
|
|
27608
|
+
|
|
27376
27609
|
/**
|
|
27377
27610
|
* Get a specific botConnector bot, plus versions, for this integration
|
|
27378
27611
|
*
|
|
@@ -28356,6 +28589,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28356
28589
|
);
|
|
28357
28590
|
}
|
|
28358
28591
|
|
|
28592
|
+
/**
|
|
28593
|
+
* Create upload presigned URL for draft function package file.
|
|
28594
|
+
*
|
|
28595
|
+
* @param {String} actionId actionId
|
|
28596
|
+
* @param {Object} body Input used to request URL upload.
|
|
28597
|
+
* postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28598
|
+
*/
|
|
28599
|
+
postIntegrationsActionDraftFunctionUpload(actionId, body) {
|
|
28600
|
+
// verify the required parameter 'actionId' is set
|
|
28601
|
+
if (actionId === undefined || actionId === null) {
|
|
28602
|
+
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';
|
|
28603
|
+
}
|
|
28604
|
+
// verify the required parameter 'body' is set
|
|
28605
|
+
if (body === undefined || body === null) {
|
|
28606
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';
|
|
28607
|
+
}
|
|
28608
|
+
|
|
28609
|
+
return this.apiClient.callApi(
|
|
28610
|
+
'/api/v2/integrations/actions/{actionId}/draft/function/upload',
|
|
28611
|
+
'POST',
|
|
28612
|
+
{ 'actionId': actionId },
|
|
28613
|
+
{ },
|
|
28614
|
+
{ },
|
|
28615
|
+
{ },
|
|
28616
|
+
body,
|
|
28617
|
+
['PureCloud OAuth'],
|
|
28618
|
+
['application/json'],
|
|
28619
|
+
['application/json']
|
|
28620
|
+
);
|
|
28621
|
+
}
|
|
28622
|
+
|
|
28359
28623
|
/**
|
|
28360
28624
|
* Publish a Draft and make it the active Action configuration
|
|
28361
28625
|
*
|
|
@@ -28678,6 +28942,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28678
28942
|
);
|
|
28679
28943
|
}
|
|
28680
28944
|
|
|
28945
|
+
/**
|
|
28946
|
+
* Update draft function settings.
|
|
28947
|
+
*
|
|
28948
|
+
* @param {String} actionId actionId
|
|
28949
|
+
* @param {Object} body Input used to update function settings.
|
|
28950
|
+
* putIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28951
|
+
*/
|
|
28952
|
+
putIntegrationsActionDraftFunction(actionId, body) {
|
|
28953
|
+
// verify the required parameter 'actionId' is set
|
|
28954
|
+
if (actionId === undefined || actionId === null) {
|
|
28955
|
+
throw 'Missing the required parameter "actionId" when calling putIntegrationsActionDraftFunction';
|
|
28956
|
+
}
|
|
28957
|
+
// verify the required parameter 'body' is set
|
|
28958
|
+
if (body === undefined || body === null) {
|
|
28959
|
+
throw 'Missing the required parameter "body" when calling putIntegrationsActionDraftFunction';
|
|
28960
|
+
}
|
|
28961
|
+
|
|
28962
|
+
return this.apiClient.callApi(
|
|
28963
|
+
'/api/v2/integrations/actions/{actionId}/draft/function',
|
|
28964
|
+
'PUT',
|
|
28965
|
+
{ 'actionId': actionId },
|
|
28966
|
+
{ },
|
|
28967
|
+
{ },
|
|
28968
|
+
{ },
|
|
28969
|
+
body,
|
|
28970
|
+
['PureCloud OAuth'],
|
|
28971
|
+
['application/json'],
|
|
28972
|
+
['application/json']
|
|
28973
|
+
);
|
|
28974
|
+
}
|
|
28975
|
+
|
|
28681
28976
|
/**
|
|
28682
28977
|
* Set a list of botConnector bots plus versions for this integration
|
|
28683
28978
|
*
|
|
@@ -28829,7 +29124,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28829
29124
|
/**
|
|
28830
29125
|
* Journey service.
|
|
28831
29126
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28832
|
-
* @version
|
|
29127
|
+
* @version 187.0.0
|
|
28833
29128
|
*/
|
|
28834
29129
|
|
|
28835
29130
|
/**
|
|
@@ -29596,39 +29891,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29596
29891
|
);
|
|
29597
29892
|
}
|
|
29598
29893
|
|
|
29599
|
-
/**
|
|
29600
|
-
* Retrieve segment assignments by session ID.
|
|
29601
|
-
*
|
|
29602
|
-
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
29603
|
-
* @param {Object} opts Optional parameters
|
|
29604
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
29605
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
29606
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
29607
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
29608
|
-
* getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29609
|
-
*/
|
|
29610
|
-
getJourneySessionSegments(sessionId, opts) {
|
|
29611
|
-
opts = opts || {};
|
|
29612
|
-
|
|
29613
|
-
// verify the required parameter 'sessionId' is set
|
|
29614
|
-
if (sessionId === undefined || sessionId === null) {
|
|
29615
|
-
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
29616
|
-
}
|
|
29617
|
-
|
|
29618
|
-
return this.apiClient.callApi(
|
|
29619
|
-
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
29620
|
-
'GET',
|
|
29621
|
-
{ 'sessionId': sessionId },
|
|
29622
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
29623
|
-
{ },
|
|
29624
|
-
{ },
|
|
29625
|
-
null,
|
|
29626
|
-
['PureCloud OAuth'],
|
|
29627
|
-
['application/json'],
|
|
29628
|
-
['application/json']
|
|
29629
|
-
);
|
|
29630
|
-
}
|
|
29631
|
-
|
|
29632
29894
|
/**
|
|
29633
29895
|
* Update single action map.
|
|
29634
29896
|
*
|
|
@@ -30060,7 +30322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30060
30322
|
/**
|
|
30061
30323
|
* Knowledge service.
|
|
30062
30324
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
30063
|
-
* @version
|
|
30325
|
+
* @version 187.0.0
|
|
30064
30326
|
*/
|
|
30065
30327
|
|
|
30066
30328
|
/**
|
|
@@ -31402,6 +31664,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31402
31664
|
);
|
|
31403
31665
|
}
|
|
31404
31666
|
|
|
31667
|
+
/**
|
|
31668
|
+
* Get operations
|
|
31669
|
+
*
|
|
31670
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31671
|
+
* @param {Object} opts Optional parameters
|
|
31672
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31673
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31674
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31675
|
+
* @param {Array.<String>} opts.userId If specified, retrieves operations associated with user ids, comma separated values expected.
|
|
31676
|
+
* @param {Array.<String>} opts.type If specified, retrieves operations with specified operation type, comma separated values expected.
|
|
31677
|
+
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
31678
|
+
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
31679
|
+
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31680
|
+
*/
|
|
31681
|
+
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
31682
|
+
opts = opts || {};
|
|
31683
|
+
|
|
31684
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31685
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31686
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';
|
|
31687
|
+
}
|
|
31688
|
+
|
|
31689
|
+
return this.apiClient.callApi(
|
|
31690
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations',
|
|
31691
|
+
'GET',
|
|
31692
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
31693
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'] },
|
|
31694
|
+
{ },
|
|
31695
|
+
{ },
|
|
31696
|
+
null,
|
|
31697
|
+
['PureCloud OAuth'],
|
|
31698
|
+
['application/json'],
|
|
31699
|
+
['application/json']
|
|
31700
|
+
);
|
|
31701
|
+
}
|
|
31702
|
+
|
|
31703
|
+
/**
|
|
31704
|
+
* Get ids of operation creator users and oauth clients
|
|
31705
|
+
*
|
|
31706
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31707
|
+
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31708
|
+
*/
|
|
31709
|
+
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
31710
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31711
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31712
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperationsUsersQuery';
|
|
31713
|
+
}
|
|
31714
|
+
|
|
31715
|
+
return this.apiClient.callApi(
|
|
31716
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query',
|
|
31717
|
+
'GET',
|
|
31718
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
31719
|
+
{ },
|
|
31720
|
+
{ },
|
|
31721
|
+
{ },
|
|
31722
|
+
null,
|
|
31723
|
+
['PureCloud OAuth'],
|
|
31724
|
+
['application/json'],
|
|
31725
|
+
['application/json']
|
|
31726
|
+
);
|
|
31727
|
+
}
|
|
31728
|
+
|
|
31405
31729
|
/**
|
|
31406
31730
|
* Get knowledge base unanswered group for a particular groupId
|
|
31407
31731
|
*
|
|
@@ -32881,7 +33205,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32881
33205
|
/**
|
|
32882
33206
|
* LanguageUnderstanding service.
|
|
32883
33207
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32884
|
-
* @version
|
|
33208
|
+
* @version 187.0.0
|
|
32885
33209
|
*/
|
|
32886
33210
|
|
|
32887
33211
|
/**
|
|
@@ -33894,7 +34218,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33894
34218
|
/**
|
|
33895
34219
|
* Languages service.
|
|
33896
34220
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33897
|
-
* @version
|
|
34221
|
+
* @version 187.0.0
|
|
33898
34222
|
*/
|
|
33899
34223
|
|
|
33900
34224
|
/**
|
|
@@ -34116,7 +34440,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34116
34440
|
/**
|
|
34117
34441
|
* Learning service.
|
|
34118
34442
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
34119
|
-
* @version
|
|
34443
|
+
* @version 187.0.0
|
|
34120
34444
|
*/
|
|
34121
34445
|
|
|
34122
34446
|
/**
|
|
@@ -34972,7 +35296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34972
35296
|
/**
|
|
34973
35297
|
* License service.
|
|
34974
35298
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34975
|
-
* @version
|
|
35299
|
+
* @version 187.0.0
|
|
34976
35300
|
*/
|
|
34977
35301
|
|
|
34978
35302
|
/**
|
|
@@ -35210,7 +35534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35210
35534
|
/**
|
|
35211
35535
|
* Locations service.
|
|
35212
35536
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
35213
|
-
* @version
|
|
35537
|
+
* @version 187.0.0
|
|
35214
35538
|
*/
|
|
35215
35539
|
|
|
35216
35540
|
/**
|
|
@@ -35446,7 +35770,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35446
35770
|
/**
|
|
35447
35771
|
* LogCapture service.
|
|
35448
35772
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
35449
|
-
* @version
|
|
35773
|
+
* @version 187.0.0
|
|
35450
35774
|
*/
|
|
35451
35775
|
|
|
35452
35776
|
/**
|
|
@@ -35461,6 +35785,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35461
35785
|
}
|
|
35462
35786
|
|
|
35463
35787
|
|
|
35788
|
+
/**
|
|
35789
|
+
* Disable browser log capture for the user
|
|
35790
|
+
*
|
|
35791
|
+
* @param {String} userId The id of the user to disable browser log capture
|
|
35792
|
+
*/
|
|
35793
|
+
deleteDiagnosticsLogcaptureBrowserUser(userId) {
|
|
35794
|
+
// verify the required parameter 'userId' is set
|
|
35795
|
+
if (userId === undefined || userId === null) {
|
|
35796
|
+
throw 'Missing the required parameter "userId" when calling deleteDiagnosticsLogcaptureBrowserUser';
|
|
35797
|
+
}
|
|
35798
|
+
|
|
35799
|
+
return this.apiClient.callApi(
|
|
35800
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35801
|
+
'DELETE',
|
|
35802
|
+
{ 'userId': userId },
|
|
35803
|
+
{ },
|
|
35804
|
+
{ },
|
|
35805
|
+
{ },
|
|
35806
|
+
null,
|
|
35807
|
+
['PureCloud OAuth'],
|
|
35808
|
+
['application/json'],
|
|
35809
|
+
['application/json']
|
|
35810
|
+
);
|
|
35811
|
+
}
|
|
35812
|
+
|
|
35464
35813
|
/**
|
|
35465
35814
|
* Gets status of async download execution
|
|
35466
35815
|
*
|
|
@@ -35486,6 +35835,55 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35486
35835
|
);
|
|
35487
35836
|
}
|
|
35488
35837
|
|
|
35838
|
+
/**
|
|
35839
|
+
* Get log capture configuration for the user
|
|
35840
|
+
*
|
|
35841
|
+
* @param {String} userId The id of the user to get browser log capture configuration
|
|
35842
|
+
*/
|
|
35843
|
+
getDiagnosticsLogcaptureBrowserUser(userId) {
|
|
35844
|
+
// verify the required parameter 'userId' is set
|
|
35845
|
+
if (userId === undefined || userId === null) {
|
|
35846
|
+
throw 'Missing the required parameter "userId" when calling getDiagnosticsLogcaptureBrowserUser';
|
|
35847
|
+
}
|
|
35848
|
+
|
|
35849
|
+
return this.apiClient.callApi(
|
|
35850
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35851
|
+
'GET',
|
|
35852
|
+
{ 'userId': userId },
|
|
35853
|
+
{ },
|
|
35854
|
+
{ },
|
|
35855
|
+
{ },
|
|
35856
|
+
null,
|
|
35857
|
+
['PureCloud OAuth'],
|
|
35858
|
+
['application/json'],
|
|
35859
|
+
['application/json']
|
|
35860
|
+
);
|
|
35861
|
+
}
|
|
35862
|
+
|
|
35863
|
+
/**
|
|
35864
|
+
* Get all log capture enabled users for an org
|
|
35865
|
+
*
|
|
35866
|
+
* @param {Object} opts Optional parameters
|
|
35867
|
+
* @param {Boolean} opts.includeExpired Include expired users with log captures still available for search or download (default to false)
|
|
35868
|
+
*/
|
|
35869
|
+
getDiagnosticsLogcaptureBrowserUsers(opts) {
|
|
35870
|
+
opts = opts || {};
|
|
35871
|
+
|
|
35872
|
+
|
|
35873
|
+
return this.apiClient.callApi(
|
|
35874
|
+
'/api/v2/diagnostics/logcapture/browser/users',
|
|
35875
|
+
'GET',
|
|
35876
|
+
{ },
|
|
35877
|
+
{ 'includeExpired': opts['includeExpired'] },
|
|
35878
|
+
{ },
|
|
35879
|
+
{ },
|
|
35880
|
+
null,
|
|
35881
|
+
['PureCloud OAuth'],
|
|
35882
|
+
['application/json'],
|
|
35883
|
+
['application/json']
|
|
35884
|
+
);
|
|
35885
|
+
}
|
|
35886
|
+
|
|
35489
35887
|
/**
|
|
35490
35888
|
* Creates an async download execution
|
|
35491
35889
|
*
|
|
@@ -35510,13 +35908,69 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35510
35908
|
);
|
|
35511
35909
|
}
|
|
35512
35910
|
|
|
35911
|
+
/**
|
|
35912
|
+
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
35913
|
+
*
|
|
35914
|
+
* @param {Object} opts Optional parameters
|
|
35915
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
35916
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35917
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35918
|
+
* @param {Object} opts.body
|
|
35919
|
+
*/
|
|
35920
|
+
postDiagnosticsLogcaptureBrowserEntriesQuery(opts) {
|
|
35921
|
+
opts = opts || {};
|
|
35922
|
+
|
|
35923
|
+
|
|
35924
|
+
return this.apiClient.callApi(
|
|
35925
|
+
'/api/v2/diagnostics/logcapture/browser/entries/query',
|
|
35926
|
+
'POST',
|
|
35927
|
+
{ },
|
|
35928
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
35929
|
+
{ },
|
|
35930
|
+
{ },
|
|
35931
|
+
opts['body'],
|
|
35932
|
+
['PureCloud OAuth'],
|
|
35933
|
+
['application/json'],
|
|
35934
|
+
['application/json']
|
|
35935
|
+
);
|
|
35936
|
+
}
|
|
35937
|
+
|
|
35938
|
+
/**
|
|
35939
|
+
* Enable log capture for a user or update expiration
|
|
35940
|
+
*
|
|
35941
|
+
* @param {String} userId The id of the user to enable browser log capture
|
|
35942
|
+
* @param {Object} opts Optional parameters
|
|
35943
|
+
* @param {Object} opts.body
|
|
35944
|
+
*/
|
|
35945
|
+
postDiagnosticsLogcaptureBrowserUser(userId, opts) {
|
|
35946
|
+
opts = opts || {};
|
|
35947
|
+
|
|
35948
|
+
// verify the required parameter 'userId' is set
|
|
35949
|
+
if (userId === undefined || userId === null) {
|
|
35950
|
+
throw 'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';
|
|
35951
|
+
}
|
|
35952
|
+
|
|
35953
|
+
return this.apiClient.callApi(
|
|
35954
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
35955
|
+
'POST',
|
|
35956
|
+
{ 'userId': userId },
|
|
35957
|
+
{ },
|
|
35958
|
+
{ },
|
|
35959
|
+
{ },
|
|
35960
|
+
opts['body'],
|
|
35961
|
+
['PureCloud OAuth'],
|
|
35962
|
+
['application/json'],
|
|
35963
|
+
['application/json']
|
|
35964
|
+
);
|
|
35965
|
+
}
|
|
35966
|
+
|
|
35513
35967
|
}
|
|
35514
35968
|
|
|
35515
35969
|
class MessagingApi {
|
|
35516
35970
|
/**
|
|
35517
35971
|
* Messaging service.
|
|
35518
35972
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
35519
|
-
* @version
|
|
35973
|
+
* @version 187.0.0
|
|
35520
35974
|
*/
|
|
35521
35975
|
|
|
35522
35976
|
/**
|
|
@@ -35875,7 +36329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35875
36329
|
/**
|
|
35876
36330
|
* MobileDevices service.
|
|
35877
36331
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35878
|
-
* @version
|
|
36332
|
+
* @version 187.0.0
|
|
35879
36333
|
*/
|
|
35880
36334
|
|
|
35881
36335
|
/**
|
|
@@ -36026,7 +36480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36026
36480
|
/**
|
|
36027
36481
|
* Notifications service.
|
|
36028
36482
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
36029
|
-
* @version
|
|
36483
|
+
* @version 187.0.0
|
|
36030
36484
|
*/
|
|
36031
36485
|
|
|
36032
36486
|
/**
|
|
@@ -36259,7 +36713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36259
36713
|
/**
|
|
36260
36714
|
* OAuth service.
|
|
36261
36715
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
36262
|
-
* @version
|
|
36716
|
+
* @version 187.0.0
|
|
36263
36717
|
*/
|
|
36264
36718
|
|
|
36265
36719
|
/**
|
|
@@ -36625,7 +37079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36625
37079
|
/**
|
|
36626
37080
|
* Objects service.
|
|
36627
37081
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36628
|
-
* @version
|
|
37082
|
+
* @version 187.0.0
|
|
36629
37083
|
*/
|
|
36630
37084
|
|
|
36631
37085
|
/**
|
|
@@ -36709,7 +37163,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36709
37163
|
* @param {String} opts.nextPage next page token
|
|
36710
37164
|
* @param {String} opts.previousPage Previous page token
|
|
36711
37165
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
36712
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
36713
37166
|
* @param {String} opts.name Search term to filter by division name
|
|
36714
37167
|
*/
|
|
36715
37168
|
getAuthorizationDivisions(opts) {
|
|
@@ -36720,7 +37173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36720
37173
|
'/api/v2/authorization/divisions',
|
|
36721
37174
|
'GET',
|
|
36722
37175
|
{ },
|
|
36723
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'
|
|
37176
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
36724
37177
|
{ },
|
|
36725
37178
|
{ },
|
|
36726
37179
|
null,
|
|
@@ -36895,7 +37348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36895
37348
|
/**
|
|
36896
37349
|
* OperationalEvents service.
|
|
36897
37350
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36898
|
-
* @version
|
|
37351
|
+
* @version 187.0.0
|
|
36899
37352
|
*/
|
|
36900
37353
|
|
|
36901
37354
|
/**
|
|
@@ -36961,7 +37414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36961
37414
|
/**
|
|
36962
37415
|
* Organization service.
|
|
36963
37416
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36964
|
-
* @version
|
|
37417
|
+
* @version 187.0.0
|
|
36965
37418
|
*/
|
|
36966
37419
|
|
|
36967
37420
|
/**
|
|
@@ -37416,7 +37869,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37416
37869
|
/**
|
|
37417
37870
|
* OrganizationAuthorization service.
|
|
37418
37871
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
37419
|
-
* @version
|
|
37872
|
+
* @version 187.0.0
|
|
37420
37873
|
*/
|
|
37421
37874
|
|
|
37422
37875
|
/**
|
|
@@ -38763,7 +39216,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38763
39216
|
/**
|
|
38764
39217
|
* Outbound service.
|
|
38765
39218
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38766
|
-
* @version
|
|
39219
|
+
* @version 187.0.0
|
|
38767
39220
|
*/
|
|
38768
39221
|
|
|
38769
39222
|
/**
|
|
@@ -39250,6 +39703,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39250
39703
|
);
|
|
39251
39704
|
}
|
|
39252
39705
|
|
|
39706
|
+
/**
|
|
39707
|
+
* Delete File Specification Template
|
|
39708
|
+
*
|
|
39709
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
39710
|
+
*/
|
|
39711
|
+
deleteOutboundFilespecificationtemplate(fileSpecificationTemplateId) {
|
|
39712
|
+
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
39713
|
+
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null) {
|
|
39714
|
+
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling deleteOutboundFilespecificationtemplate';
|
|
39715
|
+
}
|
|
39716
|
+
|
|
39717
|
+
return this.apiClient.callApi(
|
|
39718
|
+
'/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}',
|
|
39719
|
+
'DELETE',
|
|
39720
|
+
{ 'fileSpecificationTemplateId': fileSpecificationTemplateId },
|
|
39721
|
+
{ },
|
|
39722
|
+
{ },
|
|
39723
|
+
{ },
|
|
39724
|
+
null,
|
|
39725
|
+
['PureCloud OAuth'],
|
|
39726
|
+
['application/json'],
|
|
39727
|
+
['application/json']
|
|
39728
|
+
);
|
|
39729
|
+
}
|
|
39730
|
+
|
|
39731
|
+
/**
|
|
39732
|
+
* Delete multiple file specification templates.
|
|
39733
|
+
*
|
|
39734
|
+
* @param {Array.<String>} id File Specification template id(s) to delete
|
|
39735
|
+
*/
|
|
39736
|
+
deleteOutboundFilespecificationtemplatesBulk(id) {
|
|
39737
|
+
// verify the required parameter 'id' is set
|
|
39738
|
+
if (id === undefined || id === null) {
|
|
39739
|
+
throw 'Missing the required parameter "id" when calling deleteOutboundFilespecificationtemplatesBulk';
|
|
39740
|
+
}
|
|
39741
|
+
|
|
39742
|
+
return this.apiClient.callApi(
|
|
39743
|
+
'/api/v2/outbound/filespecificationtemplates/bulk',
|
|
39744
|
+
'DELETE',
|
|
39745
|
+
{ },
|
|
39746
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
39747
|
+
{ },
|
|
39748
|
+
{ },
|
|
39749
|
+
null,
|
|
39750
|
+
['PureCloud OAuth'],
|
|
39751
|
+
['application/json'],
|
|
39752
|
+
['application/json']
|
|
39753
|
+
);
|
|
39754
|
+
}
|
|
39755
|
+
|
|
39253
39756
|
/**
|
|
39254
39757
|
* Delete Import Template
|
|
39255
39758
|
*
|
|
@@ -40657,6 +41160,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40657
41160
|
);
|
|
40658
41161
|
}
|
|
40659
41162
|
|
|
41163
|
+
/**
|
|
41164
|
+
* Get File Specification Template
|
|
41165
|
+
*
|
|
41166
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
41167
|
+
*/
|
|
41168
|
+
getOutboundFilespecificationtemplate(fileSpecificationTemplateId) {
|
|
41169
|
+
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
41170
|
+
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null) {
|
|
41171
|
+
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling getOutboundFilespecificationtemplate';
|
|
41172
|
+
}
|
|
41173
|
+
|
|
41174
|
+
return this.apiClient.callApi(
|
|
41175
|
+
'/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}',
|
|
41176
|
+
'GET',
|
|
41177
|
+
{ 'fileSpecificationTemplateId': fileSpecificationTemplateId },
|
|
41178
|
+
{ },
|
|
41179
|
+
{ },
|
|
41180
|
+
{ },
|
|
41181
|
+
null,
|
|
41182
|
+
['PureCloud OAuth'],
|
|
41183
|
+
['application/json'],
|
|
41184
|
+
['application/json']
|
|
41185
|
+
);
|
|
41186
|
+
}
|
|
41187
|
+
|
|
41188
|
+
/**
|
|
41189
|
+
* Query File Specification Templates
|
|
41190
|
+
*
|
|
41191
|
+
* @param {Object} opts Optional parameters
|
|
41192
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
41193
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41194
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
41195
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
41196
|
+
* @param {String} opts.name Name
|
|
41197
|
+
* @param {String} opts.sortBy Sort by
|
|
41198
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
41199
|
+
*/
|
|
41200
|
+
getOutboundFilespecificationtemplates(opts) {
|
|
41201
|
+
opts = opts || {};
|
|
41202
|
+
|
|
41203
|
+
|
|
41204
|
+
return this.apiClient.callApi(
|
|
41205
|
+
'/api/v2/outbound/filespecificationtemplates',
|
|
41206
|
+
'GET',
|
|
41207
|
+
{ },
|
|
41208
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
41209
|
+
{ },
|
|
41210
|
+
{ },
|
|
41211
|
+
null,
|
|
41212
|
+
['PureCloud OAuth'],
|
|
41213
|
+
['application/json'],
|
|
41214
|
+
['application/json']
|
|
41215
|
+
);
|
|
41216
|
+
}
|
|
41217
|
+
|
|
40660
41218
|
/**
|
|
40661
41219
|
* Get Import Template
|
|
40662
41220
|
*
|
|
@@ -41830,6 +42388,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41830
42388
|
);
|
|
41831
42389
|
}
|
|
41832
42390
|
|
|
42391
|
+
/**
|
|
42392
|
+
* Get multiple contact list templates
|
|
42393
|
+
*
|
|
42394
|
+
* @param {Object} body contact list templates to get
|
|
42395
|
+
*/
|
|
42396
|
+
postOutboundContactlisttemplatesBulkRetrieve(body) {
|
|
42397
|
+
// verify the required parameter 'body' is set
|
|
42398
|
+
if (body === undefined || body === null) {
|
|
42399
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkRetrieve';
|
|
42400
|
+
}
|
|
42401
|
+
|
|
42402
|
+
return this.apiClient.callApi(
|
|
42403
|
+
'/api/v2/outbound/contactlisttemplates/bulk/retrieve',
|
|
42404
|
+
'POST',
|
|
42405
|
+
{ },
|
|
42406
|
+
{ },
|
|
42407
|
+
{ },
|
|
42408
|
+
{ },
|
|
42409
|
+
body,
|
|
42410
|
+
['PureCloud OAuth'],
|
|
42411
|
+
['application/json'],
|
|
42412
|
+
['application/json']
|
|
42413
|
+
);
|
|
42414
|
+
}
|
|
42415
|
+
|
|
41833
42416
|
/**
|
|
41834
42417
|
* Add phone numbers to a Dialer DNC list.
|
|
41835
42418
|
*
|
|
@@ -41994,6 +42577,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41994
42577
|
);
|
|
41995
42578
|
}
|
|
41996
42579
|
|
|
42580
|
+
/**
|
|
42581
|
+
* Create File Specification Template
|
|
42582
|
+
*
|
|
42583
|
+
* @param {Object} body FileSpecificationTemplate
|
|
42584
|
+
*/
|
|
42585
|
+
postOutboundFilespecificationtemplates(body) {
|
|
42586
|
+
// verify the required parameter 'body' is set
|
|
42587
|
+
if (body === undefined || body === null) {
|
|
42588
|
+
throw 'Missing the required parameter "body" when calling postOutboundFilespecificationtemplates';
|
|
42589
|
+
}
|
|
42590
|
+
|
|
42591
|
+
return this.apiClient.callApi(
|
|
42592
|
+
'/api/v2/outbound/filespecificationtemplates',
|
|
42593
|
+
'POST',
|
|
42594
|
+
{ },
|
|
42595
|
+
{ },
|
|
42596
|
+
{ },
|
|
42597
|
+
{ },
|
|
42598
|
+
body,
|
|
42599
|
+
['PureCloud OAuth'],
|
|
42600
|
+
['application/json'],
|
|
42601
|
+
['application/json']
|
|
42602
|
+
);
|
|
42603
|
+
}
|
|
42604
|
+
|
|
41997
42605
|
/**
|
|
41998
42606
|
* Create Import Template
|
|
41999
42607
|
*
|
|
@@ -42514,6 +43122,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42514
43122
|
);
|
|
42515
43123
|
}
|
|
42516
43124
|
|
|
43125
|
+
/**
|
|
43126
|
+
* Update File Specification Template
|
|
43127
|
+
*
|
|
43128
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
43129
|
+
* @param {Object} body fileSpecificationTemplate
|
|
43130
|
+
*/
|
|
43131
|
+
putOutboundFilespecificationtemplate(fileSpecificationTemplateId, body) {
|
|
43132
|
+
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
43133
|
+
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null) {
|
|
43134
|
+
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling putOutboundFilespecificationtemplate';
|
|
43135
|
+
}
|
|
43136
|
+
// verify the required parameter 'body' is set
|
|
43137
|
+
if (body === undefined || body === null) {
|
|
43138
|
+
throw 'Missing the required parameter "body" when calling putOutboundFilespecificationtemplate';
|
|
43139
|
+
}
|
|
43140
|
+
|
|
43141
|
+
return this.apiClient.callApi(
|
|
43142
|
+
'/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}',
|
|
43143
|
+
'PUT',
|
|
43144
|
+
{ 'fileSpecificationTemplateId': fileSpecificationTemplateId },
|
|
43145
|
+
{ },
|
|
43146
|
+
{ },
|
|
43147
|
+
{ },
|
|
43148
|
+
body,
|
|
43149
|
+
['PureCloud OAuth'],
|
|
43150
|
+
['application/json'],
|
|
43151
|
+
['application/json']
|
|
43152
|
+
);
|
|
43153
|
+
}
|
|
43154
|
+
|
|
42517
43155
|
/**
|
|
42518
43156
|
* Update Import Template
|
|
42519
43157
|
*
|
|
@@ -42785,7 +43423,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42785
43423
|
/**
|
|
42786
43424
|
* Presence service.
|
|
42787
43425
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42788
|
-
* @version
|
|
43426
|
+
* @version 187.0.0
|
|
42789
43427
|
*/
|
|
42790
43428
|
|
|
42791
43429
|
/**
|
|
@@ -42851,9 +43489,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42851
43489
|
}
|
|
42852
43490
|
|
|
42853
43491
|
/**
|
|
42854
|
-
* Delete a Presence Definition
|
|
43492
|
+
* Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead
|
|
42855
43493
|
*
|
|
42856
43494
|
* @param {String} presenceId Organization Presence ID
|
|
43495
|
+
* @deprecated
|
|
42857
43496
|
*/
|
|
42858
43497
|
deletePresencedefinition(presenceId) {
|
|
42859
43498
|
// verify the required parameter 'presenceId' is set
|
|
@@ -43025,11 +43664,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43025
43664
|
}
|
|
43026
43665
|
|
|
43027
43666
|
/**
|
|
43028
|
-
* Get a Presence Definition
|
|
43667
|
+
* Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead
|
|
43029
43668
|
*
|
|
43030
43669
|
* @param {String} presenceId Organization Presence ID
|
|
43031
43670
|
* @param {Object} opts Optional parameters
|
|
43032
43671
|
* @param {String} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
43672
|
+
* @deprecated
|
|
43033
43673
|
*/
|
|
43034
43674
|
getPresencedefinition(presenceId, opts) {
|
|
43035
43675
|
opts = opts || {};
|
|
@@ -43054,13 +43694,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43054
43694
|
}
|
|
43055
43695
|
|
|
43056
43696
|
/**
|
|
43057
|
-
* Get an Organization's list of Presence Definitions
|
|
43697
|
+
* Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead
|
|
43058
43698
|
*
|
|
43059
43699
|
* @param {Object} opts Optional parameters
|
|
43060
43700
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43061
43701
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43062
43702
|
* @param {String} opts.deleted Deleted query can be TRUE, FALSE or ALL (default to false)
|
|
43063
43703
|
* @param {String} opts.localeCode The locale code to fetch for each presence definition. Use ALL to fetch everything.
|
|
43704
|
+
* @deprecated
|
|
43064
43705
|
*/
|
|
43065
43706
|
getPresencedefinitions(opts) {
|
|
43066
43707
|
opts = opts || {};
|
|
@@ -43324,9 +43965,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43324
43965
|
}
|
|
43325
43966
|
|
|
43326
43967
|
/**
|
|
43327
|
-
* Create a Presence Definition
|
|
43968
|
+
* Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead
|
|
43328
43969
|
*
|
|
43329
43970
|
* @param {Object} body The Presence Definition to create
|
|
43971
|
+
* @deprecated
|
|
43330
43972
|
*/
|
|
43331
43973
|
postPresencedefinitions(body) {
|
|
43332
43974
|
// verify the required parameter 'body' is set
|
|
@@ -43464,10 +44106,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43464
44106
|
}
|
|
43465
44107
|
|
|
43466
44108
|
/**
|
|
43467
|
-
* Update a Presence Definition
|
|
44109
|
+
* Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)
|
|
43468
44110
|
*
|
|
43469
44111
|
* @param {String} presenceId Organization Presence ID
|
|
43470
44112
|
* @param {Object} body The OrganizationPresence to update
|
|
44113
|
+
* @deprecated
|
|
43471
44114
|
*/
|
|
43472
44115
|
putPresencedefinition(presenceId, body) {
|
|
43473
44116
|
// verify the required parameter 'presenceId' is set
|
|
@@ -43524,7 +44167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43524
44167
|
/**
|
|
43525
44168
|
* ProcessAutomation service.
|
|
43526
44169
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
43527
|
-
* @version
|
|
44170
|
+
* @version 187.0.0
|
|
43528
44171
|
*/
|
|
43529
44172
|
|
|
43530
44173
|
/**
|
|
@@ -43763,7 +44406,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43763
44406
|
/**
|
|
43764
44407
|
* Quality service.
|
|
43765
44408
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43766
|
-
* @version
|
|
44409
|
+
* @version 187.0.0
|
|
43767
44410
|
*/
|
|
43768
44411
|
|
|
43769
44412
|
/**
|
|
@@ -45356,7 +45999,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45356
45999
|
|
|
45357
46000
|
/**
|
|
45358
46001
|
* Update an evaluation
|
|
45359
|
-
* The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
|
|
46002
|
+
* The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.
|
|
45360
46003
|
* @param {String} conversationId conversationId
|
|
45361
46004
|
* @param {String} evaluationId evaluationId
|
|
45362
46005
|
* @param {Object} body evaluation
|
|
@@ -45520,7 +46163,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45520
46163
|
/**
|
|
45521
46164
|
* Recording service.
|
|
45522
46165
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
45523
|
-
* @version
|
|
46166
|
+
* @version 187.0.0
|
|
45524
46167
|
*/
|
|
45525
46168
|
|
|
45526
46169
|
/**
|
|
@@ -47157,7 +47800,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47157
47800
|
/**
|
|
47158
47801
|
* ResponseManagement service.
|
|
47159
47802
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
47160
|
-
* @version
|
|
47803
|
+
* @version 187.0.0
|
|
47161
47804
|
*/
|
|
47162
47805
|
|
|
47163
47806
|
/**
|
|
@@ -47642,7 +48285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47642
48285
|
/**
|
|
47643
48286
|
* Routing service.
|
|
47644
48287
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
47645
|
-
* @version
|
|
48288
|
+
* @version 187.0.0
|
|
47646
48289
|
*/
|
|
47647
48290
|
|
|
47648
48291
|
/**
|
|
@@ -49832,6 +50475,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49832
50475
|
);
|
|
49833
50476
|
}
|
|
49834
50477
|
|
|
50478
|
+
/**
|
|
50479
|
+
* Get a simplified wrap-up code.
|
|
50480
|
+
*
|
|
50481
|
+
* @param {String} codeId Wrapup Code ID
|
|
50482
|
+
*/
|
|
50483
|
+
getRoutingWrapupcodesDivisionview(codeId) {
|
|
50484
|
+
// verify the required parameter 'codeId' is set
|
|
50485
|
+
if (codeId === undefined || codeId === null) {
|
|
50486
|
+
throw 'Missing the required parameter "codeId" when calling getRoutingWrapupcodesDivisionview';
|
|
50487
|
+
}
|
|
50488
|
+
|
|
50489
|
+
return this.apiClient.callApi(
|
|
50490
|
+
'/api/v2/routing/wrapupcodes/divisionviews/{codeId}',
|
|
50491
|
+
'GET',
|
|
50492
|
+
{ 'codeId': codeId },
|
|
50493
|
+
{ },
|
|
50494
|
+
{ },
|
|
50495
|
+
{ },
|
|
50496
|
+
null,
|
|
50497
|
+
['PureCloud OAuth'],
|
|
50498
|
+
['application/json'],
|
|
50499
|
+
['application/json']
|
|
50500
|
+
);
|
|
50501
|
+
}
|
|
50502
|
+
|
|
50503
|
+
/**
|
|
50504
|
+
* Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).
|
|
50505
|
+
* Specifying both name and ID parameters is not supported.
|
|
50506
|
+
* @param {Object} opts Optional parameters
|
|
50507
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50508
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50509
|
+
* @param {String} opts.name Name (trailing asterisks allowed)
|
|
50510
|
+
* @param {Array.<String>} opts.id Wrapup code ID(s)
|
|
50511
|
+
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
50512
|
+
* @param {Object} opts.includeState Wrapup code state(s) to include
|
|
50513
|
+
*/
|
|
50514
|
+
getRoutingWrapupcodesDivisionviews(opts) {
|
|
50515
|
+
opts = opts || {};
|
|
50516
|
+
|
|
50517
|
+
|
|
50518
|
+
return this.apiClient.callApi(
|
|
50519
|
+
'/api/v2/routing/wrapupcodes/divisionviews',
|
|
50520
|
+
'GET',
|
|
50521
|
+
{ },
|
|
50522
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'includeState': opts['includeState'] },
|
|
50523
|
+
{ },
|
|
50524
|
+
{ },
|
|
50525
|
+
null,
|
|
50526
|
+
['PureCloud OAuth'],
|
|
50527
|
+
['application/json'],
|
|
50528
|
+
['application/json']
|
|
50529
|
+
);
|
|
50530
|
+
}
|
|
50531
|
+
|
|
49835
50532
|
/**
|
|
49836
50533
|
* Get queues for user
|
|
49837
50534
|
*
|
|
@@ -50233,6 +50930,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50233
50930
|
);
|
|
50234
50931
|
}
|
|
50235
50932
|
|
|
50933
|
+
/**
|
|
50934
|
+
* Patch Transcription Settings
|
|
50935
|
+
*
|
|
50936
|
+
* @param {Object} body Organization Settings
|
|
50937
|
+
*/
|
|
50938
|
+
patchRoutingSettingsTranscription(body) {
|
|
50939
|
+
// verify the required parameter 'body' is set
|
|
50940
|
+
if (body === undefined || body === null) {
|
|
50941
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSettingsTranscription';
|
|
50942
|
+
}
|
|
50943
|
+
|
|
50944
|
+
return this.apiClient.callApi(
|
|
50945
|
+
'/api/v2/routing/settings/transcription',
|
|
50946
|
+
'PATCH',
|
|
50947
|
+
{ },
|
|
50948
|
+
{ },
|
|
50949
|
+
{ },
|
|
50950
|
+
{ },
|
|
50951
|
+
body,
|
|
50952
|
+
['PureCloud OAuth'],
|
|
50953
|
+
['application/json'],
|
|
50954
|
+
['application/json']
|
|
50955
|
+
);
|
|
50956
|
+
}
|
|
50957
|
+
|
|
50236
50958
|
/**
|
|
50237
50959
|
* Update skill group definition
|
|
50238
50960
|
*
|
|
@@ -50971,7 +51693,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50971
51693
|
* Imports a phone number for SMS
|
|
50972
51694
|
*
|
|
50973
51695
|
* @param {Object} body SmsPhoneNumber
|
|
50974
|
-
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
50975
51696
|
*/
|
|
50976
51697
|
postRoutingSmsPhonenumbersImport(body) {
|
|
50977
51698
|
// verify the required parameter 'body' is set
|
|
@@ -51517,7 +52238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51517
52238
|
/**
|
|
51518
52239
|
* SCIM service.
|
|
51519
52240
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
51520
|
-
* @version
|
|
52241
|
+
* @version 187.0.0
|
|
51521
52242
|
*/
|
|
51522
52243
|
|
|
51523
52244
|
/**
|
|
@@ -52390,11 +53111,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52390
53111
|
|
|
52391
53112
|
}
|
|
52392
53113
|
|
|
53114
|
+
class ScreenRecordingApi {
|
|
53115
|
+
/**
|
|
53116
|
+
* ScreenRecording service.
|
|
53117
|
+
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
53118
|
+
* @version 187.0.0
|
|
53119
|
+
*/
|
|
53120
|
+
|
|
53121
|
+
/**
|
|
53122
|
+
* Constructs a new ScreenRecordingApi.
|
|
53123
|
+
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
53124
|
+
* @class
|
|
53125
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
53126
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
53127
|
+
*/
|
|
53128
|
+
constructor(apiClient) {
|
|
53129
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
53130
|
+
}
|
|
53131
|
+
|
|
53132
|
+
|
|
53133
|
+
/**
|
|
53134
|
+
* Sign identifying information for screen recording
|
|
53135
|
+
*
|
|
53136
|
+
* @param {Object} opts Optional parameters
|
|
53137
|
+
* @param {Object} opts.body
|
|
53138
|
+
*/
|
|
53139
|
+
postScreenrecordingToken(opts) {
|
|
53140
|
+
opts = opts || {};
|
|
53141
|
+
|
|
53142
|
+
|
|
53143
|
+
return this.apiClient.callApi(
|
|
53144
|
+
'/api/v2/screenrecording/token',
|
|
53145
|
+
'POST',
|
|
53146
|
+
{ },
|
|
53147
|
+
{ },
|
|
53148
|
+
{ },
|
|
53149
|
+
{ },
|
|
53150
|
+
opts['body'],
|
|
53151
|
+
['PureCloud OAuth'],
|
|
53152
|
+
['application/json'],
|
|
53153
|
+
['application/json']
|
|
53154
|
+
);
|
|
53155
|
+
}
|
|
53156
|
+
|
|
53157
|
+
}
|
|
53158
|
+
|
|
52393
53159
|
class ScriptsApi {
|
|
52394
53160
|
/**
|
|
52395
53161
|
* Scripts service.
|
|
52396
53162
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
52397
|
-
* @version
|
|
53163
|
+
* @version 187.0.0
|
|
52398
53164
|
*/
|
|
52399
53165
|
|
|
52400
53166
|
/**
|
|
@@ -52838,7 +53604,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52838
53604
|
/**
|
|
52839
53605
|
* Search service.
|
|
52840
53606
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
52841
|
-
* @version
|
|
53607
|
+
* @version 187.0.0
|
|
52842
53608
|
*/
|
|
52843
53609
|
|
|
52844
53610
|
/**
|
|
@@ -53527,7 +54293,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53527
54293
|
/**
|
|
53528
54294
|
* Settings service.
|
|
53529
54295
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
53530
|
-
* @version
|
|
54296
|
+
* @version 187.0.0
|
|
53531
54297
|
*/
|
|
53532
54298
|
|
|
53533
54299
|
/**
|
|
@@ -53592,7 +54358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53592
54358
|
/**
|
|
53593
54359
|
* SpeechTextAnalytics service.
|
|
53594
54360
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
53595
|
-
* @version
|
|
54361
|
+
* @version 187.0.0
|
|
53596
54362
|
*/
|
|
53597
54363
|
|
|
53598
54364
|
/**
|
|
@@ -54705,7 +55471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54705
55471
|
/**
|
|
54706
55472
|
* Stations service.
|
|
54707
55473
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
54708
|
-
* @version
|
|
55474
|
+
* @version 187.0.0
|
|
54709
55475
|
*/
|
|
54710
55476
|
|
|
54711
55477
|
/**
|
|
@@ -54807,7 +55573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54807
55573
|
/**
|
|
54808
55574
|
* Suggest service.
|
|
54809
55575
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
54810
|
-
* @version
|
|
55576
|
+
* @version 187.0.0
|
|
54811
55577
|
*/
|
|
54812
55578
|
|
|
54813
55579
|
/**
|
|
@@ -54946,7 +55712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54946
55712
|
/**
|
|
54947
55713
|
* TaskManagement service.
|
|
54948
55714
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
54949
|
-
* @version
|
|
55715
|
+
* @version 187.0.0
|
|
54950
55716
|
*/
|
|
54951
55717
|
|
|
54952
55718
|
/**
|
|
@@ -56227,7 +56993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56227
56993
|
/**
|
|
56228
56994
|
* Teams service.
|
|
56229
56995
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
56230
|
-
* @version
|
|
56996
|
+
* @version 187.0.0
|
|
56231
56997
|
*/
|
|
56232
56998
|
|
|
56233
56999
|
/**
|
|
@@ -56529,7 +57295,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56529
57295
|
/**
|
|
56530
57296
|
* Telephony service.
|
|
56531
57297
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
56532
|
-
* @version
|
|
57298
|
+
* @version 187.0.0
|
|
56533
57299
|
*/
|
|
56534
57300
|
|
|
56535
57301
|
/**
|
|
@@ -56568,7 +57334,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56568
57334
|
* Get a SIP message.
|
|
56569
57335
|
* Get the raw form of the SIP message
|
|
56570
57336
|
* @param {String} conversationId Conversation id
|
|
56571
|
-
* getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56572
57337
|
*/
|
|
56573
57338
|
getTelephonySipmessagesConversation(conversationId) {
|
|
56574
57339
|
// verify the required parameter 'conversationId' is set
|
|
@@ -56596,7 +57361,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56596
57361
|
* @param {String} conversationId Conversation id
|
|
56597
57362
|
* @param {Object} opts Optional parameters
|
|
56598
57363
|
* @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
|
|
56599
|
-
* getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56600
57364
|
*/
|
|
56601
57365
|
getTelephonySipmessagesConversationHeaders(conversationId, opts) {
|
|
56602
57366
|
opts = opts || {};
|
|
@@ -56713,7 +57477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56713
57477
|
/**
|
|
56714
57478
|
* TelephonyProvidersEdge service.
|
|
56715
57479
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
56716
|
-
* @version
|
|
57480
|
+
* @version 187.0.0
|
|
56717
57481
|
*/
|
|
56718
57482
|
|
|
56719
57483
|
/**
|
|
@@ -57902,7 +58666,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57902
58666
|
* @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
|
|
57903
58667
|
* @param {String} opts.name Name of the Extension Pools to filter by.
|
|
57904
58668
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
57905
|
-
* getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57906
58669
|
*/
|
|
57907
58670
|
getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts) {
|
|
57908
58671
|
opts = opts || {};
|
|
@@ -58192,32 +58955,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58192
58955
|
);
|
|
58193
58956
|
}
|
|
58194
58957
|
|
|
58195
|
-
/**
|
|
58196
|
-
* Get outbound route
|
|
58197
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
58198
|
-
* @param {String} outboundRouteId Outbound route ID
|
|
58199
|
-
* @deprecated
|
|
58200
|
-
*/
|
|
58201
|
-
getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
58202
|
-
// verify the required parameter 'outboundRouteId' is set
|
|
58203
|
-
if (outboundRouteId === undefined || outboundRouteId === null) {
|
|
58204
|
-
throw 'Missing the required parameter "outboundRouteId" when calling getTelephonyProvidersEdgesOutboundroute';
|
|
58205
|
-
}
|
|
58206
|
-
|
|
58207
|
-
return this.apiClient.callApi(
|
|
58208
|
-
'/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
|
|
58209
|
-
'GET',
|
|
58210
|
-
{ 'outboundRouteId': outboundRouteId },
|
|
58211
|
-
{ },
|
|
58212
|
-
{ },
|
|
58213
|
-
{ },
|
|
58214
|
-
null,
|
|
58215
|
-
['PureCloud OAuth'],
|
|
58216
|
-
['application/json'],
|
|
58217
|
-
['application/json']
|
|
58218
|
-
);
|
|
58219
|
-
}
|
|
58220
|
-
|
|
58221
58958
|
/**
|
|
58222
58959
|
* Get outbound routes
|
|
58223
58960
|
*
|
|
@@ -58674,6 +59411,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58674
59411
|
* @param {String} opts.name Name
|
|
58675
59412
|
* @param {String} opts.locationId Location Id
|
|
58676
59413
|
* @param {Boolean} opts.managed Filter by managed
|
|
59414
|
+
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
58677
59415
|
*/
|
|
58678
59416
|
getTelephonyProvidersEdgesSites(opts) {
|
|
58679
59417
|
opts = opts || {};
|
|
@@ -58683,7 +59421,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58683
59421
|
'/api/v2/telephony/providers/edges/sites',
|
|
58684
59422
|
'GET',
|
|
58685
59423
|
{ },
|
|
58686
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'location.id': opts['locationId'],'managed': opts['managed'] },
|
|
59424
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'location.id': opts['locationId'],'managed': opts['managed'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
58687
59425
|
{ },
|
|
58688
59426
|
{ },
|
|
58689
59427
|
null,
|
|
@@ -60088,7 +60826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60088
60826
|
/**
|
|
60089
60827
|
* Textbots service.
|
|
60090
60828
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
60091
|
-
* @version
|
|
60829
|
+
* @version 187.0.0
|
|
60092
60830
|
*/
|
|
60093
60831
|
|
|
60094
60832
|
/**
|
|
@@ -60216,7 +60954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60216
60954
|
/**
|
|
60217
60955
|
* Tokens service.
|
|
60218
60956
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
60219
|
-
* @version
|
|
60957
|
+
* @version 187.0.0
|
|
60220
60958
|
*/
|
|
60221
60959
|
|
|
60222
60960
|
/**
|
|
@@ -60372,7 +61110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60372
61110
|
/**
|
|
60373
61111
|
* Uploads service.
|
|
60374
61112
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
60375
|
-
* @version
|
|
61113
|
+
* @version 187.0.0
|
|
60376
61114
|
*/
|
|
60377
61115
|
|
|
60378
61116
|
/**
|
|
@@ -60387,6 +61125,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60387
61125
|
}
|
|
60388
61126
|
|
|
60389
61127
|
|
|
61128
|
+
/**
|
|
61129
|
+
* Create upload presigned URL for draft function package file.
|
|
61130
|
+
*
|
|
61131
|
+
* @param {String} actionId actionId
|
|
61132
|
+
* @param {Object} body Input used to request URL upload.
|
|
61133
|
+
* postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61134
|
+
*/
|
|
61135
|
+
postIntegrationsActionDraftFunctionUpload(actionId, body) {
|
|
61136
|
+
// verify the required parameter 'actionId' is set
|
|
61137
|
+
if (actionId === undefined || actionId === null) {
|
|
61138
|
+
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';
|
|
61139
|
+
}
|
|
61140
|
+
// verify the required parameter 'body' is set
|
|
61141
|
+
if (body === undefined || body === null) {
|
|
61142
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';
|
|
61143
|
+
}
|
|
61144
|
+
|
|
61145
|
+
return this.apiClient.callApi(
|
|
61146
|
+
'/api/v2/integrations/actions/{actionId}/draft/function/upload',
|
|
61147
|
+
'POST',
|
|
61148
|
+
{ 'actionId': actionId },
|
|
61149
|
+
{ },
|
|
61150
|
+
{ },
|
|
61151
|
+
{ },
|
|
61152
|
+
body,
|
|
61153
|
+
['PureCloud OAuth'],
|
|
61154
|
+
['application/json'],
|
|
61155
|
+
['application/json']
|
|
61156
|
+
);
|
|
61157
|
+
}
|
|
61158
|
+
|
|
60390
61159
|
/**
|
|
60391
61160
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
60392
61161
|
*
|
|
@@ -60548,7 +61317,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60548
61317
|
/**
|
|
60549
61318
|
* Usage service.
|
|
60550
61319
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
60551
|
-
* @version
|
|
61320
|
+
* @version 187.0.0
|
|
60552
61321
|
*/
|
|
60553
61322
|
|
|
60554
61323
|
/**
|
|
@@ -60758,7 +61527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60758
61527
|
/**
|
|
60759
61528
|
* UserRecordings service.
|
|
60760
61529
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
60761
|
-
* @version
|
|
61530
|
+
* @version 187.0.0
|
|
60762
61531
|
*/
|
|
60763
61532
|
|
|
60764
61533
|
/**
|
|
@@ -60943,7 +61712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60943
61712
|
/**
|
|
60944
61713
|
* Users service.
|
|
60945
61714
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
60946
|
-
* @version
|
|
61715
|
+
* @version 187.0.0
|
|
60947
61716
|
*/
|
|
60948
61717
|
|
|
60949
61718
|
/**
|
|
@@ -63594,7 +64363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63594
64363
|
/**
|
|
63595
64364
|
* Utilities service.
|
|
63596
64365
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
63597
|
-
* @version
|
|
64366
|
+
* @version 187.0.0
|
|
63598
64367
|
*/
|
|
63599
64368
|
|
|
63600
64369
|
/**
|
|
@@ -63705,7 +64474,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63705
64474
|
/**
|
|
63706
64475
|
* Voicemail service.
|
|
63707
64476
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
63708
|
-
* @version
|
|
64477
|
+
* @version 187.0.0
|
|
63709
64478
|
*/
|
|
63710
64479
|
|
|
63711
64480
|
/**
|
|
@@ -64372,7 +65141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64372
65141
|
/**
|
|
64373
65142
|
* WebChat service.
|
|
64374
65143
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
64375
|
-
* @version
|
|
65144
|
+
* @version 187.0.0
|
|
64376
65145
|
*/
|
|
64377
65146
|
|
|
64378
65147
|
/**
|
|
@@ -64921,7 +65690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64921
65690
|
/**
|
|
64922
65691
|
* WebDeployments service.
|
|
64923
65692
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
64924
|
-
* @version
|
|
65693
|
+
* @version 187.0.0
|
|
64925
65694
|
*/
|
|
64926
65695
|
|
|
64927
65696
|
/**
|
|
@@ -65448,7 +66217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65448
66217
|
/**
|
|
65449
66218
|
* WebMessaging service.
|
|
65450
66219
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
65451
|
-
* @version
|
|
66220
|
+
* @version 187.0.0
|
|
65452
66221
|
*/
|
|
65453
66222
|
|
|
65454
66223
|
/**
|
|
@@ -65494,7 +66263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65494
66263
|
/**
|
|
65495
66264
|
* Widgets service.
|
|
65496
66265
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
65497
|
-
* @version
|
|
66266
|
+
* @version 187.0.0
|
|
65498
66267
|
*/
|
|
65499
66268
|
|
|
65500
66269
|
/**
|
|
@@ -65640,7 +66409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65640
66409
|
/**
|
|
65641
66410
|
* WorkforceManagement service.
|
|
65642
66411
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
65643
|
-
* @version
|
|
66412
|
+
* @version 187.0.0
|
|
65644
66413
|
*/
|
|
65645
66414
|
|
|
65646
66415
|
/**
|
|
@@ -71035,7 +71804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71035
71804
|
* </pre>
|
|
71036
71805
|
* </p>
|
|
71037
71806
|
* @module purecloud-platform-client-v2/index
|
|
71038
|
-
* @version
|
|
71807
|
+
* @version 187.0.0
|
|
71039
71808
|
*/
|
|
71040
71809
|
class platformClient {
|
|
71041
71810
|
constructor() {
|
|
@@ -71299,6 +72068,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71299
72068
|
* @property {module:purecloud-platform-client-v2/api/SCIMApi}
|
|
71300
72069
|
*/
|
|
71301
72070
|
this.SCIMApi = SCIMApi;
|
|
72071
|
+
/**
|
|
72072
|
+
* The ScreenRecordingApi service constructor.
|
|
72073
|
+
* @property {module:purecloud-platform-client-v2/api/ScreenRecordingApi}
|
|
72074
|
+
*/
|
|
72075
|
+
this.ScreenRecordingApi = ScreenRecordingApi;
|
|
71302
72076
|
/**
|
|
71303
72077
|
* The ScriptsApi service constructor.
|
|
71304
72078
|
* @property {module:purecloud-platform-client-v2/api/ScriptsApi}
|