purecloud-platform-client-v2 95.0.0 → 98.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +412 -1256
- package/dist/web-amd/purecloud-platform-client-v2.js +412 -1256
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +412 -1256
- package/dist/web-cjs/purecloud-platform-client-v2.js +418 -1263
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +319 -128
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +3 -3
- 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 +26 -10
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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/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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +6 -4
- 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/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +26 -26
- 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/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/TelephonyApi.js +3 -3
- 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 +123 -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/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +309 -1148
- package/src/purecloud-platform-client-v2/index.js +1 -7
- package/src/purecloud-platform-client-v2/api/UserDevelopmentApi.js +0 -148
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -1983,7 +1983,7 @@ function isSlowBuffer (obj) {
|
|
|
1983
1983
|
|
|
1984
1984
|
/**
|
|
1985
1985
|
* @module purecloud-platform-client-v2/ApiClient
|
|
1986
|
-
* @version
|
|
1986
|
+
* @version 98.0.0
|
|
1987
1987
|
*/
|
|
1988
1988
|
class ApiClient {
|
|
1989
1989
|
/**
|
|
@@ -2739,7 +2739,7 @@ class ApiClient {
|
|
|
2739
2739
|
|
|
2740
2740
|
// set header parameters
|
|
2741
2741
|
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
|
|
2742
|
-
//request.set({ 'purecloud-sdk': '
|
|
2742
|
+
//request.set({ 'purecloud-sdk': '98.0.0' });
|
|
2743
2743
|
|
|
2744
2744
|
// set request timeout
|
|
2745
2745
|
request.timeout(this.timeout);
|
|
@@ -2864,7 +2864,7 @@ class AlertingApi {
|
|
|
2864
2864
|
/**
|
|
2865
2865
|
* Alerting service.
|
|
2866
2866
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2867
|
-
* @version
|
|
2867
|
+
* @version 98.0.0
|
|
2868
2868
|
*/
|
|
2869
2869
|
|
|
2870
2870
|
/**
|
|
@@ -3178,7 +3178,7 @@ class AnalyticsApi {
|
|
|
3178
3178
|
/**
|
|
3179
3179
|
* Analytics service.
|
|
3180
3180
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3181
|
-
* @version
|
|
3181
|
+
* @version 98.0.0
|
|
3182
3182
|
*/
|
|
3183
3183
|
|
|
3184
3184
|
/**
|
|
@@ -4258,7 +4258,7 @@ class ArchitectApi {
|
|
|
4258
4258
|
/**
|
|
4259
4259
|
* Architect service.
|
|
4260
4260
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4261
|
-
* @version
|
|
4261
|
+
* @version 98.0.0
|
|
4262
4262
|
*/
|
|
4263
4263
|
|
|
4264
4264
|
/**
|
|
@@ -7096,7 +7096,7 @@ class AuditApi {
|
|
|
7096
7096
|
/**
|
|
7097
7097
|
* Audit service.
|
|
7098
7098
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7099
|
-
* @version
|
|
7099
|
+
* @version 98.0.0
|
|
7100
7100
|
*/
|
|
7101
7101
|
|
|
7102
7102
|
/**
|
|
@@ -7267,7 +7267,7 @@ class AuthorizationApi {
|
|
|
7267
7267
|
/**
|
|
7268
7268
|
* Authorization service.
|
|
7269
7269
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7270
|
-
* @version
|
|
7270
|
+
* @version 98.0.0
|
|
7271
7271
|
*/
|
|
7272
7272
|
|
|
7273
7273
|
/**
|
|
@@ -7602,6 +7602,8 @@ class AuthorizationApi {
|
|
|
7602
7602
|
* @param {Object} opts Optional parameters
|
|
7603
7603
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7604
7604
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7605
|
+
* @param {Object} opts.queryType Query filter type
|
|
7606
|
+
* @param {String} opts.query Comma-separated list of permissions or domains to query
|
|
7605
7607
|
*/
|
|
7606
7608
|
getAuthorizationPermissions(opts) {
|
|
7607
7609
|
opts = opts || {};
|
|
@@ -7611,7 +7613,7 @@ class AuthorizationApi {
|
|
|
7611
7613
|
'/api/v2/authorization/permissions',
|
|
7612
7614
|
'GET',
|
|
7613
7615
|
{ },
|
|
7614
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
7616
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
|
|
7615
7617
|
{ },
|
|
7616
7618
|
{ },
|
|
7617
7619
|
null,
|
|
@@ -8384,7 +8386,7 @@ class BillingApi {
|
|
|
8384
8386
|
/**
|
|
8385
8387
|
* Billing service.
|
|
8386
8388
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8387
|
-
* @version
|
|
8389
|
+
* @version 98.0.0
|
|
8388
8390
|
*/
|
|
8389
8391
|
|
|
8390
8392
|
/**
|
|
@@ -8402,8 +8404,8 @@ class BillingApi {
|
|
|
8402
8404
|
/**
|
|
8403
8405
|
* Get a report of the billable license usages
|
|
8404
8406
|
* Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.
|
|
8405
|
-
* @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
8406
|
-
* @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
8407
|
+
* @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
8408
|
+
* @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
8407
8409
|
*/
|
|
8408
8410
|
getBillingReportsBillableusage(startDate, endDate) {
|
|
8409
8411
|
// verify the required parameter 'startDate' is set
|
|
@@ -8464,7 +8466,7 @@ class CoachingApi {
|
|
|
8464
8466
|
/**
|
|
8465
8467
|
* Coaching service.
|
|
8466
8468
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8467
|
-
* @version
|
|
8469
|
+
* @version 98.0.0
|
|
8468
8470
|
*/
|
|
8469
8471
|
|
|
8470
8472
|
/**
|
|
@@ -8984,7 +8986,7 @@ class ContentManagementApi {
|
|
|
8984
8986
|
/**
|
|
8985
8987
|
* ContentManagement service.
|
|
8986
8988
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8987
|
-
* @version
|
|
8989
|
+
* @version 98.0.0
|
|
8988
8990
|
*/
|
|
8989
8991
|
|
|
8990
8992
|
/**
|
|
@@ -10124,7 +10126,7 @@ class ConversationsApi {
|
|
|
10124
10126
|
/**
|
|
10125
10127
|
* Conversations service.
|
|
10126
10128
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10127
|
-
* @version
|
|
10129
|
+
* @version 98.0.0
|
|
10128
10130
|
*/
|
|
10129
10131
|
|
|
10130
10132
|
/**
|
|
@@ -13753,7 +13755,7 @@ class ConversationsApi {
|
|
|
13753
13755
|
|
|
13754
13756
|
/**
|
|
13755
13757
|
* Send message
|
|
13756
|
-
*
|
|
13758
|
+
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.
|
|
13757
13759
|
* @param {String} conversationId conversationId
|
|
13758
13760
|
* @param {String} communicationId communicationId
|
|
13759
13761
|
* @param {Object} body Message
|
|
@@ -13934,8 +13936,12 @@ class ConversationsApi {
|
|
|
13934
13936
|
* Create a Facebook Integration
|
|
13935
13937
|
*
|
|
13936
13938
|
* @param {Object} body FacebookIntegrationRequest
|
|
13939
|
+
* @param {Object} opts Optional parameters
|
|
13940
|
+
* @param {Boolean} opts.async Create a Facebook integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new Facebook integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
|
|
13937
13941
|
*/
|
|
13938
|
-
postConversationsMessagingIntegrationsFacebook(body) {
|
|
13942
|
+
postConversationsMessagingIntegrationsFacebook(body, opts) {
|
|
13943
|
+
opts = opts || {};
|
|
13944
|
+
|
|
13939
13945
|
// verify the required parameter 'body' is set
|
|
13940
13946
|
if (body === undefined || body === null) {
|
|
13941
13947
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';
|
|
@@ -13945,7 +13951,7 @@ class ConversationsApi {
|
|
|
13945
13951
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
13946
13952
|
'POST',
|
|
13947
13953
|
{ },
|
|
13948
|
-
{
|
|
13954
|
+
{ 'async': opts['async'] },
|
|
13949
13955
|
{ },
|
|
13950
13956
|
{ },
|
|
13951
13957
|
body,
|
|
@@ -13959,8 +13965,12 @@ class ConversationsApi {
|
|
|
13959
13965
|
* Create a LINE messenger Integration
|
|
13960
13966
|
*
|
|
13961
13967
|
* @param {Object} body LineIntegrationRequest
|
|
13968
|
+
* @param {Object} opts Optional parameters
|
|
13969
|
+
* @param {Boolean} opts.async Create a LINE integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new LINE integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
|
|
13962
13970
|
*/
|
|
13963
|
-
postConversationsMessagingIntegrationsLine(body) {
|
|
13971
|
+
postConversationsMessagingIntegrationsLine(body, opts) {
|
|
13972
|
+
opts = opts || {};
|
|
13973
|
+
|
|
13964
13974
|
// verify the required parameter 'body' is set
|
|
13965
13975
|
if (body === undefined || body === null) {
|
|
13966
13976
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
|
|
@@ -13970,7 +13980,7 @@ class ConversationsApi {
|
|
|
13970
13980
|
'/api/v2/conversations/messaging/integrations/line',
|
|
13971
13981
|
'POST',
|
|
13972
13982
|
{ },
|
|
13973
|
-
{
|
|
13983
|
+
{ 'async': opts['async'] },
|
|
13974
13984
|
{ },
|
|
13975
13985
|
{ },
|
|
13976
13986
|
body,
|
|
@@ -13984,8 +13994,12 @@ class ConversationsApi {
|
|
|
13984
13994
|
* Create a Twitter Integration
|
|
13985
13995
|
*
|
|
13986
13996
|
* @param {Object} body TwitterIntegrationRequest
|
|
13997
|
+
* @param {Object} opts Optional parameters
|
|
13998
|
+
* @param {Boolean} opts.async Create a Twitter integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new Twitter integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
|
|
13987
13999
|
*/
|
|
13988
|
-
postConversationsMessagingIntegrationsTwitter(body) {
|
|
14000
|
+
postConversationsMessagingIntegrationsTwitter(body, opts) {
|
|
14001
|
+
opts = opts || {};
|
|
14002
|
+
|
|
13989
14003
|
// verify the required parameter 'body' is set
|
|
13990
14004
|
if (body === undefined || body === null) {
|
|
13991
14005
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
@@ -13995,7 +14009,7 @@ class ConversationsApi {
|
|
|
13995
14009
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
13996
14010
|
'POST',
|
|
13997
14011
|
{ },
|
|
13998
|
-
{
|
|
14012
|
+
{ 'async': opts['async'] },
|
|
13999
14013
|
{ },
|
|
14000
14014
|
{ },
|
|
14001
14015
|
body,
|
|
@@ -14009,8 +14023,12 @@ class ConversationsApi {
|
|
|
14009
14023
|
* Create a WhatsApp Integration
|
|
14010
14024
|
* You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
14011
14025
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
14026
|
+
* @param {Object} opts Optional parameters
|
|
14027
|
+
* @param {Boolean} opts.async Create a WhatsApp integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new WhatsApp integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
|
|
14012
14028
|
*/
|
|
14013
|
-
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
14029
|
+
postConversationsMessagingIntegrationsWhatsapp(body, opts) {
|
|
14030
|
+
opts = opts || {};
|
|
14031
|
+
|
|
14014
14032
|
// verify the required parameter 'body' is set
|
|
14015
14033
|
if (body === undefined || body === null) {
|
|
14016
14034
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';
|
|
@@ -14020,7 +14038,7 @@ class ConversationsApi {
|
|
|
14020
14038
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
14021
14039
|
'POST',
|
|
14022
14040
|
{ },
|
|
14023
|
-
{
|
|
14041
|
+
{ 'async': opts['async'] },
|
|
14024
14042
|
{ },
|
|
14025
14043
|
{ },
|
|
14026
14044
|
body,
|
|
@@ -14166,7 +14184,7 @@ class DataExtensionsApi {
|
|
|
14166
14184
|
/**
|
|
14167
14185
|
* DataExtensions service.
|
|
14168
14186
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14169
|
-
* @version
|
|
14187
|
+
* @version 98.0.0
|
|
14170
14188
|
*/
|
|
14171
14189
|
|
|
14172
14190
|
/**
|
|
@@ -14252,7 +14270,7 @@ class ExternalContactsApi {
|
|
|
14252
14270
|
/**
|
|
14253
14271
|
* ExternalContacts service.
|
|
14254
14272
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14255
|
-
* @version
|
|
14273
|
+
* @version 98.0.0
|
|
14256
14274
|
*/
|
|
14257
14275
|
|
|
14258
14276
|
/**
|
|
@@ -15595,7 +15613,7 @@ class FaxApi {
|
|
|
15595
15613
|
/**
|
|
15596
15614
|
* Fax service.
|
|
15597
15615
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15598
|
-
* @version
|
|
15616
|
+
* @version 98.0.0
|
|
15599
15617
|
*/
|
|
15600
15618
|
|
|
15601
15619
|
/**
|
|
@@ -15766,7 +15784,7 @@ class FlowsApi {
|
|
|
15766
15784
|
/**
|
|
15767
15785
|
* Flows service.
|
|
15768
15786
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15769
|
-
* @version
|
|
15787
|
+
* @version 98.0.0
|
|
15770
15788
|
*/
|
|
15771
15789
|
|
|
15772
15790
|
/**
|
|
@@ -15837,7 +15855,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
15837
15855
|
/**
|
|
15838
15856
|
* GeneralDataProtectionRegulation service.
|
|
15839
15857
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
15840
|
-
* @version
|
|
15858
|
+
* @version 98.0.0
|
|
15841
15859
|
*/
|
|
15842
15860
|
|
|
15843
15861
|
/**
|
|
@@ -15967,7 +15985,7 @@ class GeolocationApi {
|
|
|
15967
15985
|
/**
|
|
15968
15986
|
* Geolocation service.
|
|
15969
15987
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
15970
|
-
* @version
|
|
15988
|
+
* @version 98.0.0
|
|
15971
15989
|
*/
|
|
15972
15990
|
|
|
15973
15991
|
/**
|
|
@@ -16098,7 +16116,7 @@ class GreetingsApi {
|
|
|
16098
16116
|
/**
|
|
16099
16117
|
* Greetings service.
|
|
16100
16118
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
16101
|
-
* @version
|
|
16119
|
+
* @version 98.0.0
|
|
16102
16120
|
*/
|
|
16103
16121
|
|
|
16104
16122
|
/**
|
|
@@ -16553,7 +16571,7 @@ class GroupsApi {
|
|
|
16553
16571
|
/**
|
|
16554
16572
|
* Groups service.
|
|
16555
16573
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
16556
|
-
* @version
|
|
16574
|
+
* @version 98.0.0
|
|
16557
16575
|
*/
|
|
16558
16576
|
|
|
16559
16577
|
/**
|
|
@@ -16958,7 +16976,7 @@ class IdentityProviderApi {
|
|
|
16958
16976
|
/**
|
|
16959
16977
|
* IdentityProvider service.
|
|
16960
16978
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
16961
|
-
* @version
|
|
16979
|
+
* @version 98.0.0
|
|
16962
16980
|
*/
|
|
16963
16981
|
|
|
16964
16982
|
/**
|
|
@@ -17714,7 +17732,7 @@ class IntegrationsApi {
|
|
|
17714
17732
|
/**
|
|
17715
17733
|
* Integrations service.
|
|
17716
17734
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
17717
|
-
* @version
|
|
17735
|
+
* @version 98.0.0
|
|
17718
17736
|
*/
|
|
17719
17737
|
|
|
17720
17738
|
/**
|
|
@@ -19206,7 +19224,7 @@ class JourneyApi {
|
|
|
19206
19224
|
/**
|
|
19207
19225
|
* Journey service.
|
|
19208
19226
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
19209
|
-
* @version
|
|
19227
|
+
* @version 98.0.0
|
|
19210
19228
|
*/
|
|
19211
19229
|
|
|
19212
19230
|
/**
|
|
@@ -19331,7 +19349,7 @@ class KnowledgeApi {
|
|
|
19331
19349
|
/**
|
|
19332
19350
|
* Knowledge service.
|
|
19333
19351
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
19334
|
-
* @version
|
|
19352
|
+
* @version 98.0.0
|
|
19335
19353
|
*/
|
|
19336
19354
|
|
|
19337
19355
|
/**
|
|
@@ -19584,6 +19602,7 @@ class KnowledgeApi {
|
|
|
19584
19602
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
19585
19603
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
19586
19604
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
19605
|
+
* @param {String} opts.title Filter by document title.
|
|
19587
19606
|
*/
|
|
19588
19607
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
19589
19608
|
opts = opts || {};
|
|
@@ -19601,7 +19620,7 @@ class KnowledgeApi {
|
|
|
19601
19620
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
19602
19621
|
'GET',
|
|
19603
19622
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
19604
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'] },
|
|
19623
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'] },
|
|
19605
19624
|
{ },
|
|
19606
19625
|
{ },
|
|
19607
19626
|
null,
|
|
@@ -19647,7 +19666,7 @@ class KnowledgeApi {
|
|
|
19647
19666
|
}
|
|
19648
19667
|
|
|
19649
19668
|
/**
|
|
19650
|
-
* Get
|
|
19669
|
+
* Get all trainings information for a knowledgebase
|
|
19651
19670
|
*
|
|
19652
19671
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
19653
19672
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
@@ -19656,6 +19675,7 @@ class KnowledgeApi {
|
|
|
19656
19675
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
19657
19676
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
19658
19677
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
19678
|
+
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
19659
19679
|
*/
|
|
19660
19680
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
19661
19681
|
opts = opts || {};
|
|
@@ -19673,7 +19693,7 @@ class KnowledgeApi {
|
|
|
19673
19693
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
19674
19694
|
'GET',
|
|
19675
19695
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
19676
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
|
|
19696
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
|
|
19677
19697
|
{ },
|
|
19678
19698
|
{ },
|
|
19679
19699
|
null,
|
|
@@ -20051,7 +20071,7 @@ class LanguageUnderstandingApi {
|
|
|
20051
20071
|
/**
|
|
20052
20072
|
* LanguageUnderstanding service.
|
|
20053
20073
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
20054
|
-
* @version
|
|
20074
|
+
* @version 98.0.0
|
|
20055
20075
|
*/
|
|
20056
20076
|
|
|
20057
20077
|
/**
|
|
@@ -20617,7 +20637,7 @@ class LanguagesApi {
|
|
|
20617
20637
|
/**
|
|
20618
20638
|
* Languages service.
|
|
20619
20639
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
20620
|
-
* @version
|
|
20640
|
+
* @version 98.0.0
|
|
20621
20641
|
*/
|
|
20622
20642
|
|
|
20623
20643
|
/**
|
|
@@ -20885,7 +20905,7 @@ class LicenseApi {
|
|
|
20885
20905
|
/**
|
|
20886
20906
|
* License service.
|
|
20887
20907
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
20888
|
-
* @version
|
|
20908
|
+
* @version 98.0.0
|
|
20889
20909
|
*/
|
|
20890
20910
|
|
|
20891
20911
|
/**
|
|
@@ -21123,7 +21143,7 @@ class LocationsApi {
|
|
|
21123
21143
|
/**
|
|
21124
21144
|
* Locations service.
|
|
21125
21145
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
21126
|
-
* @version
|
|
21146
|
+
* @version 98.0.0
|
|
21127
21147
|
*/
|
|
21128
21148
|
|
|
21129
21149
|
/**
|
|
@@ -21359,7 +21379,7 @@ class MobileDevicesApi {
|
|
|
21359
21379
|
/**
|
|
21360
21380
|
* MobileDevices service.
|
|
21361
21381
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
21362
|
-
* @version
|
|
21382
|
+
* @version 98.0.0
|
|
21363
21383
|
*/
|
|
21364
21384
|
|
|
21365
21385
|
/**
|
|
@@ -21510,7 +21530,7 @@ class NotificationsApi {
|
|
|
21510
21530
|
/**
|
|
21511
21531
|
* Notifications service.
|
|
21512
21532
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
21513
|
-
* @version
|
|
21533
|
+
* @version 98.0.0
|
|
21514
21534
|
*/
|
|
21515
21535
|
|
|
21516
21536
|
/**
|
|
@@ -21709,7 +21729,7 @@ class OAuthApi {
|
|
|
21709
21729
|
/**
|
|
21710
21730
|
* OAuth service.
|
|
21711
21731
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
21712
|
-
* @version
|
|
21732
|
+
* @version 98.0.0
|
|
21713
21733
|
*/
|
|
21714
21734
|
|
|
21715
21735
|
/**
|
|
@@ -22067,7 +22087,7 @@ class ObjectsApi {
|
|
|
22067
22087
|
/**
|
|
22068
22088
|
* Objects service.
|
|
22069
22089
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
22070
|
-
* @version
|
|
22090
|
+
* @version 98.0.0
|
|
22071
22091
|
*/
|
|
22072
22092
|
|
|
22073
22093
|
/**
|
|
@@ -22308,7 +22328,7 @@ class OrganizationApi {
|
|
|
22308
22328
|
/**
|
|
22309
22329
|
* Organization service.
|
|
22310
22330
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
22311
|
-
* @version
|
|
22331
|
+
* @version 98.0.0
|
|
22312
22332
|
*/
|
|
22313
22333
|
|
|
22314
22334
|
/**
|
|
@@ -22563,7 +22583,7 @@ class OrganizationAuthorizationApi {
|
|
|
22563
22583
|
/**
|
|
22564
22584
|
* OrganizationAuthorization service.
|
|
22565
22585
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
22566
|
-
* @version
|
|
22586
|
+
* @version 98.0.0
|
|
22567
22587
|
*/
|
|
22568
22588
|
|
|
22569
22589
|
/**
|
|
@@ -23273,7 +23293,7 @@ class OutboundApi {
|
|
|
23273
23293
|
/**
|
|
23274
23294
|
* Outbound service.
|
|
23275
23295
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
23276
|
-
* @version
|
|
23296
|
+
* @version 98.0.0
|
|
23277
23297
|
*/
|
|
23278
23298
|
|
|
23279
23299
|
/**
|
|
@@ -26247,7 +26267,7 @@ class PresenceApi {
|
|
|
26247
26267
|
/**
|
|
26248
26268
|
* Presence service.
|
|
26249
26269
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
26250
|
-
* @version
|
|
26270
|
+
* @version 98.0.0
|
|
26251
26271
|
*/
|
|
26252
26272
|
|
|
26253
26273
|
/**
|
|
@@ -26594,7 +26614,7 @@ class QualityApi {
|
|
|
26594
26614
|
/**
|
|
26595
26615
|
* Quality service.
|
|
26596
26616
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
26597
|
-
* @version
|
|
26617
|
+
* @version 98.0.0
|
|
26598
26618
|
*/
|
|
26599
26619
|
|
|
26600
26620
|
/**
|
|
@@ -26808,8 +26828,8 @@ class QualityApi {
|
|
|
26808
26828
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
26809
26829
|
* @param {String} opts.nextPage next page token
|
|
26810
26830
|
* @param {String} opts.previousPage Previous page token
|
|
26811
|
-
* @param {Date} opts.startTime Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
26812
|
-
* @param {Date} opts.endTime End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
26831
|
+
* @param {Date} opts.startTime Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
26832
|
+
* @param {Date} opts.endTime End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
26813
26833
|
* @param {Array.<String>} opts.agentUserId user id of agent requested
|
|
26814
26834
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
26815
26835
|
* @param {String} opts.name name
|
|
@@ -26875,8 +26895,8 @@ class QualityApi {
|
|
|
26875
26895
|
* @param {String} opts.nextPage next page token
|
|
26876
26896
|
* @param {String} opts.previousPage Previous page token
|
|
26877
26897
|
* @param {String} opts.conversationId conversation id
|
|
26878
|
-
* @param {Date} opts.startTime Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
26879
|
-
* @param {Date} opts.endTime end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
26898
|
+
* @param {Date} opts.startTime Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
26899
|
+
* @param {Date} opts.endTime end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
26880
26900
|
*/
|
|
26881
26901
|
getQualityCalibrations(calibratorId, opts) {
|
|
26882
26902
|
opts = opts || {};
|
|
@@ -27046,8 +27066,8 @@ class QualityApi {
|
|
|
27046
27066
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
27047
27067
|
* @param {String} opts.nextPage next page token
|
|
27048
27068
|
* @param {String} opts.previousPage Previous page token
|
|
27049
|
-
* @param {Date} opts.startTime The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
27050
|
-
* @param {Date} opts.endTime The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
27069
|
+
* @param {Date} opts.startTime The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
27070
|
+
* @param {Date} opts.endTime The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
27051
27071
|
* @param {String} opts.name Evaluator name
|
|
27052
27072
|
* @param {Array.<String>} opts.permission permission strings
|
|
27053
27073
|
* @param {String} opts.group group id
|
|
@@ -27188,6 +27208,7 @@ class QualityApi {
|
|
|
27188
27208
|
* @param {Object} opts Optional parameters
|
|
27189
27209
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
27190
27210
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
27211
|
+
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
27191
27212
|
*/
|
|
27192
27213
|
getQualityFormsEvaluationVersions(formId, opts) {
|
|
27193
27214
|
opts = opts || {};
|
|
@@ -27201,7 +27222,7 @@ class QualityApi {
|
|
|
27201
27222
|
'/api/v2/quality/forms/evaluations/{formId}/versions',
|
|
27202
27223
|
'GET',
|
|
27203
27224
|
{ 'formId': formId },
|
|
27204
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
27225
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
27205
27226
|
{ },
|
|
27206
27227
|
{ },
|
|
27207
27228
|
null,
|
|
@@ -28291,7 +28312,7 @@ class RecordingApi {
|
|
|
28291
28312
|
/**
|
|
28292
28313
|
* Recording service.
|
|
28293
28314
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
28294
|
-
* @version
|
|
28315
|
+
* @version 98.0.0
|
|
28295
28316
|
*/
|
|
28296
28317
|
|
|
28297
28318
|
/**
|
|
@@ -29537,7 +29558,7 @@ class ResponseManagementApi {
|
|
|
29537
29558
|
/**
|
|
29538
29559
|
* ResponseManagement service.
|
|
29539
29560
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
29540
|
-
* @version
|
|
29561
|
+
* @version 98.0.0
|
|
29541
29562
|
*/
|
|
29542
29563
|
|
|
29543
29564
|
/**
|
|
@@ -29862,7 +29883,7 @@ class RoutingApi {
|
|
|
29862
29883
|
/**
|
|
29863
29884
|
* Routing service.
|
|
29864
29885
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
29865
|
-
* @version
|
|
29886
|
+
* @version 98.0.0
|
|
29866
29887
|
*/
|
|
29867
29888
|
|
|
29868
29889
|
/**
|
|
@@ -32160,7 +32181,7 @@ class SCIMApi {
|
|
|
32160
32181
|
/**
|
|
32161
32182
|
* SCIM service.
|
|
32162
32183
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
32163
|
-
* @version
|
|
32184
|
+
* @version 98.0.0
|
|
32164
32185
|
*/
|
|
32165
32186
|
|
|
32166
32187
|
/**
|
|
@@ -32296,8 +32317,8 @@ class SCIMApi {
|
|
|
32296
32317
|
*
|
|
32297
32318
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
32298
32319
|
* @param {Object} opts Optional parameters
|
|
32299
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
32300
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32320
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
32321
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32301
32322
|
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
32302
32323
|
*/
|
|
32303
32324
|
getScimGroup(groupId, opts) {
|
|
@@ -32327,9 +32348,9 @@ class SCIMApi {
|
|
|
32327
32348
|
*
|
|
32328
32349
|
* @param {Object} opts Optional parameters
|
|
32329
32350
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
32330
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
32331
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
32332
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32351
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
32352
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
32353
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32333
32354
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
32334
32355
|
*/
|
|
32335
32356
|
getScimGroups(opts) {
|
|
@@ -32473,9 +32494,9 @@ class SCIMApi {
|
|
|
32473
32494
|
*
|
|
32474
32495
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
32475
32496
|
* @param {Object} opts Optional parameters
|
|
32476
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
32477
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32478
|
-
* @param {String} opts.ifNoneMatch
|
|
32497
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
32498
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32499
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
32479
32500
|
*/
|
|
32480
32501
|
getScimUser(userId, opts) {
|
|
32481
32502
|
opts = opts || {};
|
|
@@ -32504,9 +32525,9 @@ class SCIMApi {
|
|
|
32504
32525
|
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
32505
32526
|
* @param {Object} opts Optional parameters
|
|
32506
32527
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
32507
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
32508
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
32509
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32528
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
32529
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
32530
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32510
32531
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".
|
|
32511
32532
|
*/
|
|
32512
32533
|
getScimUsers(opts) {
|
|
@@ -32532,9 +32553,9 @@ class SCIMApi {
|
|
|
32532
32553
|
*
|
|
32533
32554
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
32534
32555
|
* @param {Object} opts Optional parameters
|
|
32535
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
32536
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32537
|
-
* @param {String} opts.ifNoneMatch
|
|
32556
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
32557
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32558
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
32538
32559
|
*/
|
|
32539
32560
|
getScimV2Group(groupId, opts) {
|
|
32540
32561
|
opts = opts || {};
|
|
@@ -32564,9 +32585,9 @@ class SCIMApi {
|
|
|
32564
32585
|
* @param {String} filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
32565
32586
|
* @param {Object} opts Optional parameters
|
|
32566
32587
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
32567
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
32568
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
32569
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32588
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
32589
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
32590
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32570
32591
|
*/
|
|
32571
32592
|
getScimV2Groups(filter, opts) {
|
|
32572
32593
|
opts = opts || {};
|
|
@@ -32713,8 +32734,8 @@ class SCIMApi {
|
|
|
32713
32734
|
*
|
|
32714
32735
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
32715
32736
|
* @param {Object} opts Optional parameters
|
|
32716
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
32717
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32737
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
32738
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32718
32739
|
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
32719
32740
|
*/
|
|
32720
32741
|
getScimV2User(userId, opts) {
|
|
@@ -32744,9 +32765,9 @@ class SCIMApi {
|
|
|
32744
32765
|
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
32745
32766
|
* @param {Object} opts Optional parameters
|
|
32746
32767
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
32747
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
32748
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
32749
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32768
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
32769
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
32770
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
32750
32771
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".
|
|
32751
32772
|
*/
|
|
32752
32773
|
getScimV2Users(opts) {
|
|
@@ -32904,8 +32925,8 @@ class SCIMApi {
|
|
|
32904
32925
|
}
|
|
32905
32926
|
|
|
32906
32927
|
/**
|
|
32907
|
-
*
|
|
32908
|
-
* Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId}
|
|
32928
|
+
* Create a group
|
|
32929
|
+
* Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} is allowed.
|
|
32909
32930
|
* @param {Object} body The information used to create a group.
|
|
32910
32931
|
*/
|
|
32911
32932
|
postScimGroups(body) {
|
|
@@ -32956,7 +32977,7 @@ class SCIMApi {
|
|
|
32956
32977
|
/**
|
|
32957
32978
|
* Create a group
|
|
32958
32979
|
* Creates an \"official\" Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
32959
|
-
* @param {Object} body
|
|
32980
|
+
* @param {Object} body The information used to create a group.
|
|
32960
32981
|
*/
|
|
32961
32982
|
postScimV2Groups(body) {
|
|
32962
32983
|
// verify the required parameter 'body' is set
|
|
@@ -33145,7 +33166,7 @@ class ScriptsApi {
|
|
|
33145
33166
|
/**
|
|
33146
33167
|
* Scripts service.
|
|
33147
33168
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
33148
|
-
* @version
|
|
33169
|
+
* @version 98.0.0
|
|
33149
33170
|
*/
|
|
33150
33171
|
|
|
33151
33172
|
/**
|
|
@@ -33498,7 +33519,7 @@ class SearchApi {
|
|
|
33498
33519
|
/**
|
|
33499
33520
|
* Search service.
|
|
33500
33521
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
33501
|
-
* @version
|
|
33522
|
+
* @version 98.0.0
|
|
33502
33523
|
*/
|
|
33503
33524
|
|
|
33504
33525
|
/**
|
|
@@ -34008,7 +34029,7 @@ class SpeechTextAnalyticsApi {
|
|
|
34008
34029
|
/**
|
|
34009
34030
|
* SpeechTextAnalytics service.
|
|
34010
34031
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
34011
|
-
* @version
|
|
34032
|
+
* @version 98.0.0
|
|
34012
34033
|
*/
|
|
34013
34034
|
|
|
34014
34035
|
/**
|
|
@@ -34084,7 +34105,7 @@ class StationsApi {
|
|
|
34084
34105
|
/**
|
|
34085
34106
|
* Stations service.
|
|
34086
34107
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
34087
|
-
* @version
|
|
34108
|
+
* @version 98.0.0
|
|
34088
34109
|
*/
|
|
34089
34110
|
|
|
34090
34111
|
/**
|
|
@@ -34231,7 +34252,7 @@ class SuggestApi {
|
|
|
34231
34252
|
/**
|
|
34232
34253
|
* Suggest service.
|
|
34233
34254
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
34234
|
-
* @version
|
|
34255
|
+
* @version 98.0.0
|
|
34235
34256
|
*/
|
|
34236
34257
|
|
|
34237
34258
|
/**
|
|
@@ -34370,7 +34391,7 @@ class TelephonyApi {
|
|
|
34370
34391
|
/**
|
|
34371
34392
|
* Telephony service.
|
|
34372
34393
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
34373
|
-
* @version
|
|
34394
|
+
* @version 98.0.0
|
|
34374
34395
|
*/
|
|
34375
34396
|
|
|
34376
34397
|
/**
|
|
@@ -34388,8 +34409,8 @@ class TelephonyApi {
|
|
|
34388
34409
|
/**
|
|
34389
34410
|
* Fetch SIP metadata
|
|
34390
34411
|
* Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
|
|
34391
|
-
* @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
34392
|
-
* @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
34412
|
+
* @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
34413
|
+
* @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
34393
34414
|
* @param {Object} opts Optional parameters
|
|
34394
34415
|
* @param {String} opts.callId unique identification of the placed call
|
|
34395
34416
|
* @param {String} opts.toUser User to who the call was placed
|
|
@@ -34478,7 +34499,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
34478
34499
|
/**
|
|
34479
34500
|
* TelephonyProvidersEdge service.
|
|
34480
34501
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
34481
|
-
* @version
|
|
34502
|
+
* @version 98.0.0
|
|
34482
34503
|
*/
|
|
34483
34504
|
|
|
34484
34505
|
/**
|
|
@@ -38055,7 +38076,7 @@ class TextbotsApi {
|
|
|
38055
38076
|
/**
|
|
38056
38077
|
* Textbots service.
|
|
38057
38078
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
38058
|
-
* @version
|
|
38079
|
+
* @version 98.0.0
|
|
38059
38080
|
*/
|
|
38060
38081
|
|
|
38061
38082
|
/**
|
|
@@ -38101,7 +38122,7 @@ class TokensApi {
|
|
|
38101
38122
|
/**
|
|
38102
38123
|
* Tokens service.
|
|
38103
38124
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
38104
|
-
* @version
|
|
38125
|
+
* @version 98.0.0
|
|
38105
38126
|
*/
|
|
38106
38127
|
|
|
38107
38128
|
/**
|
|
@@ -38187,7 +38208,7 @@ class UploadsApi {
|
|
|
38187
38208
|
/**
|
|
38188
38209
|
* Uploads service.
|
|
38189
38210
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
38190
|
-
* @version
|
|
38211
|
+
* @version 98.0.0
|
|
38191
38212
|
*/
|
|
38192
38213
|
|
|
38193
38214
|
/**
|
|
@@ -38233,7 +38254,7 @@ class UsageApi {
|
|
|
38233
38254
|
/**
|
|
38234
38255
|
* Usage service.
|
|
38235
38256
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
38236
|
-
* @version
|
|
38257
|
+
* @version 98.0.0
|
|
38237
38258
|
*/
|
|
38238
38259
|
|
|
38239
38260
|
/**
|
|
@@ -38300,154 +38321,11 @@ class UsageApi {
|
|
|
38300
38321
|
|
|
38301
38322
|
}
|
|
38302
38323
|
|
|
38303
|
-
class UserDevelopmentApi {
|
|
38304
|
-
/**
|
|
38305
|
-
* UserDevelopment service.
|
|
38306
|
-
* @module purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
38307
|
-
* @version 95.0.0
|
|
38308
|
-
*/
|
|
38309
|
-
|
|
38310
|
-
/**
|
|
38311
|
-
* Constructs a new UserDevelopmentApi.
|
|
38312
|
-
* @alias module:purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
38313
|
-
* @class
|
|
38314
|
-
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
38315
|
-
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
38316
|
-
*/
|
|
38317
|
-
constructor(apiClient) {
|
|
38318
|
-
this.apiClient = apiClient || ApiClient.instance;
|
|
38319
|
-
}
|
|
38320
|
-
|
|
38321
|
-
|
|
38322
|
-
/**
|
|
38323
|
-
* Get list of Development Activities
|
|
38324
|
-
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
38325
|
-
* @param {Object} opts Optional parameters
|
|
38326
|
-
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.
|
|
38327
|
-
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
38328
|
-
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
38329
|
-
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
38330
|
-
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
38331
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38332
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38333
|
-
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
38334
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
38335
|
-
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
38336
|
-
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
38337
|
-
*/
|
|
38338
|
-
getUsersDevelopmentActivities(opts) {
|
|
38339
|
-
opts = opts || {};
|
|
38340
|
-
|
|
38341
|
-
|
|
38342
|
-
return this.apiClient.callApi(
|
|
38343
|
-
'/api/v2/users/development/activities',
|
|
38344
|
-
'GET',
|
|
38345
|
-
{ },
|
|
38346
|
-
{ 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
38347
|
-
{ },
|
|
38348
|
-
{ },
|
|
38349
|
-
null,
|
|
38350
|
-
['PureCloud OAuth'],
|
|
38351
|
-
['application/json'],
|
|
38352
|
-
['application/json']
|
|
38353
|
-
);
|
|
38354
|
-
}
|
|
38355
|
-
|
|
38356
|
-
/**
|
|
38357
|
-
* Get list of Development Activities for current user
|
|
38358
|
-
* Results are filtered based on the applicable permissions.
|
|
38359
|
-
* @param {Object} opts Optional parameters
|
|
38360
|
-
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
38361
|
-
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
38362
|
-
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
38363
|
-
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
38364
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38365
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38366
|
-
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
38367
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
38368
|
-
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
38369
|
-
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
38370
|
-
*/
|
|
38371
|
-
getUsersDevelopmentActivitiesMe(opts) {
|
|
38372
|
-
opts = opts || {};
|
|
38373
|
-
|
|
38374
|
-
|
|
38375
|
-
return this.apiClient.callApi(
|
|
38376
|
-
'/api/v2/users/development/activities/me',
|
|
38377
|
-
'GET',
|
|
38378
|
-
{ },
|
|
38379
|
-
{ 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
38380
|
-
{ },
|
|
38381
|
-
{ },
|
|
38382
|
-
null,
|
|
38383
|
-
['PureCloud OAuth'],
|
|
38384
|
-
['application/json'],
|
|
38385
|
-
['application/json']
|
|
38386
|
-
);
|
|
38387
|
-
}
|
|
38388
|
-
|
|
38389
|
-
/**
|
|
38390
|
-
* Get a Development Activity
|
|
38391
|
-
*
|
|
38392
|
-
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
38393
|
-
* @param {Object} type Specifies the activity type.
|
|
38394
|
-
*/
|
|
38395
|
-
getUsersDevelopmentActivity(activityId, type) {
|
|
38396
|
-
// verify the required parameter 'activityId' is set
|
|
38397
|
-
if (activityId === undefined || activityId === null) {
|
|
38398
|
-
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
38399
|
-
}
|
|
38400
|
-
// verify the required parameter 'type' is set
|
|
38401
|
-
if (type === undefined || type === null) {
|
|
38402
|
-
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
38403
|
-
}
|
|
38404
|
-
|
|
38405
|
-
return this.apiClient.callApi(
|
|
38406
|
-
'/api/v2/users/development/activities/{activityId}',
|
|
38407
|
-
'GET',
|
|
38408
|
-
{ 'activityId': activityId },
|
|
38409
|
-
{ 'type': type },
|
|
38410
|
-
{ },
|
|
38411
|
-
{ },
|
|
38412
|
-
null,
|
|
38413
|
-
['PureCloud OAuth'],
|
|
38414
|
-
['application/json'],
|
|
38415
|
-
['application/json']
|
|
38416
|
-
);
|
|
38417
|
-
}
|
|
38418
|
-
|
|
38419
|
-
/**
|
|
38420
|
-
* Retrieve aggregated development activity data
|
|
38421
|
-
* Results are filtered based on the applicable permissions.
|
|
38422
|
-
* @param {Object} body Aggregate Request
|
|
38423
|
-
*/
|
|
38424
|
-
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
38425
|
-
// verify the required parameter 'body' is set
|
|
38426
|
-
if (body === undefined || body === null) {
|
|
38427
|
-
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
38428
|
-
}
|
|
38429
|
-
|
|
38430
|
-
return this.apiClient.callApi(
|
|
38431
|
-
'/api/v2/users/development/activities/aggregates/query',
|
|
38432
|
-
'POST',
|
|
38433
|
-
{ },
|
|
38434
|
-
{ },
|
|
38435
|
-
{ },
|
|
38436
|
-
{ },
|
|
38437
|
-
body,
|
|
38438
|
-
['PureCloud OAuth'],
|
|
38439
|
-
['application/json'],
|
|
38440
|
-
['application/json']
|
|
38441
|
-
);
|
|
38442
|
-
}
|
|
38443
|
-
|
|
38444
|
-
}
|
|
38445
|
-
|
|
38446
38324
|
class UserRecordingsApi {
|
|
38447
38325
|
/**
|
|
38448
38326
|
* UserRecordings service.
|
|
38449
38327
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
38450
|
-
* @version
|
|
38328
|
+
* @version 98.0.0
|
|
38451
38329
|
*/
|
|
38452
38330
|
|
|
38453
38331
|
/**
|
|
@@ -38631,7 +38509,7 @@ class UsersApi {
|
|
|
38631
38509
|
/**
|
|
38632
38510
|
* Users service.
|
|
38633
38511
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
38634
|
-
* @version
|
|
38512
|
+
* @version 98.0.0
|
|
38635
38513
|
*/
|
|
38636
38514
|
|
|
38637
38515
|
/**
|
|
@@ -39675,6 +39553,103 @@ class UsersApi {
|
|
|
39675
39553
|
);
|
|
39676
39554
|
}
|
|
39677
39555
|
|
|
39556
|
+
/**
|
|
39557
|
+
* Get list of Development Activities
|
|
39558
|
+
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
39559
|
+
* @param {Object} opts Optional parameters
|
|
39560
|
+
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.
|
|
39561
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
39562
|
+
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
39563
|
+
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
39564
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
39565
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39566
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
39567
|
+
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
39568
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
39569
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
39570
|
+
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
39571
|
+
*/
|
|
39572
|
+
getUsersDevelopmentActivities(opts) {
|
|
39573
|
+
opts = opts || {};
|
|
39574
|
+
|
|
39575
|
+
|
|
39576
|
+
return this.apiClient.callApi(
|
|
39577
|
+
'/api/v2/users/development/activities',
|
|
39578
|
+
'GET',
|
|
39579
|
+
{ },
|
|
39580
|
+
{ 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
39581
|
+
{ },
|
|
39582
|
+
{ },
|
|
39583
|
+
null,
|
|
39584
|
+
['PureCloud OAuth'],
|
|
39585
|
+
['application/json'],
|
|
39586
|
+
['application/json']
|
|
39587
|
+
);
|
|
39588
|
+
}
|
|
39589
|
+
|
|
39590
|
+
/**
|
|
39591
|
+
* Get list of Development Activities for current user
|
|
39592
|
+
* Results are filtered based on the applicable permissions.
|
|
39593
|
+
* @param {Object} opts Optional parameters
|
|
39594
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
39595
|
+
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
39596
|
+
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
39597
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
39598
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39599
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
39600
|
+
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
39601
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
39602
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
39603
|
+
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
39604
|
+
*/
|
|
39605
|
+
getUsersDevelopmentActivitiesMe(opts) {
|
|
39606
|
+
opts = opts || {};
|
|
39607
|
+
|
|
39608
|
+
|
|
39609
|
+
return this.apiClient.callApi(
|
|
39610
|
+
'/api/v2/users/development/activities/me',
|
|
39611
|
+
'GET',
|
|
39612
|
+
{ },
|
|
39613
|
+
{ 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
39614
|
+
{ },
|
|
39615
|
+
{ },
|
|
39616
|
+
null,
|
|
39617
|
+
['PureCloud OAuth'],
|
|
39618
|
+
['application/json'],
|
|
39619
|
+
['application/json']
|
|
39620
|
+
);
|
|
39621
|
+
}
|
|
39622
|
+
|
|
39623
|
+
/**
|
|
39624
|
+
* Get a Development Activity
|
|
39625
|
+
*
|
|
39626
|
+
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
39627
|
+
* @param {Object} type Specifies the activity type.
|
|
39628
|
+
*/
|
|
39629
|
+
getUsersDevelopmentActivity(activityId, type) {
|
|
39630
|
+
// verify the required parameter 'activityId' is set
|
|
39631
|
+
if (activityId === undefined || activityId === null) {
|
|
39632
|
+
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
39633
|
+
}
|
|
39634
|
+
// verify the required parameter 'type' is set
|
|
39635
|
+
if (type === undefined || type === null) {
|
|
39636
|
+
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
39637
|
+
}
|
|
39638
|
+
|
|
39639
|
+
return this.apiClient.callApi(
|
|
39640
|
+
'/api/v2/users/development/activities/{activityId}',
|
|
39641
|
+
'GET',
|
|
39642
|
+
{ 'activityId': activityId },
|
|
39643
|
+
{ 'type': type },
|
|
39644
|
+
{ },
|
|
39645
|
+
{ },
|
|
39646
|
+
null,
|
|
39647
|
+
['PureCloud OAuth'],
|
|
39648
|
+
['application/json'],
|
|
39649
|
+
['application/json']
|
|
39650
|
+
);
|
|
39651
|
+
}
|
|
39652
|
+
|
|
39678
39653
|
/**
|
|
39679
39654
|
* Get current user details.
|
|
39680
39655
|
* This request is not valid when using the Client Credentials OAuth grant.
|
|
@@ -40361,6 +40336,31 @@ class UsersApi {
|
|
|
40361
40336
|
);
|
|
40362
40337
|
}
|
|
40363
40338
|
|
|
40339
|
+
/**
|
|
40340
|
+
* Retrieve aggregated development activity data
|
|
40341
|
+
* Results are filtered based on the applicable permissions.
|
|
40342
|
+
* @param {Object} body Aggregate Request
|
|
40343
|
+
*/
|
|
40344
|
+
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
40345
|
+
// verify the required parameter 'body' is set
|
|
40346
|
+
if (body === undefined || body === null) {
|
|
40347
|
+
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
40348
|
+
}
|
|
40349
|
+
|
|
40350
|
+
return this.apiClient.callApi(
|
|
40351
|
+
'/api/v2/users/development/activities/aggregates/query',
|
|
40352
|
+
'POST',
|
|
40353
|
+
{ },
|
|
40354
|
+
{ },
|
|
40355
|
+
{ },
|
|
40356
|
+
{ },
|
|
40357
|
+
body,
|
|
40358
|
+
['PureCloud OAuth'],
|
|
40359
|
+
['application/json'],
|
|
40360
|
+
['application/json']
|
|
40361
|
+
);
|
|
40362
|
+
}
|
|
40363
|
+
|
|
40364
40364
|
/**
|
|
40365
40365
|
* Change your password
|
|
40366
40366
|
*
|
|
@@ -40722,7 +40722,7 @@ class UtilitiesApi {
|
|
|
40722
40722
|
/**
|
|
40723
40723
|
* Utilities service.
|
|
40724
40724
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
40725
|
-
* @version
|
|
40725
|
+
* @version 98.0.0
|
|
40726
40726
|
*/
|
|
40727
40727
|
|
|
40728
40728
|
/**
|
|
@@ -40833,7 +40833,7 @@ class VoicemailApi {
|
|
|
40833
40833
|
/**
|
|
40834
40834
|
* Voicemail service.
|
|
40835
40835
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
40836
|
-
* @version
|
|
40836
|
+
* @version 98.0.0
|
|
40837
40837
|
*/
|
|
40838
40838
|
|
|
40839
40839
|
/**
|
|
@@ -41470,7 +41470,7 @@ class WebChatApi {
|
|
|
41470
41470
|
/**
|
|
41471
41471
|
* WebChat service.
|
|
41472
41472
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
41473
|
-
* @version
|
|
41473
|
+
* @version 98.0.0
|
|
41474
41474
|
*/
|
|
41475
41475
|
|
|
41476
41476
|
/**
|
|
@@ -42014,7 +42014,7 @@ class WidgetsApi {
|
|
|
42014
42014
|
/**
|
|
42015
42015
|
* Widgets service.
|
|
42016
42016
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
42017
|
-
* @version
|
|
42017
|
+
* @version 98.0.0
|
|
42018
42018
|
*/
|
|
42019
42019
|
|
|
42020
42020
|
/**
|
|
@@ -42160,7 +42160,7 @@ class WorkforceManagementApi {
|
|
|
42160
42160
|
/**
|
|
42161
42161
|
* WorkforceManagement service.
|
|
42162
42162
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
42163
|
-
* @version
|
|
42163
|
+
* @version 98.0.0
|
|
42164
42164
|
*/
|
|
42165
42165
|
|
|
42166
42166
|
/**
|
|
@@ -42416,155 +42416,25 @@ class WorkforceManagementApi {
|
|
|
42416
42416
|
}
|
|
42417
42417
|
|
|
42418
42418
|
/**
|
|
42419
|
-
*
|
|
42420
|
-
*
|
|
42421
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42422
|
-
* @param {String} acId The ID of the activity code to delete
|
|
42423
|
-
*/
|
|
42424
|
-
deleteWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
42425
|
-
// verify the required parameter 'muId' is set
|
|
42426
|
-
if (muId === undefined || muId === null) {
|
|
42427
|
-
throw 'Missing the required parameter "muId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
42428
|
-
}
|
|
42429
|
-
// verify the required parameter 'acId' is set
|
|
42430
|
-
if (acId === undefined || acId === null) {
|
|
42431
|
-
throw 'Missing the required parameter "acId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
42432
|
-
}
|
|
42433
|
-
|
|
42434
|
-
return this.apiClient.callApi(
|
|
42435
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
42436
|
-
'DELETE',
|
|
42437
|
-
{ 'muId': muId,'acId': acId },
|
|
42438
|
-
{ },
|
|
42439
|
-
{ },
|
|
42440
|
-
{ },
|
|
42441
|
-
null,
|
|
42442
|
-
['PureCloud OAuth'],
|
|
42443
|
-
['application/json'],
|
|
42444
|
-
['application/json']
|
|
42445
|
-
);
|
|
42446
|
-
}
|
|
42447
|
-
|
|
42448
|
-
/**
|
|
42449
|
-
* Gone. Scheduling has moved under business units
|
|
42450
|
-
*
|
|
42451
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
42452
|
-
* @param {String} runId The ID of the schedule run
|
|
42453
|
-
*/
|
|
42454
|
-
deleteWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
42455
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42456
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42457
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
42458
|
-
}
|
|
42459
|
-
// verify the required parameter 'runId' is set
|
|
42460
|
-
if (runId === undefined || runId === null) {
|
|
42461
|
-
throw 'Missing the required parameter "runId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
42462
|
-
}
|
|
42463
|
-
|
|
42464
|
-
return this.apiClient.callApi(
|
|
42465
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
42466
|
-
'DELETE',
|
|
42467
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
42468
|
-
{ },
|
|
42469
|
-
{ },
|
|
42470
|
-
{ },
|
|
42471
|
-
null,
|
|
42472
|
-
['PureCloud OAuth'],
|
|
42473
|
-
['application/json'],
|
|
42474
|
-
['application/json']
|
|
42475
|
-
);
|
|
42476
|
-
}
|
|
42477
|
-
|
|
42478
|
-
/**
|
|
42479
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
42480
|
-
*
|
|
42481
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42482
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to delete
|
|
42483
|
-
*/
|
|
42484
|
-
deleteWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
42485
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42486
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42487
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
42488
|
-
}
|
|
42489
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
42490
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
42491
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
42492
|
-
}
|
|
42493
|
-
|
|
42494
|
-
return this.apiClient.callApi(
|
|
42495
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
42496
|
-
'DELETE',
|
|
42497
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
42498
|
-
{ },
|
|
42499
|
-
{ },
|
|
42500
|
-
{ },
|
|
42501
|
-
null,
|
|
42502
|
-
['PureCloud OAuth'],
|
|
42503
|
-
['application/json'],
|
|
42504
|
-
['application/json']
|
|
42505
|
-
);
|
|
42506
|
-
}
|
|
42507
|
-
|
|
42508
|
-
/**
|
|
42509
|
-
* Gone. Scheduling has moved under business units
|
|
42419
|
+
* Delete a work plan
|
|
42510
42420
|
*
|
|
42511
42421
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42512
|
-
* @param {String}
|
|
42513
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to delete
|
|
42514
|
-
*/
|
|
42515
|
-
deleteWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
42516
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42517
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42518
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
42519
|
-
}
|
|
42520
|
-
// verify the required parameter 'weekId' is set
|
|
42521
|
-
if (weekId === undefined || weekId === null) {
|
|
42522
|
-
throw 'Missing the required parameter "weekId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
42523
|
-
}
|
|
42524
|
-
// verify the required parameter 'scheduleId' is set
|
|
42525
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
42526
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
42527
|
-
}
|
|
42528
|
-
|
|
42529
|
-
return this.apiClient.callApi(
|
|
42530
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
42531
|
-
'DELETE',
|
|
42532
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
42533
|
-
{ },
|
|
42534
|
-
{ },
|
|
42535
|
-
{ },
|
|
42536
|
-
null,
|
|
42537
|
-
['PureCloud OAuth'],
|
|
42538
|
-
['application/json'],
|
|
42539
|
-
['application/json']
|
|
42540
|
-
);
|
|
42541
|
-
}
|
|
42542
|
-
|
|
42543
|
-
/**
|
|
42544
|
-
* Gone. Use equivalent business unit resource instead
|
|
42545
|
-
*
|
|
42546
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
42547
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
42548
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
42422
|
+
* @param {String} workPlanId The ID of the work plan to delete
|
|
42549
42423
|
*/
|
|
42550
|
-
|
|
42424
|
+
deleteWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId) {
|
|
42551
42425
|
// verify the required parameter 'managementUnitId' is set
|
|
42552
42426
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42553
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
42554
|
-
}
|
|
42555
|
-
// verify the required parameter 'weekDateId' is set
|
|
42556
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
42557
|
-
throw 'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
42427
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplan';
|
|
42558
42428
|
}
|
|
42559
|
-
// verify the required parameter '
|
|
42560
|
-
if (
|
|
42561
|
-
throw 'Missing the required parameter "
|
|
42429
|
+
// verify the required parameter 'workPlanId' is set
|
|
42430
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
42431
|
+
throw 'Missing the required parameter "workPlanId" when calling deleteWorkforcemanagementManagementunitWorkplan';
|
|
42562
42432
|
}
|
|
42563
42433
|
|
|
42564
42434
|
return this.apiClient.callApi(
|
|
42565
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
42435
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
42566
42436
|
'DELETE',
|
|
42567
|
-
{ 'managementUnitId': managementUnitId,'
|
|
42437
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
42568
42438
|
{ },
|
|
42569
42439
|
{ },
|
|
42570
42440
|
{ },
|
|
@@ -42576,25 +42446,25 @@ class WorkforceManagementApi {
|
|
|
42576
42446
|
}
|
|
42577
42447
|
|
|
42578
42448
|
/**
|
|
42579
|
-
* Delete a work plan
|
|
42449
|
+
* Delete a work plan rotation
|
|
42580
42450
|
*
|
|
42581
42451
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42582
|
-
* @param {String}
|
|
42452
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
|
|
42583
42453
|
*/
|
|
42584
|
-
|
|
42454
|
+
deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
42585
42455
|
// verify the required parameter 'managementUnitId' is set
|
|
42586
42456
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42587
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
42457
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
42588
42458
|
}
|
|
42589
|
-
// verify the required parameter '
|
|
42590
|
-
if (
|
|
42591
|
-
throw 'Missing the required parameter "
|
|
42459
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
42460
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
42461
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
42592
42462
|
}
|
|
42593
42463
|
|
|
42594
42464
|
return this.apiClient.callApi(
|
|
42595
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
42465
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
42596
42466
|
'DELETE',
|
|
42597
|
-
{ 'managementUnitId': managementUnitId,'
|
|
42467
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
42598
42468
|
{ },
|
|
42599
42469
|
{ },
|
|
42600
42470
|
{ },
|
|
@@ -43409,36 +43279,6 @@ class WorkforceManagementApi {
|
|
|
43409
43279
|
);
|
|
43410
43280
|
}
|
|
43411
43281
|
|
|
43412
|
-
/**
|
|
43413
|
-
* Get an activity code
|
|
43414
|
-
*
|
|
43415
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43416
|
-
* @param {String} acId The ID of the activity code to fetch
|
|
43417
|
-
*/
|
|
43418
|
-
getWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
43419
|
-
// verify the required parameter 'muId' is set
|
|
43420
|
-
if (muId === undefined || muId === null) {
|
|
43421
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
43422
|
-
}
|
|
43423
|
-
// verify the required parameter 'acId' is set
|
|
43424
|
-
if (acId === undefined || acId === null) {
|
|
43425
|
-
throw 'Missing the required parameter "acId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
43426
|
-
}
|
|
43427
|
-
|
|
43428
|
-
return this.apiClient.callApi(
|
|
43429
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
43430
|
-
'GET',
|
|
43431
|
-
{ 'muId': muId,'acId': acId },
|
|
43432
|
-
{ },
|
|
43433
|
-
{ },
|
|
43434
|
-
{ },
|
|
43435
|
-
null,
|
|
43436
|
-
['PureCloud OAuth'],
|
|
43437
|
-
['application/json'],
|
|
43438
|
-
['application/json']
|
|
43439
|
-
);
|
|
43440
|
-
}
|
|
43441
|
-
|
|
43442
43282
|
/**
|
|
43443
43283
|
* Get activity codes
|
|
43444
43284
|
*
|
|
@@ -43557,196 +43397,6 @@ class WorkforceManagementApi {
|
|
|
43557
43397
|
);
|
|
43558
43398
|
}
|
|
43559
43399
|
|
|
43560
|
-
/**
|
|
43561
|
-
* Gone. Moved under business units
|
|
43562
|
-
*
|
|
43563
|
-
* @param {String} muId The management unit ID of the management unit
|
|
43564
|
-
*/
|
|
43565
|
-
getWorkforcemanagementManagementunitIntradayQueues(muId) {
|
|
43566
|
-
// verify the required parameter 'muId' is set
|
|
43567
|
-
if (muId === undefined || muId === null) {
|
|
43568
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitIntradayQueues';
|
|
43569
|
-
}
|
|
43570
|
-
|
|
43571
|
-
return this.apiClient.callApi(
|
|
43572
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday/queues',
|
|
43573
|
-
'GET',
|
|
43574
|
-
{ 'muId': muId },
|
|
43575
|
-
{ },
|
|
43576
|
-
{ },
|
|
43577
|
-
{ },
|
|
43578
|
-
null,
|
|
43579
|
-
['PureCloud OAuth'],
|
|
43580
|
-
['application/json'],
|
|
43581
|
-
['application/json']
|
|
43582
|
-
);
|
|
43583
|
-
}
|
|
43584
|
-
|
|
43585
|
-
/**
|
|
43586
|
-
* Gone. Scheduling has moved under business units
|
|
43587
|
-
*
|
|
43588
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
43589
|
-
* @param {String} runId The ID of the schedule run
|
|
43590
|
-
*/
|
|
43591
|
-
getWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
43592
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43593
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43594
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
43595
|
-
}
|
|
43596
|
-
// verify the required parameter 'runId' is set
|
|
43597
|
-
if (runId === undefined || runId === null) {
|
|
43598
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
43599
|
-
}
|
|
43600
|
-
|
|
43601
|
-
return this.apiClient.callApi(
|
|
43602
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
43603
|
-
'GET',
|
|
43604
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
43605
|
-
{ },
|
|
43606
|
-
{ },
|
|
43607
|
-
{ },
|
|
43608
|
-
null,
|
|
43609
|
-
['PureCloud OAuth'],
|
|
43610
|
-
['application/json'],
|
|
43611
|
-
['application/json']
|
|
43612
|
-
);
|
|
43613
|
-
}
|
|
43614
|
-
|
|
43615
|
-
/**
|
|
43616
|
-
* Gone. Scheduling has moved under business units
|
|
43617
|
-
*
|
|
43618
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
43619
|
-
* @param {String} runId The ID of the schedule run
|
|
43620
|
-
*/
|
|
43621
|
-
getWorkforcemanagementManagementunitSchedulingRunResult(managementUnitId, runId) {
|
|
43622
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43623
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43624
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
|
|
43625
|
-
}
|
|
43626
|
-
// verify the required parameter 'runId' is set
|
|
43627
|
-
if (runId === undefined || runId === null) {
|
|
43628
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
|
|
43629
|
-
}
|
|
43630
|
-
|
|
43631
|
-
return this.apiClient.callApi(
|
|
43632
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}/result',
|
|
43633
|
-
'GET',
|
|
43634
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
43635
|
-
{ },
|
|
43636
|
-
{ },
|
|
43637
|
-
{ },
|
|
43638
|
-
null,
|
|
43639
|
-
['PureCloud OAuth'],
|
|
43640
|
-
['application/json'],
|
|
43641
|
-
['application/json']
|
|
43642
|
-
);
|
|
43643
|
-
}
|
|
43644
|
-
|
|
43645
|
-
/**
|
|
43646
|
-
* Gone. Scheduling has moved under business units
|
|
43647
|
-
*
|
|
43648
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
43649
|
-
*/
|
|
43650
|
-
getWorkforcemanagementManagementunitSchedulingRuns(managementUnitId) {
|
|
43651
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43652
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43653
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRuns';
|
|
43654
|
-
}
|
|
43655
|
-
|
|
43656
|
-
return this.apiClient.callApi(
|
|
43657
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs',
|
|
43658
|
-
'GET',
|
|
43659
|
-
{ 'managementUnitId': managementUnitId },
|
|
43660
|
-
{ },
|
|
43661
|
-
{ },
|
|
43662
|
-
{ },
|
|
43663
|
-
null,
|
|
43664
|
-
['PureCloud OAuth'],
|
|
43665
|
-
['application/json'],
|
|
43666
|
-
['application/json']
|
|
43667
|
-
);
|
|
43668
|
-
}
|
|
43669
|
-
|
|
43670
|
-
/**
|
|
43671
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
43672
|
-
*
|
|
43673
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43674
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to fetch
|
|
43675
|
-
*/
|
|
43676
|
-
getWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
43677
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43678
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43679
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
43680
|
-
}
|
|
43681
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
43682
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
43683
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
43684
|
-
}
|
|
43685
|
-
|
|
43686
|
-
return this.apiClient.callApi(
|
|
43687
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
43688
|
-
'GET',
|
|
43689
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
43690
|
-
{ },
|
|
43691
|
-
{ },
|
|
43692
|
-
{ },
|
|
43693
|
-
null,
|
|
43694
|
-
['PureCloud OAuth'],
|
|
43695
|
-
['application/json'],
|
|
43696
|
-
['application/json']
|
|
43697
|
-
);
|
|
43698
|
-
}
|
|
43699
|
-
|
|
43700
|
-
/**
|
|
43701
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
43702
|
-
*
|
|
43703
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43704
|
-
*/
|
|
43705
|
-
getWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
43706
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43707
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43708
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroups';
|
|
43709
|
-
}
|
|
43710
|
-
|
|
43711
|
-
return this.apiClient.callApi(
|
|
43712
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
43713
|
-
'GET',
|
|
43714
|
-
{ 'managementUnitId': managementUnitId },
|
|
43715
|
-
{ },
|
|
43716
|
-
{ },
|
|
43717
|
-
{ },
|
|
43718
|
-
null,
|
|
43719
|
-
['PureCloud OAuth'],
|
|
43720
|
-
['application/json'],
|
|
43721
|
-
['application/json']
|
|
43722
|
-
);
|
|
43723
|
-
}
|
|
43724
|
-
|
|
43725
|
-
/**
|
|
43726
|
-
* Gone. Get management unit settings via expand parameters on the GET management unit
|
|
43727
|
-
*
|
|
43728
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43729
|
-
*/
|
|
43730
|
-
getWorkforcemanagementManagementunitSettings(muId) {
|
|
43731
|
-
// verify the required parameter 'muId' is set
|
|
43732
|
-
if (muId === undefined || muId === null) {
|
|
43733
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitSettings';
|
|
43734
|
-
}
|
|
43735
|
-
|
|
43736
|
-
return this.apiClient.callApi(
|
|
43737
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
43738
|
-
'GET',
|
|
43739
|
-
{ 'muId': muId },
|
|
43740
|
-
{ },
|
|
43741
|
-
{ },
|
|
43742
|
-
{ },
|
|
43743
|
-
null,
|
|
43744
|
-
['PureCloud OAuth'],
|
|
43745
|
-
['application/json'],
|
|
43746
|
-
['application/json']
|
|
43747
|
-
);
|
|
43748
|
-
}
|
|
43749
|
-
|
|
43750
43400
|
/**
|
|
43751
43401
|
* Gets a summary of all shift trades in the matched state
|
|
43752
43402
|
*
|
|
@@ -43931,41 +43581,6 @@ class WorkforceManagementApi {
|
|
|
43931
43581
|
);
|
|
43932
43582
|
}
|
|
43933
43583
|
|
|
43934
|
-
/**
|
|
43935
|
-
* Gone. Scheduling has moved under business units
|
|
43936
|
-
*
|
|
43937
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43938
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43939
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to fetch generation results
|
|
43940
|
-
*/
|
|
43941
|
-
getWorkforcemanagementManagementunitWeekScheduleGenerationresults(managementUnitId, weekId, scheduleId) {
|
|
43942
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43943
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43944
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
43945
|
-
}
|
|
43946
|
-
// verify the required parameter 'weekId' is set
|
|
43947
|
-
if (weekId === undefined || weekId === null) {
|
|
43948
|
-
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
43949
|
-
}
|
|
43950
|
-
// verify the required parameter 'scheduleId' is set
|
|
43951
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
43952
|
-
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
43953
|
-
}
|
|
43954
|
-
|
|
43955
|
-
return this.apiClient.callApi(
|
|
43956
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults',
|
|
43957
|
-
'GET',
|
|
43958
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
43959
|
-
{ },
|
|
43960
|
-
{ },
|
|
43961
|
-
{ },
|
|
43962
|
-
null,
|
|
43963
|
-
['PureCloud OAuth'],
|
|
43964
|
-
['application/json'],
|
|
43965
|
-
['application/json']
|
|
43966
|
-
);
|
|
43967
|
-
}
|
|
43968
|
-
|
|
43969
43584
|
/**
|
|
43970
43585
|
* Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
|
|
43971
43586
|
*
|
|
@@ -44036,71 +43651,6 @@ class WorkforceManagementApi {
|
|
|
44036
43651
|
);
|
|
44037
43652
|
}
|
|
44038
43653
|
|
|
44039
|
-
/**
|
|
44040
|
-
* Gone. Use equivalent business unit resource instead
|
|
44041
|
-
*
|
|
44042
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
44043
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
44044
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
44045
|
-
*/
|
|
44046
|
-
getWorkforcemanagementManagementunitWeekShorttermforecastFinal(managementUnitId, weekDateId, forecastId) {
|
|
44047
|
-
// verify the required parameter 'managementUnitId' is set
|
|
44048
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44049
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
44050
|
-
}
|
|
44051
|
-
// verify the required parameter 'weekDateId' is set
|
|
44052
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
44053
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
44054
|
-
}
|
|
44055
|
-
// verify the required parameter 'forecastId' is set
|
|
44056
|
-
if (forecastId === undefined || forecastId === null) {
|
|
44057
|
-
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
44058
|
-
}
|
|
44059
|
-
|
|
44060
|
-
return this.apiClient.callApi(
|
|
44061
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final',
|
|
44062
|
-
'GET',
|
|
44063
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
44064
|
-
{ },
|
|
44065
|
-
{ },
|
|
44066
|
-
{ },
|
|
44067
|
-
null,
|
|
44068
|
-
['PureCloud OAuth'],
|
|
44069
|
-
['application/json'],
|
|
44070
|
-
['application/json']
|
|
44071
|
-
);
|
|
44072
|
-
}
|
|
44073
|
-
|
|
44074
|
-
/**
|
|
44075
|
-
* Gone. Use equivalent business unit resource instead
|
|
44076
|
-
*
|
|
44077
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
44078
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
44079
|
-
*/
|
|
44080
|
-
getWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
44081
|
-
// verify the required parameter 'managementUnitId' is set
|
|
44082
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44083
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
44084
|
-
}
|
|
44085
|
-
// verify the required parameter 'weekDateId' is set
|
|
44086
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
44087
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
44088
|
-
}
|
|
44089
|
-
|
|
44090
|
-
return this.apiClient.callApi(
|
|
44091
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
44092
|
-
'GET',
|
|
44093
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
44094
|
-
{ },
|
|
44095
|
-
{ },
|
|
44096
|
-
{ },
|
|
44097
|
-
null,
|
|
44098
|
-
['PureCloud OAuth'],
|
|
44099
|
-
['application/json'],
|
|
44100
|
-
['application/json']
|
|
44101
|
-
);
|
|
44102
|
-
}
|
|
44103
|
-
|
|
44104
43654
|
/**
|
|
44105
43655
|
* Get a work plan
|
|
44106
43656
|
*
|
|
@@ -44131,6 +43681,65 @@ class WorkforceManagementApi {
|
|
|
44131
43681
|
);
|
|
44132
43682
|
}
|
|
44133
43683
|
|
|
43684
|
+
/**
|
|
43685
|
+
* Get a work plan rotation
|
|
43686
|
+
*
|
|
43687
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43688
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to fetch
|
|
43689
|
+
*/
|
|
43690
|
+
getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
43691
|
+
// verify the required parameter 'managementUnitId' is set
|
|
43692
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43693
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
43694
|
+
}
|
|
43695
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
43696
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
43697
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
43698
|
+
}
|
|
43699
|
+
|
|
43700
|
+
return this.apiClient.callApi(
|
|
43701
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
43702
|
+
'GET',
|
|
43703
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
43704
|
+
{ },
|
|
43705
|
+
{ },
|
|
43706
|
+
{ },
|
|
43707
|
+
null,
|
|
43708
|
+
['PureCloud OAuth'],
|
|
43709
|
+
['application/json'],
|
|
43710
|
+
['application/json']
|
|
43711
|
+
);
|
|
43712
|
+
}
|
|
43713
|
+
|
|
43714
|
+
/**
|
|
43715
|
+
* Get work plan rotations
|
|
43716
|
+
*
|
|
43717
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43718
|
+
* @param {Object} opts Optional parameters
|
|
43719
|
+
* @param {Array.<String>} opts.expand
|
|
43720
|
+
*/
|
|
43721
|
+
getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
43722
|
+
opts = opts || {};
|
|
43723
|
+
|
|
43724
|
+
// verify the required parameter 'managementUnitId' is set
|
|
43725
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43726
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
|
|
43727
|
+
}
|
|
43728
|
+
|
|
43729
|
+
return this.apiClient.callApi(
|
|
43730
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
43731
|
+
'GET',
|
|
43732
|
+
{ 'managementUnitId': managementUnitId },
|
|
43733
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
43734
|
+
{ },
|
|
43735
|
+
{ },
|
|
43736
|
+
null,
|
|
43737
|
+
['PureCloud OAuth'],
|
|
43738
|
+
['application/json'],
|
|
43739
|
+
['application/json']
|
|
43740
|
+
);
|
|
43741
|
+
}
|
|
43742
|
+
|
|
44134
43743
|
/**
|
|
44135
43744
|
* Get work plans
|
|
44136
43745
|
*
|
|
@@ -44520,129 +44129,6 @@ class WorkforceManagementApi {
|
|
|
44520
44129
|
);
|
|
44521
44130
|
}
|
|
44522
44131
|
|
|
44523
|
-
/**
|
|
44524
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
44525
|
-
*
|
|
44526
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44527
|
-
* @param {String} acId The ID of the activity code to update
|
|
44528
|
-
* @param {Object} opts Optional parameters
|
|
44529
|
-
* @param {Object} opts.body body
|
|
44530
|
-
*/
|
|
44531
|
-
patchWorkforcemanagementManagementunitActivitycode(muId, acId, opts) {
|
|
44532
|
-
opts = opts || {};
|
|
44533
|
-
|
|
44534
|
-
// verify the required parameter 'muId' is set
|
|
44535
|
-
if (muId === undefined || muId === null) {
|
|
44536
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
44537
|
-
}
|
|
44538
|
-
// verify the required parameter 'acId' is set
|
|
44539
|
-
if (acId === undefined || acId === null) {
|
|
44540
|
-
throw 'Missing the required parameter "acId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
44541
|
-
}
|
|
44542
|
-
|
|
44543
|
-
return this.apiClient.callApi(
|
|
44544
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
44545
|
-
'PATCH',
|
|
44546
|
-
{ 'muId': muId,'acId': acId },
|
|
44547
|
-
{ },
|
|
44548
|
-
{ },
|
|
44549
|
-
{ },
|
|
44550
|
-
opts['body'],
|
|
44551
|
-
['PureCloud OAuth'],
|
|
44552
|
-
['application/json'],
|
|
44553
|
-
['application/json']
|
|
44554
|
-
);
|
|
44555
|
-
}
|
|
44556
|
-
|
|
44557
|
-
/**
|
|
44558
|
-
* Gone. Scheduling has moved under business units
|
|
44559
|
-
*
|
|
44560
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
44561
|
-
* @param {String} runId The ID of the schedule run
|
|
44562
|
-
* @param {Object} opts Optional parameters
|
|
44563
|
-
* @param {Object} opts.body body
|
|
44564
|
-
*/
|
|
44565
|
-
patchWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId, opts) {
|
|
44566
|
-
opts = opts || {};
|
|
44567
|
-
|
|
44568
|
-
// verify the required parameter 'managementUnitId' is set
|
|
44569
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44570
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
44571
|
-
}
|
|
44572
|
-
// verify the required parameter 'runId' is set
|
|
44573
|
-
if (runId === undefined || runId === null) {
|
|
44574
|
-
throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
44575
|
-
}
|
|
44576
|
-
|
|
44577
|
-
return this.apiClient.callApi(
|
|
44578
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
44579
|
-
'PATCH',
|
|
44580
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
44581
|
-
{ },
|
|
44582
|
-
{ },
|
|
44583
|
-
{ },
|
|
44584
|
-
opts['body'],
|
|
44585
|
-
['PureCloud OAuth'],
|
|
44586
|
-
['application/json'],
|
|
44587
|
-
['application/json']
|
|
44588
|
-
);
|
|
44589
|
-
}
|
|
44590
|
-
|
|
44591
|
-
/**
|
|
44592
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
44593
|
-
*
|
|
44594
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44595
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to update
|
|
44596
|
-
*/
|
|
44597
|
-
patchWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
44598
|
-
// verify the required parameter 'managementUnitId' is set
|
|
44599
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44600
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
44601
|
-
}
|
|
44602
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
44603
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
44604
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
44605
|
-
}
|
|
44606
|
-
|
|
44607
|
-
return this.apiClient.callApi(
|
|
44608
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
44609
|
-
'PATCH',
|
|
44610
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
44611
|
-
{ },
|
|
44612
|
-
{ },
|
|
44613
|
-
{ },
|
|
44614
|
-
null,
|
|
44615
|
-
['PureCloud OAuth'],
|
|
44616
|
-
['application/json'],
|
|
44617
|
-
['application/json']
|
|
44618
|
-
);
|
|
44619
|
-
}
|
|
44620
|
-
|
|
44621
|
-
/**
|
|
44622
|
-
* Gone. Update settings by PATCHing the management unit
|
|
44623
|
-
*
|
|
44624
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44625
|
-
*/
|
|
44626
|
-
patchWorkforcemanagementManagementunitSettings(muId) {
|
|
44627
|
-
// verify the required parameter 'muId' is set
|
|
44628
|
-
if (muId === undefined || muId === null) {
|
|
44629
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitSettings';
|
|
44630
|
-
}
|
|
44631
|
-
|
|
44632
|
-
return this.apiClient.callApi(
|
|
44633
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
44634
|
-
'PATCH',
|
|
44635
|
-
{ 'muId': muId },
|
|
44636
|
-
{ },
|
|
44637
|
-
{ },
|
|
44638
|
-
{ },
|
|
44639
|
-
null,
|
|
44640
|
-
['PureCloud OAuth'],
|
|
44641
|
-
['application/json'],
|
|
44642
|
-
['application/json']
|
|
44643
|
-
);
|
|
44644
|
-
}
|
|
44645
|
-
|
|
44646
44132
|
/**
|
|
44647
44133
|
* Update a time off request
|
|
44648
44134
|
*
|
|
@@ -44682,41 +44168,6 @@ class WorkforceManagementApi {
|
|
|
44682
44168
|
);
|
|
44683
44169
|
}
|
|
44684
44170
|
|
|
44685
|
-
/**
|
|
44686
|
-
* Gone. Scheduling has moved under business units
|
|
44687
|
-
*
|
|
44688
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44689
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
44690
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500
|
|
44691
|
-
*/
|
|
44692
|
-
patchWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
44693
|
-
// verify the required parameter 'managementUnitId' is set
|
|
44694
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44695
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
44696
|
-
}
|
|
44697
|
-
// verify the required parameter 'weekId' is set
|
|
44698
|
-
if (weekId === undefined || weekId === null) {
|
|
44699
|
-
throw 'Missing the required parameter "weekId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
44700
|
-
}
|
|
44701
|
-
// verify the required parameter 'scheduleId' is set
|
|
44702
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
44703
|
-
throw 'Missing the required parameter "scheduleId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
44704
|
-
}
|
|
44705
|
-
|
|
44706
|
-
return this.apiClient.callApi(
|
|
44707
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
44708
|
-
'PATCH',
|
|
44709
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
44710
|
-
{ },
|
|
44711
|
-
{ },
|
|
44712
|
-
{ },
|
|
44713
|
-
null,
|
|
44714
|
-
['PureCloud OAuth'],
|
|
44715
|
-
['application/json'],
|
|
44716
|
-
['application/json']
|
|
44717
|
-
);
|
|
44718
|
-
}
|
|
44719
|
-
|
|
44720
44171
|
/**
|
|
44721
44172
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
44722
44173
|
*
|
|
@@ -44764,6 +44215,7 @@ class WorkforceManagementApi {
|
|
|
44764
44215
|
* @param {String} workPlanId The ID of the work plan to update
|
|
44765
44216
|
* @param {Object} opts Optional parameters
|
|
44766
44217
|
* @param {Object} opts.body body
|
|
44218
|
+
* @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
|
|
44767
44219
|
*/
|
|
44768
44220
|
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
|
|
44769
44221
|
opts = opts || {};
|
|
@@ -44781,6 +44233,40 @@ class WorkforceManagementApi {
|
|
|
44781
44233
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
44782
44234
|
'PATCH',
|
|
44783
44235
|
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
44236
|
+
{ 'validationMode': opts['validationMode'] },
|
|
44237
|
+
{ },
|
|
44238
|
+
{ },
|
|
44239
|
+
opts['body'],
|
|
44240
|
+
['PureCloud OAuth'],
|
|
44241
|
+
['application/json'],
|
|
44242
|
+
['application/json']
|
|
44243
|
+
);
|
|
44244
|
+
}
|
|
44245
|
+
|
|
44246
|
+
/**
|
|
44247
|
+
* Update a work plan rotation
|
|
44248
|
+
*
|
|
44249
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44250
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
44251
|
+
* @param {Object} opts Optional parameters
|
|
44252
|
+
* @param {Object} opts.body body
|
|
44253
|
+
*/
|
|
44254
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
|
|
44255
|
+
opts = opts || {};
|
|
44256
|
+
|
|
44257
|
+
// verify the required parameter 'managementUnitId' is set
|
|
44258
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44259
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
44260
|
+
}
|
|
44261
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
44262
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
44263
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
44264
|
+
}
|
|
44265
|
+
|
|
44266
|
+
return this.apiClient.callApi(
|
|
44267
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
44268
|
+
'PATCH',
|
|
44269
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
44784
44270
|
{ },
|
|
44785
44271
|
{ },
|
|
44786
44272
|
{ },
|
|
@@ -45318,31 +44804,6 @@ class WorkforceManagementApi {
|
|
|
45318
44804
|
);
|
|
45319
44805
|
}
|
|
45320
44806
|
|
|
45321
|
-
/**
|
|
45322
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
45323
|
-
*
|
|
45324
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45325
|
-
*/
|
|
45326
|
-
postWorkforcemanagementManagementunitActivitycodes(muId) {
|
|
45327
|
-
// verify the required parameter 'muId' is set
|
|
45328
|
-
if (muId === undefined || muId === null) {
|
|
45329
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitActivitycodes';
|
|
45330
|
-
}
|
|
45331
|
-
|
|
45332
|
-
return this.apiClient.callApi(
|
|
45333
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes',
|
|
45334
|
-
'POST',
|
|
45335
|
-
{ 'muId': muId },
|
|
45336
|
-
{ },
|
|
45337
|
-
{ },
|
|
45338
|
-
{ },
|
|
45339
|
-
null,
|
|
45340
|
-
['PureCloud OAuth'],
|
|
45341
|
-
['application/json'],
|
|
45342
|
-
['application/json']
|
|
45343
|
-
);
|
|
45344
|
-
}
|
|
45345
|
-
|
|
45346
44807
|
/**
|
|
45347
44808
|
* Query published schedules for given given time range for set of users
|
|
45348
44809
|
*
|
|
@@ -45403,31 +44864,6 @@ class WorkforceManagementApi {
|
|
|
45403
44864
|
);
|
|
45404
44865
|
}
|
|
45405
44866
|
|
|
45406
|
-
/**
|
|
45407
|
-
* Gone. Moved under business units
|
|
45408
|
-
*
|
|
45409
|
-
* @param {String} muId The management unit ID of the management unit
|
|
45410
|
-
*/
|
|
45411
|
-
postWorkforcemanagementManagementunitIntraday(muId) {
|
|
45412
|
-
// verify the required parameter 'muId' is set
|
|
45413
|
-
if (muId === undefined || muId === null) {
|
|
45414
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitIntraday';
|
|
45415
|
-
}
|
|
45416
|
-
|
|
45417
|
-
return this.apiClient.callApi(
|
|
45418
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday',
|
|
45419
|
-
'POST',
|
|
45420
|
-
{ 'muId': muId },
|
|
45421
|
-
{ },
|
|
45422
|
-
{ },
|
|
45423
|
-
{ },
|
|
45424
|
-
null,
|
|
45425
|
-
['PureCloud OAuth'],
|
|
45426
|
-
['application/json'],
|
|
45427
|
-
['application/json']
|
|
45428
|
-
);
|
|
45429
|
-
}
|
|
45430
|
-
|
|
45431
44867
|
/**
|
|
45432
44868
|
* Move the requested management unit to a new business unit
|
|
45433
44869
|
* Returns status 200 if the management unit is already in the requested business unit
|
|
@@ -45486,31 +44922,6 @@ class WorkforceManagementApi {
|
|
|
45486
44922
|
);
|
|
45487
44923
|
}
|
|
45488
44924
|
|
|
45489
|
-
/**
|
|
45490
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
45491
|
-
*
|
|
45492
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45493
|
-
*/
|
|
45494
|
-
postWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
45495
|
-
// verify the required parameter 'managementUnitId' is set
|
|
45496
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45497
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitServicegoalgroups';
|
|
45498
|
-
}
|
|
45499
|
-
|
|
45500
|
-
return this.apiClient.callApi(
|
|
45501
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
45502
|
-
'POST',
|
|
45503
|
-
{ 'managementUnitId': managementUnitId },
|
|
45504
|
-
{ },
|
|
45505
|
-
{ },
|
|
45506
|
-
{ },
|
|
45507
|
-
null,
|
|
45508
|
-
['PureCloud OAuth'],
|
|
45509
|
-
['application/json'],
|
|
45510
|
-
['application/json']
|
|
45511
|
-
);
|
|
45512
|
-
}
|
|
45513
|
-
|
|
45514
44925
|
/**
|
|
45515
44926
|
* Create a new time off request
|
|
45516
44927
|
*
|
|
@@ -45540,35 +44951,6 @@ class WorkforceManagementApi {
|
|
|
45540
44951
|
);
|
|
45541
44952
|
}
|
|
45542
44953
|
|
|
45543
|
-
/**
|
|
45544
|
-
* Gone. All data is now returned in the query route
|
|
45545
|
-
*
|
|
45546
|
-
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45547
|
-
* @param {Object} opts Optional parameters
|
|
45548
|
-
* @param {Object} opts.body body
|
|
45549
|
-
*/
|
|
45550
|
-
postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails(muId, opts) {
|
|
45551
|
-
opts = opts || {};
|
|
45552
|
-
|
|
45553
|
-
// verify the required parameter 'muId' is set
|
|
45554
|
-
if (muId === undefined || muId === null) {
|
|
45555
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails';
|
|
45556
|
-
}
|
|
45557
|
-
|
|
45558
|
-
return this.apiClient.callApi(
|
|
45559
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails',
|
|
45560
|
-
'POST',
|
|
45561
|
-
{ 'muId': muId },
|
|
45562
|
-
{ },
|
|
45563
|
-
{ },
|
|
45564
|
-
{ },
|
|
45565
|
-
opts['body'],
|
|
45566
|
-
['PureCloud OAuth'],
|
|
45567
|
-
['application/json'],
|
|
45568
|
-
['application/json']
|
|
45569
|
-
);
|
|
45570
|
-
}
|
|
45571
|
-
|
|
45572
44954
|
/**
|
|
45573
44955
|
* Gets the lookup ids to fetch the specified set of requests
|
|
45574
44956
|
*
|
|
@@ -45598,166 +44980,6 @@ class WorkforceManagementApi {
|
|
|
45598
44980
|
);
|
|
45599
44981
|
}
|
|
45600
44982
|
|
|
45601
|
-
/**
|
|
45602
|
-
* Gone. Scheduling has moved under business units
|
|
45603
|
-
*
|
|
45604
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45605
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
45606
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to copy from
|
|
45607
|
-
*/
|
|
45608
|
-
postWorkforcemanagementManagementunitWeekScheduleCopy(managementUnitId, weekId, scheduleId) {
|
|
45609
|
-
// verify the required parameter 'managementUnitId' is set
|
|
45610
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45611
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
45612
|
-
}
|
|
45613
|
-
// verify the required parameter 'weekId' is set
|
|
45614
|
-
if (weekId === undefined || weekId === null) {
|
|
45615
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
45616
|
-
}
|
|
45617
|
-
// verify the required parameter 'scheduleId' is set
|
|
45618
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
45619
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
45620
|
-
}
|
|
45621
|
-
|
|
45622
|
-
return this.apiClient.callApi(
|
|
45623
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy',
|
|
45624
|
-
'POST',
|
|
45625
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
45626
|
-
{ },
|
|
45627
|
-
{ },
|
|
45628
|
-
{ },
|
|
45629
|
-
null,
|
|
45630
|
-
['PureCloud OAuth'],
|
|
45631
|
-
['application/json'],
|
|
45632
|
-
['application/json']
|
|
45633
|
-
);
|
|
45634
|
-
}
|
|
45635
|
-
|
|
45636
|
-
/**
|
|
45637
|
-
* Gone. Scheduling has moved under business units
|
|
45638
|
-
*
|
|
45639
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45640
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
45641
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to re-optimize
|
|
45642
|
-
*/
|
|
45643
|
-
postWorkforcemanagementManagementunitWeekScheduleReschedule(managementUnitId, weekId, scheduleId) {
|
|
45644
|
-
// verify the required parameter 'managementUnitId' is set
|
|
45645
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45646
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
45647
|
-
}
|
|
45648
|
-
// verify the required parameter 'weekId' is set
|
|
45649
|
-
if (weekId === undefined || weekId === null) {
|
|
45650
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
45651
|
-
}
|
|
45652
|
-
// verify the required parameter 'scheduleId' is set
|
|
45653
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
45654
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
45655
|
-
}
|
|
45656
|
-
|
|
45657
|
-
return this.apiClient.callApi(
|
|
45658
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule',
|
|
45659
|
-
'POST',
|
|
45660
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
45661
|
-
{ },
|
|
45662
|
-
{ },
|
|
45663
|
-
{ },
|
|
45664
|
-
null,
|
|
45665
|
-
['PureCloud OAuth'],
|
|
45666
|
-
['application/json'],
|
|
45667
|
-
['application/json']
|
|
45668
|
-
);
|
|
45669
|
-
}
|
|
45670
|
-
|
|
45671
|
-
/**
|
|
45672
|
-
* Gone. Scheduling has moved under business units
|
|
45673
|
-
*
|
|
45674
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45675
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
45676
|
-
*/
|
|
45677
|
-
postWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId) {
|
|
45678
|
-
// verify the required parameter 'managementUnitId' is set
|
|
45679
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45680
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
45681
|
-
}
|
|
45682
|
-
// verify the required parameter 'weekId' is set
|
|
45683
|
-
if (weekId === undefined || weekId === null) {
|
|
45684
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
45685
|
-
}
|
|
45686
|
-
|
|
45687
|
-
return this.apiClient.callApi(
|
|
45688
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules',
|
|
45689
|
-
'POST',
|
|
45690
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
45691
|
-
{ },
|
|
45692
|
-
{ },
|
|
45693
|
-
{ },
|
|
45694
|
-
null,
|
|
45695
|
-
['PureCloud OAuth'],
|
|
45696
|
-
['application/json'],
|
|
45697
|
-
['application/json']
|
|
45698
|
-
);
|
|
45699
|
-
}
|
|
45700
|
-
|
|
45701
|
-
/**
|
|
45702
|
-
* Gone. Scheduling has moved under business units
|
|
45703
|
-
*
|
|
45704
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45705
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
45706
|
-
*/
|
|
45707
|
-
postWorkforcemanagementManagementunitWeekSchedulesGenerate(managementUnitId, weekId) {
|
|
45708
|
-
// verify the required parameter 'managementUnitId' is set
|
|
45709
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45710
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
45711
|
-
}
|
|
45712
|
-
// verify the required parameter 'weekId' is set
|
|
45713
|
-
if (weekId === undefined || weekId === null) {
|
|
45714
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
45715
|
-
}
|
|
45716
|
-
|
|
45717
|
-
return this.apiClient.callApi(
|
|
45718
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate',
|
|
45719
|
-
'POST',
|
|
45720
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
45721
|
-
{ },
|
|
45722
|
-
{ },
|
|
45723
|
-
{ },
|
|
45724
|
-
null,
|
|
45725
|
-
['PureCloud OAuth'],
|
|
45726
|
-
['application/json'],
|
|
45727
|
-
['application/json']
|
|
45728
|
-
);
|
|
45729
|
-
}
|
|
45730
|
-
|
|
45731
|
-
/**
|
|
45732
|
-
* Gone. Scheduling has moved under business units
|
|
45733
|
-
*
|
|
45734
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45735
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
45736
|
-
*/
|
|
45737
|
-
postWorkforcemanagementManagementunitWeekSchedulesPartialupload(managementUnitId, weekId) {
|
|
45738
|
-
// verify the required parameter 'managementUnitId' is set
|
|
45739
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45740
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
45741
|
-
}
|
|
45742
|
-
// verify the required parameter 'weekId' is set
|
|
45743
|
-
if (weekId === undefined || weekId === null) {
|
|
45744
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
45745
|
-
}
|
|
45746
|
-
|
|
45747
|
-
return this.apiClient.callApi(
|
|
45748
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload',
|
|
45749
|
-
'POST',
|
|
45750
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
45751
|
-
{ },
|
|
45752
|
-
{ },
|
|
45753
|
-
{ },
|
|
45754
|
-
null,
|
|
45755
|
-
['PureCloud OAuth'],
|
|
45756
|
-
['application/json'],
|
|
45757
|
-
['application/json']
|
|
45758
|
-
);
|
|
45759
|
-
}
|
|
45760
|
-
|
|
45761
44983
|
/**
|
|
45762
44984
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
45763
44985
|
*
|
|
@@ -45908,94 +45130,33 @@ class WorkforceManagementApi {
|
|
|
45908
45130
|
}
|
|
45909
45131
|
|
|
45910
45132
|
/**
|
|
45911
|
-
*
|
|
45912
|
-
*
|
|
45913
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
45914
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
45915
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
45916
|
-
*/
|
|
45917
|
-
postWorkforcemanagementManagementunitWeekShorttermforecastCopy(managementUnitId, weekDateId, forecastId) {
|
|
45918
|
-
// verify the required parameter 'managementUnitId' is set
|
|
45919
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45920
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
45921
|
-
}
|
|
45922
|
-
// verify the required parameter 'weekDateId' is set
|
|
45923
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
45924
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
45925
|
-
}
|
|
45926
|
-
// verify the required parameter 'forecastId' is set
|
|
45927
|
-
if (forecastId === undefined || forecastId === null) {
|
|
45928
|
-
throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
45929
|
-
}
|
|
45930
|
-
|
|
45931
|
-
return this.apiClient.callApi(
|
|
45932
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy',
|
|
45933
|
-
'POST',
|
|
45934
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
45935
|
-
{ },
|
|
45936
|
-
{ },
|
|
45937
|
-
{ },
|
|
45938
|
-
null,
|
|
45939
|
-
['PureCloud OAuth'],
|
|
45940
|
-
['application/json'],
|
|
45941
|
-
['application/json']
|
|
45942
|
-
);
|
|
45943
|
-
}
|
|
45944
|
-
|
|
45945
|
-
/**
|
|
45946
|
-
* Gone. Use equivalent business unit resource instead
|
|
45947
|
-
*
|
|
45948
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
45949
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
45950
|
-
*/
|
|
45951
|
-
postWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
45952
|
-
// verify the required parameter 'managementUnitId' is set
|
|
45953
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45954
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
45955
|
-
}
|
|
45956
|
-
// verify the required parameter 'weekDateId' is set
|
|
45957
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
45958
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
45959
|
-
}
|
|
45960
|
-
|
|
45961
|
-
return this.apiClient.callApi(
|
|
45962
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
45963
|
-
'POST',
|
|
45964
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
45965
|
-
{ },
|
|
45966
|
-
{ },
|
|
45967
|
-
{ },
|
|
45968
|
-
null,
|
|
45969
|
-
['PureCloud OAuth'],
|
|
45970
|
-
['application/json'],
|
|
45971
|
-
['application/json']
|
|
45972
|
-
);
|
|
45973
|
-
}
|
|
45974
|
-
|
|
45975
|
-
/**
|
|
45976
|
-
* Gone. Use equivalent business unit resource instead
|
|
45133
|
+
* Create a copy of work plan
|
|
45977
45134
|
*
|
|
45978
|
-
* @param {String} managementUnitId
|
|
45979
|
-
* @param {String}
|
|
45135
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45136
|
+
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
45137
|
+
* @param {Object} opts Optional parameters
|
|
45138
|
+
* @param {Object} opts.body body
|
|
45980
45139
|
*/
|
|
45981
|
-
|
|
45140
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
|
|
45141
|
+
opts = opts || {};
|
|
45142
|
+
|
|
45982
45143
|
// verify the required parameter 'managementUnitId' is set
|
|
45983
45144
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
45984
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
45145
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
45985
45146
|
}
|
|
45986
|
-
// verify the required parameter '
|
|
45987
|
-
if (
|
|
45988
|
-
throw 'Missing the required parameter "
|
|
45147
|
+
// verify the required parameter 'workPlanId' is set
|
|
45148
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
45149
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
45989
45150
|
}
|
|
45990
45151
|
|
|
45991
45152
|
return this.apiClient.callApi(
|
|
45992
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
45153
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
45993
45154
|
'POST',
|
|
45994
|
-
{ 'managementUnitId': managementUnitId,'
|
|
45155
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
45995
45156
|
{ },
|
|
45996
45157
|
{ },
|
|
45997
45158
|
{ },
|
|
45998
|
-
|
|
45159
|
+
opts['body'],
|
|
45999
45160
|
['PureCloud OAuth'],
|
|
46000
45161
|
['application/json'],
|
|
46001
45162
|
['application/json']
|
|
@@ -46003,29 +45164,34 @@ class WorkforceManagementApi {
|
|
|
46003
45164
|
}
|
|
46004
45165
|
|
|
46005
45166
|
/**
|
|
46006
|
-
*
|
|
45167
|
+
* Validate Work Plan
|
|
46007
45168
|
*
|
|
46008
|
-
* @param {String} managementUnitId
|
|
46009
|
-
* @param {String}
|
|
45169
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45170
|
+
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
45171
|
+
* @param {Object} opts Optional parameters
|
|
45172
|
+
* @param {Object} opts.body body
|
|
45173
|
+
* @param {Array.<String>} opts.expand
|
|
46010
45174
|
*/
|
|
46011
|
-
|
|
45175
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
45176
|
+
opts = opts || {};
|
|
45177
|
+
|
|
46012
45178
|
// verify the required parameter 'managementUnitId' is set
|
|
46013
45179
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46014
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
45180
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
46015
45181
|
}
|
|
46016
|
-
// verify the required parameter '
|
|
46017
|
-
if (
|
|
46018
|
-
throw 'Missing the required parameter "
|
|
45182
|
+
// verify the required parameter 'workPlanId' is set
|
|
45183
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
45184
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
46019
45185
|
}
|
|
46020
45186
|
|
|
46021
45187
|
return this.apiClient.callApi(
|
|
46022
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
45188
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
46023
45189
|
'POST',
|
|
46024
|
-
{ 'managementUnitId': managementUnitId,'
|
|
46025
|
-
{
|
|
45190
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
45191
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
46026
45192
|
{ },
|
|
46027
45193
|
{ },
|
|
46028
|
-
|
|
45194
|
+
opts['body'],
|
|
46029
45195
|
['PureCloud OAuth'],
|
|
46030
45196
|
['application/json'],
|
|
46031
45197
|
['application/json']
|
|
@@ -46033,29 +45199,29 @@ class WorkforceManagementApi {
|
|
|
46033
45199
|
}
|
|
46034
45200
|
|
|
46035
45201
|
/**
|
|
46036
|
-
* Create a copy of work plan
|
|
45202
|
+
* Create a copy of work plan rotation
|
|
46037
45203
|
*
|
|
46038
45204
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46039
|
-
* @param {String}
|
|
45205
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
46040
45206
|
* @param {Object} opts Optional parameters
|
|
46041
45207
|
* @param {Object} opts.body body
|
|
46042
45208
|
*/
|
|
46043
|
-
|
|
45209
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
|
|
46044
45210
|
opts = opts || {};
|
|
46045
45211
|
|
|
46046
45212
|
// verify the required parameter 'managementUnitId' is set
|
|
46047
45213
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46048
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
45214
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
46049
45215
|
}
|
|
46050
|
-
// verify the required parameter '
|
|
46051
|
-
if (
|
|
46052
|
-
throw 'Missing the required parameter "
|
|
45216
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
45217
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
45218
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
46053
45219
|
}
|
|
46054
45220
|
|
|
46055
45221
|
return this.apiClient.callApi(
|
|
46056
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
45222
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
46057
45223
|
'POST',
|
|
46058
|
-
{ 'managementUnitId': managementUnitId,'
|
|
45224
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
46059
45225
|
{ },
|
|
46060
45226
|
{ },
|
|
46061
45227
|
{ },
|
|
@@ -46067,31 +45233,25 @@ class WorkforceManagementApi {
|
|
|
46067
45233
|
}
|
|
46068
45234
|
|
|
46069
45235
|
/**
|
|
46070
|
-
*
|
|
45236
|
+
* Create a new work plan rotation
|
|
46071
45237
|
*
|
|
46072
45238
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46073
|
-
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
46074
45239
|
* @param {Object} opts Optional parameters
|
|
46075
45240
|
* @param {Object} opts.body body
|
|
46076
|
-
* @param {Array.<String>} opts.expand
|
|
46077
45241
|
*/
|
|
46078
|
-
|
|
45242
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
46079
45243
|
opts = opts || {};
|
|
46080
45244
|
|
|
46081
45245
|
// verify the required parameter 'managementUnitId' is set
|
|
46082
45246
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46083
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
46084
|
-
}
|
|
46085
|
-
// verify the required parameter 'workPlanId' is set
|
|
46086
|
-
if (workPlanId === undefined || workPlanId === null) {
|
|
46087
|
-
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
45247
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
46088
45248
|
}
|
|
46089
45249
|
|
|
46090
45250
|
return this.apiClient.callApi(
|
|
46091
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
45251
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
46092
45252
|
'POST',
|
|
46093
|
-
{ 'managementUnitId': managementUnitId
|
|
46094
|
-
{
|
|
45253
|
+
{ 'managementUnitId': managementUnitId },
|
|
45254
|
+
{ },
|
|
46095
45255
|
{ },
|
|
46096
45256
|
{ },
|
|
46097
45257
|
opts['body'],
|
|
@@ -46107,6 +45267,7 @@ class WorkforceManagementApi {
|
|
|
46107
45267
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46108
45268
|
* @param {Object} opts Optional parameters
|
|
46109
45269
|
* @param {Object} opts.body body
|
|
45270
|
+
* @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
|
|
46110
45271
|
*/
|
|
46111
45272
|
postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
46112
45273
|
opts = opts || {};
|
|
@@ -46120,7 +45281,7 @@ class WorkforceManagementApi {
|
|
|
46120
45281
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
46121
45282
|
'POST',
|
|
46122
45283
|
{ 'managementUnitId': managementUnitId },
|
|
46123
|
-
{
|
|
45284
|
+
{ 'validationMode': opts['validationMode'] },
|
|
46124
45285
|
{ },
|
|
46125
45286
|
{ },
|
|
46126
45287
|
opts['body'],
|
|
@@ -46257,7 +45418,7 @@ class WorkforceManagementApi {
|
|
|
46257
45418
|
* </pre>
|
|
46258
45419
|
* </p>
|
|
46259
45420
|
* @module purecloud-platform-client-v2/index
|
|
46260
|
-
* @version
|
|
45421
|
+
* @version 98.0.0
|
|
46261
45422
|
*/
|
|
46262
45423
|
class platformClient {
|
|
46263
45424
|
constructor() {
|
|
@@ -46516,11 +45677,6 @@ class platformClient {
|
|
|
46516
45677
|
* @property {module:purecloud-platform-client-v2/api/UsageApi}
|
|
46517
45678
|
*/
|
|
46518
45679
|
this.UsageApi = UsageApi;
|
|
46519
|
-
/**
|
|
46520
|
-
* The UserDevelopmentApi service constructor.
|
|
46521
|
-
* @property {module:purecloud-platform-client-v2/api/UserDevelopmentApi}
|
|
46522
|
-
*/
|
|
46523
|
-
this.UserDevelopmentApi = UserDevelopmentApi;
|
|
46524
45680
|
/**
|
|
46525
45681
|
* The UserRecordingsApi service constructor.
|
|
46526
45682
|
* @property {module:purecloud-platform-client-v2/api/UserRecordingsApi}
|