purecloud-platform-client-v2 249.1.0 → 250.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1466 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +1466 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +461 -124
- package/dist/web-cjs/purecloud-platform-client-v2.js +461 -124
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +748 -41
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +157 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -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/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.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 +41 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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/EmployeeEngagementApi.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/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +471 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +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/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +8 -8
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +9 -21
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +765 -70
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -748,7 +748,7 @@ class Configuration {
|
|
|
748
748
|
|
|
749
749
|
/**
|
|
750
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
751
|
-
* @version
|
|
751
|
+
* @version 250.0.0
|
|
752
752
|
*/
|
|
753
753
|
class ApiClient {
|
|
754
754
|
/**
|
|
@@ -2436,7 +2436,7 @@ class AIStudioApi {
|
|
|
2436
2436
|
/**
|
|
2437
2437
|
* AIStudio service.
|
|
2438
2438
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2439
|
-
* @version
|
|
2439
|
+
* @version 250.0.0
|
|
2440
2440
|
*/
|
|
2441
2441
|
|
|
2442
2442
|
/**
|
|
@@ -3151,7 +3151,7 @@ class AgentAssistantsApi {
|
|
|
3151
3151
|
/**
|
|
3152
3152
|
* AgentAssistants service.
|
|
3153
3153
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3154
|
-
* @version
|
|
3154
|
+
* @version 250.0.0
|
|
3155
3155
|
*/
|
|
3156
3156
|
|
|
3157
3157
|
/**
|
|
@@ -3955,7 +3955,7 @@ class AgentCopilotApi {
|
|
|
3955
3955
|
/**
|
|
3956
3956
|
* AgentCopilot service.
|
|
3957
3957
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3958
|
-
* @version
|
|
3958
|
+
* @version 250.0.0
|
|
3959
3959
|
*/
|
|
3960
3960
|
|
|
3961
3961
|
/**
|
|
@@ -4067,7 +4067,7 @@ class AgentUIApi {
|
|
|
4067
4067
|
/**
|
|
4068
4068
|
* AgentUI service.
|
|
4069
4069
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4070
|
-
* @version
|
|
4070
|
+
* @version 250.0.0
|
|
4071
4071
|
*/
|
|
4072
4072
|
|
|
4073
4073
|
/**
|
|
@@ -4218,7 +4218,7 @@ class AlertingApi {
|
|
|
4218
4218
|
/**
|
|
4219
4219
|
* Alerting service.
|
|
4220
4220
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4221
|
-
* @version
|
|
4221
|
+
* @version 250.0.0
|
|
4222
4222
|
*/
|
|
4223
4223
|
|
|
4224
4224
|
/**
|
|
@@ -4679,7 +4679,7 @@ class AnalyticsApi {
|
|
|
4679
4679
|
/**
|
|
4680
4680
|
* Analytics service.
|
|
4681
4681
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4682
|
-
* @version
|
|
4682
|
+
* @version 250.0.0
|
|
4683
4683
|
*/
|
|
4684
4684
|
|
|
4685
4685
|
/**
|
|
@@ -4879,6 +4879,37 @@ class AnalyticsApi {
|
|
|
4879
4879
|
);
|
|
4880
4880
|
}
|
|
4881
4881
|
|
|
4882
|
+
/**
|
|
4883
|
+
* Delete/cancel an async request for copilot aggregates
|
|
4884
|
+
*
|
|
4885
|
+
* @param {String} jobId jobId
|
|
4886
|
+
* @param {Object} opts Optional parameters
|
|
4887
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4888
|
+
* deleteAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4889
|
+
*/
|
|
4890
|
+
deleteAnalyticsCopilotsAggregatesJob(jobId, opts) {
|
|
4891
|
+
opts = opts || {};
|
|
4892
|
+
|
|
4893
|
+
// verify the required parameter 'jobId' is set
|
|
4894
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4895
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCopilotsAggregatesJob';
|
|
4896
|
+
}
|
|
4897
|
+
|
|
4898
|
+
return this.apiClient.callApi(
|
|
4899
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}',
|
|
4900
|
+
'DELETE',
|
|
4901
|
+
{ 'jobId': jobId },
|
|
4902
|
+
{ },
|
|
4903
|
+
{ },
|
|
4904
|
+
{ },
|
|
4905
|
+
null,
|
|
4906
|
+
['PureCloud OAuth'],
|
|
4907
|
+
['application/json'],
|
|
4908
|
+
['application/json'],
|
|
4909
|
+
opts['customHeaders']
|
|
4910
|
+
);
|
|
4911
|
+
}
|
|
4912
|
+
|
|
4882
4913
|
/**
|
|
4883
4914
|
* Delete/cancel an async request for evaluation aggregates
|
|
4884
4915
|
*
|
|
@@ -5848,6 +5879,69 @@ class AnalyticsApi {
|
|
|
5848
5879
|
);
|
|
5849
5880
|
}
|
|
5850
5881
|
|
|
5882
|
+
/**
|
|
5883
|
+
* Get status for async query for copilot aggregates
|
|
5884
|
+
*
|
|
5885
|
+
* @param {String} jobId jobId
|
|
5886
|
+
* @param {Object} opts Optional parameters
|
|
5887
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5888
|
+
* getAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5889
|
+
*/
|
|
5890
|
+
getAnalyticsCopilotsAggregatesJob(jobId, opts) {
|
|
5891
|
+
opts = opts || {};
|
|
5892
|
+
|
|
5893
|
+
// verify the required parameter 'jobId' is set
|
|
5894
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
5895
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCopilotsAggregatesJob';
|
|
5896
|
+
}
|
|
5897
|
+
|
|
5898
|
+
return this.apiClient.callApi(
|
|
5899
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}',
|
|
5900
|
+
'GET',
|
|
5901
|
+
{ 'jobId': jobId },
|
|
5902
|
+
{ },
|
|
5903
|
+
{ },
|
|
5904
|
+
{ },
|
|
5905
|
+
null,
|
|
5906
|
+
['PureCloud OAuth'],
|
|
5907
|
+
['application/json'],
|
|
5908
|
+
['application/json'],
|
|
5909
|
+
opts['customHeaders']
|
|
5910
|
+
);
|
|
5911
|
+
}
|
|
5912
|
+
|
|
5913
|
+
/**
|
|
5914
|
+
* Fetch a page of results for an async aggregates query
|
|
5915
|
+
*
|
|
5916
|
+
* @param {String} jobId jobId
|
|
5917
|
+
* @param {Object} opts Optional parameters
|
|
5918
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
5919
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5920
|
+
* getAnalyticsCopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5921
|
+
*/
|
|
5922
|
+
getAnalyticsCopilotsAggregatesJobResults(jobId, opts) {
|
|
5923
|
+
opts = opts || {};
|
|
5924
|
+
|
|
5925
|
+
// verify the required parameter 'jobId' is set
|
|
5926
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
5927
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCopilotsAggregatesJobResults';
|
|
5928
|
+
}
|
|
5929
|
+
|
|
5930
|
+
return this.apiClient.callApi(
|
|
5931
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}/results',
|
|
5932
|
+
'GET',
|
|
5933
|
+
{ 'jobId': jobId },
|
|
5934
|
+
{ 'cursor': opts['cursor'] },
|
|
5935
|
+
{ },
|
|
5936
|
+
{ },
|
|
5937
|
+
null,
|
|
5938
|
+
['PureCloud OAuth'],
|
|
5939
|
+
['application/json'],
|
|
5940
|
+
['application/json'],
|
|
5941
|
+
opts['customHeaders']
|
|
5942
|
+
);
|
|
5943
|
+
}
|
|
5944
|
+
|
|
5851
5945
|
/**
|
|
5852
5946
|
* Get analytics data warehouse file download
|
|
5853
5947
|
*
|
|
@@ -7455,6 +7549,68 @@ class AnalyticsApi {
|
|
|
7455
7549
|
);
|
|
7456
7550
|
}
|
|
7457
7551
|
|
|
7552
|
+
/**
|
|
7553
|
+
* Query for copilot aggregates asynchronously
|
|
7554
|
+
*
|
|
7555
|
+
* @param {Object} body query
|
|
7556
|
+
* @param {Object} opts Optional parameters
|
|
7557
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7558
|
+
* postAnalyticsCopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7559
|
+
*/
|
|
7560
|
+
postAnalyticsCopilotsAggregatesJobs(body, opts) {
|
|
7561
|
+
opts = opts || {};
|
|
7562
|
+
|
|
7563
|
+
// verify the required parameter 'body' is set
|
|
7564
|
+
if (body === undefined || body === null) {
|
|
7565
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCopilotsAggregatesJobs';
|
|
7566
|
+
}
|
|
7567
|
+
|
|
7568
|
+
return this.apiClient.callApi(
|
|
7569
|
+
'/api/v2/analytics/copilots/aggregates/jobs',
|
|
7570
|
+
'POST',
|
|
7571
|
+
{ },
|
|
7572
|
+
{ },
|
|
7573
|
+
{ },
|
|
7574
|
+
{ },
|
|
7575
|
+
body,
|
|
7576
|
+
['PureCloud OAuth'],
|
|
7577
|
+
['application/json'],
|
|
7578
|
+
['application/json'],
|
|
7579
|
+
opts['customHeaders']
|
|
7580
|
+
);
|
|
7581
|
+
}
|
|
7582
|
+
|
|
7583
|
+
/**
|
|
7584
|
+
* Query for copilot aggregates
|
|
7585
|
+
*
|
|
7586
|
+
* @param {Object} body query
|
|
7587
|
+
* @param {Object} opts Optional parameters
|
|
7588
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7589
|
+
* postAnalyticsCopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7590
|
+
*/
|
|
7591
|
+
postAnalyticsCopilotsAggregatesQuery(body, opts) {
|
|
7592
|
+
opts = opts || {};
|
|
7593
|
+
|
|
7594
|
+
// verify the required parameter 'body' is set
|
|
7595
|
+
if (body === undefined || body === null) {
|
|
7596
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCopilotsAggregatesQuery';
|
|
7597
|
+
}
|
|
7598
|
+
|
|
7599
|
+
return this.apiClient.callApi(
|
|
7600
|
+
'/api/v2/analytics/copilots/aggregates/query',
|
|
7601
|
+
'POST',
|
|
7602
|
+
{ },
|
|
7603
|
+
{ },
|
|
7604
|
+
{ },
|
|
7605
|
+
{ },
|
|
7606
|
+
body,
|
|
7607
|
+
['PureCloud OAuth'],
|
|
7608
|
+
['application/json'],
|
|
7609
|
+
['application/json'],
|
|
7610
|
+
opts['customHeaders']
|
|
7611
|
+
);
|
|
7612
|
+
}
|
|
7613
|
+
|
|
7458
7614
|
/**
|
|
7459
7615
|
* Get download URLs for analytics data warehouse files
|
|
7460
7616
|
*
|
|
@@ -8317,7 +8473,6 @@ class AnalyticsApi {
|
|
|
8317
8473
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned. Used for pagination.
|
|
8318
8474
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.
|
|
8319
8475
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8320
|
-
* postAnalyticsTaskmanagementMetricsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8321
8476
|
*/
|
|
8322
8477
|
postAnalyticsTaskmanagementMetricsQuery(body, opts) {
|
|
8323
8478
|
opts = opts || {};
|
|
@@ -8654,7 +8809,7 @@ class ArchitectApi {
|
|
|
8654
8809
|
/**
|
|
8655
8810
|
* Architect service.
|
|
8656
8811
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8657
|
-
* @version
|
|
8812
|
+
* @version 250.0.0
|
|
8658
8813
|
*/
|
|
8659
8814
|
|
|
8660
8815
|
/**
|
|
@@ -13477,7 +13632,7 @@ class AssistantCopilotVariationsApi {
|
|
|
13477
13632
|
/**
|
|
13478
13633
|
* AssistantCopilotVariations service.
|
|
13479
13634
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13480
|
-
* @version
|
|
13635
|
+
* @version 250.0.0
|
|
13481
13636
|
*/
|
|
13482
13637
|
|
|
13483
13638
|
/**
|
|
@@ -13673,7 +13828,7 @@ class AuditApi {
|
|
|
13673
13828
|
/**
|
|
13674
13829
|
* Audit service.
|
|
13675
13830
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
13676
|
-
* @version
|
|
13831
|
+
* @version 250.0.0
|
|
13677
13832
|
*/
|
|
13678
13833
|
|
|
13679
13834
|
/**
|
|
@@ -13900,7 +14055,7 @@ class AuthorizationApi {
|
|
|
13900
14055
|
/**
|
|
13901
14056
|
* Authorization service.
|
|
13902
14057
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
13903
|
-
* @version
|
|
14058
|
+
* @version 250.0.0
|
|
13904
14059
|
*/
|
|
13905
14060
|
|
|
13906
14061
|
/**
|
|
@@ -15825,7 +15980,7 @@ class BackgroundAssistantApi {
|
|
|
15825
15980
|
/**
|
|
15826
15981
|
* BackgroundAssistant service.
|
|
15827
15982
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
15828
|
-
* @version
|
|
15983
|
+
* @version 250.0.0
|
|
15829
15984
|
*/
|
|
15830
15985
|
|
|
15831
15986
|
/**
|
|
@@ -15899,7 +16054,7 @@ class BillingApi {
|
|
|
15899
16054
|
/**
|
|
15900
16055
|
* Billing service.
|
|
15901
16056
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
15902
|
-
* @version
|
|
16057
|
+
* @version 250.0.0
|
|
15903
16058
|
*/
|
|
15904
16059
|
|
|
15905
16060
|
/**
|
|
@@ -16183,7 +16338,7 @@ class BusinessRulesApi {
|
|
|
16183
16338
|
/**
|
|
16184
16339
|
* BusinessRules service.
|
|
16185
16340
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16186
|
-
* @version
|
|
16341
|
+
* @version 250.0.0
|
|
16187
16342
|
*/
|
|
16188
16343
|
|
|
16189
16344
|
/**
|
|
@@ -17197,7 +17352,7 @@ class CarrierServicesApi {
|
|
|
17197
17352
|
/**
|
|
17198
17353
|
* CarrierServices service.
|
|
17199
17354
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17200
|
-
* @version
|
|
17355
|
+
* @version 250.0.0
|
|
17201
17356
|
*/
|
|
17202
17357
|
|
|
17203
17358
|
/**
|
|
@@ -17274,7 +17429,7 @@ class CaseManagementApi {
|
|
|
17274
17429
|
/**
|
|
17275
17430
|
* CaseManagement service.
|
|
17276
17431
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17277
|
-
* @version
|
|
17432
|
+
* @version 250.0.0
|
|
17278
17433
|
*/
|
|
17279
17434
|
|
|
17280
17435
|
/**
|
|
@@ -18500,7 +18655,7 @@ class ChatApi {
|
|
|
18500
18655
|
/**
|
|
18501
18656
|
* Chat service.
|
|
18502
18657
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18503
|
-
* @version
|
|
18658
|
+
* @version 250.0.0
|
|
18504
18659
|
*/
|
|
18505
18660
|
|
|
18506
18661
|
/**
|
|
@@ -19639,7 +19794,7 @@ class CoachingApi {
|
|
|
19639
19794
|
/**
|
|
19640
19795
|
* Coaching service.
|
|
19641
19796
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
19642
|
-
* @version
|
|
19797
|
+
* @version 250.0.0
|
|
19643
19798
|
*/
|
|
19644
19799
|
|
|
19645
19800
|
/**
|
|
@@ -20353,7 +20508,7 @@ class ContentManagementApi {
|
|
|
20353
20508
|
/**
|
|
20354
20509
|
* ContentManagement service.
|
|
20355
20510
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20356
|
-
* @version
|
|
20511
|
+
* @version 250.0.0
|
|
20357
20512
|
*/
|
|
20358
20513
|
|
|
20359
20514
|
/**
|
|
@@ -21548,7 +21703,7 @@ class ConversationsApi {
|
|
|
21548
21703
|
/**
|
|
21549
21704
|
* Conversations service.
|
|
21550
21705
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21551
|
-
* @version
|
|
21706
|
+
* @version 250.0.0
|
|
21552
21707
|
*/
|
|
21553
21708
|
|
|
21554
21709
|
/**
|
|
@@ -29424,6 +29579,46 @@ class ConversationsApi {
|
|
|
29424
29579
|
);
|
|
29425
29580
|
}
|
|
29426
29581
|
|
|
29582
|
+
/**
|
|
29583
|
+
* Start/stop the snippet recording for a participant
|
|
29584
|
+
*
|
|
29585
|
+
* @param {String} conversationId conversationId
|
|
29586
|
+
* @param {String} participantId participantId
|
|
29587
|
+
* @param {Object} body snippetRecordingRequest
|
|
29588
|
+
* @param {Object} opts Optional parameters
|
|
29589
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29590
|
+
*/
|
|
29591
|
+
postConversationsCallParticipantSnippetRecord(conversationId, participantId, body, opts) {
|
|
29592
|
+
opts = opts || {};
|
|
29593
|
+
|
|
29594
|
+
// verify the required parameter 'conversationId' is set
|
|
29595
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
29596
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantSnippetRecord';
|
|
29597
|
+
}
|
|
29598
|
+
// verify the required parameter 'participantId' is set
|
|
29599
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
29600
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantSnippetRecord';
|
|
29601
|
+
}
|
|
29602
|
+
// verify the required parameter 'body' is set
|
|
29603
|
+
if (body === undefined || body === null) {
|
|
29604
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantSnippetRecord';
|
|
29605
|
+
}
|
|
29606
|
+
|
|
29607
|
+
return this.apiClient.callApi(
|
|
29608
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/snippet/record',
|
|
29609
|
+
'POST',
|
|
29610
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
29611
|
+
{ },
|
|
29612
|
+
{ },
|
|
29613
|
+
{ },
|
|
29614
|
+
body,
|
|
29615
|
+
['PureCloud OAuth'],
|
|
29616
|
+
['application/json'],
|
|
29617
|
+
['application/json'],
|
|
29618
|
+
opts['customHeaders']
|
|
29619
|
+
);
|
|
29620
|
+
}
|
|
29621
|
+
|
|
29427
29622
|
/**
|
|
29428
29623
|
* Initiate voice consult transfer
|
|
29429
29624
|
*
|
|
@@ -32543,7 +32738,7 @@ class DataExtensionsApi {
|
|
|
32543
32738
|
/**
|
|
32544
32739
|
* DataExtensions service.
|
|
32545
32740
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
32546
|
-
* @version
|
|
32741
|
+
* @version 250.0.0
|
|
32547
32742
|
*/
|
|
32548
32743
|
|
|
32549
32744
|
/**
|
|
@@ -32644,7 +32839,7 @@ class DataPrivacyApi {
|
|
|
32644
32839
|
/**
|
|
32645
32840
|
* DataPrivacy service.
|
|
32646
32841
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
32647
|
-
* @version
|
|
32842
|
+
* @version 250.0.0
|
|
32648
32843
|
*/
|
|
32649
32844
|
|
|
32650
32845
|
/**
|
|
@@ -32841,7 +33036,7 @@ class DownloadsApi {
|
|
|
32841
33036
|
/**
|
|
32842
33037
|
* Downloads service.
|
|
32843
33038
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
32844
|
-
* @version
|
|
33039
|
+
* @version 250.0.0
|
|
32845
33040
|
*/
|
|
32846
33041
|
|
|
32847
33042
|
/**
|
|
@@ -32895,7 +33090,7 @@ class EmailsApi {
|
|
|
32895
33090
|
/**
|
|
32896
33091
|
* Emails service.
|
|
32897
33092
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
32898
|
-
* @version
|
|
33093
|
+
* @version 250.0.0
|
|
32899
33094
|
*/
|
|
32900
33095
|
|
|
32901
33096
|
/**
|
|
@@ -33043,7 +33238,7 @@ class EmployeeEngagementApi {
|
|
|
33043
33238
|
/**
|
|
33044
33239
|
* EmployeeEngagement service.
|
|
33045
33240
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33046
|
-
* @version
|
|
33241
|
+
* @version 250.0.0
|
|
33047
33242
|
*/
|
|
33048
33243
|
|
|
33049
33244
|
/**
|
|
@@ -33247,7 +33442,7 @@ class EventsApi {
|
|
|
33247
33442
|
/**
|
|
33248
33443
|
* Events service.
|
|
33249
33444
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33250
|
-
* @version
|
|
33445
|
+
* @version 250.0.0
|
|
33251
33446
|
*/
|
|
33252
33447
|
|
|
33253
33448
|
/**
|
|
@@ -33358,7 +33553,7 @@ class ExternalContactsApi {
|
|
|
33358
33553
|
/**
|
|
33359
33554
|
* ExternalContacts service.
|
|
33360
33555
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33361
|
-
* @version
|
|
33556
|
+
* @version 250.0.0
|
|
33362
33557
|
*/
|
|
33363
33558
|
|
|
33364
33559
|
/**
|
|
@@ -37129,7 +37324,7 @@ class FaxApi {
|
|
|
37129
37324
|
/**
|
|
37130
37325
|
* Fax service.
|
|
37131
37326
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37132
|
-
* @version
|
|
37327
|
+
* @version 250.0.0
|
|
37133
37328
|
*/
|
|
37134
37329
|
|
|
37135
37330
|
/**
|
|
@@ -37378,7 +37573,7 @@ class FlowsApi {
|
|
|
37378
37573
|
/**
|
|
37379
37574
|
* Flows service.
|
|
37380
37575
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37381
|
-
* @version
|
|
37576
|
+
* @version 250.0.0
|
|
37382
37577
|
*/
|
|
37383
37578
|
|
|
37384
37579
|
/**
|
|
@@ -37616,7 +37811,7 @@ class GamificationApi {
|
|
|
37616
37811
|
/**
|
|
37617
37812
|
* Gamification service.
|
|
37618
37813
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
37619
|
-
* @version
|
|
37814
|
+
* @version 250.0.0
|
|
37620
37815
|
*/
|
|
37621
37816
|
|
|
37622
37817
|
/**
|
|
@@ -40468,7 +40663,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
40468
40663
|
/**
|
|
40469
40664
|
* GeneralDataProtectionRegulation service.
|
|
40470
40665
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
40471
|
-
* @version
|
|
40666
|
+
* @version 250.0.0
|
|
40472
40667
|
*/
|
|
40473
40668
|
|
|
40474
40669
|
/**
|
|
@@ -40612,7 +40807,7 @@ class GeolocationApi {
|
|
|
40612
40807
|
/**
|
|
40613
40808
|
* Geolocation service.
|
|
40614
40809
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
40615
|
-
* @version
|
|
40810
|
+
* @version 250.0.0
|
|
40616
40811
|
*/
|
|
40617
40812
|
|
|
40618
40813
|
/**
|
|
@@ -40763,7 +40958,7 @@ class GreetingsApi {
|
|
|
40763
40958
|
/**
|
|
40764
40959
|
* Greetings service.
|
|
40765
40960
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
40766
|
-
* @version
|
|
40961
|
+
* @version 250.0.0
|
|
40767
40962
|
*/
|
|
40768
40963
|
|
|
40769
40964
|
/**
|
|
@@ -41379,7 +41574,7 @@ class GroupsApi {
|
|
|
41379
41574
|
/**
|
|
41380
41575
|
* Groups service.
|
|
41381
41576
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41382
|
-
* @version
|
|
41577
|
+
* @version 250.0.0
|
|
41383
41578
|
*/
|
|
41384
41579
|
|
|
41385
41580
|
/**
|
|
@@ -41970,7 +42165,7 @@ class IdentityProviderApi {
|
|
|
41970
42165
|
/**
|
|
41971
42166
|
* IdentityProvider service.
|
|
41972
42167
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
41973
|
-
* @version
|
|
42168
|
+
* @version 250.0.0
|
|
41974
42169
|
*/
|
|
41975
42170
|
|
|
41976
42171
|
/**
|
|
@@ -43021,7 +43216,7 @@ class InfrastructureAsCodeApi {
|
|
|
43021
43216
|
/**
|
|
43022
43217
|
* InfrastructureAsCode service.
|
|
43023
43218
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43024
|
-
* @version
|
|
43219
|
+
* @version 250.0.0
|
|
43025
43220
|
*/
|
|
43026
43221
|
|
|
43027
43222
|
/**
|
|
@@ -43201,7 +43396,7 @@ class IntegrationsApi {
|
|
|
43201
43396
|
/**
|
|
43202
43397
|
* Integrations service.
|
|
43203
43398
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43204
|
-
* @version
|
|
43399
|
+
* @version 250.0.0
|
|
43205
43400
|
*/
|
|
43206
43401
|
|
|
43207
43402
|
/**
|
|
@@ -46173,7 +46368,7 @@ class IntentsApi {
|
|
|
46173
46368
|
/**
|
|
46174
46369
|
* Intents service.
|
|
46175
46370
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46176
|
-
* @version
|
|
46371
|
+
* @version 250.0.0
|
|
46177
46372
|
*/
|
|
46178
46373
|
|
|
46179
46374
|
/**
|
|
@@ -46705,7 +46900,7 @@ class JourneyApi {
|
|
|
46705
46900
|
/**
|
|
46706
46901
|
* Journey service.
|
|
46707
46902
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
46708
|
-
* @version
|
|
46903
|
+
* @version 250.0.0
|
|
46709
46904
|
*/
|
|
46710
46905
|
|
|
46711
46906
|
/**
|
|
@@ -46812,6 +47007,66 @@ class JourneyApi {
|
|
|
46812
47007
|
);
|
|
46813
47008
|
}
|
|
46814
47009
|
|
|
47010
|
+
/**
|
|
47011
|
+
* Delete an external events configuration.
|
|
47012
|
+
*
|
|
47013
|
+
* @param {String} configId The ID of the external event configuration.
|
|
47014
|
+
* @param {Object} opts Optional parameters
|
|
47015
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47016
|
+
*/
|
|
47017
|
+
deleteJourneyExternaleventsConfiguration(configId, opts) {
|
|
47018
|
+
opts = opts || {};
|
|
47019
|
+
|
|
47020
|
+
// verify the required parameter 'configId' is set
|
|
47021
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
47022
|
+
throw 'Missing the required parameter "configId" when calling deleteJourneyExternaleventsConfiguration';
|
|
47023
|
+
}
|
|
47024
|
+
|
|
47025
|
+
return this.apiClient.callApi(
|
|
47026
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
47027
|
+
'DELETE',
|
|
47028
|
+
{ 'configId': configId },
|
|
47029
|
+
{ },
|
|
47030
|
+
{ },
|
|
47031
|
+
{ },
|
|
47032
|
+
null,
|
|
47033
|
+
['PureCloud OAuth'],
|
|
47034
|
+
['application/json'],
|
|
47035
|
+
['application/json'],
|
|
47036
|
+
opts['customHeaders']
|
|
47037
|
+
);
|
|
47038
|
+
}
|
|
47039
|
+
|
|
47040
|
+
/**
|
|
47041
|
+
* Delete a schema
|
|
47042
|
+
*
|
|
47043
|
+
* @param {String} schemaId Schema ID
|
|
47044
|
+
* @param {Object} opts Optional parameters
|
|
47045
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47046
|
+
*/
|
|
47047
|
+
deleteJourneyExternaleventsSchema(schemaId, opts) {
|
|
47048
|
+
opts = opts || {};
|
|
47049
|
+
|
|
47050
|
+
// verify the required parameter 'schemaId' is set
|
|
47051
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
47052
|
+
throw 'Missing the required parameter "schemaId" when calling deleteJourneyExternaleventsSchema';
|
|
47053
|
+
}
|
|
47054
|
+
|
|
47055
|
+
return this.apiClient.callApi(
|
|
47056
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
47057
|
+
'DELETE',
|
|
47058
|
+
{ 'schemaId': schemaId },
|
|
47059
|
+
{ },
|
|
47060
|
+
{ },
|
|
47061
|
+
{ },
|
|
47062
|
+
null,
|
|
47063
|
+
['PureCloud OAuth'],
|
|
47064
|
+
['application/json'],
|
|
47065
|
+
['application/json'],
|
|
47066
|
+
opts['customHeaders']
|
|
47067
|
+
);
|
|
47068
|
+
}
|
|
47069
|
+
|
|
46815
47070
|
/**
|
|
46816
47071
|
* Delete an outcome.
|
|
46817
47072
|
*
|
|
@@ -47372,6 +47627,263 @@ class JourneyApi {
|
|
|
47372
47627
|
);
|
|
47373
47628
|
}
|
|
47374
47629
|
|
|
47630
|
+
/**
|
|
47631
|
+
* Get an external events configuration
|
|
47632
|
+
*
|
|
47633
|
+
* @param {String} configId The ID of the external event configuration.
|
|
47634
|
+
* @param {Object} opts Optional parameters
|
|
47635
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47636
|
+
*/
|
|
47637
|
+
getJourneyExternaleventsConfiguration(configId, opts) {
|
|
47638
|
+
opts = opts || {};
|
|
47639
|
+
|
|
47640
|
+
// verify the required parameter 'configId' is set
|
|
47641
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
47642
|
+
throw 'Missing the required parameter "configId" when calling getJourneyExternaleventsConfiguration';
|
|
47643
|
+
}
|
|
47644
|
+
|
|
47645
|
+
return this.apiClient.callApi(
|
|
47646
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
47647
|
+
'GET',
|
|
47648
|
+
{ 'configId': configId },
|
|
47649
|
+
{ },
|
|
47650
|
+
{ },
|
|
47651
|
+
{ },
|
|
47652
|
+
null,
|
|
47653
|
+
['PureCloud OAuth'],
|
|
47654
|
+
['application/json'],
|
|
47655
|
+
['application/json'],
|
|
47656
|
+
opts['customHeaders']
|
|
47657
|
+
);
|
|
47658
|
+
}
|
|
47659
|
+
|
|
47660
|
+
/**
|
|
47661
|
+
* Get all external event configurations.
|
|
47662
|
+
*
|
|
47663
|
+
* @param {Object} opts Optional parameters
|
|
47664
|
+
* @param {Number} opts.pageSize Page size (default to 20)
|
|
47665
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47666
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47667
|
+
*/
|
|
47668
|
+
getJourneyExternaleventsConfigurations(opts) {
|
|
47669
|
+
opts = opts || {};
|
|
47670
|
+
|
|
47671
|
+
|
|
47672
|
+
return this.apiClient.callApi(
|
|
47673
|
+
'/api/v2/journey/externalevents/configurations',
|
|
47674
|
+
'GET',
|
|
47675
|
+
{ },
|
|
47676
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
47677
|
+
{ },
|
|
47678
|
+
{ },
|
|
47679
|
+
null,
|
|
47680
|
+
['PureCloud OAuth'],
|
|
47681
|
+
['application/json'],
|
|
47682
|
+
['application/json'],
|
|
47683
|
+
opts['customHeaders']
|
|
47684
|
+
);
|
|
47685
|
+
}
|
|
47686
|
+
|
|
47687
|
+
/**
|
|
47688
|
+
* Get a schema
|
|
47689
|
+
*
|
|
47690
|
+
* @param {String} schemaId Schema ID
|
|
47691
|
+
* @param {Object} opts Optional parameters
|
|
47692
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47693
|
+
*/
|
|
47694
|
+
getJourneyExternaleventsSchema(schemaId, opts) {
|
|
47695
|
+
opts = opts || {};
|
|
47696
|
+
|
|
47697
|
+
// verify the required parameter 'schemaId' is set
|
|
47698
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
47699
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchema';
|
|
47700
|
+
}
|
|
47701
|
+
|
|
47702
|
+
return this.apiClient.callApi(
|
|
47703
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
47704
|
+
'GET',
|
|
47705
|
+
{ 'schemaId': schemaId },
|
|
47706
|
+
{ },
|
|
47707
|
+
{ },
|
|
47708
|
+
{ },
|
|
47709
|
+
null,
|
|
47710
|
+
['PureCloud OAuth'],
|
|
47711
|
+
['application/json'],
|
|
47712
|
+
['application/json'],
|
|
47713
|
+
opts['customHeaders']
|
|
47714
|
+
);
|
|
47715
|
+
}
|
|
47716
|
+
|
|
47717
|
+
/**
|
|
47718
|
+
* Get a specific version of a schema
|
|
47719
|
+
*
|
|
47720
|
+
* @param {String} schemaId Schema ID
|
|
47721
|
+
* @param {String} versionId Schema version
|
|
47722
|
+
* @param {Object} opts Optional parameters
|
|
47723
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47724
|
+
*/
|
|
47725
|
+
getJourneyExternaleventsSchemaVersion(schemaId, versionId, opts) {
|
|
47726
|
+
opts = opts || {};
|
|
47727
|
+
|
|
47728
|
+
// verify the required parameter 'schemaId' is set
|
|
47729
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
47730
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchemaVersion';
|
|
47731
|
+
}
|
|
47732
|
+
// verify the required parameter 'versionId' is set
|
|
47733
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
47734
|
+
throw 'Missing the required parameter "versionId" when calling getJourneyExternaleventsSchemaVersion';
|
|
47735
|
+
}
|
|
47736
|
+
|
|
47737
|
+
return this.apiClient.callApi(
|
|
47738
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}/versions/{versionId}',
|
|
47739
|
+
'GET',
|
|
47740
|
+
{ 'schemaId': schemaId,'versionId': versionId },
|
|
47741
|
+
{ },
|
|
47742
|
+
{ },
|
|
47743
|
+
{ },
|
|
47744
|
+
null,
|
|
47745
|
+
['PureCloud OAuth'],
|
|
47746
|
+
['application/json'],
|
|
47747
|
+
['application/json'],
|
|
47748
|
+
opts['customHeaders']
|
|
47749
|
+
);
|
|
47750
|
+
}
|
|
47751
|
+
|
|
47752
|
+
/**
|
|
47753
|
+
* Get all versions of a External Events schema
|
|
47754
|
+
*
|
|
47755
|
+
* @param {String} schemaId Schema ID
|
|
47756
|
+
* @param {Object} opts Optional parameters
|
|
47757
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47758
|
+
*/
|
|
47759
|
+
getJourneyExternaleventsSchemaVersions(schemaId, opts) {
|
|
47760
|
+
opts = opts || {};
|
|
47761
|
+
|
|
47762
|
+
// verify the required parameter 'schemaId' is set
|
|
47763
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
47764
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchemaVersions';
|
|
47765
|
+
}
|
|
47766
|
+
|
|
47767
|
+
return this.apiClient.callApi(
|
|
47768
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}/versions',
|
|
47769
|
+
'GET',
|
|
47770
|
+
{ 'schemaId': schemaId },
|
|
47771
|
+
{ },
|
|
47772
|
+
{ },
|
|
47773
|
+
{ },
|
|
47774
|
+
null,
|
|
47775
|
+
['PureCloud OAuth'],
|
|
47776
|
+
['application/json'],
|
|
47777
|
+
['application/json'],
|
|
47778
|
+
opts['customHeaders']
|
|
47779
|
+
);
|
|
47780
|
+
}
|
|
47781
|
+
|
|
47782
|
+
/**
|
|
47783
|
+
* Get a list of schemas.
|
|
47784
|
+
*
|
|
47785
|
+
* @param {Object} opts Optional parameters
|
|
47786
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47787
|
+
*/
|
|
47788
|
+
getJourneyExternaleventsSchemas(opts) {
|
|
47789
|
+
opts = opts || {};
|
|
47790
|
+
|
|
47791
|
+
|
|
47792
|
+
return this.apiClient.callApi(
|
|
47793
|
+
'/api/v2/journey/externalevents/schemas',
|
|
47794
|
+
'GET',
|
|
47795
|
+
{ },
|
|
47796
|
+
{ },
|
|
47797
|
+
{ },
|
|
47798
|
+
{ },
|
|
47799
|
+
null,
|
|
47800
|
+
['PureCloud OAuth'],
|
|
47801
|
+
['application/json'],
|
|
47802
|
+
['application/json'],
|
|
47803
|
+
opts['customHeaders']
|
|
47804
|
+
);
|
|
47805
|
+
}
|
|
47806
|
+
|
|
47807
|
+
/**
|
|
47808
|
+
* Get a core type from which all schemas are built
|
|
47809
|
+
*
|
|
47810
|
+
* @param {String} coreTypeName Name of core type
|
|
47811
|
+
* @param {Object} opts Optional parameters
|
|
47812
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47813
|
+
*/
|
|
47814
|
+
getJourneyExternaleventsSchemasCoretype(coreTypeName, opts) {
|
|
47815
|
+
opts = opts || {};
|
|
47816
|
+
|
|
47817
|
+
// verify the required parameter 'coreTypeName' is set
|
|
47818
|
+
if (coreTypeName === undefined || coreTypeName === null || coreTypeName === '') {
|
|
47819
|
+
throw 'Missing the required parameter "coreTypeName" when calling getJourneyExternaleventsSchemasCoretype';
|
|
47820
|
+
}
|
|
47821
|
+
|
|
47822
|
+
return this.apiClient.callApi(
|
|
47823
|
+
'/api/v2/journey/externalevents/schemas/coretypes/{coreTypeName}',
|
|
47824
|
+
'GET',
|
|
47825
|
+
{ 'coreTypeName': coreTypeName },
|
|
47826
|
+
{ },
|
|
47827
|
+
{ },
|
|
47828
|
+
{ },
|
|
47829
|
+
null,
|
|
47830
|
+
['PureCloud OAuth'],
|
|
47831
|
+
['application/json'],
|
|
47832
|
+
['application/json'],
|
|
47833
|
+
opts['customHeaders']
|
|
47834
|
+
);
|
|
47835
|
+
}
|
|
47836
|
+
|
|
47837
|
+
/**
|
|
47838
|
+
* Get the list of core types enabled for a specific namespace.
|
|
47839
|
+
*
|
|
47840
|
+
* @param {Object} opts Optional parameters
|
|
47841
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47842
|
+
*/
|
|
47843
|
+
getJourneyExternaleventsSchemasCoretypes(opts) {
|
|
47844
|
+
opts = opts || {};
|
|
47845
|
+
|
|
47846
|
+
|
|
47847
|
+
return this.apiClient.callApi(
|
|
47848
|
+
'/api/v2/journey/externalevents/schemas/coretypes',
|
|
47849
|
+
'GET',
|
|
47850
|
+
{ },
|
|
47851
|
+
{ },
|
|
47852
|
+
{ },
|
|
47853
|
+
{ },
|
|
47854
|
+
null,
|
|
47855
|
+
['PureCloud OAuth'],
|
|
47856
|
+
['application/json'],
|
|
47857
|
+
['application/json'],
|
|
47858
|
+
opts['customHeaders']
|
|
47859
|
+
);
|
|
47860
|
+
}
|
|
47861
|
+
|
|
47862
|
+
/**
|
|
47863
|
+
* Get quantitative limits on schemas
|
|
47864
|
+
*
|
|
47865
|
+
* @param {Object} opts Optional parameters
|
|
47866
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47867
|
+
*/
|
|
47868
|
+
getJourneyExternaleventsSchemasLimits(opts) {
|
|
47869
|
+
opts = opts || {};
|
|
47870
|
+
|
|
47871
|
+
|
|
47872
|
+
return this.apiClient.callApi(
|
|
47873
|
+
'/api/v2/journey/externalevents/schemas/limits',
|
|
47874
|
+
'GET',
|
|
47875
|
+
{ },
|
|
47876
|
+
{ },
|
|
47877
|
+
{ },
|
|
47878
|
+
{ },
|
|
47879
|
+
null,
|
|
47880
|
+
['PureCloud OAuth'],
|
|
47881
|
+
['application/json'],
|
|
47882
|
+
['application/json'],
|
|
47883
|
+
opts['customHeaders']
|
|
47884
|
+
);
|
|
47885
|
+
}
|
|
47886
|
+
|
|
47375
47887
|
/**
|
|
47376
47888
|
* Retrieve a single outcome.
|
|
47377
47889
|
*
|
|
@@ -48333,6 +48845,37 @@ class JourneyApi {
|
|
|
48333
48845
|
);
|
|
48334
48846
|
}
|
|
48335
48847
|
|
|
48848
|
+
/**
|
|
48849
|
+
* Update an external events configuration.
|
|
48850
|
+
*
|
|
48851
|
+
* @param {String} configId The ID of the external event configuration.
|
|
48852
|
+
* @param {Object} opts Optional parameters
|
|
48853
|
+
* @param {Object} opts.body
|
|
48854
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48855
|
+
*/
|
|
48856
|
+
patchJourneyExternaleventsConfiguration(configId, opts) {
|
|
48857
|
+
opts = opts || {};
|
|
48858
|
+
|
|
48859
|
+
// verify the required parameter 'configId' is set
|
|
48860
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
48861
|
+
throw 'Missing the required parameter "configId" when calling patchJourneyExternaleventsConfiguration';
|
|
48862
|
+
}
|
|
48863
|
+
|
|
48864
|
+
return this.apiClient.callApi(
|
|
48865
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
48866
|
+
'PATCH',
|
|
48867
|
+
{ 'configId': configId },
|
|
48868
|
+
{ },
|
|
48869
|
+
{ },
|
|
48870
|
+
{ },
|
|
48871
|
+
opts['body'],
|
|
48872
|
+
['PureCloud OAuth'],
|
|
48873
|
+
['application/json'],
|
|
48874
|
+
['application/json'],
|
|
48875
|
+
opts['customHeaders']
|
|
48876
|
+
);
|
|
48877
|
+
}
|
|
48878
|
+
|
|
48336
48879
|
/**
|
|
48337
48880
|
* Update an outcome.
|
|
48338
48881
|
*
|
|
@@ -48711,6 +49254,93 @@ class JourneyApi {
|
|
|
48711
49254
|
);
|
|
48712
49255
|
}
|
|
48713
49256
|
|
|
49257
|
+
/**
|
|
49258
|
+
* Create external events
|
|
49259
|
+
*
|
|
49260
|
+
* @param {String} configurationId The ID of the external event configuration.
|
|
49261
|
+
* @param {Object} opts Optional parameters
|
|
49262
|
+
* @param {Object} opts.body
|
|
49263
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49264
|
+
*/
|
|
49265
|
+
postJourneyExternaleventsConfigurationEvents(configurationId, opts) {
|
|
49266
|
+
opts = opts || {};
|
|
49267
|
+
|
|
49268
|
+
// verify the required parameter 'configurationId' is set
|
|
49269
|
+
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
49270
|
+
throw 'Missing the required parameter "configurationId" when calling postJourneyExternaleventsConfigurationEvents';
|
|
49271
|
+
}
|
|
49272
|
+
|
|
49273
|
+
return this.apiClient.callApi(
|
|
49274
|
+
'/api/v2/journey/externalevents/configurations/{configurationId}/events',
|
|
49275
|
+
'POST',
|
|
49276
|
+
{ 'configurationId': configurationId },
|
|
49277
|
+
{ },
|
|
49278
|
+
{ },
|
|
49279
|
+
{ },
|
|
49280
|
+
opts['body'],
|
|
49281
|
+
['PureCloud OAuth'],
|
|
49282
|
+
['application/json'],
|
|
49283
|
+
['application/json'],
|
|
49284
|
+
opts['customHeaders']
|
|
49285
|
+
);
|
|
49286
|
+
}
|
|
49287
|
+
|
|
49288
|
+
/**
|
|
49289
|
+
* Create an external events configuration.
|
|
49290
|
+
*
|
|
49291
|
+
* @param {Object} opts Optional parameters
|
|
49292
|
+
* @param {Object} opts.body
|
|
49293
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49294
|
+
*/
|
|
49295
|
+
postJourneyExternaleventsConfigurations(opts) {
|
|
49296
|
+
opts = opts || {};
|
|
49297
|
+
|
|
49298
|
+
|
|
49299
|
+
return this.apiClient.callApi(
|
|
49300
|
+
'/api/v2/journey/externalevents/configurations',
|
|
49301
|
+
'POST',
|
|
49302
|
+
{ },
|
|
49303
|
+
{ },
|
|
49304
|
+
{ },
|
|
49305
|
+
{ },
|
|
49306
|
+
opts['body'],
|
|
49307
|
+
['PureCloud OAuth'],
|
|
49308
|
+
['application/json'],
|
|
49309
|
+
['application/json'],
|
|
49310
|
+
opts['customHeaders']
|
|
49311
|
+
);
|
|
49312
|
+
}
|
|
49313
|
+
|
|
49314
|
+
/**
|
|
49315
|
+
* Create a schema
|
|
49316
|
+
*
|
|
49317
|
+
* @param {Object} body Schema create request body
|
|
49318
|
+
* @param {Object} opts Optional parameters
|
|
49319
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49320
|
+
*/
|
|
49321
|
+
postJourneyExternaleventsSchemas(body, opts) {
|
|
49322
|
+
opts = opts || {};
|
|
49323
|
+
|
|
49324
|
+
// verify the required parameter 'body' is set
|
|
49325
|
+
if (body === undefined || body === null) {
|
|
49326
|
+
throw 'Missing the required parameter "body" when calling postJourneyExternaleventsSchemas';
|
|
49327
|
+
}
|
|
49328
|
+
|
|
49329
|
+
return this.apiClient.callApi(
|
|
49330
|
+
'/api/v2/journey/externalevents/schemas',
|
|
49331
|
+
'POST',
|
|
49332
|
+
{ },
|
|
49333
|
+
{ },
|
|
49334
|
+
{ },
|
|
49335
|
+
{ },
|
|
49336
|
+
body,
|
|
49337
|
+
['PureCloud OAuth'],
|
|
49338
|
+
['application/json'],
|
|
49339
|
+
['application/json'],
|
|
49340
|
+
opts['customHeaders']
|
|
49341
|
+
);
|
|
49342
|
+
}
|
|
49343
|
+
|
|
48714
49344
|
/**
|
|
48715
49345
|
* Query for flow paths.
|
|
48716
49346
|
*
|
|
@@ -49003,6 +49633,41 @@ class JourneyApi {
|
|
|
49003
49633
|
);
|
|
49004
49634
|
}
|
|
49005
49635
|
|
|
49636
|
+
/**
|
|
49637
|
+
* Update a schema
|
|
49638
|
+
*
|
|
49639
|
+
* @param {String} schemaId Schema ID
|
|
49640
|
+
* @param {Object} body Schema update request body
|
|
49641
|
+
* @param {Object} opts Optional parameters
|
|
49642
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49643
|
+
*/
|
|
49644
|
+
putJourneyExternaleventsSchema(schemaId, body, opts) {
|
|
49645
|
+
opts = opts || {};
|
|
49646
|
+
|
|
49647
|
+
// verify the required parameter 'schemaId' is set
|
|
49648
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
49649
|
+
throw 'Missing the required parameter "schemaId" when calling putJourneyExternaleventsSchema';
|
|
49650
|
+
}
|
|
49651
|
+
// verify the required parameter 'body' is set
|
|
49652
|
+
if (body === undefined || body === null) {
|
|
49653
|
+
throw 'Missing the required parameter "body" when calling putJourneyExternaleventsSchema';
|
|
49654
|
+
}
|
|
49655
|
+
|
|
49656
|
+
return this.apiClient.callApi(
|
|
49657
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
49658
|
+
'PUT',
|
|
49659
|
+
{ 'schemaId': schemaId },
|
|
49660
|
+
{ },
|
|
49661
|
+
{ },
|
|
49662
|
+
{ },
|
|
49663
|
+
body,
|
|
49664
|
+
['PureCloud OAuth'],
|
|
49665
|
+
['application/json'],
|
|
49666
|
+
['application/json'],
|
|
49667
|
+
opts['customHeaders']
|
|
49668
|
+
);
|
|
49669
|
+
}
|
|
49670
|
+
|
|
49006
49671
|
/**
|
|
49007
49672
|
* Update the Schedule for a JourneyView
|
|
49008
49673
|
*
|
|
@@ -49084,7 +49749,7 @@ class KnowledgeApi {
|
|
|
49084
49749
|
/**
|
|
49085
49750
|
* Knowledge service.
|
|
49086
49751
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
49087
|
-
* @version
|
|
49752
|
+
* @version 250.0.0
|
|
49088
49753
|
*/
|
|
49089
49754
|
|
|
49090
49755
|
/**
|
|
@@ -53292,7 +53957,7 @@ class LanguageUnderstandingApi {
|
|
|
53292
53957
|
/**
|
|
53293
53958
|
* LanguageUnderstanding service.
|
|
53294
53959
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
53295
|
-
* @version
|
|
53960
|
+
* @version 250.0.0
|
|
53296
53961
|
*/
|
|
53297
53962
|
|
|
53298
53963
|
/**
|
|
@@ -54666,7 +55331,7 @@ class LanguagesApi {
|
|
|
54666
55331
|
/**
|
|
54667
55332
|
* Languages service.
|
|
54668
55333
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
54669
|
-
* @version
|
|
55334
|
+
* @version 250.0.0
|
|
54670
55335
|
*/
|
|
54671
55336
|
|
|
54672
55337
|
/**
|
|
@@ -54925,7 +55590,7 @@ class LearningApi {
|
|
|
54925
55590
|
/**
|
|
54926
55591
|
* Learning service.
|
|
54927
55592
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
54928
|
-
* @version
|
|
55593
|
+
* @version 250.0.0
|
|
54929
55594
|
*/
|
|
54930
55595
|
|
|
54931
55596
|
/**
|
|
@@ -56173,7 +56838,7 @@ class LicenseApi {
|
|
|
56173
56838
|
/**
|
|
56174
56839
|
* License service.
|
|
56175
56840
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
56176
|
-
* @version
|
|
56841
|
+
* @version 250.0.0
|
|
56177
56842
|
*/
|
|
56178
56843
|
|
|
56179
56844
|
/**
|
|
@@ -56471,7 +57136,7 @@ class LocationsApi {
|
|
|
56471
57136
|
/**
|
|
56472
57137
|
* Locations service.
|
|
56473
57138
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
56474
|
-
* @version
|
|
57139
|
+
* @version 250.0.0
|
|
56475
57140
|
*/
|
|
56476
57141
|
|
|
56477
57142
|
/**
|
|
@@ -56738,7 +57403,7 @@ class LogCaptureApi {
|
|
|
56738
57403
|
/**
|
|
56739
57404
|
* LogCapture service.
|
|
56740
57405
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
56741
|
-
* @version
|
|
57406
|
+
* @version 250.0.0
|
|
56742
57407
|
*/
|
|
56743
57408
|
|
|
56744
57409
|
/**
|
|
@@ -56960,7 +57625,7 @@ class MessagingApi {
|
|
|
56960
57625
|
/**
|
|
56961
57626
|
* Messaging service.
|
|
56962
57627
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
56963
|
-
* @version
|
|
57628
|
+
* @version 250.0.0
|
|
56964
57629
|
*/
|
|
56965
57630
|
|
|
56966
57631
|
/**
|
|
@@ -57378,7 +58043,7 @@ class MobileDevicesApi {
|
|
|
57378
58043
|
/**
|
|
57379
58044
|
* MobileDevices service.
|
|
57380
58045
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
57381
|
-
* @version
|
|
58046
|
+
* @version 250.0.0
|
|
57382
58047
|
*/
|
|
57383
58048
|
|
|
57384
58049
|
/**
|
|
@@ -57548,7 +58213,7 @@ class NotificationsApi {
|
|
|
57548
58213
|
/**
|
|
57549
58214
|
* Notifications service.
|
|
57550
58215
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
57551
|
-
* @version
|
|
58216
|
+
* @version 250.0.0
|
|
57552
58217
|
*/
|
|
57553
58218
|
|
|
57554
58219
|
/**
|
|
@@ -57809,7 +58474,7 @@ class OAuthApi {
|
|
|
57809
58474
|
/**
|
|
57810
58475
|
* OAuth service.
|
|
57811
58476
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
57812
|
-
* @version
|
|
58477
|
+
* @version 250.0.0
|
|
57813
58478
|
*/
|
|
57814
58479
|
|
|
57815
58480
|
/**
|
|
@@ -58225,7 +58890,7 @@ class ObjectsApi {
|
|
|
58225
58890
|
/**
|
|
58226
58891
|
* Objects service.
|
|
58227
58892
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
58228
|
-
* @version
|
|
58893
|
+
* @version 250.0.0
|
|
58229
58894
|
*/
|
|
58230
58895
|
|
|
58231
58896
|
/**
|
|
@@ -58589,7 +59254,7 @@ class OperationalEventsApi {
|
|
|
58589
59254
|
/**
|
|
58590
59255
|
* OperationalEvents service.
|
|
58591
59256
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
58592
|
-
* @version
|
|
59257
|
+
* @version 250.0.0
|
|
58593
59258
|
*/
|
|
58594
59259
|
|
|
58595
59260
|
/**
|
|
@@ -58720,7 +59385,7 @@ class OrganizationApi {
|
|
|
58720
59385
|
/**
|
|
58721
59386
|
* Organization service.
|
|
58722
59387
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
58723
|
-
* @version
|
|
59388
|
+
* @version 250.0.0
|
|
58724
59389
|
*/
|
|
58725
59390
|
|
|
58726
59391
|
/**
|
|
@@ -59281,7 +59946,7 @@ class OrganizationAuthorizationApi {
|
|
|
59281
59946
|
/**
|
|
59282
59947
|
* OrganizationAuthorization service.
|
|
59283
59948
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
59284
|
-
* @version
|
|
59949
|
+
* @version 250.0.0
|
|
59285
59950
|
*/
|
|
59286
59951
|
|
|
59287
59952
|
/**
|
|
@@ -60885,7 +61550,7 @@ class OutboundApi {
|
|
|
60885
61550
|
/**
|
|
60886
61551
|
* Outbound service.
|
|
60887
61552
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
60888
|
-
* @version
|
|
61553
|
+
* @version 250.0.0
|
|
60889
61554
|
*/
|
|
60890
61555
|
|
|
60891
61556
|
/**
|
|
@@ -66472,7 +67137,7 @@ class PresenceApi {
|
|
|
66472
67137
|
/**
|
|
66473
67138
|
* Presence service.
|
|
66474
67139
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
66475
|
-
* @version
|
|
67140
|
+
* @version 250.0.0
|
|
66476
67141
|
*/
|
|
66477
67142
|
|
|
66478
67143
|
/**
|
|
@@ -67330,7 +67995,7 @@ class ProcessAutomationApi {
|
|
|
67330
67995
|
/**
|
|
67331
67996
|
* ProcessAutomation service.
|
|
67332
67997
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
67333
|
-
* @version
|
|
67998
|
+
* @version 250.0.0
|
|
67334
67999
|
*/
|
|
67335
68000
|
|
|
67336
68001
|
/**
|
|
@@ -67597,7 +68262,7 @@ class QualityApi {
|
|
|
67597
68262
|
/**
|
|
67598
68263
|
* Quality service.
|
|
67599
68264
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
67600
|
-
* @version
|
|
68265
|
+
* @version 250.0.0
|
|
67601
68266
|
*/
|
|
67602
68267
|
|
|
67603
68268
|
/**
|
|
@@ -69955,7 +70620,7 @@ class RecordingApi {
|
|
|
69955
70620
|
/**
|
|
69956
70621
|
* Recording service.
|
|
69957
70622
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
69958
|
-
* @version
|
|
70623
|
+
* @version 250.0.0
|
|
69959
70624
|
*/
|
|
69960
70625
|
|
|
69961
70626
|
/**
|
|
@@ -70192,7 +70857,7 @@ class RecordingApi {
|
|
|
70192
70857
|
|
|
70193
70858
|
/**
|
|
70194
70859
|
* Gets a specific recording.
|
|
70195
|
-
*
|
|
70860
|
+
* Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.
|
|
70196
70861
|
* @param {String} conversationId Conversation ID
|
|
70197
70862
|
* @param {String} recordingId Recording ID
|
|
70198
70863
|
* @param {Object} opts Optional parameters
|
|
@@ -70339,7 +71004,7 @@ class RecordingApi {
|
|
|
70339
71004
|
}
|
|
70340
71005
|
|
|
70341
71006
|
/**
|
|
70342
|
-
* Get metadata for a specific recording. Does not return playable media.
|
|
71007
|
+
* Get metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.
|
|
70343
71008
|
*
|
|
70344
71009
|
* @param {String} conversationId Conversation ID
|
|
70345
71010
|
* @param {String} recordingId Recording ID
|
|
@@ -70375,7 +71040,7 @@ class RecordingApi {
|
|
|
70375
71040
|
|
|
70376
71041
|
/**
|
|
70377
71042
|
* Get all of a Conversation's Recordings.
|
|
70378
|
-
*
|
|
71043
|
+
* Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.
|
|
70379
71044
|
* @param {String} conversationId Conversation ID
|
|
70380
71045
|
* @param {Object} opts Optional parameters
|
|
70381
71046
|
* @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
@@ -71060,7 +71725,7 @@ class RecordingApi {
|
|
|
71060
71725
|
|
|
71061
71726
|
/**
|
|
71062
71727
|
* Create annotation
|
|
71063
|
-
*
|
|
71728
|
+
* If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.
|
|
71064
71729
|
* @param {String} conversationId Conversation ID
|
|
71065
71730
|
* @param {String} recordingId Recording ID
|
|
71066
71731
|
* @param {Object} body annotation
|
|
@@ -71099,7 +71764,7 @@ class RecordingApi {
|
|
|
71099
71764
|
}
|
|
71100
71765
|
|
|
71101
71766
|
/**
|
|
71102
|
-
* Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.
|
|
71767
|
+
* Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download.
|
|
71103
71768
|
*
|
|
71104
71769
|
* @param {Object} body Job submission criteria
|
|
71105
71770
|
* @param {Object} opts Optional parameters
|
|
@@ -71455,7 +72120,7 @@ class RecordingApi {
|
|
|
71455
72120
|
|
|
71456
72121
|
/**
|
|
71457
72122
|
* Updates the retention records on a recording.
|
|
71458
|
-
* Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set.
|
|
72123
|
+
* Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Required permissions depend on the operation: view (recording, screenRecording, or snippetRecording) is always required; editRetention is required when updating retention dates except for restoration; restore is required when restoring an archived recording.
|
|
71459
72124
|
* @param {String} conversationId Conversation ID
|
|
71460
72125
|
* @param {String} recordingId Recording ID
|
|
71461
72126
|
* @param {Object} body recording
|
|
@@ -71496,7 +72161,7 @@ class RecordingApi {
|
|
|
71496
72161
|
|
|
71497
72162
|
/**
|
|
71498
72163
|
* Update annotation
|
|
71499
|
-
*
|
|
72164
|
+
* If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.
|
|
71500
72165
|
* @param {String} conversationId Conversation ID
|
|
71501
72166
|
* @param {String} recordingId Recording ID
|
|
71502
72167
|
* @param {String} annotationId Annotation ID
|
|
@@ -71803,7 +72468,7 @@ class ResponseManagementApi {
|
|
|
71803
72468
|
/**
|
|
71804
72469
|
* ResponseManagement service.
|
|
71805
72470
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
71806
|
-
* @version
|
|
72471
|
+
* @version 250.0.0
|
|
71807
72472
|
*/
|
|
71808
72473
|
|
|
71809
72474
|
/**
|
|
@@ -72448,7 +73113,7 @@ class RoutingApi {
|
|
|
72448
73113
|
/**
|
|
72449
73114
|
* Routing service.
|
|
72450
73115
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
72451
|
-
* @version
|
|
73116
|
+
* @version 250.0.0
|
|
72452
73117
|
*/
|
|
72453
73118
|
|
|
72454
73119
|
/**
|
|
@@ -77835,7 +78500,7 @@ class SCIMApi {
|
|
|
77835
78500
|
/**
|
|
77836
78501
|
* SCIM service.
|
|
77837
78502
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
77838
|
-
* @version
|
|
78503
|
+
* @version 250.0.0
|
|
77839
78504
|
*/
|
|
77840
78505
|
|
|
77841
78506
|
/**
|
|
@@ -78796,7 +79461,7 @@ class ScriptsApi {
|
|
|
78796
79461
|
/**
|
|
78797
79462
|
* Scripts service.
|
|
78798
79463
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
78799
|
-
* @version
|
|
79464
|
+
* @version 250.0.0
|
|
78800
79465
|
*/
|
|
78801
79466
|
|
|
78802
79467
|
/**
|
|
@@ -79305,7 +79970,7 @@ class SearchApi {
|
|
|
79305
79970
|
/**
|
|
79306
79971
|
* Search service.
|
|
79307
79972
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
79308
|
-
* @version
|
|
79973
|
+
* @version 250.0.0
|
|
79309
79974
|
*/
|
|
79310
79975
|
|
|
79311
79976
|
/**
|
|
@@ -80121,7 +80786,7 @@ class SettingsApi {
|
|
|
80121
80786
|
/**
|
|
80122
80787
|
* Settings service.
|
|
80123
80788
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
80124
|
-
* @version
|
|
80789
|
+
* @version 250.0.0
|
|
80125
80790
|
*/
|
|
80126
80791
|
|
|
80127
80792
|
/**
|
|
@@ -80530,7 +81195,7 @@ class SocialMediaApi {
|
|
|
80530
81195
|
/**
|
|
80531
81196
|
* SocialMedia service.
|
|
80532
81197
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
80533
|
-
* @version
|
|
81198
|
+
* @version 250.0.0
|
|
80534
81199
|
*/
|
|
80535
81200
|
|
|
80536
81201
|
/**
|
|
@@ -82515,7 +83180,7 @@ class SpeechTextAnalyticsApi {
|
|
|
82515
83180
|
/**
|
|
82516
83181
|
* SpeechTextAnalytics service.
|
|
82517
83182
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
82518
|
-
* @version
|
|
83183
|
+
* @version 250.0.0
|
|
82519
83184
|
*/
|
|
82520
83185
|
|
|
82521
83186
|
/**
|
|
@@ -84466,7 +85131,7 @@ class StationsApi {
|
|
|
84466
85131
|
/**
|
|
84467
85132
|
* Stations service.
|
|
84468
85133
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
84469
|
-
* @version
|
|
85134
|
+
* @version 250.0.0
|
|
84470
85135
|
*/
|
|
84471
85136
|
|
|
84472
85137
|
/**
|
|
@@ -84580,7 +85245,7 @@ class SuggestApi {
|
|
|
84580
85245
|
/**
|
|
84581
85246
|
* Suggest service.
|
|
84582
85247
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
84583
|
-
* @version
|
|
85248
|
+
* @version 250.0.0
|
|
84584
85249
|
*/
|
|
84585
85250
|
|
|
84586
85251
|
/**
|
|
@@ -84727,7 +85392,7 @@ class TaskManagementApi {
|
|
|
84727
85392
|
/**
|
|
84728
85393
|
* TaskManagement service.
|
|
84729
85394
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
84730
|
-
* @version
|
|
85395
|
+
* @version 250.0.0
|
|
84731
85396
|
*/
|
|
84732
85397
|
|
|
84733
85398
|
/**
|
|
@@ -87223,7 +87888,7 @@ class TeamsApi {
|
|
|
87223
87888
|
/**
|
|
87224
87889
|
* Teams service.
|
|
87225
87890
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
87226
|
-
* @version
|
|
87891
|
+
* @version 250.0.0
|
|
87227
87892
|
*/
|
|
87228
87893
|
|
|
87229
87894
|
/**
|
|
@@ -87566,7 +88231,7 @@ class TelephonyApi {
|
|
|
87566
88231
|
/**
|
|
87567
88232
|
* Telephony service.
|
|
87568
88233
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
87569
|
-
* @version
|
|
88234
|
+
* @version 250.0.0
|
|
87570
88235
|
*/
|
|
87571
88236
|
|
|
87572
88237
|
/**
|
|
@@ -87973,7 +88638,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
87973
88638
|
/**
|
|
87974
88639
|
* TelephonyProvidersEdge service.
|
|
87975
88640
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
87976
|
-
* @version
|
|
88641
|
+
* @version 250.0.0
|
|
87977
88642
|
*/
|
|
87978
88643
|
|
|
87979
88644
|
/**
|
|
@@ -91997,7 +92662,7 @@ class TextbotsApi {
|
|
|
91997
92662
|
/**
|
|
91998
92663
|
* Textbots service.
|
|
91999
92664
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
92000
|
-
* @version
|
|
92665
|
+
* @version 250.0.0
|
|
92001
92666
|
*/
|
|
92002
92667
|
|
|
92003
92668
|
/**
|
|
@@ -92143,7 +92808,7 @@ class TokensApi {
|
|
|
92143
92808
|
/**
|
|
92144
92809
|
* Tokens service.
|
|
92145
92810
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
92146
|
-
* @version
|
|
92811
|
+
* @version 250.0.0
|
|
92147
92812
|
*/
|
|
92148
92813
|
|
|
92149
92814
|
/**
|
|
@@ -92321,7 +92986,7 @@ class UploadsApi {
|
|
|
92321
92986
|
/**
|
|
92322
92987
|
* Uploads service.
|
|
92323
92988
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
92324
|
-
* @version
|
|
92989
|
+
* @version 250.0.0
|
|
92325
92990
|
*/
|
|
92326
92991
|
|
|
92327
92992
|
/**
|
|
@@ -92692,7 +93357,7 @@ class UsageApi {
|
|
|
92692
93357
|
/**
|
|
92693
93358
|
* Usage service.
|
|
92694
93359
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
92695
|
-
* @version
|
|
93360
|
+
* @version 250.0.0
|
|
92696
93361
|
*/
|
|
92697
93362
|
|
|
92698
93363
|
/**
|
|
@@ -93070,7 +93735,7 @@ class UserRecordingsApi {
|
|
|
93070
93735
|
/**
|
|
93071
93736
|
* UserRecordings service.
|
|
93072
93737
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
93073
|
-
* @version
|
|
93738
|
+
* @version 250.0.0
|
|
93074
93739
|
*/
|
|
93075
93740
|
|
|
93076
93741
|
/**
|
|
@@ -93272,7 +93937,7 @@ class UsersApi {
|
|
|
93272
93937
|
/**
|
|
93273
93938
|
* Users service.
|
|
93274
93939
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
93275
|
-
* @version
|
|
93940
|
+
* @version 250.0.0
|
|
93276
93941
|
*/
|
|
93277
93942
|
|
|
93278
93943
|
/**
|
|
@@ -93510,7 +94175,6 @@ class UsersApi {
|
|
|
93510
94175
|
* @param {String} schemaId schemaId
|
|
93511
94176
|
* @param {Object} opts Optional parameters
|
|
93512
94177
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
93513
|
-
* deleteUserCustomattribute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
93514
94178
|
*/
|
|
93515
94179
|
deleteUserCustomattribute(userId, schemaId, opts) {
|
|
93516
94180
|
opts = opts || {};
|
|
@@ -93750,7 +94414,6 @@ class UsersApi {
|
|
|
93750
94414
|
* @param {String} schemaId Schema ID
|
|
93751
94415
|
* @param {Object} opts Optional parameters
|
|
93752
94416
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
93753
|
-
* deleteUsersCustomattributesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
93754
94417
|
*/
|
|
93755
94418
|
deleteUsersCustomattributesSchema(schemaId, opts) {
|
|
93756
94419
|
opts = opts || {};
|
|
@@ -94240,6 +94903,7 @@ class UsersApi {
|
|
|
94240
94903
|
* @param {Object} opts Optional parameters
|
|
94241
94904
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
94242
94905
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
94906
|
+
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 100
|
|
94243
94907
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
94244
94908
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94245
94909
|
*/
|
|
@@ -94255,7 +94919,7 @@ class UsersApi {
|
|
|
94255
94919
|
'/api/v2/users/{userId}',
|
|
94256
94920
|
'GET',
|
|
94257
94921
|
{ 'userId': userId },
|
|
94258
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
94922
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi'),'state': opts['state'] },
|
|
94259
94923
|
{ },
|
|
94260
94924
|
{ },
|
|
94261
94925
|
null,
|
|
@@ -94334,7 +94998,6 @@ class UsersApi {
|
|
|
94334
94998
|
* @param {String} schemaId schemaId
|
|
94335
94999
|
* @param {Object} opts Optional parameters
|
|
94336
95000
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94337
|
-
* getUserCustomattribute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
94338
95001
|
*/
|
|
94339
95002
|
getUserCustomattribute(userId, schemaId, opts) {
|
|
94340
95003
|
opts = opts || {};
|
|
@@ -94370,7 +95033,6 @@ class UsersApi {
|
|
|
94370
95033
|
* @param {Array.<String>} schemaIds
|
|
94371
95034
|
* @param {Object} opts Optional parameters
|
|
94372
95035
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94373
|
-
* getUserCustomattributesBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
94374
95036
|
*/
|
|
94375
95037
|
getUserCustomattributesBulk(userId, schemaIds, opts) {
|
|
94376
95038
|
opts = opts || {};
|
|
@@ -95015,6 +95677,7 @@ class UsersApi {
|
|
|
95015
95677
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
95016
95678
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
95017
95679
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
95680
|
+
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 5
|
|
95018
95681
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
95019
95682
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95020
95683
|
*/
|
|
@@ -95026,7 +95689,7 @@ class UsersApi {
|
|
|
95026
95689
|
'/api/v2/users',
|
|
95027
95690
|
'GET',
|
|
95028
95691
|
{ },
|
|
95029
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'jabberId': this.apiClient.buildCollectionParam(opts['jabberId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
95692
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'jabberId': this.apiClient.buildCollectionParam(opts['jabberId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi'),'state': opts['state'] },
|
|
95030
95693
|
{ },
|
|
95031
95694
|
{ },
|
|
95032
95695
|
null,
|
|
@@ -95071,7 +95734,6 @@ class UsersApi {
|
|
|
95071
95734
|
* @param {String} schemaId Schema ID
|
|
95072
95735
|
* @param {Object} opts Optional parameters
|
|
95073
95736
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95074
|
-
* getUsersCustomattributesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95075
95737
|
*/
|
|
95076
95738
|
getUsersCustomattributesSchema(schemaId, opts) {
|
|
95077
95739
|
opts = opts || {};
|
|
@@ -95103,7 +95765,6 @@ class UsersApi {
|
|
|
95103
95765
|
* @param {String} versionId Schema version
|
|
95104
95766
|
* @param {Object} opts Optional parameters
|
|
95105
95767
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95106
|
-
* getUsersCustomattributesSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95107
95768
|
*/
|
|
95108
95769
|
getUsersCustomattributesSchemaVersion(schemaId, versionId, opts) {
|
|
95109
95770
|
opts = opts || {};
|
|
@@ -95138,7 +95799,6 @@ class UsersApi {
|
|
|
95138
95799
|
* @param {String} schemaId Schema ID
|
|
95139
95800
|
* @param {Object} opts Optional parameters
|
|
95140
95801
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95141
|
-
* getUsersCustomattributesSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95142
95802
|
*/
|
|
95143
95803
|
getUsersCustomattributesSchemaVersions(schemaId, opts) {
|
|
95144
95804
|
opts = opts || {};
|
|
@@ -95168,7 +95828,6 @@ class UsersApi {
|
|
|
95168
95828
|
*
|
|
95169
95829
|
* @param {Object} opts Optional parameters
|
|
95170
95830
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95171
|
-
* getUsersCustomattributesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95172
95831
|
*/
|
|
95173
95832
|
getUsersCustomattributesSchemas(opts) {
|
|
95174
95833
|
opts = opts || {};
|
|
@@ -95195,7 +95854,6 @@ class UsersApi {
|
|
|
95195
95854
|
* @param {String} coreTypeName Name of the core type
|
|
95196
95855
|
* @param {Object} opts Optional parameters
|
|
95197
95856
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95198
|
-
* getUsersCustomattributesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95199
95857
|
*/
|
|
95200
95858
|
getUsersCustomattributesSchemasCoretype(coreTypeName, opts) {
|
|
95201
95859
|
opts = opts || {};
|
|
@@ -95225,7 +95883,6 @@ class UsersApi {
|
|
|
95225
95883
|
*
|
|
95226
95884
|
* @param {Object} opts Optional parameters
|
|
95227
95885
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95228
|
-
* getUsersCustomattributesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95229
95886
|
*/
|
|
95230
95887
|
getUsersCustomattributesSchemasCoretypes(opts) {
|
|
95231
95888
|
opts = opts || {};
|
|
@@ -95251,7 +95908,6 @@ class UsersApi {
|
|
|
95251
95908
|
*
|
|
95252
95909
|
* @param {Object} opts Optional parameters
|
|
95253
95910
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95254
|
-
* getUsersCustomattributesSchemasLimits is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95255
95911
|
*/
|
|
95256
95912
|
getUsersCustomattributesSchemasLimits(opts) {
|
|
95257
95913
|
opts = opts || {};
|
|
@@ -95422,6 +96078,7 @@ class UsersApi {
|
|
|
95422
96078
|
* @param {Object} opts Optional parameters
|
|
95423
96079
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
95424
96080
|
* @param {Object} opts.integrationPresenceSource Get your presence for a given integration. This parameter will only be used when presence is provided as an expand.
|
|
96081
|
+
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 100
|
|
95425
96082
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95426
96083
|
*/
|
|
95427
96084
|
getUsersMe(opts) {
|
|
@@ -95432,7 +96089,7 @@ class UsersApi {
|
|
|
95432
96089
|
'/api/v2/users/me',
|
|
95433
96090
|
'GET',
|
|
95434
96091
|
{ },
|
|
95435
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'] },
|
|
96092
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi') },
|
|
95436
96093
|
{ },
|
|
95437
96094
|
{ },
|
|
95438
96095
|
null,
|
|
@@ -95452,6 +96109,7 @@ class UsersApi {
|
|
|
95452
96109
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
95453
96110
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
95454
96111
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
96112
|
+
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 5
|
|
95455
96113
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
95456
96114
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95457
96115
|
* getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
@@ -95464,7 +96122,7 @@ class UsersApi {
|
|
|
95464
96122
|
'/api/v2/users/query',
|
|
95465
96123
|
'GET',
|
|
95466
96124
|
{ },
|
|
95467
|
-
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
96125
|
+
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi'),'state': opts['state'] },
|
|
95468
96126
|
{ },
|
|
95469
96127
|
{ },
|
|
95470
96128
|
null,
|
|
@@ -95584,7 +96242,6 @@ class UsersApi {
|
|
|
95584
96242
|
* @param {Object} userCustomAttributes
|
|
95585
96243
|
* @param {Object} opts Optional parameters
|
|
95586
96244
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95587
|
-
* patchUserCustomattributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95588
96245
|
*/
|
|
95589
96246
|
patchUserCustomattributes(userId, userCustomAttributes, opts) {
|
|
95590
96247
|
opts = opts || {};
|
|
@@ -95620,7 +96277,6 @@ class UsersApi {
|
|
|
95620
96277
|
* @param {Array.<Object>} userCustomAttributesList
|
|
95621
96278
|
* @param {Object} opts Optional parameters
|
|
95622
96279
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95623
|
-
* patchUserCustomattributesBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95624
96280
|
*/
|
|
95625
96281
|
patchUserCustomattributesBulk(userId, userCustomAttributesList, opts) {
|
|
95626
96282
|
opts = opts || {};
|
|
@@ -96443,7 +97099,6 @@ class UsersApi {
|
|
|
96443
97099
|
* @param {Object} body Schema
|
|
96444
97100
|
* @param {Object} opts Optional parameters
|
|
96445
97101
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96446
|
-
* postUsersCustomattributesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
96447
97102
|
*/
|
|
96448
97103
|
postUsersCustomattributesSchemas(body, opts) {
|
|
96449
97104
|
opts = opts || {};
|
|
@@ -96792,7 +97447,6 @@ class UsersApi {
|
|
|
96792
97447
|
* @param {Object} userCustomAttributes
|
|
96793
97448
|
* @param {Object} opts Optional parameters
|
|
96794
97449
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96795
|
-
* putUserCustomattributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
96796
97450
|
*/
|
|
96797
97451
|
putUserCustomattributes(userId, userCustomAttributes, opts) {
|
|
96798
97452
|
opts = opts || {};
|
|
@@ -97188,7 +97842,6 @@ class UsersApi {
|
|
|
97188
97842
|
* @param {Object} body Data Schema
|
|
97189
97843
|
* @param {Object} opts Optional parameters
|
|
97190
97844
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
97191
|
-
* putUsersCustomattributesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
97192
97845
|
*/
|
|
97193
97846
|
putUsersCustomattributesSchema(schemaId, body, opts) {
|
|
97194
97847
|
opts = opts || {};
|
|
@@ -97223,7 +97876,7 @@ class UsersRulesApi {
|
|
|
97223
97876
|
/**
|
|
97224
97877
|
* UsersRules service.
|
|
97225
97878
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
97226
|
-
* @version
|
|
97879
|
+
* @version 250.0.0
|
|
97227
97880
|
*/
|
|
97228
97881
|
|
|
97229
97882
|
/**
|
|
@@ -97540,7 +98193,7 @@ class UtilitiesApi {
|
|
|
97540
98193
|
/**
|
|
97541
98194
|
* Utilities service.
|
|
97542
98195
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
97543
|
-
* @version
|
|
98196
|
+
* @version 250.0.0
|
|
97544
98197
|
*/
|
|
97545
98198
|
|
|
97546
98199
|
/**
|
|
@@ -97668,7 +98321,7 @@ class VoicemailApi {
|
|
|
97668
98321
|
/**
|
|
97669
98322
|
* Voicemail service.
|
|
97670
98323
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
97671
|
-
* @version
|
|
98324
|
+
* @version 250.0.0
|
|
97672
98325
|
*/
|
|
97673
98326
|
|
|
97674
98327
|
/**
|
|
@@ -98498,7 +99151,7 @@ class WebChatApi {
|
|
|
98498
99151
|
/**
|
|
98499
99152
|
* WebChat service.
|
|
98500
99153
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
98501
|
-
* @version
|
|
99154
|
+
* @version 250.0.0
|
|
98502
99155
|
*/
|
|
98503
99156
|
|
|
98504
99157
|
/**
|
|
@@ -99150,7 +99803,7 @@ class WebDeploymentsApi {
|
|
|
99150
99803
|
/**
|
|
99151
99804
|
* WebDeployments service.
|
|
99152
99805
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
99153
|
-
* @version
|
|
99806
|
+
* @version 250.0.0
|
|
99154
99807
|
*/
|
|
99155
99808
|
|
|
99156
99809
|
/**
|
|
@@ -99828,7 +100481,7 @@ class WebMessagingApi {
|
|
|
99828
100481
|
/**
|
|
99829
100482
|
* WebMessaging service.
|
|
99830
100483
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
99831
|
-
* @version
|
|
100484
|
+
* @version 250.0.0
|
|
99832
100485
|
*/
|
|
99833
100486
|
|
|
99834
100487
|
/**
|
|
@@ -99991,7 +100644,7 @@ class WidgetsApi {
|
|
|
99991
100644
|
/**
|
|
99992
100645
|
* Widgets service.
|
|
99993
100646
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
99994
|
-
* @version
|
|
100647
|
+
* @version 250.0.0
|
|
99995
100648
|
*/
|
|
99996
100649
|
|
|
99997
100650
|
/**
|
|
@@ -100167,7 +100820,7 @@ class WorkforceManagementApi {
|
|
|
100167
100820
|
/**
|
|
100168
100821
|
* WorkforceManagement service.
|
|
100169
100822
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
100170
|
-
* @version
|
|
100823
|
+
* @version 250.0.0
|
|
100171
100824
|
*/
|
|
100172
100825
|
|
|
100173
100826
|
/**
|
|
@@ -102302,6 +102955,181 @@ class WorkforceManagementApi {
|
|
|
102302
102955
|
);
|
|
102303
102956
|
}
|
|
102304
102957
|
|
|
102958
|
+
/**
|
|
102959
|
+
* View results of the evaluate shift trades in a management unit per week operation. Only the user who started the operation can query the status
|
|
102960
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
102961
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
102962
|
+
* @param {String} jobId The ID of the job
|
|
102963
|
+
* @param {Object} opts Optional parameters
|
|
102964
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
102965
|
+
*/
|
|
102966
|
+
getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob(businessUnitId, jobId, opts) {
|
|
102967
|
+
opts = opts || {};
|
|
102968
|
+
|
|
102969
|
+
// verify the required parameter 'businessUnitId' is set
|
|
102970
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
102971
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob';
|
|
102972
|
+
}
|
|
102973
|
+
// verify the required parameter 'jobId' is set
|
|
102974
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
102975
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob';
|
|
102976
|
+
}
|
|
102977
|
+
|
|
102978
|
+
return this.apiClient.callApi(
|
|
102979
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs/{jobId}',
|
|
102980
|
+
'GET',
|
|
102981
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
102982
|
+
{ },
|
|
102983
|
+
{ },
|
|
102984
|
+
{ },
|
|
102985
|
+
null,
|
|
102986
|
+
['PureCloud OAuth'],
|
|
102987
|
+
['application/json'],
|
|
102988
|
+
['application/json'],
|
|
102989
|
+
opts['customHeaders']
|
|
102990
|
+
);
|
|
102991
|
+
}
|
|
102992
|
+
|
|
102993
|
+
/**
|
|
102994
|
+
* View results of the query shift trades in a management unit per user operation. Only the user who started the operation can query the status
|
|
102995
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
102996
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
102997
|
+
* @param {String} jobId The ID of the job
|
|
102998
|
+
* @param {Object} opts Optional parameters
|
|
102999
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103000
|
+
*/
|
|
103001
|
+
getWorkforcemanagementBusinessunitShifttradingTradesQueryJob(businessUnitId, jobId, opts) {
|
|
103002
|
+
opts = opts || {};
|
|
103003
|
+
|
|
103004
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103005
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103006
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingTradesQueryJob';
|
|
103007
|
+
}
|
|
103008
|
+
// verify the required parameter 'jobId' is set
|
|
103009
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
103010
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingTradesQueryJob';
|
|
103011
|
+
}
|
|
103012
|
+
|
|
103013
|
+
return this.apiClient.callApi(
|
|
103014
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs/{jobId}',
|
|
103015
|
+
'GET',
|
|
103016
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
103017
|
+
{ },
|
|
103018
|
+
{ },
|
|
103019
|
+
{ },
|
|
103020
|
+
null,
|
|
103021
|
+
['PureCloud OAuth'],
|
|
103022
|
+
['application/json'],
|
|
103023
|
+
['application/json'],
|
|
103024
|
+
opts['customHeaders']
|
|
103025
|
+
);
|
|
103026
|
+
}
|
|
103027
|
+
|
|
103028
|
+
/**
|
|
103029
|
+
* View results of bulk update trades states operation. Only the user who started the operation can query the status.
|
|
103030
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
103031
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
103032
|
+
* @param {String} jobId The ID of the job
|
|
103033
|
+
* @param {Object} opts Optional parameters
|
|
103034
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103035
|
+
*/
|
|
103036
|
+
getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob(businessUnitId, jobId, opts) {
|
|
103037
|
+
opts = opts || {};
|
|
103038
|
+
|
|
103039
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103040
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103041
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob';
|
|
103042
|
+
}
|
|
103043
|
+
// verify the required parameter 'jobId' is set
|
|
103044
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
103045
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob';
|
|
103046
|
+
}
|
|
103047
|
+
|
|
103048
|
+
return this.apiClient.callApi(
|
|
103049
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs/{jobId}',
|
|
103050
|
+
'GET',
|
|
103051
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
103052
|
+
{ },
|
|
103053
|
+
{ },
|
|
103054
|
+
{ },
|
|
103055
|
+
null,
|
|
103056
|
+
['PureCloud OAuth'],
|
|
103057
|
+
['application/json'],
|
|
103058
|
+
['application/json'],
|
|
103059
|
+
opts['customHeaders']
|
|
103060
|
+
);
|
|
103061
|
+
}
|
|
103062
|
+
|
|
103063
|
+
/**
|
|
103064
|
+
* View result of potential shift trade matches for the current user. Only the user who started the operation can query the status
|
|
103065
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
103066
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
103067
|
+
* @param {String} jobId The ID of the job
|
|
103068
|
+
* @param {Object} opts Optional parameters
|
|
103069
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103070
|
+
*/
|
|
103071
|
+
getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob(businessUnitId, jobId, opts) {
|
|
103072
|
+
opts = opts || {};
|
|
103073
|
+
|
|
103074
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103075
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103076
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob';
|
|
103077
|
+
}
|
|
103078
|
+
// verify the required parameter 'jobId' is set
|
|
103079
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
103080
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob';
|
|
103081
|
+
}
|
|
103082
|
+
|
|
103083
|
+
return this.apiClient.callApi(
|
|
103084
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs/{jobId}',
|
|
103085
|
+
'GET',
|
|
103086
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
103087
|
+
{ },
|
|
103088
|
+
{ },
|
|
103089
|
+
{ },
|
|
103090
|
+
null,
|
|
103091
|
+
['PureCloud OAuth'],
|
|
103092
|
+
['application/json'],
|
|
103093
|
+
['application/json'],
|
|
103094
|
+
opts['customHeaders']
|
|
103095
|
+
);
|
|
103096
|
+
}
|
|
103097
|
+
|
|
103098
|
+
/**
|
|
103099
|
+
* View results of the retrieve the summary of shift trades in a matched state per week operation. Only the user who started the operation can query the status
|
|
103100
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
103101
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
103102
|
+
* @param {String} jobId The ID of the job
|
|
103103
|
+
* @param {Object} opts Optional parameters
|
|
103104
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103105
|
+
*/
|
|
103106
|
+
getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob(businessUnitId, jobId, opts) {
|
|
103107
|
+
opts = opts || {};
|
|
103108
|
+
|
|
103109
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103110
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103111
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob';
|
|
103112
|
+
}
|
|
103113
|
+
// verify the required parameter 'jobId' is set
|
|
103114
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
103115
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob';
|
|
103116
|
+
}
|
|
103117
|
+
|
|
103118
|
+
return this.apiClient.callApi(
|
|
103119
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs/{jobId}',
|
|
103120
|
+
'GET',
|
|
103121
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
103122
|
+
{ },
|
|
103123
|
+
{ },
|
|
103124
|
+
{ },
|
|
103125
|
+
null,
|
|
103126
|
+
['PureCloud OAuth'],
|
|
103127
|
+
['application/json'],
|
|
103128
|
+
['application/json'],
|
|
103129
|
+
opts['customHeaders']
|
|
103130
|
+
);
|
|
103131
|
+
}
|
|
103132
|
+
|
|
102305
103133
|
/**
|
|
102306
103134
|
* Gets a staffing group
|
|
102307
103135
|
*
|
|
@@ -102787,7 +103615,7 @@ class WorkforceManagementApi {
|
|
|
102787
103615
|
|
|
102788
103616
|
/**
|
|
102789
103617
|
* Get the list of week schedules for the specified week
|
|
102790
|
-
* Use "recent" (without quotes) for the `weekId` path parameter to fetch all
|
|
103618
|
+
* Use "recent" (without quotes) for the `weekId` path parameter to fetch all schedules for up to +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
|
|
102791
103619
|
* @param {String} businessUnitId The ID of the business unit
|
|
102792
103620
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
|
|
102793
103621
|
* @param {Object} opts Optional parameters
|
|
@@ -103070,7 +103898,7 @@ class WorkforceManagementApi {
|
|
|
103070
103898
|
|
|
103071
103899
|
/**
|
|
103072
103900
|
* Get short term forecasts
|
|
103073
|
-
* Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
103901
|
+
* Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for up to +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
103074
103902
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
103075
103903
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
103076
103904
|
* @param {Object} opts Optional parameters
|
|
@@ -104446,6 +105274,171 @@ class WorkforceManagementApi {
|
|
|
104446
105274
|
);
|
|
104447
105275
|
}
|
|
104448
105276
|
|
|
105277
|
+
/**
|
|
105278
|
+
* View result of update trade operation. Only the user who started the operation can query the status
|
|
105279
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105280
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
105281
|
+
* @param {String} jobId The ID of the job
|
|
105282
|
+
* @param {Object} opts Optional parameters
|
|
105283
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105284
|
+
*/
|
|
105285
|
+
getWorkforcemanagementShifttradingTradeJob(tradeId, jobId, opts) {
|
|
105286
|
+
opts = opts || {};
|
|
105287
|
+
|
|
105288
|
+
// verify the required parameter 'tradeId' is set
|
|
105289
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
105290
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementShifttradingTradeJob';
|
|
105291
|
+
}
|
|
105292
|
+
// verify the required parameter 'jobId' is set
|
|
105293
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105294
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradeJob';
|
|
105295
|
+
}
|
|
105296
|
+
|
|
105297
|
+
return this.apiClient.callApi(
|
|
105298
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs/{jobId}',
|
|
105299
|
+
'GET',
|
|
105300
|
+
{ 'tradeId': tradeId,'jobId': jobId },
|
|
105301
|
+
{ },
|
|
105302
|
+
{ },
|
|
105303
|
+
{ },
|
|
105304
|
+
null,
|
|
105305
|
+
['PureCloud OAuth'],
|
|
105306
|
+
['application/json'],
|
|
105307
|
+
['application/json'],
|
|
105308
|
+
opts['customHeaders']
|
|
105309
|
+
);
|
|
105310
|
+
}
|
|
105311
|
+
|
|
105312
|
+
/**
|
|
105313
|
+
* View result of match shift trade operation. Only the receiving user who started the operation can query the status.
|
|
105314
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105315
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
105316
|
+
* @param {String} jobId The ID of the job
|
|
105317
|
+
* @param {Object} opts Optional parameters
|
|
105318
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105319
|
+
*/
|
|
105320
|
+
getWorkforcemanagementShifttradingTradeMatchJob(tradeId, jobId, opts) {
|
|
105321
|
+
opts = opts || {};
|
|
105322
|
+
|
|
105323
|
+
// verify the required parameter 'tradeId' is set
|
|
105324
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
105325
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementShifttradingTradeMatchJob';
|
|
105326
|
+
}
|
|
105327
|
+
// verify the required parameter 'jobId' is set
|
|
105328
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105329
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradeMatchJob';
|
|
105330
|
+
}
|
|
105331
|
+
|
|
105332
|
+
return this.apiClient.callApi(
|
|
105333
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs/{jobId}',
|
|
105334
|
+
'GET',
|
|
105335
|
+
{ 'tradeId': tradeId,'jobId': jobId },
|
|
105336
|
+
{ },
|
|
105337
|
+
{ },
|
|
105338
|
+
{ },
|
|
105339
|
+
null,
|
|
105340
|
+
['PureCloud OAuth'],
|
|
105341
|
+
['application/json'],
|
|
105342
|
+
['application/json'],
|
|
105343
|
+
opts['customHeaders']
|
|
105344
|
+
);
|
|
105345
|
+
}
|
|
105346
|
+
|
|
105347
|
+
/**
|
|
105348
|
+
* View result of update trade state operation. Only the user who started the operation can query the status.
|
|
105349
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105350
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
105351
|
+
* @param {String} jobId The ID of the job
|
|
105352
|
+
* @param {Object} opts Optional parameters
|
|
105353
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105354
|
+
*/
|
|
105355
|
+
getWorkforcemanagementShifttradingTradeStateJob(tradeId, jobId, opts) {
|
|
105356
|
+
opts = opts || {};
|
|
105357
|
+
|
|
105358
|
+
// verify the required parameter 'tradeId' is set
|
|
105359
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
105360
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementShifttradingTradeStateJob';
|
|
105361
|
+
}
|
|
105362
|
+
// verify the required parameter 'jobId' is set
|
|
105363
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105364
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradeStateJob';
|
|
105365
|
+
}
|
|
105366
|
+
|
|
105367
|
+
return this.apiClient.callApi(
|
|
105368
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs/{jobId}',
|
|
105369
|
+
'GET',
|
|
105370
|
+
{ 'tradeId': tradeId,'jobId': jobId },
|
|
105371
|
+
{ },
|
|
105372
|
+
{ },
|
|
105373
|
+
{ },
|
|
105374
|
+
null,
|
|
105375
|
+
['PureCloud OAuth'],
|
|
105376
|
+
['application/json'],
|
|
105377
|
+
['application/json'],
|
|
105378
|
+
opts['customHeaders']
|
|
105379
|
+
);
|
|
105380
|
+
}
|
|
105381
|
+
|
|
105382
|
+
/**
|
|
105383
|
+
* View result of create trade operation. Only the user who started the operation can query the status
|
|
105384
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105385
|
+
* @param {String} jobId The ID of the job
|
|
105386
|
+
* @param {Object} opts Optional parameters
|
|
105387
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105388
|
+
*/
|
|
105389
|
+
getWorkforcemanagementShifttradingTradesJob(jobId, opts) {
|
|
105390
|
+
opts = opts || {};
|
|
105391
|
+
|
|
105392
|
+
// verify the required parameter 'jobId' is set
|
|
105393
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105394
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradesJob';
|
|
105395
|
+
}
|
|
105396
|
+
|
|
105397
|
+
return this.apiClient.callApi(
|
|
105398
|
+
'/api/v2/workforcemanagement/shifttrading/trades/jobs/{jobId}',
|
|
105399
|
+
'GET',
|
|
105400
|
+
{ 'jobId': jobId },
|
|
105401
|
+
{ },
|
|
105402
|
+
{ },
|
|
105403
|
+
{ },
|
|
105404
|
+
null,
|
|
105405
|
+
['PureCloud OAuth'],
|
|
105406
|
+
['application/json'],
|
|
105407
|
+
['application/json'],
|
|
105408
|
+
opts['customHeaders']
|
|
105409
|
+
);
|
|
105410
|
+
}
|
|
105411
|
+
|
|
105412
|
+
/**
|
|
105413
|
+
* View results of retrieve all my shift trade operation. Only the user who started the operation can query the status
|
|
105414
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105415
|
+
* @param {String} jobId The ID of the job
|
|
105416
|
+
* @param {Object} opts Optional parameters
|
|
105417
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105418
|
+
*/
|
|
105419
|
+
getWorkforcemanagementShifttradingTradesMineQueryJob(jobId, opts) {
|
|
105420
|
+
opts = opts || {};
|
|
105421
|
+
|
|
105422
|
+
// verify the required parameter 'jobId' is set
|
|
105423
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105424
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradesMineQueryJob';
|
|
105425
|
+
}
|
|
105426
|
+
|
|
105427
|
+
return this.apiClient.callApi(
|
|
105428
|
+
'/api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs/{jobId}',
|
|
105429
|
+
'GET',
|
|
105430
|
+
{ 'jobId': jobId },
|
|
105431
|
+
{ },
|
|
105432
|
+
{ },
|
|
105433
|
+
{ },
|
|
105434
|
+
null,
|
|
105435
|
+
['PureCloud OAuth'],
|
|
105436
|
+
['application/json'],
|
|
105437
|
+
['application/json'],
|
|
105438
|
+
opts['customHeaders']
|
|
105439
|
+
);
|
|
105440
|
+
}
|
|
105441
|
+
|
|
104449
105442
|
/**
|
|
104450
105443
|
* Request to fetch the status of the historical shrinkage query
|
|
104451
105444
|
*
|
|
@@ -107169,6 +108162,190 @@ class WorkforceManagementApi {
|
|
|
107169
108162
|
);
|
|
107170
108163
|
}
|
|
107171
108164
|
|
|
108165
|
+
/**
|
|
108166
|
+
* Queries and evaluates against shift trade configuration shift trades in a management unit per week
|
|
108167
|
+
*
|
|
108168
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108169
|
+
* @param {Object} body The request body
|
|
108170
|
+
* @param {Object} opts Optional parameters
|
|
108171
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108172
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108173
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108174
|
+
*/
|
|
108175
|
+
postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs(businessUnitId, body, opts) {
|
|
108176
|
+
opts = opts || {};
|
|
108177
|
+
|
|
108178
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108179
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108180
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs';
|
|
108181
|
+
}
|
|
108182
|
+
// verify the required parameter 'body' is set
|
|
108183
|
+
if (body === undefined || body === null) {
|
|
108184
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs';
|
|
108185
|
+
}
|
|
108186
|
+
|
|
108187
|
+
return this.apiClient.callApi(
|
|
108188
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs',
|
|
108189
|
+
'POST',
|
|
108190
|
+
{ 'businessUnitId': businessUnitId },
|
|
108191
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108192
|
+
{ },
|
|
108193
|
+
{ },
|
|
108194
|
+
body,
|
|
108195
|
+
['PureCloud OAuth'],
|
|
108196
|
+
['application/json'],
|
|
108197
|
+
['application/json'],
|
|
108198
|
+
opts['customHeaders']
|
|
108199
|
+
);
|
|
108200
|
+
}
|
|
108201
|
+
|
|
108202
|
+
/**
|
|
108203
|
+
* Queries shift trades in a management unit per user
|
|
108204
|
+
*
|
|
108205
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108206
|
+
* @param {Object} body The request body
|
|
108207
|
+
* @param {Object} opts Optional parameters
|
|
108208
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108209
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108210
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108211
|
+
*/
|
|
108212
|
+
postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs(businessUnitId, body, opts) {
|
|
108213
|
+
opts = opts || {};
|
|
108214
|
+
|
|
108215
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108216
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108217
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs';
|
|
108218
|
+
}
|
|
108219
|
+
// verify the required parameter 'body' is set
|
|
108220
|
+
if (body === undefined || body === null) {
|
|
108221
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs';
|
|
108222
|
+
}
|
|
108223
|
+
|
|
108224
|
+
return this.apiClient.callApi(
|
|
108225
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs',
|
|
108226
|
+
'POST',
|
|
108227
|
+
{ 'businessUnitId': businessUnitId },
|
|
108228
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108229
|
+
{ },
|
|
108230
|
+
{ },
|
|
108231
|
+
body,
|
|
108232
|
+
['PureCloud OAuth'],
|
|
108233
|
+
['application/json'],
|
|
108234
|
+
['application/json'],
|
|
108235
|
+
opts['customHeaders']
|
|
108236
|
+
);
|
|
108237
|
+
}
|
|
108238
|
+
|
|
108239
|
+
/**
|
|
108240
|
+
* Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades.
|
|
108241
|
+
*
|
|
108242
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108243
|
+
* @param {Object} body The request body
|
|
108244
|
+
* @param {Object} opts Optional parameters
|
|
108245
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108246
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108247
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108248
|
+
*/
|
|
108249
|
+
postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs(businessUnitId, body, opts) {
|
|
108250
|
+
opts = opts || {};
|
|
108251
|
+
|
|
108252
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108253
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108254
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs';
|
|
108255
|
+
}
|
|
108256
|
+
// verify the required parameter 'body' is set
|
|
108257
|
+
if (body === undefined || body === null) {
|
|
108258
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs';
|
|
108259
|
+
}
|
|
108260
|
+
|
|
108261
|
+
return this.apiClient.callApi(
|
|
108262
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs',
|
|
108263
|
+
'POST',
|
|
108264
|
+
{ 'businessUnitId': businessUnitId },
|
|
108265
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108266
|
+
{ },
|
|
108267
|
+
{ },
|
|
108268
|
+
body,
|
|
108269
|
+
['PureCloud OAuth'],
|
|
108270
|
+
['application/json'],
|
|
108271
|
+
['application/json'],
|
|
108272
|
+
opts['customHeaders']
|
|
108273
|
+
);
|
|
108274
|
+
}
|
|
108275
|
+
|
|
108276
|
+
/**
|
|
108277
|
+
* Start an async job to find potential shift trade matches for the current receiving user
|
|
108278
|
+
*
|
|
108279
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108280
|
+
* @param {Object} body The request body
|
|
108281
|
+
* @param {Object} opts Optional parameters
|
|
108282
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108283
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108284
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108285
|
+
*/
|
|
108286
|
+
postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs(businessUnitId, body, opts) {
|
|
108287
|
+
opts = opts || {};
|
|
108288
|
+
|
|
108289
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108290
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108291
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs';
|
|
108292
|
+
}
|
|
108293
|
+
// verify the required parameter 'body' is set
|
|
108294
|
+
if (body === undefined || body === null) {
|
|
108295
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs';
|
|
108296
|
+
}
|
|
108297
|
+
|
|
108298
|
+
return this.apiClient.callApi(
|
|
108299
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs',
|
|
108300
|
+
'POST',
|
|
108301
|
+
{ 'businessUnitId': businessUnitId },
|
|
108302
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108303
|
+
{ },
|
|
108304
|
+
{ },
|
|
108305
|
+
body,
|
|
108306
|
+
['PureCloud OAuth'],
|
|
108307
|
+
['application/json'],
|
|
108308
|
+
['application/json'],
|
|
108309
|
+
opts['customHeaders']
|
|
108310
|
+
);
|
|
108311
|
+
}
|
|
108312
|
+
|
|
108313
|
+
/**
|
|
108314
|
+
* Retrieves the summary of shift trades in a matched state per week
|
|
108315
|
+
*
|
|
108316
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108317
|
+
* @param {Object} body The request body
|
|
108318
|
+
* @param {Object} opts Optional parameters
|
|
108319
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108320
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108321
|
+
*/
|
|
108322
|
+
postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs(businessUnitId, body, opts) {
|
|
108323
|
+
opts = opts || {};
|
|
108324
|
+
|
|
108325
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108326
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108327
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs';
|
|
108328
|
+
}
|
|
108329
|
+
// verify the required parameter 'body' is set
|
|
108330
|
+
if (body === undefined || body === null) {
|
|
108331
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs';
|
|
108332
|
+
}
|
|
108333
|
+
|
|
108334
|
+
return this.apiClient.callApi(
|
|
108335
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs',
|
|
108336
|
+
'POST',
|
|
108337
|
+
{ 'businessUnitId': businessUnitId },
|
|
108338
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
108339
|
+
{ },
|
|
108340
|
+
{ },
|
|
108341
|
+
body,
|
|
108342
|
+
['PureCloud OAuth'],
|
|
108343
|
+
['application/json'],
|
|
108344
|
+
['application/json'],
|
|
108345
|
+
opts['customHeaders']
|
|
108346
|
+
);
|
|
108347
|
+
}
|
|
108348
|
+
|
|
107172
108349
|
/**
|
|
107173
108350
|
* Creates a new staffing group
|
|
107174
108351
|
*
|
|
@@ -109382,6 +110559,177 @@ class WorkforceManagementApi {
|
|
|
109382
110559
|
);
|
|
109383
110560
|
}
|
|
109384
110561
|
|
|
110562
|
+
/**
|
|
110563
|
+
* Updates a shift trade. This route can only be called by the initiating user
|
|
110564
|
+
*
|
|
110565
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
110566
|
+
* @param {Object} body The request body
|
|
110567
|
+
* @param {Object} opts Optional parameters
|
|
110568
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110569
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110570
|
+
*/
|
|
110571
|
+
postWorkforcemanagementShifttradingTradeJobs(tradeId, body, opts) {
|
|
110572
|
+
opts = opts || {};
|
|
110573
|
+
|
|
110574
|
+
// verify the required parameter 'tradeId' is set
|
|
110575
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
110576
|
+
throw 'Missing the required parameter "tradeId" when calling postWorkforcemanagementShifttradingTradeJobs';
|
|
110577
|
+
}
|
|
110578
|
+
// verify the required parameter 'body' is set
|
|
110579
|
+
if (body === undefined || body === null) {
|
|
110580
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradeJobs';
|
|
110581
|
+
}
|
|
110582
|
+
|
|
110583
|
+
return this.apiClient.callApi(
|
|
110584
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs',
|
|
110585
|
+
'POST',
|
|
110586
|
+
{ 'tradeId': tradeId },
|
|
110587
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
110588
|
+
{ },
|
|
110589
|
+
{ },
|
|
110590
|
+
body,
|
|
110591
|
+
['PureCloud OAuth'],
|
|
110592
|
+
['application/json'],
|
|
110593
|
+
['application/json'],
|
|
110594
|
+
opts['customHeaders']
|
|
110595
|
+
);
|
|
110596
|
+
}
|
|
110597
|
+
|
|
110598
|
+
/**
|
|
110599
|
+
* Matches a shift trade. This route can only be called by the receiving user
|
|
110600
|
+
*
|
|
110601
|
+
* @param {String} tradeId The ID of the shift trade to match
|
|
110602
|
+
* @param {Object} body The request body
|
|
110603
|
+
* @param {Object} opts Optional parameters
|
|
110604
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110605
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110606
|
+
*/
|
|
110607
|
+
postWorkforcemanagementShifttradingTradeMatchJobs(tradeId, body, opts) {
|
|
110608
|
+
opts = opts || {};
|
|
110609
|
+
|
|
110610
|
+
// verify the required parameter 'tradeId' is set
|
|
110611
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
110612
|
+
throw 'Missing the required parameter "tradeId" when calling postWorkforcemanagementShifttradingTradeMatchJobs';
|
|
110613
|
+
}
|
|
110614
|
+
// verify the required parameter 'body' is set
|
|
110615
|
+
if (body === undefined || body === null) {
|
|
110616
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradeMatchJobs';
|
|
110617
|
+
}
|
|
110618
|
+
|
|
110619
|
+
return this.apiClient.callApi(
|
|
110620
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs',
|
|
110621
|
+
'POST',
|
|
110622
|
+
{ 'tradeId': tradeId },
|
|
110623
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
110624
|
+
{ },
|
|
110625
|
+
{ },
|
|
110626
|
+
body,
|
|
110627
|
+
['PureCloud OAuth'],
|
|
110628
|
+
['application/json'],
|
|
110629
|
+
['application/json'],
|
|
110630
|
+
opts['customHeaders']
|
|
110631
|
+
);
|
|
110632
|
+
}
|
|
110633
|
+
|
|
110634
|
+
/**
|
|
110635
|
+
* Update trade state by a user
|
|
110636
|
+
*
|
|
110637
|
+
* @param {String} tradeId The ID of the shift trade to update state
|
|
110638
|
+
* @param {Object} body The request body
|
|
110639
|
+
* @param {Object} opts Optional parameters
|
|
110640
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110641
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110642
|
+
*/
|
|
110643
|
+
postWorkforcemanagementShifttradingTradeStateJobs(tradeId, body, opts) {
|
|
110644
|
+
opts = opts || {};
|
|
110645
|
+
|
|
110646
|
+
// verify the required parameter 'tradeId' is set
|
|
110647
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
110648
|
+
throw 'Missing the required parameter "tradeId" when calling postWorkforcemanagementShifttradingTradeStateJobs';
|
|
110649
|
+
}
|
|
110650
|
+
// verify the required parameter 'body' is set
|
|
110651
|
+
if (body === undefined || body === null) {
|
|
110652
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradeStateJobs';
|
|
110653
|
+
}
|
|
110654
|
+
|
|
110655
|
+
return this.apiClient.callApi(
|
|
110656
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs',
|
|
110657
|
+
'POST',
|
|
110658
|
+
{ 'tradeId': tradeId },
|
|
110659
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
110660
|
+
{ },
|
|
110661
|
+
{ },
|
|
110662
|
+
body,
|
|
110663
|
+
['PureCloud OAuth'],
|
|
110664
|
+
['application/json'],
|
|
110665
|
+
['application/json'],
|
|
110666
|
+
opts['customHeaders']
|
|
110667
|
+
);
|
|
110668
|
+
}
|
|
110669
|
+
|
|
110670
|
+
/**
|
|
110671
|
+
* Add a shift trade job
|
|
110672
|
+
*
|
|
110673
|
+
* @param {Object} body The request body
|
|
110674
|
+
* @param {Object} opts Optional parameters
|
|
110675
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110676
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110677
|
+
*/
|
|
110678
|
+
postWorkforcemanagementShifttradingTradesJobs(body, opts) {
|
|
110679
|
+
opts = opts || {};
|
|
110680
|
+
|
|
110681
|
+
// verify the required parameter 'body' is set
|
|
110682
|
+
if (body === undefined || body === null) {
|
|
110683
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradesJobs';
|
|
110684
|
+
}
|
|
110685
|
+
|
|
110686
|
+
return this.apiClient.callApi(
|
|
110687
|
+
'/api/v2/workforcemanagement/shifttrading/trades/jobs',
|
|
110688
|
+
'POST',
|
|
110689
|
+
{ },
|
|
110690
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
110691
|
+
{ },
|
|
110692
|
+
{ },
|
|
110693
|
+
body,
|
|
110694
|
+
['PureCloud OAuth'],
|
|
110695
|
+
['application/json'],
|
|
110696
|
+
['application/json'],
|
|
110697
|
+
opts['customHeaders']
|
|
110698
|
+
);
|
|
110699
|
+
}
|
|
110700
|
+
|
|
110701
|
+
/**
|
|
110702
|
+
* Retrieve all my shift trades where I am either the initiating or receiving user
|
|
110703
|
+
*
|
|
110704
|
+
* @param {Object} body The request body
|
|
110705
|
+
* @param {Object} opts Optional parameters
|
|
110706
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110707
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
110708
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110709
|
+
*/
|
|
110710
|
+
postWorkforcemanagementShifttradingTradesMineQueryJobs(body, opts) {
|
|
110711
|
+
opts = opts || {};
|
|
110712
|
+
|
|
110713
|
+
// verify the required parameter 'body' is set
|
|
110714
|
+
if (body === undefined || body === null) {
|
|
110715
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradesMineQueryJobs';
|
|
110716
|
+
}
|
|
110717
|
+
|
|
110718
|
+
return this.apiClient.callApi(
|
|
110719
|
+
'/api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs',
|
|
110720
|
+
'POST',
|
|
110721
|
+
{ },
|
|
110722
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
110723
|
+
{ },
|
|
110724
|
+
{ },
|
|
110725
|
+
body,
|
|
110726
|
+
['PureCloud OAuth'],
|
|
110727
|
+
['application/json'],
|
|
110728
|
+
['application/json'],
|
|
110729
|
+
opts['customHeaders']
|
|
110730
|
+
);
|
|
110731
|
+
}
|
|
110732
|
+
|
|
109385
110733
|
/**
|
|
109386
110734
|
* Request a teams historical adherence report
|
|
109387
110735
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
@@ -109808,7 +111156,7 @@ class WorkforceManagementApi {
|
|
|
109808
111156
|
* </pre>
|
|
109809
111157
|
* </p>
|
|
109810
111158
|
* @module purecloud-platform-client-v2/index
|
|
109811
|
-
* @version
|
|
111159
|
+
* @version 250.0.0
|
|
109812
111160
|
*/
|
|
109813
111161
|
class platformClient {
|
|
109814
111162
|
constructor() {
|