purecloud-platform-client-v2 249.1.0 → 250.1.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 +10 -8
- package/dist/node/purecloud-platform-client-v2.js +1467 -119
- package/dist/web-amd/purecloud-platform-client-v2.js +1467 -119
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +462 -125
- package/dist/web-cjs/purecloud-platform-client-v2.js +462 -125
- 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 +2 -2
- 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
|
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
748
|
-
* @version
|
|
748
|
+
* @version 250.1.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -811,7 +811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
811
811
|
MULTI: 'multi'
|
|
812
812
|
};
|
|
813
813
|
|
|
814
|
-
this.useLegacyParameterFilter =
|
|
814
|
+
this.useLegacyParameterFilter = false;
|
|
815
815
|
|
|
816
816
|
/**
|
|
817
817
|
* @description Value is `true` if local storage exists. Otherwise, false.
|
|
@@ -2433,7 +2433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2433
2433
|
/**
|
|
2434
2434
|
* AIStudio service.
|
|
2435
2435
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2436
|
-
* @version
|
|
2436
|
+
* @version 250.1.0
|
|
2437
2437
|
*/
|
|
2438
2438
|
|
|
2439
2439
|
/**
|
|
@@ -3148,7 +3148,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3148
3148
|
/**
|
|
3149
3149
|
* AgentAssistants service.
|
|
3150
3150
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3151
|
-
* @version
|
|
3151
|
+
* @version 250.1.0
|
|
3152
3152
|
*/
|
|
3153
3153
|
|
|
3154
3154
|
/**
|
|
@@ -3952,7 +3952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3952
3952
|
/**
|
|
3953
3953
|
* AgentCopilot service.
|
|
3954
3954
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3955
|
-
* @version
|
|
3955
|
+
* @version 250.1.0
|
|
3956
3956
|
*/
|
|
3957
3957
|
|
|
3958
3958
|
/**
|
|
@@ -4064,7 +4064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4064
4064
|
/**
|
|
4065
4065
|
* AgentUI service.
|
|
4066
4066
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4067
|
-
* @version
|
|
4067
|
+
* @version 250.1.0
|
|
4068
4068
|
*/
|
|
4069
4069
|
|
|
4070
4070
|
/**
|
|
@@ -4215,7 +4215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4215
4215
|
/**
|
|
4216
4216
|
* Alerting service.
|
|
4217
4217
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4218
|
-
* @version
|
|
4218
|
+
* @version 250.1.0
|
|
4219
4219
|
*/
|
|
4220
4220
|
|
|
4221
4221
|
/**
|
|
@@ -4676,7 +4676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4676
4676
|
/**
|
|
4677
4677
|
* Analytics service.
|
|
4678
4678
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4679
|
-
* @version
|
|
4679
|
+
* @version 250.1.0
|
|
4680
4680
|
*/
|
|
4681
4681
|
|
|
4682
4682
|
/**
|
|
@@ -4876,6 +4876,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4876
4876
|
);
|
|
4877
4877
|
}
|
|
4878
4878
|
|
|
4879
|
+
/**
|
|
4880
|
+
* Delete/cancel an async request for copilot aggregates
|
|
4881
|
+
*
|
|
4882
|
+
* @param {String} jobId jobId
|
|
4883
|
+
* @param {Object} opts Optional parameters
|
|
4884
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4885
|
+
* deleteAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4886
|
+
*/
|
|
4887
|
+
deleteAnalyticsCopilotsAggregatesJob(jobId, opts) {
|
|
4888
|
+
opts = opts || {};
|
|
4889
|
+
|
|
4890
|
+
// verify the required parameter 'jobId' is set
|
|
4891
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4892
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCopilotsAggregatesJob';
|
|
4893
|
+
}
|
|
4894
|
+
|
|
4895
|
+
return this.apiClient.callApi(
|
|
4896
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}',
|
|
4897
|
+
'DELETE',
|
|
4898
|
+
{ 'jobId': jobId },
|
|
4899
|
+
{ },
|
|
4900
|
+
{ },
|
|
4901
|
+
{ },
|
|
4902
|
+
null,
|
|
4903
|
+
['PureCloud OAuth'],
|
|
4904
|
+
['application/json'],
|
|
4905
|
+
['application/json'],
|
|
4906
|
+
opts['customHeaders']
|
|
4907
|
+
);
|
|
4908
|
+
}
|
|
4909
|
+
|
|
4879
4910
|
/**
|
|
4880
4911
|
* Delete/cancel an async request for evaluation aggregates
|
|
4881
4912
|
*
|
|
@@ -5845,6 +5876,69 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5845
5876
|
);
|
|
5846
5877
|
}
|
|
5847
5878
|
|
|
5879
|
+
/**
|
|
5880
|
+
* Get status for async query for copilot aggregates
|
|
5881
|
+
*
|
|
5882
|
+
* @param {String} jobId jobId
|
|
5883
|
+
* @param {Object} opts Optional parameters
|
|
5884
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5885
|
+
* getAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5886
|
+
*/
|
|
5887
|
+
getAnalyticsCopilotsAggregatesJob(jobId, opts) {
|
|
5888
|
+
opts = opts || {};
|
|
5889
|
+
|
|
5890
|
+
// verify the required parameter 'jobId' is set
|
|
5891
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
5892
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCopilotsAggregatesJob';
|
|
5893
|
+
}
|
|
5894
|
+
|
|
5895
|
+
return this.apiClient.callApi(
|
|
5896
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}',
|
|
5897
|
+
'GET',
|
|
5898
|
+
{ 'jobId': jobId },
|
|
5899
|
+
{ },
|
|
5900
|
+
{ },
|
|
5901
|
+
{ },
|
|
5902
|
+
null,
|
|
5903
|
+
['PureCloud OAuth'],
|
|
5904
|
+
['application/json'],
|
|
5905
|
+
['application/json'],
|
|
5906
|
+
opts['customHeaders']
|
|
5907
|
+
);
|
|
5908
|
+
}
|
|
5909
|
+
|
|
5910
|
+
/**
|
|
5911
|
+
* Fetch a page of results for an async aggregates query
|
|
5912
|
+
*
|
|
5913
|
+
* @param {String} jobId jobId
|
|
5914
|
+
* @param {Object} opts Optional parameters
|
|
5915
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
5916
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5917
|
+
* getAnalyticsCopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5918
|
+
*/
|
|
5919
|
+
getAnalyticsCopilotsAggregatesJobResults(jobId, opts) {
|
|
5920
|
+
opts = opts || {};
|
|
5921
|
+
|
|
5922
|
+
// verify the required parameter 'jobId' is set
|
|
5923
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
5924
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCopilotsAggregatesJobResults';
|
|
5925
|
+
}
|
|
5926
|
+
|
|
5927
|
+
return this.apiClient.callApi(
|
|
5928
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}/results',
|
|
5929
|
+
'GET',
|
|
5930
|
+
{ 'jobId': jobId },
|
|
5931
|
+
{ 'cursor': opts['cursor'] },
|
|
5932
|
+
{ },
|
|
5933
|
+
{ },
|
|
5934
|
+
null,
|
|
5935
|
+
['PureCloud OAuth'],
|
|
5936
|
+
['application/json'],
|
|
5937
|
+
['application/json'],
|
|
5938
|
+
opts['customHeaders']
|
|
5939
|
+
);
|
|
5940
|
+
}
|
|
5941
|
+
|
|
5848
5942
|
/**
|
|
5849
5943
|
* Get analytics data warehouse file download
|
|
5850
5944
|
*
|
|
@@ -7452,6 +7546,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7452
7546
|
);
|
|
7453
7547
|
}
|
|
7454
7548
|
|
|
7549
|
+
/**
|
|
7550
|
+
* Query for copilot aggregates asynchronously
|
|
7551
|
+
*
|
|
7552
|
+
* @param {Object} body query
|
|
7553
|
+
* @param {Object} opts Optional parameters
|
|
7554
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7555
|
+
* postAnalyticsCopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7556
|
+
*/
|
|
7557
|
+
postAnalyticsCopilotsAggregatesJobs(body, opts) {
|
|
7558
|
+
opts = opts || {};
|
|
7559
|
+
|
|
7560
|
+
// verify the required parameter 'body' is set
|
|
7561
|
+
if (body === undefined || body === null) {
|
|
7562
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCopilotsAggregatesJobs';
|
|
7563
|
+
}
|
|
7564
|
+
|
|
7565
|
+
return this.apiClient.callApi(
|
|
7566
|
+
'/api/v2/analytics/copilots/aggregates/jobs',
|
|
7567
|
+
'POST',
|
|
7568
|
+
{ },
|
|
7569
|
+
{ },
|
|
7570
|
+
{ },
|
|
7571
|
+
{ },
|
|
7572
|
+
body,
|
|
7573
|
+
['PureCloud OAuth'],
|
|
7574
|
+
['application/json'],
|
|
7575
|
+
['application/json'],
|
|
7576
|
+
opts['customHeaders']
|
|
7577
|
+
);
|
|
7578
|
+
}
|
|
7579
|
+
|
|
7580
|
+
/**
|
|
7581
|
+
* Query for copilot aggregates
|
|
7582
|
+
*
|
|
7583
|
+
* @param {Object} body query
|
|
7584
|
+
* @param {Object} opts Optional parameters
|
|
7585
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7586
|
+
* postAnalyticsCopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7587
|
+
*/
|
|
7588
|
+
postAnalyticsCopilotsAggregatesQuery(body, opts) {
|
|
7589
|
+
opts = opts || {};
|
|
7590
|
+
|
|
7591
|
+
// verify the required parameter 'body' is set
|
|
7592
|
+
if (body === undefined || body === null) {
|
|
7593
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCopilotsAggregatesQuery';
|
|
7594
|
+
}
|
|
7595
|
+
|
|
7596
|
+
return this.apiClient.callApi(
|
|
7597
|
+
'/api/v2/analytics/copilots/aggregates/query',
|
|
7598
|
+
'POST',
|
|
7599
|
+
{ },
|
|
7600
|
+
{ },
|
|
7601
|
+
{ },
|
|
7602
|
+
{ },
|
|
7603
|
+
body,
|
|
7604
|
+
['PureCloud OAuth'],
|
|
7605
|
+
['application/json'],
|
|
7606
|
+
['application/json'],
|
|
7607
|
+
opts['customHeaders']
|
|
7608
|
+
);
|
|
7609
|
+
}
|
|
7610
|
+
|
|
7455
7611
|
/**
|
|
7456
7612
|
* Get download URLs for analytics data warehouse files
|
|
7457
7613
|
*
|
|
@@ -8314,7 +8470,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8314
8470
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned. Used for pagination.
|
|
8315
8471
|
* @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.
|
|
8316
8472
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8317
|
-
* postAnalyticsTaskmanagementMetricsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8318
8473
|
*/
|
|
8319
8474
|
postAnalyticsTaskmanagementMetricsQuery(body, opts) {
|
|
8320
8475
|
opts = opts || {};
|
|
@@ -8651,7 +8806,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8651
8806
|
/**
|
|
8652
8807
|
* Architect service.
|
|
8653
8808
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8654
|
-
* @version
|
|
8809
|
+
* @version 250.1.0
|
|
8655
8810
|
*/
|
|
8656
8811
|
|
|
8657
8812
|
/**
|
|
@@ -13474,7 +13629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13474
13629
|
/**
|
|
13475
13630
|
* AssistantCopilotVariations service.
|
|
13476
13631
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13477
|
-
* @version
|
|
13632
|
+
* @version 250.1.0
|
|
13478
13633
|
*/
|
|
13479
13634
|
|
|
13480
13635
|
/**
|
|
@@ -13670,7 +13825,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13670
13825
|
/**
|
|
13671
13826
|
* Audit service.
|
|
13672
13827
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
13673
|
-
* @version
|
|
13828
|
+
* @version 250.1.0
|
|
13674
13829
|
*/
|
|
13675
13830
|
|
|
13676
13831
|
/**
|
|
@@ -13897,7 +14052,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13897
14052
|
/**
|
|
13898
14053
|
* Authorization service.
|
|
13899
14054
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
13900
|
-
* @version
|
|
14055
|
+
* @version 250.1.0
|
|
13901
14056
|
*/
|
|
13902
14057
|
|
|
13903
14058
|
/**
|
|
@@ -15822,7 +15977,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15822
15977
|
/**
|
|
15823
15978
|
* BackgroundAssistant service.
|
|
15824
15979
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
15825
|
-
* @version
|
|
15980
|
+
* @version 250.1.0
|
|
15826
15981
|
*/
|
|
15827
15982
|
|
|
15828
15983
|
/**
|
|
@@ -15896,7 +16051,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15896
16051
|
/**
|
|
15897
16052
|
* Billing service.
|
|
15898
16053
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
15899
|
-
* @version
|
|
16054
|
+
* @version 250.1.0
|
|
15900
16055
|
*/
|
|
15901
16056
|
|
|
15902
16057
|
/**
|
|
@@ -16180,7 +16335,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16180
16335
|
/**
|
|
16181
16336
|
* BusinessRules service.
|
|
16182
16337
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16183
|
-
* @version
|
|
16338
|
+
* @version 250.1.0
|
|
16184
16339
|
*/
|
|
16185
16340
|
|
|
16186
16341
|
/**
|
|
@@ -17194,7 +17349,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17194
17349
|
/**
|
|
17195
17350
|
* CarrierServices service.
|
|
17196
17351
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17197
|
-
* @version
|
|
17352
|
+
* @version 250.1.0
|
|
17198
17353
|
*/
|
|
17199
17354
|
|
|
17200
17355
|
/**
|
|
@@ -17271,7 +17426,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17271
17426
|
/**
|
|
17272
17427
|
* CaseManagement service.
|
|
17273
17428
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17274
|
-
* @version
|
|
17429
|
+
* @version 250.1.0
|
|
17275
17430
|
*/
|
|
17276
17431
|
|
|
17277
17432
|
/**
|
|
@@ -18497,7 +18652,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18497
18652
|
/**
|
|
18498
18653
|
* Chat service.
|
|
18499
18654
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18500
|
-
* @version
|
|
18655
|
+
* @version 250.1.0
|
|
18501
18656
|
*/
|
|
18502
18657
|
|
|
18503
18658
|
/**
|
|
@@ -19636,7 +19791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19636
19791
|
/**
|
|
19637
19792
|
* Coaching service.
|
|
19638
19793
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
19639
|
-
* @version
|
|
19794
|
+
* @version 250.1.0
|
|
19640
19795
|
*/
|
|
19641
19796
|
|
|
19642
19797
|
/**
|
|
@@ -20350,7 +20505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20350
20505
|
/**
|
|
20351
20506
|
* ContentManagement service.
|
|
20352
20507
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20353
|
-
* @version
|
|
20508
|
+
* @version 250.1.0
|
|
20354
20509
|
*/
|
|
20355
20510
|
|
|
20356
20511
|
/**
|
|
@@ -21545,7 +21700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21545
21700
|
/**
|
|
21546
21701
|
* Conversations service.
|
|
21547
21702
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21548
|
-
* @version
|
|
21703
|
+
* @version 250.1.0
|
|
21549
21704
|
*/
|
|
21550
21705
|
|
|
21551
21706
|
/**
|
|
@@ -29421,6 +29576,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29421
29576
|
);
|
|
29422
29577
|
}
|
|
29423
29578
|
|
|
29579
|
+
/**
|
|
29580
|
+
* Start/stop the snippet recording for a participant
|
|
29581
|
+
*
|
|
29582
|
+
* @param {String} conversationId conversationId
|
|
29583
|
+
* @param {String} participantId participantId
|
|
29584
|
+
* @param {Object} body snippetRecordingRequest
|
|
29585
|
+
* @param {Object} opts Optional parameters
|
|
29586
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29587
|
+
*/
|
|
29588
|
+
postConversationsCallParticipantSnippetRecord(conversationId, participantId, body, opts) {
|
|
29589
|
+
opts = opts || {};
|
|
29590
|
+
|
|
29591
|
+
// verify the required parameter 'conversationId' is set
|
|
29592
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
29593
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantSnippetRecord';
|
|
29594
|
+
}
|
|
29595
|
+
// verify the required parameter 'participantId' is set
|
|
29596
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
29597
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantSnippetRecord';
|
|
29598
|
+
}
|
|
29599
|
+
// verify the required parameter 'body' is set
|
|
29600
|
+
if (body === undefined || body === null) {
|
|
29601
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantSnippetRecord';
|
|
29602
|
+
}
|
|
29603
|
+
|
|
29604
|
+
return this.apiClient.callApi(
|
|
29605
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/snippet/record',
|
|
29606
|
+
'POST',
|
|
29607
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
29608
|
+
{ },
|
|
29609
|
+
{ },
|
|
29610
|
+
{ },
|
|
29611
|
+
body,
|
|
29612
|
+
['PureCloud OAuth'],
|
|
29613
|
+
['application/json'],
|
|
29614
|
+
['application/json'],
|
|
29615
|
+
opts['customHeaders']
|
|
29616
|
+
);
|
|
29617
|
+
}
|
|
29618
|
+
|
|
29424
29619
|
/**
|
|
29425
29620
|
* Initiate voice consult transfer
|
|
29426
29621
|
*
|
|
@@ -32540,7 +32735,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32540
32735
|
/**
|
|
32541
32736
|
* DataExtensions service.
|
|
32542
32737
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
32543
|
-
* @version
|
|
32738
|
+
* @version 250.1.0
|
|
32544
32739
|
*/
|
|
32545
32740
|
|
|
32546
32741
|
/**
|
|
@@ -32641,7 +32836,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32641
32836
|
/**
|
|
32642
32837
|
* DataPrivacy service.
|
|
32643
32838
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
32644
|
-
* @version
|
|
32839
|
+
* @version 250.1.0
|
|
32645
32840
|
*/
|
|
32646
32841
|
|
|
32647
32842
|
/**
|
|
@@ -32838,7 +33033,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32838
33033
|
/**
|
|
32839
33034
|
* Downloads service.
|
|
32840
33035
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
32841
|
-
* @version
|
|
33036
|
+
* @version 250.1.0
|
|
32842
33037
|
*/
|
|
32843
33038
|
|
|
32844
33039
|
/**
|
|
@@ -32892,7 +33087,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32892
33087
|
/**
|
|
32893
33088
|
* Emails service.
|
|
32894
33089
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
32895
|
-
* @version
|
|
33090
|
+
* @version 250.1.0
|
|
32896
33091
|
*/
|
|
32897
33092
|
|
|
32898
33093
|
/**
|
|
@@ -33040,7 +33235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33040
33235
|
/**
|
|
33041
33236
|
* EmployeeEngagement service.
|
|
33042
33237
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33043
|
-
* @version
|
|
33238
|
+
* @version 250.1.0
|
|
33044
33239
|
*/
|
|
33045
33240
|
|
|
33046
33241
|
/**
|
|
@@ -33244,7 +33439,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33244
33439
|
/**
|
|
33245
33440
|
* Events service.
|
|
33246
33441
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33247
|
-
* @version
|
|
33442
|
+
* @version 250.1.0
|
|
33248
33443
|
*/
|
|
33249
33444
|
|
|
33250
33445
|
/**
|
|
@@ -33355,7 +33550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33355
33550
|
/**
|
|
33356
33551
|
* ExternalContacts service.
|
|
33357
33552
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33358
|
-
* @version
|
|
33553
|
+
* @version 250.1.0
|
|
33359
33554
|
*/
|
|
33360
33555
|
|
|
33361
33556
|
/**
|
|
@@ -37126,7 +37321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37126
37321
|
/**
|
|
37127
37322
|
* Fax service.
|
|
37128
37323
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37129
|
-
* @version
|
|
37324
|
+
* @version 250.1.0
|
|
37130
37325
|
*/
|
|
37131
37326
|
|
|
37132
37327
|
/**
|
|
@@ -37375,7 +37570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37375
37570
|
/**
|
|
37376
37571
|
* Flows service.
|
|
37377
37572
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37378
|
-
* @version
|
|
37573
|
+
* @version 250.1.0
|
|
37379
37574
|
*/
|
|
37380
37575
|
|
|
37381
37576
|
/**
|
|
@@ -37613,7 +37808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37613
37808
|
/**
|
|
37614
37809
|
* Gamification service.
|
|
37615
37810
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
37616
|
-
* @version
|
|
37811
|
+
* @version 250.1.0
|
|
37617
37812
|
*/
|
|
37618
37813
|
|
|
37619
37814
|
/**
|
|
@@ -40465,7 +40660,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40465
40660
|
/**
|
|
40466
40661
|
* GeneralDataProtectionRegulation service.
|
|
40467
40662
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
40468
|
-
* @version
|
|
40663
|
+
* @version 250.1.0
|
|
40469
40664
|
*/
|
|
40470
40665
|
|
|
40471
40666
|
/**
|
|
@@ -40609,7 +40804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40609
40804
|
/**
|
|
40610
40805
|
* Geolocation service.
|
|
40611
40806
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
40612
|
-
* @version
|
|
40807
|
+
* @version 250.1.0
|
|
40613
40808
|
*/
|
|
40614
40809
|
|
|
40615
40810
|
/**
|
|
@@ -40760,7 +40955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40760
40955
|
/**
|
|
40761
40956
|
* Greetings service.
|
|
40762
40957
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
40763
|
-
* @version
|
|
40958
|
+
* @version 250.1.0
|
|
40764
40959
|
*/
|
|
40765
40960
|
|
|
40766
40961
|
/**
|
|
@@ -41376,7 +41571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41376
41571
|
/**
|
|
41377
41572
|
* Groups service.
|
|
41378
41573
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41379
|
-
* @version
|
|
41574
|
+
* @version 250.1.0
|
|
41380
41575
|
*/
|
|
41381
41576
|
|
|
41382
41577
|
/**
|
|
@@ -41967,7 +42162,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41967
42162
|
/**
|
|
41968
42163
|
* IdentityProvider service.
|
|
41969
42164
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
41970
|
-
* @version
|
|
42165
|
+
* @version 250.1.0
|
|
41971
42166
|
*/
|
|
41972
42167
|
|
|
41973
42168
|
/**
|
|
@@ -43018,7 +43213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43018
43213
|
/**
|
|
43019
43214
|
* InfrastructureAsCode service.
|
|
43020
43215
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43021
|
-
* @version
|
|
43216
|
+
* @version 250.1.0
|
|
43022
43217
|
*/
|
|
43023
43218
|
|
|
43024
43219
|
/**
|
|
@@ -43198,7 +43393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43198
43393
|
/**
|
|
43199
43394
|
* Integrations service.
|
|
43200
43395
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43201
|
-
* @version
|
|
43396
|
+
* @version 250.1.0
|
|
43202
43397
|
*/
|
|
43203
43398
|
|
|
43204
43399
|
/**
|
|
@@ -46170,7 +46365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46170
46365
|
/**
|
|
46171
46366
|
* Intents service.
|
|
46172
46367
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46173
|
-
* @version
|
|
46368
|
+
* @version 250.1.0
|
|
46174
46369
|
*/
|
|
46175
46370
|
|
|
46176
46371
|
/**
|
|
@@ -46702,7 +46897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46702
46897
|
/**
|
|
46703
46898
|
* Journey service.
|
|
46704
46899
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
46705
|
-
* @version
|
|
46900
|
+
* @version 250.1.0
|
|
46706
46901
|
*/
|
|
46707
46902
|
|
|
46708
46903
|
/**
|
|
@@ -46809,6 +47004,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46809
47004
|
);
|
|
46810
47005
|
}
|
|
46811
47006
|
|
|
47007
|
+
/**
|
|
47008
|
+
* Delete an external events configuration.
|
|
47009
|
+
*
|
|
47010
|
+
* @param {String} configId The ID of the external event configuration.
|
|
47011
|
+
* @param {Object} opts Optional parameters
|
|
47012
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47013
|
+
*/
|
|
47014
|
+
deleteJourneyExternaleventsConfiguration(configId, opts) {
|
|
47015
|
+
opts = opts || {};
|
|
47016
|
+
|
|
47017
|
+
// verify the required parameter 'configId' is set
|
|
47018
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
47019
|
+
throw 'Missing the required parameter "configId" when calling deleteJourneyExternaleventsConfiguration';
|
|
47020
|
+
}
|
|
47021
|
+
|
|
47022
|
+
return this.apiClient.callApi(
|
|
47023
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
47024
|
+
'DELETE',
|
|
47025
|
+
{ 'configId': configId },
|
|
47026
|
+
{ },
|
|
47027
|
+
{ },
|
|
47028
|
+
{ },
|
|
47029
|
+
null,
|
|
47030
|
+
['PureCloud OAuth'],
|
|
47031
|
+
['application/json'],
|
|
47032
|
+
['application/json'],
|
|
47033
|
+
opts['customHeaders']
|
|
47034
|
+
);
|
|
47035
|
+
}
|
|
47036
|
+
|
|
47037
|
+
/**
|
|
47038
|
+
* Delete a schema
|
|
47039
|
+
*
|
|
47040
|
+
* @param {String} schemaId Schema ID
|
|
47041
|
+
* @param {Object} opts Optional parameters
|
|
47042
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47043
|
+
*/
|
|
47044
|
+
deleteJourneyExternaleventsSchema(schemaId, opts) {
|
|
47045
|
+
opts = opts || {};
|
|
47046
|
+
|
|
47047
|
+
// verify the required parameter 'schemaId' is set
|
|
47048
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
47049
|
+
throw 'Missing the required parameter "schemaId" when calling deleteJourneyExternaleventsSchema';
|
|
47050
|
+
}
|
|
47051
|
+
|
|
47052
|
+
return this.apiClient.callApi(
|
|
47053
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
47054
|
+
'DELETE',
|
|
47055
|
+
{ 'schemaId': schemaId },
|
|
47056
|
+
{ },
|
|
47057
|
+
{ },
|
|
47058
|
+
{ },
|
|
47059
|
+
null,
|
|
47060
|
+
['PureCloud OAuth'],
|
|
47061
|
+
['application/json'],
|
|
47062
|
+
['application/json'],
|
|
47063
|
+
opts['customHeaders']
|
|
47064
|
+
);
|
|
47065
|
+
}
|
|
47066
|
+
|
|
46812
47067
|
/**
|
|
46813
47068
|
* Delete an outcome.
|
|
46814
47069
|
*
|
|
@@ -47369,6 +47624,263 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47369
47624
|
);
|
|
47370
47625
|
}
|
|
47371
47626
|
|
|
47627
|
+
/**
|
|
47628
|
+
* Get an external events configuration
|
|
47629
|
+
*
|
|
47630
|
+
* @param {String} configId The ID of the external event configuration.
|
|
47631
|
+
* @param {Object} opts Optional parameters
|
|
47632
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47633
|
+
*/
|
|
47634
|
+
getJourneyExternaleventsConfiguration(configId, opts) {
|
|
47635
|
+
opts = opts || {};
|
|
47636
|
+
|
|
47637
|
+
// verify the required parameter 'configId' is set
|
|
47638
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
47639
|
+
throw 'Missing the required parameter "configId" when calling getJourneyExternaleventsConfiguration';
|
|
47640
|
+
}
|
|
47641
|
+
|
|
47642
|
+
return this.apiClient.callApi(
|
|
47643
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
47644
|
+
'GET',
|
|
47645
|
+
{ 'configId': configId },
|
|
47646
|
+
{ },
|
|
47647
|
+
{ },
|
|
47648
|
+
{ },
|
|
47649
|
+
null,
|
|
47650
|
+
['PureCloud OAuth'],
|
|
47651
|
+
['application/json'],
|
|
47652
|
+
['application/json'],
|
|
47653
|
+
opts['customHeaders']
|
|
47654
|
+
);
|
|
47655
|
+
}
|
|
47656
|
+
|
|
47657
|
+
/**
|
|
47658
|
+
* Get all external event configurations.
|
|
47659
|
+
*
|
|
47660
|
+
* @param {Object} opts Optional parameters
|
|
47661
|
+
* @param {Number} opts.pageSize Page size (default to 20)
|
|
47662
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47663
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47664
|
+
*/
|
|
47665
|
+
getJourneyExternaleventsConfigurations(opts) {
|
|
47666
|
+
opts = opts || {};
|
|
47667
|
+
|
|
47668
|
+
|
|
47669
|
+
return this.apiClient.callApi(
|
|
47670
|
+
'/api/v2/journey/externalevents/configurations',
|
|
47671
|
+
'GET',
|
|
47672
|
+
{ },
|
|
47673
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
47674
|
+
{ },
|
|
47675
|
+
{ },
|
|
47676
|
+
null,
|
|
47677
|
+
['PureCloud OAuth'],
|
|
47678
|
+
['application/json'],
|
|
47679
|
+
['application/json'],
|
|
47680
|
+
opts['customHeaders']
|
|
47681
|
+
);
|
|
47682
|
+
}
|
|
47683
|
+
|
|
47684
|
+
/**
|
|
47685
|
+
* Get a schema
|
|
47686
|
+
*
|
|
47687
|
+
* @param {String} schemaId Schema ID
|
|
47688
|
+
* @param {Object} opts Optional parameters
|
|
47689
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47690
|
+
*/
|
|
47691
|
+
getJourneyExternaleventsSchema(schemaId, opts) {
|
|
47692
|
+
opts = opts || {};
|
|
47693
|
+
|
|
47694
|
+
// verify the required parameter 'schemaId' is set
|
|
47695
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
47696
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchema';
|
|
47697
|
+
}
|
|
47698
|
+
|
|
47699
|
+
return this.apiClient.callApi(
|
|
47700
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
47701
|
+
'GET',
|
|
47702
|
+
{ 'schemaId': schemaId },
|
|
47703
|
+
{ },
|
|
47704
|
+
{ },
|
|
47705
|
+
{ },
|
|
47706
|
+
null,
|
|
47707
|
+
['PureCloud OAuth'],
|
|
47708
|
+
['application/json'],
|
|
47709
|
+
['application/json'],
|
|
47710
|
+
opts['customHeaders']
|
|
47711
|
+
);
|
|
47712
|
+
}
|
|
47713
|
+
|
|
47714
|
+
/**
|
|
47715
|
+
* Get a specific version of a schema
|
|
47716
|
+
*
|
|
47717
|
+
* @param {String} schemaId Schema ID
|
|
47718
|
+
* @param {String} versionId Schema version
|
|
47719
|
+
* @param {Object} opts Optional parameters
|
|
47720
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47721
|
+
*/
|
|
47722
|
+
getJourneyExternaleventsSchemaVersion(schemaId, versionId, opts) {
|
|
47723
|
+
opts = opts || {};
|
|
47724
|
+
|
|
47725
|
+
// verify the required parameter 'schemaId' is set
|
|
47726
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
47727
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchemaVersion';
|
|
47728
|
+
}
|
|
47729
|
+
// verify the required parameter 'versionId' is set
|
|
47730
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
47731
|
+
throw 'Missing the required parameter "versionId" when calling getJourneyExternaleventsSchemaVersion';
|
|
47732
|
+
}
|
|
47733
|
+
|
|
47734
|
+
return this.apiClient.callApi(
|
|
47735
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}/versions/{versionId}',
|
|
47736
|
+
'GET',
|
|
47737
|
+
{ 'schemaId': schemaId,'versionId': versionId },
|
|
47738
|
+
{ },
|
|
47739
|
+
{ },
|
|
47740
|
+
{ },
|
|
47741
|
+
null,
|
|
47742
|
+
['PureCloud OAuth'],
|
|
47743
|
+
['application/json'],
|
|
47744
|
+
['application/json'],
|
|
47745
|
+
opts['customHeaders']
|
|
47746
|
+
);
|
|
47747
|
+
}
|
|
47748
|
+
|
|
47749
|
+
/**
|
|
47750
|
+
* Get all versions of a External Events schema
|
|
47751
|
+
*
|
|
47752
|
+
* @param {String} schemaId Schema ID
|
|
47753
|
+
* @param {Object} opts Optional parameters
|
|
47754
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47755
|
+
*/
|
|
47756
|
+
getJourneyExternaleventsSchemaVersions(schemaId, opts) {
|
|
47757
|
+
opts = opts || {};
|
|
47758
|
+
|
|
47759
|
+
// verify the required parameter 'schemaId' is set
|
|
47760
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
47761
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchemaVersions';
|
|
47762
|
+
}
|
|
47763
|
+
|
|
47764
|
+
return this.apiClient.callApi(
|
|
47765
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}/versions',
|
|
47766
|
+
'GET',
|
|
47767
|
+
{ 'schemaId': schemaId },
|
|
47768
|
+
{ },
|
|
47769
|
+
{ },
|
|
47770
|
+
{ },
|
|
47771
|
+
null,
|
|
47772
|
+
['PureCloud OAuth'],
|
|
47773
|
+
['application/json'],
|
|
47774
|
+
['application/json'],
|
|
47775
|
+
opts['customHeaders']
|
|
47776
|
+
);
|
|
47777
|
+
}
|
|
47778
|
+
|
|
47779
|
+
/**
|
|
47780
|
+
* Get a list of schemas.
|
|
47781
|
+
*
|
|
47782
|
+
* @param {Object} opts Optional parameters
|
|
47783
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47784
|
+
*/
|
|
47785
|
+
getJourneyExternaleventsSchemas(opts) {
|
|
47786
|
+
opts = opts || {};
|
|
47787
|
+
|
|
47788
|
+
|
|
47789
|
+
return this.apiClient.callApi(
|
|
47790
|
+
'/api/v2/journey/externalevents/schemas',
|
|
47791
|
+
'GET',
|
|
47792
|
+
{ },
|
|
47793
|
+
{ },
|
|
47794
|
+
{ },
|
|
47795
|
+
{ },
|
|
47796
|
+
null,
|
|
47797
|
+
['PureCloud OAuth'],
|
|
47798
|
+
['application/json'],
|
|
47799
|
+
['application/json'],
|
|
47800
|
+
opts['customHeaders']
|
|
47801
|
+
);
|
|
47802
|
+
}
|
|
47803
|
+
|
|
47804
|
+
/**
|
|
47805
|
+
* Get a core type from which all schemas are built
|
|
47806
|
+
*
|
|
47807
|
+
* @param {String} coreTypeName Name of core type
|
|
47808
|
+
* @param {Object} opts Optional parameters
|
|
47809
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47810
|
+
*/
|
|
47811
|
+
getJourneyExternaleventsSchemasCoretype(coreTypeName, opts) {
|
|
47812
|
+
opts = opts || {};
|
|
47813
|
+
|
|
47814
|
+
// verify the required parameter 'coreTypeName' is set
|
|
47815
|
+
if (coreTypeName === undefined || coreTypeName === null || coreTypeName === '') {
|
|
47816
|
+
throw 'Missing the required parameter "coreTypeName" when calling getJourneyExternaleventsSchemasCoretype';
|
|
47817
|
+
}
|
|
47818
|
+
|
|
47819
|
+
return this.apiClient.callApi(
|
|
47820
|
+
'/api/v2/journey/externalevents/schemas/coretypes/{coreTypeName}',
|
|
47821
|
+
'GET',
|
|
47822
|
+
{ 'coreTypeName': coreTypeName },
|
|
47823
|
+
{ },
|
|
47824
|
+
{ },
|
|
47825
|
+
{ },
|
|
47826
|
+
null,
|
|
47827
|
+
['PureCloud OAuth'],
|
|
47828
|
+
['application/json'],
|
|
47829
|
+
['application/json'],
|
|
47830
|
+
opts['customHeaders']
|
|
47831
|
+
);
|
|
47832
|
+
}
|
|
47833
|
+
|
|
47834
|
+
/**
|
|
47835
|
+
* Get the list of core types enabled for a specific namespace.
|
|
47836
|
+
*
|
|
47837
|
+
* @param {Object} opts Optional parameters
|
|
47838
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47839
|
+
*/
|
|
47840
|
+
getJourneyExternaleventsSchemasCoretypes(opts) {
|
|
47841
|
+
opts = opts || {};
|
|
47842
|
+
|
|
47843
|
+
|
|
47844
|
+
return this.apiClient.callApi(
|
|
47845
|
+
'/api/v2/journey/externalevents/schemas/coretypes',
|
|
47846
|
+
'GET',
|
|
47847
|
+
{ },
|
|
47848
|
+
{ },
|
|
47849
|
+
{ },
|
|
47850
|
+
{ },
|
|
47851
|
+
null,
|
|
47852
|
+
['PureCloud OAuth'],
|
|
47853
|
+
['application/json'],
|
|
47854
|
+
['application/json'],
|
|
47855
|
+
opts['customHeaders']
|
|
47856
|
+
);
|
|
47857
|
+
}
|
|
47858
|
+
|
|
47859
|
+
/**
|
|
47860
|
+
* Get quantitative limits on schemas
|
|
47861
|
+
*
|
|
47862
|
+
* @param {Object} opts Optional parameters
|
|
47863
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47864
|
+
*/
|
|
47865
|
+
getJourneyExternaleventsSchemasLimits(opts) {
|
|
47866
|
+
opts = opts || {};
|
|
47867
|
+
|
|
47868
|
+
|
|
47869
|
+
return this.apiClient.callApi(
|
|
47870
|
+
'/api/v2/journey/externalevents/schemas/limits',
|
|
47871
|
+
'GET',
|
|
47872
|
+
{ },
|
|
47873
|
+
{ },
|
|
47874
|
+
{ },
|
|
47875
|
+
{ },
|
|
47876
|
+
null,
|
|
47877
|
+
['PureCloud OAuth'],
|
|
47878
|
+
['application/json'],
|
|
47879
|
+
['application/json'],
|
|
47880
|
+
opts['customHeaders']
|
|
47881
|
+
);
|
|
47882
|
+
}
|
|
47883
|
+
|
|
47372
47884
|
/**
|
|
47373
47885
|
* Retrieve a single outcome.
|
|
47374
47886
|
*
|
|
@@ -48330,6 +48842,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48330
48842
|
);
|
|
48331
48843
|
}
|
|
48332
48844
|
|
|
48845
|
+
/**
|
|
48846
|
+
* Update an external events configuration.
|
|
48847
|
+
*
|
|
48848
|
+
* @param {String} configId The ID of the external event configuration.
|
|
48849
|
+
* @param {Object} opts Optional parameters
|
|
48850
|
+
* @param {Object} opts.body
|
|
48851
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48852
|
+
*/
|
|
48853
|
+
patchJourneyExternaleventsConfiguration(configId, opts) {
|
|
48854
|
+
opts = opts || {};
|
|
48855
|
+
|
|
48856
|
+
// verify the required parameter 'configId' is set
|
|
48857
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
48858
|
+
throw 'Missing the required parameter "configId" when calling patchJourneyExternaleventsConfiguration';
|
|
48859
|
+
}
|
|
48860
|
+
|
|
48861
|
+
return this.apiClient.callApi(
|
|
48862
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
48863
|
+
'PATCH',
|
|
48864
|
+
{ 'configId': configId },
|
|
48865
|
+
{ },
|
|
48866
|
+
{ },
|
|
48867
|
+
{ },
|
|
48868
|
+
opts['body'],
|
|
48869
|
+
['PureCloud OAuth'],
|
|
48870
|
+
['application/json'],
|
|
48871
|
+
['application/json'],
|
|
48872
|
+
opts['customHeaders']
|
|
48873
|
+
);
|
|
48874
|
+
}
|
|
48875
|
+
|
|
48333
48876
|
/**
|
|
48334
48877
|
* Update an outcome.
|
|
48335
48878
|
*
|
|
@@ -48708,6 +49251,93 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48708
49251
|
);
|
|
48709
49252
|
}
|
|
48710
49253
|
|
|
49254
|
+
/**
|
|
49255
|
+
* Create external events
|
|
49256
|
+
*
|
|
49257
|
+
* @param {String} configurationId The ID of the external event configuration.
|
|
49258
|
+
* @param {Object} opts Optional parameters
|
|
49259
|
+
* @param {Object} opts.body
|
|
49260
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49261
|
+
*/
|
|
49262
|
+
postJourneyExternaleventsConfigurationEvents(configurationId, opts) {
|
|
49263
|
+
opts = opts || {};
|
|
49264
|
+
|
|
49265
|
+
// verify the required parameter 'configurationId' is set
|
|
49266
|
+
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
49267
|
+
throw 'Missing the required parameter "configurationId" when calling postJourneyExternaleventsConfigurationEvents';
|
|
49268
|
+
}
|
|
49269
|
+
|
|
49270
|
+
return this.apiClient.callApi(
|
|
49271
|
+
'/api/v2/journey/externalevents/configurations/{configurationId}/events',
|
|
49272
|
+
'POST',
|
|
49273
|
+
{ 'configurationId': configurationId },
|
|
49274
|
+
{ },
|
|
49275
|
+
{ },
|
|
49276
|
+
{ },
|
|
49277
|
+
opts['body'],
|
|
49278
|
+
['PureCloud OAuth'],
|
|
49279
|
+
['application/json'],
|
|
49280
|
+
['application/json'],
|
|
49281
|
+
opts['customHeaders']
|
|
49282
|
+
);
|
|
49283
|
+
}
|
|
49284
|
+
|
|
49285
|
+
/**
|
|
49286
|
+
* Create an external events configuration.
|
|
49287
|
+
*
|
|
49288
|
+
* @param {Object} opts Optional parameters
|
|
49289
|
+
* @param {Object} opts.body
|
|
49290
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49291
|
+
*/
|
|
49292
|
+
postJourneyExternaleventsConfigurations(opts) {
|
|
49293
|
+
opts = opts || {};
|
|
49294
|
+
|
|
49295
|
+
|
|
49296
|
+
return this.apiClient.callApi(
|
|
49297
|
+
'/api/v2/journey/externalevents/configurations',
|
|
49298
|
+
'POST',
|
|
49299
|
+
{ },
|
|
49300
|
+
{ },
|
|
49301
|
+
{ },
|
|
49302
|
+
{ },
|
|
49303
|
+
opts['body'],
|
|
49304
|
+
['PureCloud OAuth'],
|
|
49305
|
+
['application/json'],
|
|
49306
|
+
['application/json'],
|
|
49307
|
+
opts['customHeaders']
|
|
49308
|
+
);
|
|
49309
|
+
}
|
|
49310
|
+
|
|
49311
|
+
/**
|
|
49312
|
+
* Create a schema
|
|
49313
|
+
*
|
|
49314
|
+
* @param {Object} body Schema create request body
|
|
49315
|
+
* @param {Object} opts Optional parameters
|
|
49316
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49317
|
+
*/
|
|
49318
|
+
postJourneyExternaleventsSchemas(body, opts) {
|
|
49319
|
+
opts = opts || {};
|
|
49320
|
+
|
|
49321
|
+
// verify the required parameter 'body' is set
|
|
49322
|
+
if (body === undefined || body === null) {
|
|
49323
|
+
throw 'Missing the required parameter "body" when calling postJourneyExternaleventsSchemas';
|
|
49324
|
+
}
|
|
49325
|
+
|
|
49326
|
+
return this.apiClient.callApi(
|
|
49327
|
+
'/api/v2/journey/externalevents/schemas',
|
|
49328
|
+
'POST',
|
|
49329
|
+
{ },
|
|
49330
|
+
{ },
|
|
49331
|
+
{ },
|
|
49332
|
+
{ },
|
|
49333
|
+
body,
|
|
49334
|
+
['PureCloud OAuth'],
|
|
49335
|
+
['application/json'],
|
|
49336
|
+
['application/json'],
|
|
49337
|
+
opts['customHeaders']
|
|
49338
|
+
);
|
|
49339
|
+
}
|
|
49340
|
+
|
|
48711
49341
|
/**
|
|
48712
49342
|
* Query for flow paths.
|
|
48713
49343
|
*
|
|
@@ -49000,6 +49630,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49000
49630
|
);
|
|
49001
49631
|
}
|
|
49002
49632
|
|
|
49633
|
+
/**
|
|
49634
|
+
* Update a schema
|
|
49635
|
+
*
|
|
49636
|
+
* @param {String} schemaId Schema ID
|
|
49637
|
+
* @param {Object} body Schema update request body
|
|
49638
|
+
* @param {Object} opts Optional parameters
|
|
49639
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49640
|
+
*/
|
|
49641
|
+
putJourneyExternaleventsSchema(schemaId, body, opts) {
|
|
49642
|
+
opts = opts || {};
|
|
49643
|
+
|
|
49644
|
+
// verify the required parameter 'schemaId' is set
|
|
49645
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
49646
|
+
throw 'Missing the required parameter "schemaId" when calling putJourneyExternaleventsSchema';
|
|
49647
|
+
}
|
|
49648
|
+
// verify the required parameter 'body' is set
|
|
49649
|
+
if (body === undefined || body === null) {
|
|
49650
|
+
throw 'Missing the required parameter "body" when calling putJourneyExternaleventsSchema';
|
|
49651
|
+
}
|
|
49652
|
+
|
|
49653
|
+
return this.apiClient.callApi(
|
|
49654
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
49655
|
+
'PUT',
|
|
49656
|
+
{ 'schemaId': schemaId },
|
|
49657
|
+
{ },
|
|
49658
|
+
{ },
|
|
49659
|
+
{ },
|
|
49660
|
+
body,
|
|
49661
|
+
['PureCloud OAuth'],
|
|
49662
|
+
['application/json'],
|
|
49663
|
+
['application/json'],
|
|
49664
|
+
opts['customHeaders']
|
|
49665
|
+
);
|
|
49666
|
+
}
|
|
49667
|
+
|
|
49003
49668
|
/**
|
|
49004
49669
|
* Update the Schedule for a JourneyView
|
|
49005
49670
|
*
|
|
@@ -49081,7 +49746,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49081
49746
|
/**
|
|
49082
49747
|
* Knowledge service.
|
|
49083
49748
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
49084
|
-
* @version
|
|
49749
|
+
* @version 250.1.0
|
|
49085
49750
|
*/
|
|
49086
49751
|
|
|
49087
49752
|
/**
|
|
@@ -53289,7 +53954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53289
53954
|
/**
|
|
53290
53955
|
* LanguageUnderstanding service.
|
|
53291
53956
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
53292
|
-
* @version
|
|
53957
|
+
* @version 250.1.0
|
|
53293
53958
|
*/
|
|
53294
53959
|
|
|
53295
53960
|
/**
|
|
@@ -54663,7 +55328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54663
55328
|
/**
|
|
54664
55329
|
* Languages service.
|
|
54665
55330
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
54666
|
-
* @version
|
|
55331
|
+
* @version 250.1.0
|
|
54667
55332
|
*/
|
|
54668
55333
|
|
|
54669
55334
|
/**
|
|
@@ -54922,7 +55587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54922
55587
|
/**
|
|
54923
55588
|
* Learning service.
|
|
54924
55589
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
54925
|
-
* @version
|
|
55590
|
+
* @version 250.1.0
|
|
54926
55591
|
*/
|
|
54927
55592
|
|
|
54928
55593
|
/**
|
|
@@ -56170,7 +56835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56170
56835
|
/**
|
|
56171
56836
|
* License service.
|
|
56172
56837
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
56173
|
-
* @version
|
|
56838
|
+
* @version 250.1.0
|
|
56174
56839
|
*/
|
|
56175
56840
|
|
|
56176
56841
|
/**
|
|
@@ -56468,7 +57133,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56468
57133
|
/**
|
|
56469
57134
|
* Locations service.
|
|
56470
57135
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
56471
|
-
* @version
|
|
57136
|
+
* @version 250.1.0
|
|
56472
57137
|
*/
|
|
56473
57138
|
|
|
56474
57139
|
/**
|
|
@@ -56735,7 +57400,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56735
57400
|
/**
|
|
56736
57401
|
* LogCapture service.
|
|
56737
57402
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
56738
|
-
* @version
|
|
57403
|
+
* @version 250.1.0
|
|
56739
57404
|
*/
|
|
56740
57405
|
|
|
56741
57406
|
/**
|
|
@@ -56957,7 +57622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56957
57622
|
/**
|
|
56958
57623
|
* Messaging service.
|
|
56959
57624
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
56960
|
-
* @version
|
|
57625
|
+
* @version 250.1.0
|
|
56961
57626
|
*/
|
|
56962
57627
|
|
|
56963
57628
|
/**
|
|
@@ -57375,7 +58040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57375
58040
|
/**
|
|
57376
58041
|
* MobileDevices service.
|
|
57377
58042
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
57378
|
-
* @version
|
|
58043
|
+
* @version 250.1.0
|
|
57379
58044
|
*/
|
|
57380
58045
|
|
|
57381
58046
|
/**
|
|
@@ -57545,7 +58210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57545
58210
|
/**
|
|
57546
58211
|
* Notifications service.
|
|
57547
58212
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
57548
|
-
* @version
|
|
58213
|
+
* @version 250.1.0
|
|
57549
58214
|
*/
|
|
57550
58215
|
|
|
57551
58216
|
/**
|
|
@@ -57806,7 +58471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57806
58471
|
/**
|
|
57807
58472
|
* OAuth service.
|
|
57808
58473
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
57809
|
-
* @version
|
|
58474
|
+
* @version 250.1.0
|
|
57810
58475
|
*/
|
|
57811
58476
|
|
|
57812
58477
|
/**
|
|
@@ -58222,7 +58887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58222
58887
|
/**
|
|
58223
58888
|
* Objects service.
|
|
58224
58889
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
58225
|
-
* @version
|
|
58890
|
+
* @version 250.1.0
|
|
58226
58891
|
*/
|
|
58227
58892
|
|
|
58228
58893
|
/**
|
|
@@ -58586,7 +59251,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58586
59251
|
/**
|
|
58587
59252
|
* OperationalEvents service.
|
|
58588
59253
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
58589
|
-
* @version
|
|
59254
|
+
* @version 250.1.0
|
|
58590
59255
|
*/
|
|
58591
59256
|
|
|
58592
59257
|
/**
|
|
@@ -58717,7 +59382,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58717
59382
|
/**
|
|
58718
59383
|
* Organization service.
|
|
58719
59384
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
58720
|
-
* @version
|
|
59385
|
+
* @version 250.1.0
|
|
58721
59386
|
*/
|
|
58722
59387
|
|
|
58723
59388
|
/**
|
|
@@ -59278,7 +59943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59278
59943
|
/**
|
|
59279
59944
|
* OrganizationAuthorization service.
|
|
59280
59945
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
59281
|
-
* @version
|
|
59946
|
+
* @version 250.1.0
|
|
59282
59947
|
*/
|
|
59283
59948
|
|
|
59284
59949
|
/**
|
|
@@ -60882,7 +61547,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60882
61547
|
/**
|
|
60883
61548
|
* Outbound service.
|
|
60884
61549
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
60885
|
-
* @version
|
|
61550
|
+
* @version 250.1.0
|
|
60886
61551
|
*/
|
|
60887
61552
|
|
|
60888
61553
|
/**
|
|
@@ -66469,7 +67134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66469
67134
|
/**
|
|
66470
67135
|
* Presence service.
|
|
66471
67136
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
66472
|
-
* @version
|
|
67137
|
+
* @version 250.1.0
|
|
66473
67138
|
*/
|
|
66474
67139
|
|
|
66475
67140
|
/**
|
|
@@ -67327,7 +67992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67327
67992
|
/**
|
|
67328
67993
|
* ProcessAutomation service.
|
|
67329
67994
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
67330
|
-
* @version
|
|
67995
|
+
* @version 250.1.0
|
|
67331
67996
|
*/
|
|
67332
67997
|
|
|
67333
67998
|
/**
|
|
@@ -67594,7 +68259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67594
68259
|
/**
|
|
67595
68260
|
* Quality service.
|
|
67596
68261
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
67597
|
-
* @version
|
|
68262
|
+
* @version 250.1.0
|
|
67598
68263
|
*/
|
|
67599
68264
|
|
|
67600
68265
|
/**
|
|
@@ -69952,7 +70617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69952
70617
|
/**
|
|
69953
70618
|
* Recording service.
|
|
69954
70619
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
69955
|
-
* @version
|
|
70620
|
+
* @version 250.1.0
|
|
69956
70621
|
*/
|
|
69957
70622
|
|
|
69958
70623
|
/**
|
|
@@ -70189,7 +70854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70189
70854
|
|
|
70190
70855
|
/**
|
|
70191
70856
|
* Gets a specific recording.
|
|
70192
|
-
*
|
|
70857
|
+
* 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.
|
|
70193
70858
|
* @param {String} conversationId Conversation ID
|
|
70194
70859
|
* @param {String} recordingId Recording ID
|
|
70195
70860
|
* @param {Object} opts Optional parameters
|
|
@@ -70336,7 +71001,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70336
71001
|
}
|
|
70337
71002
|
|
|
70338
71003
|
/**
|
|
70339
|
-
* Get metadata for a specific recording. Does not return playable media.
|
|
71004
|
+
* 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.
|
|
70340
71005
|
*
|
|
70341
71006
|
* @param {String} conversationId Conversation ID
|
|
70342
71007
|
* @param {String} recordingId Recording ID
|
|
@@ -70372,7 +71037,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70372
71037
|
|
|
70373
71038
|
/**
|
|
70374
71039
|
* Get all of a Conversation's Recordings.
|
|
70375
|
-
*
|
|
71040
|
+
* 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.
|
|
70376
71041
|
* @param {String} conversationId Conversation ID
|
|
70377
71042
|
* @param {Object} opts Optional parameters
|
|
70378
71043
|
* @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)
|
|
@@ -71057,7 +71722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71057
71722
|
|
|
71058
71723
|
/**
|
|
71059
71724
|
* Create annotation
|
|
71060
|
-
*
|
|
71725
|
+
* 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.
|
|
71061
71726
|
* @param {String} conversationId Conversation ID
|
|
71062
71727
|
* @param {String} recordingId Recording ID
|
|
71063
71728
|
* @param {Object} body annotation
|
|
@@ -71096,7 +71761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71096
71761
|
}
|
|
71097
71762
|
|
|
71098
71763
|
/**
|
|
71099
|
-
* Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.
|
|
71764
|
+
* 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.
|
|
71100
71765
|
*
|
|
71101
71766
|
* @param {Object} body Job submission criteria
|
|
71102
71767
|
* @param {Object} opts Optional parameters
|
|
@@ -71452,7 +72117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71452
72117
|
|
|
71453
72118
|
/**
|
|
71454
72119
|
* Updates the retention records on a recording.
|
|
71455
|
-
* 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.
|
|
72120
|
+
* 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.
|
|
71456
72121
|
* @param {String} conversationId Conversation ID
|
|
71457
72122
|
* @param {String} recordingId Recording ID
|
|
71458
72123
|
* @param {Object} body recording
|
|
@@ -71493,7 +72158,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71493
72158
|
|
|
71494
72159
|
/**
|
|
71495
72160
|
* Update annotation
|
|
71496
|
-
*
|
|
72161
|
+
* 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.
|
|
71497
72162
|
* @param {String} conversationId Conversation ID
|
|
71498
72163
|
* @param {String} recordingId Recording ID
|
|
71499
72164
|
* @param {String} annotationId Annotation ID
|
|
@@ -71800,7 +72465,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71800
72465
|
/**
|
|
71801
72466
|
* ResponseManagement service.
|
|
71802
72467
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
71803
|
-
* @version
|
|
72468
|
+
* @version 250.1.0
|
|
71804
72469
|
*/
|
|
71805
72470
|
|
|
71806
72471
|
/**
|
|
@@ -72445,7 +73110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72445
73110
|
/**
|
|
72446
73111
|
* Routing service.
|
|
72447
73112
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
72448
|
-
* @version
|
|
73113
|
+
* @version 250.1.0
|
|
72449
73114
|
*/
|
|
72450
73115
|
|
|
72451
73116
|
/**
|
|
@@ -77832,7 +78497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77832
78497
|
/**
|
|
77833
78498
|
* SCIM service.
|
|
77834
78499
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
77835
|
-
* @version
|
|
78500
|
+
* @version 250.1.0
|
|
77836
78501
|
*/
|
|
77837
78502
|
|
|
77838
78503
|
/**
|
|
@@ -78793,7 +79458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78793
79458
|
/**
|
|
78794
79459
|
* Scripts service.
|
|
78795
79460
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
78796
|
-
* @version
|
|
79461
|
+
* @version 250.1.0
|
|
78797
79462
|
*/
|
|
78798
79463
|
|
|
78799
79464
|
/**
|
|
@@ -79302,7 +79967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79302
79967
|
/**
|
|
79303
79968
|
* Search service.
|
|
79304
79969
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
79305
|
-
* @version
|
|
79970
|
+
* @version 250.1.0
|
|
79306
79971
|
*/
|
|
79307
79972
|
|
|
79308
79973
|
/**
|
|
@@ -80118,7 +80783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80118
80783
|
/**
|
|
80119
80784
|
* Settings service.
|
|
80120
80785
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
80121
|
-
* @version
|
|
80786
|
+
* @version 250.1.0
|
|
80122
80787
|
*/
|
|
80123
80788
|
|
|
80124
80789
|
/**
|
|
@@ -80527,7 +81192,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80527
81192
|
/**
|
|
80528
81193
|
* SocialMedia service.
|
|
80529
81194
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
80530
|
-
* @version
|
|
81195
|
+
* @version 250.1.0
|
|
80531
81196
|
*/
|
|
80532
81197
|
|
|
80533
81198
|
/**
|
|
@@ -82512,7 +83177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82512
83177
|
/**
|
|
82513
83178
|
* SpeechTextAnalytics service.
|
|
82514
83179
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
82515
|
-
* @version
|
|
83180
|
+
* @version 250.1.0
|
|
82516
83181
|
*/
|
|
82517
83182
|
|
|
82518
83183
|
/**
|
|
@@ -84463,7 +85128,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84463
85128
|
/**
|
|
84464
85129
|
* Stations service.
|
|
84465
85130
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
84466
|
-
* @version
|
|
85131
|
+
* @version 250.1.0
|
|
84467
85132
|
*/
|
|
84468
85133
|
|
|
84469
85134
|
/**
|
|
@@ -84577,7 +85242,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84577
85242
|
/**
|
|
84578
85243
|
* Suggest service.
|
|
84579
85244
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
84580
|
-
* @version
|
|
85245
|
+
* @version 250.1.0
|
|
84581
85246
|
*/
|
|
84582
85247
|
|
|
84583
85248
|
/**
|
|
@@ -84724,7 +85389,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84724
85389
|
/**
|
|
84725
85390
|
* TaskManagement service.
|
|
84726
85391
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
84727
|
-
* @version
|
|
85392
|
+
* @version 250.1.0
|
|
84728
85393
|
*/
|
|
84729
85394
|
|
|
84730
85395
|
/**
|
|
@@ -87220,7 +87885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
87220
87885
|
/**
|
|
87221
87886
|
* Teams service.
|
|
87222
87887
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
87223
|
-
* @version
|
|
87888
|
+
* @version 250.1.0
|
|
87224
87889
|
*/
|
|
87225
87890
|
|
|
87226
87891
|
/**
|
|
@@ -87563,7 +88228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
87563
88228
|
/**
|
|
87564
88229
|
* Telephony service.
|
|
87565
88230
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
87566
|
-
* @version
|
|
88231
|
+
* @version 250.1.0
|
|
87567
88232
|
*/
|
|
87568
88233
|
|
|
87569
88234
|
/**
|
|
@@ -87970,7 +88635,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
87970
88635
|
/**
|
|
87971
88636
|
* TelephonyProvidersEdge service.
|
|
87972
88637
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
87973
|
-
* @version
|
|
88638
|
+
* @version 250.1.0
|
|
87974
88639
|
*/
|
|
87975
88640
|
|
|
87976
88641
|
/**
|
|
@@ -91994,7 +92659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
91994
92659
|
/**
|
|
91995
92660
|
* Textbots service.
|
|
91996
92661
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
91997
|
-
* @version
|
|
92662
|
+
* @version 250.1.0
|
|
91998
92663
|
*/
|
|
91999
92664
|
|
|
92000
92665
|
/**
|
|
@@ -92140,7 +92805,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
92140
92805
|
/**
|
|
92141
92806
|
* Tokens service.
|
|
92142
92807
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
92143
|
-
* @version
|
|
92808
|
+
* @version 250.1.0
|
|
92144
92809
|
*/
|
|
92145
92810
|
|
|
92146
92811
|
/**
|
|
@@ -92318,7 +92983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
92318
92983
|
/**
|
|
92319
92984
|
* Uploads service.
|
|
92320
92985
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
92321
|
-
* @version
|
|
92986
|
+
* @version 250.1.0
|
|
92322
92987
|
*/
|
|
92323
92988
|
|
|
92324
92989
|
/**
|
|
@@ -92689,7 +93354,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
92689
93354
|
/**
|
|
92690
93355
|
* Usage service.
|
|
92691
93356
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
92692
|
-
* @version
|
|
93357
|
+
* @version 250.1.0
|
|
92693
93358
|
*/
|
|
92694
93359
|
|
|
92695
93360
|
/**
|
|
@@ -93067,7 +93732,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93067
93732
|
/**
|
|
93068
93733
|
* UserRecordings service.
|
|
93069
93734
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
93070
|
-
* @version
|
|
93735
|
+
* @version 250.1.0
|
|
93071
93736
|
*/
|
|
93072
93737
|
|
|
93073
93738
|
/**
|
|
@@ -93269,7 +93934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93269
93934
|
/**
|
|
93270
93935
|
* Users service.
|
|
93271
93936
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
93272
|
-
* @version
|
|
93937
|
+
* @version 250.1.0
|
|
93273
93938
|
*/
|
|
93274
93939
|
|
|
93275
93940
|
/**
|
|
@@ -93507,7 +94172,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93507
94172
|
* @param {String} schemaId schemaId
|
|
93508
94173
|
* @param {Object} opts Optional parameters
|
|
93509
94174
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
93510
|
-
* deleteUserCustomattribute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
93511
94175
|
*/
|
|
93512
94176
|
deleteUserCustomattribute(userId, schemaId, opts) {
|
|
93513
94177
|
opts = opts || {};
|
|
@@ -93747,7 +94411,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93747
94411
|
* @param {String} schemaId Schema ID
|
|
93748
94412
|
* @param {Object} opts Optional parameters
|
|
93749
94413
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
93750
|
-
* deleteUsersCustomattributesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
93751
94414
|
*/
|
|
93752
94415
|
deleteUsersCustomattributesSchema(schemaId, opts) {
|
|
93753
94416
|
opts = opts || {};
|
|
@@ -94237,6 +94900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94237
94900
|
* @param {Object} opts Optional parameters
|
|
94238
94901
|
* @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.
|
|
94239
94902
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
94903
|
+
* @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
|
|
94240
94904
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
94241
94905
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94242
94906
|
*/
|
|
@@ -94252,7 +94916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94252
94916
|
'/api/v2/users/{userId}',
|
|
94253
94917
|
'GET',
|
|
94254
94918
|
{ 'userId': userId },
|
|
94255
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
94919
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi'),'state': opts['state'] },
|
|
94256
94920
|
{ },
|
|
94257
94921
|
{ },
|
|
94258
94922
|
null,
|
|
@@ -94331,7 +94995,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94331
94995
|
* @param {String} schemaId schemaId
|
|
94332
94996
|
* @param {Object} opts Optional parameters
|
|
94333
94997
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94334
|
-
* getUserCustomattribute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
94335
94998
|
*/
|
|
94336
94999
|
getUserCustomattribute(userId, schemaId, opts) {
|
|
94337
95000
|
opts = opts || {};
|
|
@@ -94367,7 +95030,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94367
95030
|
* @param {Array.<String>} schemaIds
|
|
94368
95031
|
* @param {Object} opts Optional parameters
|
|
94369
95032
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94370
|
-
* getUserCustomattributesBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
94371
95033
|
*/
|
|
94372
95034
|
getUserCustomattributesBulk(userId, schemaIds, opts) {
|
|
94373
95035
|
opts = opts || {};
|
|
@@ -95012,6 +95674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95012
95674
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
95013
95675
|
* @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.
|
|
95014
95676
|
* @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.
|
|
95677
|
+
* @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
|
|
95015
95678
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
95016
95679
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95017
95680
|
*/
|
|
@@ -95023,7 +95686,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95023
95686
|
'/api/v2/users',
|
|
95024
95687
|
'GET',
|
|
95025
95688
|
{ },
|
|
95026
|
-
{ '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'] },
|
|
95689
|
+
{ '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'] },
|
|
95027
95690
|
{ },
|
|
95028
95691
|
{ },
|
|
95029
95692
|
null,
|
|
@@ -95068,7 +95731,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95068
95731
|
* @param {String} schemaId Schema ID
|
|
95069
95732
|
* @param {Object} opts Optional parameters
|
|
95070
95733
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95071
|
-
* getUsersCustomattributesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95072
95734
|
*/
|
|
95073
95735
|
getUsersCustomattributesSchema(schemaId, opts) {
|
|
95074
95736
|
opts = opts || {};
|
|
@@ -95100,7 +95762,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95100
95762
|
* @param {String} versionId Schema version
|
|
95101
95763
|
* @param {Object} opts Optional parameters
|
|
95102
95764
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95103
|
-
* getUsersCustomattributesSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95104
95765
|
*/
|
|
95105
95766
|
getUsersCustomattributesSchemaVersion(schemaId, versionId, opts) {
|
|
95106
95767
|
opts = opts || {};
|
|
@@ -95135,7 +95796,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95135
95796
|
* @param {String} schemaId Schema ID
|
|
95136
95797
|
* @param {Object} opts Optional parameters
|
|
95137
95798
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95138
|
-
* getUsersCustomattributesSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95139
95799
|
*/
|
|
95140
95800
|
getUsersCustomattributesSchemaVersions(schemaId, opts) {
|
|
95141
95801
|
opts = opts || {};
|
|
@@ -95165,7 +95825,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95165
95825
|
*
|
|
95166
95826
|
* @param {Object} opts Optional parameters
|
|
95167
95827
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95168
|
-
* getUsersCustomattributesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95169
95828
|
*/
|
|
95170
95829
|
getUsersCustomattributesSchemas(opts) {
|
|
95171
95830
|
opts = opts || {};
|
|
@@ -95192,7 +95851,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95192
95851
|
* @param {String} coreTypeName Name of the core type
|
|
95193
95852
|
* @param {Object} opts Optional parameters
|
|
95194
95853
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95195
|
-
* getUsersCustomattributesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95196
95854
|
*/
|
|
95197
95855
|
getUsersCustomattributesSchemasCoretype(coreTypeName, opts) {
|
|
95198
95856
|
opts = opts || {};
|
|
@@ -95222,7 +95880,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95222
95880
|
*
|
|
95223
95881
|
* @param {Object} opts Optional parameters
|
|
95224
95882
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95225
|
-
* getUsersCustomattributesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95226
95883
|
*/
|
|
95227
95884
|
getUsersCustomattributesSchemasCoretypes(opts) {
|
|
95228
95885
|
opts = opts || {};
|
|
@@ -95248,7 +95905,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95248
95905
|
*
|
|
95249
95906
|
* @param {Object} opts Optional parameters
|
|
95250
95907
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95251
|
-
* getUsersCustomattributesSchemasLimits is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95252
95908
|
*/
|
|
95253
95909
|
getUsersCustomattributesSchemasLimits(opts) {
|
|
95254
95910
|
opts = opts || {};
|
|
@@ -95419,6 +96075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95419
96075
|
* @param {Object} opts Optional parameters
|
|
95420
96076
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
95421
96077
|
* @param {Object} opts.integrationPresenceSource Get your presence for a given integration. This parameter will only be used when presence is provided as an expand.
|
|
96078
|
+
* @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
|
|
95422
96079
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95423
96080
|
*/
|
|
95424
96081
|
getUsersMe(opts) {
|
|
@@ -95429,7 +96086,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95429
96086
|
'/api/v2/users/me',
|
|
95430
96087
|
'GET',
|
|
95431
96088
|
{ },
|
|
95432
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'] },
|
|
96089
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi') },
|
|
95433
96090
|
{ },
|
|
95434
96091
|
{ },
|
|
95435
96092
|
null,
|
|
@@ -95449,6 +96106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95449
96106
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
95450
96107
|
* @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.
|
|
95451
96108
|
* @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.
|
|
96109
|
+
* @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
|
|
95452
96110
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
95453
96111
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95454
96112
|
* getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
@@ -95461,7 +96119,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95461
96119
|
'/api/v2/users/query',
|
|
95462
96120
|
'GET',
|
|
95463
96121
|
{ },
|
|
95464
|
-
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
96122
|
+
{ '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'] },
|
|
95465
96123
|
{ },
|
|
95466
96124
|
{ },
|
|
95467
96125
|
null,
|
|
@@ -95581,7 +96239,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95581
96239
|
* @param {Object} userCustomAttributes
|
|
95582
96240
|
* @param {Object} opts Optional parameters
|
|
95583
96241
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95584
|
-
* patchUserCustomattributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95585
96242
|
*/
|
|
95586
96243
|
patchUserCustomattributes(userId, userCustomAttributes, opts) {
|
|
95587
96244
|
opts = opts || {};
|
|
@@ -95617,7 +96274,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95617
96274
|
* @param {Array.<Object>} userCustomAttributesList
|
|
95618
96275
|
* @param {Object} opts Optional parameters
|
|
95619
96276
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95620
|
-
* patchUserCustomattributesBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95621
96277
|
*/
|
|
95622
96278
|
patchUserCustomattributesBulk(userId, userCustomAttributesList, opts) {
|
|
95623
96279
|
opts = opts || {};
|
|
@@ -96440,7 +97096,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96440
97096
|
* @param {Object} body Schema
|
|
96441
97097
|
* @param {Object} opts Optional parameters
|
|
96442
97098
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96443
|
-
* postUsersCustomattributesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
96444
97099
|
*/
|
|
96445
97100
|
postUsersCustomattributesSchemas(body, opts) {
|
|
96446
97101
|
opts = opts || {};
|
|
@@ -96789,7 +97444,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
96789
97444
|
* @param {Object} userCustomAttributes
|
|
96790
97445
|
* @param {Object} opts Optional parameters
|
|
96791
97446
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
96792
|
-
* putUserCustomattributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
96793
97447
|
*/
|
|
96794
97448
|
putUserCustomattributes(userId, userCustomAttributes, opts) {
|
|
96795
97449
|
opts = opts || {};
|
|
@@ -97185,7 +97839,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
97185
97839
|
* @param {Object} body Data Schema
|
|
97186
97840
|
* @param {Object} opts Optional parameters
|
|
97187
97841
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
97188
|
-
* putUsersCustomattributesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
97189
97842
|
*/
|
|
97190
97843
|
putUsersCustomattributesSchema(schemaId, body, opts) {
|
|
97191
97844
|
opts = opts || {};
|
|
@@ -97220,7 +97873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
97220
97873
|
/**
|
|
97221
97874
|
* UsersRules service.
|
|
97222
97875
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
97223
|
-
* @version
|
|
97876
|
+
* @version 250.1.0
|
|
97224
97877
|
*/
|
|
97225
97878
|
|
|
97226
97879
|
/**
|
|
@@ -97537,7 +98190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
97537
98190
|
/**
|
|
97538
98191
|
* Utilities service.
|
|
97539
98192
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
97540
|
-
* @version
|
|
98193
|
+
* @version 250.1.0
|
|
97541
98194
|
*/
|
|
97542
98195
|
|
|
97543
98196
|
/**
|
|
@@ -97665,7 +98318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
97665
98318
|
/**
|
|
97666
98319
|
* Voicemail service.
|
|
97667
98320
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
97668
|
-
* @version
|
|
98321
|
+
* @version 250.1.0
|
|
97669
98322
|
*/
|
|
97670
98323
|
|
|
97671
98324
|
/**
|
|
@@ -98495,7 +99148,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98495
99148
|
/**
|
|
98496
99149
|
* WebChat service.
|
|
98497
99150
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
98498
|
-
* @version
|
|
99151
|
+
* @version 250.1.0
|
|
98499
99152
|
*/
|
|
98500
99153
|
|
|
98501
99154
|
/**
|
|
@@ -99147,7 +99800,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99147
99800
|
/**
|
|
99148
99801
|
* WebDeployments service.
|
|
99149
99802
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
99150
|
-
* @version
|
|
99803
|
+
* @version 250.1.0
|
|
99151
99804
|
*/
|
|
99152
99805
|
|
|
99153
99806
|
/**
|
|
@@ -99825,7 +100478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99825
100478
|
/**
|
|
99826
100479
|
* WebMessaging service.
|
|
99827
100480
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
99828
|
-
* @version
|
|
100481
|
+
* @version 250.1.0
|
|
99829
100482
|
*/
|
|
99830
100483
|
|
|
99831
100484
|
/**
|
|
@@ -99988,7 +100641,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99988
100641
|
/**
|
|
99989
100642
|
* Widgets service.
|
|
99990
100643
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
99991
|
-
* @version
|
|
100644
|
+
* @version 250.1.0
|
|
99992
100645
|
*/
|
|
99993
100646
|
|
|
99994
100647
|
/**
|
|
@@ -100164,7 +100817,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100164
100817
|
/**
|
|
100165
100818
|
* WorkforceManagement service.
|
|
100166
100819
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
100167
|
-
* @version
|
|
100820
|
+
* @version 250.1.0
|
|
100168
100821
|
*/
|
|
100169
100822
|
|
|
100170
100823
|
/**
|
|
@@ -102299,6 +102952,181 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
102299
102952
|
);
|
|
102300
102953
|
}
|
|
102301
102954
|
|
|
102955
|
+
/**
|
|
102956
|
+
* 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
|
|
102957
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
102958
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
102959
|
+
* @param {String} jobId The ID of the job
|
|
102960
|
+
* @param {Object} opts Optional parameters
|
|
102961
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
102962
|
+
*/
|
|
102963
|
+
getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob(businessUnitId, jobId, opts) {
|
|
102964
|
+
opts = opts || {};
|
|
102965
|
+
|
|
102966
|
+
// verify the required parameter 'businessUnitId' is set
|
|
102967
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
102968
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob';
|
|
102969
|
+
}
|
|
102970
|
+
// verify the required parameter 'jobId' is set
|
|
102971
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
102972
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob';
|
|
102973
|
+
}
|
|
102974
|
+
|
|
102975
|
+
return this.apiClient.callApi(
|
|
102976
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs/{jobId}',
|
|
102977
|
+
'GET',
|
|
102978
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
102979
|
+
{ },
|
|
102980
|
+
{ },
|
|
102981
|
+
{ },
|
|
102982
|
+
null,
|
|
102983
|
+
['PureCloud OAuth'],
|
|
102984
|
+
['application/json'],
|
|
102985
|
+
['application/json'],
|
|
102986
|
+
opts['customHeaders']
|
|
102987
|
+
);
|
|
102988
|
+
}
|
|
102989
|
+
|
|
102990
|
+
/**
|
|
102991
|
+
* 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
|
|
102992
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
102993
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
102994
|
+
* @param {String} jobId The ID of the job
|
|
102995
|
+
* @param {Object} opts Optional parameters
|
|
102996
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
102997
|
+
*/
|
|
102998
|
+
getWorkforcemanagementBusinessunitShifttradingTradesQueryJob(businessUnitId, jobId, opts) {
|
|
102999
|
+
opts = opts || {};
|
|
103000
|
+
|
|
103001
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103002
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103003
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingTradesQueryJob';
|
|
103004
|
+
}
|
|
103005
|
+
// verify the required parameter 'jobId' is set
|
|
103006
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
103007
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingTradesQueryJob';
|
|
103008
|
+
}
|
|
103009
|
+
|
|
103010
|
+
return this.apiClient.callApi(
|
|
103011
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs/{jobId}',
|
|
103012
|
+
'GET',
|
|
103013
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
103014
|
+
{ },
|
|
103015
|
+
{ },
|
|
103016
|
+
{ },
|
|
103017
|
+
null,
|
|
103018
|
+
['PureCloud OAuth'],
|
|
103019
|
+
['application/json'],
|
|
103020
|
+
['application/json'],
|
|
103021
|
+
opts['customHeaders']
|
|
103022
|
+
);
|
|
103023
|
+
}
|
|
103024
|
+
|
|
103025
|
+
/**
|
|
103026
|
+
* View results of bulk update trades states operation. Only the user who started the operation can query the status.
|
|
103027
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
103028
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
103029
|
+
* @param {String} jobId The ID of the job
|
|
103030
|
+
* @param {Object} opts Optional parameters
|
|
103031
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103032
|
+
*/
|
|
103033
|
+
getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob(businessUnitId, jobId, opts) {
|
|
103034
|
+
opts = opts || {};
|
|
103035
|
+
|
|
103036
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103037
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103038
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob';
|
|
103039
|
+
}
|
|
103040
|
+
// verify the required parameter 'jobId' is set
|
|
103041
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
103042
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob';
|
|
103043
|
+
}
|
|
103044
|
+
|
|
103045
|
+
return this.apiClient.callApi(
|
|
103046
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs/{jobId}',
|
|
103047
|
+
'GET',
|
|
103048
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
103049
|
+
{ },
|
|
103050
|
+
{ },
|
|
103051
|
+
{ },
|
|
103052
|
+
null,
|
|
103053
|
+
['PureCloud OAuth'],
|
|
103054
|
+
['application/json'],
|
|
103055
|
+
['application/json'],
|
|
103056
|
+
opts['customHeaders']
|
|
103057
|
+
);
|
|
103058
|
+
}
|
|
103059
|
+
|
|
103060
|
+
/**
|
|
103061
|
+
* View result of potential shift trade matches for the current user. Only the user who started the operation can query the status
|
|
103062
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
103063
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
103064
|
+
* @param {String} jobId The ID of the job
|
|
103065
|
+
* @param {Object} opts Optional parameters
|
|
103066
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103067
|
+
*/
|
|
103068
|
+
getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob(businessUnitId, jobId, opts) {
|
|
103069
|
+
opts = opts || {};
|
|
103070
|
+
|
|
103071
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103072
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103073
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob';
|
|
103074
|
+
}
|
|
103075
|
+
// verify the required parameter 'jobId' is set
|
|
103076
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
103077
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob';
|
|
103078
|
+
}
|
|
103079
|
+
|
|
103080
|
+
return this.apiClient.callApi(
|
|
103081
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs/{jobId}',
|
|
103082
|
+
'GET',
|
|
103083
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
103084
|
+
{ },
|
|
103085
|
+
{ },
|
|
103086
|
+
{ },
|
|
103087
|
+
null,
|
|
103088
|
+
['PureCloud OAuth'],
|
|
103089
|
+
['application/json'],
|
|
103090
|
+
['application/json'],
|
|
103091
|
+
opts['customHeaders']
|
|
103092
|
+
);
|
|
103093
|
+
}
|
|
103094
|
+
|
|
103095
|
+
/**
|
|
103096
|
+
* 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
|
|
103097
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
103098
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
103099
|
+
* @param {String} jobId The ID of the job
|
|
103100
|
+
* @param {Object} opts Optional parameters
|
|
103101
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103102
|
+
*/
|
|
103103
|
+
getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob(businessUnitId, jobId, opts) {
|
|
103104
|
+
opts = opts || {};
|
|
103105
|
+
|
|
103106
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103107
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103108
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob';
|
|
103109
|
+
}
|
|
103110
|
+
// verify the required parameter 'jobId' is set
|
|
103111
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
103112
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob';
|
|
103113
|
+
}
|
|
103114
|
+
|
|
103115
|
+
return this.apiClient.callApi(
|
|
103116
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs/{jobId}',
|
|
103117
|
+
'GET',
|
|
103118
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
103119
|
+
{ },
|
|
103120
|
+
{ },
|
|
103121
|
+
{ },
|
|
103122
|
+
null,
|
|
103123
|
+
['PureCloud OAuth'],
|
|
103124
|
+
['application/json'],
|
|
103125
|
+
['application/json'],
|
|
103126
|
+
opts['customHeaders']
|
|
103127
|
+
);
|
|
103128
|
+
}
|
|
103129
|
+
|
|
102302
103130
|
/**
|
|
102303
103131
|
* Gets a staffing group
|
|
102304
103132
|
*
|
|
@@ -102784,7 +103612,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
102784
103612
|
|
|
102785
103613
|
/**
|
|
102786
103614
|
* Get the list of week schedules for the specified week
|
|
102787
|
-
* Use "recent" (without quotes) for the `weekId` path parameter to fetch all
|
|
103615
|
+
* 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
|
|
102788
103616
|
* @param {String} businessUnitId The ID of the business unit
|
|
102789
103617
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
|
|
102790
103618
|
* @param {Object} opts Optional parameters
|
|
@@ -103067,7 +103895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
103067
103895
|
|
|
103068
103896
|
/**
|
|
103069
103897
|
* Get short term forecasts
|
|
103070
|
-
* 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
|
|
103898
|
+
* 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
|
|
103071
103899
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
103072
103900
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
103073
103901
|
* @param {Object} opts Optional parameters
|
|
@@ -104443,6 +105271,171 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
104443
105271
|
);
|
|
104444
105272
|
}
|
|
104445
105273
|
|
|
105274
|
+
/**
|
|
105275
|
+
* View result of update trade operation. Only the user who started the operation can query the status
|
|
105276
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105277
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
105278
|
+
* @param {String} jobId The ID of the job
|
|
105279
|
+
* @param {Object} opts Optional parameters
|
|
105280
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105281
|
+
*/
|
|
105282
|
+
getWorkforcemanagementShifttradingTradeJob(tradeId, jobId, opts) {
|
|
105283
|
+
opts = opts || {};
|
|
105284
|
+
|
|
105285
|
+
// verify the required parameter 'tradeId' is set
|
|
105286
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
105287
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementShifttradingTradeJob';
|
|
105288
|
+
}
|
|
105289
|
+
// verify the required parameter 'jobId' is set
|
|
105290
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105291
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradeJob';
|
|
105292
|
+
}
|
|
105293
|
+
|
|
105294
|
+
return this.apiClient.callApi(
|
|
105295
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs/{jobId}',
|
|
105296
|
+
'GET',
|
|
105297
|
+
{ 'tradeId': tradeId,'jobId': jobId },
|
|
105298
|
+
{ },
|
|
105299
|
+
{ },
|
|
105300
|
+
{ },
|
|
105301
|
+
null,
|
|
105302
|
+
['PureCloud OAuth'],
|
|
105303
|
+
['application/json'],
|
|
105304
|
+
['application/json'],
|
|
105305
|
+
opts['customHeaders']
|
|
105306
|
+
);
|
|
105307
|
+
}
|
|
105308
|
+
|
|
105309
|
+
/**
|
|
105310
|
+
* View result of match shift trade operation. Only the receiving user who started the operation can query the status.
|
|
105311
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105312
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
105313
|
+
* @param {String} jobId The ID of the job
|
|
105314
|
+
* @param {Object} opts Optional parameters
|
|
105315
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105316
|
+
*/
|
|
105317
|
+
getWorkforcemanagementShifttradingTradeMatchJob(tradeId, jobId, opts) {
|
|
105318
|
+
opts = opts || {};
|
|
105319
|
+
|
|
105320
|
+
// verify the required parameter 'tradeId' is set
|
|
105321
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
105322
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementShifttradingTradeMatchJob';
|
|
105323
|
+
}
|
|
105324
|
+
// verify the required parameter 'jobId' is set
|
|
105325
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105326
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradeMatchJob';
|
|
105327
|
+
}
|
|
105328
|
+
|
|
105329
|
+
return this.apiClient.callApi(
|
|
105330
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs/{jobId}',
|
|
105331
|
+
'GET',
|
|
105332
|
+
{ 'tradeId': tradeId,'jobId': jobId },
|
|
105333
|
+
{ },
|
|
105334
|
+
{ },
|
|
105335
|
+
{ },
|
|
105336
|
+
null,
|
|
105337
|
+
['PureCloud OAuth'],
|
|
105338
|
+
['application/json'],
|
|
105339
|
+
['application/json'],
|
|
105340
|
+
opts['customHeaders']
|
|
105341
|
+
);
|
|
105342
|
+
}
|
|
105343
|
+
|
|
105344
|
+
/**
|
|
105345
|
+
* View result of update trade state operation. Only the user who started the operation can query the status.
|
|
105346
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105347
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
105348
|
+
* @param {String} jobId The ID of the job
|
|
105349
|
+
* @param {Object} opts Optional parameters
|
|
105350
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105351
|
+
*/
|
|
105352
|
+
getWorkforcemanagementShifttradingTradeStateJob(tradeId, jobId, opts) {
|
|
105353
|
+
opts = opts || {};
|
|
105354
|
+
|
|
105355
|
+
// verify the required parameter 'tradeId' is set
|
|
105356
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
105357
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementShifttradingTradeStateJob';
|
|
105358
|
+
}
|
|
105359
|
+
// verify the required parameter 'jobId' is set
|
|
105360
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105361
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradeStateJob';
|
|
105362
|
+
}
|
|
105363
|
+
|
|
105364
|
+
return this.apiClient.callApi(
|
|
105365
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs/{jobId}',
|
|
105366
|
+
'GET',
|
|
105367
|
+
{ 'tradeId': tradeId,'jobId': jobId },
|
|
105368
|
+
{ },
|
|
105369
|
+
{ },
|
|
105370
|
+
{ },
|
|
105371
|
+
null,
|
|
105372
|
+
['PureCloud OAuth'],
|
|
105373
|
+
['application/json'],
|
|
105374
|
+
['application/json'],
|
|
105375
|
+
opts['customHeaders']
|
|
105376
|
+
);
|
|
105377
|
+
}
|
|
105378
|
+
|
|
105379
|
+
/**
|
|
105380
|
+
* View result of create trade operation. Only the user who started the operation can query the status
|
|
105381
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105382
|
+
* @param {String} jobId The ID of the job
|
|
105383
|
+
* @param {Object} opts Optional parameters
|
|
105384
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105385
|
+
*/
|
|
105386
|
+
getWorkforcemanagementShifttradingTradesJob(jobId, opts) {
|
|
105387
|
+
opts = opts || {};
|
|
105388
|
+
|
|
105389
|
+
// verify the required parameter 'jobId' is set
|
|
105390
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105391
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradesJob';
|
|
105392
|
+
}
|
|
105393
|
+
|
|
105394
|
+
return this.apiClient.callApi(
|
|
105395
|
+
'/api/v2/workforcemanagement/shifttrading/trades/jobs/{jobId}',
|
|
105396
|
+
'GET',
|
|
105397
|
+
{ 'jobId': jobId },
|
|
105398
|
+
{ },
|
|
105399
|
+
{ },
|
|
105400
|
+
{ },
|
|
105401
|
+
null,
|
|
105402
|
+
['PureCloud OAuth'],
|
|
105403
|
+
['application/json'],
|
|
105404
|
+
['application/json'],
|
|
105405
|
+
opts['customHeaders']
|
|
105406
|
+
);
|
|
105407
|
+
}
|
|
105408
|
+
|
|
105409
|
+
/**
|
|
105410
|
+
* View results of retrieve all my shift trade operation. Only the user who started the operation can query the status
|
|
105411
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
105412
|
+
* @param {String} jobId The ID of the job
|
|
105413
|
+
* @param {Object} opts Optional parameters
|
|
105414
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105415
|
+
*/
|
|
105416
|
+
getWorkforcemanagementShifttradingTradesMineQueryJob(jobId, opts) {
|
|
105417
|
+
opts = opts || {};
|
|
105418
|
+
|
|
105419
|
+
// verify the required parameter 'jobId' is set
|
|
105420
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
105421
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShifttradingTradesMineQueryJob';
|
|
105422
|
+
}
|
|
105423
|
+
|
|
105424
|
+
return this.apiClient.callApi(
|
|
105425
|
+
'/api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs/{jobId}',
|
|
105426
|
+
'GET',
|
|
105427
|
+
{ 'jobId': jobId },
|
|
105428
|
+
{ },
|
|
105429
|
+
{ },
|
|
105430
|
+
{ },
|
|
105431
|
+
null,
|
|
105432
|
+
['PureCloud OAuth'],
|
|
105433
|
+
['application/json'],
|
|
105434
|
+
['application/json'],
|
|
105435
|
+
opts['customHeaders']
|
|
105436
|
+
);
|
|
105437
|
+
}
|
|
105438
|
+
|
|
104446
105439
|
/**
|
|
104447
105440
|
* Request to fetch the status of the historical shrinkage query
|
|
104448
105441
|
*
|
|
@@ -107166,6 +108159,190 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
107166
108159
|
);
|
|
107167
108160
|
}
|
|
107168
108161
|
|
|
108162
|
+
/**
|
|
108163
|
+
* Queries and evaluates against shift trade configuration shift trades in a management unit per week
|
|
108164
|
+
*
|
|
108165
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108166
|
+
* @param {Object} body The request body
|
|
108167
|
+
* @param {Object} opts Optional parameters
|
|
108168
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108169
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108170
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108171
|
+
*/
|
|
108172
|
+
postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs(businessUnitId, body, opts) {
|
|
108173
|
+
opts = opts || {};
|
|
108174
|
+
|
|
108175
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108176
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108177
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs';
|
|
108178
|
+
}
|
|
108179
|
+
// verify the required parameter 'body' is set
|
|
108180
|
+
if (body === undefined || body === null) {
|
|
108181
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs';
|
|
108182
|
+
}
|
|
108183
|
+
|
|
108184
|
+
return this.apiClient.callApi(
|
|
108185
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs',
|
|
108186
|
+
'POST',
|
|
108187
|
+
{ 'businessUnitId': businessUnitId },
|
|
108188
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108189
|
+
{ },
|
|
108190
|
+
{ },
|
|
108191
|
+
body,
|
|
108192
|
+
['PureCloud OAuth'],
|
|
108193
|
+
['application/json'],
|
|
108194
|
+
['application/json'],
|
|
108195
|
+
opts['customHeaders']
|
|
108196
|
+
);
|
|
108197
|
+
}
|
|
108198
|
+
|
|
108199
|
+
/**
|
|
108200
|
+
* Queries shift trades in a management unit per user
|
|
108201
|
+
*
|
|
108202
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108203
|
+
* @param {Object} body The request body
|
|
108204
|
+
* @param {Object} opts Optional parameters
|
|
108205
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108206
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108207
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108208
|
+
*/
|
|
108209
|
+
postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs(businessUnitId, body, opts) {
|
|
108210
|
+
opts = opts || {};
|
|
108211
|
+
|
|
108212
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108213
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108214
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs';
|
|
108215
|
+
}
|
|
108216
|
+
// verify the required parameter 'body' is set
|
|
108217
|
+
if (body === undefined || body === null) {
|
|
108218
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs';
|
|
108219
|
+
}
|
|
108220
|
+
|
|
108221
|
+
return this.apiClient.callApi(
|
|
108222
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs',
|
|
108223
|
+
'POST',
|
|
108224
|
+
{ 'businessUnitId': businessUnitId },
|
|
108225
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108226
|
+
{ },
|
|
108227
|
+
{ },
|
|
108228
|
+
body,
|
|
108229
|
+
['PureCloud OAuth'],
|
|
108230
|
+
['application/json'],
|
|
108231
|
+
['application/json'],
|
|
108232
|
+
opts['customHeaders']
|
|
108233
|
+
);
|
|
108234
|
+
}
|
|
108235
|
+
|
|
108236
|
+
/**
|
|
108237
|
+
* Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades.
|
|
108238
|
+
*
|
|
108239
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108240
|
+
* @param {Object} body The request body
|
|
108241
|
+
* @param {Object} opts Optional parameters
|
|
108242
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108243
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108244
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108245
|
+
*/
|
|
108246
|
+
postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs(businessUnitId, body, opts) {
|
|
108247
|
+
opts = opts || {};
|
|
108248
|
+
|
|
108249
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108250
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108251
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs';
|
|
108252
|
+
}
|
|
108253
|
+
// verify the required parameter 'body' is set
|
|
108254
|
+
if (body === undefined || body === null) {
|
|
108255
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs';
|
|
108256
|
+
}
|
|
108257
|
+
|
|
108258
|
+
return this.apiClient.callApi(
|
|
108259
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs',
|
|
108260
|
+
'POST',
|
|
108261
|
+
{ 'businessUnitId': businessUnitId },
|
|
108262
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108263
|
+
{ },
|
|
108264
|
+
{ },
|
|
108265
|
+
body,
|
|
108266
|
+
['PureCloud OAuth'],
|
|
108267
|
+
['application/json'],
|
|
108268
|
+
['application/json'],
|
|
108269
|
+
opts['customHeaders']
|
|
108270
|
+
);
|
|
108271
|
+
}
|
|
108272
|
+
|
|
108273
|
+
/**
|
|
108274
|
+
* Start an async job to find potential shift trade matches for the current receiving user
|
|
108275
|
+
*
|
|
108276
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108277
|
+
* @param {Object} body The request body
|
|
108278
|
+
* @param {Object} opts Optional parameters
|
|
108279
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108280
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108281
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108282
|
+
*/
|
|
108283
|
+
postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs(businessUnitId, body, opts) {
|
|
108284
|
+
opts = opts || {};
|
|
108285
|
+
|
|
108286
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108287
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108288
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs';
|
|
108289
|
+
}
|
|
108290
|
+
// verify the required parameter 'body' is set
|
|
108291
|
+
if (body === undefined || body === null) {
|
|
108292
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs';
|
|
108293
|
+
}
|
|
108294
|
+
|
|
108295
|
+
return this.apiClient.callApi(
|
|
108296
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs',
|
|
108297
|
+
'POST',
|
|
108298
|
+
{ 'businessUnitId': businessUnitId },
|
|
108299
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108300
|
+
{ },
|
|
108301
|
+
{ },
|
|
108302
|
+
body,
|
|
108303
|
+
['PureCloud OAuth'],
|
|
108304
|
+
['application/json'],
|
|
108305
|
+
['application/json'],
|
|
108306
|
+
opts['customHeaders']
|
|
108307
|
+
);
|
|
108308
|
+
}
|
|
108309
|
+
|
|
108310
|
+
/**
|
|
108311
|
+
* Retrieves the summary of shift trades in a matched state per week
|
|
108312
|
+
*
|
|
108313
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108314
|
+
* @param {Object} body The request body
|
|
108315
|
+
* @param {Object} opts Optional parameters
|
|
108316
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
108317
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108318
|
+
*/
|
|
108319
|
+
postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs(businessUnitId, body, opts) {
|
|
108320
|
+
opts = opts || {};
|
|
108321
|
+
|
|
108322
|
+
// verify the required parameter 'businessUnitId' is set
|
|
108323
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
108324
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs';
|
|
108325
|
+
}
|
|
108326
|
+
// verify the required parameter 'body' is set
|
|
108327
|
+
if (body === undefined || body === null) {
|
|
108328
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs';
|
|
108329
|
+
}
|
|
108330
|
+
|
|
108331
|
+
return this.apiClient.callApi(
|
|
108332
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs',
|
|
108333
|
+
'POST',
|
|
108334
|
+
{ 'businessUnitId': businessUnitId },
|
|
108335
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
108336
|
+
{ },
|
|
108337
|
+
{ },
|
|
108338
|
+
body,
|
|
108339
|
+
['PureCloud OAuth'],
|
|
108340
|
+
['application/json'],
|
|
108341
|
+
['application/json'],
|
|
108342
|
+
opts['customHeaders']
|
|
108343
|
+
);
|
|
108344
|
+
}
|
|
108345
|
+
|
|
107169
108346
|
/**
|
|
107170
108347
|
* Creates a new staffing group
|
|
107171
108348
|
*
|
|
@@ -109379,6 +110556,177 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
109379
110556
|
);
|
|
109380
110557
|
}
|
|
109381
110558
|
|
|
110559
|
+
/**
|
|
110560
|
+
* Updates a shift trade. This route can only be called by the initiating user
|
|
110561
|
+
*
|
|
110562
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
110563
|
+
* @param {Object} body The request body
|
|
110564
|
+
* @param {Object} opts Optional parameters
|
|
110565
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110566
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110567
|
+
*/
|
|
110568
|
+
postWorkforcemanagementShifttradingTradeJobs(tradeId, body, opts) {
|
|
110569
|
+
opts = opts || {};
|
|
110570
|
+
|
|
110571
|
+
// verify the required parameter 'tradeId' is set
|
|
110572
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
110573
|
+
throw 'Missing the required parameter "tradeId" when calling postWorkforcemanagementShifttradingTradeJobs';
|
|
110574
|
+
}
|
|
110575
|
+
// verify the required parameter 'body' is set
|
|
110576
|
+
if (body === undefined || body === null) {
|
|
110577
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradeJobs';
|
|
110578
|
+
}
|
|
110579
|
+
|
|
110580
|
+
return this.apiClient.callApi(
|
|
110581
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs',
|
|
110582
|
+
'POST',
|
|
110583
|
+
{ 'tradeId': tradeId },
|
|
110584
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
110585
|
+
{ },
|
|
110586
|
+
{ },
|
|
110587
|
+
body,
|
|
110588
|
+
['PureCloud OAuth'],
|
|
110589
|
+
['application/json'],
|
|
110590
|
+
['application/json'],
|
|
110591
|
+
opts['customHeaders']
|
|
110592
|
+
);
|
|
110593
|
+
}
|
|
110594
|
+
|
|
110595
|
+
/**
|
|
110596
|
+
* Matches a shift trade. This route can only be called by the receiving user
|
|
110597
|
+
*
|
|
110598
|
+
* @param {String} tradeId The ID of the shift trade to match
|
|
110599
|
+
* @param {Object} body The request body
|
|
110600
|
+
* @param {Object} opts Optional parameters
|
|
110601
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110602
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110603
|
+
*/
|
|
110604
|
+
postWorkforcemanagementShifttradingTradeMatchJobs(tradeId, body, opts) {
|
|
110605
|
+
opts = opts || {};
|
|
110606
|
+
|
|
110607
|
+
// verify the required parameter 'tradeId' is set
|
|
110608
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
110609
|
+
throw 'Missing the required parameter "tradeId" when calling postWorkforcemanagementShifttradingTradeMatchJobs';
|
|
110610
|
+
}
|
|
110611
|
+
// verify the required parameter 'body' is set
|
|
110612
|
+
if (body === undefined || body === null) {
|
|
110613
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradeMatchJobs';
|
|
110614
|
+
}
|
|
110615
|
+
|
|
110616
|
+
return this.apiClient.callApi(
|
|
110617
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs',
|
|
110618
|
+
'POST',
|
|
110619
|
+
{ 'tradeId': tradeId },
|
|
110620
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
110621
|
+
{ },
|
|
110622
|
+
{ },
|
|
110623
|
+
body,
|
|
110624
|
+
['PureCloud OAuth'],
|
|
110625
|
+
['application/json'],
|
|
110626
|
+
['application/json'],
|
|
110627
|
+
opts['customHeaders']
|
|
110628
|
+
);
|
|
110629
|
+
}
|
|
110630
|
+
|
|
110631
|
+
/**
|
|
110632
|
+
* Update trade state by a user
|
|
110633
|
+
*
|
|
110634
|
+
* @param {String} tradeId The ID of the shift trade to update state
|
|
110635
|
+
* @param {Object} body The request body
|
|
110636
|
+
* @param {Object} opts Optional parameters
|
|
110637
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110638
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110639
|
+
*/
|
|
110640
|
+
postWorkforcemanagementShifttradingTradeStateJobs(tradeId, body, opts) {
|
|
110641
|
+
opts = opts || {};
|
|
110642
|
+
|
|
110643
|
+
// verify the required parameter 'tradeId' is set
|
|
110644
|
+
if (tradeId === undefined || tradeId === null || tradeId === '') {
|
|
110645
|
+
throw 'Missing the required parameter "tradeId" when calling postWorkforcemanagementShifttradingTradeStateJobs';
|
|
110646
|
+
}
|
|
110647
|
+
// verify the required parameter 'body' is set
|
|
110648
|
+
if (body === undefined || body === null) {
|
|
110649
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradeStateJobs';
|
|
110650
|
+
}
|
|
110651
|
+
|
|
110652
|
+
return this.apiClient.callApi(
|
|
110653
|
+
'/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs',
|
|
110654
|
+
'POST',
|
|
110655
|
+
{ 'tradeId': tradeId },
|
|
110656
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
110657
|
+
{ },
|
|
110658
|
+
{ },
|
|
110659
|
+
body,
|
|
110660
|
+
['PureCloud OAuth'],
|
|
110661
|
+
['application/json'],
|
|
110662
|
+
['application/json'],
|
|
110663
|
+
opts['customHeaders']
|
|
110664
|
+
);
|
|
110665
|
+
}
|
|
110666
|
+
|
|
110667
|
+
/**
|
|
110668
|
+
* Add a shift trade job
|
|
110669
|
+
*
|
|
110670
|
+
* @param {Object} body The request body
|
|
110671
|
+
* @param {Object} opts Optional parameters
|
|
110672
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110673
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110674
|
+
*/
|
|
110675
|
+
postWorkforcemanagementShifttradingTradesJobs(body, opts) {
|
|
110676
|
+
opts = opts || {};
|
|
110677
|
+
|
|
110678
|
+
// verify the required parameter 'body' is set
|
|
110679
|
+
if (body === undefined || body === null) {
|
|
110680
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradesJobs';
|
|
110681
|
+
}
|
|
110682
|
+
|
|
110683
|
+
return this.apiClient.callApi(
|
|
110684
|
+
'/api/v2/workforcemanagement/shifttrading/trades/jobs',
|
|
110685
|
+
'POST',
|
|
110686
|
+
{ },
|
|
110687
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
110688
|
+
{ },
|
|
110689
|
+
{ },
|
|
110690
|
+
body,
|
|
110691
|
+
['PureCloud OAuth'],
|
|
110692
|
+
['application/json'],
|
|
110693
|
+
['application/json'],
|
|
110694
|
+
opts['customHeaders']
|
|
110695
|
+
);
|
|
110696
|
+
}
|
|
110697
|
+
|
|
110698
|
+
/**
|
|
110699
|
+
* Retrieve all my shift trades where I am either the initiating or receiving user
|
|
110700
|
+
*
|
|
110701
|
+
* @param {Object} body The request body
|
|
110702
|
+
* @param {Object} opts Optional parameters
|
|
110703
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110704
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
110705
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110706
|
+
*/
|
|
110707
|
+
postWorkforcemanagementShifttradingTradesMineQueryJobs(body, opts) {
|
|
110708
|
+
opts = opts || {};
|
|
110709
|
+
|
|
110710
|
+
// verify the required parameter 'body' is set
|
|
110711
|
+
if (body === undefined || body === null) {
|
|
110712
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementShifttradingTradesMineQueryJobs';
|
|
110713
|
+
}
|
|
110714
|
+
|
|
110715
|
+
return this.apiClient.callApi(
|
|
110716
|
+
'/api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs',
|
|
110717
|
+
'POST',
|
|
110718
|
+
{ },
|
|
110719
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
110720
|
+
{ },
|
|
110721
|
+
{ },
|
|
110722
|
+
body,
|
|
110723
|
+
['PureCloud OAuth'],
|
|
110724
|
+
['application/json'],
|
|
110725
|
+
['application/json'],
|
|
110726
|
+
opts['customHeaders']
|
|
110727
|
+
);
|
|
110728
|
+
}
|
|
110729
|
+
|
|
109382
110730
|
/**
|
|
109383
110731
|
* Request a teams historical adherence report
|
|
109384
110732
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
@@ -109805,7 +111153,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
109805
111153
|
* </pre>
|
|
109806
111154
|
* </p>
|
|
109807
111155
|
* @module purecloud-platform-client-v2/index
|
|
109808
|
-
* @version
|
|
111156
|
+
* @version 250.1.0
|
|
109809
111157
|
*/
|
|
109810
111158
|
class platformClient {
|
|
109811
111159
|
constructor() {
|