purecloud-platform-client-v2 173.0.0 → 174.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 +1432 -106
- package/dist/web-amd/purecloud-platform-client-v2.js +1432 -106
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1432 -106
- package/dist/web-cjs/purecloud-platform-client-v2.js +1432 -106
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1278 -218
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +493 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +223 -5
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +62 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +188 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +10 -8
- 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 +7 -6
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +10 -5
- 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 +363 -6
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 174.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3358,7 +3358,7 @@ class AlertingApi {
|
|
|
3358
3358
|
/**
|
|
3359
3359
|
* Alerting service.
|
|
3360
3360
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3361
|
-
* @version
|
|
3361
|
+
* @version 174.0.0
|
|
3362
3362
|
*/
|
|
3363
3363
|
|
|
3364
3364
|
/**
|
|
@@ -4008,7 +4008,7 @@ class AnalyticsApi {
|
|
|
4008
4008
|
/**
|
|
4009
4009
|
* Analytics service.
|
|
4010
4010
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4011
|
-
* @version
|
|
4011
|
+
* @version 174.0.0
|
|
4012
4012
|
*/
|
|
4013
4013
|
|
|
4014
4014
|
/**
|
|
@@ -4156,13 +4156,14 @@ class AnalyticsApi {
|
|
|
4156
4156
|
|
|
4157
4157
|
/**
|
|
4158
4158
|
* Get Reporting Turns.
|
|
4159
|
-
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list.
|
|
4159
|
+
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint do not persist indefinitely, as they auto delete after a predefined period.
|
|
4160
4160
|
* @param {String} botFlowId ID of the bot flow.
|
|
4161
4161
|
* @param {Object} opts Optional parameters
|
|
4162
4162
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
4163
4163
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
4164
|
+
* @param {String} opts.interval Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
4164
4165
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
4165
|
-
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
4166
|
+
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
|
|
4166
4167
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
4167
4168
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
4168
4169
|
*/
|
|
@@ -4178,7 +4179,7 @@ class AnalyticsApi {
|
|
|
4178
4179
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
4179
4180
|
'GET',
|
|
4180
4181
|
{ 'botFlowId': botFlowId },
|
|
4181
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
4182
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
4182
4183
|
{ },
|
|
4183
4184
|
{ },
|
|
4184
4185
|
null,
|
|
@@ -6453,7 +6454,7 @@ class ArchitectApi {
|
|
|
6453
6454
|
/**
|
|
6454
6455
|
* Architect service.
|
|
6455
6456
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6456
|
-
* @version
|
|
6457
|
+
* @version 174.0.0
|
|
6457
6458
|
*/
|
|
6458
6459
|
|
|
6459
6460
|
/**
|
|
@@ -6493,6 +6494,125 @@ class ArchitectApi {
|
|
|
6493
6494
|
);
|
|
6494
6495
|
}
|
|
6495
6496
|
|
|
6497
|
+
/**
|
|
6498
|
+
* Delete a grammar.
|
|
6499
|
+
*
|
|
6500
|
+
* @param {String} grammarId grammar ID
|
|
6501
|
+
* deleteArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6502
|
+
*/
|
|
6503
|
+
deleteArchitectGrammar(grammarId) {
|
|
6504
|
+
// verify the required parameter 'grammarId' is set
|
|
6505
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6506
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';
|
|
6507
|
+
}
|
|
6508
|
+
|
|
6509
|
+
return this.apiClient.callApi(
|
|
6510
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
6511
|
+
'DELETE',
|
|
6512
|
+
{ 'grammarId': grammarId },
|
|
6513
|
+
{ },
|
|
6514
|
+
{ },
|
|
6515
|
+
{ },
|
|
6516
|
+
null,
|
|
6517
|
+
['PureCloud OAuth'],
|
|
6518
|
+
['application/json'],
|
|
6519
|
+
['application/json']
|
|
6520
|
+
);
|
|
6521
|
+
}
|
|
6522
|
+
|
|
6523
|
+
/**
|
|
6524
|
+
* Delete specified grammar language
|
|
6525
|
+
*
|
|
6526
|
+
* @param {String} grammarId Grammar ID
|
|
6527
|
+
* @param {String} languageCode Language
|
|
6528
|
+
* deleteArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6529
|
+
*/
|
|
6530
|
+
deleteArchitectGrammarLanguage(grammarId, languageCode) {
|
|
6531
|
+
// verify the required parameter 'grammarId' is set
|
|
6532
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6533
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';
|
|
6534
|
+
}
|
|
6535
|
+
// verify the required parameter 'languageCode' is set
|
|
6536
|
+
if (languageCode === undefined || languageCode === null) {
|
|
6537
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';
|
|
6538
|
+
}
|
|
6539
|
+
|
|
6540
|
+
return this.apiClient.callApi(
|
|
6541
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
6542
|
+
'DELETE',
|
|
6543
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
6544
|
+
{ },
|
|
6545
|
+
{ },
|
|
6546
|
+
{ },
|
|
6547
|
+
null,
|
|
6548
|
+
['PureCloud OAuth'],
|
|
6549
|
+
['application/json'],
|
|
6550
|
+
['application/json']
|
|
6551
|
+
);
|
|
6552
|
+
}
|
|
6553
|
+
|
|
6554
|
+
/**
|
|
6555
|
+
* Clear the DTMF mode file for the grammar language if there is one
|
|
6556
|
+
*
|
|
6557
|
+
* @param {String} grammarId Grammar ID
|
|
6558
|
+
* @param {String} languageCode Language
|
|
6559
|
+
* deleteArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6560
|
+
*/
|
|
6561
|
+
deleteArchitectGrammarLanguageFilesDtmf(grammarId, languageCode) {
|
|
6562
|
+
// verify the required parameter 'grammarId' is set
|
|
6563
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6564
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
6565
|
+
}
|
|
6566
|
+
// verify the required parameter 'languageCode' is set
|
|
6567
|
+
if (languageCode === undefined || languageCode === null) {
|
|
6568
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
6569
|
+
}
|
|
6570
|
+
|
|
6571
|
+
return this.apiClient.callApi(
|
|
6572
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
6573
|
+
'DELETE',
|
|
6574
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
6575
|
+
{ },
|
|
6576
|
+
{ },
|
|
6577
|
+
{ },
|
|
6578
|
+
null,
|
|
6579
|
+
['PureCloud OAuth'],
|
|
6580
|
+
['application/json'],
|
|
6581
|
+
['application/json']
|
|
6582
|
+
);
|
|
6583
|
+
}
|
|
6584
|
+
|
|
6585
|
+
/**
|
|
6586
|
+
* Clear the voice mode file for the grammar language if there is one
|
|
6587
|
+
*
|
|
6588
|
+
* @param {String} grammarId Grammar ID
|
|
6589
|
+
* @param {String} languageCode Language
|
|
6590
|
+
* deleteArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6591
|
+
*/
|
|
6592
|
+
deleteArchitectGrammarLanguageFilesVoice(grammarId, languageCode) {
|
|
6593
|
+
// verify the required parameter 'grammarId' is set
|
|
6594
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6595
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
6596
|
+
}
|
|
6597
|
+
// verify the required parameter 'languageCode' is set
|
|
6598
|
+
if (languageCode === undefined || languageCode === null) {
|
|
6599
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
6600
|
+
}
|
|
6601
|
+
|
|
6602
|
+
return this.apiClient.callApi(
|
|
6603
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
6604
|
+
'DELETE',
|
|
6605
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
6606
|
+
{ },
|
|
6607
|
+
{ },
|
|
6608
|
+
{ },
|
|
6609
|
+
null,
|
|
6610
|
+
['PureCloud OAuth'],
|
|
6611
|
+
['application/json'],
|
|
6612
|
+
['application/json']
|
|
6613
|
+
);
|
|
6614
|
+
}
|
|
6615
|
+
|
|
6496
6616
|
/**
|
|
6497
6617
|
* Delete an IVR Config.
|
|
6498
6618
|
*
|
|
@@ -7177,6 +7297,130 @@ class ArchitectApi {
|
|
|
7177
7297
|
);
|
|
7178
7298
|
}
|
|
7179
7299
|
|
|
7300
|
+
/**
|
|
7301
|
+
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
7302
|
+
* This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.
|
|
7303
|
+
* @param {Object} opts Optional parameters
|
|
7304
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7305
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7306
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
7307
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
7308
|
+
* @param {Array.<String>} opts.id ID of the Emergency Groups to filter by.
|
|
7309
|
+
* @param {String} opts.name Name of the Emergency Group to filter by.
|
|
7310
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7311
|
+
*/
|
|
7312
|
+
getArchitectEmergencygroupsDivisionviews(opts) {
|
|
7313
|
+
opts = opts || {};
|
|
7314
|
+
|
|
7315
|
+
|
|
7316
|
+
return this.apiClient.callApi(
|
|
7317
|
+
'/api/v2/architect/emergencygroups/divisionviews',
|
|
7318
|
+
'GET',
|
|
7319
|
+
{ },
|
|
7320
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
7321
|
+
{ },
|
|
7322
|
+
{ },
|
|
7323
|
+
null,
|
|
7324
|
+
['PureCloud OAuth'],
|
|
7325
|
+
['application/json'],
|
|
7326
|
+
['application/json']
|
|
7327
|
+
);
|
|
7328
|
+
}
|
|
7329
|
+
|
|
7330
|
+
/**
|
|
7331
|
+
* Get a grammar
|
|
7332
|
+
* Returns a specified grammar
|
|
7333
|
+
* @param {String} grammarId grammar ID
|
|
7334
|
+
* @param {Object} opts Optional parameters
|
|
7335
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
7336
|
+
* getArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7337
|
+
*/
|
|
7338
|
+
getArchitectGrammar(grammarId, opts) {
|
|
7339
|
+
opts = opts || {};
|
|
7340
|
+
|
|
7341
|
+
// verify the required parameter 'grammarId' is set
|
|
7342
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7343
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammar';
|
|
7344
|
+
}
|
|
7345
|
+
|
|
7346
|
+
return this.apiClient.callApi(
|
|
7347
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
7348
|
+
'GET',
|
|
7349
|
+
{ 'grammarId': grammarId },
|
|
7350
|
+
{ 'includeFileUrls': opts['includeFileUrls'] },
|
|
7351
|
+
{ },
|
|
7352
|
+
{ },
|
|
7353
|
+
null,
|
|
7354
|
+
['PureCloud OAuth'],
|
|
7355
|
+
['application/json'],
|
|
7356
|
+
['application/json']
|
|
7357
|
+
);
|
|
7358
|
+
}
|
|
7359
|
+
|
|
7360
|
+
/**
|
|
7361
|
+
* Get a grammar language.
|
|
7362
|
+
*
|
|
7363
|
+
* @param {String} grammarId Grammar ID
|
|
7364
|
+
* @param {String} languageCode Language
|
|
7365
|
+
* getArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7366
|
+
*/
|
|
7367
|
+
getArchitectGrammarLanguage(grammarId, languageCode) {
|
|
7368
|
+
// verify the required parameter 'grammarId' is set
|
|
7369
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7370
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';
|
|
7371
|
+
}
|
|
7372
|
+
// verify the required parameter 'languageCode' is set
|
|
7373
|
+
if (languageCode === undefined || languageCode === null) {
|
|
7374
|
+
throw 'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';
|
|
7375
|
+
}
|
|
7376
|
+
|
|
7377
|
+
return this.apiClient.callApi(
|
|
7378
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
7379
|
+
'GET',
|
|
7380
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
7381
|
+
{ },
|
|
7382
|
+
{ },
|
|
7383
|
+
{ },
|
|
7384
|
+
null,
|
|
7385
|
+
['PureCloud OAuth'],
|
|
7386
|
+
['application/json'],
|
|
7387
|
+
['application/json']
|
|
7388
|
+
);
|
|
7389
|
+
}
|
|
7390
|
+
|
|
7391
|
+
/**
|
|
7392
|
+
* Get a pageable list of grammars, filtered by query parameters
|
|
7393
|
+
* Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
|
|
7394
|
+
* @param {Object} opts Optional parameters
|
|
7395
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7396
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7397
|
+
* @param {Object} opts.sortBy Sort by (default to id)
|
|
7398
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
7399
|
+
* @param {Array.<String>} opts.id ID
|
|
7400
|
+
* @param {String} opts.name Name
|
|
7401
|
+
* @param {String} opts.description Description
|
|
7402
|
+
* @param {String} opts.nameOrDescription Name or description
|
|
7403
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
7404
|
+
* getArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7405
|
+
*/
|
|
7406
|
+
getArchitectGrammars(opts) {
|
|
7407
|
+
opts = opts || {};
|
|
7408
|
+
|
|
7409
|
+
|
|
7410
|
+
return this.apiClient.callApi(
|
|
7411
|
+
'/api/v2/architect/grammars',
|
|
7412
|
+
'GET',
|
|
7413
|
+
{ },
|
|
7414
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'includeFileUrls': opts['includeFileUrls'] },
|
|
7415
|
+
{ },
|
|
7416
|
+
{ },
|
|
7417
|
+
null,
|
|
7418
|
+
['PureCloud OAuth'],
|
|
7419
|
+
['application/json'],
|
|
7420
|
+
['application/json']
|
|
7421
|
+
);
|
|
7422
|
+
}
|
|
7423
|
+
|
|
7180
7424
|
/**
|
|
7181
7425
|
* Get an IVR config.
|
|
7182
7426
|
*
|
|
@@ -7232,6 +7476,36 @@ class ArchitectApi {
|
|
|
7232
7476
|
);
|
|
7233
7477
|
}
|
|
7234
7478
|
|
|
7479
|
+
/**
|
|
7480
|
+
* Get a pageable list of basic ivr configuration information objects filterable by query parameters.
|
|
7481
|
+
*
|
|
7482
|
+
* @param {Object} opts Optional parameters
|
|
7483
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7484
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7485
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
7486
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
7487
|
+
* @param {Array.<String>} opts.id ID of the IVR to filter by.
|
|
7488
|
+
* @param {String} opts.name Name of the IVR to filter by.
|
|
7489
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7490
|
+
*/
|
|
7491
|
+
getArchitectIvrsDivisionviews(opts) {
|
|
7492
|
+
opts = opts || {};
|
|
7493
|
+
|
|
7494
|
+
|
|
7495
|
+
return this.apiClient.callApi(
|
|
7496
|
+
'/api/v2/architect/ivrs/divisionviews',
|
|
7497
|
+
'GET',
|
|
7498
|
+
{ },
|
|
7499
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
7500
|
+
{ },
|
|
7501
|
+
{ },
|
|
7502
|
+
null,
|
|
7503
|
+
['PureCloud OAuth'],
|
|
7504
|
+
['application/json'],
|
|
7505
|
+
['application/json']
|
|
7506
|
+
);
|
|
7507
|
+
}
|
|
7508
|
+
|
|
7235
7509
|
/**
|
|
7236
7510
|
* Get specified user prompt
|
|
7237
7511
|
*
|
|
@@ -7465,6 +7739,36 @@ class ArchitectApi {
|
|
|
7465
7739
|
);
|
|
7466
7740
|
}
|
|
7467
7741
|
|
|
7742
|
+
/**
|
|
7743
|
+
* Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
|
|
7744
|
+
*
|
|
7745
|
+
* @param {Object} opts Optional parameters
|
|
7746
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7747
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7748
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
7749
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
7750
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
7751
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
7752
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7753
|
+
*/
|
|
7754
|
+
getArchitectSchedulegroupsDivisionviews(opts) {
|
|
7755
|
+
opts = opts || {};
|
|
7756
|
+
|
|
7757
|
+
|
|
7758
|
+
return this.apiClient.callApi(
|
|
7759
|
+
'/api/v2/architect/schedulegroups/divisionviews',
|
|
7760
|
+
'GET',
|
|
7761
|
+
{ },
|
|
7762
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
7763
|
+
{ },
|
|
7764
|
+
{ },
|
|
7765
|
+
null,
|
|
7766
|
+
['PureCloud OAuth'],
|
|
7767
|
+
['application/json'],
|
|
7768
|
+
['application/json']
|
|
7769
|
+
);
|
|
7770
|
+
}
|
|
7771
|
+
|
|
7468
7772
|
/**
|
|
7469
7773
|
* Get a list of schedules.
|
|
7470
7774
|
*
|
|
@@ -7494,6 +7798,36 @@ class ArchitectApi {
|
|
|
7494
7798
|
);
|
|
7495
7799
|
}
|
|
7496
7800
|
|
|
7801
|
+
/**
|
|
7802
|
+
* Get a pageable list of basic schedule configuration information objects filterable by query parameters.
|
|
7803
|
+
*
|
|
7804
|
+
* @param {Object} opts Optional parameters
|
|
7805
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7806
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7807
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
7808
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
7809
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
7810
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
7811
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7812
|
+
*/
|
|
7813
|
+
getArchitectSchedulesDivisionviews(opts) {
|
|
7814
|
+
opts = opts || {};
|
|
7815
|
+
|
|
7816
|
+
|
|
7817
|
+
return this.apiClient.callApi(
|
|
7818
|
+
'/api/v2/architect/schedules/divisionviews',
|
|
7819
|
+
'GET',
|
|
7820
|
+
{ },
|
|
7821
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
7822
|
+
{ },
|
|
7823
|
+
{ },
|
|
7824
|
+
null,
|
|
7825
|
+
['PureCloud OAuth'],
|
|
7826
|
+
['application/json'],
|
|
7827
|
+
['application/json']
|
|
7828
|
+
);
|
|
7829
|
+
}
|
|
7830
|
+
|
|
7497
7831
|
/**
|
|
7498
7832
|
* Get a system prompt
|
|
7499
7833
|
*
|
|
@@ -8504,6 +8838,36 @@ class ArchitectApi {
|
|
|
8504
8838
|
);
|
|
8505
8839
|
}
|
|
8506
8840
|
|
|
8841
|
+
/**
|
|
8842
|
+
* Updates a grammar
|
|
8843
|
+
*
|
|
8844
|
+
* @param {String} grammarId grammar ID
|
|
8845
|
+
* @param {Object} opts Optional parameters
|
|
8846
|
+
* @param {Object} opts.body
|
|
8847
|
+
* patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8848
|
+
*/
|
|
8849
|
+
patchArchitectGrammar(grammarId, opts) {
|
|
8850
|
+
opts = opts || {};
|
|
8851
|
+
|
|
8852
|
+
// verify the required parameter 'grammarId' is set
|
|
8853
|
+
if (grammarId === undefined || grammarId === null) {
|
|
8854
|
+
throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
|
|
8855
|
+
}
|
|
8856
|
+
|
|
8857
|
+
return this.apiClient.callApi(
|
|
8858
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
8859
|
+
'PATCH',
|
|
8860
|
+
{ 'grammarId': grammarId },
|
|
8861
|
+
{ },
|
|
8862
|
+
{ },
|
|
8863
|
+
{ },
|
|
8864
|
+
opts['body'],
|
|
8865
|
+
['PureCloud OAuth'],
|
|
8866
|
+
['application/json'],
|
|
8867
|
+
['application/json']
|
|
8868
|
+
);
|
|
8869
|
+
}
|
|
8870
|
+
|
|
8507
8871
|
/**
|
|
8508
8872
|
* Rebuild Dependency Tracking data for an organization
|
|
8509
8873
|
* Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
@@ -8549,6 +8913,135 @@ class ArchitectApi {
|
|
|
8549
8913
|
);
|
|
8550
8914
|
}
|
|
8551
8915
|
|
|
8916
|
+
/**
|
|
8917
|
+
* Creates a presigned URL for uploading a grammar DTMF mode file
|
|
8918
|
+
*
|
|
8919
|
+
* @param {String} grammarId Grammar ID
|
|
8920
|
+
* @param {String} languageCode Language
|
|
8921
|
+
* @param {Object} body query
|
|
8922
|
+
* postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8923
|
+
*/
|
|
8924
|
+
postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
|
|
8925
|
+
// verify the required parameter 'grammarId' is set
|
|
8926
|
+
if (grammarId === undefined || grammarId === null) {
|
|
8927
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
8928
|
+
}
|
|
8929
|
+
// verify the required parameter 'languageCode' is set
|
|
8930
|
+
if (languageCode === undefined || languageCode === null) {
|
|
8931
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
8932
|
+
}
|
|
8933
|
+
// verify the required parameter 'body' is set
|
|
8934
|
+
if (body === undefined || body === null) {
|
|
8935
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
8936
|
+
}
|
|
8937
|
+
|
|
8938
|
+
return this.apiClient.callApi(
|
|
8939
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
8940
|
+
'POST',
|
|
8941
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
8942
|
+
{ },
|
|
8943
|
+
{ },
|
|
8944
|
+
{ },
|
|
8945
|
+
body,
|
|
8946
|
+
['PureCloud OAuth'],
|
|
8947
|
+
['application/json'],
|
|
8948
|
+
['application/json']
|
|
8949
|
+
);
|
|
8950
|
+
}
|
|
8951
|
+
|
|
8952
|
+
/**
|
|
8953
|
+
* Creates a presigned URL for uploading a grammar voice mode file
|
|
8954
|
+
*
|
|
8955
|
+
* @param {String} grammarId Grammar ID
|
|
8956
|
+
* @param {String} languageCode Language
|
|
8957
|
+
* @param {Object} body query
|
|
8958
|
+
* postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8959
|
+
*/
|
|
8960
|
+
postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
|
|
8961
|
+
// verify the required parameter 'grammarId' is set
|
|
8962
|
+
if (grammarId === undefined || grammarId === null) {
|
|
8963
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
|
|
8964
|
+
}
|
|
8965
|
+
// verify the required parameter 'languageCode' is set
|
|
8966
|
+
if (languageCode === undefined || languageCode === null) {
|
|
8967
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
|
|
8968
|
+
}
|
|
8969
|
+
// verify the required parameter 'body' is set
|
|
8970
|
+
if (body === undefined || body === null) {
|
|
8971
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
|
|
8972
|
+
}
|
|
8973
|
+
|
|
8974
|
+
return this.apiClient.callApi(
|
|
8975
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
8976
|
+
'POST',
|
|
8977
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
8978
|
+
{ },
|
|
8979
|
+
{ },
|
|
8980
|
+
{ },
|
|
8981
|
+
body,
|
|
8982
|
+
['PureCloud OAuth'],
|
|
8983
|
+
['application/json'],
|
|
8984
|
+
['application/json']
|
|
8985
|
+
);
|
|
8986
|
+
}
|
|
8987
|
+
|
|
8988
|
+
/**
|
|
8989
|
+
* Create a new language for a given grammar
|
|
8990
|
+
*
|
|
8991
|
+
* @param {String} grammarId Grammar ID
|
|
8992
|
+
* @param {Object} body
|
|
8993
|
+
* postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8994
|
+
*/
|
|
8995
|
+
postArchitectGrammarLanguages(grammarId, body) {
|
|
8996
|
+
// verify the required parameter 'grammarId' is set
|
|
8997
|
+
if (grammarId === undefined || grammarId === null) {
|
|
8998
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
|
|
8999
|
+
}
|
|
9000
|
+
// verify the required parameter 'body' is set
|
|
9001
|
+
if (body === undefined || body === null) {
|
|
9002
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
|
|
9003
|
+
}
|
|
9004
|
+
|
|
9005
|
+
return this.apiClient.callApi(
|
|
9006
|
+
'/api/v2/architect/grammars/{grammarId}/languages',
|
|
9007
|
+
'POST',
|
|
9008
|
+
{ 'grammarId': grammarId },
|
|
9009
|
+
{ },
|
|
9010
|
+
{ },
|
|
9011
|
+
{ },
|
|
9012
|
+
body,
|
|
9013
|
+
['PureCloud OAuth'],
|
|
9014
|
+
['application/json'],
|
|
9015
|
+
['application/json']
|
|
9016
|
+
);
|
|
9017
|
+
}
|
|
9018
|
+
|
|
9019
|
+
/**
|
|
9020
|
+
* Create a new grammar
|
|
9021
|
+
*
|
|
9022
|
+
* @param {Object} body
|
|
9023
|
+
* postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9024
|
+
*/
|
|
9025
|
+
postArchitectGrammars(body) {
|
|
9026
|
+
// verify the required parameter 'body' is set
|
|
9027
|
+
if (body === undefined || body === null) {
|
|
9028
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammars';
|
|
9029
|
+
}
|
|
9030
|
+
|
|
9031
|
+
return this.apiClient.callApi(
|
|
9032
|
+
'/api/v2/architect/grammars',
|
|
9033
|
+
'POST',
|
|
9034
|
+
{ },
|
|
9035
|
+
{ },
|
|
9036
|
+
{ },
|
|
9037
|
+
{ },
|
|
9038
|
+
body,
|
|
9039
|
+
['PureCloud OAuth'],
|
|
9040
|
+
['application/json'],
|
|
9041
|
+
['application/json']
|
|
9042
|
+
);
|
|
9043
|
+
}
|
|
9044
|
+
|
|
8552
9045
|
/**
|
|
8553
9046
|
* Create IVR config.
|
|
8554
9047
|
*
|
|
@@ -9642,7 +10135,7 @@ class AuditApi {
|
|
|
9642
10135
|
/**
|
|
9643
10136
|
* Audit service.
|
|
9644
10137
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9645
|
-
* @version
|
|
10138
|
+
* @version 174.0.0
|
|
9646
10139
|
*/
|
|
9647
10140
|
|
|
9648
10141
|
/**
|
|
@@ -9813,7 +10306,7 @@ class AuthorizationApi {
|
|
|
9813
10306
|
/**
|
|
9814
10307
|
* Authorization service.
|
|
9815
10308
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9816
|
-
* @version
|
|
10309
|
+
* @version 174.0.0
|
|
9817
10310
|
*/
|
|
9818
10311
|
|
|
9819
10312
|
/**
|
|
@@ -11044,7 +11537,7 @@ class BillingApi {
|
|
|
11044
11537
|
/**
|
|
11045
11538
|
* Billing service.
|
|
11046
11539
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11047
|
-
* @version
|
|
11540
|
+
* @version 174.0.0
|
|
11048
11541
|
*/
|
|
11049
11542
|
|
|
11050
11543
|
/**
|
|
@@ -11124,7 +11617,7 @@ class CarrierServicesApi {
|
|
|
11124
11617
|
/**
|
|
11125
11618
|
* CarrierServices service.
|
|
11126
11619
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11127
|
-
* @version
|
|
11620
|
+
* @version 174.0.0
|
|
11128
11621
|
*/
|
|
11129
11622
|
|
|
11130
11623
|
/**
|
|
@@ -11194,7 +11687,7 @@ class ChatApi {
|
|
|
11194
11687
|
/**
|
|
11195
11688
|
* Chat service.
|
|
11196
11689
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11197
|
-
* @version
|
|
11690
|
+
* @version 174.0.0
|
|
11198
11691
|
*/
|
|
11199
11692
|
|
|
11200
11693
|
/**
|
|
@@ -11358,7 +11851,7 @@ class CoachingApi {
|
|
|
11358
11851
|
/**
|
|
11359
11852
|
* Coaching service.
|
|
11360
11853
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11361
|
-
* @version
|
|
11854
|
+
* @version 174.0.0
|
|
11362
11855
|
*/
|
|
11363
11856
|
|
|
11364
11857
|
/**
|
|
@@ -11935,7 +12428,7 @@ class ContentManagementApi {
|
|
|
11935
12428
|
/**
|
|
11936
12429
|
* ContentManagement service.
|
|
11937
12430
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11938
|
-
* @version
|
|
12431
|
+
* @version 174.0.0
|
|
11939
12432
|
*/
|
|
11940
12433
|
|
|
11941
12434
|
/**
|
|
@@ -13078,7 +13571,7 @@ class ConversationsApi {
|
|
|
13078
13571
|
/**
|
|
13079
13572
|
* Conversations service.
|
|
13080
13573
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13081
|
-
* @version
|
|
13574
|
+
* @version 174.0.0
|
|
13082
13575
|
*/
|
|
13083
13576
|
|
|
13084
13577
|
/**
|
|
@@ -13243,6 +13736,31 @@ class ConversationsApi {
|
|
|
13243
13736
|
);
|
|
13244
13737
|
}
|
|
13245
13738
|
|
|
13739
|
+
/**
|
|
13740
|
+
* Remove a cached media item asychronously
|
|
13741
|
+
*
|
|
13742
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
13743
|
+
*/
|
|
13744
|
+
deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
13745
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
13746
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
13747
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
|
|
13748
|
+
}
|
|
13749
|
+
|
|
13750
|
+
return this.apiClient.callApi(
|
|
13751
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
13752
|
+
'DELETE',
|
|
13753
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
13754
|
+
{ },
|
|
13755
|
+
{ },
|
|
13756
|
+
{ },
|
|
13757
|
+
null,
|
|
13758
|
+
['PureCloud OAuth'],
|
|
13759
|
+
['application/json'],
|
|
13760
|
+
['application/json']
|
|
13761
|
+
);
|
|
13762
|
+
}
|
|
13763
|
+
|
|
13246
13764
|
/**
|
|
13247
13765
|
* Delete a Facebook messaging integration
|
|
13248
13766
|
*
|
|
@@ -15044,7 +15562,7 @@ class ConversationsApi {
|
|
|
15044
15562
|
/**
|
|
15045
15563
|
* Get list of wrapup codes for this conversation participant
|
|
15046
15564
|
*
|
|
15047
|
-
* @param {String} conversationId
|
|
15565
|
+
* @param {String} conversationId conversationId
|
|
15048
15566
|
* @param {String} participantId participantId
|
|
15049
15567
|
*/
|
|
15050
15568
|
getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
|
|
@@ -15091,6 +15609,57 @@ class ConversationsApi {
|
|
|
15091
15609
|
);
|
|
15092
15610
|
}
|
|
15093
15611
|
|
|
15612
|
+
/**
|
|
15613
|
+
* Get a list of cached media items
|
|
15614
|
+
*
|
|
15615
|
+
* @param {Object} opts Optional parameters
|
|
15616
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15617
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15618
|
+
* @param {String} opts.url URL to search for
|
|
15619
|
+
*/
|
|
15620
|
+
getConversationsMessagesCachedmedia(opts) {
|
|
15621
|
+
opts = opts || {};
|
|
15622
|
+
|
|
15623
|
+
|
|
15624
|
+
return this.apiClient.callApi(
|
|
15625
|
+
'/api/v2/conversations/messages/cachedmedia',
|
|
15626
|
+
'GET',
|
|
15627
|
+
{ },
|
|
15628
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
|
|
15629
|
+
{ },
|
|
15630
|
+
{ },
|
|
15631
|
+
null,
|
|
15632
|
+
['PureCloud OAuth'],
|
|
15633
|
+
['application/json'],
|
|
15634
|
+
['application/json']
|
|
15635
|
+
);
|
|
15636
|
+
}
|
|
15637
|
+
|
|
15638
|
+
/**
|
|
15639
|
+
* Get a cached media item
|
|
15640
|
+
*
|
|
15641
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
15642
|
+
*/
|
|
15643
|
+
getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
15644
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
15645
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
15646
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
|
|
15647
|
+
}
|
|
15648
|
+
|
|
15649
|
+
return this.apiClient.callApi(
|
|
15650
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
15651
|
+
'GET',
|
|
15652
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
15653
|
+
{ },
|
|
15654
|
+
{ },
|
|
15655
|
+
{ },
|
|
15656
|
+
null,
|
|
15657
|
+
['PureCloud OAuth'],
|
|
15658
|
+
['application/json'],
|
|
15659
|
+
['application/json']
|
|
15660
|
+
);
|
|
15661
|
+
}
|
|
15662
|
+
|
|
15094
15663
|
/**
|
|
15095
15664
|
* Get Genesys Facebook App Id
|
|
15096
15665
|
*
|
|
@@ -15834,6 +16403,32 @@ class ConversationsApi {
|
|
|
15834
16403
|
);
|
|
15835
16404
|
}
|
|
15836
16405
|
|
|
16406
|
+
/**
|
|
16407
|
+
* Gets a record for a given meetingId
|
|
16408
|
+
*
|
|
16409
|
+
* @param {String} meetingId meetingId
|
|
16410
|
+
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16411
|
+
*/
|
|
16412
|
+
getConversationsVideosMeeting(meetingId) {
|
|
16413
|
+
// verify the required parameter 'meetingId' is set
|
|
16414
|
+
if (meetingId === undefined || meetingId === null) {
|
|
16415
|
+
throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
|
|
16416
|
+
}
|
|
16417
|
+
|
|
16418
|
+
return this.apiClient.callApi(
|
|
16419
|
+
'/api/v2/conversations/videos/meetings/{meetingId}',
|
|
16420
|
+
'GET',
|
|
16421
|
+
{ 'meetingId': meetingId },
|
|
16422
|
+
{ },
|
|
16423
|
+
{ },
|
|
16424
|
+
{ },
|
|
16425
|
+
null,
|
|
16426
|
+
['PureCloud OAuth'],
|
|
16427
|
+
['application/json'],
|
|
16428
|
+
['application/json']
|
|
16429
|
+
);
|
|
16430
|
+
}
|
|
16431
|
+
|
|
15837
16432
|
/**
|
|
15838
16433
|
* Update a participant.
|
|
15839
16434
|
* Update conversation participant.
|
|
@@ -16796,7 +17391,7 @@ class ConversationsApi {
|
|
|
16796
17391
|
/**
|
|
16797
17392
|
* Update conversation participant
|
|
16798
17393
|
*
|
|
16799
|
-
* @param {String} conversationId
|
|
17394
|
+
* @param {String} conversationId conversationId
|
|
16800
17395
|
* @param {String} participantId participantId
|
|
16801
17396
|
* @param {Object} opts Optional parameters
|
|
16802
17397
|
* @param {Object} opts.body
|
|
@@ -16830,7 +17425,7 @@ class ConversationsApi {
|
|
|
16830
17425
|
/**
|
|
16831
17426
|
* Update the attributes on a conversation participant.
|
|
16832
17427
|
*
|
|
16833
|
-
* @param {String} conversationId
|
|
17428
|
+
* @param {String} conversationId conversationId
|
|
16834
17429
|
* @param {String} participantId participantId
|
|
16835
17430
|
* @param {Object} opts Optional parameters
|
|
16836
17431
|
* @param {Object} opts.body
|
|
@@ -16864,7 +17459,7 @@ class ConversationsApi {
|
|
|
16864
17459
|
/**
|
|
16865
17460
|
* Update conversation participant's communication by disconnecting it.
|
|
16866
17461
|
*
|
|
16867
|
-
* @param {String} conversationId
|
|
17462
|
+
* @param {String} conversationId conversationId
|
|
16868
17463
|
* @param {String} participantId participantId
|
|
16869
17464
|
* @param {String} communicationId communicationId
|
|
16870
17465
|
* @param {Object} body Participant
|
|
@@ -18821,6 +19416,96 @@ class ConversationsApi {
|
|
|
18821
19416
|
);
|
|
18822
19417
|
}
|
|
18823
19418
|
|
|
19419
|
+
/**
|
|
19420
|
+
* Send an inbound Open Event Message
|
|
19421
|
+
* Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
19422
|
+
* @param {String} integrationId integrationId
|
|
19423
|
+
* @param {Object} body NormalizedMessage
|
|
19424
|
+
*/
|
|
19425
|
+
postConversationsMessageInboundOpenEvent(integrationId, body) {
|
|
19426
|
+
// verify the required parameter 'integrationId' is set
|
|
19427
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19428
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
|
|
19429
|
+
}
|
|
19430
|
+
// verify the required parameter 'body' is set
|
|
19431
|
+
if (body === undefined || body === null) {
|
|
19432
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
|
|
19433
|
+
}
|
|
19434
|
+
|
|
19435
|
+
return this.apiClient.callApi(
|
|
19436
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/event',
|
|
19437
|
+
'POST',
|
|
19438
|
+
{ 'integrationId': integrationId },
|
|
19439
|
+
{ },
|
|
19440
|
+
{ },
|
|
19441
|
+
{ },
|
|
19442
|
+
body,
|
|
19443
|
+
['PureCloud OAuth'],
|
|
19444
|
+
['application/json'],
|
|
19445
|
+
['application/json']
|
|
19446
|
+
);
|
|
19447
|
+
}
|
|
19448
|
+
|
|
19449
|
+
/**
|
|
19450
|
+
* Send inbound Open Message
|
|
19451
|
+
* Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
19452
|
+
* @param {String} integrationId integrationId
|
|
19453
|
+
* @param {Object} body NormalizedMessage
|
|
19454
|
+
*/
|
|
19455
|
+
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
19456
|
+
// verify the required parameter 'integrationId' is set
|
|
19457
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19458
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
19459
|
+
}
|
|
19460
|
+
// verify the required parameter 'body' is set
|
|
19461
|
+
if (body === undefined || body === null) {
|
|
19462
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
|
|
19463
|
+
}
|
|
19464
|
+
|
|
19465
|
+
return this.apiClient.callApi(
|
|
19466
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
19467
|
+
'POST',
|
|
19468
|
+
{ 'integrationId': integrationId },
|
|
19469
|
+
{ },
|
|
19470
|
+
{ },
|
|
19471
|
+
{ },
|
|
19472
|
+
body,
|
|
19473
|
+
['PureCloud OAuth'],
|
|
19474
|
+
['application/json'],
|
|
19475
|
+
['application/json']
|
|
19476
|
+
);
|
|
19477
|
+
}
|
|
19478
|
+
|
|
19479
|
+
/**
|
|
19480
|
+
* Send an inbound Open Receipt Message
|
|
19481
|
+
* Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
19482
|
+
* @param {String} integrationId integrationId
|
|
19483
|
+
* @param {Object} body NormalizedMessage
|
|
19484
|
+
*/
|
|
19485
|
+
postConversationsMessageInboundOpenReceipt(integrationId, body) {
|
|
19486
|
+
// verify the required parameter 'integrationId' is set
|
|
19487
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19488
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
|
|
19489
|
+
}
|
|
19490
|
+
// verify the required parameter 'body' is set
|
|
19491
|
+
if (body === undefined || body === null) {
|
|
19492
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
|
|
19493
|
+
}
|
|
19494
|
+
|
|
19495
|
+
return this.apiClient.callApi(
|
|
19496
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
|
|
19497
|
+
'POST',
|
|
19498
|
+
{ 'integrationId': integrationId },
|
|
19499
|
+
{ },
|
|
19500
|
+
{ },
|
|
19501
|
+
{ },
|
|
19502
|
+
body,
|
|
19503
|
+
['PureCloud OAuth'],
|
|
19504
|
+
['application/json'],
|
|
19505
|
+
['application/json']
|
|
19506
|
+
);
|
|
19507
|
+
}
|
|
19508
|
+
|
|
18824
19509
|
/**
|
|
18825
19510
|
* Get messages in batch
|
|
18826
19511
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
@@ -19373,6 +20058,32 @@ class ConversationsApi {
|
|
|
19373
20058
|
);
|
|
19374
20059
|
}
|
|
19375
20060
|
|
|
20061
|
+
/**
|
|
20062
|
+
* Generate a meetingId for a given conferenceId
|
|
20063
|
+
*
|
|
20064
|
+
* @param {Object} body MeetingIdRequest
|
|
20065
|
+
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20066
|
+
*/
|
|
20067
|
+
postConversationsVideosMeetings(body) {
|
|
20068
|
+
// verify the required parameter 'body' is set
|
|
20069
|
+
if (body === undefined || body === null) {
|
|
20070
|
+
throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
|
|
20071
|
+
}
|
|
20072
|
+
|
|
20073
|
+
return this.apiClient.callApi(
|
|
20074
|
+
'/api/v2/conversations/videos/meetings',
|
|
20075
|
+
'POST',
|
|
20076
|
+
{ },
|
|
20077
|
+
{ },
|
|
20078
|
+
{ },
|
|
20079
|
+
{ },
|
|
20080
|
+
body,
|
|
20081
|
+
['PureCloud OAuth'],
|
|
20082
|
+
['application/json'],
|
|
20083
|
+
['application/json']
|
|
20084
|
+
);
|
|
20085
|
+
}
|
|
20086
|
+
|
|
19376
20087
|
/**
|
|
19377
20088
|
* Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
19378
20089
|
*
|
|
@@ -19944,7 +20655,7 @@ class DataExtensionsApi {
|
|
|
19944
20655
|
/**
|
|
19945
20656
|
* DataExtensions service.
|
|
19946
20657
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19947
|
-
* @version
|
|
20658
|
+
* @version 174.0.0
|
|
19948
20659
|
*/
|
|
19949
20660
|
|
|
19950
20661
|
/**
|
|
@@ -20030,7 +20741,7 @@ class DownloadsApi {
|
|
|
20030
20741
|
/**
|
|
20031
20742
|
* Downloads service.
|
|
20032
20743
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20033
|
-
* @version
|
|
20744
|
+
* @version 174.0.0
|
|
20034
20745
|
*/
|
|
20035
20746
|
|
|
20036
20747
|
/**
|
|
@@ -20082,7 +20793,7 @@ class EmailsApi {
|
|
|
20082
20793
|
/**
|
|
20083
20794
|
* Emails service.
|
|
20084
20795
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20085
|
-
* @version
|
|
20796
|
+
* @version 174.0.0
|
|
20086
20797
|
*/
|
|
20087
20798
|
|
|
20088
20799
|
/**
|
|
@@ -20147,7 +20858,7 @@ class EventsApi {
|
|
|
20147
20858
|
/**
|
|
20148
20859
|
* Events service.
|
|
20149
20860
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20150
|
-
* @version
|
|
20861
|
+
* @version 174.0.0
|
|
20151
20862
|
*/
|
|
20152
20863
|
|
|
20153
20864
|
/**
|
|
@@ -20243,7 +20954,7 @@ class ExternalContactsApi {
|
|
|
20243
20954
|
/**
|
|
20244
20955
|
* ExternalContacts service.
|
|
20245
20956
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20246
|
-
* @version
|
|
20957
|
+
* @version 174.0.0
|
|
20247
20958
|
*/
|
|
20248
20959
|
|
|
20249
20960
|
/**
|
|
@@ -22201,7 +22912,7 @@ class FaxApi {
|
|
|
22201
22912
|
/**
|
|
22202
22913
|
* Fax service.
|
|
22203
22914
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22204
|
-
* @version
|
|
22915
|
+
* @version 174.0.0
|
|
22205
22916
|
*/
|
|
22206
22917
|
|
|
22207
22918
|
/**
|
|
@@ -22372,7 +23083,7 @@ class FlowsApi {
|
|
|
22372
23083
|
/**
|
|
22373
23084
|
* Flows service.
|
|
22374
23085
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22375
|
-
* @version
|
|
23086
|
+
* @version 174.0.0
|
|
22376
23087
|
*/
|
|
22377
23088
|
|
|
22378
23089
|
/**
|
|
@@ -22556,7 +23267,7 @@ class GamificationApi {
|
|
|
22556
23267
|
/**
|
|
22557
23268
|
* Gamification service.
|
|
22558
23269
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22559
|
-
* @version
|
|
23270
|
+
* @version 174.0.0
|
|
22560
23271
|
*/
|
|
22561
23272
|
|
|
22562
23273
|
/**
|
|
@@ -24642,7 +25353,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
24642
25353
|
/**
|
|
24643
25354
|
* GeneralDataProtectionRegulation service.
|
|
24644
25355
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24645
|
-
* @version
|
|
25356
|
+
* @version 174.0.0
|
|
24646
25357
|
*/
|
|
24647
25358
|
|
|
24648
25359
|
/**
|
|
@@ -24772,7 +25483,7 @@ class GeolocationApi {
|
|
|
24772
25483
|
/**
|
|
24773
25484
|
* Geolocation service.
|
|
24774
25485
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24775
|
-
* @version
|
|
25486
|
+
* @version 174.0.0
|
|
24776
25487
|
*/
|
|
24777
25488
|
|
|
24778
25489
|
/**
|
|
@@ -24903,7 +25614,7 @@ class GreetingsApi {
|
|
|
24903
25614
|
/**
|
|
24904
25615
|
* Greetings service.
|
|
24905
25616
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24906
|
-
* @version
|
|
25617
|
+
* @version 174.0.0
|
|
24907
25618
|
*/
|
|
24908
25619
|
|
|
24909
25620
|
/**
|
|
@@ -25358,7 +26069,7 @@ class GroupsApi {
|
|
|
25358
26069
|
/**
|
|
25359
26070
|
* Groups service.
|
|
25360
26071
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25361
|
-
* @version
|
|
26072
|
+
* @version 174.0.0
|
|
25362
26073
|
*/
|
|
25363
26074
|
|
|
25364
26075
|
/**
|
|
@@ -25877,7 +26588,7 @@ class IdentityProviderApi {
|
|
|
25877
26588
|
/**
|
|
25878
26589
|
* IdentityProvider service.
|
|
25879
26590
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25880
|
-
* @version
|
|
26591
|
+
* @version 174.0.0
|
|
25881
26592
|
*/
|
|
25882
26593
|
|
|
25883
26594
|
/**
|
|
@@ -26633,7 +27344,7 @@ class InfrastructureAsCodeApi {
|
|
|
26633
27344
|
/**
|
|
26634
27345
|
* InfrastructureAsCode service.
|
|
26635
27346
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26636
|
-
* @version
|
|
27347
|
+
* @version 174.0.0
|
|
26637
27348
|
*/
|
|
26638
27349
|
|
|
26639
27350
|
/**
|
|
@@ -26800,7 +27511,7 @@ class IntegrationsApi {
|
|
|
26800
27511
|
/**
|
|
26801
27512
|
* Integrations service.
|
|
26802
27513
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26803
|
-
* @version
|
|
27514
|
+
* @version 174.0.0
|
|
26804
27515
|
*/
|
|
26805
27516
|
|
|
26806
27517
|
/**
|
|
@@ -28762,7 +29473,7 @@ class JourneyApi {
|
|
|
28762
29473
|
/**
|
|
28763
29474
|
* Journey service.
|
|
28764
29475
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28765
|
-
* @version
|
|
29476
|
+
* @version 174.0.0
|
|
28766
29477
|
*/
|
|
28767
29478
|
|
|
28768
29479
|
/**
|
|
@@ -28962,6 +29673,37 @@ class JourneyApi {
|
|
|
28962
29673
|
);
|
|
28963
29674
|
}
|
|
28964
29675
|
|
|
29676
|
+
/**
|
|
29677
|
+
* Retrieve all sessions for a given external contact.
|
|
29678
|
+
*
|
|
29679
|
+
* @param {String} contactId ExternalContact ID
|
|
29680
|
+
* @param {Object} opts Optional parameters
|
|
29681
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
29682
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
29683
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
29684
|
+
*/
|
|
29685
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
29686
|
+
opts = opts || {};
|
|
29687
|
+
|
|
29688
|
+
// verify the required parameter 'contactId' is set
|
|
29689
|
+
if (contactId === undefined || contactId === null) {
|
|
29690
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
29691
|
+
}
|
|
29692
|
+
|
|
29693
|
+
return this.apiClient.callApi(
|
|
29694
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
29695
|
+
'GET',
|
|
29696
|
+
{ 'contactId': contactId },
|
|
29697
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
29698
|
+
{ },
|
|
29699
|
+
{ },
|
|
29700
|
+
null,
|
|
29701
|
+
['PureCloud OAuth'],
|
|
29702
|
+
['application/json'],
|
|
29703
|
+
['application/json']
|
|
29704
|
+
);
|
|
29705
|
+
}
|
|
29706
|
+
|
|
28965
29707
|
/**
|
|
28966
29708
|
* Retrieve a single action map.
|
|
28967
29709
|
*
|
|
@@ -29762,6 +30504,36 @@ class JourneyApi {
|
|
|
29762
30504
|
);
|
|
29763
30505
|
}
|
|
29764
30506
|
|
|
30507
|
+
/**
|
|
30508
|
+
* Send a journey app event, used for tracking customer activity on an application.
|
|
30509
|
+
*
|
|
30510
|
+
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
30511
|
+
* @param {Object} opts Optional parameters
|
|
30512
|
+
* @param {Object} opts.body
|
|
30513
|
+
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30514
|
+
*/
|
|
30515
|
+
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
30516
|
+
opts = opts || {};
|
|
30517
|
+
|
|
30518
|
+
// verify the required parameter 'deploymentId' is set
|
|
30519
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
30520
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
|
|
30521
|
+
}
|
|
30522
|
+
|
|
30523
|
+
return this.apiClient.callApi(
|
|
30524
|
+
'/api/v2/journey/deployments/{deploymentId}/appevents',
|
|
30525
|
+
'POST',
|
|
30526
|
+
{ 'deploymentId': deploymentId },
|
|
30527
|
+
{ },
|
|
30528
|
+
{ },
|
|
30529
|
+
{ },
|
|
30530
|
+
opts['body'],
|
|
30531
|
+
['PureCloud OAuth'],
|
|
30532
|
+
['application/json'],
|
|
30533
|
+
['application/json']
|
|
30534
|
+
);
|
|
30535
|
+
}
|
|
30536
|
+
|
|
29765
30537
|
/**
|
|
29766
30538
|
* Create an outcome.
|
|
29767
30539
|
*
|
|
@@ -29865,7 +30637,7 @@ class KnowledgeApi {
|
|
|
29865
30637
|
/**
|
|
29866
30638
|
* Knowledge service.
|
|
29867
30639
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29868
|
-
* @version
|
|
30640
|
+
* @version 174.0.0
|
|
29869
30641
|
*/
|
|
29870
30642
|
|
|
29871
30643
|
/**
|
|
@@ -30422,6 +31194,85 @@ class KnowledgeApi {
|
|
|
30422
31194
|
);
|
|
30423
31195
|
}
|
|
30424
31196
|
|
|
31197
|
+
/**
|
|
31198
|
+
* Get a list of feedback records given on a document
|
|
31199
|
+
*
|
|
31200
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31201
|
+
* @param {String} documentId Document ID.
|
|
31202
|
+
* @param {Object} opts Optional parameters
|
|
31203
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31204
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31205
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31206
|
+
* @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
|
|
31207
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
31208
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
31209
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
31210
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
31211
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
31212
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
31213
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
31214
|
+
*/
|
|
31215
|
+
getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
31216
|
+
opts = opts || {};
|
|
31217
|
+
|
|
31218
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31219
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31220
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
31221
|
+
}
|
|
31222
|
+
// verify the required parameter 'documentId' is set
|
|
31223
|
+
if (documentId === undefined || documentId === null) {
|
|
31224
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
31225
|
+
}
|
|
31226
|
+
|
|
31227
|
+
return this.apiClient.callApi(
|
|
31228
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
31229
|
+
'GET',
|
|
31230
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31231
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'onlyCommented': opts['onlyCommented'],'documentVersionId': opts['documentVersionId'],'documentVariationId': opts['documentVariationId'],'appType': opts['appType'],'queryType': opts['queryType'],'userId': opts['userId'],'queueId': opts['queueId'],'state': opts['state'] },
|
|
31232
|
+
{ },
|
|
31233
|
+
{ },
|
|
31234
|
+
null,
|
|
31235
|
+
['PureCloud OAuth'],
|
|
31236
|
+
['application/json'],
|
|
31237
|
+
['application/json']
|
|
31238
|
+
);
|
|
31239
|
+
}
|
|
31240
|
+
|
|
31241
|
+
/**
|
|
31242
|
+
* Get a single feedback record given on a document
|
|
31243
|
+
*
|
|
31244
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31245
|
+
* @param {String} documentId Document ID.
|
|
31246
|
+
* @param {String} feedbackId Feedback ID.
|
|
31247
|
+
*/
|
|
31248
|
+
getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
|
|
31249
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31250
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31251
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
31252
|
+
}
|
|
31253
|
+
// verify the required parameter 'documentId' is set
|
|
31254
|
+
if (documentId === undefined || documentId === null) {
|
|
31255
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
31256
|
+
}
|
|
31257
|
+
// verify the required parameter 'feedbackId' is set
|
|
31258
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
31259
|
+
throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
31260
|
+
}
|
|
31261
|
+
|
|
31262
|
+
return this.apiClient.callApi(
|
|
31263
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
31264
|
+
'GET',
|
|
31265
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
31266
|
+
{ },
|
|
31267
|
+
{ },
|
|
31268
|
+
{ },
|
|
31269
|
+
null,
|
|
31270
|
+
['PureCloud OAuth'],
|
|
31271
|
+
['application/json'],
|
|
31272
|
+
['application/json']
|
|
31273
|
+
);
|
|
31274
|
+
}
|
|
31275
|
+
|
|
30425
31276
|
/**
|
|
30426
31277
|
* Get a variation for a document.
|
|
30427
31278
|
*
|
|
@@ -30729,8 +31580,12 @@ class KnowledgeApi {
|
|
|
30729
31580
|
*
|
|
30730
31581
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
30731
31582
|
* @param {String} importJobId Import job ID
|
|
31583
|
+
* @param {Object} opts Optional parameters
|
|
31584
|
+
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
30732
31585
|
*/
|
|
30733
|
-
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
31586
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
|
|
31587
|
+
opts = opts || {};
|
|
31588
|
+
|
|
30734
31589
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
30735
31590
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
30736
31591
|
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
@@ -30744,7 +31599,7 @@ class KnowledgeApi {
|
|
|
30744
31599
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
30745
31600
|
'GET',
|
|
30746
31601
|
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
30747
|
-
{
|
|
31602
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
30748
31603
|
{ },
|
|
30749
31604
|
{ },
|
|
30750
31605
|
null,
|
|
@@ -31767,6 +32622,40 @@ class KnowledgeApi {
|
|
|
31767
32622
|
);
|
|
31768
32623
|
}
|
|
31769
32624
|
|
|
32625
|
+
/**
|
|
32626
|
+
* Give feedback on a document
|
|
32627
|
+
*
|
|
32628
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
32629
|
+
* @param {String} documentId Document ID.
|
|
32630
|
+
* @param {Object} opts Optional parameters
|
|
32631
|
+
* @param {Object} opts.body
|
|
32632
|
+
*/
|
|
32633
|
+
postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
|
|
32634
|
+
opts = opts || {};
|
|
32635
|
+
|
|
32636
|
+
// verify the required parameter 'sessionId' is set
|
|
32637
|
+
if (sessionId === undefined || sessionId === null) {
|
|
32638
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
32639
|
+
}
|
|
32640
|
+
// verify the required parameter 'documentId' is set
|
|
32641
|
+
if (documentId === undefined || documentId === null) {
|
|
32642
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
32643
|
+
}
|
|
32644
|
+
|
|
32645
|
+
return this.apiClient.callApi(
|
|
32646
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
|
|
32647
|
+
'POST',
|
|
32648
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
32649
|
+
{ },
|
|
32650
|
+
{ },
|
|
32651
|
+
{ },
|
|
32652
|
+
opts['body'],
|
|
32653
|
+
['PureCloud OAuth'],
|
|
32654
|
+
['application/json'],
|
|
32655
|
+
['application/json']
|
|
32656
|
+
);
|
|
32657
|
+
}
|
|
32658
|
+
|
|
31770
32659
|
/**
|
|
31771
32660
|
* Search the documents in a guest session.
|
|
31772
32661
|
*
|
|
@@ -31881,6 +32770,40 @@ class KnowledgeApi {
|
|
|
31881
32770
|
);
|
|
31882
32771
|
}
|
|
31883
32772
|
|
|
32773
|
+
/**
|
|
32774
|
+
* Give feedback on a document
|
|
32775
|
+
*
|
|
32776
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
32777
|
+
* @param {String} documentId Document ID.
|
|
32778
|
+
* @param {Object} opts Optional parameters
|
|
32779
|
+
* @param {Object} opts.body
|
|
32780
|
+
*/
|
|
32781
|
+
postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
32782
|
+
opts = opts || {};
|
|
32783
|
+
|
|
32784
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32785
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32786
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
32787
|
+
}
|
|
32788
|
+
// verify the required parameter 'documentId' is set
|
|
32789
|
+
if (documentId === undefined || documentId === null) {
|
|
32790
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
32791
|
+
}
|
|
32792
|
+
|
|
32793
|
+
return this.apiClient.callApi(
|
|
32794
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
32795
|
+
'POST',
|
|
32796
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
32797
|
+
{ },
|
|
32798
|
+
{ },
|
|
32799
|
+
{ },
|
|
32800
|
+
opts['body'],
|
|
32801
|
+
['PureCloud OAuth'],
|
|
32802
|
+
['application/json'],
|
|
32803
|
+
['application/json']
|
|
32804
|
+
);
|
|
32805
|
+
}
|
|
32806
|
+
|
|
31884
32807
|
/**
|
|
31885
32808
|
* Create a variation for a document.
|
|
31886
32809
|
*
|
|
@@ -31951,6 +32874,40 @@ class KnowledgeApi {
|
|
|
31951
32874
|
);
|
|
31952
32875
|
}
|
|
31953
32876
|
|
|
32877
|
+
/**
|
|
32878
|
+
* Create view for a document.
|
|
32879
|
+
*
|
|
32880
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
32881
|
+
* @param {String} documentId Document ID.
|
|
32882
|
+
* @param {Object} opts Optional parameters
|
|
32883
|
+
* @param {Object} opts.body
|
|
32884
|
+
*/
|
|
32885
|
+
postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
|
|
32886
|
+
opts = opts || {};
|
|
32887
|
+
|
|
32888
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32889
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32890
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
32891
|
+
}
|
|
32892
|
+
// verify the required parameter 'documentId' is set
|
|
32893
|
+
if (documentId === undefined || documentId === null) {
|
|
32894
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
32895
|
+
}
|
|
32896
|
+
|
|
32897
|
+
return this.apiClient.callApi(
|
|
32898
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
|
|
32899
|
+
'POST',
|
|
32900
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
32901
|
+
{ },
|
|
32902
|
+
{ },
|
|
32903
|
+
{ },
|
|
32904
|
+
opts['body'],
|
|
32905
|
+
['PureCloud OAuth'],
|
|
32906
|
+
['application/json'],
|
|
32907
|
+
['application/json']
|
|
32908
|
+
);
|
|
32909
|
+
}
|
|
32910
|
+
|
|
31954
32911
|
/**
|
|
31955
32912
|
* Create document.
|
|
31956
32913
|
*
|
|
@@ -32501,7 +33458,7 @@ class LanguageUnderstandingApi {
|
|
|
32501
33458
|
/**
|
|
32502
33459
|
* LanguageUnderstanding service.
|
|
32503
33460
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32504
|
-
* @version
|
|
33461
|
+
* @version 174.0.0
|
|
32505
33462
|
*/
|
|
32506
33463
|
|
|
32507
33464
|
/**
|
|
@@ -33514,7 +34471,7 @@ class LanguagesApi {
|
|
|
33514
34471
|
/**
|
|
33515
34472
|
* Languages service.
|
|
33516
34473
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33517
|
-
* @version
|
|
34474
|
+
* @version 174.0.0
|
|
33518
34475
|
*/
|
|
33519
34476
|
|
|
33520
34477
|
/**
|
|
@@ -33736,7 +34693,7 @@ class LearningApi {
|
|
|
33736
34693
|
/**
|
|
33737
34694
|
* Learning service.
|
|
33738
34695
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33739
|
-
* @version
|
|
34696
|
+
* @version 174.0.0
|
|
33740
34697
|
*/
|
|
33741
34698
|
|
|
33742
34699
|
/**
|
|
@@ -34551,7 +35508,7 @@ class LicenseApi {
|
|
|
34551
35508
|
/**
|
|
34552
35509
|
* License service.
|
|
34553
35510
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34554
|
-
* @version
|
|
35511
|
+
* @version 174.0.0
|
|
34555
35512
|
*/
|
|
34556
35513
|
|
|
34557
35514
|
/**
|
|
@@ -34789,7 +35746,7 @@ class LocationsApi {
|
|
|
34789
35746
|
/**
|
|
34790
35747
|
* Locations service.
|
|
34791
35748
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34792
|
-
* @version
|
|
35749
|
+
* @version 174.0.0
|
|
34793
35750
|
*/
|
|
34794
35751
|
|
|
34795
35752
|
/**
|
|
@@ -35025,7 +35982,7 @@ class MessagingApi {
|
|
|
35025
35982
|
/**
|
|
35026
35983
|
* Messaging service.
|
|
35027
35984
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
35028
|
-
* @version
|
|
35985
|
+
* @version 174.0.0
|
|
35029
35986
|
*/
|
|
35030
35987
|
|
|
35031
35988
|
/**
|
|
@@ -35384,7 +36341,7 @@ class MobileDevicesApi {
|
|
|
35384
36341
|
/**
|
|
35385
36342
|
* MobileDevices service.
|
|
35386
36343
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35387
|
-
* @version
|
|
36344
|
+
* @version 174.0.0
|
|
35388
36345
|
*/
|
|
35389
36346
|
|
|
35390
36347
|
/**
|
|
@@ -35535,7 +36492,7 @@ class NotificationsApi {
|
|
|
35535
36492
|
/**
|
|
35536
36493
|
* Notifications service.
|
|
35537
36494
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35538
|
-
* @version
|
|
36495
|
+
* @version 174.0.0
|
|
35539
36496
|
*/
|
|
35540
36497
|
|
|
35541
36498
|
/**
|
|
@@ -35768,7 +36725,7 @@ class OAuthApi {
|
|
|
35768
36725
|
/**
|
|
35769
36726
|
* OAuth service.
|
|
35770
36727
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35771
|
-
* @version
|
|
36728
|
+
* @version 174.0.0
|
|
35772
36729
|
*/
|
|
35773
36730
|
|
|
35774
36731
|
/**
|
|
@@ -36134,7 +37091,7 @@ class ObjectsApi {
|
|
|
36134
37091
|
/**
|
|
36135
37092
|
* Objects service.
|
|
36136
37093
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36137
|
-
* @version
|
|
37094
|
+
* @version 174.0.0
|
|
36138
37095
|
*/
|
|
36139
37096
|
|
|
36140
37097
|
/**
|
|
@@ -36405,7 +37362,7 @@ class OrganizationApi {
|
|
|
36405
37362
|
/**
|
|
36406
37363
|
* Organization service.
|
|
36407
37364
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36408
|
-
* @version
|
|
37365
|
+
* @version 174.0.0
|
|
36409
37366
|
*/
|
|
36410
37367
|
|
|
36411
37368
|
/**
|
|
@@ -36860,7 +37817,7 @@ class OrganizationAuthorizationApi {
|
|
|
36860
37817
|
/**
|
|
36861
37818
|
* OrganizationAuthorization service.
|
|
36862
37819
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36863
|
-
* @version
|
|
37820
|
+
* @version 174.0.0
|
|
36864
37821
|
*/
|
|
36865
37822
|
|
|
36866
37823
|
/**
|
|
@@ -38207,7 +39164,7 @@ class OutboundApi {
|
|
|
38207
39164
|
/**
|
|
38208
39165
|
* Outbound service.
|
|
38209
39166
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38210
|
-
* @version
|
|
39167
|
+
* @version 174.0.0
|
|
38211
39168
|
*/
|
|
38212
39169
|
|
|
38213
39170
|
/**
|
|
@@ -41829,7 +42786,7 @@ class PresenceApi {
|
|
|
41829
42786
|
/**
|
|
41830
42787
|
* Presence service.
|
|
41831
42788
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
41832
|
-
* @version
|
|
42789
|
+
* @version 174.0.0
|
|
41833
42790
|
*/
|
|
41834
42791
|
|
|
41835
42792
|
/**
|
|
@@ -42568,7 +43525,7 @@ class ProcessAutomationApi {
|
|
|
42568
43525
|
/**
|
|
42569
43526
|
* ProcessAutomation service.
|
|
42570
43527
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
42571
|
-
* @version
|
|
43528
|
+
* @version 174.0.0
|
|
42572
43529
|
*/
|
|
42573
43530
|
|
|
42574
43531
|
/**
|
|
@@ -42807,7 +43764,7 @@ class QualityApi {
|
|
|
42807
43764
|
/**
|
|
42808
43765
|
* Quality service.
|
|
42809
43766
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
42810
|
-
* @version
|
|
43767
|
+
* @version 174.0.0
|
|
42811
43768
|
*/
|
|
42812
43769
|
|
|
42813
43770
|
/**
|
|
@@ -43090,6 +44047,7 @@ class QualityApi {
|
|
|
43090
44047
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
43091
44048
|
* @param {String} opts.name name
|
|
43092
44049
|
* @param {String} opts.group group id
|
|
44050
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
43093
44051
|
*/
|
|
43094
44052
|
getQualityAgentsActivity(opts) {
|
|
43095
44053
|
opts = opts || {};
|
|
@@ -43099,7 +44057,7 @@ class QualityApi {
|
|
|
43099
44057
|
'/api/v2/quality/agents/activity',
|
|
43100
44058
|
'GET',
|
|
43101
44059
|
{ },
|
|
43102
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'] },
|
|
44060
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'formContextId': opts['formContextId'] },
|
|
43103
44061
|
{ },
|
|
43104
44062
|
{ },
|
|
43105
44063
|
null,
|
|
@@ -43297,9 +44255,9 @@ class QualityApi {
|
|
|
43297
44255
|
* @param {Object} opts Optional parameters
|
|
43298
44256
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
43299
44257
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
43300
|
-
* @param {String} opts.sortBy
|
|
44258
|
+
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
43301
44259
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
43302
|
-
* @param {String} opts.nextPage
|
|
44260
|
+
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
43303
44261
|
* @param {String} opts.previousPage Previous page token
|
|
43304
44262
|
* @param {String} opts.conversationId conversationId specified
|
|
43305
44263
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -43308,12 +44266,13 @@ class QualityApi {
|
|
|
43308
44266
|
* @param {String} opts.queueId queue id
|
|
43309
44267
|
* @param {String} opts.startTime start time of the evaluation query
|
|
43310
44268
|
* @param {String} opts.endTime end time of the evaluation query
|
|
44269
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
43311
44270
|
* @param {Array.<String>} opts.evaluationState
|
|
43312
44271
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
43313
44272
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
43314
44273
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
43315
|
-
* @param {Number} opts.maximum maximum
|
|
43316
|
-
* @param {String} opts.sortOrder
|
|
44274
|
+
* @param {Number} opts.maximum the maximum number of results to return
|
|
44275
|
+
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
43317
44276
|
*/
|
|
43318
44277
|
getQualityEvaluationsQuery(opts) {
|
|
43319
44278
|
opts = opts || {};
|
|
@@ -43323,7 +44282,7 @@ class QualityApi {
|
|
|
43323
44282
|
'/api/v2/quality/evaluations/query',
|
|
43324
44283
|
'GET',
|
|
43325
44284
|
{ },
|
|
43326
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
44285
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
43327
44286
|
{ },
|
|
43328
44287
|
{ },
|
|
43329
44288
|
null,
|
|
@@ -44400,7 +45359,7 @@ class QualityApi {
|
|
|
44400
45359
|
* @param {String} evaluationId evaluationId
|
|
44401
45360
|
* @param {Object} body evaluation
|
|
44402
45361
|
* @param {Object} opts Optional parameters
|
|
44403
|
-
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
45362
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
|
|
44404
45363
|
*/
|
|
44405
45364
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
44406
45365
|
opts = opts || {};
|
|
@@ -44559,7 +45518,7 @@ class RecordingApi {
|
|
|
44559
45518
|
/**
|
|
44560
45519
|
* Recording service.
|
|
44561
45520
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44562
|
-
* @version
|
|
45521
|
+
* @version 174.0.0
|
|
44563
45522
|
*/
|
|
44564
45523
|
|
|
44565
45524
|
/**
|
|
@@ -46196,7 +47155,7 @@ class ResponseManagementApi {
|
|
|
46196
47155
|
/**
|
|
46197
47156
|
* ResponseManagement service.
|
|
46198
47157
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46199
|
-
* @version
|
|
47158
|
+
* @version 174.0.0
|
|
46200
47159
|
*/
|
|
46201
47160
|
|
|
46202
47161
|
/**
|
|
@@ -46681,7 +47640,7 @@ class RoutingApi {
|
|
|
46681
47640
|
/**
|
|
46682
47641
|
* Routing service.
|
|
46683
47642
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46684
|
-
* @version
|
|
47643
|
+
* @version 174.0.0
|
|
46685
47644
|
*/
|
|
46686
47645
|
|
|
46687
47646
|
/**
|
|
@@ -47688,6 +48647,7 @@ class RoutingApi {
|
|
|
47688
48647
|
*
|
|
47689
48648
|
* @param {Object} opts Optional parameters
|
|
47690
48649
|
* @param {Object} opts.messengerType Messenger Type
|
|
48650
|
+
* @param {String} opts.name Recipient Name
|
|
47691
48651
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47692
48652
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47693
48653
|
*/
|
|
@@ -47699,7 +48659,7 @@ class RoutingApi {
|
|
|
47699
48659
|
'/api/v2/routing/message/recipients',
|
|
47700
48660
|
'GET',
|
|
47701
48661
|
{ },
|
|
47702
|
-
{ 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
48662
|
+
{ 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
47703
48663
|
{ },
|
|
47704
48664
|
{ },
|
|
47705
48665
|
null,
|
|
@@ -47990,10 +48950,10 @@ class RoutingApi {
|
|
|
47990
48950
|
* @param {Number} opts.pageSize Max value is 100 (default to 25)
|
|
47991
48951
|
* @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
|
|
47992
48952
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
47993
|
-
* @param {String} opts.name Filter by queue member name
|
|
47994
|
-
* @param {Array.<String>} opts.profileSkills Filter by profile skill
|
|
47995
|
-
* @param {Array.<String>} opts.skills Filter by skill
|
|
47996
|
-
* @param {Array.<String>} opts.languages Filter by language
|
|
48953
|
+
* @param {String} opts.name Filter by queue member name (contains-style search)
|
|
48954
|
+
* @param {Array.<String>} opts.profileSkills Filter by profile skill (contains-style search)
|
|
48955
|
+
* @param {Array.<String>} opts.skills Filter by skill (contains-style search)
|
|
48956
|
+
* @param {Array.<String>} opts.languages Filter by language (contains-style search)
|
|
47997
48957
|
* @param {Array.<String>} opts.routingStatus Filter by routing status
|
|
47998
48958
|
* @param {Array.<String>} opts.presence Filter by presence
|
|
47999
48959
|
* @param {Object} opts.memberBy Filter by member type
|
|
@@ -50388,7 +51348,7 @@ class SCIMApi {
|
|
|
50388
51348
|
/**
|
|
50389
51349
|
* SCIM service.
|
|
50390
51350
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50391
|
-
* @version
|
|
51351
|
+
* @version 174.0.0
|
|
50392
51352
|
*/
|
|
50393
51353
|
|
|
50394
51354
|
/**
|
|
@@ -51265,7 +52225,7 @@ class ScriptsApi {
|
|
|
51265
52225
|
/**
|
|
51266
52226
|
* Scripts service.
|
|
51267
52227
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51268
|
-
* @version
|
|
52228
|
+
* @version 174.0.0
|
|
51269
52229
|
*/
|
|
51270
52230
|
|
|
51271
52231
|
/**
|
|
@@ -51709,7 +52669,7 @@ class SearchApi {
|
|
|
51709
52669
|
/**
|
|
51710
52670
|
* Search service.
|
|
51711
52671
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51712
|
-
* @version
|
|
52672
|
+
* @version 174.0.0
|
|
51713
52673
|
*/
|
|
51714
52674
|
|
|
51715
52675
|
/**
|
|
@@ -52398,7 +53358,7 @@ class SettingsApi {
|
|
|
52398
53358
|
/**
|
|
52399
53359
|
* Settings service.
|
|
52400
53360
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
52401
|
-
* @version
|
|
53361
|
+
* @version 174.0.0
|
|
52402
53362
|
*/
|
|
52403
53363
|
|
|
52404
53364
|
/**
|
|
@@ -52463,7 +53423,7 @@ class SpeechTextAnalyticsApi {
|
|
|
52463
53423
|
/**
|
|
52464
53424
|
* SpeechTextAnalytics service.
|
|
52465
53425
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52466
|
-
* @version
|
|
53426
|
+
* @version 174.0.0
|
|
52467
53427
|
*/
|
|
52468
53428
|
|
|
52469
53429
|
/**
|
|
@@ -53446,7 +54406,7 @@ class StationsApi {
|
|
|
53446
54406
|
/**
|
|
53447
54407
|
* Stations service.
|
|
53448
54408
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
53449
|
-
* @version
|
|
54409
|
+
* @version 174.0.0
|
|
53450
54410
|
*/
|
|
53451
54411
|
|
|
53452
54412
|
/**
|
|
@@ -53548,7 +54508,7 @@ class SuggestApi {
|
|
|
53548
54508
|
/**
|
|
53549
54509
|
* Suggest service.
|
|
53550
54510
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53551
|
-
* @version
|
|
54511
|
+
* @version 174.0.0
|
|
53552
54512
|
*/
|
|
53553
54513
|
|
|
53554
54514
|
/**
|
|
@@ -53687,7 +54647,7 @@ class TaskManagementApi {
|
|
|
53687
54647
|
/**
|
|
53688
54648
|
* TaskManagement service.
|
|
53689
54649
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
53690
|
-
* @version
|
|
54650
|
+
* @version 174.0.0
|
|
53691
54651
|
*/
|
|
53692
54652
|
|
|
53693
54653
|
/**
|
|
@@ -54968,7 +55928,7 @@ class TeamsApi {
|
|
|
54968
55928
|
/**
|
|
54969
55929
|
* Teams service.
|
|
54970
55930
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
54971
|
-
* @version
|
|
55931
|
+
* @version 174.0.0
|
|
54972
55932
|
*/
|
|
54973
55933
|
|
|
54974
55934
|
/**
|
|
@@ -55270,7 +56230,7 @@ class TelephonyApi {
|
|
|
55270
56230
|
/**
|
|
55271
56231
|
* Telephony service.
|
|
55272
56232
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
55273
|
-
* @version
|
|
56233
|
+
* @version 174.0.0
|
|
55274
56234
|
*/
|
|
55275
56235
|
|
|
55276
56236
|
/**
|
|
@@ -55398,7 +56358,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
55398
56358
|
/**
|
|
55399
56359
|
* TelephonyProvidersEdge service.
|
|
55400
56360
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
55401
|
-
* @version
|
|
56361
|
+
* @version 174.0.0
|
|
55402
56362
|
*/
|
|
55403
56363
|
|
|
55404
56364
|
/**
|
|
@@ -57061,7 +58021,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
57061
58021
|
}
|
|
57062
58022
|
|
|
57063
58023
|
/**
|
|
57064
|
-
* Get a list of Phone Instances
|
|
58024
|
+
* Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.
|
|
57065
58025
|
*
|
|
57066
58026
|
* @param {Object} opts Optional parameters
|
|
57067
58027
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -58687,7 +59647,7 @@ class TextbotsApi {
|
|
|
58687
59647
|
/**
|
|
58688
59648
|
* Textbots service.
|
|
58689
59649
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
58690
|
-
* @version
|
|
59650
|
+
* @version 174.0.0
|
|
58691
59651
|
*/
|
|
58692
59652
|
|
|
58693
59653
|
/**
|
|
@@ -58815,7 +59775,7 @@ class TokensApi {
|
|
|
58815
59775
|
/**
|
|
58816
59776
|
* Tokens service.
|
|
58817
59777
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
58818
|
-
* @version
|
|
59778
|
+
* @version 174.0.0
|
|
58819
59779
|
*/
|
|
58820
59780
|
|
|
58821
59781
|
/**
|
|
@@ -58878,14 +59838,18 @@ class TokensApi {
|
|
|
58878
59838
|
/**
|
|
58879
59839
|
* Fetch information about the current token
|
|
58880
59840
|
*
|
|
59841
|
+
* @param {Object} opts Optional parameters
|
|
59842
|
+
* @param {Boolean} opts.preserveIdleTTL preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset.
|
|
58881
59843
|
*/
|
|
58882
|
-
getTokensMe() {
|
|
59844
|
+
getTokensMe(opts) {
|
|
59845
|
+
opts = opts || {};
|
|
59846
|
+
|
|
58883
59847
|
|
|
58884
59848
|
return this.apiClient.callApi(
|
|
58885
59849
|
'/api/v2/tokens/me',
|
|
58886
59850
|
'GET',
|
|
58887
59851
|
{ },
|
|
58888
|
-
{
|
|
59852
|
+
{ 'preserveIdleTTL': opts['preserveIdleTTL'] },
|
|
58889
59853
|
{ },
|
|
58890
59854
|
{ },
|
|
58891
59855
|
null,
|
|
@@ -58967,7 +59931,7 @@ class UploadsApi {
|
|
|
58967
59931
|
/**
|
|
58968
59932
|
* Uploads service.
|
|
58969
59933
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
58970
|
-
* @version
|
|
59934
|
+
* @version 174.0.0
|
|
58971
59935
|
*/
|
|
58972
59936
|
|
|
58973
59937
|
/**
|
|
@@ -59143,7 +60107,7 @@ class UsageApi {
|
|
|
59143
60107
|
/**
|
|
59144
60108
|
* Usage service.
|
|
59145
60109
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
59146
|
-
* @version
|
|
60110
|
+
* @version 174.0.0
|
|
59147
60111
|
*/
|
|
59148
60112
|
|
|
59149
60113
|
/**
|
|
@@ -59353,7 +60317,7 @@ class UserRecordingsApi {
|
|
|
59353
60317
|
/**
|
|
59354
60318
|
* UserRecordings service.
|
|
59355
60319
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
59356
|
-
* @version
|
|
60320
|
+
* @version 174.0.0
|
|
59357
60321
|
*/
|
|
59358
60322
|
|
|
59359
60323
|
/**
|
|
@@ -59538,7 +60502,7 @@ class UsersApi {
|
|
|
59538
60502
|
/**
|
|
59539
60503
|
* Users service.
|
|
59540
60504
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
59541
|
-
* @version
|
|
60505
|
+
* @version 174.0.0
|
|
59542
60506
|
*/
|
|
59543
60507
|
|
|
59544
60508
|
/**
|
|
@@ -62099,7 +63063,7 @@ class UtilitiesApi {
|
|
|
62099
63063
|
/**
|
|
62100
63064
|
* Utilities service.
|
|
62101
63065
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
62102
|
-
* @version
|
|
63066
|
+
* @version 174.0.0
|
|
62103
63067
|
*/
|
|
62104
63068
|
|
|
62105
63069
|
/**
|
|
@@ -62210,7 +63174,7 @@ class VoicemailApi {
|
|
|
62210
63174
|
/**
|
|
62211
63175
|
* Voicemail service.
|
|
62212
63176
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
62213
|
-
* @version
|
|
63177
|
+
* @version 174.0.0
|
|
62214
63178
|
*/
|
|
62215
63179
|
|
|
62216
63180
|
/**
|
|
@@ -62877,7 +63841,7 @@ class WebChatApi {
|
|
|
62877
63841
|
/**
|
|
62878
63842
|
* WebChat service.
|
|
62879
63843
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
62880
|
-
* @version
|
|
63844
|
+
* @version 174.0.0
|
|
62881
63845
|
*/
|
|
62882
63846
|
|
|
62883
63847
|
/**
|
|
@@ -63426,7 +64390,7 @@ class WebDeploymentsApi {
|
|
|
63426
64390
|
/**
|
|
63427
64391
|
* WebDeployments service.
|
|
63428
64392
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
63429
|
-
* @version
|
|
64393
|
+
* @version 174.0.0
|
|
63430
64394
|
*/
|
|
63431
64395
|
|
|
63432
64396
|
/**
|
|
@@ -63654,8 +64618,12 @@ class WebDeploymentsApi {
|
|
|
63654
64618
|
* Get a deployment
|
|
63655
64619
|
*
|
|
63656
64620
|
* @param {String} deploymentId The deployment ID
|
|
64621
|
+
* @param {Object} opts Optional parameters
|
|
64622
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
63657
64623
|
*/
|
|
63658
|
-
getWebdeploymentsDeployment(deploymentId) {
|
|
64624
|
+
getWebdeploymentsDeployment(deploymentId, opts) {
|
|
64625
|
+
opts = opts || {};
|
|
64626
|
+
|
|
63659
64627
|
// verify the required parameter 'deploymentId' is set
|
|
63660
64628
|
if (deploymentId === undefined || deploymentId === null) {
|
|
63661
64629
|
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
|
|
@@ -63665,7 +64633,7 @@ class WebDeploymentsApi {
|
|
|
63665
64633
|
'/api/v2/webdeployments/deployments/{deploymentId}',
|
|
63666
64634
|
'GET',
|
|
63667
64635
|
{ 'deploymentId': deploymentId },
|
|
63668
|
-
{
|
|
64636
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63669
64637
|
{ },
|
|
63670
64638
|
{ },
|
|
63671
64639
|
null,
|
|
@@ -63711,6 +64679,7 @@ class WebDeploymentsApi {
|
|
|
63711
64679
|
* @param {String} deploymentId The deployment ID
|
|
63712
64680
|
* @param {Object} opts Optional parameters
|
|
63713
64681
|
* @param {String} opts.type Get active configuration on a deployment
|
|
64682
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
63714
64683
|
*/
|
|
63715
64684
|
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
63716
64685
|
opts = opts || {};
|
|
@@ -63724,7 +64693,7 @@ class WebDeploymentsApi {
|
|
|
63724
64693
|
'/api/v2/webdeployments/deployments/{deploymentId}/configurations',
|
|
63725
64694
|
'GET',
|
|
63726
64695
|
{ 'deploymentId': deploymentId },
|
|
63727
|
-
{ 'type': opts['type'] },
|
|
64696
|
+
{ 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63728
64697
|
{ },
|
|
63729
64698
|
{ },
|
|
63730
64699
|
null,
|
|
@@ -63738,7 +64707,7 @@ class WebDeploymentsApi {
|
|
|
63738
64707
|
* Get deployments
|
|
63739
64708
|
*
|
|
63740
64709
|
* @param {Object} opts Optional parameters
|
|
63741
|
-
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
64710
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
63742
64711
|
*/
|
|
63743
64712
|
getWebdeploymentsDeployments(opts) {
|
|
63744
64713
|
opts = opts || {};
|
|
@@ -63948,7 +64917,7 @@ class WebMessagingApi {
|
|
|
63948
64917
|
/**
|
|
63949
64918
|
* WebMessaging service.
|
|
63950
64919
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
63951
|
-
* @version
|
|
64920
|
+
* @version 174.0.0
|
|
63952
64921
|
*/
|
|
63953
64922
|
|
|
63954
64923
|
/**
|
|
@@ -63994,7 +64963,7 @@ class WidgetsApi {
|
|
|
63994
64963
|
/**
|
|
63995
64964
|
* Widgets service.
|
|
63996
64965
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
63997
|
-
* @version
|
|
64966
|
+
* @version 174.0.0
|
|
63998
64967
|
*/
|
|
63999
64968
|
|
|
64000
64969
|
/**
|
|
@@ -64140,7 +65109,7 @@ class WorkforceManagementApi {
|
|
|
64140
65109
|
/**
|
|
64141
65110
|
* WorkforceManagement service.
|
|
64142
65111
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
64143
|
-
* @version
|
|
65112
|
+
* @version 174.0.0
|
|
64144
65113
|
*/
|
|
64145
65114
|
|
|
64146
65115
|
/**
|
|
@@ -65059,8 +66028,12 @@ class WorkforceManagementApi {
|
|
|
65059
66028
|
*
|
|
65060
66029
|
* @param {String} businessUnitId The ID of the business unit.
|
|
65061
66030
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
|
|
66031
|
+
* @param {Object} opts Optional parameters
|
|
66032
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
65062
66033
|
*/
|
|
65063
|
-
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) {
|
|
66034
|
+
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) {
|
|
66035
|
+
opts = opts || {};
|
|
66036
|
+
|
|
65064
66037
|
// verify the required parameter 'businessUnitId' is set
|
|
65065
66038
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
65066
66039
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -65074,7 +66047,7 @@ class WorkforceManagementApi {
|
|
|
65074
66047
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
65075
66048
|
'GET',
|
|
65076
66049
|
{ 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
|
|
65077
|
-
{
|
|
66050
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
65078
66051
|
{ },
|
|
65079
66052
|
{ },
|
|
65080
66053
|
null,
|
|
@@ -65088,8 +66061,12 @@ class WorkforceManagementApi {
|
|
|
65088
66061
|
* Gets list of service goal templates
|
|
65089
66062
|
*
|
|
65090
66063
|
* @param {String} businessUnitId The ID of the business unit.
|
|
66064
|
+
* @param {Object} opts Optional parameters
|
|
66065
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
65091
66066
|
*/
|
|
65092
|
-
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) {
|
|
66067
|
+
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) {
|
|
66068
|
+
opts = opts || {};
|
|
66069
|
+
|
|
65093
66070
|
// verify the required parameter 'businessUnitId' is set
|
|
65094
66071
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
65095
66072
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
@@ -65099,7 +66076,7 @@ class WorkforceManagementApi {
|
|
|
65099
66076
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
65100
66077
|
'GET',
|
|
65101
66078
|
{ 'businessUnitId': businessUnitId },
|
|
65102
|
-
{
|
|
66079
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
65103
66080
|
{ },
|
|
65104
66081
|
{ },
|
|
65105
66082
|
null,
|
|
@@ -65649,6 +66626,51 @@ class WorkforceManagementApi {
|
|
|
65649
66626
|
);
|
|
65650
66627
|
}
|
|
65651
66628
|
|
|
66629
|
+
/**
|
|
66630
|
+
* Get integrations
|
|
66631
|
+
*
|
|
66632
|
+
*/
|
|
66633
|
+
getWorkforcemanagementIntegrationsHris() {
|
|
66634
|
+
|
|
66635
|
+
return this.apiClient.callApi(
|
|
66636
|
+
'/api/v2/workforcemanagement/integrations/hris',
|
|
66637
|
+
'GET',
|
|
66638
|
+
{ },
|
|
66639
|
+
{ },
|
|
66640
|
+
{ },
|
|
66641
|
+
{ },
|
|
66642
|
+
null,
|
|
66643
|
+
['PureCloud OAuth'],
|
|
66644
|
+
['application/json'],
|
|
66645
|
+
['application/json']
|
|
66646
|
+
);
|
|
66647
|
+
}
|
|
66648
|
+
|
|
66649
|
+
/**
|
|
66650
|
+
* Query the results of time off types job
|
|
66651
|
+
*
|
|
66652
|
+
* @param {String} jobId The ID of the job.
|
|
66653
|
+
*/
|
|
66654
|
+
getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) {
|
|
66655
|
+
// verify the required parameter 'jobId' is set
|
|
66656
|
+
if (jobId === undefined || jobId === null) {
|
|
66657
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
|
|
66658
|
+
}
|
|
66659
|
+
|
|
66660
|
+
return this.apiClient.callApi(
|
|
66661
|
+
'/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}',
|
|
66662
|
+
'GET',
|
|
66663
|
+
{ 'jobId': jobId },
|
|
66664
|
+
{ },
|
|
66665
|
+
{ },
|
|
66666
|
+
{ },
|
|
66667
|
+
null,
|
|
66668
|
+
['PureCloud OAuth'],
|
|
66669
|
+
['application/json'],
|
|
66670
|
+
['application/json']
|
|
66671
|
+
);
|
|
66672
|
+
}
|
|
66673
|
+
|
|
65652
66674
|
/**
|
|
65653
66675
|
* Get management unit
|
|
65654
66676
|
* settings.shortTermForecasting is deprecated and now lives on the business unit
|
|
@@ -65679,7 +66701,7 @@ class WorkforceManagementApi {
|
|
|
65679
66701
|
}
|
|
65680
66702
|
|
|
65681
66703
|
/**
|
|
65682
|
-
* Get activity codes
|
|
66704
|
+
* Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
|
|
65683
66705
|
*
|
|
65684
66706
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
65685
66707
|
* @deprecated
|
|
@@ -66462,6 +67484,31 @@ class WorkforceManagementApi {
|
|
|
66462
67484
|
);
|
|
66463
67485
|
}
|
|
66464
67486
|
|
|
67487
|
+
/**
|
|
67488
|
+
* Query the results of time off types job
|
|
67489
|
+
*
|
|
67490
|
+
* @param {String} jobId The ID of the job.
|
|
67491
|
+
*/
|
|
67492
|
+
getWorkforcemanagementTimeoffbalanceJob(jobId) {
|
|
67493
|
+
// verify the required parameter 'jobId' is set
|
|
67494
|
+
if (jobId === undefined || jobId === null) {
|
|
67495
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
|
|
67496
|
+
}
|
|
67497
|
+
|
|
67498
|
+
return this.apiClient.callApi(
|
|
67499
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}',
|
|
67500
|
+
'GET',
|
|
67501
|
+
{ 'jobId': jobId },
|
|
67502
|
+
{ },
|
|
67503
|
+
{ },
|
|
67504
|
+
{ },
|
|
67505
|
+
null,
|
|
67506
|
+
['PureCloud OAuth'],
|
|
67507
|
+
['application/json'],
|
|
67508
|
+
['application/json']
|
|
67509
|
+
);
|
|
67510
|
+
}
|
|
67511
|
+
|
|
66465
67512
|
/**
|
|
66466
67513
|
* Get a time off request for the current user
|
|
66467
67514
|
*
|
|
@@ -66833,6 +67880,45 @@ class WorkforceManagementApi {
|
|
|
66833
67880
|
);
|
|
66834
67881
|
}
|
|
66835
67882
|
|
|
67883
|
+
/**
|
|
67884
|
+
* Set integration status for a time off request.
|
|
67885
|
+
*
|
|
67886
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
67887
|
+
* @param {String} timeOffRequestId The ID of the time off request.
|
|
67888
|
+
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
67889
|
+
* @param {Object} opts Optional parameters
|
|
67890
|
+
* @param {Object} opts.body body
|
|
67891
|
+
*/
|
|
67892
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) {
|
|
67893
|
+
opts = opts || {};
|
|
67894
|
+
|
|
67895
|
+
// verify the required parameter 'managementUnitId' is set
|
|
67896
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
67897
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
67898
|
+
}
|
|
67899
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
67900
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
67901
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
67902
|
+
}
|
|
67903
|
+
// verify the required parameter 'userId' is set
|
|
67904
|
+
if (userId === undefined || userId === null) {
|
|
67905
|
+
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
67906
|
+
}
|
|
67907
|
+
|
|
67908
|
+
return this.apiClient.callApi(
|
|
67909
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
67910
|
+
'PATCH',
|
|
67911
|
+
{ 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
|
|
67912
|
+
{ },
|
|
67913
|
+
{ },
|
|
67914
|
+
{ },
|
|
67915
|
+
opts['body'],
|
|
67916
|
+
['PureCloud OAuth'],
|
|
67917
|
+
['application/json'],
|
|
67918
|
+
['application/json']
|
|
67919
|
+
);
|
|
67920
|
+
}
|
|
67921
|
+
|
|
66836
67922
|
/**
|
|
66837
67923
|
* Update a time off request
|
|
66838
67924
|
*
|
|
@@ -67070,6 +68156,7 @@ class WorkforceManagementApi {
|
|
|
67070
68156
|
*
|
|
67071
68157
|
* @param {Object} opts Optional parameters
|
|
67072
68158
|
* @param {Object} opts.body body
|
|
68159
|
+
* @deprecated
|
|
67073
68160
|
*/
|
|
67074
68161
|
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
67075
68162
|
opts = opts || {};
|
|
@@ -67178,6 +68265,54 @@ class WorkforceManagementApi {
|
|
|
67178
68265
|
);
|
|
67179
68266
|
}
|
|
67180
68267
|
|
|
68268
|
+
/**
|
|
68269
|
+
* Move agents in and out of management unit
|
|
68270
|
+
*
|
|
68271
|
+
* @param {Object} opts Optional parameters
|
|
68272
|
+
* @param {Object} opts.body body
|
|
68273
|
+
*/
|
|
68274
|
+
postWorkforcemanagementAgents(opts) {
|
|
68275
|
+
opts = opts || {};
|
|
68276
|
+
|
|
68277
|
+
|
|
68278
|
+
return this.apiClient.callApi(
|
|
68279
|
+
'/api/v2/workforcemanagement/agents',
|
|
68280
|
+
'POST',
|
|
68281
|
+
{ },
|
|
68282
|
+
{ },
|
|
68283
|
+
{ },
|
|
68284
|
+
{ },
|
|
68285
|
+
opts['body'],
|
|
68286
|
+
['PureCloud OAuth'],
|
|
68287
|
+
['application/json'],
|
|
68288
|
+
['application/json']
|
|
68289
|
+
);
|
|
68290
|
+
}
|
|
68291
|
+
|
|
68292
|
+
/**
|
|
68293
|
+
* Query integrations for agents
|
|
68294
|
+
*
|
|
68295
|
+
* @param {Object} opts Optional parameters
|
|
68296
|
+
* @param {Object} opts.body body
|
|
68297
|
+
*/
|
|
68298
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) {
|
|
68299
|
+
opts = opts || {};
|
|
68300
|
+
|
|
68301
|
+
|
|
68302
|
+
return this.apiClient.callApi(
|
|
68303
|
+
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
68304
|
+
'POST',
|
|
68305
|
+
{ },
|
|
68306
|
+
{ },
|
|
68307
|
+
{ },
|
|
68308
|
+
{ },
|
|
68309
|
+
opts['body'],
|
|
68310
|
+
['PureCloud OAuth'],
|
|
68311
|
+
['application/json'],
|
|
68312
|
+
['application/json']
|
|
68313
|
+
);
|
|
68314
|
+
}
|
|
68315
|
+
|
|
67181
68316
|
/**
|
|
67182
68317
|
* Get agent possible work shifts for requested time frame
|
|
67183
68318
|
*
|
|
@@ -68000,6 +69135,31 @@ class WorkforceManagementApi {
|
|
|
68000
69135
|
);
|
|
68001
69136
|
}
|
|
68002
69137
|
|
|
69138
|
+
/**
|
|
69139
|
+
* Get list of time off types configured in integration
|
|
69140
|
+
*
|
|
69141
|
+
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
69142
|
+
*/
|
|
69143
|
+
postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) {
|
|
69144
|
+
// verify the required parameter 'hrisIntegrationId' is set
|
|
69145
|
+
if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
|
|
69146
|
+
throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
|
|
69147
|
+
}
|
|
69148
|
+
|
|
69149
|
+
return this.apiClient.callApi(
|
|
69150
|
+
'/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs',
|
|
69151
|
+
'POST',
|
|
69152
|
+
{ 'hrisIntegrationId': hrisIntegrationId },
|
|
69153
|
+
{ },
|
|
69154
|
+
{ },
|
|
69155
|
+
{ },
|
|
69156
|
+
null,
|
|
69157
|
+
['PureCloud OAuth'],
|
|
69158
|
+
['application/json'],
|
|
69159
|
+
['application/json']
|
|
69160
|
+
);
|
|
69161
|
+
}
|
|
69162
|
+
|
|
68003
69163
|
/**
|
|
68004
69164
|
* Query published schedules for given given time range for set of users
|
|
68005
69165
|
*
|
|
@@ -68264,6 +69424,35 @@ class WorkforceManagementApi {
|
|
|
68264
69424
|
);
|
|
68265
69425
|
}
|
|
68266
69426
|
|
|
69427
|
+
/**
|
|
69428
|
+
* Retrieves integration statuses for a list of time off requests
|
|
69429
|
+
*
|
|
69430
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
69431
|
+
* @param {Object} opts Optional parameters
|
|
69432
|
+
* @param {Object} opts.body body
|
|
69433
|
+
*/
|
|
69434
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) {
|
|
69435
|
+
opts = opts || {};
|
|
69436
|
+
|
|
69437
|
+
// verify the required parameter 'managementUnitId' is set
|
|
69438
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
69439
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
69440
|
+
}
|
|
69441
|
+
|
|
69442
|
+
return this.apiClient.callApi(
|
|
69443
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
69444
|
+
'POST',
|
|
69445
|
+
{ 'managementUnitId': managementUnitId },
|
|
69446
|
+
{ },
|
|
69447
|
+
{ },
|
|
69448
|
+
{ },
|
|
69449
|
+
opts['body'],
|
|
69450
|
+
['PureCloud OAuth'],
|
|
69451
|
+
['application/json'],
|
|
69452
|
+
['application/json']
|
|
69453
|
+
);
|
|
69454
|
+
}
|
|
69455
|
+
|
|
68267
69456
|
/**
|
|
68268
69457
|
* Fetches time off requests matching the conditions specified in the request body
|
|
68269
69458
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
@@ -68392,6 +69581,40 @@ class WorkforceManagementApi {
|
|
|
68392
69581
|
);
|
|
68393
69582
|
}
|
|
68394
69583
|
|
|
69584
|
+
/**
|
|
69585
|
+
* Estimates available time off for an agent
|
|
69586
|
+
*
|
|
69587
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
69588
|
+
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
69589
|
+
* @param {Object} opts Optional parameters
|
|
69590
|
+
* @param {Object} opts.body body
|
|
69591
|
+
*/
|
|
69592
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) {
|
|
69593
|
+
opts = opts || {};
|
|
69594
|
+
|
|
69595
|
+
// verify the required parameter 'managementUnitId' is set
|
|
69596
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
69597
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
69598
|
+
}
|
|
69599
|
+
// verify the required parameter 'userId' is set
|
|
69600
|
+
if (userId === undefined || userId === null) {
|
|
69601
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
69602
|
+
}
|
|
69603
|
+
|
|
69604
|
+
return this.apiClient.callApi(
|
|
69605
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
69606
|
+
'POST',
|
|
69607
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
69608
|
+
{ },
|
|
69609
|
+
{ },
|
|
69610
|
+
{ },
|
|
69611
|
+
opts['body'],
|
|
69612
|
+
['PureCloud OAuth'],
|
|
69613
|
+
['application/json'],
|
|
69614
|
+
['application/json']
|
|
69615
|
+
);
|
|
69616
|
+
}
|
|
69617
|
+
|
|
68395
69618
|
/**
|
|
68396
69619
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
68397
69620
|
*
|
|
@@ -68834,6 +70057,31 @@ class WorkforceManagementApi {
|
|
|
68834
70057
|
);
|
|
68835
70058
|
}
|
|
68836
70059
|
|
|
70060
|
+
/**
|
|
70061
|
+
* Query time off balances for the current user for specified activity code and dates
|
|
70062
|
+
*
|
|
70063
|
+
* @param {Object} body The request body
|
|
70064
|
+
*/
|
|
70065
|
+
postWorkforcemanagementTimeoffbalanceJobs(body) {
|
|
70066
|
+
// verify the required parameter 'body' is set
|
|
70067
|
+
if (body === undefined || body === null) {
|
|
70068
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
|
|
70069
|
+
}
|
|
70070
|
+
|
|
70071
|
+
return this.apiClient.callApi(
|
|
70072
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs',
|
|
70073
|
+
'POST',
|
|
70074
|
+
{ },
|
|
70075
|
+
{ },
|
|
70076
|
+
{ },
|
|
70077
|
+
{ },
|
|
70078
|
+
body,
|
|
70079
|
+
['PureCloud OAuth'],
|
|
70080
|
+
['application/json'],
|
|
70081
|
+
['application/json']
|
|
70082
|
+
);
|
|
70083
|
+
}
|
|
70084
|
+
|
|
68837
70085
|
/**
|
|
68838
70086
|
* Queries available time off for the current user
|
|
68839
70087
|
*
|
|
@@ -68882,6 +70130,84 @@ class WorkforceManagementApi {
|
|
|
68882
70130
|
);
|
|
68883
70131
|
}
|
|
68884
70132
|
|
|
70133
|
+
/**
|
|
70134
|
+
* Estimates available time off for current user
|
|
70135
|
+
*
|
|
70136
|
+
* @param {Object} opts Optional parameters
|
|
70137
|
+
* @param {Object} opts.body body
|
|
70138
|
+
*/
|
|
70139
|
+
postWorkforcemanagementTimeoffrequestsEstimate(opts) {
|
|
70140
|
+
opts = opts || {};
|
|
70141
|
+
|
|
70142
|
+
|
|
70143
|
+
return this.apiClient.callApi(
|
|
70144
|
+
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
70145
|
+
'POST',
|
|
70146
|
+
{ },
|
|
70147
|
+
{ },
|
|
70148
|
+
{ },
|
|
70149
|
+
{ },
|
|
70150
|
+
opts['body'],
|
|
70151
|
+
['PureCloud OAuth'],
|
|
70152
|
+
['application/json'],
|
|
70153
|
+
['application/json']
|
|
70154
|
+
);
|
|
70155
|
+
}
|
|
70156
|
+
|
|
70157
|
+
/**
|
|
70158
|
+
* Retrieves integration statuses for a list of current user time off requests
|
|
70159
|
+
*
|
|
70160
|
+
* @param {Object} opts Optional parameters
|
|
70161
|
+
* @param {Object} opts.body body
|
|
70162
|
+
*/
|
|
70163
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) {
|
|
70164
|
+
opts = opts || {};
|
|
70165
|
+
|
|
70166
|
+
|
|
70167
|
+
return this.apiClient.callApi(
|
|
70168
|
+
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
70169
|
+
'POST',
|
|
70170
|
+
{ },
|
|
70171
|
+
{ },
|
|
70172
|
+
{ },
|
|
70173
|
+
{ },
|
|
70174
|
+
opts['body'],
|
|
70175
|
+
['PureCloud OAuth'],
|
|
70176
|
+
['application/json'],
|
|
70177
|
+
['application/json']
|
|
70178
|
+
);
|
|
70179
|
+
}
|
|
70180
|
+
|
|
70181
|
+
/**
|
|
70182
|
+
* Update integrations for agent
|
|
70183
|
+
*
|
|
70184
|
+
* @param {String} agentId The ID of the agent
|
|
70185
|
+
* @param {Object} body body
|
|
70186
|
+
*/
|
|
70187
|
+
putWorkforcemanagementAgentIntegrationsHris(agentId, body) {
|
|
70188
|
+
// verify the required parameter 'agentId' is set
|
|
70189
|
+
if (agentId === undefined || agentId === null) {
|
|
70190
|
+
throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
70191
|
+
}
|
|
70192
|
+
// verify the required parameter 'body' is set
|
|
70193
|
+
if (body === undefined || body === null) {
|
|
70194
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
70195
|
+
}
|
|
70196
|
+
|
|
70197
|
+
return this.apiClient.callApi(
|
|
70198
|
+
'/api/v2/workforcemanagement/agents/{agentId}/integrations/hris',
|
|
70199
|
+
'PUT',
|
|
70200
|
+
{ 'agentId': agentId },
|
|
70201
|
+
{ },
|
|
70202
|
+
{ },
|
|
70203
|
+
{ },
|
|
70204
|
+
body,
|
|
70205
|
+
['PureCloud OAuth'],
|
|
70206
|
+
['application/json'],
|
|
70207
|
+
['application/json']
|
|
70208
|
+
);
|
|
70209
|
+
}
|
|
70210
|
+
|
|
68885
70211
|
/**
|
|
68886
70212
|
* Sets daily values for a date range of time off limit object
|
|
68887
70213
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
@@ -68947,7 +70273,7 @@ class WorkforceManagementApi {
|
|
|
68947
70273
|
* </pre>
|
|
68948
70274
|
* </p>
|
|
68949
70275
|
* @module purecloud-platform-client-v2/index
|
|
68950
|
-
* @version
|
|
70276
|
+
* @version 174.0.0
|
|
68951
70277
|
*/
|
|
68952
70278
|
class platformClient {
|
|
68953
70279
|
constructor() {
|