purecloud-platform-client-v2 173.1.0 → 175.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 +1580 -131
- package/dist/web-amd/purecloud-platform-client-v2.js +1580 -131
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1580 -131
- package/dist/web-cjs/purecloud-platform-client-v2.js +1580 -131
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1223 -20
- 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 +612 -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 +7 -3
- 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 +3 -2
- 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 +362 -5
- 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 175.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 175.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 175.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 175.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
|
*
|
|
@@ -5940,6 +6274,125 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5940
6274
|
);
|
|
5941
6275
|
}
|
|
5942
6276
|
|
|
6277
|
+
/**
|
|
6278
|
+
* Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
|
|
6279
|
+
*
|
|
6280
|
+
* @param {String} flowId Flow ID.
|
|
6281
|
+
* @param {String} versionId Version ID.
|
|
6282
|
+
* @param {Object} opts Optional parameters
|
|
6283
|
+
* @param {Object} opts.language Language to filter for
|
|
6284
|
+
*/
|
|
6285
|
+
getFlowVersionHealth(flowId, versionId, opts) {
|
|
6286
|
+
opts = opts || {};
|
|
6287
|
+
|
|
6288
|
+
// verify the required parameter 'flowId' is set
|
|
6289
|
+
if (flowId === undefined || flowId === null) {
|
|
6290
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionHealth';
|
|
6291
|
+
}
|
|
6292
|
+
// verify the required parameter 'versionId' is set
|
|
6293
|
+
if (versionId === undefined || versionId === null) {
|
|
6294
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionHealth';
|
|
6295
|
+
}
|
|
6296
|
+
|
|
6297
|
+
return this.apiClient.callApi(
|
|
6298
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/health',
|
|
6299
|
+
'GET',
|
|
6300
|
+
{ 'flowId': flowId,'versionId': versionId },
|
|
6301
|
+
{ 'language': opts['language'] },
|
|
6302
|
+
{ },
|
|
6303
|
+
{ },
|
|
6304
|
+
null,
|
|
6305
|
+
['PureCloud OAuth'],
|
|
6306
|
+
['application/json'],
|
|
6307
|
+
['application/json']
|
|
6308
|
+
);
|
|
6309
|
+
}
|
|
6310
|
+
|
|
6311
|
+
/**
|
|
6312
|
+
* Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.
|
|
6313
|
+
*
|
|
6314
|
+
* @param {String} flowId Flow ID.
|
|
6315
|
+
* @param {String} versionId Version ID.
|
|
6316
|
+
* @param {String} intentId Intent ID.
|
|
6317
|
+
* @param {Object} language Language to filter for
|
|
6318
|
+
*/
|
|
6319
|
+
getFlowVersionIntentHealth(flowId, versionId, intentId, language) {
|
|
6320
|
+
// verify the required parameter 'flowId' is set
|
|
6321
|
+
if (flowId === undefined || flowId === null) {
|
|
6322
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';
|
|
6323
|
+
}
|
|
6324
|
+
// verify the required parameter 'versionId' is set
|
|
6325
|
+
if (versionId === undefined || versionId === null) {
|
|
6326
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';
|
|
6327
|
+
}
|
|
6328
|
+
// verify the required parameter 'intentId' is set
|
|
6329
|
+
if (intentId === undefined || intentId === null) {
|
|
6330
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';
|
|
6331
|
+
}
|
|
6332
|
+
// verify the required parameter 'language' is set
|
|
6333
|
+
if (language === undefined || language === null) {
|
|
6334
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentHealth';
|
|
6335
|
+
}
|
|
6336
|
+
|
|
6337
|
+
return this.apiClient.callApi(
|
|
6338
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health',
|
|
6339
|
+
'GET',
|
|
6340
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId },
|
|
6341
|
+
{ 'language': language },
|
|
6342
|
+
{ },
|
|
6343
|
+
{ },
|
|
6344
|
+
null,
|
|
6345
|
+
['PureCloud OAuth'],
|
|
6346
|
+
['application/json'],
|
|
6347
|
+
['application/json']
|
|
6348
|
+
);
|
|
6349
|
+
}
|
|
6350
|
+
|
|
6351
|
+
/**
|
|
6352
|
+
* Get health metrics associated with a specific utterance of an intent.
|
|
6353
|
+
*
|
|
6354
|
+
* @param {String} flowId Flow ID.
|
|
6355
|
+
* @param {String} versionId Version ID.
|
|
6356
|
+
* @param {String} intentId Intent ID.
|
|
6357
|
+
* @param {String} utteranceId Utterance ID.
|
|
6358
|
+
* @param {Object} language Language to filter for
|
|
6359
|
+
*/
|
|
6360
|
+
getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language) {
|
|
6361
|
+
// verify the required parameter 'flowId' is set
|
|
6362
|
+
if (flowId === undefined || flowId === null) {
|
|
6363
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6364
|
+
}
|
|
6365
|
+
// verify the required parameter 'versionId' is set
|
|
6366
|
+
if (versionId === undefined || versionId === null) {
|
|
6367
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6368
|
+
}
|
|
6369
|
+
// verify the required parameter 'intentId' is set
|
|
6370
|
+
if (intentId === undefined || intentId === null) {
|
|
6371
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6372
|
+
}
|
|
6373
|
+
// verify the required parameter 'utteranceId' is set
|
|
6374
|
+
if (utteranceId === undefined || utteranceId === null) {
|
|
6375
|
+
throw 'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6376
|
+
}
|
|
6377
|
+
// verify the required parameter 'language' is set
|
|
6378
|
+
if (language === undefined || language === null) {
|
|
6379
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';
|
|
6380
|
+
}
|
|
6381
|
+
|
|
6382
|
+
return this.apiClient.callApi(
|
|
6383
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health',
|
|
6384
|
+
'GET',
|
|
6385
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId,'utteranceId': utteranceId },
|
|
6386
|
+
{ 'language': language },
|
|
6387
|
+
{ },
|
|
6388
|
+
{ },
|
|
6389
|
+
null,
|
|
6390
|
+
['PureCloud OAuth'],
|
|
6391
|
+
['application/json'],
|
|
6392
|
+
['application/json']
|
|
6393
|
+
);
|
|
6394
|
+
}
|
|
6395
|
+
|
|
5943
6396
|
/**
|
|
5944
6397
|
* Get flow version list
|
|
5945
6398
|
*
|
|
@@ -6631,6 +7084,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6631
7084
|
);
|
|
6632
7085
|
}
|
|
6633
7086
|
|
|
7087
|
+
/**
|
|
7088
|
+
* Updates a grammar
|
|
7089
|
+
*
|
|
7090
|
+
* @param {String} grammarId grammar ID
|
|
7091
|
+
* @param {Object} opts Optional parameters
|
|
7092
|
+
* @param {Object} opts.body
|
|
7093
|
+
* patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7094
|
+
*/
|
|
7095
|
+
patchArchitectGrammar(grammarId, opts) {
|
|
7096
|
+
opts = opts || {};
|
|
7097
|
+
|
|
7098
|
+
// verify the required parameter 'grammarId' is set
|
|
7099
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7100
|
+
throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
|
|
7101
|
+
}
|
|
7102
|
+
|
|
7103
|
+
return this.apiClient.callApi(
|
|
7104
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
7105
|
+
'PATCH',
|
|
7106
|
+
{ 'grammarId': grammarId },
|
|
7107
|
+
{ },
|
|
7108
|
+
{ },
|
|
7109
|
+
{ },
|
|
7110
|
+
opts['body'],
|
|
7111
|
+
['PureCloud OAuth'],
|
|
7112
|
+
['application/json'],
|
|
7113
|
+
['application/json']
|
|
7114
|
+
);
|
|
7115
|
+
}
|
|
7116
|
+
|
|
6634
7117
|
/**
|
|
6635
7118
|
* Rebuild Dependency Tracking data for an organization
|
|
6636
7119
|
* Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
@@ -6676,6 +7159,135 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6676
7159
|
);
|
|
6677
7160
|
}
|
|
6678
7161
|
|
|
7162
|
+
/**
|
|
7163
|
+
* Creates a presigned URL for uploading a grammar DTMF mode file
|
|
7164
|
+
*
|
|
7165
|
+
* @param {String} grammarId Grammar ID
|
|
7166
|
+
* @param {String} languageCode Language
|
|
7167
|
+
* @param {Object} body query
|
|
7168
|
+
* postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7169
|
+
*/
|
|
7170
|
+
postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
|
|
7171
|
+
// verify the required parameter 'grammarId' is set
|
|
7172
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7173
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7174
|
+
}
|
|
7175
|
+
// verify the required parameter 'languageCode' is set
|
|
7176
|
+
if (languageCode === undefined || languageCode === null) {
|
|
7177
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7178
|
+
}
|
|
7179
|
+
// verify the required parameter 'body' is set
|
|
7180
|
+
if (body === undefined || body === null) {
|
|
7181
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7182
|
+
}
|
|
7183
|
+
|
|
7184
|
+
return this.apiClient.callApi(
|
|
7185
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
7186
|
+
'POST',
|
|
7187
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
7188
|
+
{ },
|
|
7189
|
+
{ },
|
|
7190
|
+
{ },
|
|
7191
|
+
body,
|
|
7192
|
+
['PureCloud OAuth'],
|
|
7193
|
+
['application/json'],
|
|
7194
|
+
['application/json']
|
|
7195
|
+
);
|
|
7196
|
+
}
|
|
7197
|
+
|
|
7198
|
+
/**
|
|
7199
|
+
* Creates a presigned URL for uploading a grammar voice mode file
|
|
7200
|
+
*
|
|
7201
|
+
* @param {String} grammarId Grammar ID
|
|
7202
|
+
* @param {String} languageCode Language
|
|
7203
|
+
* @param {Object} body query
|
|
7204
|
+
* postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7205
|
+
*/
|
|
7206
|
+
postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
|
|
7207
|
+
// verify the required parameter 'grammarId' is set
|
|
7208
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7209
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7210
|
+
}
|
|
7211
|
+
// verify the required parameter 'languageCode' is set
|
|
7212
|
+
if (languageCode === undefined || languageCode === null) {
|
|
7213
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7214
|
+
}
|
|
7215
|
+
// verify the required parameter 'body' is set
|
|
7216
|
+
if (body === undefined || body === null) {
|
|
7217
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7218
|
+
}
|
|
7219
|
+
|
|
7220
|
+
return this.apiClient.callApi(
|
|
7221
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
7222
|
+
'POST',
|
|
7223
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
7224
|
+
{ },
|
|
7225
|
+
{ },
|
|
7226
|
+
{ },
|
|
7227
|
+
body,
|
|
7228
|
+
['PureCloud OAuth'],
|
|
7229
|
+
['application/json'],
|
|
7230
|
+
['application/json']
|
|
7231
|
+
);
|
|
7232
|
+
}
|
|
7233
|
+
|
|
7234
|
+
/**
|
|
7235
|
+
* Create a new language for a given grammar
|
|
7236
|
+
*
|
|
7237
|
+
* @param {String} grammarId Grammar ID
|
|
7238
|
+
* @param {Object} body
|
|
7239
|
+
* postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7240
|
+
*/
|
|
7241
|
+
postArchitectGrammarLanguages(grammarId, body) {
|
|
7242
|
+
// verify the required parameter 'grammarId' is set
|
|
7243
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7244
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
|
|
7245
|
+
}
|
|
7246
|
+
// verify the required parameter 'body' is set
|
|
7247
|
+
if (body === undefined || body === null) {
|
|
7248
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
|
|
7249
|
+
}
|
|
7250
|
+
|
|
7251
|
+
return this.apiClient.callApi(
|
|
7252
|
+
'/api/v2/architect/grammars/{grammarId}/languages',
|
|
7253
|
+
'POST',
|
|
7254
|
+
{ 'grammarId': grammarId },
|
|
7255
|
+
{ },
|
|
7256
|
+
{ },
|
|
7257
|
+
{ },
|
|
7258
|
+
body,
|
|
7259
|
+
['PureCloud OAuth'],
|
|
7260
|
+
['application/json'],
|
|
7261
|
+
['application/json']
|
|
7262
|
+
);
|
|
7263
|
+
}
|
|
7264
|
+
|
|
7265
|
+
/**
|
|
7266
|
+
* Create a new grammar
|
|
7267
|
+
*
|
|
7268
|
+
* @param {Object} body
|
|
7269
|
+
* postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7270
|
+
*/
|
|
7271
|
+
postArchitectGrammars(body) {
|
|
7272
|
+
// verify the required parameter 'body' is set
|
|
7273
|
+
if (body === undefined || body === null) {
|
|
7274
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammars';
|
|
7275
|
+
}
|
|
7276
|
+
|
|
7277
|
+
return this.apiClient.callApi(
|
|
7278
|
+
'/api/v2/architect/grammars',
|
|
7279
|
+
'POST',
|
|
7280
|
+
{ },
|
|
7281
|
+
{ },
|
|
7282
|
+
{ },
|
|
7283
|
+
{ },
|
|
7284
|
+
body,
|
|
7285
|
+
['PureCloud OAuth'],
|
|
7286
|
+
['application/json'],
|
|
7287
|
+
['application/json']
|
|
7288
|
+
);
|
|
7289
|
+
}
|
|
7290
|
+
|
|
6679
7291
|
/**
|
|
6680
7292
|
* Create IVR config.
|
|
6681
7293
|
*
|
|
@@ -7769,7 +8381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7769
8381
|
/**
|
|
7770
8382
|
* Audit service.
|
|
7771
8383
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7772
|
-
* @version
|
|
8384
|
+
* @version 175.0.0
|
|
7773
8385
|
*/
|
|
7774
8386
|
|
|
7775
8387
|
/**
|
|
@@ -7940,7 +8552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7940
8552
|
/**
|
|
7941
8553
|
* Authorization service.
|
|
7942
8554
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7943
|
-
* @version
|
|
8555
|
+
* @version 175.0.0
|
|
7944
8556
|
*/
|
|
7945
8557
|
|
|
7946
8558
|
/**
|
|
@@ -9171,7 +9783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9171
9783
|
/**
|
|
9172
9784
|
* Billing service.
|
|
9173
9785
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9174
|
-
* @version
|
|
9786
|
+
* @version 175.0.0
|
|
9175
9787
|
*/
|
|
9176
9788
|
|
|
9177
9789
|
/**
|
|
@@ -9251,7 +9863,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9251
9863
|
/**
|
|
9252
9864
|
* CarrierServices service.
|
|
9253
9865
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9254
|
-
* @version
|
|
9866
|
+
* @version 175.0.0
|
|
9255
9867
|
*/
|
|
9256
9868
|
|
|
9257
9869
|
/**
|
|
@@ -9321,7 +9933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9321
9933
|
/**
|
|
9322
9934
|
* Chat service.
|
|
9323
9935
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9324
|
-
* @version
|
|
9936
|
+
* @version 175.0.0
|
|
9325
9937
|
*/
|
|
9326
9938
|
|
|
9327
9939
|
/**
|
|
@@ -9485,7 +10097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9485
10097
|
/**
|
|
9486
10098
|
* Coaching service.
|
|
9487
10099
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9488
|
-
* @version
|
|
10100
|
+
* @version 175.0.0
|
|
9489
10101
|
*/
|
|
9490
10102
|
|
|
9491
10103
|
/**
|
|
@@ -10062,7 +10674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10062
10674
|
/**
|
|
10063
10675
|
* ContentManagement service.
|
|
10064
10676
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10065
|
-
* @version
|
|
10677
|
+
* @version 175.0.0
|
|
10066
10678
|
*/
|
|
10067
10679
|
|
|
10068
10680
|
/**
|
|
@@ -11205,7 +11817,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11205
11817
|
/**
|
|
11206
11818
|
* Conversations service.
|
|
11207
11819
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11208
|
-
* @version
|
|
11820
|
+
* @version 175.0.0
|
|
11209
11821
|
*/
|
|
11210
11822
|
|
|
11211
11823
|
/**
|
|
@@ -11370,6 +11982,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11370
11982
|
);
|
|
11371
11983
|
}
|
|
11372
11984
|
|
|
11985
|
+
/**
|
|
11986
|
+
* Remove a cached media item asychronously
|
|
11987
|
+
*
|
|
11988
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
11989
|
+
*/
|
|
11990
|
+
deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
11991
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
11992
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
11993
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
|
|
11994
|
+
}
|
|
11995
|
+
|
|
11996
|
+
return this.apiClient.callApi(
|
|
11997
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
11998
|
+
'DELETE',
|
|
11999
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
12000
|
+
{ },
|
|
12001
|
+
{ },
|
|
12002
|
+
{ },
|
|
12003
|
+
null,
|
|
12004
|
+
['PureCloud OAuth'],
|
|
12005
|
+
['application/json'],
|
|
12006
|
+
['application/json']
|
|
12007
|
+
);
|
|
12008
|
+
}
|
|
12009
|
+
|
|
11373
12010
|
/**
|
|
11374
12011
|
* Delete a Facebook messaging integration
|
|
11375
12012
|
*
|
|
@@ -13171,7 +13808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13171
13808
|
/**
|
|
13172
13809
|
* Get list of wrapup codes for this conversation participant
|
|
13173
13810
|
*
|
|
13174
|
-
* @param {String} conversationId
|
|
13811
|
+
* @param {String} conversationId conversationId
|
|
13175
13812
|
* @param {String} participantId participantId
|
|
13176
13813
|
*/
|
|
13177
13814
|
getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
|
|
@@ -13218,6 +13855,57 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13218
13855
|
);
|
|
13219
13856
|
}
|
|
13220
13857
|
|
|
13858
|
+
/**
|
|
13859
|
+
* Get a list of cached media items
|
|
13860
|
+
*
|
|
13861
|
+
* @param {Object} opts Optional parameters
|
|
13862
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13863
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13864
|
+
* @param {String} opts.url URL to search for
|
|
13865
|
+
*/
|
|
13866
|
+
getConversationsMessagesCachedmedia(opts) {
|
|
13867
|
+
opts = opts || {};
|
|
13868
|
+
|
|
13869
|
+
|
|
13870
|
+
return this.apiClient.callApi(
|
|
13871
|
+
'/api/v2/conversations/messages/cachedmedia',
|
|
13872
|
+
'GET',
|
|
13873
|
+
{ },
|
|
13874
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
|
|
13875
|
+
{ },
|
|
13876
|
+
{ },
|
|
13877
|
+
null,
|
|
13878
|
+
['PureCloud OAuth'],
|
|
13879
|
+
['application/json'],
|
|
13880
|
+
['application/json']
|
|
13881
|
+
);
|
|
13882
|
+
}
|
|
13883
|
+
|
|
13884
|
+
/**
|
|
13885
|
+
* Get a cached media item
|
|
13886
|
+
*
|
|
13887
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
13888
|
+
*/
|
|
13889
|
+
getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
13890
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
13891
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
13892
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
|
|
13893
|
+
}
|
|
13894
|
+
|
|
13895
|
+
return this.apiClient.callApi(
|
|
13896
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
13897
|
+
'GET',
|
|
13898
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
13899
|
+
{ },
|
|
13900
|
+
{ },
|
|
13901
|
+
{ },
|
|
13902
|
+
null,
|
|
13903
|
+
['PureCloud OAuth'],
|
|
13904
|
+
['application/json'],
|
|
13905
|
+
['application/json']
|
|
13906
|
+
);
|
|
13907
|
+
}
|
|
13908
|
+
|
|
13221
13909
|
/**
|
|
13222
13910
|
* Get Genesys Facebook App Id
|
|
13223
13911
|
*
|
|
@@ -13961,6 +14649,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13961
14649
|
);
|
|
13962
14650
|
}
|
|
13963
14651
|
|
|
14652
|
+
/**
|
|
14653
|
+
* Gets a record for a given meetingId
|
|
14654
|
+
*
|
|
14655
|
+
* @param {String} meetingId meetingId
|
|
14656
|
+
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14657
|
+
*/
|
|
14658
|
+
getConversationsVideosMeeting(meetingId) {
|
|
14659
|
+
// verify the required parameter 'meetingId' is set
|
|
14660
|
+
if (meetingId === undefined || meetingId === null) {
|
|
14661
|
+
throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
|
|
14662
|
+
}
|
|
14663
|
+
|
|
14664
|
+
return this.apiClient.callApi(
|
|
14665
|
+
'/api/v2/conversations/videos/meetings/{meetingId}',
|
|
14666
|
+
'GET',
|
|
14667
|
+
{ 'meetingId': meetingId },
|
|
14668
|
+
{ },
|
|
14669
|
+
{ },
|
|
14670
|
+
{ },
|
|
14671
|
+
null,
|
|
14672
|
+
['PureCloud OAuth'],
|
|
14673
|
+
['application/json'],
|
|
14674
|
+
['application/json']
|
|
14675
|
+
);
|
|
14676
|
+
}
|
|
14677
|
+
|
|
13964
14678
|
/**
|
|
13965
14679
|
* Update a participant.
|
|
13966
14680
|
* Update conversation participant.
|
|
@@ -14923,7 +15637,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14923
15637
|
/**
|
|
14924
15638
|
* Update conversation participant
|
|
14925
15639
|
*
|
|
14926
|
-
* @param {String} conversationId
|
|
15640
|
+
* @param {String} conversationId conversationId
|
|
14927
15641
|
* @param {String} participantId participantId
|
|
14928
15642
|
* @param {Object} opts Optional parameters
|
|
14929
15643
|
* @param {Object} opts.body
|
|
@@ -14957,7 +15671,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14957
15671
|
/**
|
|
14958
15672
|
* Update the attributes on a conversation participant.
|
|
14959
15673
|
*
|
|
14960
|
-
* @param {String} conversationId
|
|
15674
|
+
* @param {String} conversationId conversationId
|
|
14961
15675
|
* @param {String} participantId participantId
|
|
14962
15676
|
* @param {Object} opts Optional parameters
|
|
14963
15677
|
* @param {Object} opts.body
|
|
@@ -14991,7 +15705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14991
15705
|
/**
|
|
14992
15706
|
* Update conversation participant's communication by disconnecting it.
|
|
14993
15707
|
*
|
|
14994
|
-
* @param {String} conversationId
|
|
15708
|
+
* @param {String} conversationId conversationId
|
|
14995
15709
|
* @param {String} participantId participantId
|
|
14996
15710
|
* @param {String} communicationId communicationId
|
|
14997
15711
|
* @param {Object} body Participant
|
|
@@ -16948,6 +17662,96 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16948
17662
|
);
|
|
16949
17663
|
}
|
|
16950
17664
|
|
|
17665
|
+
/**
|
|
17666
|
+
* Send an inbound Open Event Message
|
|
17667
|
+
* 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.
|
|
17668
|
+
* @param {String} integrationId integrationId
|
|
17669
|
+
* @param {Object} body NormalizedMessage
|
|
17670
|
+
*/
|
|
17671
|
+
postConversationsMessageInboundOpenEvent(integrationId, body) {
|
|
17672
|
+
// verify the required parameter 'integrationId' is set
|
|
17673
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17674
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
|
|
17675
|
+
}
|
|
17676
|
+
// verify the required parameter 'body' is set
|
|
17677
|
+
if (body === undefined || body === null) {
|
|
17678
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
|
|
17679
|
+
}
|
|
17680
|
+
|
|
17681
|
+
return this.apiClient.callApi(
|
|
17682
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/event',
|
|
17683
|
+
'POST',
|
|
17684
|
+
{ 'integrationId': integrationId },
|
|
17685
|
+
{ },
|
|
17686
|
+
{ },
|
|
17687
|
+
{ },
|
|
17688
|
+
body,
|
|
17689
|
+
['PureCloud OAuth'],
|
|
17690
|
+
['application/json'],
|
|
17691
|
+
['application/json']
|
|
17692
|
+
);
|
|
17693
|
+
}
|
|
17694
|
+
|
|
17695
|
+
/**
|
|
17696
|
+
* Send inbound Open Message
|
|
17697
|
+
* 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.
|
|
17698
|
+
* @param {String} integrationId integrationId
|
|
17699
|
+
* @param {Object} body NormalizedMessage
|
|
17700
|
+
*/
|
|
17701
|
+
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
17702
|
+
// verify the required parameter 'integrationId' is set
|
|
17703
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17704
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
17705
|
+
}
|
|
17706
|
+
// verify the required parameter 'body' is set
|
|
17707
|
+
if (body === undefined || body === null) {
|
|
17708
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
|
|
17709
|
+
}
|
|
17710
|
+
|
|
17711
|
+
return this.apiClient.callApi(
|
|
17712
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
17713
|
+
'POST',
|
|
17714
|
+
{ 'integrationId': integrationId },
|
|
17715
|
+
{ },
|
|
17716
|
+
{ },
|
|
17717
|
+
{ },
|
|
17718
|
+
body,
|
|
17719
|
+
['PureCloud OAuth'],
|
|
17720
|
+
['application/json'],
|
|
17721
|
+
['application/json']
|
|
17722
|
+
);
|
|
17723
|
+
}
|
|
17724
|
+
|
|
17725
|
+
/**
|
|
17726
|
+
* Send an inbound Open Receipt Message
|
|
17727
|
+
* 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.
|
|
17728
|
+
* @param {String} integrationId integrationId
|
|
17729
|
+
* @param {Object} body NormalizedMessage
|
|
17730
|
+
*/
|
|
17731
|
+
postConversationsMessageInboundOpenReceipt(integrationId, body) {
|
|
17732
|
+
// verify the required parameter 'integrationId' is set
|
|
17733
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17734
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
|
|
17735
|
+
}
|
|
17736
|
+
// verify the required parameter 'body' is set
|
|
17737
|
+
if (body === undefined || body === null) {
|
|
17738
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
|
|
17739
|
+
}
|
|
17740
|
+
|
|
17741
|
+
return this.apiClient.callApi(
|
|
17742
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
|
|
17743
|
+
'POST',
|
|
17744
|
+
{ 'integrationId': integrationId },
|
|
17745
|
+
{ },
|
|
17746
|
+
{ },
|
|
17747
|
+
{ },
|
|
17748
|
+
body,
|
|
17749
|
+
['PureCloud OAuth'],
|
|
17750
|
+
['application/json'],
|
|
17751
|
+
['application/json']
|
|
17752
|
+
);
|
|
17753
|
+
}
|
|
17754
|
+
|
|
16951
17755
|
/**
|
|
16952
17756
|
* Get messages in batch
|
|
16953
17757
|
* 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"]
|
|
@@ -17431,24 +18235,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17431
18235
|
* @param {Object} opts Optional parameters
|
|
17432
18236
|
* @param {Object} opts.body Wrap-up
|
|
17433
18237
|
*/
|
|
17434
|
-
postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18238
|
+
postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18239
|
+
opts = opts || {};
|
|
18240
|
+
|
|
18241
|
+
// verify the required parameter 'conversationId' is set
|
|
18242
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18243
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
18244
|
+
}
|
|
18245
|
+
// verify the required parameter 'participantId' is set
|
|
18246
|
+
if (participantId === undefined || participantId === null) {
|
|
18247
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
18248
|
+
}
|
|
18249
|
+
// verify the required parameter 'communicationId' is set
|
|
18250
|
+
if (communicationId === undefined || communicationId === null) {
|
|
18251
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
18252
|
+
}
|
|
18253
|
+
|
|
18254
|
+
return this.apiClient.callApi(
|
|
18255
|
+
'/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup',
|
|
18256
|
+
'POST',
|
|
18257
|
+
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
18258
|
+
{ },
|
|
18259
|
+
{ },
|
|
18260
|
+
{ },
|
|
18261
|
+
opts['body'],
|
|
18262
|
+
['PureCloud OAuth'],
|
|
18263
|
+
['application/json'],
|
|
18264
|
+
['application/json']
|
|
18265
|
+
);
|
|
18266
|
+
}
|
|
18267
|
+
|
|
18268
|
+
/**
|
|
18269
|
+
* Apply wrap-up for this conversation communication
|
|
18270
|
+
*
|
|
18271
|
+
* @param {String} conversationId conversationId
|
|
18272
|
+
* @param {String} participantId participantId
|
|
18273
|
+
* @param {String} communicationId communicationId
|
|
18274
|
+
* @param {Object} opts Optional parameters
|
|
18275
|
+
* @param {Object} opts.body Wrap-up
|
|
18276
|
+
*/
|
|
18277
|
+
postConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
17435
18278
|
opts = opts || {};
|
|
17436
18279
|
|
|
17437
18280
|
// verify the required parameter 'conversationId' is set
|
|
17438
18281
|
if (conversationId === undefined || conversationId === null) {
|
|
17439
|
-
throw 'Missing the required parameter "conversationId" when calling
|
|
18282
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17440
18283
|
}
|
|
17441
18284
|
// verify the required parameter 'participantId' is set
|
|
17442
18285
|
if (participantId === undefined || participantId === null) {
|
|
17443
|
-
throw 'Missing the required parameter "participantId" when calling
|
|
18286
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17444
18287
|
}
|
|
17445
18288
|
// verify the required parameter 'communicationId' is set
|
|
17446
18289
|
if (communicationId === undefined || communicationId === null) {
|
|
17447
|
-
throw 'Missing the required parameter "communicationId" when calling
|
|
18290
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17448
18291
|
}
|
|
17449
18292
|
|
|
17450
18293
|
return this.apiClient.callApi(
|
|
17451
|
-
'/api/v2/conversations/
|
|
18294
|
+
'/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup',
|
|
17452
18295
|
'POST',
|
|
17453
18296
|
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
17454
18297
|
{ },
|
|
@@ -17462,38 +18305,25 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17462
18305
|
}
|
|
17463
18306
|
|
|
17464
18307
|
/**
|
|
17465
|
-
*
|
|
18308
|
+
* Generate a meetingId for a given conferenceId
|
|
17466
18309
|
*
|
|
17467
|
-
* @param {
|
|
17468
|
-
*
|
|
17469
|
-
* @param {String} communicationId communicationId
|
|
17470
|
-
* @param {Object} opts Optional parameters
|
|
17471
|
-
* @param {Object} opts.body Wrap-up
|
|
18310
|
+
* @param {Object} body MeetingIdRequest
|
|
18311
|
+
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17472
18312
|
*/
|
|
17473
|
-
|
|
17474
|
-
|
|
17475
|
-
|
|
17476
|
-
|
|
17477
|
-
if (conversationId === undefined || conversationId === null) {
|
|
17478
|
-
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17479
|
-
}
|
|
17480
|
-
// verify the required parameter 'participantId' is set
|
|
17481
|
-
if (participantId === undefined || participantId === null) {
|
|
17482
|
-
throw 'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17483
|
-
}
|
|
17484
|
-
// verify the required parameter 'communicationId' is set
|
|
17485
|
-
if (communicationId === undefined || communicationId === null) {
|
|
17486
|
-
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
18313
|
+
postConversationsVideosMeetings(body) {
|
|
18314
|
+
// verify the required parameter 'body' is set
|
|
18315
|
+
if (body === undefined || body === null) {
|
|
18316
|
+
throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
|
|
17487
18317
|
}
|
|
17488
18318
|
|
|
17489
18319
|
return this.apiClient.callApi(
|
|
17490
|
-
'/api/v2/conversations/videos/
|
|
18320
|
+
'/api/v2/conversations/videos/meetings',
|
|
17491
18321
|
'POST',
|
|
17492
|
-
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
17493
18322
|
{ },
|
|
17494
18323
|
{ },
|
|
17495
18324
|
{ },
|
|
17496
|
-
|
|
18325
|
+
{ },
|
|
18326
|
+
body,
|
|
17497
18327
|
['PureCloud OAuth'],
|
|
17498
18328
|
['application/json'],
|
|
17499
18329
|
['application/json']
|
|
@@ -18071,7 +18901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18071
18901
|
/**
|
|
18072
18902
|
* DataExtensions service.
|
|
18073
18903
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
18074
|
-
* @version
|
|
18904
|
+
* @version 175.0.0
|
|
18075
18905
|
*/
|
|
18076
18906
|
|
|
18077
18907
|
/**
|
|
@@ -18157,7 +18987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18157
18987
|
/**
|
|
18158
18988
|
* Downloads service.
|
|
18159
18989
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
18160
|
-
* @version
|
|
18990
|
+
* @version 175.0.0
|
|
18161
18991
|
*/
|
|
18162
18992
|
|
|
18163
18993
|
/**
|
|
@@ -18209,7 +19039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18209
19039
|
/**
|
|
18210
19040
|
* Emails service.
|
|
18211
19041
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
18212
|
-
* @version
|
|
19042
|
+
* @version 175.0.0
|
|
18213
19043
|
*/
|
|
18214
19044
|
|
|
18215
19045
|
/**
|
|
@@ -18274,7 +19104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18274
19104
|
/**
|
|
18275
19105
|
* Events service.
|
|
18276
19106
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
18277
|
-
* @version
|
|
19107
|
+
* @version 175.0.0
|
|
18278
19108
|
*/
|
|
18279
19109
|
|
|
18280
19110
|
/**
|
|
@@ -18370,7 +19200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18370
19200
|
/**
|
|
18371
19201
|
* ExternalContacts service.
|
|
18372
19202
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
18373
|
-
* @version
|
|
19203
|
+
* @version 175.0.0
|
|
18374
19204
|
*/
|
|
18375
19205
|
|
|
18376
19206
|
/**
|
|
@@ -20328,7 +21158,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20328
21158
|
/**
|
|
20329
21159
|
* Fax service.
|
|
20330
21160
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
20331
|
-
* @version
|
|
21161
|
+
* @version 175.0.0
|
|
20332
21162
|
*/
|
|
20333
21163
|
|
|
20334
21164
|
/**
|
|
@@ -20499,7 +21329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20499
21329
|
/**
|
|
20500
21330
|
* Flows service.
|
|
20501
21331
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
20502
|
-
* @version
|
|
21332
|
+
* @version 175.0.0
|
|
20503
21333
|
*/
|
|
20504
21334
|
|
|
20505
21335
|
/**
|
|
@@ -20683,7 +21513,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20683
21513
|
/**
|
|
20684
21514
|
* Gamification service.
|
|
20685
21515
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
20686
|
-
* @version
|
|
21516
|
+
* @version 175.0.0
|
|
20687
21517
|
*/
|
|
20688
21518
|
|
|
20689
21519
|
/**
|
|
@@ -22769,7 +23599,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22769
23599
|
/**
|
|
22770
23600
|
* GeneralDataProtectionRegulation service.
|
|
22771
23601
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
22772
|
-
* @version
|
|
23602
|
+
* @version 175.0.0
|
|
22773
23603
|
*/
|
|
22774
23604
|
|
|
22775
23605
|
/**
|
|
@@ -22899,7 +23729,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22899
23729
|
/**
|
|
22900
23730
|
* Geolocation service.
|
|
22901
23731
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
22902
|
-
* @version
|
|
23732
|
+
* @version 175.0.0
|
|
22903
23733
|
*/
|
|
22904
23734
|
|
|
22905
23735
|
/**
|
|
@@ -23030,7 +23860,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23030
23860
|
/**
|
|
23031
23861
|
* Greetings service.
|
|
23032
23862
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
23033
|
-
* @version
|
|
23863
|
+
* @version 175.0.0
|
|
23034
23864
|
*/
|
|
23035
23865
|
|
|
23036
23866
|
/**
|
|
@@ -23485,7 +24315,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23485
24315
|
/**
|
|
23486
24316
|
* Groups service.
|
|
23487
24317
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
23488
|
-
* @version
|
|
24318
|
+
* @version 175.0.0
|
|
23489
24319
|
*/
|
|
23490
24320
|
|
|
23491
24321
|
/**
|
|
@@ -24004,7 +24834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24004
24834
|
/**
|
|
24005
24835
|
* IdentityProvider service.
|
|
24006
24836
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
24007
|
-
* @version
|
|
24837
|
+
* @version 175.0.0
|
|
24008
24838
|
*/
|
|
24009
24839
|
|
|
24010
24840
|
/**
|
|
@@ -24760,7 +25590,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24760
25590
|
/**
|
|
24761
25591
|
* InfrastructureAsCode service.
|
|
24762
25592
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
24763
|
-
* @version
|
|
25593
|
+
* @version 175.0.0
|
|
24764
25594
|
*/
|
|
24765
25595
|
|
|
24766
25596
|
/**
|
|
@@ -24927,7 +25757,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24927
25757
|
/**
|
|
24928
25758
|
* Integrations service.
|
|
24929
25759
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
24930
|
-
* @version
|
|
25760
|
+
* @version 175.0.0
|
|
24931
25761
|
*/
|
|
24932
25762
|
|
|
24933
25763
|
/**
|
|
@@ -26889,7 +27719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26889
27719
|
/**
|
|
26890
27720
|
* Journey service.
|
|
26891
27721
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
26892
|
-
* @version
|
|
27722
|
+
* @version 175.0.0
|
|
26893
27723
|
*/
|
|
26894
27724
|
|
|
26895
27725
|
/**
|
|
@@ -27089,6 +27919,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27089
27919
|
);
|
|
27090
27920
|
}
|
|
27091
27921
|
|
|
27922
|
+
/**
|
|
27923
|
+
* Retrieve all sessions for a given external contact.
|
|
27924
|
+
*
|
|
27925
|
+
* @param {String} contactId ExternalContact ID
|
|
27926
|
+
* @param {Object} opts Optional parameters
|
|
27927
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
27928
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
27929
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
27930
|
+
*/
|
|
27931
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
27932
|
+
opts = opts || {};
|
|
27933
|
+
|
|
27934
|
+
// verify the required parameter 'contactId' is set
|
|
27935
|
+
if (contactId === undefined || contactId === null) {
|
|
27936
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
27937
|
+
}
|
|
27938
|
+
|
|
27939
|
+
return this.apiClient.callApi(
|
|
27940
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
27941
|
+
'GET',
|
|
27942
|
+
{ 'contactId': contactId },
|
|
27943
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
27944
|
+
{ },
|
|
27945
|
+
{ },
|
|
27946
|
+
null,
|
|
27947
|
+
['PureCloud OAuth'],
|
|
27948
|
+
['application/json'],
|
|
27949
|
+
['application/json']
|
|
27950
|
+
);
|
|
27951
|
+
}
|
|
27952
|
+
|
|
27092
27953
|
/**
|
|
27093
27954
|
* Retrieve a single action map.
|
|
27094
27955
|
*
|
|
@@ -27889,6 +28750,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27889
28750
|
);
|
|
27890
28751
|
}
|
|
27891
28752
|
|
|
28753
|
+
/**
|
|
28754
|
+
* Send a journey app event, used for tracking customer activity on an application.
|
|
28755
|
+
*
|
|
28756
|
+
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
28757
|
+
* @param {Object} opts Optional parameters
|
|
28758
|
+
* @param {Object} opts.body
|
|
28759
|
+
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28760
|
+
*/
|
|
28761
|
+
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
28762
|
+
opts = opts || {};
|
|
28763
|
+
|
|
28764
|
+
// verify the required parameter 'deploymentId' is set
|
|
28765
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
28766
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
|
|
28767
|
+
}
|
|
28768
|
+
|
|
28769
|
+
return this.apiClient.callApi(
|
|
28770
|
+
'/api/v2/journey/deployments/{deploymentId}/appevents',
|
|
28771
|
+
'POST',
|
|
28772
|
+
{ 'deploymentId': deploymentId },
|
|
28773
|
+
{ },
|
|
28774
|
+
{ },
|
|
28775
|
+
{ },
|
|
28776
|
+
opts['body'],
|
|
28777
|
+
['PureCloud OAuth'],
|
|
28778
|
+
['application/json'],
|
|
28779
|
+
['application/json']
|
|
28780
|
+
);
|
|
28781
|
+
}
|
|
28782
|
+
|
|
27892
28783
|
/**
|
|
27893
28784
|
* Create an outcome.
|
|
27894
28785
|
*
|
|
@@ -27992,7 +28883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27992
28883
|
/**
|
|
27993
28884
|
* Knowledge service.
|
|
27994
28885
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
27995
|
-
* @version
|
|
28886
|
+
* @version 175.0.0
|
|
27996
28887
|
*/
|
|
27997
28888
|
|
|
27998
28889
|
/**
|
|
@@ -28549,6 +29440,85 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28549
29440
|
);
|
|
28550
29441
|
}
|
|
28551
29442
|
|
|
29443
|
+
/**
|
|
29444
|
+
* Get a list of feedback records given on a document
|
|
29445
|
+
*
|
|
29446
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
29447
|
+
* @param {String} documentId Document ID.
|
|
29448
|
+
* @param {Object} opts Optional parameters
|
|
29449
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
29450
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
29451
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
29452
|
+
* @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.
|
|
29453
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
29454
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
29455
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
29456
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
29457
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
29458
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
29459
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
29460
|
+
*/
|
|
29461
|
+
getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
29462
|
+
opts = opts || {};
|
|
29463
|
+
|
|
29464
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
29465
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
29466
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
29467
|
+
}
|
|
29468
|
+
// verify the required parameter 'documentId' is set
|
|
29469
|
+
if (documentId === undefined || documentId === null) {
|
|
29470
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
29471
|
+
}
|
|
29472
|
+
|
|
29473
|
+
return this.apiClient.callApi(
|
|
29474
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
29475
|
+
'GET',
|
|
29476
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
29477
|
+
{ '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'] },
|
|
29478
|
+
{ },
|
|
29479
|
+
{ },
|
|
29480
|
+
null,
|
|
29481
|
+
['PureCloud OAuth'],
|
|
29482
|
+
['application/json'],
|
|
29483
|
+
['application/json']
|
|
29484
|
+
);
|
|
29485
|
+
}
|
|
29486
|
+
|
|
29487
|
+
/**
|
|
29488
|
+
* Get a single feedback record given on a document
|
|
29489
|
+
*
|
|
29490
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
29491
|
+
* @param {String} documentId Document ID.
|
|
29492
|
+
* @param {String} feedbackId Feedback ID.
|
|
29493
|
+
*/
|
|
29494
|
+
getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
|
|
29495
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
29496
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
29497
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29498
|
+
}
|
|
29499
|
+
// verify the required parameter 'documentId' is set
|
|
29500
|
+
if (documentId === undefined || documentId === null) {
|
|
29501
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29502
|
+
}
|
|
29503
|
+
// verify the required parameter 'feedbackId' is set
|
|
29504
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
29505
|
+
throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29506
|
+
}
|
|
29507
|
+
|
|
29508
|
+
return this.apiClient.callApi(
|
|
29509
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
29510
|
+
'GET',
|
|
29511
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
29512
|
+
{ },
|
|
29513
|
+
{ },
|
|
29514
|
+
{ },
|
|
29515
|
+
null,
|
|
29516
|
+
['PureCloud OAuth'],
|
|
29517
|
+
['application/json'],
|
|
29518
|
+
['application/json']
|
|
29519
|
+
);
|
|
29520
|
+
}
|
|
29521
|
+
|
|
28552
29522
|
/**
|
|
28553
29523
|
* Get a variation for a document.
|
|
28554
29524
|
*
|
|
@@ -28856,8 +29826,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28856
29826
|
*
|
|
28857
29827
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28858
29828
|
* @param {String} importJobId Import job ID
|
|
29829
|
+
* @param {Object} opts Optional parameters
|
|
29830
|
+
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
28859
29831
|
*/
|
|
28860
|
-
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
29832
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
|
|
29833
|
+
opts = opts || {};
|
|
29834
|
+
|
|
28861
29835
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
28862
29836
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
28863
29837
|
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
@@ -28871,7 +29845,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28871
29845
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
28872
29846
|
'GET',
|
|
28873
29847
|
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
28874
|
-
{
|
|
29848
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
28875
29849
|
{ },
|
|
28876
29850
|
{ },
|
|
28877
29851
|
null,
|
|
@@ -29894,6 +30868,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29894
30868
|
);
|
|
29895
30869
|
}
|
|
29896
30870
|
|
|
30871
|
+
/**
|
|
30872
|
+
* Give feedback on a document
|
|
30873
|
+
*
|
|
30874
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
30875
|
+
* @param {String} documentId Document ID.
|
|
30876
|
+
* @param {Object} opts Optional parameters
|
|
30877
|
+
* @param {Object} opts.body
|
|
30878
|
+
*/
|
|
30879
|
+
postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
|
|
30880
|
+
opts = opts || {};
|
|
30881
|
+
|
|
30882
|
+
// verify the required parameter 'sessionId' is set
|
|
30883
|
+
if (sessionId === undefined || sessionId === null) {
|
|
30884
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
30885
|
+
}
|
|
30886
|
+
// verify the required parameter 'documentId' is set
|
|
30887
|
+
if (documentId === undefined || documentId === null) {
|
|
30888
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
30889
|
+
}
|
|
30890
|
+
|
|
30891
|
+
return this.apiClient.callApi(
|
|
30892
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
|
|
30893
|
+
'POST',
|
|
30894
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
30895
|
+
{ },
|
|
30896
|
+
{ },
|
|
30897
|
+
{ },
|
|
30898
|
+
opts['body'],
|
|
30899
|
+
['PureCloud OAuth'],
|
|
30900
|
+
['application/json'],
|
|
30901
|
+
['application/json']
|
|
30902
|
+
);
|
|
30903
|
+
}
|
|
30904
|
+
|
|
29897
30905
|
/**
|
|
29898
30906
|
* Search the documents in a guest session.
|
|
29899
30907
|
*
|
|
@@ -30008,6 +31016,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30008
31016
|
);
|
|
30009
31017
|
}
|
|
30010
31018
|
|
|
31019
|
+
/**
|
|
31020
|
+
* Give feedback on a document
|
|
31021
|
+
*
|
|
31022
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31023
|
+
* @param {String} documentId Document ID.
|
|
31024
|
+
* @param {Object} opts Optional parameters
|
|
31025
|
+
* @param {Object} opts.body
|
|
31026
|
+
*/
|
|
31027
|
+
postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
31028
|
+
opts = opts || {};
|
|
31029
|
+
|
|
31030
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31031
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31032
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
31033
|
+
}
|
|
31034
|
+
// verify the required parameter 'documentId' is set
|
|
31035
|
+
if (documentId === undefined || documentId === null) {
|
|
31036
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
31037
|
+
}
|
|
31038
|
+
|
|
31039
|
+
return this.apiClient.callApi(
|
|
31040
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
31041
|
+
'POST',
|
|
31042
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31043
|
+
{ },
|
|
31044
|
+
{ },
|
|
31045
|
+
{ },
|
|
31046
|
+
opts['body'],
|
|
31047
|
+
['PureCloud OAuth'],
|
|
31048
|
+
['application/json'],
|
|
31049
|
+
['application/json']
|
|
31050
|
+
);
|
|
31051
|
+
}
|
|
31052
|
+
|
|
30011
31053
|
/**
|
|
30012
31054
|
* Create a variation for a document.
|
|
30013
31055
|
*
|
|
@@ -30078,6 +31120,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30078
31120
|
);
|
|
30079
31121
|
}
|
|
30080
31122
|
|
|
31123
|
+
/**
|
|
31124
|
+
* Create view for a document.
|
|
31125
|
+
*
|
|
31126
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31127
|
+
* @param {String} documentId Document ID.
|
|
31128
|
+
* @param {Object} opts Optional parameters
|
|
31129
|
+
* @param {Object} opts.body
|
|
31130
|
+
*/
|
|
31131
|
+
postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
|
|
31132
|
+
opts = opts || {};
|
|
31133
|
+
|
|
31134
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31135
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31136
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
31137
|
+
}
|
|
31138
|
+
// verify the required parameter 'documentId' is set
|
|
31139
|
+
if (documentId === undefined || documentId === null) {
|
|
31140
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
31141
|
+
}
|
|
31142
|
+
|
|
31143
|
+
return this.apiClient.callApi(
|
|
31144
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
|
|
31145
|
+
'POST',
|
|
31146
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31147
|
+
{ },
|
|
31148
|
+
{ },
|
|
31149
|
+
{ },
|
|
31150
|
+
opts['body'],
|
|
31151
|
+
['PureCloud OAuth'],
|
|
31152
|
+
['application/json'],
|
|
31153
|
+
['application/json']
|
|
31154
|
+
);
|
|
31155
|
+
}
|
|
31156
|
+
|
|
30081
31157
|
/**
|
|
30082
31158
|
* Create document.
|
|
30083
31159
|
*
|
|
@@ -30628,7 +31704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30628
31704
|
/**
|
|
30629
31705
|
* LanguageUnderstanding service.
|
|
30630
31706
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
30631
|
-
* @version
|
|
31707
|
+
* @version 175.0.0
|
|
30632
31708
|
*/
|
|
30633
31709
|
|
|
30634
31710
|
/**
|
|
@@ -31641,7 +32717,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31641
32717
|
/**
|
|
31642
32718
|
* Languages service.
|
|
31643
32719
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
31644
|
-
* @version
|
|
32720
|
+
* @version 175.0.0
|
|
31645
32721
|
*/
|
|
31646
32722
|
|
|
31647
32723
|
/**
|
|
@@ -31863,7 +32939,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31863
32939
|
/**
|
|
31864
32940
|
* Learning service.
|
|
31865
32941
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
31866
|
-
* @version
|
|
32942
|
+
* @version 175.0.0
|
|
31867
32943
|
*/
|
|
31868
32944
|
|
|
31869
32945
|
/**
|
|
@@ -32506,8 +33582,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32506
33582
|
* Publish a Learning module
|
|
32507
33583
|
*
|
|
32508
33584
|
* @param {String} moduleId The ID of the learning module
|
|
33585
|
+
* @param {Object} opts Optional parameters
|
|
33586
|
+
* @param {Object} opts.body The request body
|
|
32509
33587
|
*/
|
|
32510
|
-
postLearningModulePublish(moduleId) {
|
|
33588
|
+
postLearningModulePublish(moduleId, opts) {
|
|
33589
|
+
opts = opts || {};
|
|
33590
|
+
|
|
32511
33591
|
// verify the required parameter 'moduleId' is set
|
|
32512
33592
|
if (moduleId === undefined || moduleId === null) {
|
|
32513
33593
|
throw 'Missing the required parameter "moduleId" when calling postLearningModulePublish';
|
|
@@ -32520,7 +33600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32520
33600
|
{ },
|
|
32521
33601
|
{ },
|
|
32522
33602
|
{ },
|
|
32523
|
-
|
|
33603
|
+
opts['body'],
|
|
32524
33604
|
['PureCloud OAuth'],
|
|
32525
33605
|
['application/json'],
|
|
32526
33606
|
['application/json']
|
|
@@ -32678,7 +33758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32678
33758
|
/**
|
|
32679
33759
|
* License service.
|
|
32680
33760
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
32681
|
-
* @version
|
|
33761
|
+
* @version 175.0.0
|
|
32682
33762
|
*/
|
|
32683
33763
|
|
|
32684
33764
|
/**
|
|
@@ -32916,7 +33996,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32916
33996
|
/**
|
|
32917
33997
|
* Locations service.
|
|
32918
33998
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
32919
|
-
* @version
|
|
33999
|
+
* @version 175.0.0
|
|
32920
34000
|
*/
|
|
32921
34001
|
|
|
32922
34002
|
/**
|
|
@@ -33152,7 +34232,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33152
34232
|
/**
|
|
33153
34233
|
* Messaging service.
|
|
33154
34234
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
33155
|
-
* @version
|
|
34235
|
+
* @version 175.0.0
|
|
33156
34236
|
*/
|
|
33157
34237
|
|
|
33158
34238
|
/**
|
|
@@ -33511,7 +34591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33511
34591
|
/**
|
|
33512
34592
|
* MobileDevices service.
|
|
33513
34593
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
33514
|
-
* @version
|
|
34594
|
+
* @version 175.0.0
|
|
33515
34595
|
*/
|
|
33516
34596
|
|
|
33517
34597
|
/**
|
|
@@ -33662,7 +34742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33662
34742
|
/**
|
|
33663
34743
|
* Notifications service.
|
|
33664
34744
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
33665
|
-
* @version
|
|
34745
|
+
* @version 175.0.0
|
|
33666
34746
|
*/
|
|
33667
34747
|
|
|
33668
34748
|
/**
|
|
@@ -33895,7 +34975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33895
34975
|
/**
|
|
33896
34976
|
* OAuth service.
|
|
33897
34977
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
33898
|
-
* @version
|
|
34978
|
+
* @version 175.0.0
|
|
33899
34979
|
*/
|
|
33900
34980
|
|
|
33901
34981
|
/**
|
|
@@ -34261,7 +35341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34261
35341
|
/**
|
|
34262
35342
|
* Objects service.
|
|
34263
35343
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
34264
|
-
* @version
|
|
35344
|
+
* @version 175.0.0
|
|
34265
35345
|
*/
|
|
34266
35346
|
|
|
34267
35347
|
/**
|
|
@@ -34532,7 +35612,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34532
35612
|
/**
|
|
34533
35613
|
* Organization service.
|
|
34534
35614
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
34535
|
-
* @version
|
|
35615
|
+
* @version 175.0.0
|
|
34536
35616
|
*/
|
|
34537
35617
|
|
|
34538
35618
|
/**
|
|
@@ -34987,7 +36067,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34987
36067
|
/**
|
|
34988
36068
|
* OrganizationAuthorization service.
|
|
34989
36069
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
34990
|
-
* @version
|
|
36070
|
+
* @version 175.0.0
|
|
34991
36071
|
*/
|
|
34992
36072
|
|
|
34993
36073
|
/**
|
|
@@ -36334,7 +37414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36334
37414
|
/**
|
|
36335
37415
|
* Outbound service.
|
|
36336
37416
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
36337
|
-
* @version
|
|
37417
|
+
* @version 175.0.0
|
|
36338
37418
|
*/
|
|
36339
37419
|
|
|
36340
37420
|
/**
|
|
@@ -39956,7 +41036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39956
41036
|
/**
|
|
39957
41037
|
* Presence service.
|
|
39958
41038
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39959
|
-
* @version
|
|
41039
|
+
* @version 175.0.0
|
|
39960
41040
|
*/
|
|
39961
41041
|
|
|
39962
41042
|
/**
|
|
@@ -40695,7 +41775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40695
41775
|
/**
|
|
40696
41776
|
* ProcessAutomation service.
|
|
40697
41777
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
40698
|
-
* @version
|
|
41778
|
+
* @version 175.0.0
|
|
40699
41779
|
*/
|
|
40700
41780
|
|
|
40701
41781
|
/**
|
|
@@ -40934,7 +42014,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40934
42014
|
/**
|
|
40935
42015
|
* Quality service.
|
|
40936
42016
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
40937
|
-
* @version
|
|
42017
|
+
* @version 175.0.0
|
|
40938
42018
|
*/
|
|
40939
42019
|
|
|
40940
42020
|
/**
|
|
@@ -41217,6 +42297,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41217
42297
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
41218
42298
|
* @param {String} opts.name name
|
|
41219
42299
|
* @param {String} opts.group group id
|
|
42300
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
41220
42301
|
*/
|
|
41221
42302
|
getQualityAgentsActivity(opts) {
|
|
41222
42303
|
opts = opts || {};
|
|
@@ -41226,7 +42307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41226
42307
|
'/api/v2/quality/agents/activity',
|
|
41227
42308
|
'GET',
|
|
41228
42309
|
{ },
|
|
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'] },
|
|
42310
|
+
{ '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
42311
|
{ },
|
|
41231
42312
|
{ },
|
|
41232
42313
|
null,
|
|
@@ -41424,9 +42505,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41424
42505
|
* @param {Object} opts Optional parameters
|
|
41425
42506
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
41426
42507
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
41427
|
-
* @param {String} opts.sortBy
|
|
42508
|
+
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
41428
42509
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
41429
|
-
* @param {String} opts.nextPage
|
|
42510
|
+
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
41430
42511
|
* @param {String} opts.previousPage Previous page token
|
|
41431
42512
|
* @param {String} opts.conversationId conversationId specified
|
|
41432
42513
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -41435,12 +42516,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41435
42516
|
* @param {String} opts.queueId queue id
|
|
41436
42517
|
* @param {String} opts.startTime start time of the evaluation query
|
|
41437
42518
|
* @param {String} opts.endTime end time of the evaluation query
|
|
42519
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
41438
42520
|
* @param {Array.<String>} opts.evaluationState
|
|
41439
42521
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
41440
42522
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
41441
42523
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
41442
|
-
* @param {Number} opts.maximum maximum
|
|
41443
|
-
* @param {String} opts.sortOrder
|
|
42524
|
+
* @param {Number} opts.maximum the maximum number of results to return
|
|
42525
|
+
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
41444
42526
|
*/
|
|
41445
42527
|
getQualityEvaluationsQuery(opts) {
|
|
41446
42528
|
opts = opts || {};
|
|
@@ -41450,7 +42532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41450
42532
|
'/api/v2/quality/evaluations/query',
|
|
41451
42533
|
'GET',
|
|
41452
42534
|
{ },
|
|
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'] },
|
|
42535
|
+
{ '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
42536
|
{ },
|
|
41455
42537
|
{ },
|
|
41456
42538
|
null,
|
|
@@ -42527,7 +43609,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42527
43609
|
* @param {String} evaluationId evaluationId
|
|
42528
43610
|
* @param {Object} body evaluation
|
|
42529
43611
|
* @param {Object} opts Optional parameters
|
|
42530
|
-
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
43612
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
|
|
42531
43613
|
*/
|
|
42532
43614
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
42533
43615
|
opts = opts || {};
|
|
@@ -42686,7 +43768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42686
43768
|
/**
|
|
42687
43769
|
* Recording service.
|
|
42688
43770
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
42689
|
-
* @version
|
|
43771
|
+
* @version 175.0.0
|
|
42690
43772
|
*/
|
|
42691
43773
|
|
|
42692
43774
|
/**
|
|
@@ -44323,7 +45405,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44323
45405
|
/**
|
|
44324
45406
|
* ResponseManagement service.
|
|
44325
45407
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
44326
|
-
* @version
|
|
45408
|
+
* @version 175.0.0
|
|
44327
45409
|
*/
|
|
44328
45410
|
|
|
44329
45411
|
/**
|
|
@@ -44808,7 +45890,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44808
45890
|
/**
|
|
44809
45891
|
* Routing service.
|
|
44810
45892
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
44811
|
-
* @version
|
|
45893
|
+
* @version 175.0.0
|
|
44812
45894
|
*/
|
|
44813
45895
|
|
|
44814
45896
|
/**
|
|
@@ -45815,6 +46897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45815
46897
|
*
|
|
45816
46898
|
* @param {Object} opts Optional parameters
|
|
45817
46899
|
* @param {Object} opts.messengerType Messenger Type
|
|
46900
|
+
* @param {String} opts.name Recipient Name
|
|
45818
46901
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
45819
46902
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
45820
46903
|
*/
|
|
@@ -45826,7 +46909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45826
46909
|
'/api/v2/routing/message/recipients',
|
|
45827
46910
|
'GET',
|
|
45828
46911
|
{ },
|
|
45829
|
-
{ 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
46912
|
+
{ 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
45830
46913
|
{ },
|
|
45831
46914
|
{ },
|
|
45832
46915
|
null,
|
|
@@ -48515,7 +49598,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48515
49598
|
/**
|
|
48516
49599
|
* SCIM service.
|
|
48517
49600
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
48518
|
-
* @version
|
|
49601
|
+
* @version 175.0.0
|
|
48519
49602
|
*/
|
|
48520
49603
|
|
|
48521
49604
|
/**
|
|
@@ -49392,7 +50475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49392
50475
|
/**
|
|
49393
50476
|
* Scripts service.
|
|
49394
50477
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
49395
|
-
* @version
|
|
50478
|
+
* @version 175.0.0
|
|
49396
50479
|
*/
|
|
49397
50480
|
|
|
49398
50481
|
/**
|
|
@@ -49836,7 +50919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49836
50919
|
/**
|
|
49837
50920
|
* Search service.
|
|
49838
50921
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
49839
|
-
* @version
|
|
50922
|
+
* @version 175.0.0
|
|
49840
50923
|
*/
|
|
49841
50924
|
|
|
49842
50925
|
/**
|
|
@@ -50525,7 +51608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50525
51608
|
/**
|
|
50526
51609
|
* Settings service.
|
|
50527
51610
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
50528
|
-
* @version
|
|
51611
|
+
* @version 175.0.0
|
|
50529
51612
|
*/
|
|
50530
51613
|
|
|
50531
51614
|
/**
|
|
@@ -50590,7 +51673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50590
51673
|
/**
|
|
50591
51674
|
* SpeechTextAnalytics service.
|
|
50592
51675
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
50593
|
-
* @version
|
|
51676
|
+
* @version 175.0.0
|
|
50594
51677
|
*/
|
|
50595
51678
|
|
|
50596
51679
|
/**
|
|
@@ -51573,7 +52656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51573
52656
|
/**
|
|
51574
52657
|
* Stations service.
|
|
51575
52658
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
51576
|
-
* @version
|
|
52659
|
+
* @version 175.0.0
|
|
51577
52660
|
*/
|
|
51578
52661
|
|
|
51579
52662
|
/**
|
|
@@ -51675,7 +52758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51675
52758
|
/**
|
|
51676
52759
|
* Suggest service.
|
|
51677
52760
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
51678
|
-
* @version
|
|
52761
|
+
* @version 175.0.0
|
|
51679
52762
|
*/
|
|
51680
52763
|
|
|
51681
52764
|
/**
|
|
@@ -51814,7 +52897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51814
52897
|
/**
|
|
51815
52898
|
* TaskManagement service.
|
|
51816
52899
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
51817
|
-
* @version
|
|
52900
|
+
* @version 175.0.0
|
|
51818
52901
|
*/
|
|
51819
52902
|
|
|
51820
52903
|
/**
|
|
@@ -53095,7 +54178,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53095
54178
|
/**
|
|
53096
54179
|
* Teams service.
|
|
53097
54180
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
53098
|
-
* @version
|
|
54181
|
+
* @version 175.0.0
|
|
53099
54182
|
*/
|
|
53100
54183
|
|
|
53101
54184
|
/**
|
|
@@ -53397,7 +54480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53397
54480
|
/**
|
|
53398
54481
|
* Telephony service.
|
|
53399
54482
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
53400
|
-
* @version
|
|
54483
|
+
* @version 175.0.0
|
|
53401
54484
|
*/
|
|
53402
54485
|
|
|
53403
54486
|
/**
|
|
@@ -53525,7 +54608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53525
54608
|
/**
|
|
53526
54609
|
* TelephonyProvidersEdge service.
|
|
53527
54610
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
53528
|
-
* @version
|
|
54611
|
+
* @version 175.0.0
|
|
53529
54612
|
*/
|
|
53530
54613
|
|
|
53531
54614
|
/**
|
|
@@ -55188,7 +56271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55188
56271
|
}
|
|
55189
56272
|
|
|
55190
56273
|
/**
|
|
55191
|
-
* Get a list of Phone Instances
|
|
56274
|
+
* 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
56275
|
*
|
|
55193
56276
|
* @param {Object} opts Optional parameters
|
|
55194
56277
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -56814,7 +57897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56814
57897
|
/**
|
|
56815
57898
|
* Textbots service.
|
|
56816
57899
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
56817
|
-
* @version
|
|
57900
|
+
* @version 175.0.0
|
|
56818
57901
|
*/
|
|
56819
57902
|
|
|
56820
57903
|
/**
|
|
@@ -56942,7 +58025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56942
58025
|
/**
|
|
56943
58026
|
* Tokens service.
|
|
56944
58027
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
56945
|
-
* @version
|
|
58028
|
+
* @version 175.0.0
|
|
56946
58029
|
*/
|
|
56947
58030
|
|
|
56948
58031
|
/**
|
|
@@ -57005,14 +58088,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57005
58088
|
/**
|
|
57006
58089
|
* Fetch information about the current token
|
|
57007
58090
|
*
|
|
58091
|
+
* @param {Object} opts Optional parameters
|
|
58092
|
+
* @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
58093
|
*/
|
|
57009
|
-
getTokensMe() {
|
|
58094
|
+
getTokensMe(opts) {
|
|
58095
|
+
opts = opts || {};
|
|
58096
|
+
|
|
57010
58097
|
|
|
57011
58098
|
return this.apiClient.callApi(
|
|
57012
58099
|
'/api/v2/tokens/me',
|
|
57013
58100
|
'GET',
|
|
57014
58101
|
{ },
|
|
57015
|
-
{
|
|
58102
|
+
{ 'preserveIdleTTL': opts['preserveIdleTTL'] },
|
|
57016
58103
|
{ },
|
|
57017
58104
|
{ },
|
|
57018
58105
|
null,
|
|
@@ -57094,7 +58181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57094
58181
|
/**
|
|
57095
58182
|
* Uploads service.
|
|
57096
58183
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
57097
|
-
* @version
|
|
58184
|
+
* @version 175.0.0
|
|
57098
58185
|
*/
|
|
57099
58186
|
|
|
57100
58187
|
/**
|
|
@@ -57270,7 +58357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57270
58357
|
/**
|
|
57271
58358
|
* Usage service.
|
|
57272
58359
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
57273
|
-
* @version
|
|
58360
|
+
* @version 175.0.0
|
|
57274
58361
|
*/
|
|
57275
58362
|
|
|
57276
58363
|
/**
|
|
@@ -57480,7 +58567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57480
58567
|
/**
|
|
57481
58568
|
* UserRecordings service.
|
|
57482
58569
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
57483
|
-
* @version
|
|
58570
|
+
* @version 175.0.0
|
|
57484
58571
|
*/
|
|
57485
58572
|
|
|
57486
58573
|
/**
|
|
@@ -57665,7 +58752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57665
58752
|
/**
|
|
57666
58753
|
* Users service.
|
|
57667
58754
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
57668
|
-
* @version
|
|
58755
|
+
* @version 175.0.0
|
|
57669
58756
|
*/
|
|
57670
58757
|
|
|
57671
58758
|
/**
|
|
@@ -60226,7 +61313,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60226
61313
|
/**
|
|
60227
61314
|
* Utilities service.
|
|
60228
61315
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
60229
|
-
* @version
|
|
61316
|
+
* @version 175.0.0
|
|
60230
61317
|
*/
|
|
60231
61318
|
|
|
60232
61319
|
/**
|
|
@@ -60337,7 +61424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60337
61424
|
/**
|
|
60338
61425
|
* Voicemail service.
|
|
60339
61426
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
60340
|
-
* @version
|
|
61427
|
+
* @version 175.0.0
|
|
60341
61428
|
*/
|
|
60342
61429
|
|
|
60343
61430
|
/**
|
|
@@ -61004,7 +62091,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61004
62091
|
/**
|
|
61005
62092
|
* WebChat service.
|
|
61006
62093
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
61007
|
-
* @version
|
|
62094
|
+
* @version 175.0.0
|
|
61008
62095
|
*/
|
|
61009
62096
|
|
|
61010
62097
|
/**
|
|
@@ -61553,7 +62640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61553
62640
|
/**
|
|
61554
62641
|
* WebDeployments service.
|
|
61555
62642
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
61556
|
-
* @version
|
|
62643
|
+
* @version 175.0.0
|
|
61557
62644
|
*/
|
|
61558
62645
|
|
|
61559
62646
|
/**
|
|
@@ -61781,8 +62868,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61781
62868
|
* Get a deployment
|
|
61782
62869
|
*
|
|
61783
62870
|
* @param {String} deploymentId The deployment ID
|
|
62871
|
+
* @param {Object} opts Optional parameters
|
|
62872
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
61784
62873
|
*/
|
|
61785
|
-
getWebdeploymentsDeployment(deploymentId) {
|
|
62874
|
+
getWebdeploymentsDeployment(deploymentId, opts) {
|
|
62875
|
+
opts = opts || {};
|
|
62876
|
+
|
|
61786
62877
|
// verify the required parameter 'deploymentId' is set
|
|
61787
62878
|
if (deploymentId === undefined || deploymentId === null) {
|
|
61788
62879
|
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
|
|
@@ -61792,7 +62883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61792
62883
|
'/api/v2/webdeployments/deployments/{deploymentId}',
|
|
61793
62884
|
'GET',
|
|
61794
62885
|
{ 'deploymentId': deploymentId },
|
|
61795
|
-
{
|
|
62886
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61796
62887
|
{ },
|
|
61797
62888
|
{ },
|
|
61798
62889
|
null,
|
|
@@ -61838,6 +62929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61838
62929
|
* @param {String} deploymentId The deployment ID
|
|
61839
62930
|
* @param {Object} opts Optional parameters
|
|
61840
62931
|
* @param {String} opts.type Get active configuration on a deployment
|
|
62932
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
61841
62933
|
*/
|
|
61842
62934
|
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
61843
62935
|
opts = opts || {};
|
|
@@ -61851,7 +62943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61851
62943
|
'/api/v2/webdeployments/deployments/{deploymentId}/configurations',
|
|
61852
62944
|
'GET',
|
|
61853
62945
|
{ 'deploymentId': deploymentId },
|
|
61854
|
-
{ 'type': opts['type'] },
|
|
62946
|
+
{ 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61855
62947
|
{ },
|
|
61856
62948
|
{ },
|
|
61857
62949
|
null,
|
|
@@ -61865,7 +62957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61865
62957
|
* Get deployments
|
|
61866
62958
|
*
|
|
61867
62959
|
* @param {Object} opts Optional parameters
|
|
61868
|
-
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
62960
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
61869
62961
|
*/
|
|
61870
62962
|
getWebdeploymentsDeployments(opts) {
|
|
61871
62963
|
opts = opts || {};
|
|
@@ -62075,7 +63167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62075
63167
|
/**
|
|
62076
63168
|
* WebMessaging service.
|
|
62077
63169
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
62078
|
-
* @version
|
|
63170
|
+
* @version 175.0.0
|
|
62079
63171
|
*/
|
|
62080
63172
|
|
|
62081
63173
|
/**
|
|
@@ -62121,7 +63213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62121
63213
|
/**
|
|
62122
63214
|
* Widgets service.
|
|
62123
63215
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
62124
|
-
* @version
|
|
63216
|
+
* @version 175.0.0
|
|
62125
63217
|
*/
|
|
62126
63218
|
|
|
62127
63219
|
/**
|
|
@@ -62267,7 +63359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62267
63359
|
/**
|
|
62268
63360
|
* WorkforceManagement service.
|
|
62269
63361
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
62270
|
-
* @version
|
|
63362
|
+
* @version 175.0.0
|
|
62271
63363
|
*/
|
|
62272
63364
|
|
|
62273
63365
|
/**
|
|
@@ -63186,8 +64278,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63186
64278
|
*
|
|
63187
64279
|
* @param {String} businessUnitId The ID of the business unit.
|
|
63188
64280
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
|
|
64281
|
+
* @param {Object} opts Optional parameters
|
|
64282
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
63189
64283
|
*/
|
|
63190
|
-
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) {
|
|
64284
|
+
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) {
|
|
64285
|
+
opts = opts || {};
|
|
64286
|
+
|
|
63191
64287
|
// verify the required parameter 'businessUnitId' is set
|
|
63192
64288
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
63193
64289
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -63201,7 +64297,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63201
64297
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
63202
64298
|
'GET',
|
|
63203
64299
|
{ 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
|
|
63204
|
-
{
|
|
64300
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63205
64301
|
{ },
|
|
63206
64302
|
{ },
|
|
63207
64303
|
null,
|
|
@@ -63215,8 +64311,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63215
64311
|
* Gets list of service goal templates
|
|
63216
64312
|
*
|
|
63217
64313
|
* @param {String} businessUnitId The ID of the business unit.
|
|
64314
|
+
* @param {Object} opts Optional parameters
|
|
64315
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
63218
64316
|
*/
|
|
63219
|
-
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) {
|
|
64317
|
+
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) {
|
|
64318
|
+
opts = opts || {};
|
|
64319
|
+
|
|
63220
64320
|
// verify the required parameter 'businessUnitId' is set
|
|
63221
64321
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
63222
64322
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
@@ -63226,7 +64326,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63226
64326
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
63227
64327
|
'GET',
|
|
63228
64328
|
{ 'businessUnitId': businessUnitId },
|
|
63229
|
-
{
|
|
64329
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63230
64330
|
{ },
|
|
63231
64331
|
{ },
|
|
63232
64332
|
null,
|
|
@@ -63776,6 +64876,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63776
64876
|
);
|
|
63777
64877
|
}
|
|
63778
64878
|
|
|
64879
|
+
/**
|
|
64880
|
+
* Get integrations
|
|
64881
|
+
*
|
|
64882
|
+
*/
|
|
64883
|
+
getWorkforcemanagementIntegrationsHris() {
|
|
64884
|
+
|
|
64885
|
+
return this.apiClient.callApi(
|
|
64886
|
+
'/api/v2/workforcemanagement/integrations/hris',
|
|
64887
|
+
'GET',
|
|
64888
|
+
{ },
|
|
64889
|
+
{ },
|
|
64890
|
+
{ },
|
|
64891
|
+
{ },
|
|
64892
|
+
null,
|
|
64893
|
+
['PureCloud OAuth'],
|
|
64894
|
+
['application/json'],
|
|
64895
|
+
['application/json']
|
|
64896
|
+
);
|
|
64897
|
+
}
|
|
64898
|
+
|
|
64899
|
+
/**
|
|
64900
|
+
* Query the results of time off types job
|
|
64901
|
+
*
|
|
64902
|
+
* @param {String} jobId The ID of the job.
|
|
64903
|
+
*/
|
|
64904
|
+
getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) {
|
|
64905
|
+
// verify the required parameter 'jobId' is set
|
|
64906
|
+
if (jobId === undefined || jobId === null) {
|
|
64907
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
|
|
64908
|
+
}
|
|
64909
|
+
|
|
64910
|
+
return this.apiClient.callApi(
|
|
64911
|
+
'/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}',
|
|
64912
|
+
'GET',
|
|
64913
|
+
{ 'jobId': jobId },
|
|
64914
|
+
{ },
|
|
64915
|
+
{ },
|
|
64916
|
+
{ },
|
|
64917
|
+
null,
|
|
64918
|
+
['PureCloud OAuth'],
|
|
64919
|
+
['application/json'],
|
|
64920
|
+
['application/json']
|
|
64921
|
+
);
|
|
64922
|
+
}
|
|
64923
|
+
|
|
63779
64924
|
/**
|
|
63780
64925
|
* Get management unit
|
|
63781
64926
|
* settings.shortTermForecasting is deprecated and now lives on the business unit
|
|
@@ -64589,6 +65734,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64589
65734
|
);
|
|
64590
65735
|
}
|
|
64591
65736
|
|
|
65737
|
+
/**
|
|
65738
|
+
* Query the results of time off types job
|
|
65739
|
+
*
|
|
65740
|
+
* @param {String} jobId The ID of the job.
|
|
65741
|
+
*/
|
|
65742
|
+
getWorkforcemanagementTimeoffbalanceJob(jobId) {
|
|
65743
|
+
// verify the required parameter 'jobId' is set
|
|
65744
|
+
if (jobId === undefined || jobId === null) {
|
|
65745
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
|
|
65746
|
+
}
|
|
65747
|
+
|
|
65748
|
+
return this.apiClient.callApi(
|
|
65749
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}',
|
|
65750
|
+
'GET',
|
|
65751
|
+
{ 'jobId': jobId },
|
|
65752
|
+
{ },
|
|
65753
|
+
{ },
|
|
65754
|
+
{ },
|
|
65755
|
+
null,
|
|
65756
|
+
['PureCloud OAuth'],
|
|
65757
|
+
['application/json'],
|
|
65758
|
+
['application/json']
|
|
65759
|
+
);
|
|
65760
|
+
}
|
|
65761
|
+
|
|
64592
65762
|
/**
|
|
64593
65763
|
* Get a time off request for the current user
|
|
64594
65764
|
*
|
|
@@ -64960,6 +66130,45 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64960
66130
|
);
|
|
64961
66131
|
}
|
|
64962
66132
|
|
|
66133
|
+
/**
|
|
66134
|
+
* Set integration status for a time off request.
|
|
66135
|
+
*
|
|
66136
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
66137
|
+
* @param {String} timeOffRequestId The ID of the time off request.
|
|
66138
|
+
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
66139
|
+
* @param {Object} opts Optional parameters
|
|
66140
|
+
* @param {Object} opts.body body
|
|
66141
|
+
*/
|
|
66142
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) {
|
|
66143
|
+
opts = opts || {};
|
|
66144
|
+
|
|
66145
|
+
// verify the required parameter 'managementUnitId' is set
|
|
66146
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
66147
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66148
|
+
}
|
|
66149
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
66150
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
66151
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66152
|
+
}
|
|
66153
|
+
// verify the required parameter 'userId' is set
|
|
66154
|
+
if (userId === undefined || userId === null) {
|
|
66155
|
+
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66156
|
+
}
|
|
66157
|
+
|
|
66158
|
+
return this.apiClient.callApi(
|
|
66159
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
66160
|
+
'PATCH',
|
|
66161
|
+
{ 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
|
|
66162
|
+
{ },
|
|
66163
|
+
{ },
|
|
66164
|
+
{ },
|
|
66165
|
+
opts['body'],
|
|
66166
|
+
['PureCloud OAuth'],
|
|
66167
|
+
['application/json'],
|
|
66168
|
+
['application/json']
|
|
66169
|
+
);
|
|
66170
|
+
}
|
|
66171
|
+
|
|
64963
66172
|
/**
|
|
64964
66173
|
* Update a time off request
|
|
64965
66174
|
*
|
|
@@ -65197,6 +66406,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65197
66406
|
*
|
|
65198
66407
|
* @param {Object} opts Optional parameters
|
|
65199
66408
|
* @param {Object} opts.body body
|
|
66409
|
+
* @deprecated
|
|
65200
66410
|
*/
|
|
65201
66411
|
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
65202
66412
|
opts = opts || {};
|
|
@@ -65305,6 +66515,54 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65305
66515
|
);
|
|
65306
66516
|
}
|
|
65307
66517
|
|
|
66518
|
+
/**
|
|
66519
|
+
* Move agents in and out of management unit
|
|
66520
|
+
*
|
|
66521
|
+
* @param {Object} opts Optional parameters
|
|
66522
|
+
* @param {Object} opts.body body
|
|
66523
|
+
*/
|
|
66524
|
+
postWorkforcemanagementAgents(opts) {
|
|
66525
|
+
opts = opts || {};
|
|
66526
|
+
|
|
66527
|
+
|
|
66528
|
+
return this.apiClient.callApi(
|
|
66529
|
+
'/api/v2/workforcemanagement/agents',
|
|
66530
|
+
'POST',
|
|
66531
|
+
{ },
|
|
66532
|
+
{ },
|
|
66533
|
+
{ },
|
|
66534
|
+
{ },
|
|
66535
|
+
opts['body'],
|
|
66536
|
+
['PureCloud OAuth'],
|
|
66537
|
+
['application/json'],
|
|
66538
|
+
['application/json']
|
|
66539
|
+
);
|
|
66540
|
+
}
|
|
66541
|
+
|
|
66542
|
+
/**
|
|
66543
|
+
* Query integrations for agents
|
|
66544
|
+
*
|
|
66545
|
+
* @param {Object} opts Optional parameters
|
|
66546
|
+
* @param {Object} opts.body body
|
|
66547
|
+
*/
|
|
66548
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) {
|
|
66549
|
+
opts = opts || {};
|
|
66550
|
+
|
|
66551
|
+
|
|
66552
|
+
return this.apiClient.callApi(
|
|
66553
|
+
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
66554
|
+
'POST',
|
|
66555
|
+
{ },
|
|
66556
|
+
{ },
|
|
66557
|
+
{ },
|
|
66558
|
+
{ },
|
|
66559
|
+
opts['body'],
|
|
66560
|
+
['PureCloud OAuth'],
|
|
66561
|
+
['application/json'],
|
|
66562
|
+
['application/json']
|
|
66563
|
+
);
|
|
66564
|
+
}
|
|
66565
|
+
|
|
65308
66566
|
/**
|
|
65309
66567
|
* Get agent possible work shifts for requested time frame
|
|
65310
66568
|
*
|
|
@@ -66127,6 +67385,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66127
67385
|
);
|
|
66128
67386
|
}
|
|
66129
67387
|
|
|
67388
|
+
/**
|
|
67389
|
+
* Get list of time off types configured in integration
|
|
67390
|
+
*
|
|
67391
|
+
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
67392
|
+
*/
|
|
67393
|
+
postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) {
|
|
67394
|
+
// verify the required parameter 'hrisIntegrationId' is set
|
|
67395
|
+
if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
|
|
67396
|
+
throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
|
|
67397
|
+
}
|
|
67398
|
+
|
|
67399
|
+
return this.apiClient.callApi(
|
|
67400
|
+
'/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs',
|
|
67401
|
+
'POST',
|
|
67402
|
+
{ 'hrisIntegrationId': hrisIntegrationId },
|
|
67403
|
+
{ },
|
|
67404
|
+
{ },
|
|
67405
|
+
{ },
|
|
67406
|
+
null,
|
|
67407
|
+
['PureCloud OAuth'],
|
|
67408
|
+
['application/json'],
|
|
67409
|
+
['application/json']
|
|
67410
|
+
);
|
|
67411
|
+
}
|
|
67412
|
+
|
|
66130
67413
|
/**
|
|
66131
67414
|
* Query published schedules for given given time range for set of users
|
|
66132
67415
|
*
|
|
@@ -66391,6 +67674,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66391
67674
|
);
|
|
66392
67675
|
}
|
|
66393
67676
|
|
|
67677
|
+
/**
|
|
67678
|
+
* Retrieves integration statuses for a list of time off requests
|
|
67679
|
+
*
|
|
67680
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
67681
|
+
* @param {Object} opts Optional parameters
|
|
67682
|
+
* @param {Object} opts.body body
|
|
67683
|
+
*/
|
|
67684
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) {
|
|
67685
|
+
opts = opts || {};
|
|
67686
|
+
|
|
67687
|
+
// verify the required parameter 'managementUnitId' is set
|
|
67688
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
67689
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
67690
|
+
}
|
|
67691
|
+
|
|
67692
|
+
return this.apiClient.callApi(
|
|
67693
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
67694
|
+
'POST',
|
|
67695
|
+
{ 'managementUnitId': managementUnitId },
|
|
67696
|
+
{ },
|
|
67697
|
+
{ },
|
|
67698
|
+
{ },
|
|
67699
|
+
opts['body'],
|
|
67700
|
+
['PureCloud OAuth'],
|
|
67701
|
+
['application/json'],
|
|
67702
|
+
['application/json']
|
|
67703
|
+
);
|
|
67704
|
+
}
|
|
67705
|
+
|
|
66394
67706
|
/**
|
|
66395
67707
|
* Fetches time off requests matching the conditions specified in the request body
|
|
66396
67708
|
* 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 +67831,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66519
67831
|
);
|
|
66520
67832
|
}
|
|
66521
67833
|
|
|
67834
|
+
/**
|
|
67835
|
+
* Estimates available time off for an agent
|
|
67836
|
+
*
|
|
67837
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
67838
|
+
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
67839
|
+
* @param {Object} opts Optional parameters
|
|
67840
|
+
* @param {Object} opts.body body
|
|
67841
|
+
*/
|
|
67842
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) {
|
|
67843
|
+
opts = opts || {};
|
|
67844
|
+
|
|
67845
|
+
// verify the required parameter 'managementUnitId' is set
|
|
67846
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
67847
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
67848
|
+
}
|
|
67849
|
+
// verify the required parameter 'userId' is set
|
|
67850
|
+
if (userId === undefined || userId === null) {
|
|
67851
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
67852
|
+
}
|
|
67853
|
+
|
|
67854
|
+
return this.apiClient.callApi(
|
|
67855
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
67856
|
+
'POST',
|
|
67857
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
67858
|
+
{ },
|
|
67859
|
+
{ },
|
|
67860
|
+
{ },
|
|
67861
|
+
opts['body'],
|
|
67862
|
+
['PureCloud OAuth'],
|
|
67863
|
+
['application/json'],
|
|
67864
|
+
['application/json']
|
|
67865
|
+
);
|
|
67866
|
+
}
|
|
67867
|
+
|
|
66522
67868
|
/**
|
|
66523
67869
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
66524
67870
|
*
|
|
@@ -66961,6 +68307,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66961
68307
|
);
|
|
66962
68308
|
}
|
|
66963
68309
|
|
|
68310
|
+
/**
|
|
68311
|
+
* Query time off balances for the current user for specified activity code and dates
|
|
68312
|
+
*
|
|
68313
|
+
* @param {Object} body The request body
|
|
68314
|
+
*/
|
|
68315
|
+
postWorkforcemanagementTimeoffbalanceJobs(body) {
|
|
68316
|
+
// verify the required parameter 'body' is set
|
|
68317
|
+
if (body === undefined || body === null) {
|
|
68318
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
|
|
68319
|
+
}
|
|
68320
|
+
|
|
68321
|
+
return this.apiClient.callApi(
|
|
68322
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs',
|
|
68323
|
+
'POST',
|
|
68324
|
+
{ },
|
|
68325
|
+
{ },
|
|
68326
|
+
{ },
|
|
68327
|
+
{ },
|
|
68328
|
+
body,
|
|
68329
|
+
['PureCloud OAuth'],
|
|
68330
|
+
['application/json'],
|
|
68331
|
+
['application/json']
|
|
68332
|
+
);
|
|
68333
|
+
}
|
|
68334
|
+
|
|
66964
68335
|
/**
|
|
66965
68336
|
* Queries available time off for the current user
|
|
66966
68337
|
*
|
|
@@ -67009,6 +68380,84 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67009
68380
|
);
|
|
67010
68381
|
}
|
|
67011
68382
|
|
|
68383
|
+
/**
|
|
68384
|
+
* Estimates available time off for current user
|
|
68385
|
+
*
|
|
68386
|
+
* @param {Object} opts Optional parameters
|
|
68387
|
+
* @param {Object} opts.body body
|
|
68388
|
+
*/
|
|
68389
|
+
postWorkforcemanagementTimeoffrequestsEstimate(opts) {
|
|
68390
|
+
opts = opts || {};
|
|
68391
|
+
|
|
68392
|
+
|
|
68393
|
+
return this.apiClient.callApi(
|
|
68394
|
+
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
68395
|
+
'POST',
|
|
68396
|
+
{ },
|
|
68397
|
+
{ },
|
|
68398
|
+
{ },
|
|
68399
|
+
{ },
|
|
68400
|
+
opts['body'],
|
|
68401
|
+
['PureCloud OAuth'],
|
|
68402
|
+
['application/json'],
|
|
68403
|
+
['application/json']
|
|
68404
|
+
);
|
|
68405
|
+
}
|
|
68406
|
+
|
|
68407
|
+
/**
|
|
68408
|
+
* Retrieves integration statuses for a list of current user time off requests
|
|
68409
|
+
*
|
|
68410
|
+
* @param {Object} opts Optional parameters
|
|
68411
|
+
* @param {Object} opts.body body
|
|
68412
|
+
*/
|
|
68413
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) {
|
|
68414
|
+
opts = opts || {};
|
|
68415
|
+
|
|
68416
|
+
|
|
68417
|
+
return this.apiClient.callApi(
|
|
68418
|
+
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
68419
|
+
'POST',
|
|
68420
|
+
{ },
|
|
68421
|
+
{ },
|
|
68422
|
+
{ },
|
|
68423
|
+
{ },
|
|
68424
|
+
opts['body'],
|
|
68425
|
+
['PureCloud OAuth'],
|
|
68426
|
+
['application/json'],
|
|
68427
|
+
['application/json']
|
|
68428
|
+
);
|
|
68429
|
+
}
|
|
68430
|
+
|
|
68431
|
+
/**
|
|
68432
|
+
* Update integrations for agent
|
|
68433
|
+
*
|
|
68434
|
+
* @param {String} agentId The ID of the agent
|
|
68435
|
+
* @param {Object} body body
|
|
68436
|
+
*/
|
|
68437
|
+
putWorkforcemanagementAgentIntegrationsHris(agentId, body) {
|
|
68438
|
+
// verify the required parameter 'agentId' is set
|
|
68439
|
+
if (agentId === undefined || agentId === null) {
|
|
68440
|
+
throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
68441
|
+
}
|
|
68442
|
+
// verify the required parameter 'body' is set
|
|
68443
|
+
if (body === undefined || body === null) {
|
|
68444
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
68445
|
+
}
|
|
68446
|
+
|
|
68447
|
+
return this.apiClient.callApi(
|
|
68448
|
+
'/api/v2/workforcemanagement/agents/{agentId}/integrations/hris',
|
|
68449
|
+
'PUT',
|
|
68450
|
+
{ 'agentId': agentId },
|
|
68451
|
+
{ },
|
|
68452
|
+
{ },
|
|
68453
|
+
{ },
|
|
68454
|
+
body,
|
|
68455
|
+
['PureCloud OAuth'],
|
|
68456
|
+
['application/json'],
|
|
68457
|
+
['application/json']
|
|
68458
|
+
);
|
|
68459
|
+
}
|
|
68460
|
+
|
|
67012
68461
|
/**
|
|
67013
68462
|
* Sets daily values for a date range of time off limit object
|
|
67014
68463
|
* 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 +68523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67074
68523
|
* </pre>
|
|
67075
68524
|
* </p>
|
|
67076
68525
|
* @module purecloud-platform-client-v2/index
|
|
67077
|
-
* @version
|
|
68526
|
+
* @version 175.0.0
|
|
67078
68527
|
*/
|
|
67079
68528
|
class platformClient {
|
|
67080
68529
|
constructor() {
|