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
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 174.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1485,7 +1485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1485
1485
|
/**
|
|
1486
1486
|
* Alerting service.
|
|
1487
1487
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1488
|
-
* @version
|
|
1488
|
+
* @version 174.0.0
|
|
1489
1489
|
*/
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
@@ -2135,7 +2135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2135
2135
|
/**
|
|
2136
2136
|
* Analytics service.
|
|
2137
2137
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2138
|
-
* @version
|
|
2138
|
+
* @version 174.0.0
|
|
2139
2139
|
*/
|
|
2140
2140
|
|
|
2141
2141
|
/**
|
|
@@ -2283,13 +2283,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2283
2283
|
|
|
2284
2284
|
/**
|
|
2285
2285
|
* Get Reporting Turns.
|
|
2286
|
-
* 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.
|
|
2286
|
+
* 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.
|
|
2287
2287
|
* @param {String} botFlowId ID of the bot flow.
|
|
2288
2288
|
* @param {Object} opts Optional parameters
|
|
2289
2289
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
2290
2290
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
2291
|
+
* @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
|
|
2291
2292
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
2292
|
-
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
2293
|
+
* @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.
|
|
2293
2294
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
2294
2295
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
2295
2296
|
*/
|
|
@@ -2305,7 +2306,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2305
2306
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
2306
2307
|
'GET',
|
|
2307
2308
|
{ 'botFlowId': botFlowId },
|
|
2308
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
2309
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
2309
2310
|
{ },
|
|
2310
2311
|
{ },
|
|
2311
2312
|
null,
|
|
@@ -4580,7 +4581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4580
4581
|
/**
|
|
4581
4582
|
* Architect service.
|
|
4582
4583
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4583
|
-
* @version
|
|
4584
|
+
* @version 174.0.0
|
|
4584
4585
|
*/
|
|
4585
4586
|
|
|
4586
4587
|
/**
|
|
@@ -4620,6 +4621,125 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4620
4621
|
);
|
|
4621
4622
|
}
|
|
4622
4623
|
|
|
4624
|
+
/**
|
|
4625
|
+
* Delete a grammar.
|
|
4626
|
+
*
|
|
4627
|
+
* @param {String} grammarId grammar ID
|
|
4628
|
+
* deleteArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4629
|
+
*/
|
|
4630
|
+
deleteArchitectGrammar(grammarId) {
|
|
4631
|
+
// verify the required parameter 'grammarId' is set
|
|
4632
|
+
if (grammarId === undefined || grammarId === null) {
|
|
4633
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';
|
|
4634
|
+
}
|
|
4635
|
+
|
|
4636
|
+
return this.apiClient.callApi(
|
|
4637
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
4638
|
+
'DELETE',
|
|
4639
|
+
{ 'grammarId': grammarId },
|
|
4640
|
+
{ },
|
|
4641
|
+
{ },
|
|
4642
|
+
{ },
|
|
4643
|
+
null,
|
|
4644
|
+
['PureCloud OAuth'],
|
|
4645
|
+
['application/json'],
|
|
4646
|
+
['application/json']
|
|
4647
|
+
);
|
|
4648
|
+
}
|
|
4649
|
+
|
|
4650
|
+
/**
|
|
4651
|
+
* Delete specified grammar language
|
|
4652
|
+
*
|
|
4653
|
+
* @param {String} grammarId Grammar ID
|
|
4654
|
+
* @param {String} languageCode Language
|
|
4655
|
+
* deleteArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4656
|
+
*/
|
|
4657
|
+
deleteArchitectGrammarLanguage(grammarId, languageCode) {
|
|
4658
|
+
// verify the required parameter 'grammarId' is set
|
|
4659
|
+
if (grammarId === undefined || grammarId === null) {
|
|
4660
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';
|
|
4661
|
+
}
|
|
4662
|
+
// verify the required parameter 'languageCode' is set
|
|
4663
|
+
if (languageCode === undefined || languageCode === null) {
|
|
4664
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';
|
|
4665
|
+
}
|
|
4666
|
+
|
|
4667
|
+
return this.apiClient.callApi(
|
|
4668
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
4669
|
+
'DELETE',
|
|
4670
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
4671
|
+
{ },
|
|
4672
|
+
{ },
|
|
4673
|
+
{ },
|
|
4674
|
+
null,
|
|
4675
|
+
['PureCloud OAuth'],
|
|
4676
|
+
['application/json'],
|
|
4677
|
+
['application/json']
|
|
4678
|
+
);
|
|
4679
|
+
}
|
|
4680
|
+
|
|
4681
|
+
/**
|
|
4682
|
+
* Clear the DTMF mode file for the grammar language if there is one
|
|
4683
|
+
*
|
|
4684
|
+
* @param {String} grammarId Grammar ID
|
|
4685
|
+
* @param {String} languageCode Language
|
|
4686
|
+
* deleteArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4687
|
+
*/
|
|
4688
|
+
deleteArchitectGrammarLanguageFilesDtmf(grammarId, languageCode) {
|
|
4689
|
+
// verify the required parameter 'grammarId' is set
|
|
4690
|
+
if (grammarId === undefined || grammarId === null) {
|
|
4691
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
4692
|
+
}
|
|
4693
|
+
// verify the required parameter 'languageCode' is set
|
|
4694
|
+
if (languageCode === undefined || languageCode === null) {
|
|
4695
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
4696
|
+
}
|
|
4697
|
+
|
|
4698
|
+
return this.apiClient.callApi(
|
|
4699
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
4700
|
+
'DELETE',
|
|
4701
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
4702
|
+
{ },
|
|
4703
|
+
{ },
|
|
4704
|
+
{ },
|
|
4705
|
+
null,
|
|
4706
|
+
['PureCloud OAuth'],
|
|
4707
|
+
['application/json'],
|
|
4708
|
+
['application/json']
|
|
4709
|
+
);
|
|
4710
|
+
}
|
|
4711
|
+
|
|
4712
|
+
/**
|
|
4713
|
+
* Clear the voice mode file for the grammar language if there is one
|
|
4714
|
+
*
|
|
4715
|
+
* @param {String} grammarId Grammar ID
|
|
4716
|
+
* @param {String} languageCode Language
|
|
4717
|
+
* deleteArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4718
|
+
*/
|
|
4719
|
+
deleteArchitectGrammarLanguageFilesVoice(grammarId, languageCode) {
|
|
4720
|
+
// verify the required parameter 'grammarId' is set
|
|
4721
|
+
if (grammarId === undefined || grammarId === null) {
|
|
4722
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
4723
|
+
}
|
|
4724
|
+
// verify the required parameter 'languageCode' is set
|
|
4725
|
+
if (languageCode === undefined || languageCode === null) {
|
|
4726
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
4727
|
+
}
|
|
4728
|
+
|
|
4729
|
+
return this.apiClient.callApi(
|
|
4730
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
4731
|
+
'DELETE',
|
|
4732
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
4733
|
+
{ },
|
|
4734
|
+
{ },
|
|
4735
|
+
{ },
|
|
4736
|
+
null,
|
|
4737
|
+
['PureCloud OAuth'],
|
|
4738
|
+
['application/json'],
|
|
4739
|
+
['application/json']
|
|
4740
|
+
);
|
|
4741
|
+
}
|
|
4742
|
+
|
|
4623
4743
|
/**
|
|
4624
4744
|
* Delete an IVR Config.
|
|
4625
4745
|
*
|
|
@@ -5304,6 +5424,130 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5304
5424
|
);
|
|
5305
5425
|
}
|
|
5306
5426
|
|
|
5427
|
+
/**
|
|
5428
|
+
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
5429
|
+
* 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.
|
|
5430
|
+
* @param {Object} opts Optional parameters
|
|
5431
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5432
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5433
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
5434
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5435
|
+
* @param {Array.<String>} opts.id ID of the Emergency Groups to filter by.
|
|
5436
|
+
* @param {String} opts.name Name of the Emergency Group to filter by.
|
|
5437
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
5438
|
+
*/
|
|
5439
|
+
getArchitectEmergencygroupsDivisionviews(opts) {
|
|
5440
|
+
opts = opts || {};
|
|
5441
|
+
|
|
5442
|
+
|
|
5443
|
+
return this.apiClient.callApi(
|
|
5444
|
+
'/api/v2/architect/emergencygroups/divisionviews',
|
|
5445
|
+
'GET',
|
|
5446
|
+
{ },
|
|
5447
|
+
{ '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') },
|
|
5448
|
+
{ },
|
|
5449
|
+
{ },
|
|
5450
|
+
null,
|
|
5451
|
+
['PureCloud OAuth'],
|
|
5452
|
+
['application/json'],
|
|
5453
|
+
['application/json']
|
|
5454
|
+
);
|
|
5455
|
+
}
|
|
5456
|
+
|
|
5457
|
+
/**
|
|
5458
|
+
* Get a grammar
|
|
5459
|
+
* Returns a specified grammar
|
|
5460
|
+
* @param {String} grammarId grammar ID
|
|
5461
|
+
* @param {Object} opts Optional parameters
|
|
5462
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
5463
|
+
* getArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5464
|
+
*/
|
|
5465
|
+
getArchitectGrammar(grammarId, opts) {
|
|
5466
|
+
opts = opts || {};
|
|
5467
|
+
|
|
5468
|
+
// verify the required parameter 'grammarId' is set
|
|
5469
|
+
if (grammarId === undefined || grammarId === null) {
|
|
5470
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammar';
|
|
5471
|
+
}
|
|
5472
|
+
|
|
5473
|
+
return this.apiClient.callApi(
|
|
5474
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
5475
|
+
'GET',
|
|
5476
|
+
{ 'grammarId': grammarId },
|
|
5477
|
+
{ 'includeFileUrls': opts['includeFileUrls'] },
|
|
5478
|
+
{ },
|
|
5479
|
+
{ },
|
|
5480
|
+
null,
|
|
5481
|
+
['PureCloud OAuth'],
|
|
5482
|
+
['application/json'],
|
|
5483
|
+
['application/json']
|
|
5484
|
+
);
|
|
5485
|
+
}
|
|
5486
|
+
|
|
5487
|
+
/**
|
|
5488
|
+
* Get a grammar language.
|
|
5489
|
+
*
|
|
5490
|
+
* @param {String} grammarId Grammar ID
|
|
5491
|
+
* @param {String} languageCode Language
|
|
5492
|
+
* getArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5493
|
+
*/
|
|
5494
|
+
getArchitectGrammarLanguage(grammarId, languageCode) {
|
|
5495
|
+
// verify the required parameter 'grammarId' is set
|
|
5496
|
+
if (grammarId === undefined || grammarId === null) {
|
|
5497
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';
|
|
5498
|
+
}
|
|
5499
|
+
// verify the required parameter 'languageCode' is set
|
|
5500
|
+
if (languageCode === undefined || languageCode === null) {
|
|
5501
|
+
throw 'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';
|
|
5502
|
+
}
|
|
5503
|
+
|
|
5504
|
+
return this.apiClient.callApi(
|
|
5505
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
5506
|
+
'GET',
|
|
5507
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
5508
|
+
{ },
|
|
5509
|
+
{ },
|
|
5510
|
+
{ },
|
|
5511
|
+
null,
|
|
5512
|
+
['PureCloud OAuth'],
|
|
5513
|
+
['application/json'],
|
|
5514
|
+
['application/json']
|
|
5515
|
+
);
|
|
5516
|
+
}
|
|
5517
|
+
|
|
5518
|
+
/**
|
|
5519
|
+
* Get a pageable list of grammars, filtered by query parameters
|
|
5520
|
+
* Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
|
|
5521
|
+
* @param {Object} opts Optional parameters
|
|
5522
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5523
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5524
|
+
* @param {Object} opts.sortBy Sort by (default to id)
|
|
5525
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
5526
|
+
* @param {Array.<String>} opts.id ID
|
|
5527
|
+
* @param {String} opts.name Name
|
|
5528
|
+
* @param {String} opts.description Description
|
|
5529
|
+
* @param {String} opts.nameOrDescription Name or description
|
|
5530
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
5531
|
+
* getArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5532
|
+
*/
|
|
5533
|
+
getArchitectGrammars(opts) {
|
|
5534
|
+
opts = opts || {};
|
|
5535
|
+
|
|
5536
|
+
|
|
5537
|
+
return this.apiClient.callApi(
|
|
5538
|
+
'/api/v2/architect/grammars',
|
|
5539
|
+
'GET',
|
|
5540
|
+
{ },
|
|
5541
|
+
{ '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'] },
|
|
5542
|
+
{ },
|
|
5543
|
+
{ },
|
|
5544
|
+
null,
|
|
5545
|
+
['PureCloud OAuth'],
|
|
5546
|
+
['application/json'],
|
|
5547
|
+
['application/json']
|
|
5548
|
+
);
|
|
5549
|
+
}
|
|
5550
|
+
|
|
5307
5551
|
/**
|
|
5308
5552
|
* Get an IVR config.
|
|
5309
5553
|
*
|
|
@@ -5359,6 +5603,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5359
5603
|
);
|
|
5360
5604
|
}
|
|
5361
5605
|
|
|
5606
|
+
/**
|
|
5607
|
+
* Get a pageable list of basic ivr configuration information objects filterable by query parameters.
|
|
5608
|
+
*
|
|
5609
|
+
* @param {Object} opts Optional parameters
|
|
5610
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5611
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5612
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
5613
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5614
|
+
* @param {Array.<String>} opts.id ID of the IVR to filter by.
|
|
5615
|
+
* @param {String} opts.name Name of the IVR to filter by.
|
|
5616
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
5617
|
+
*/
|
|
5618
|
+
getArchitectIvrsDivisionviews(opts) {
|
|
5619
|
+
opts = opts || {};
|
|
5620
|
+
|
|
5621
|
+
|
|
5622
|
+
return this.apiClient.callApi(
|
|
5623
|
+
'/api/v2/architect/ivrs/divisionviews',
|
|
5624
|
+
'GET',
|
|
5625
|
+
{ },
|
|
5626
|
+
{ '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') },
|
|
5627
|
+
{ },
|
|
5628
|
+
{ },
|
|
5629
|
+
null,
|
|
5630
|
+
['PureCloud OAuth'],
|
|
5631
|
+
['application/json'],
|
|
5632
|
+
['application/json']
|
|
5633
|
+
);
|
|
5634
|
+
}
|
|
5635
|
+
|
|
5362
5636
|
/**
|
|
5363
5637
|
* Get specified user prompt
|
|
5364
5638
|
*
|
|
@@ -5592,6 +5866,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5592
5866
|
);
|
|
5593
5867
|
}
|
|
5594
5868
|
|
|
5869
|
+
/**
|
|
5870
|
+
* Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
|
|
5871
|
+
*
|
|
5872
|
+
* @param {Object} opts Optional parameters
|
|
5873
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5874
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5875
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
5876
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5877
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
5878
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
5879
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
5880
|
+
*/
|
|
5881
|
+
getArchitectSchedulegroupsDivisionviews(opts) {
|
|
5882
|
+
opts = opts || {};
|
|
5883
|
+
|
|
5884
|
+
|
|
5885
|
+
return this.apiClient.callApi(
|
|
5886
|
+
'/api/v2/architect/schedulegroups/divisionviews',
|
|
5887
|
+
'GET',
|
|
5888
|
+
{ },
|
|
5889
|
+
{ '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') },
|
|
5890
|
+
{ },
|
|
5891
|
+
{ },
|
|
5892
|
+
null,
|
|
5893
|
+
['PureCloud OAuth'],
|
|
5894
|
+
['application/json'],
|
|
5895
|
+
['application/json']
|
|
5896
|
+
);
|
|
5897
|
+
}
|
|
5898
|
+
|
|
5595
5899
|
/**
|
|
5596
5900
|
* Get a list of schedules.
|
|
5597
5901
|
*
|
|
@@ -5621,6 +5925,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5621
5925
|
);
|
|
5622
5926
|
}
|
|
5623
5927
|
|
|
5928
|
+
/**
|
|
5929
|
+
* Get a pageable list of basic schedule configuration information objects filterable by query parameters.
|
|
5930
|
+
*
|
|
5931
|
+
* @param {Object} opts Optional parameters
|
|
5932
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5933
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5934
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
5935
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5936
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
5937
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
5938
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
5939
|
+
*/
|
|
5940
|
+
getArchitectSchedulesDivisionviews(opts) {
|
|
5941
|
+
opts = opts || {};
|
|
5942
|
+
|
|
5943
|
+
|
|
5944
|
+
return this.apiClient.callApi(
|
|
5945
|
+
'/api/v2/architect/schedules/divisionviews',
|
|
5946
|
+
'GET',
|
|
5947
|
+
{ },
|
|
5948
|
+
{ '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') },
|
|
5949
|
+
{ },
|
|
5950
|
+
{ },
|
|
5951
|
+
null,
|
|
5952
|
+
['PureCloud OAuth'],
|
|
5953
|
+
['application/json'],
|
|
5954
|
+
['application/json']
|
|
5955
|
+
);
|
|
5956
|
+
}
|
|
5957
|
+
|
|
5624
5958
|
/**
|
|
5625
5959
|
* Get a system prompt
|
|
5626
5960
|
*
|
|
@@ -6631,6 +6965,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6631
6965
|
);
|
|
6632
6966
|
}
|
|
6633
6967
|
|
|
6968
|
+
/**
|
|
6969
|
+
* Updates a grammar
|
|
6970
|
+
*
|
|
6971
|
+
* @param {String} grammarId grammar ID
|
|
6972
|
+
* @param {Object} opts Optional parameters
|
|
6973
|
+
* @param {Object} opts.body
|
|
6974
|
+
* patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6975
|
+
*/
|
|
6976
|
+
patchArchitectGrammar(grammarId, opts) {
|
|
6977
|
+
opts = opts || {};
|
|
6978
|
+
|
|
6979
|
+
// verify the required parameter 'grammarId' is set
|
|
6980
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6981
|
+
throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
|
|
6982
|
+
}
|
|
6983
|
+
|
|
6984
|
+
return this.apiClient.callApi(
|
|
6985
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
6986
|
+
'PATCH',
|
|
6987
|
+
{ 'grammarId': grammarId },
|
|
6988
|
+
{ },
|
|
6989
|
+
{ },
|
|
6990
|
+
{ },
|
|
6991
|
+
opts['body'],
|
|
6992
|
+
['PureCloud OAuth'],
|
|
6993
|
+
['application/json'],
|
|
6994
|
+
['application/json']
|
|
6995
|
+
);
|
|
6996
|
+
}
|
|
6997
|
+
|
|
6634
6998
|
/**
|
|
6635
6999
|
* Rebuild Dependency Tracking data for an organization
|
|
6636
7000
|
* Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
@@ -6676,6 +7040,135 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6676
7040
|
);
|
|
6677
7041
|
}
|
|
6678
7042
|
|
|
7043
|
+
/**
|
|
7044
|
+
* Creates a presigned URL for uploading a grammar DTMF mode file
|
|
7045
|
+
*
|
|
7046
|
+
* @param {String} grammarId Grammar ID
|
|
7047
|
+
* @param {String} languageCode Language
|
|
7048
|
+
* @param {Object} body query
|
|
7049
|
+
* postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7050
|
+
*/
|
|
7051
|
+
postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
|
|
7052
|
+
// verify the required parameter 'grammarId' is set
|
|
7053
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7054
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7055
|
+
}
|
|
7056
|
+
// verify the required parameter 'languageCode' is set
|
|
7057
|
+
if (languageCode === undefined || languageCode === null) {
|
|
7058
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7059
|
+
}
|
|
7060
|
+
// verify the required parameter 'body' is set
|
|
7061
|
+
if (body === undefined || body === null) {
|
|
7062
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7063
|
+
}
|
|
7064
|
+
|
|
7065
|
+
return this.apiClient.callApi(
|
|
7066
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
7067
|
+
'POST',
|
|
7068
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
7069
|
+
{ },
|
|
7070
|
+
{ },
|
|
7071
|
+
{ },
|
|
7072
|
+
body,
|
|
7073
|
+
['PureCloud OAuth'],
|
|
7074
|
+
['application/json'],
|
|
7075
|
+
['application/json']
|
|
7076
|
+
);
|
|
7077
|
+
}
|
|
7078
|
+
|
|
7079
|
+
/**
|
|
7080
|
+
* Creates a presigned URL for uploading a grammar voice mode file
|
|
7081
|
+
*
|
|
7082
|
+
* @param {String} grammarId Grammar ID
|
|
7083
|
+
* @param {String} languageCode Language
|
|
7084
|
+
* @param {Object} body query
|
|
7085
|
+
* postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7086
|
+
*/
|
|
7087
|
+
postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
|
|
7088
|
+
// verify the required parameter 'grammarId' is set
|
|
7089
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7090
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7091
|
+
}
|
|
7092
|
+
// verify the required parameter 'languageCode' is set
|
|
7093
|
+
if (languageCode === undefined || languageCode === null) {
|
|
7094
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7095
|
+
}
|
|
7096
|
+
// verify the required parameter 'body' is set
|
|
7097
|
+
if (body === undefined || body === null) {
|
|
7098
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7099
|
+
}
|
|
7100
|
+
|
|
7101
|
+
return this.apiClient.callApi(
|
|
7102
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
7103
|
+
'POST',
|
|
7104
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
7105
|
+
{ },
|
|
7106
|
+
{ },
|
|
7107
|
+
{ },
|
|
7108
|
+
body,
|
|
7109
|
+
['PureCloud OAuth'],
|
|
7110
|
+
['application/json'],
|
|
7111
|
+
['application/json']
|
|
7112
|
+
);
|
|
7113
|
+
}
|
|
7114
|
+
|
|
7115
|
+
/**
|
|
7116
|
+
* Create a new language for a given grammar
|
|
7117
|
+
*
|
|
7118
|
+
* @param {String} grammarId Grammar ID
|
|
7119
|
+
* @param {Object} body
|
|
7120
|
+
* postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7121
|
+
*/
|
|
7122
|
+
postArchitectGrammarLanguages(grammarId, body) {
|
|
7123
|
+
// verify the required parameter 'grammarId' is set
|
|
7124
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7125
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
|
|
7126
|
+
}
|
|
7127
|
+
// verify the required parameter 'body' is set
|
|
7128
|
+
if (body === undefined || body === null) {
|
|
7129
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
|
|
7130
|
+
}
|
|
7131
|
+
|
|
7132
|
+
return this.apiClient.callApi(
|
|
7133
|
+
'/api/v2/architect/grammars/{grammarId}/languages',
|
|
7134
|
+
'POST',
|
|
7135
|
+
{ 'grammarId': grammarId },
|
|
7136
|
+
{ },
|
|
7137
|
+
{ },
|
|
7138
|
+
{ },
|
|
7139
|
+
body,
|
|
7140
|
+
['PureCloud OAuth'],
|
|
7141
|
+
['application/json'],
|
|
7142
|
+
['application/json']
|
|
7143
|
+
);
|
|
7144
|
+
}
|
|
7145
|
+
|
|
7146
|
+
/**
|
|
7147
|
+
* Create a new grammar
|
|
7148
|
+
*
|
|
7149
|
+
* @param {Object} body
|
|
7150
|
+
* postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7151
|
+
*/
|
|
7152
|
+
postArchitectGrammars(body) {
|
|
7153
|
+
// verify the required parameter 'body' is set
|
|
7154
|
+
if (body === undefined || body === null) {
|
|
7155
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammars';
|
|
7156
|
+
}
|
|
7157
|
+
|
|
7158
|
+
return this.apiClient.callApi(
|
|
7159
|
+
'/api/v2/architect/grammars',
|
|
7160
|
+
'POST',
|
|
7161
|
+
{ },
|
|
7162
|
+
{ },
|
|
7163
|
+
{ },
|
|
7164
|
+
{ },
|
|
7165
|
+
body,
|
|
7166
|
+
['PureCloud OAuth'],
|
|
7167
|
+
['application/json'],
|
|
7168
|
+
['application/json']
|
|
7169
|
+
);
|
|
7170
|
+
}
|
|
7171
|
+
|
|
6679
7172
|
/**
|
|
6680
7173
|
* Create IVR config.
|
|
6681
7174
|
*
|
|
@@ -7769,7 +8262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7769
8262
|
/**
|
|
7770
8263
|
* Audit service.
|
|
7771
8264
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7772
|
-
* @version
|
|
8265
|
+
* @version 174.0.0
|
|
7773
8266
|
*/
|
|
7774
8267
|
|
|
7775
8268
|
/**
|
|
@@ -7940,7 +8433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7940
8433
|
/**
|
|
7941
8434
|
* Authorization service.
|
|
7942
8435
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7943
|
-
* @version
|
|
8436
|
+
* @version 174.0.0
|
|
7944
8437
|
*/
|
|
7945
8438
|
|
|
7946
8439
|
/**
|
|
@@ -9171,7 +9664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9171
9664
|
/**
|
|
9172
9665
|
* Billing service.
|
|
9173
9666
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9174
|
-
* @version
|
|
9667
|
+
* @version 174.0.0
|
|
9175
9668
|
*/
|
|
9176
9669
|
|
|
9177
9670
|
/**
|
|
@@ -9251,7 +9744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9251
9744
|
/**
|
|
9252
9745
|
* CarrierServices service.
|
|
9253
9746
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9254
|
-
* @version
|
|
9747
|
+
* @version 174.0.0
|
|
9255
9748
|
*/
|
|
9256
9749
|
|
|
9257
9750
|
/**
|
|
@@ -9321,7 +9814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9321
9814
|
/**
|
|
9322
9815
|
* Chat service.
|
|
9323
9816
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9324
|
-
* @version
|
|
9817
|
+
* @version 174.0.0
|
|
9325
9818
|
*/
|
|
9326
9819
|
|
|
9327
9820
|
/**
|
|
@@ -9485,7 +9978,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9485
9978
|
/**
|
|
9486
9979
|
* Coaching service.
|
|
9487
9980
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9488
|
-
* @version
|
|
9981
|
+
* @version 174.0.0
|
|
9489
9982
|
*/
|
|
9490
9983
|
|
|
9491
9984
|
/**
|
|
@@ -10062,7 +10555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10062
10555
|
/**
|
|
10063
10556
|
* ContentManagement service.
|
|
10064
10557
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10065
|
-
* @version
|
|
10558
|
+
* @version 174.0.0
|
|
10066
10559
|
*/
|
|
10067
10560
|
|
|
10068
10561
|
/**
|
|
@@ -11205,7 +11698,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11205
11698
|
/**
|
|
11206
11699
|
* Conversations service.
|
|
11207
11700
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11208
|
-
* @version
|
|
11701
|
+
* @version 174.0.0
|
|
11209
11702
|
*/
|
|
11210
11703
|
|
|
11211
11704
|
/**
|
|
@@ -11370,6 +11863,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11370
11863
|
);
|
|
11371
11864
|
}
|
|
11372
11865
|
|
|
11866
|
+
/**
|
|
11867
|
+
* Remove a cached media item asychronously
|
|
11868
|
+
*
|
|
11869
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
11870
|
+
*/
|
|
11871
|
+
deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
11872
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
11873
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
11874
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
|
|
11875
|
+
}
|
|
11876
|
+
|
|
11877
|
+
return this.apiClient.callApi(
|
|
11878
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
11879
|
+
'DELETE',
|
|
11880
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
11881
|
+
{ },
|
|
11882
|
+
{ },
|
|
11883
|
+
{ },
|
|
11884
|
+
null,
|
|
11885
|
+
['PureCloud OAuth'],
|
|
11886
|
+
['application/json'],
|
|
11887
|
+
['application/json']
|
|
11888
|
+
);
|
|
11889
|
+
}
|
|
11890
|
+
|
|
11373
11891
|
/**
|
|
11374
11892
|
* Delete a Facebook messaging integration
|
|
11375
11893
|
*
|
|
@@ -13171,7 +13689,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13171
13689
|
/**
|
|
13172
13690
|
* Get list of wrapup codes for this conversation participant
|
|
13173
13691
|
*
|
|
13174
|
-
* @param {String} conversationId
|
|
13692
|
+
* @param {String} conversationId conversationId
|
|
13175
13693
|
* @param {String} participantId participantId
|
|
13176
13694
|
*/
|
|
13177
13695
|
getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
|
|
@@ -13218,6 +13736,57 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13218
13736
|
);
|
|
13219
13737
|
}
|
|
13220
13738
|
|
|
13739
|
+
/**
|
|
13740
|
+
* Get a list of cached media items
|
|
13741
|
+
*
|
|
13742
|
+
* @param {Object} opts Optional parameters
|
|
13743
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13744
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13745
|
+
* @param {String} opts.url URL to search for
|
|
13746
|
+
*/
|
|
13747
|
+
getConversationsMessagesCachedmedia(opts) {
|
|
13748
|
+
opts = opts || {};
|
|
13749
|
+
|
|
13750
|
+
|
|
13751
|
+
return this.apiClient.callApi(
|
|
13752
|
+
'/api/v2/conversations/messages/cachedmedia',
|
|
13753
|
+
'GET',
|
|
13754
|
+
{ },
|
|
13755
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
|
|
13756
|
+
{ },
|
|
13757
|
+
{ },
|
|
13758
|
+
null,
|
|
13759
|
+
['PureCloud OAuth'],
|
|
13760
|
+
['application/json'],
|
|
13761
|
+
['application/json']
|
|
13762
|
+
);
|
|
13763
|
+
}
|
|
13764
|
+
|
|
13765
|
+
/**
|
|
13766
|
+
* Get a cached media item
|
|
13767
|
+
*
|
|
13768
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
13769
|
+
*/
|
|
13770
|
+
getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
13771
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
13772
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
13773
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
|
|
13774
|
+
}
|
|
13775
|
+
|
|
13776
|
+
return this.apiClient.callApi(
|
|
13777
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
13778
|
+
'GET',
|
|
13779
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
13780
|
+
{ },
|
|
13781
|
+
{ },
|
|
13782
|
+
{ },
|
|
13783
|
+
null,
|
|
13784
|
+
['PureCloud OAuth'],
|
|
13785
|
+
['application/json'],
|
|
13786
|
+
['application/json']
|
|
13787
|
+
);
|
|
13788
|
+
}
|
|
13789
|
+
|
|
13221
13790
|
/**
|
|
13222
13791
|
* Get Genesys Facebook App Id
|
|
13223
13792
|
*
|
|
@@ -13961,6 +14530,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13961
14530
|
);
|
|
13962
14531
|
}
|
|
13963
14532
|
|
|
14533
|
+
/**
|
|
14534
|
+
* Gets a record for a given meetingId
|
|
14535
|
+
*
|
|
14536
|
+
* @param {String} meetingId meetingId
|
|
14537
|
+
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14538
|
+
*/
|
|
14539
|
+
getConversationsVideosMeeting(meetingId) {
|
|
14540
|
+
// verify the required parameter 'meetingId' is set
|
|
14541
|
+
if (meetingId === undefined || meetingId === null) {
|
|
14542
|
+
throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
|
|
14543
|
+
}
|
|
14544
|
+
|
|
14545
|
+
return this.apiClient.callApi(
|
|
14546
|
+
'/api/v2/conversations/videos/meetings/{meetingId}',
|
|
14547
|
+
'GET',
|
|
14548
|
+
{ 'meetingId': meetingId },
|
|
14549
|
+
{ },
|
|
14550
|
+
{ },
|
|
14551
|
+
{ },
|
|
14552
|
+
null,
|
|
14553
|
+
['PureCloud OAuth'],
|
|
14554
|
+
['application/json'],
|
|
14555
|
+
['application/json']
|
|
14556
|
+
);
|
|
14557
|
+
}
|
|
14558
|
+
|
|
13964
14559
|
/**
|
|
13965
14560
|
* Update a participant.
|
|
13966
14561
|
* Update conversation participant.
|
|
@@ -14923,7 +15518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14923
15518
|
/**
|
|
14924
15519
|
* Update conversation participant
|
|
14925
15520
|
*
|
|
14926
|
-
* @param {String} conversationId
|
|
15521
|
+
* @param {String} conversationId conversationId
|
|
14927
15522
|
* @param {String} participantId participantId
|
|
14928
15523
|
* @param {Object} opts Optional parameters
|
|
14929
15524
|
* @param {Object} opts.body
|
|
@@ -14957,7 +15552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14957
15552
|
/**
|
|
14958
15553
|
* Update the attributes on a conversation participant.
|
|
14959
15554
|
*
|
|
14960
|
-
* @param {String} conversationId
|
|
15555
|
+
* @param {String} conversationId conversationId
|
|
14961
15556
|
* @param {String} participantId participantId
|
|
14962
15557
|
* @param {Object} opts Optional parameters
|
|
14963
15558
|
* @param {Object} opts.body
|
|
@@ -14991,7 +15586,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14991
15586
|
/**
|
|
14992
15587
|
* Update conversation participant's communication by disconnecting it.
|
|
14993
15588
|
*
|
|
14994
|
-
* @param {String} conversationId
|
|
15589
|
+
* @param {String} conversationId conversationId
|
|
14995
15590
|
* @param {String} participantId participantId
|
|
14996
15591
|
* @param {String} communicationId communicationId
|
|
14997
15592
|
* @param {Object} body Participant
|
|
@@ -16948,6 +17543,96 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16948
17543
|
);
|
|
16949
17544
|
}
|
|
16950
17545
|
|
|
17546
|
+
/**
|
|
17547
|
+
* Send an inbound Open Event Message
|
|
17548
|
+
* 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.
|
|
17549
|
+
* @param {String} integrationId integrationId
|
|
17550
|
+
* @param {Object} body NormalizedMessage
|
|
17551
|
+
*/
|
|
17552
|
+
postConversationsMessageInboundOpenEvent(integrationId, body) {
|
|
17553
|
+
// verify the required parameter 'integrationId' is set
|
|
17554
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17555
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
|
|
17556
|
+
}
|
|
17557
|
+
// verify the required parameter 'body' is set
|
|
17558
|
+
if (body === undefined || body === null) {
|
|
17559
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
|
|
17560
|
+
}
|
|
17561
|
+
|
|
17562
|
+
return this.apiClient.callApi(
|
|
17563
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/event',
|
|
17564
|
+
'POST',
|
|
17565
|
+
{ 'integrationId': integrationId },
|
|
17566
|
+
{ },
|
|
17567
|
+
{ },
|
|
17568
|
+
{ },
|
|
17569
|
+
body,
|
|
17570
|
+
['PureCloud OAuth'],
|
|
17571
|
+
['application/json'],
|
|
17572
|
+
['application/json']
|
|
17573
|
+
);
|
|
17574
|
+
}
|
|
17575
|
+
|
|
17576
|
+
/**
|
|
17577
|
+
* Send inbound Open Message
|
|
17578
|
+
* 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.
|
|
17579
|
+
* @param {String} integrationId integrationId
|
|
17580
|
+
* @param {Object} body NormalizedMessage
|
|
17581
|
+
*/
|
|
17582
|
+
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
17583
|
+
// verify the required parameter 'integrationId' is set
|
|
17584
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17585
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
17586
|
+
}
|
|
17587
|
+
// verify the required parameter 'body' is set
|
|
17588
|
+
if (body === undefined || body === null) {
|
|
17589
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
|
|
17590
|
+
}
|
|
17591
|
+
|
|
17592
|
+
return this.apiClient.callApi(
|
|
17593
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
17594
|
+
'POST',
|
|
17595
|
+
{ 'integrationId': integrationId },
|
|
17596
|
+
{ },
|
|
17597
|
+
{ },
|
|
17598
|
+
{ },
|
|
17599
|
+
body,
|
|
17600
|
+
['PureCloud OAuth'],
|
|
17601
|
+
['application/json'],
|
|
17602
|
+
['application/json']
|
|
17603
|
+
);
|
|
17604
|
+
}
|
|
17605
|
+
|
|
17606
|
+
/**
|
|
17607
|
+
* Send an inbound Open Receipt Message
|
|
17608
|
+
* 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.
|
|
17609
|
+
* @param {String} integrationId integrationId
|
|
17610
|
+
* @param {Object} body NormalizedMessage
|
|
17611
|
+
*/
|
|
17612
|
+
postConversationsMessageInboundOpenReceipt(integrationId, body) {
|
|
17613
|
+
// verify the required parameter 'integrationId' is set
|
|
17614
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17615
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
|
|
17616
|
+
}
|
|
17617
|
+
// verify the required parameter 'body' is set
|
|
17618
|
+
if (body === undefined || body === null) {
|
|
17619
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
|
|
17620
|
+
}
|
|
17621
|
+
|
|
17622
|
+
return this.apiClient.callApi(
|
|
17623
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
|
|
17624
|
+
'POST',
|
|
17625
|
+
{ 'integrationId': integrationId },
|
|
17626
|
+
{ },
|
|
17627
|
+
{ },
|
|
17628
|
+
{ },
|
|
17629
|
+
body,
|
|
17630
|
+
['PureCloud OAuth'],
|
|
17631
|
+
['application/json'],
|
|
17632
|
+
['application/json']
|
|
17633
|
+
);
|
|
17634
|
+
}
|
|
17635
|
+
|
|
16951
17636
|
/**
|
|
16952
17637
|
* Get messages in batch
|
|
16953
17638
|
* 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"]
|
|
@@ -17500,6 +18185,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17500
18185
|
);
|
|
17501
18186
|
}
|
|
17502
18187
|
|
|
18188
|
+
/**
|
|
18189
|
+
* Generate a meetingId for a given conferenceId
|
|
18190
|
+
*
|
|
18191
|
+
* @param {Object} body MeetingIdRequest
|
|
18192
|
+
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18193
|
+
*/
|
|
18194
|
+
postConversationsVideosMeetings(body) {
|
|
18195
|
+
// verify the required parameter 'body' is set
|
|
18196
|
+
if (body === undefined || body === null) {
|
|
18197
|
+
throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
|
|
18198
|
+
}
|
|
18199
|
+
|
|
18200
|
+
return this.apiClient.callApi(
|
|
18201
|
+
'/api/v2/conversations/videos/meetings',
|
|
18202
|
+
'POST',
|
|
18203
|
+
{ },
|
|
18204
|
+
{ },
|
|
18205
|
+
{ },
|
|
18206
|
+
{ },
|
|
18207
|
+
body,
|
|
18208
|
+
['PureCloud OAuth'],
|
|
18209
|
+
['application/json'],
|
|
18210
|
+
['application/json']
|
|
18211
|
+
);
|
|
18212
|
+
}
|
|
18213
|
+
|
|
17503
18214
|
/**
|
|
17504
18215
|
* Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
17505
18216
|
*
|
|
@@ -18071,7 +18782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18071
18782
|
/**
|
|
18072
18783
|
* DataExtensions service.
|
|
18073
18784
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
18074
|
-
* @version
|
|
18785
|
+
* @version 174.0.0
|
|
18075
18786
|
*/
|
|
18076
18787
|
|
|
18077
18788
|
/**
|
|
@@ -18157,7 +18868,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18157
18868
|
/**
|
|
18158
18869
|
* Downloads service.
|
|
18159
18870
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
18160
|
-
* @version
|
|
18871
|
+
* @version 174.0.0
|
|
18161
18872
|
*/
|
|
18162
18873
|
|
|
18163
18874
|
/**
|
|
@@ -18209,7 +18920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18209
18920
|
/**
|
|
18210
18921
|
* Emails service.
|
|
18211
18922
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
18212
|
-
* @version
|
|
18923
|
+
* @version 174.0.0
|
|
18213
18924
|
*/
|
|
18214
18925
|
|
|
18215
18926
|
/**
|
|
@@ -18274,7 +18985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18274
18985
|
/**
|
|
18275
18986
|
* Events service.
|
|
18276
18987
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
18277
|
-
* @version
|
|
18988
|
+
* @version 174.0.0
|
|
18278
18989
|
*/
|
|
18279
18990
|
|
|
18280
18991
|
/**
|
|
@@ -18370,7 +19081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18370
19081
|
/**
|
|
18371
19082
|
* ExternalContacts service.
|
|
18372
19083
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
18373
|
-
* @version
|
|
19084
|
+
* @version 174.0.0
|
|
18374
19085
|
*/
|
|
18375
19086
|
|
|
18376
19087
|
/**
|
|
@@ -20328,7 +21039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20328
21039
|
/**
|
|
20329
21040
|
* Fax service.
|
|
20330
21041
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
20331
|
-
* @version
|
|
21042
|
+
* @version 174.0.0
|
|
20332
21043
|
*/
|
|
20333
21044
|
|
|
20334
21045
|
/**
|
|
@@ -20499,7 +21210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20499
21210
|
/**
|
|
20500
21211
|
* Flows service.
|
|
20501
21212
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
20502
|
-
* @version
|
|
21213
|
+
* @version 174.0.0
|
|
20503
21214
|
*/
|
|
20504
21215
|
|
|
20505
21216
|
/**
|
|
@@ -20683,7 +21394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20683
21394
|
/**
|
|
20684
21395
|
* Gamification service.
|
|
20685
21396
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
20686
|
-
* @version
|
|
21397
|
+
* @version 174.0.0
|
|
20687
21398
|
*/
|
|
20688
21399
|
|
|
20689
21400
|
/**
|
|
@@ -22769,7 +23480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22769
23480
|
/**
|
|
22770
23481
|
* GeneralDataProtectionRegulation service.
|
|
22771
23482
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
22772
|
-
* @version
|
|
23483
|
+
* @version 174.0.0
|
|
22773
23484
|
*/
|
|
22774
23485
|
|
|
22775
23486
|
/**
|
|
@@ -22899,7 +23610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22899
23610
|
/**
|
|
22900
23611
|
* Geolocation service.
|
|
22901
23612
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
22902
|
-
* @version
|
|
23613
|
+
* @version 174.0.0
|
|
22903
23614
|
*/
|
|
22904
23615
|
|
|
22905
23616
|
/**
|
|
@@ -23030,7 +23741,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23030
23741
|
/**
|
|
23031
23742
|
* Greetings service.
|
|
23032
23743
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
23033
|
-
* @version
|
|
23744
|
+
* @version 174.0.0
|
|
23034
23745
|
*/
|
|
23035
23746
|
|
|
23036
23747
|
/**
|
|
@@ -23485,7 +24196,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23485
24196
|
/**
|
|
23486
24197
|
* Groups service.
|
|
23487
24198
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
23488
|
-
* @version
|
|
24199
|
+
* @version 174.0.0
|
|
23489
24200
|
*/
|
|
23490
24201
|
|
|
23491
24202
|
/**
|
|
@@ -24004,7 +24715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24004
24715
|
/**
|
|
24005
24716
|
* IdentityProvider service.
|
|
24006
24717
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
24007
|
-
* @version
|
|
24718
|
+
* @version 174.0.0
|
|
24008
24719
|
*/
|
|
24009
24720
|
|
|
24010
24721
|
/**
|
|
@@ -24760,7 +25471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24760
25471
|
/**
|
|
24761
25472
|
* InfrastructureAsCode service.
|
|
24762
25473
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
24763
|
-
* @version
|
|
25474
|
+
* @version 174.0.0
|
|
24764
25475
|
*/
|
|
24765
25476
|
|
|
24766
25477
|
/**
|
|
@@ -24927,7 +25638,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24927
25638
|
/**
|
|
24928
25639
|
* Integrations service.
|
|
24929
25640
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
24930
|
-
* @version
|
|
25641
|
+
* @version 174.0.0
|
|
24931
25642
|
*/
|
|
24932
25643
|
|
|
24933
25644
|
/**
|
|
@@ -26889,7 +27600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26889
27600
|
/**
|
|
26890
27601
|
* Journey service.
|
|
26891
27602
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
26892
|
-
* @version
|
|
27603
|
+
* @version 174.0.0
|
|
26893
27604
|
*/
|
|
26894
27605
|
|
|
26895
27606
|
/**
|
|
@@ -27089,6 +27800,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27089
27800
|
);
|
|
27090
27801
|
}
|
|
27091
27802
|
|
|
27803
|
+
/**
|
|
27804
|
+
* Retrieve all sessions for a given external contact.
|
|
27805
|
+
*
|
|
27806
|
+
* @param {String} contactId ExternalContact ID
|
|
27807
|
+
* @param {Object} opts Optional parameters
|
|
27808
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
27809
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
27810
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
27811
|
+
*/
|
|
27812
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
27813
|
+
opts = opts || {};
|
|
27814
|
+
|
|
27815
|
+
// verify the required parameter 'contactId' is set
|
|
27816
|
+
if (contactId === undefined || contactId === null) {
|
|
27817
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
27818
|
+
}
|
|
27819
|
+
|
|
27820
|
+
return this.apiClient.callApi(
|
|
27821
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
27822
|
+
'GET',
|
|
27823
|
+
{ 'contactId': contactId },
|
|
27824
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
27825
|
+
{ },
|
|
27826
|
+
{ },
|
|
27827
|
+
null,
|
|
27828
|
+
['PureCloud OAuth'],
|
|
27829
|
+
['application/json'],
|
|
27830
|
+
['application/json']
|
|
27831
|
+
);
|
|
27832
|
+
}
|
|
27833
|
+
|
|
27092
27834
|
/**
|
|
27093
27835
|
* Retrieve a single action map.
|
|
27094
27836
|
*
|
|
@@ -27889,6 +28631,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27889
28631
|
);
|
|
27890
28632
|
}
|
|
27891
28633
|
|
|
28634
|
+
/**
|
|
28635
|
+
* Send a journey app event, used for tracking customer activity on an application.
|
|
28636
|
+
*
|
|
28637
|
+
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
28638
|
+
* @param {Object} opts Optional parameters
|
|
28639
|
+
* @param {Object} opts.body
|
|
28640
|
+
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28641
|
+
*/
|
|
28642
|
+
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
28643
|
+
opts = opts || {};
|
|
28644
|
+
|
|
28645
|
+
// verify the required parameter 'deploymentId' is set
|
|
28646
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
28647
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
|
|
28648
|
+
}
|
|
28649
|
+
|
|
28650
|
+
return this.apiClient.callApi(
|
|
28651
|
+
'/api/v2/journey/deployments/{deploymentId}/appevents',
|
|
28652
|
+
'POST',
|
|
28653
|
+
{ 'deploymentId': deploymentId },
|
|
28654
|
+
{ },
|
|
28655
|
+
{ },
|
|
28656
|
+
{ },
|
|
28657
|
+
opts['body'],
|
|
28658
|
+
['PureCloud OAuth'],
|
|
28659
|
+
['application/json'],
|
|
28660
|
+
['application/json']
|
|
28661
|
+
);
|
|
28662
|
+
}
|
|
28663
|
+
|
|
27892
28664
|
/**
|
|
27893
28665
|
* Create an outcome.
|
|
27894
28666
|
*
|
|
@@ -27992,7 +28764,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27992
28764
|
/**
|
|
27993
28765
|
* Knowledge service.
|
|
27994
28766
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
27995
|
-
* @version
|
|
28767
|
+
* @version 174.0.0
|
|
27996
28768
|
*/
|
|
27997
28769
|
|
|
27998
28770
|
/**
|
|
@@ -28549,6 +29321,85 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28549
29321
|
);
|
|
28550
29322
|
}
|
|
28551
29323
|
|
|
29324
|
+
/**
|
|
29325
|
+
* Get a list of feedback records given on a document
|
|
29326
|
+
*
|
|
29327
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
29328
|
+
* @param {String} documentId Document ID.
|
|
29329
|
+
* @param {Object} opts Optional parameters
|
|
29330
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
29331
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
29332
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
29333
|
+
* @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.
|
|
29334
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
29335
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
29336
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
29337
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
29338
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
29339
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
29340
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
29341
|
+
*/
|
|
29342
|
+
getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
29343
|
+
opts = opts || {};
|
|
29344
|
+
|
|
29345
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
29346
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
29347
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
29348
|
+
}
|
|
29349
|
+
// verify the required parameter 'documentId' is set
|
|
29350
|
+
if (documentId === undefined || documentId === null) {
|
|
29351
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
29352
|
+
}
|
|
29353
|
+
|
|
29354
|
+
return this.apiClient.callApi(
|
|
29355
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
29356
|
+
'GET',
|
|
29357
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
29358
|
+
{ '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'] },
|
|
29359
|
+
{ },
|
|
29360
|
+
{ },
|
|
29361
|
+
null,
|
|
29362
|
+
['PureCloud OAuth'],
|
|
29363
|
+
['application/json'],
|
|
29364
|
+
['application/json']
|
|
29365
|
+
);
|
|
29366
|
+
}
|
|
29367
|
+
|
|
29368
|
+
/**
|
|
29369
|
+
* Get a single feedback record given on a document
|
|
29370
|
+
*
|
|
29371
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
29372
|
+
* @param {String} documentId Document ID.
|
|
29373
|
+
* @param {String} feedbackId Feedback ID.
|
|
29374
|
+
*/
|
|
29375
|
+
getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
|
|
29376
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
29377
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
29378
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29379
|
+
}
|
|
29380
|
+
// verify the required parameter 'documentId' is set
|
|
29381
|
+
if (documentId === undefined || documentId === null) {
|
|
29382
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29383
|
+
}
|
|
29384
|
+
// verify the required parameter 'feedbackId' is set
|
|
29385
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
29386
|
+
throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29387
|
+
}
|
|
29388
|
+
|
|
29389
|
+
return this.apiClient.callApi(
|
|
29390
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
29391
|
+
'GET',
|
|
29392
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
29393
|
+
{ },
|
|
29394
|
+
{ },
|
|
29395
|
+
{ },
|
|
29396
|
+
null,
|
|
29397
|
+
['PureCloud OAuth'],
|
|
29398
|
+
['application/json'],
|
|
29399
|
+
['application/json']
|
|
29400
|
+
);
|
|
29401
|
+
}
|
|
29402
|
+
|
|
28552
29403
|
/**
|
|
28553
29404
|
* Get a variation for a document.
|
|
28554
29405
|
*
|
|
@@ -28856,8 +29707,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28856
29707
|
*
|
|
28857
29708
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28858
29709
|
* @param {String} importJobId Import job ID
|
|
29710
|
+
* @param {Object} opts Optional parameters
|
|
29711
|
+
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
28859
29712
|
*/
|
|
28860
|
-
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
29713
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
|
|
29714
|
+
opts = opts || {};
|
|
29715
|
+
|
|
28861
29716
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
28862
29717
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
28863
29718
|
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
@@ -28871,7 +29726,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28871
29726
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
28872
29727
|
'GET',
|
|
28873
29728
|
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
28874
|
-
{
|
|
29729
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
28875
29730
|
{ },
|
|
28876
29731
|
{ },
|
|
28877
29732
|
null,
|
|
@@ -29894,6 +30749,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29894
30749
|
);
|
|
29895
30750
|
}
|
|
29896
30751
|
|
|
30752
|
+
/**
|
|
30753
|
+
* Give feedback on a document
|
|
30754
|
+
*
|
|
30755
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
30756
|
+
* @param {String} documentId Document ID.
|
|
30757
|
+
* @param {Object} opts Optional parameters
|
|
30758
|
+
* @param {Object} opts.body
|
|
30759
|
+
*/
|
|
30760
|
+
postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
|
|
30761
|
+
opts = opts || {};
|
|
30762
|
+
|
|
30763
|
+
// verify the required parameter 'sessionId' is set
|
|
30764
|
+
if (sessionId === undefined || sessionId === null) {
|
|
30765
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
30766
|
+
}
|
|
30767
|
+
// verify the required parameter 'documentId' is set
|
|
30768
|
+
if (documentId === undefined || documentId === null) {
|
|
30769
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
30770
|
+
}
|
|
30771
|
+
|
|
30772
|
+
return this.apiClient.callApi(
|
|
30773
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
|
|
30774
|
+
'POST',
|
|
30775
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
30776
|
+
{ },
|
|
30777
|
+
{ },
|
|
30778
|
+
{ },
|
|
30779
|
+
opts['body'],
|
|
30780
|
+
['PureCloud OAuth'],
|
|
30781
|
+
['application/json'],
|
|
30782
|
+
['application/json']
|
|
30783
|
+
);
|
|
30784
|
+
}
|
|
30785
|
+
|
|
29897
30786
|
/**
|
|
29898
30787
|
* Search the documents in a guest session.
|
|
29899
30788
|
*
|
|
@@ -30008,6 +30897,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30008
30897
|
);
|
|
30009
30898
|
}
|
|
30010
30899
|
|
|
30900
|
+
/**
|
|
30901
|
+
* Give feedback on a document
|
|
30902
|
+
*
|
|
30903
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
30904
|
+
* @param {String} documentId Document ID.
|
|
30905
|
+
* @param {Object} opts Optional parameters
|
|
30906
|
+
* @param {Object} opts.body
|
|
30907
|
+
*/
|
|
30908
|
+
postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
30909
|
+
opts = opts || {};
|
|
30910
|
+
|
|
30911
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
30912
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
30913
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
30914
|
+
}
|
|
30915
|
+
// verify the required parameter 'documentId' is set
|
|
30916
|
+
if (documentId === undefined || documentId === null) {
|
|
30917
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
30918
|
+
}
|
|
30919
|
+
|
|
30920
|
+
return this.apiClient.callApi(
|
|
30921
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
30922
|
+
'POST',
|
|
30923
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
30924
|
+
{ },
|
|
30925
|
+
{ },
|
|
30926
|
+
{ },
|
|
30927
|
+
opts['body'],
|
|
30928
|
+
['PureCloud OAuth'],
|
|
30929
|
+
['application/json'],
|
|
30930
|
+
['application/json']
|
|
30931
|
+
);
|
|
30932
|
+
}
|
|
30933
|
+
|
|
30011
30934
|
/**
|
|
30012
30935
|
* Create a variation for a document.
|
|
30013
30936
|
*
|
|
@@ -30078,6 +31001,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30078
31001
|
);
|
|
30079
31002
|
}
|
|
30080
31003
|
|
|
31004
|
+
/**
|
|
31005
|
+
* Create view for a document.
|
|
31006
|
+
*
|
|
31007
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31008
|
+
* @param {String} documentId Document ID.
|
|
31009
|
+
* @param {Object} opts Optional parameters
|
|
31010
|
+
* @param {Object} opts.body
|
|
31011
|
+
*/
|
|
31012
|
+
postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
|
|
31013
|
+
opts = opts || {};
|
|
31014
|
+
|
|
31015
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31016
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31017
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
31018
|
+
}
|
|
31019
|
+
// verify the required parameter 'documentId' is set
|
|
31020
|
+
if (documentId === undefined || documentId === null) {
|
|
31021
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
31022
|
+
}
|
|
31023
|
+
|
|
31024
|
+
return this.apiClient.callApi(
|
|
31025
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
|
|
31026
|
+
'POST',
|
|
31027
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31028
|
+
{ },
|
|
31029
|
+
{ },
|
|
31030
|
+
{ },
|
|
31031
|
+
opts['body'],
|
|
31032
|
+
['PureCloud OAuth'],
|
|
31033
|
+
['application/json'],
|
|
31034
|
+
['application/json']
|
|
31035
|
+
);
|
|
31036
|
+
}
|
|
31037
|
+
|
|
30081
31038
|
/**
|
|
30082
31039
|
* Create document.
|
|
30083
31040
|
*
|
|
@@ -30628,7 +31585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30628
31585
|
/**
|
|
30629
31586
|
* LanguageUnderstanding service.
|
|
30630
31587
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
30631
|
-
* @version
|
|
31588
|
+
* @version 174.0.0
|
|
30632
31589
|
*/
|
|
30633
31590
|
|
|
30634
31591
|
/**
|
|
@@ -31641,7 +32598,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31641
32598
|
/**
|
|
31642
32599
|
* Languages service.
|
|
31643
32600
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
31644
|
-
* @version
|
|
32601
|
+
* @version 174.0.0
|
|
31645
32602
|
*/
|
|
31646
32603
|
|
|
31647
32604
|
/**
|
|
@@ -31863,7 +32820,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31863
32820
|
/**
|
|
31864
32821
|
* Learning service.
|
|
31865
32822
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
31866
|
-
* @version
|
|
32823
|
+
* @version 174.0.0
|
|
31867
32824
|
*/
|
|
31868
32825
|
|
|
31869
32826
|
/**
|
|
@@ -32678,7 +33635,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32678
33635
|
/**
|
|
32679
33636
|
* License service.
|
|
32680
33637
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
32681
|
-
* @version
|
|
33638
|
+
* @version 174.0.0
|
|
32682
33639
|
*/
|
|
32683
33640
|
|
|
32684
33641
|
/**
|
|
@@ -32916,7 +33873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32916
33873
|
/**
|
|
32917
33874
|
* Locations service.
|
|
32918
33875
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
32919
|
-
* @version
|
|
33876
|
+
* @version 174.0.0
|
|
32920
33877
|
*/
|
|
32921
33878
|
|
|
32922
33879
|
/**
|
|
@@ -33152,7 +34109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33152
34109
|
/**
|
|
33153
34110
|
* Messaging service.
|
|
33154
34111
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
33155
|
-
* @version
|
|
34112
|
+
* @version 174.0.0
|
|
33156
34113
|
*/
|
|
33157
34114
|
|
|
33158
34115
|
/**
|
|
@@ -33511,7 +34468,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33511
34468
|
/**
|
|
33512
34469
|
* MobileDevices service.
|
|
33513
34470
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
33514
|
-
* @version
|
|
34471
|
+
* @version 174.0.0
|
|
33515
34472
|
*/
|
|
33516
34473
|
|
|
33517
34474
|
/**
|
|
@@ -33662,7 +34619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33662
34619
|
/**
|
|
33663
34620
|
* Notifications service.
|
|
33664
34621
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
33665
|
-
* @version
|
|
34622
|
+
* @version 174.0.0
|
|
33666
34623
|
*/
|
|
33667
34624
|
|
|
33668
34625
|
/**
|
|
@@ -33895,7 +34852,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33895
34852
|
/**
|
|
33896
34853
|
* OAuth service.
|
|
33897
34854
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
33898
|
-
* @version
|
|
34855
|
+
* @version 174.0.0
|
|
33899
34856
|
*/
|
|
33900
34857
|
|
|
33901
34858
|
/**
|
|
@@ -34261,7 +35218,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34261
35218
|
/**
|
|
34262
35219
|
* Objects service.
|
|
34263
35220
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
34264
|
-
* @version
|
|
35221
|
+
* @version 174.0.0
|
|
34265
35222
|
*/
|
|
34266
35223
|
|
|
34267
35224
|
/**
|
|
@@ -34532,7 +35489,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34532
35489
|
/**
|
|
34533
35490
|
* Organization service.
|
|
34534
35491
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
34535
|
-
* @version
|
|
35492
|
+
* @version 174.0.0
|
|
34536
35493
|
*/
|
|
34537
35494
|
|
|
34538
35495
|
/**
|
|
@@ -34987,7 +35944,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34987
35944
|
/**
|
|
34988
35945
|
* OrganizationAuthorization service.
|
|
34989
35946
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
34990
|
-
* @version
|
|
35947
|
+
* @version 174.0.0
|
|
34991
35948
|
*/
|
|
34992
35949
|
|
|
34993
35950
|
/**
|
|
@@ -36334,7 +37291,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36334
37291
|
/**
|
|
36335
37292
|
* Outbound service.
|
|
36336
37293
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
36337
|
-
* @version
|
|
37294
|
+
* @version 174.0.0
|
|
36338
37295
|
*/
|
|
36339
37296
|
|
|
36340
37297
|
/**
|
|
@@ -39956,7 +40913,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39956
40913
|
/**
|
|
39957
40914
|
* Presence service.
|
|
39958
40915
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39959
|
-
* @version
|
|
40916
|
+
* @version 174.0.0
|
|
39960
40917
|
*/
|
|
39961
40918
|
|
|
39962
40919
|
/**
|
|
@@ -40695,7 +41652,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40695
41652
|
/**
|
|
40696
41653
|
* ProcessAutomation service.
|
|
40697
41654
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
40698
|
-
* @version
|
|
41655
|
+
* @version 174.0.0
|
|
40699
41656
|
*/
|
|
40700
41657
|
|
|
40701
41658
|
/**
|
|
@@ -40934,7 +41891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40934
41891
|
/**
|
|
40935
41892
|
* Quality service.
|
|
40936
41893
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
40937
|
-
* @version
|
|
41894
|
+
* @version 174.0.0
|
|
40938
41895
|
*/
|
|
40939
41896
|
|
|
40940
41897
|
/**
|
|
@@ -41217,6 +42174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41217
42174
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
41218
42175
|
* @param {String} opts.name name
|
|
41219
42176
|
* @param {String} opts.group group id
|
|
42177
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
41220
42178
|
*/
|
|
41221
42179
|
getQualityAgentsActivity(opts) {
|
|
41222
42180
|
opts = opts || {};
|
|
@@ -41226,7 +42184,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41226
42184
|
'/api/v2/quality/agents/activity',
|
|
41227
42185
|
'GET',
|
|
41228
42186
|
{ },
|
|
41229
|
-
{ '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'] },
|
|
42187
|
+
{ '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'] },
|
|
41230
42188
|
{ },
|
|
41231
42189
|
{ },
|
|
41232
42190
|
null,
|
|
@@ -41424,9 +42382,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41424
42382
|
* @param {Object} opts Optional parameters
|
|
41425
42383
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
41426
42384
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
41427
|
-
* @param {String} opts.sortBy
|
|
42385
|
+
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
41428
42386
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
41429
|
-
* @param {String} opts.nextPage
|
|
42387
|
+
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
41430
42388
|
* @param {String} opts.previousPage Previous page token
|
|
41431
42389
|
* @param {String} opts.conversationId conversationId specified
|
|
41432
42390
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -41435,12 +42393,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41435
42393
|
* @param {String} opts.queueId queue id
|
|
41436
42394
|
* @param {String} opts.startTime start time of the evaluation query
|
|
41437
42395
|
* @param {String} opts.endTime end time of the evaluation query
|
|
42396
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
41438
42397
|
* @param {Array.<String>} opts.evaluationState
|
|
41439
42398
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
41440
42399
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
41441
42400
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
41442
|
-
* @param {Number} opts.maximum maximum
|
|
41443
|
-
* @param {String} opts.sortOrder
|
|
42401
|
+
* @param {Number} opts.maximum the maximum number of results to return
|
|
42402
|
+
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
41444
42403
|
*/
|
|
41445
42404
|
getQualityEvaluationsQuery(opts) {
|
|
41446
42405
|
opts = opts || {};
|
|
@@ -41450,7 +42409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41450
42409
|
'/api/v2/quality/evaluations/query',
|
|
41451
42410
|
'GET',
|
|
41452
42411
|
{ },
|
|
41453
|
-
{ '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'] },
|
|
42412
|
+
{ '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'] },
|
|
41454
42413
|
{ },
|
|
41455
42414
|
{ },
|
|
41456
42415
|
null,
|
|
@@ -42527,7 +43486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42527
43486
|
* @param {String} evaluationId evaluationId
|
|
42528
43487
|
* @param {Object} body evaluation
|
|
42529
43488
|
* @param {Object} opts Optional parameters
|
|
42530
|
-
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
43489
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
|
|
42531
43490
|
*/
|
|
42532
43491
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
42533
43492
|
opts = opts || {};
|
|
@@ -42686,7 +43645,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42686
43645
|
/**
|
|
42687
43646
|
* Recording service.
|
|
42688
43647
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
42689
|
-
* @version
|
|
43648
|
+
* @version 174.0.0
|
|
42690
43649
|
*/
|
|
42691
43650
|
|
|
42692
43651
|
/**
|
|
@@ -44323,7 +45282,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44323
45282
|
/**
|
|
44324
45283
|
* ResponseManagement service.
|
|
44325
45284
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
44326
|
-
* @version
|
|
45285
|
+
* @version 174.0.0
|
|
44327
45286
|
*/
|
|
44328
45287
|
|
|
44329
45288
|
/**
|
|
@@ -44808,7 +45767,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44808
45767
|
/**
|
|
44809
45768
|
* Routing service.
|
|
44810
45769
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
44811
|
-
* @version
|
|
45770
|
+
* @version 174.0.0
|
|
44812
45771
|
*/
|
|
44813
45772
|
|
|
44814
45773
|
/**
|
|
@@ -45815,6 +46774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45815
46774
|
*
|
|
45816
46775
|
* @param {Object} opts Optional parameters
|
|
45817
46776
|
* @param {Object} opts.messengerType Messenger Type
|
|
46777
|
+
* @param {String} opts.name Recipient Name
|
|
45818
46778
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
45819
46779
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
45820
46780
|
*/
|
|
@@ -45826,7 +46786,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45826
46786
|
'/api/v2/routing/message/recipients',
|
|
45827
46787
|
'GET',
|
|
45828
46788
|
{ },
|
|
45829
|
-
{ 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
46789
|
+
{ 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
45830
46790
|
{ },
|
|
45831
46791
|
{ },
|
|
45832
46792
|
null,
|
|
@@ -46117,10 +47077,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46117
47077
|
* @param {Number} opts.pageSize Max value is 100 (default to 25)
|
|
46118
47078
|
* @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
|
|
46119
47079
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
46120
|
-
* @param {String} opts.name Filter by queue member name
|
|
46121
|
-
* @param {Array.<String>} opts.profileSkills Filter by profile skill
|
|
46122
|
-
* @param {Array.<String>} opts.skills Filter by skill
|
|
46123
|
-
* @param {Array.<String>} opts.languages Filter by language
|
|
47080
|
+
* @param {String} opts.name Filter by queue member name (contains-style search)
|
|
47081
|
+
* @param {Array.<String>} opts.profileSkills Filter by profile skill (contains-style search)
|
|
47082
|
+
* @param {Array.<String>} opts.skills Filter by skill (contains-style search)
|
|
47083
|
+
* @param {Array.<String>} opts.languages Filter by language (contains-style search)
|
|
46124
47084
|
* @param {Array.<String>} opts.routingStatus Filter by routing status
|
|
46125
47085
|
* @param {Array.<String>} opts.presence Filter by presence
|
|
46126
47086
|
* @param {Object} opts.memberBy Filter by member type
|
|
@@ -48515,7 +49475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48515
49475
|
/**
|
|
48516
49476
|
* SCIM service.
|
|
48517
49477
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
48518
|
-
* @version
|
|
49478
|
+
* @version 174.0.0
|
|
48519
49479
|
*/
|
|
48520
49480
|
|
|
48521
49481
|
/**
|
|
@@ -49392,7 +50352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49392
50352
|
/**
|
|
49393
50353
|
* Scripts service.
|
|
49394
50354
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
49395
|
-
* @version
|
|
50355
|
+
* @version 174.0.0
|
|
49396
50356
|
*/
|
|
49397
50357
|
|
|
49398
50358
|
/**
|
|
@@ -49836,7 +50796,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49836
50796
|
/**
|
|
49837
50797
|
* Search service.
|
|
49838
50798
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
49839
|
-
* @version
|
|
50799
|
+
* @version 174.0.0
|
|
49840
50800
|
*/
|
|
49841
50801
|
|
|
49842
50802
|
/**
|
|
@@ -50525,7 +51485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50525
51485
|
/**
|
|
50526
51486
|
* Settings service.
|
|
50527
51487
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
50528
|
-
* @version
|
|
51488
|
+
* @version 174.0.0
|
|
50529
51489
|
*/
|
|
50530
51490
|
|
|
50531
51491
|
/**
|
|
@@ -50590,7 +51550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50590
51550
|
/**
|
|
50591
51551
|
* SpeechTextAnalytics service.
|
|
50592
51552
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
50593
|
-
* @version
|
|
51553
|
+
* @version 174.0.0
|
|
50594
51554
|
*/
|
|
50595
51555
|
|
|
50596
51556
|
/**
|
|
@@ -51573,7 +52533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51573
52533
|
/**
|
|
51574
52534
|
* Stations service.
|
|
51575
52535
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
51576
|
-
* @version
|
|
52536
|
+
* @version 174.0.0
|
|
51577
52537
|
*/
|
|
51578
52538
|
|
|
51579
52539
|
/**
|
|
@@ -51675,7 +52635,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51675
52635
|
/**
|
|
51676
52636
|
* Suggest service.
|
|
51677
52637
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
51678
|
-
* @version
|
|
52638
|
+
* @version 174.0.0
|
|
51679
52639
|
*/
|
|
51680
52640
|
|
|
51681
52641
|
/**
|
|
@@ -51814,7 +52774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51814
52774
|
/**
|
|
51815
52775
|
* TaskManagement service.
|
|
51816
52776
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
51817
|
-
* @version
|
|
52777
|
+
* @version 174.0.0
|
|
51818
52778
|
*/
|
|
51819
52779
|
|
|
51820
52780
|
/**
|
|
@@ -53095,7 +54055,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53095
54055
|
/**
|
|
53096
54056
|
* Teams service.
|
|
53097
54057
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
53098
|
-
* @version
|
|
54058
|
+
* @version 174.0.0
|
|
53099
54059
|
*/
|
|
53100
54060
|
|
|
53101
54061
|
/**
|
|
@@ -53397,7 +54357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53397
54357
|
/**
|
|
53398
54358
|
* Telephony service.
|
|
53399
54359
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
53400
|
-
* @version
|
|
54360
|
+
* @version 174.0.0
|
|
53401
54361
|
*/
|
|
53402
54362
|
|
|
53403
54363
|
/**
|
|
@@ -53525,7 +54485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53525
54485
|
/**
|
|
53526
54486
|
* TelephonyProvidersEdge service.
|
|
53527
54487
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
53528
|
-
* @version
|
|
54488
|
+
* @version 174.0.0
|
|
53529
54489
|
*/
|
|
53530
54490
|
|
|
53531
54491
|
/**
|
|
@@ -55188,7 +56148,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55188
56148
|
}
|
|
55189
56149
|
|
|
55190
56150
|
/**
|
|
55191
|
-
* Get a list of Phone Instances
|
|
56151
|
+
* 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.
|
|
55192
56152
|
*
|
|
55193
56153
|
* @param {Object} opts Optional parameters
|
|
55194
56154
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -56814,7 +57774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56814
57774
|
/**
|
|
56815
57775
|
* Textbots service.
|
|
56816
57776
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
56817
|
-
* @version
|
|
57777
|
+
* @version 174.0.0
|
|
56818
57778
|
*/
|
|
56819
57779
|
|
|
56820
57780
|
/**
|
|
@@ -56942,7 +57902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56942
57902
|
/**
|
|
56943
57903
|
* Tokens service.
|
|
56944
57904
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
56945
|
-
* @version
|
|
57905
|
+
* @version 174.0.0
|
|
56946
57906
|
*/
|
|
56947
57907
|
|
|
56948
57908
|
/**
|
|
@@ -57005,14 +57965,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57005
57965
|
/**
|
|
57006
57966
|
* Fetch information about the current token
|
|
57007
57967
|
*
|
|
57968
|
+
* @param {Object} opts Optional parameters
|
|
57969
|
+
* @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.
|
|
57008
57970
|
*/
|
|
57009
|
-
getTokensMe() {
|
|
57971
|
+
getTokensMe(opts) {
|
|
57972
|
+
opts = opts || {};
|
|
57973
|
+
|
|
57010
57974
|
|
|
57011
57975
|
return this.apiClient.callApi(
|
|
57012
57976
|
'/api/v2/tokens/me',
|
|
57013
57977
|
'GET',
|
|
57014
57978
|
{ },
|
|
57015
|
-
{
|
|
57979
|
+
{ 'preserveIdleTTL': opts['preserveIdleTTL'] },
|
|
57016
57980
|
{ },
|
|
57017
57981
|
{ },
|
|
57018
57982
|
null,
|
|
@@ -57094,7 +58058,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57094
58058
|
/**
|
|
57095
58059
|
* Uploads service.
|
|
57096
58060
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
57097
|
-
* @version
|
|
58061
|
+
* @version 174.0.0
|
|
57098
58062
|
*/
|
|
57099
58063
|
|
|
57100
58064
|
/**
|
|
@@ -57270,7 +58234,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57270
58234
|
/**
|
|
57271
58235
|
* Usage service.
|
|
57272
58236
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
57273
|
-
* @version
|
|
58237
|
+
* @version 174.0.0
|
|
57274
58238
|
*/
|
|
57275
58239
|
|
|
57276
58240
|
/**
|
|
@@ -57480,7 +58444,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57480
58444
|
/**
|
|
57481
58445
|
* UserRecordings service.
|
|
57482
58446
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
57483
|
-
* @version
|
|
58447
|
+
* @version 174.0.0
|
|
57484
58448
|
*/
|
|
57485
58449
|
|
|
57486
58450
|
/**
|
|
@@ -57665,7 +58629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57665
58629
|
/**
|
|
57666
58630
|
* Users service.
|
|
57667
58631
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
57668
|
-
* @version
|
|
58632
|
+
* @version 174.0.0
|
|
57669
58633
|
*/
|
|
57670
58634
|
|
|
57671
58635
|
/**
|
|
@@ -60226,7 +61190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60226
61190
|
/**
|
|
60227
61191
|
* Utilities service.
|
|
60228
61192
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
60229
|
-
* @version
|
|
61193
|
+
* @version 174.0.0
|
|
60230
61194
|
*/
|
|
60231
61195
|
|
|
60232
61196
|
/**
|
|
@@ -60337,7 +61301,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60337
61301
|
/**
|
|
60338
61302
|
* Voicemail service.
|
|
60339
61303
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
60340
|
-
* @version
|
|
61304
|
+
* @version 174.0.0
|
|
60341
61305
|
*/
|
|
60342
61306
|
|
|
60343
61307
|
/**
|
|
@@ -61004,7 +61968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61004
61968
|
/**
|
|
61005
61969
|
* WebChat service.
|
|
61006
61970
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
61007
|
-
* @version
|
|
61971
|
+
* @version 174.0.0
|
|
61008
61972
|
*/
|
|
61009
61973
|
|
|
61010
61974
|
/**
|
|
@@ -61553,7 +62517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61553
62517
|
/**
|
|
61554
62518
|
* WebDeployments service.
|
|
61555
62519
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
61556
|
-
* @version
|
|
62520
|
+
* @version 174.0.0
|
|
61557
62521
|
*/
|
|
61558
62522
|
|
|
61559
62523
|
/**
|
|
@@ -61781,8 +62745,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61781
62745
|
* Get a deployment
|
|
61782
62746
|
*
|
|
61783
62747
|
* @param {String} deploymentId The deployment ID
|
|
62748
|
+
* @param {Object} opts Optional parameters
|
|
62749
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
61784
62750
|
*/
|
|
61785
|
-
getWebdeploymentsDeployment(deploymentId) {
|
|
62751
|
+
getWebdeploymentsDeployment(deploymentId, opts) {
|
|
62752
|
+
opts = opts || {};
|
|
62753
|
+
|
|
61786
62754
|
// verify the required parameter 'deploymentId' is set
|
|
61787
62755
|
if (deploymentId === undefined || deploymentId === null) {
|
|
61788
62756
|
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
|
|
@@ -61792,7 +62760,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61792
62760
|
'/api/v2/webdeployments/deployments/{deploymentId}',
|
|
61793
62761
|
'GET',
|
|
61794
62762
|
{ 'deploymentId': deploymentId },
|
|
61795
|
-
{
|
|
62763
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61796
62764
|
{ },
|
|
61797
62765
|
{ },
|
|
61798
62766
|
null,
|
|
@@ -61838,6 +62806,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61838
62806
|
* @param {String} deploymentId The deployment ID
|
|
61839
62807
|
* @param {Object} opts Optional parameters
|
|
61840
62808
|
* @param {String} opts.type Get active configuration on a deployment
|
|
62809
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
61841
62810
|
*/
|
|
61842
62811
|
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
61843
62812
|
opts = opts || {};
|
|
@@ -61851,7 +62820,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61851
62820
|
'/api/v2/webdeployments/deployments/{deploymentId}/configurations',
|
|
61852
62821
|
'GET',
|
|
61853
62822
|
{ 'deploymentId': deploymentId },
|
|
61854
|
-
{ 'type': opts['type'] },
|
|
62823
|
+
{ 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61855
62824
|
{ },
|
|
61856
62825
|
{ },
|
|
61857
62826
|
null,
|
|
@@ -61865,7 +62834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61865
62834
|
* Get deployments
|
|
61866
62835
|
*
|
|
61867
62836
|
* @param {Object} opts Optional parameters
|
|
61868
|
-
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
62837
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
61869
62838
|
*/
|
|
61870
62839
|
getWebdeploymentsDeployments(opts) {
|
|
61871
62840
|
opts = opts || {};
|
|
@@ -62075,7 +63044,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62075
63044
|
/**
|
|
62076
63045
|
* WebMessaging service.
|
|
62077
63046
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
62078
|
-
* @version
|
|
63047
|
+
* @version 174.0.0
|
|
62079
63048
|
*/
|
|
62080
63049
|
|
|
62081
63050
|
/**
|
|
@@ -62121,7 +63090,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62121
63090
|
/**
|
|
62122
63091
|
* Widgets service.
|
|
62123
63092
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
62124
|
-
* @version
|
|
63093
|
+
* @version 174.0.0
|
|
62125
63094
|
*/
|
|
62126
63095
|
|
|
62127
63096
|
/**
|
|
@@ -62267,7 +63236,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62267
63236
|
/**
|
|
62268
63237
|
* WorkforceManagement service.
|
|
62269
63238
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
62270
|
-
* @version
|
|
63239
|
+
* @version 174.0.0
|
|
62271
63240
|
*/
|
|
62272
63241
|
|
|
62273
63242
|
/**
|
|
@@ -63186,8 +64155,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63186
64155
|
*
|
|
63187
64156
|
* @param {String} businessUnitId The ID of the business unit.
|
|
63188
64157
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
|
|
64158
|
+
* @param {Object} opts Optional parameters
|
|
64159
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
63189
64160
|
*/
|
|
63190
|
-
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) {
|
|
64161
|
+
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) {
|
|
64162
|
+
opts = opts || {};
|
|
64163
|
+
|
|
63191
64164
|
// verify the required parameter 'businessUnitId' is set
|
|
63192
64165
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
63193
64166
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -63201,7 +64174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63201
64174
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
63202
64175
|
'GET',
|
|
63203
64176
|
{ 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
|
|
63204
|
-
{
|
|
64177
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63205
64178
|
{ },
|
|
63206
64179
|
{ },
|
|
63207
64180
|
null,
|
|
@@ -63215,8 +64188,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63215
64188
|
* Gets list of service goal templates
|
|
63216
64189
|
*
|
|
63217
64190
|
* @param {String} businessUnitId The ID of the business unit.
|
|
64191
|
+
* @param {Object} opts Optional parameters
|
|
64192
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
63218
64193
|
*/
|
|
63219
|
-
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) {
|
|
64194
|
+
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) {
|
|
64195
|
+
opts = opts || {};
|
|
64196
|
+
|
|
63220
64197
|
// verify the required parameter 'businessUnitId' is set
|
|
63221
64198
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
63222
64199
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
@@ -63226,7 +64203,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63226
64203
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
63227
64204
|
'GET',
|
|
63228
64205
|
{ 'businessUnitId': businessUnitId },
|
|
63229
|
-
{
|
|
64206
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63230
64207
|
{ },
|
|
63231
64208
|
{ },
|
|
63232
64209
|
null,
|
|
@@ -63776,6 +64753,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63776
64753
|
);
|
|
63777
64754
|
}
|
|
63778
64755
|
|
|
64756
|
+
/**
|
|
64757
|
+
* Get integrations
|
|
64758
|
+
*
|
|
64759
|
+
*/
|
|
64760
|
+
getWorkforcemanagementIntegrationsHris() {
|
|
64761
|
+
|
|
64762
|
+
return this.apiClient.callApi(
|
|
64763
|
+
'/api/v2/workforcemanagement/integrations/hris',
|
|
64764
|
+
'GET',
|
|
64765
|
+
{ },
|
|
64766
|
+
{ },
|
|
64767
|
+
{ },
|
|
64768
|
+
{ },
|
|
64769
|
+
null,
|
|
64770
|
+
['PureCloud OAuth'],
|
|
64771
|
+
['application/json'],
|
|
64772
|
+
['application/json']
|
|
64773
|
+
);
|
|
64774
|
+
}
|
|
64775
|
+
|
|
64776
|
+
/**
|
|
64777
|
+
* Query the results of time off types job
|
|
64778
|
+
*
|
|
64779
|
+
* @param {String} jobId The ID of the job.
|
|
64780
|
+
*/
|
|
64781
|
+
getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) {
|
|
64782
|
+
// verify the required parameter 'jobId' is set
|
|
64783
|
+
if (jobId === undefined || jobId === null) {
|
|
64784
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
|
|
64785
|
+
}
|
|
64786
|
+
|
|
64787
|
+
return this.apiClient.callApi(
|
|
64788
|
+
'/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}',
|
|
64789
|
+
'GET',
|
|
64790
|
+
{ 'jobId': jobId },
|
|
64791
|
+
{ },
|
|
64792
|
+
{ },
|
|
64793
|
+
{ },
|
|
64794
|
+
null,
|
|
64795
|
+
['PureCloud OAuth'],
|
|
64796
|
+
['application/json'],
|
|
64797
|
+
['application/json']
|
|
64798
|
+
);
|
|
64799
|
+
}
|
|
64800
|
+
|
|
63779
64801
|
/**
|
|
63780
64802
|
* Get management unit
|
|
63781
64803
|
* settings.shortTermForecasting is deprecated and now lives on the business unit
|
|
@@ -63806,7 +64828,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63806
64828
|
}
|
|
63807
64829
|
|
|
63808
64830
|
/**
|
|
63809
|
-
* Get activity codes
|
|
64831
|
+
* Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
|
|
63810
64832
|
*
|
|
63811
64833
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
63812
64834
|
* @deprecated
|
|
@@ -64589,6 +65611,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64589
65611
|
);
|
|
64590
65612
|
}
|
|
64591
65613
|
|
|
65614
|
+
/**
|
|
65615
|
+
* Query the results of time off types job
|
|
65616
|
+
*
|
|
65617
|
+
* @param {String} jobId The ID of the job.
|
|
65618
|
+
*/
|
|
65619
|
+
getWorkforcemanagementTimeoffbalanceJob(jobId) {
|
|
65620
|
+
// verify the required parameter 'jobId' is set
|
|
65621
|
+
if (jobId === undefined || jobId === null) {
|
|
65622
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
|
|
65623
|
+
}
|
|
65624
|
+
|
|
65625
|
+
return this.apiClient.callApi(
|
|
65626
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}',
|
|
65627
|
+
'GET',
|
|
65628
|
+
{ 'jobId': jobId },
|
|
65629
|
+
{ },
|
|
65630
|
+
{ },
|
|
65631
|
+
{ },
|
|
65632
|
+
null,
|
|
65633
|
+
['PureCloud OAuth'],
|
|
65634
|
+
['application/json'],
|
|
65635
|
+
['application/json']
|
|
65636
|
+
);
|
|
65637
|
+
}
|
|
65638
|
+
|
|
64592
65639
|
/**
|
|
64593
65640
|
* Get a time off request for the current user
|
|
64594
65641
|
*
|
|
@@ -64960,6 +66007,45 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64960
66007
|
);
|
|
64961
66008
|
}
|
|
64962
66009
|
|
|
66010
|
+
/**
|
|
66011
|
+
* Set integration status for a time off request.
|
|
66012
|
+
*
|
|
66013
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
66014
|
+
* @param {String} timeOffRequestId The ID of the time off request.
|
|
66015
|
+
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
66016
|
+
* @param {Object} opts Optional parameters
|
|
66017
|
+
* @param {Object} opts.body body
|
|
66018
|
+
*/
|
|
66019
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) {
|
|
66020
|
+
opts = opts || {};
|
|
66021
|
+
|
|
66022
|
+
// verify the required parameter 'managementUnitId' is set
|
|
66023
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
66024
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66025
|
+
}
|
|
66026
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
66027
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
66028
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66029
|
+
}
|
|
66030
|
+
// verify the required parameter 'userId' is set
|
|
66031
|
+
if (userId === undefined || userId === null) {
|
|
66032
|
+
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66033
|
+
}
|
|
66034
|
+
|
|
66035
|
+
return this.apiClient.callApi(
|
|
66036
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
66037
|
+
'PATCH',
|
|
66038
|
+
{ 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
|
|
66039
|
+
{ },
|
|
66040
|
+
{ },
|
|
66041
|
+
{ },
|
|
66042
|
+
opts['body'],
|
|
66043
|
+
['PureCloud OAuth'],
|
|
66044
|
+
['application/json'],
|
|
66045
|
+
['application/json']
|
|
66046
|
+
);
|
|
66047
|
+
}
|
|
66048
|
+
|
|
64963
66049
|
/**
|
|
64964
66050
|
* Update a time off request
|
|
64965
66051
|
*
|
|
@@ -65197,6 +66283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65197
66283
|
*
|
|
65198
66284
|
* @param {Object} opts Optional parameters
|
|
65199
66285
|
* @param {Object} opts.body body
|
|
66286
|
+
* @deprecated
|
|
65200
66287
|
*/
|
|
65201
66288
|
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
65202
66289
|
opts = opts || {};
|
|
@@ -65305,6 +66392,54 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65305
66392
|
);
|
|
65306
66393
|
}
|
|
65307
66394
|
|
|
66395
|
+
/**
|
|
66396
|
+
* Move agents in and out of management unit
|
|
66397
|
+
*
|
|
66398
|
+
* @param {Object} opts Optional parameters
|
|
66399
|
+
* @param {Object} opts.body body
|
|
66400
|
+
*/
|
|
66401
|
+
postWorkforcemanagementAgents(opts) {
|
|
66402
|
+
opts = opts || {};
|
|
66403
|
+
|
|
66404
|
+
|
|
66405
|
+
return this.apiClient.callApi(
|
|
66406
|
+
'/api/v2/workforcemanagement/agents',
|
|
66407
|
+
'POST',
|
|
66408
|
+
{ },
|
|
66409
|
+
{ },
|
|
66410
|
+
{ },
|
|
66411
|
+
{ },
|
|
66412
|
+
opts['body'],
|
|
66413
|
+
['PureCloud OAuth'],
|
|
66414
|
+
['application/json'],
|
|
66415
|
+
['application/json']
|
|
66416
|
+
);
|
|
66417
|
+
}
|
|
66418
|
+
|
|
66419
|
+
/**
|
|
66420
|
+
* Query integrations for agents
|
|
66421
|
+
*
|
|
66422
|
+
* @param {Object} opts Optional parameters
|
|
66423
|
+
* @param {Object} opts.body body
|
|
66424
|
+
*/
|
|
66425
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) {
|
|
66426
|
+
opts = opts || {};
|
|
66427
|
+
|
|
66428
|
+
|
|
66429
|
+
return this.apiClient.callApi(
|
|
66430
|
+
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
66431
|
+
'POST',
|
|
66432
|
+
{ },
|
|
66433
|
+
{ },
|
|
66434
|
+
{ },
|
|
66435
|
+
{ },
|
|
66436
|
+
opts['body'],
|
|
66437
|
+
['PureCloud OAuth'],
|
|
66438
|
+
['application/json'],
|
|
66439
|
+
['application/json']
|
|
66440
|
+
);
|
|
66441
|
+
}
|
|
66442
|
+
|
|
65308
66443
|
/**
|
|
65309
66444
|
* Get agent possible work shifts for requested time frame
|
|
65310
66445
|
*
|
|
@@ -66127,6 +67262,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66127
67262
|
);
|
|
66128
67263
|
}
|
|
66129
67264
|
|
|
67265
|
+
/**
|
|
67266
|
+
* Get list of time off types configured in integration
|
|
67267
|
+
*
|
|
67268
|
+
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
67269
|
+
*/
|
|
67270
|
+
postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) {
|
|
67271
|
+
// verify the required parameter 'hrisIntegrationId' is set
|
|
67272
|
+
if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
|
|
67273
|
+
throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
|
|
67274
|
+
}
|
|
67275
|
+
|
|
67276
|
+
return this.apiClient.callApi(
|
|
67277
|
+
'/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs',
|
|
67278
|
+
'POST',
|
|
67279
|
+
{ 'hrisIntegrationId': hrisIntegrationId },
|
|
67280
|
+
{ },
|
|
67281
|
+
{ },
|
|
67282
|
+
{ },
|
|
67283
|
+
null,
|
|
67284
|
+
['PureCloud OAuth'],
|
|
67285
|
+
['application/json'],
|
|
67286
|
+
['application/json']
|
|
67287
|
+
);
|
|
67288
|
+
}
|
|
67289
|
+
|
|
66130
67290
|
/**
|
|
66131
67291
|
* Query published schedules for given given time range for set of users
|
|
66132
67292
|
*
|
|
@@ -66391,6 +67551,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66391
67551
|
);
|
|
66392
67552
|
}
|
|
66393
67553
|
|
|
67554
|
+
/**
|
|
67555
|
+
* Retrieves integration statuses for a list of time off requests
|
|
67556
|
+
*
|
|
67557
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
67558
|
+
* @param {Object} opts Optional parameters
|
|
67559
|
+
* @param {Object} opts.body body
|
|
67560
|
+
*/
|
|
67561
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) {
|
|
67562
|
+
opts = opts || {};
|
|
67563
|
+
|
|
67564
|
+
// verify the required parameter 'managementUnitId' is set
|
|
67565
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
67566
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
67567
|
+
}
|
|
67568
|
+
|
|
67569
|
+
return this.apiClient.callApi(
|
|
67570
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
67571
|
+
'POST',
|
|
67572
|
+
{ 'managementUnitId': managementUnitId },
|
|
67573
|
+
{ },
|
|
67574
|
+
{ },
|
|
67575
|
+
{ },
|
|
67576
|
+
opts['body'],
|
|
67577
|
+
['PureCloud OAuth'],
|
|
67578
|
+
['application/json'],
|
|
67579
|
+
['application/json']
|
|
67580
|
+
);
|
|
67581
|
+
}
|
|
67582
|
+
|
|
66394
67583
|
/**
|
|
66395
67584
|
* Fetches time off requests matching the conditions specified in the request body
|
|
66396
67585
|
* 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
|
|
@@ -66519,6 +67708,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66519
67708
|
);
|
|
66520
67709
|
}
|
|
66521
67710
|
|
|
67711
|
+
/**
|
|
67712
|
+
* Estimates available time off for an agent
|
|
67713
|
+
*
|
|
67714
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
67715
|
+
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
67716
|
+
* @param {Object} opts Optional parameters
|
|
67717
|
+
* @param {Object} opts.body body
|
|
67718
|
+
*/
|
|
67719
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) {
|
|
67720
|
+
opts = opts || {};
|
|
67721
|
+
|
|
67722
|
+
// verify the required parameter 'managementUnitId' is set
|
|
67723
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
67724
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
67725
|
+
}
|
|
67726
|
+
// verify the required parameter 'userId' is set
|
|
67727
|
+
if (userId === undefined || userId === null) {
|
|
67728
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
67729
|
+
}
|
|
67730
|
+
|
|
67731
|
+
return this.apiClient.callApi(
|
|
67732
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
67733
|
+
'POST',
|
|
67734
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
67735
|
+
{ },
|
|
67736
|
+
{ },
|
|
67737
|
+
{ },
|
|
67738
|
+
opts['body'],
|
|
67739
|
+
['PureCloud OAuth'],
|
|
67740
|
+
['application/json'],
|
|
67741
|
+
['application/json']
|
|
67742
|
+
);
|
|
67743
|
+
}
|
|
67744
|
+
|
|
66522
67745
|
/**
|
|
66523
67746
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
66524
67747
|
*
|
|
@@ -66961,6 +68184,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66961
68184
|
);
|
|
66962
68185
|
}
|
|
66963
68186
|
|
|
68187
|
+
/**
|
|
68188
|
+
* Query time off balances for the current user for specified activity code and dates
|
|
68189
|
+
*
|
|
68190
|
+
* @param {Object} body The request body
|
|
68191
|
+
*/
|
|
68192
|
+
postWorkforcemanagementTimeoffbalanceJobs(body) {
|
|
68193
|
+
// verify the required parameter 'body' is set
|
|
68194
|
+
if (body === undefined || body === null) {
|
|
68195
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
|
|
68196
|
+
}
|
|
68197
|
+
|
|
68198
|
+
return this.apiClient.callApi(
|
|
68199
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs',
|
|
68200
|
+
'POST',
|
|
68201
|
+
{ },
|
|
68202
|
+
{ },
|
|
68203
|
+
{ },
|
|
68204
|
+
{ },
|
|
68205
|
+
body,
|
|
68206
|
+
['PureCloud OAuth'],
|
|
68207
|
+
['application/json'],
|
|
68208
|
+
['application/json']
|
|
68209
|
+
);
|
|
68210
|
+
}
|
|
68211
|
+
|
|
66964
68212
|
/**
|
|
66965
68213
|
* Queries available time off for the current user
|
|
66966
68214
|
*
|
|
@@ -67009,6 +68257,84 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67009
68257
|
);
|
|
67010
68258
|
}
|
|
67011
68259
|
|
|
68260
|
+
/**
|
|
68261
|
+
* Estimates available time off for current user
|
|
68262
|
+
*
|
|
68263
|
+
* @param {Object} opts Optional parameters
|
|
68264
|
+
* @param {Object} opts.body body
|
|
68265
|
+
*/
|
|
68266
|
+
postWorkforcemanagementTimeoffrequestsEstimate(opts) {
|
|
68267
|
+
opts = opts || {};
|
|
68268
|
+
|
|
68269
|
+
|
|
68270
|
+
return this.apiClient.callApi(
|
|
68271
|
+
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
68272
|
+
'POST',
|
|
68273
|
+
{ },
|
|
68274
|
+
{ },
|
|
68275
|
+
{ },
|
|
68276
|
+
{ },
|
|
68277
|
+
opts['body'],
|
|
68278
|
+
['PureCloud OAuth'],
|
|
68279
|
+
['application/json'],
|
|
68280
|
+
['application/json']
|
|
68281
|
+
);
|
|
68282
|
+
}
|
|
68283
|
+
|
|
68284
|
+
/**
|
|
68285
|
+
* Retrieves integration statuses for a list of current user time off requests
|
|
68286
|
+
*
|
|
68287
|
+
* @param {Object} opts Optional parameters
|
|
68288
|
+
* @param {Object} opts.body body
|
|
68289
|
+
*/
|
|
68290
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) {
|
|
68291
|
+
opts = opts || {};
|
|
68292
|
+
|
|
68293
|
+
|
|
68294
|
+
return this.apiClient.callApi(
|
|
68295
|
+
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
68296
|
+
'POST',
|
|
68297
|
+
{ },
|
|
68298
|
+
{ },
|
|
68299
|
+
{ },
|
|
68300
|
+
{ },
|
|
68301
|
+
opts['body'],
|
|
68302
|
+
['PureCloud OAuth'],
|
|
68303
|
+
['application/json'],
|
|
68304
|
+
['application/json']
|
|
68305
|
+
);
|
|
68306
|
+
}
|
|
68307
|
+
|
|
68308
|
+
/**
|
|
68309
|
+
* Update integrations for agent
|
|
68310
|
+
*
|
|
68311
|
+
* @param {String} agentId The ID of the agent
|
|
68312
|
+
* @param {Object} body body
|
|
68313
|
+
*/
|
|
68314
|
+
putWorkforcemanagementAgentIntegrationsHris(agentId, body) {
|
|
68315
|
+
// verify the required parameter 'agentId' is set
|
|
68316
|
+
if (agentId === undefined || agentId === null) {
|
|
68317
|
+
throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
68318
|
+
}
|
|
68319
|
+
// verify the required parameter 'body' is set
|
|
68320
|
+
if (body === undefined || body === null) {
|
|
68321
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
68322
|
+
}
|
|
68323
|
+
|
|
68324
|
+
return this.apiClient.callApi(
|
|
68325
|
+
'/api/v2/workforcemanagement/agents/{agentId}/integrations/hris',
|
|
68326
|
+
'PUT',
|
|
68327
|
+
{ 'agentId': agentId },
|
|
68328
|
+
{ },
|
|
68329
|
+
{ },
|
|
68330
|
+
{ },
|
|
68331
|
+
body,
|
|
68332
|
+
['PureCloud OAuth'],
|
|
68333
|
+
['application/json'],
|
|
68334
|
+
['application/json']
|
|
68335
|
+
);
|
|
68336
|
+
}
|
|
68337
|
+
|
|
67012
68338
|
/**
|
|
67013
68339
|
* Sets daily values for a date range of time off limit object
|
|
67014
68340
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
@@ -67074,7 +68400,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67074
68400
|
* </pre>
|
|
67075
68401
|
* </p>
|
|
67076
68402
|
* @module purecloud-platform-client-v2/index
|
|
67077
|
-
* @version
|
|
68403
|
+
* @version 174.0.0
|
|
67078
68404
|
*/
|
|
67079
68405
|
class platformClient {
|
|
67080
68406
|
constructor() {
|