purecloud-platform-client-v2 134.0.1 → 136.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -29
- package/dist/node/purecloud-platform-client-v2.js +637 -214
- package/dist/web-amd/purecloud-platform-client-v2.js +637 -214
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +637 -214
- package/dist/web-cjs/purecloud-platform-client-v2.js +647 -225
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +895 -425
- 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 +50 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +5 -5
- 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/GamificationApi.js +29 -29
- 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 +11 -9
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +226 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +132 -5
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -51
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5755,10 +5755,10 @@ function Request(method, url) {
|
|
|
5755
5755
|
|
|
5756
5756
|
try {
|
|
5757
5757
|
res = new Response(self);
|
|
5758
|
-
} catch (
|
|
5758
|
+
} catch (err) {
|
|
5759
5759
|
error = new Error('Parser is unable to parse the response');
|
|
5760
5760
|
error.parse = true;
|
|
5761
|
-
error.original =
|
|
5761
|
+
error.original = err; // issue #675: return the raw response if the response parsing fails
|
|
5762
5762
|
|
|
5763
5763
|
if (self.xhr) {
|
|
5764
5764
|
// ie9 doesn't have 'response' property
|
|
@@ -5881,14 +5881,13 @@ Request.prototype.auth = function (user, pass, options) {
|
|
|
5881
5881
|
};
|
|
5882
5882
|
}
|
|
5883
5883
|
|
|
5884
|
-
var encoder = function
|
|
5884
|
+
var encoder = options.encoder ? options.encoder : function (string) {
|
|
5885
5885
|
if (typeof btoa === 'function') {
|
|
5886
5886
|
return btoa(string);
|
|
5887
5887
|
}
|
|
5888
5888
|
|
|
5889
5889
|
throw new Error('Cannot use basic auth, btoa is not a function');
|
|
5890
5890
|
};
|
|
5891
|
-
|
|
5892
5891
|
return this._auth(user, pass, options, encoder);
|
|
5893
5892
|
};
|
|
5894
5893
|
/**
|
|
@@ -6552,8 +6551,8 @@ RequestBase.prototype._shouldRetry = function (error, res) {
|
|
|
6552
6551
|
|
|
6553
6552
|
if (override === true) return true;
|
|
6554
6553
|
if (override === false) return false; // undefined falls back to defaults
|
|
6555
|
-
} catch (
|
|
6556
|
-
console.error(
|
|
6554
|
+
} catch (err) {
|
|
6555
|
+
console.error(err);
|
|
6557
6556
|
}
|
|
6558
6557
|
} // TODO: we would need to make this easily configurable before adding it in (e.g. some might want to add POST)
|
|
6559
6558
|
|
|
@@ -6645,8 +6644,8 @@ RequestBase.prototype.then = function (resolve, reject) {
|
|
|
6645
6644
|
return this._fullfilledPromise.then(resolve, reject);
|
|
6646
6645
|
};
|
|
6647
6646
|
|
|
6648
|
-
RequestBase.prototype.catch = function (
|
|
6649
|
-
return this.then(undefined,
|
|
6647
|
+
RequestBase.prototype.catch = function (callback) {
|
|
6648
|
+
return this.then(undefined, callback);
|
|
6650
6649
|
};
|
|
6651
6650
|
/**
|
|
6652
6651
|
* Allow for extension
|
|
@@ -6658,9 +6657,9 @@ RequestBase.prototype.use = function (fn) {
|
|
|
6658
6657
|
return this;
|
|
6659
6658
|
};
|
|
6660
6659
|
|
|
6661
|
-
RequestBase.prototype.ok = function (
|
|
6662
|
-
if (typeof
|
|
6663
|
-
this._okCallback =
|
|
6660
|
+
RequestBase.prototype.ok = function (callback) {
|
|
6661
|
+
if (typeof callback !== 'function') throw new Error('Callback required');
|
|
6662
|
+
this._okCallback = callback;
|
|
6664
6663
|
return this;
|
|
6665
6664
|
};
|
|
6666
6665
|
|
|
@@ -9675,7 +9674,7 @@ class Configuration {
|
|
|
9675
9674
|
|
|
9676
9675
|
/**
|
|
9677
9676
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9678
|
-
* @version
|
|
9677
|
+
* @version 136.1.0
|
|
9679
9678
|
*/
|
|
9680
9679
|
class ApiClient {
|
|
9681
9680
|
/**
|
|
@@ -10615,7 +10614,7 @@ class ApiClient {
|
|
|
10615
10614
|
|
|
10616
10615
|
// set header parameters
|
|
10617
10616
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
10618
|
-
//request.set({ 'purecloud-sdk': '
|
|
10617
|
+
//request.set({ 'purecloud-sdk': '136.1.0' });
|
|
10619
10618
|
|
|
10620
10619
|
// set request timeout
|
|
10621
10620
|
request.timeout(that.timeout);
|
|
@@ -10715,7 +10714,7 @@ class AlertingApi {
|
|
|
10715
10714
|
/**
|
|
10716
10715
|
* Alerting service.
|
|
10717
10716
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10718
|
-
* @version
|
|
10717
|
+
* @version 136.1.0
|
|
10719
10718
|
*/
|
|
10720
10719
|
|
|
10721
10720
|
/**
|
|
@@ -11029,7 +11028,7 @@ class AnalyticsApi {
|
|
|
11029
11028
|
/**
|
|
11030
11029
|
* Analytics service.
|
|
11031
11030
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
11032
|
-
* @version
|
|
11031
|
+
* @version 136.1.0
|
|
11033
11032
|
*/
|
|
11034
11033
|
|
|
11035
11034
|
/**
|
|
@@ -12211,7 +12210,7 @@ class ArchitectApi {
|
|
|
12211
12210
|
/**
|
|
12212
12211
|
* Architect service.
|
|
12213
12212
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
12214
|
-
* @version
|
|
12213
|
+
* @version 136.1.0
|
|
12215
12214
|
*/
|
|
12216
12215
|
|
|
12217
12216
|
/**
|
|
@@ -13975,6 +13974,35 @@ class ArchitectApi {
|
|
|
13975
13974
|
);
|
|
13976
13975
|
}
|
|
13977
13976
|
|
|
13977
|
+
/**
|
|
13978
|
+
* Fetch Architect Job Status
|
|
13979
|
+
*
|
|
13980
|
+
* @param {String} jobId Job ID
|
|
13981
|
+
* @param {Object} opts Optional parameters
|
|
13982
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
13983
|
+
*/
|
|
13984
|
+
getFlowsJob(jobId, opts) {
|
|
13985
|
+
opts = opts || {};
|
|
13986
|
+
|
|
13987
|
+
// verify the required parameter 'jobId' is set
|
|
13988
|
+
if (jobId === undefined || jobId === null) {
|
|
13989
|
+
throw 'Missing the required parameter "jobId" when calling getFlowsJob';
|
|
13990
|
+
}
|
|
13991
|
+
|
|
13992
|
+
return this.apiClient.callApi(
|
|
13993
|
+
'/api/v2/flows/jobs/{jobId}',
|
|
13994
|
+
'GET',
|
|
13995
|
+
{ 'jobId': jobId },
|
|
13996
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
13997
|
+
{ },
|
|
13998
|
+
{ },
|
|
13999
|
+
null,
|
|
14000
|
+
['PureCloud OAuth'],
|
|
14001
|
+
['application/json'],
|
|
14002
|
+
['application/json']
|
|
14003
|
+
);
|
|
14004
|
+
}
|
|
14005
|
+
|
|
13978
14006
|
/**
|
|
13979
14007
|
* Get a flow milestone
|
|
13980
14008
|
* Returns a specified flow milestone
|
|
@@ -14777,6 +14805,26 @@ class ArchitectApi {
|
|
|
14777
14805
|
);
|
|
14778
14806
|
}
|
|
14779
14807
|
|
|
14808
|
+
/**
|
|
14809
|
+
* Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
|
|
14810
|
+
*
|
|
14811
|
+
*/
|
|
14812
|
+
postFlowsJobs() {
|
|
14813
|
+
|
|
14814
|
+
return this.apiClient.callApi(
|
|
14815
|
+
'/api/v2/flows/jobs',
|
|
14816
|
+
'POST',
|
|
14817
|
+
{ },
|
|
14818
|
+
{ },
|
|
14819
|
+
{ },
|
|
14820
|
+
{ },
|
|
14821
|
+
null,
|
|
14822
|
+
['PureCloud OAuth'],
|
|
14823
|
+
['application/json'],
|
|
14824
|
+
['application/json']
|
|
14825
|
+
);
|
|
14826
|
+
}
|
|
14827
|
+
|
|
14780
14828
|
/**
|
|
14781
14829
|
* Create a flow milestone
|
|
14782
14830
|
*
|
|
@@ -15207,7 +15255,7 @@ class AuditApi {
|
|
|
15207
15255
|
/**
|
|
15208
15256
|
* Audit service.
|
|
15209
15257
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
15210
|
-
* @version
|
|
15258
|
+
* @version 136.1.0
|
|
15211
15259
|
*/
|
|
15212
15260
|
|
|
15213
15261
|
/**
|
|
@@ -15378,7 +15426,7 @@ class AuthorizationApi {
|
|
|
15378
15426
|
/**
|
|
15379
15427
|
* Authorization service.
|
|
15380
15428
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15381
|
-
* @version
|
|
15429
|
+
* @version 136.1.0
|
|
15382
15430
|
*/
|
|
15383
15431
|
|
|
15384
15432
|
/**
|
|
@@ -16561,7 +16609,7 @@ class BillingApi {
|
|
|
16561
16609
|
/**
|
|
16562
16610
|
* Billing service.
|
|
16563
16611
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16564
|
-
* @version
|
|
16612
|
+
* @version 136.1.0
|
|
16565
16613
|
*/
|
|
16566
16614
|
|
|
16567
16615
|
/**
|
|
@@ -16641,7 +16689,7 @@ class ChatApi {
|
|
|
16641
16689
|
/**
|
|
16642
16690
|
* Chat service.
|
|
16643
16691
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16644
|
-
* @version
|
|
16692
|
+
* @version 136.1.0
|
|
16645
16693
|
*/
|
|
16646
16694
|
|
|
16647
16695
|
/**
|
|
@@ -16732,7 +16780,7 @@ class CoachingApi {
|
|
|
16732
16780
|
/**
|
|
16733
16781
|
* Coaching service.
|
|
16734
16782
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16735
|
-
* @version
|
|
16783
|
+
* @version 136.1.0
|
|
16736
16784
|
*/
|
|
16737
16785
|
|
|
16738
16786
|
/**
|
|
@@ -17309,7 +17357,7 @@ class ContentManagementApi {
|
|
|
17309
17357
|
/**
|
|
17310
17358
|
* ContentManagement service.
|
|
17311
17359
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17312
|
-
* @version
|
|
17360
|
+
* @version 136.1.0
|
|
17313
17361
|
*/
|
|
17314
17362
|
|
|
17315
17363
|
/**
|
|
@@ -18449,7 +18497,7 @@ class ConversationsApi {
|
|
|
18449
18497
|
/**
|
|
18450
18498
|
* Conversations service.
|
|
18451
18499
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18452
|
-
* @version
|
|
18500
|
+
* @version 136.1.0
|
|
18453
18501
|
*/
|
|
18454
18502
|
|
|
18455
18503
|
/**
|
|
@@ -20354,7 +20402,7 @@ class ConversationsApi {
|
|
|
20354
20402
|
/**
|
|
20355
20403
|
* Get a list of Messaging Stickers
|
|
20356
20404
|
*
|
|
20357
|
-
* @param {
|
|
20405
|
+
* @param {Object} messengerType Messenger Type
|
|
20358
20406
|
* @param {Object} opts Optional parameters
|
|
20359
20407
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
20360
20408
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -20542,7 +20590,7 @@ class ConversationsApi {
|
|
|
20542
20590
|
}
|
|
20543
20591
|
|
|
20544
20592
|
/**
|
|
20545
|
-
* Update a conversation by setting
|
|
20593
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
20546
20594
|
*
|
|
20547
20595
|
* @param {String} conversationId conversationId
|
|
20548
20596
|
* @param {Object} body Conversation
|
|
@@ -21528,8 +21576,8 @@ class ConversationsApi {
|
|
|
21528
21576
|
}
|
|
21529
21577
|
|
|
21530
21578
|
/**
|
|
21531
|
-
* Update or activate a WhatsApp messaging integration
|
|
21532
|
-
* The following steps are required in order to fully activate a
|
|
21579
|
+
* Update or activate a WhatsApp messaging integration
|
|
21580
|
+
* The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
21533
21581
|
* @param {String} integrationId Integration ID
|
|
21534
21582
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
21535
21583
|
*/
|
|
@@ -23113,7 +23161,7 @@ class DataExtensionsApi {
|
|
|
23113
23161
|
/**
|
|
23114
23162
|
* DataExtensions service.
|
|
23115
23163
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23116
|
-
* @version
|
|
23164
|
+
* @version 136.1.0
|
|
23117
23165
|
*/
|
|
23118
23166
|
|
|
23119
23167
|
/**
|
|
@@ -23199,7 +23247,7 @@ class ExternalContactsApi {
|
|
|
23199
23247
|
/**
|
|
23200
23248
|
* ExternalContacts service.
|
|
23201
23249
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23202
|
-
* @version
|
|
23250
|
+
* @version 136.1.0
|
|
23203
23251
|
*/
|
|
23204
23252
|
|
|
23205
23253
|
/**
|
|
@@ -24942,7 +24990,7 @@ class FaxApi {
|
|
|
24942
24990
|
/**
|
|
24943
24991
|
* Fax service.
|
|
24944
24992
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24945
|
-
* @version
|
|
24993
|
+
* @version 136.1.0
|
|
24946
24994
|
*/
|
|
24947
24995
|
|
|
24948
24996
|
/**
|
|
@@ -25113,7 +25161,7 @@ class FlowsApi {
|
|
|
25113
25161
|
/**
|
|
25114
25162
|
* Flows service.
|
|
25115
25163
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25116
|
-
* @version
|
|
25164
|
+
* @version 136.1.0
|
|
25117
25165
|
*/
|
|
25118
25166
|
|
|
25119
25167
|
/**
|
|
@@ -25184,7 +25232,7 @@ class GamificationApi {
|
|
|
25184
25232
|
/**
|
|
25185
25233
|
* Gamification service.
|
|
25186
25234
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25187
|
-
* @version
|
|
25235
|
+
* @version 136.1.0
|
|
25188
25236
|
*/
|
|
25189
25237
|
|
|
25190
25238
|
/**
|
|
@@ -25430,18 +25478,18 @@ class GamificationApi {
|
|
|
25430
25478
|
/**
|
|
25431
25479
|
* Performance profile by id
|
|
25432
25480
|
*
|
|
25433
|
-
* @param {String} performanceProfileId
|
|
25481
|
+
* @param {String} profileId performanceProfileId
|
|
25434
25482
|
*/
|
|
25435
|
-
getGamificationProfile(
|
|
25436
|
-
// verify the required parameter '
|
|
25437
|
-
if (
|
|
25438
|
-
throw 'Missing the required parameter "
|
|
25483
|
+
getGamificationProfile(profileId) {
|
|
25484
|
+
// verify the required parameter 'profileId' is set
|
|
25485
|
+
if (profileId === undefined || profileId === null) {
|
|
25486
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
25439
25487
|
}
|
|
25440
25488
|
|
|
25441
25489
|
return this.apiClient.callApi(
|
|
25442
|
-
'/api/v2/gamification/profiles/{
|
|
25490
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
25443
25491
|
'GET',
|
|
25444
|
-
{ '
|
|
25492
|
+
{ 'profileId': profileId },
|
|
25445
25493
|
{ },
|
|
25446
25494
|
{ },
|
|
25447
25495
|
{ },
|
|
@@ -26284,18 +26332,18 @@ class GamificationApi {
|
|
|
26284
26332
|
/**
|
|
26285
26333
|
* Activate a performance profile
|
|
26286
26334
|
*
|
|
26287
|
-
* @param {String} performanceProfileId
|
|
26335
|
+
* @param {String} profileId performanceProfileId
|
|
26288
26336
|
*/
|
|
26289
|
-
postGamificationProfileActivate(
|
|
26290
|
-
// verify the required parameter '
|
|
26291
|
-
if (
|
|
26292
|
-
throw 'Missing the required parameter "
|
|
26337
|
+
postGamificationProfileActivate(profileId) {
|
|
26338
|
+
// verify the required parameter 'profileId' is set
|
|
26339
|
+
if (profileId === undefined || profileId === null) {
|
|
26340
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
26293
26341
|
}
|
|
26294
26342
|
|
|
26295
26343
|
return this.apiClient.callApi(
|
|
26296
|
-
'/api/v2/gamification/profiles/{
|
|
26344
|
+
'/api/v2/gamification/profiles/{profileId}/activate',
|
|
26297
26345
|
'POST',
|
|
26298
|
-
{ '
|
|
26346
|
+
{ 'profileId': profileId },
|
|
26299
26347
|
{ },
|
|
26300
26348
|
{ },
|
|
26301
26349
|
{ },
|
|
@@ -26309,18 +26357,18 @@ class GamificationApi {
|
|
|
26309
26357
|
/**
|
|
26310
26358
|
* Deactivate a performance profile
|
|
26311
26359
|
*
|
|
26312
|
-
* @param {String} performanceProfileId
|
|
26360
|
+
* @param {String} profileId performanceProfileId
|
|
26313
26361
|
*/
|
|
26314
|
-
postGamificationProfileDeactivate(
|
|
26315
|
-
// verify the required parameter '
|
|
26316
|
-
if (
|
|
26317
|
-
throw 'Missing the required parameter "
|
|
26362
|
+
postGamificationProfileDeactivate(profileId) {
|
|
26363
|
+
// verify the required parameter 'profileId' is set
|
|
26364
|
+
if (profileId === undefined || profileId === null) {
|
|
26365
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
26318
26366
|
}
|
|
26319
26367
|
|
|
26320
26368
|
return this.apiClient.callApi(
|
|
26321
|
-
'/api/v2/gamification/profiles/{
|
|
26369
|
+
'/api/v2/gamification/profiles/{profileId}/deactivate',
|
|
26322
26370
|
'POST',
|
|
26323
|
-
{ '
|
|
26371
|
+
{ 'profileId': profileId },
|
|
26324
26372
|
{ },
|
|
26325
26373
|
{ },
|
|
26326
26374
|
{ },
|
|
@@ -26522,22 +26570,22 @@ class GamificationApi {
|
|
|
26522
26570
|
/**
|
|
26523
26571
|
* Updates a performance profile
|
|
26524
26572
|
*
|
|
26525
|
-
* @param {String} performanceProfileId
|
|
26573
|
+
* @param {String} profileId performanceProfileId
|
|
26526
26574
|
* @param {Object} opts Optional parameters
|
|
26527
26575
|
* @param {Object} opts.body performanceProfile
|
|
26528
26576
|
*/
|
|
26529
|
-
putGamificationProfile(
|
|
26577
|
+
putGamificationProfile(profileId, opts) {
|
|
26530
26578
|
opts = opts || {};
|
|
26531
26579
|
|
|
26532
|
-
// verify the required parameter '
|
|
26533
|
-
if (
|
|
26534
|
-
throw 'Missing the required parameter "
|
|
26580
|
+
// verify the required parameter 'profileId' is set
|
|
26581
|
+
if (profileId === undefined || profileId === null) {
|
|
26582
|
+
throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
|
|
26535
26583
|
}
|
|
26536
26584
|
|
|
26537
26585
|
return this.apiClient.callApi(
|
|
26538
|
-
'/api/v2/gamification/profiles/{
|
|
26586
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
26539
26587
|
'PUT',
|
|
26540
|
-
{ '
|
|
26588
|
+
{ 'profileId': profileId },
|
|
26541
26589
|
{ },
|
|
26542
26590
|
{ },
|
|
26543
26591
|
{ },
|
|
@@ -26614,7 +26662,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26614
26662
|
/**
|
|
26615
26663
|
* GeneralDataProtectionRegulation service.
|
|
26616
26664
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26617
|
-
* @version
|
|
26665
|
+
* @version 136.1.0
|
|
26618
26666
|
*/
|
|
26619
26667
|
|
|
26620
26668
|
/**
|
|
@@ -26744,7 +26792,7 @@ class GeolocationApi {
|
|
|
26744
26792
|
/**
|
|
26745
26793
|
* Geolocation service.
|
|
26746
26794
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26747
|
-
* @version
|
|
26795
|
+
* @version 136.1.0
|
|
26748
26796
|
*/
|
|
26749
26797
|
|
|
26750
26798
|
/**
|
|
@@ -26875,7 +26923,7 @@ class GreetingsApi {
|
|
|
26875
26923
|
/**
|
|
26876
26924
|
* Greetings service.
|
|
26877
26925
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26878
|
-
* @version
|
|
26926
|
+
* @version 136.1.0
|
|
26879
26927
|
*/
|
|
26880
26928
|
|
|
26881
26929
|
/**
|
|
@@ -27330,7 +27378,7 @@ class GroupsApi {
|
|
|
27330
27378
|
/**
|
|
27331
27379
|
* Groups service.
|
|
27332
27380
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27333
|
-
* @version
|
|
27381
|
+
* @version 136.1.0
|
|
27334
27382
|
*/
|
|
27335
27383
|
|
|
27336
27384
|
/**
|
|
@@ -27735,7 +27783,7 @@ class IdentityProviderApi {
|
|
|
27735
27783
|
/**
|
|
27736
27784
|
* IdentityProvider service.
|
|
27737
27785
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27738
|
-
* @version
|
|
27786
|
+
* @version 136.1.0
|
|
27739
27787
|
*/
|
|
27740
27788
|
|
|
27741
27789
|
/**
|
|
@@ -28491,7 +28539,7 @@ class IntegrationsApi {
|
|
|
28491
28539
|
/**
|
|
28492
28540
|
* Integrations service.
|
|
28493
28541
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28494
|
-
* @version
|
|
28542
|
+
* @version 136.1.0
|
|
28495
28543
|
*/
|
|
28496
28544
|
|
|
28497
28545
|
/**
|
|
@@ -28909,9 +28957,10 @@ class IntegrationsApi {
|
|
|
28909
28957
|
* @param {String} opts.previousPage Previous page token
|
|
28910
28958
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
28911
28959
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
28912
|
-
* @param {String} opts.category Filter by category name
|
|
28913
|
-
* @param {String} opts.name Filter by
|
|
28914
|
-
* @param {
|
|
28960
|
+
* @param {String} opts.category Filter by category name.
|
|
28961
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
28962
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
28963
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
28915
28964
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
28916
28965
|
*/
|
|
28917
28966
|
getIntegrationsActions(opts) {
|
|
@@ -28922,7 +28971,7 @@ class IntegrationsApi {
|
|
|
28922
28971
|
'/api/v2/integrations/actions',
|
|
28923
28972
|
'GET',
|
|
28924
28973
|
{ },
|
|
28925
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
28974
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
28926
28975
|
{ },
|
|
28927
28976
|
{ },
|
|
28928
28977
|
null,
|
|
@@ -28972,9 +29021,10 @@ class IntegrationsApi {
|
|
|
28972
29021
|
* @param {String} opts.previousPage Previous page token
|
|
28973
29022
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
28974
29023
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
28975
|
-
* @param {String} opts.category Filter by category name
|
|
28976
|
-
* @param {String} opts.name Filter by
|
|
28977
|
-
* @param {
|
|
29024
|
+
* @param {String} opts.category Filter by category name.
|
|
29025
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
29026
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
29027
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
28978
29028
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
28979
29029
|
*/
|
|
28980
29030
|
getIntegrationsActionsDrafts(opts) {
|
|
@@ -28985,7 +29035,7 @@ class IntegrationsApi {
|
|
|
28985
29035
|
'/api/v2/integrations/actions/drafts',
|
|
28986
29036
|
'GET',
|
|
28987
29037
|
{ },
|
|
28988
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
29038
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
28989
29039
|
{ },
|
|
28990
29040
|
{ },
|
|
28991
29041
|
null,
|
|
@@ -30166,7 +30216,7 @@ class JourneyApi {
|
|
|
30166
30216
|
/**
|
|
30167
30217
|
* Journey service.
|
|
30168
30218
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30169
|
-
* @version
|
|
30219
|
+
* @version 136.1.0
|
|
30170
30220
|
*/
|
|
30171
30221
|
|
|
30172
30222
|
/**
|
|
@@ -30877,7 +30927,7 @@ class KnowledgeApi {
|
|
|
30877
30927
|
/**
|
|
30878
30928
|
* Knowledge service.
|
|
30879
30929
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
30880
|
-
* @version
|
|
30930
|
+
* @version 136.1.0
|
|
30881
30931
|
*/
|
|
30882
30932
|
|
|
30883
30933
|
/**
|
|
@@ -31777,7 +31827,7 @@ class LanguageUnderstandingApi {
|
|
|
31777
31827
|
/**
|
|
31778
31828
|
* LanguageUnderstanding service.
|
|
31779
31829
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
31780
|
-
* @version
|
|
31830
|
+
* @version 136.1.0
|
|
31781
31831
|
*/
|
|
31782
31832
|
|
|
31783
31833
|
/**
|
|
@@ -32681,7 +32731,7 @@ class LanguagesApi {
|
|
|
32681
32731
|
/**
|
|
32682
32732
|
* Languages service.
|
|
32683
32733
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
32684
|
-
* @version
|
|
32734
|
+
* @version 136.1.0
|
|
32685
32735
|
*/
|
|
32686
32736
|
|
|
32687
32737
|
/**
|
|
@@ -32949,7 +32999,7 @@ class LearningApi {
|
|
|
32949
32999
|
/**
|
|
32950
33000
|
* Learning service.
|
|
32951
33001
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
32952
|
-
* @version
|
|
33002
|
+
* @version 136.1.0
|
|
32953
33003
|
*/
|
|
32954
33004
|
|
|
32955
33005
|
/**
|
|
@@ -33540,7 +33590,7 @@ class LicenseApi {
|
|
|
33540
33590
|
/**
|
|
33541
33591
|
* License service.
|
|
33542
33592
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
33543
|
-
* @version
|
|
33593
|
+
* @version 136.1.0
|
|
33544
33594
|
*/
|
|
33545
33595
|
|
|
33546
33596
|
/**
|
|
@@ -33778,7 +33828,7 @@ class LocationsApi {
|
|
|
33778
33828
|
/**
|
|
33779
33829
|
* Locations service.
|
|
33780
33830
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
33781
|
-
* @version
|
|
33831
|
+
* @version 136.1.0
|
|
33782
33832
|
*/
|
|
33783
33833
|
|
|
33784
33834
|
/**
|
|
@@ -34014,7 +34064,7 @@ class MessagingApi {
|
|
|
34014
34064
|
/**
|
|
34015
34065
|
* Messaging service.
|
|
34016
34066
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34017
|
-
* @version
|
|
34067
|
+
* @version 136.1.0
|
|
34018
34068
|
*/
|
|
34019
34069
|
|
|
34020
34070
|
/**
|
|
@@ -34165,7 +34215,7 @@ class MobileDevicesApi {
|
|
|
34165
34215
|
/**
|
|
34166
34216
|
* MobileDevices service.
|
|
34167
34217
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
34168
|
-
* @version
|
|
34218
|
+
* @version 136.1.0
|
|
34169
34219
|
*/
|
|
34170
34220
|
|
|
34171
34221
|
/**
|
|
@@ -34316,7 +34366,7 @@ class NotificationsApi {
|
|
|
34316
34366
|
/**
|
|
34317
34367
|
* Notifications service.
|
|
34318
34368
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
34319
|
-
* @version
|
|
34369
|
+
* @version 136.1.0
|
|
34320
34370
|
*/
|
|
34321
34371
|
|
|
34322
34372
|
/**
|
|
@@ -34541,7 +34591,7 @@ class OAuthApi {
|
|
|
34541
34591
|
/**
|
|
34542
34592
|
* OAuth service.
|
|
34543
34593
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
34544
|
-
* @version
|
|
34594
|
+
* @version 136.1.0
|
|
34545
34595
|
*/
|
|
34546
34596
|
|
|
34547
34597
|
/**
|
|
@@ -34907,7 +34957,7 @@ class ObjectsApi {
|
|
|
34907
34957
|
/**
|
|
34908
34958
|
* Objects service.
|
|
34909
34959
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
34910
|
-
* @version
|
|
34960
|
+
* @version 136.1.0
|
|
34911
34961
|
*/
|
|
34912
34962
|
|
|
34913
34963
|
/**
|
|
@@ -35178,7 +35228,7 @@ class OrganizationApi {
|
|
|
35178
35228
|
/**
|
|
35179
35229
|
* Organization service.
|
|
35180
35230
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
35181
|
-
* @version
|
|
35231
|
+
* @version 136.1.0
|
|
35182
35232
|
*/
|
|
35183
35233
|
|
|
35184
35234
|
/**
|
|
@@ -35581,7 +35631,7 @@ class OrganizationAuthorizationApi {
|
|
|
35581
35631
|
/**
|
|
35582
35632
|
* OrganizationAuthorization service.
|
|
35583
35633
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
35584
|
-
* @version
|
|
35634
|
+
* @version 136.1.0
|
|
35585
35635
|
*/
|
|
35586
35636
|
|
|
35587
35637
|
/**
|
|
@@ -36506,7 +36556,7 @@ class OutboundApi {
|
|
|
36506
36556
|
/**
|
|
36507
36557
|
* Outbound service.
|
|
36508
36558
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
36509
|
-
* @version
|
|
36559
|
+
* @version 136.1.0
|
|
36510
36560
|
*/
|
|
36511
36561
|
|
|
36512
36562
|
/**
|
|
@@ -36856,6 +36906,31 @@ class OutboundApi {
|
|
|
36856
36906
|
);
|
|
36857
36907
|
}
|
|
36858
36908
|
|
|
36909
|
+
/**
|
|
36910
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
36911
|
+
*
|
|
36912
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
36913
|
+
*/
|
|
36914
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
36915
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
36916
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
36917
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
36918
|
+
}
|
|
36919
|
+
|
|
36920
|
+
return this.apiClient.callApi(
|
|
36921
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
36922
|
+
'DELETE',
|
|
36923
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
36924
|
+
{ },
|
|
36925
|
+
{ },
|
|
36926
|
+
{ },
|
|
36927
|
+
null,
|
|
36928
|
+
['PureCloud OAuth'],
|
|
36929
|
+
['application/json'],
|
|
36930
|
+
['application/json']
|
|
36931
|
+
);
|
|
36932
|
+
}
|
|
36933
|
+
|
|
36859
36934
|
/**
|
|
36860
36935
|
* Delete a Rule Set.
|
|
36861
36936
|
*
|
|
@@ -36906,6 +36981,56 @@ class OutboundApi {
|
|
|
36906
36981
|
);
|
|
36907
36982
|
}
|
|
36908
36983
|
|
|
36984
|
+
/**
|
|
36985
|
+
* Delete an email campaign schedule.
|
|
36986
|
+
*
|
|
36987
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
36988
|
+
*/
|
|
36989
|
+
deleteOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
36990
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
36991
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
36992
|
+
throw 'Missing the required parameter "emailCampaignId" when calling deleteOutboundSchedulesEmailcampaign';
|
|
36993
|
+
}
|
|
36994
|
+
|
|
36995
|
+
return this.apiClient.callApi(
|
|
36996
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
36997
|
+
'DELETE',
|
|
36998
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
36999
|
+
{ },
|
|
37000
|
+
{ },
|
|
37001
|
+
{ },
|
|
37002
|
+
null,
|
|
37003
|
+
['PureCloud OAuth'],
|
|
37004
|
+
['application/json'],
|
|
37005
|
+
['application/json']
|
|
37006
|
+
);
|
|
37007
|
+
}
|
|
37008
|
+
|
|
37009
|
+
/**
|
|
37010
|
+
* Delete a messaging campaign schedule.
|
|
37011
|
+
*
|
|
37012
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
37013
|
+
*/
|
|
37014
|
+
deleteOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
37015
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
37016
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
37017
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundSchedulesMessagingcampaign';
|
|
37018
|
+
}
|
|
37019
|
+
|
|
37020
|
+
return this.apiClient.callApi(
|
|
37021
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
37022
|
+
'DELETE',
|
|
37023
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
37024
|
+
{ },
|
|
37025
|
+
{ },
|
|
37026
|
+
{ },
|
|
37027
|
+
null,
|
|
37028
|
+
['PureCloud OAuth'],
|
|
37029
|
+
['application/json'],
|
|
37030
|
+
['application/json']
|
|
37031
|
+
);
|
|
37032
|
+
}
|
|
37033
|
+
|
|
36909
37034
|
/**
|
|
36910
37035
|
* Delete a dialer sequence schedule.
|
|
36911
37036
|
*
|
|
@@ -38242,6 +38367,96 @@ class OutboundApi {
|
|
|
38242
38367
|
);
|
|
38243
38368
|
}
|
|
38244
38369
|
|
|
38370
|
+
/**
|
|
38371
|
+
* Get an email campaign schedule.
|
|
38372
|
+
*
|
|
38373
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
38374
|
+
*/
|
|
38375
|
+
getOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
38376
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
38377
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
38378
|
+
throw 'Missing the required parameter "emailCampaignId" when calling getOutboundSchedulesEmailcampaign';
|
|
38379
|
+
}
|
|
38380
|
+
|
|
38381
|
+
return this.apiClient.callApi(
|
|
38382
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
38383
|
+
'GET',
|
|
38384
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
38385
|
+
{ },
|
|
38386
|
+
{ },
|
|
38387
|
+
{ },
|
|
38388
|
+
null,
|
|
38389
|
+
['PureCloud OAuth'],
|
|
38390
|
+
['application/json'],
|
|
38391
|
+
['application/json']
|
|
38392
|
+
);
|
|
38393
|
+
}
|
|
38394
|
+
|
|
38395
|
+
/**
|
|
38396
|
+
* Query for a list of email campaign schedules.
|
|
38397
|
+
*
|
|
38398
|
+
*/
|
|
38399
|
+
getOutboundSchedulesEmailcampaigns() {
|
|
38400
|
+
|
|
38401
|
+
return this.apiClient.callApi(
|
|
38402
|
+
'/api/v2/outbound/schedules/emailcampaigns',
|
|
38403
|
+
'GET',
|
|
38404
|
+
{ },
|
|
38405
|
+
{ },
|
|
38406
|
+
{ },
|
|
38407
|
+
{ },
|
|
38408
|
+
null,
|
|
38409
|
+
['PureCloud OAuth'],
|
|
38410
|
+
['application/json'],
|
|
38411
|
+
['application/json']
|
|
38412
|
+
);
|
|
38413
|
+
}
|
|
38414
|
+
|
|
38415
|
+
/**
|
|
38416
|
+
* Get a messaging campaign schedule.
|
|
38417
|
+
*
|
|
38418
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
38419
|
+
*/
|
|
38420
|
+
getOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
38421
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
38422
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
38423
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundSchedulesMessagingcampaign';
|
|
38424
|
+
}
|
|
38425
|
+
|
|
38426
|
+
return this.apiClient.callApi(
|
|
38427
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
38428
|
+
'GET',
|
|
38429
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
38430
|
+
{ },
|
|
38431
|
+
{ },
|
|
38432
|
+
{ },
|
|
38433
|
+
null,
|
|
38434
|
+
['PureCloud OAuth'],
|
|
38435
|
+
['application/json'],
|
|
38436
|
+
['application/json']
|
|
38437
|
+
);
|
|
38438
|
+
}
|
|
38439
|
+
|
|
38440
|
+
/**
|
|
38441
|
+
* Query for a list of messaging campaign schedules.
|
|
38442
|
+
*
|
|
38443
|
+
*/
|
|
38444
|
+
getOutboundSchedulesMessagingcampaigns() {
|
|
38445
|
+
|
|
38446
|
+
return this.apiClient.callApi(
|
|
38447
|
+
'/api/v2/outbound/schedules/messagingcampaigns',
|
|
38448
|
+
'GET',
|
|
38449
|
+
{ },
|
|
38450
|
+
{ },
|
|
38451
|
+
{ },
|
|
38452
|
+
{ },
|
|
38453
|
+
null,
|
|
38454
|
+
['PureCloud OAuth'],
|
|
38455
|
+
['application/json'],
|
|
38456
|
+
['application/json']
|
|
38457
|
+
);
|
|
38458
|
+
}
|
|
38459
|
+
|
|
38245
38460
|
/**
|
|
38246
38461
|
* Get a dialer sequence schedule.
|
|
38247
38462
|
*
|
|
@@ -39445,6 +39660,66 @@ class OutboundApi {
|
|
|
39445
39660
|
);
|
|
39446
39661
|
}
|
|
39447
39662
|
|
|
39663
|
+
/**
|
|
39664
|
+
* Update an email campaign schedule.
|
|
39665
|
+
*
|
|
39666
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
39667
|
+
* @param {Object} body EmailCampaignSchedule
|
|
39668
|
+
*/
|
|
39669
|
+
putOutboundSchedulesEmailcampaign(emailCampaignId, body) {
|
|
39670
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
39671
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
39672
|
+
throw 'Missing the required parameter "emailCampaignId" when calling putOutboundSchedulesEmailcampaign';
|
|
39673
|
+
}
|
|
39674
|
+
// verify the required parameter 'body' is set
|
|
39675
|
+
if (body === undefined || body === null) {
|
|
39676
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesEmailcampaign';
|
|
39677
|
+
}
|
|
39678
|
+
|
|
39679
|
+
return this.apiClient.callApi(
|
|
39680
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
39681
|
+
'PUT',
|
|
39682
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
39683
|
+
{ },
|
|
39684
|
+
{ },
|
|
39685
|
+
{ },
|
|
39686
|
+
body,
|
|
39687
|
+
['PureCloud OAuth'],
|
|
39688
|
+
['application/json'],
|
|
39689
|
+
['application/json']
|
|
39690
|
+
);
|
|
39691
|
+
}
|
|
39692
|
+
|
|
39693
|
+
/**
|
|
39694
|
+
* Update a new messaging campaign schedule.
|
|
39695
|
+
*
|
|
39696
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
39697
|
+
* @param {Object} body MessagingCampaignSchedule
|
|
39698
|
+
*/
|
|
39699
|
+
putOutboundSchedulesMessagingcampaign(messagingCampaignId, body) {
|
|
39700
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
39701
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
39702
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling putOutboundSchedulesMessagingcampaign';
|
|
39703
|
+
}
|
|
39704
|
+
// verify the required parameter 'body' is set
|
|
39705
|
+
if (body === undefined || body === null) {
|
|
39706
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesMessagingcampaign';
|
|
39707
|
+
}
|
|
39708
|
+
|
|
39709
|
+
return this.apiClient.callApi(
|
|
39710
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
39711
|
+
'PUT',
|
|
39712
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
39713
|
+
{ },
|
|
39714
|
+
{ },
|
|
39715
|
+
{ },
|
|
39716
|
+
body,
|
|
39717
|
+
['PureCloud OAuth'],
|
|
39718
|
+
['application/json'],
|
|
39719
|
+
['application/json']
|
|
39720
|
+
);
|
|
39721
|
+
}
|
|
39722
|
+
|
|
39448
39723
|
/**
|
|
39449
39724
|
* Update a new sequence schedule.
|
|
39450
39725
|
*
|
|
@@ -39536,7 +39811,7 @@ class PresenceApi {
|
|
|
39536
39811
|
/**
|
|
39537
39812
|
* Presence service.
|
|
39538
39813
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39539
|
-
* @version
|
|
39814
|
+
* @version 136.1.0
|
|
39540
39815
|
*/
|
|
39541
39816
|
|
|
39542
39817
|
/**
|
|
@@ -39682,31 +39957,6 @@ class PresenceApi {
|
|
|
39682
39957
|
);
|
|
39683
39958
|
}
|
|
39684
39959
|
|
|
39685
|
-
/**
|
|
39686
|
-
* Get a user's Microsoft Teams presence.
|
|
39687
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
39688
|
-
* @param {String} userId user Id
|
|
39689
|
-
*/
|
|
39690
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
39691
|
-
// verify the required parameter 'userId' is set
|
|
39692
|
-
if (userId === undefined || userId === null) {
|
|
39693
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
39694
|
-
}
|
|
39695
|
-
|
|
39696
|
-
return this.apiClient.callApi(
|
|
39697
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
39698
|
-
'GET',
|
|
39699
|
-
{ 'userId': userId },
|
|
39700
|
-
{ },
|
|
39701
|
-
{ },
|
|
39702
|
-
{ },
|
|
39703
|
-
null,
|
|
39704
|
-
['PureCloud OAuth'],
|
|
39705
|
-
['application/json'],
|
|
39706
|
-
['application/json']
|
|
39707
|
-
);
|
|
39708
|
-
}
|
|
39709
|
-
|
|
39710
39960
|
/**
|
|
39711
39961
|
* Get a user's Genesys Cloud presence.
|
|
39712
39962
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -39732,31 +39982,6 @@ class PresenceApi {
|
|
|
39732
39982
|
);
|
|
39733
39983
|
}
|
|
39734
39984
|
|
|
39735
|
-
/**
|
|
39736
|
-
* Get a user's Zoom Phone presence.
|
|
39737
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
39738
|
-
* @param {String} userId user Id
|
|
39739
|
-
*/
|
|
39740
|
-
getUserPresencesZoomphone(userId) {
|
|
39741
|
-
// verify the required parameter 'userId' is set
|
|
39742
|
-
if (userId === undefined || userId === null) {
|
|
39743
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
39744
|
-
}
|
|
39745
|
-
|
|
39746
|
-
return this.apiClient.callApi(
|
|
39747
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
39748
|
-
'GET',
|
|
39749
|
-
{ 'userId': userId },
|
|
39750
|
-
{ },
|
|
39751
|
-
{ },
|
|
39752
|
-
{ },
|
|
39753
|
-
null,
|
|
39754
|
-
['PureCloud OAuth'],
|
|
39755
|
-
['application/json'],
|
|
39756
|
-
['application/json']
|
|
39757
|
-
);
|
|
39758
|
-
}
|
|
39759
|
-
|
|
39760
39985
|
/**
|
|
39761
39986
|
* Patch a user's Presence
|
|
39762
39987
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -39908,7 +40133,7 @@ class QualityApi {
|
|
|
39908
40133
|
/**
|
|
39909
40134
|
* Quality service.
|
|
39910
40135
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
39911
|
-
* @version
|
|
40136
|
+
* @version 136.1.0
|
|
39912
40137
|
*/
|
|
39913
40138
|
|
|
39914
40139
|
/**
|
|
@@ -41486,7 +41711,7 @@ class RecordingApi {
|
|
|
41486
41711
|
/**
|
|
41487
41712
|
* Recording service.
|
|
41488
41713
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
41489
|
-
* @version
|
|
41714
|
+
* @version 136.1.0
|
|
41490
41715
|
*/
|
|
41491
41716
|
|
|
41492
41717
|
/**
|
|
@@ -42009,6 +42234,7 @@ class RecordingApi {
|
|
|
42009
42234
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
42010
42235
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
42011
42236
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
42237
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
42012
42238
|
*/
|
|
42013
42239
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
42014
42240
|
opts = opts || {};
|
|
@@ -42018,7 +42244,7 @@ class RecordingApi {
|
|
|
42018
42244
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
42019
42245
|
'GET',
|
|
42020
42246
|
{ },
|
|
42021
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
42247
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
42022
42248
|
{ },
|
|
42023
42249
|
{ },
|
|
42024
42250
|
null,
|
|
@@ -42141,6 +42367,51 @@ class RecordingApi {
|
|
|
42141
42367
|
);
|
|
42142
42368
|
}
|
|
42143
42369
|
|
|
42370
|
+
/**
|
|
42371
|
+
* Get the encryption key configurations
|
|
42372
|
+
*
|
|
42373
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
42374
|
+
*/
|
|
42375
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
42376
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
42377
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
42378
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
42379
|
+
}
|
|
42380
|
+
|
|
42381
|
+
return this.apiClient.callApi(
|
|
42382
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
42383
|
+
'GET',
|
|
42384
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
42385
|
+
{ },
|
|
42386
|
+
{ },
|
|
42387
|
+
{ },
|
|
42388
|
+
null,
|
|
42389
|
+
['PureCloud OAuth'],
|
|
42390
|
+
['application/json'],
|
|
42391
|
+
['application/json']
|
|
42392
|
+
);
|
|
42393
|
+
}
|
|
42394
|
+
|
|
42395
|
+
/**
|
|
42396
|
+
* Get a list of key configurations data
|
|
42397
|
+
*
|
|
42398
|
+
*/
|
|
42399
|
+
getRecordingKeyconfigurations() {
|
|
42400
|
+
|
|
42401
|
+
return this.apiClient.callApi(
|
|
42402
|
+
'/api/v2/recording/keyconfigurations',
|
|
42403
|
+
'GET',
|
|
42404
|
+
{ },
|
|
42405
|
+
{ },
|
|
42406
|
+
{ },
|
|
42407
|
+
{ },
|
|
42408
|
+
null,
|
|
42409
|
+
['PureCloud OAuth'],
|
|
42410
|
+
['application/json'],
|
|
42411
|
+
['application/json']
|
|
42412
|
+
);
|
|
42413
|
+
}
|
|
42414
|
+
|
|
42144
42415
|
/**
|
|
42145
42416
|
* Get the local encryption settings
|
|
42146
42417
|
*
|
|
@@ -42200,6 +42471,7 @@ class RecordingApi {
|
|
|
42200
42471
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
42201
42472
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
42202
42473
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
42474
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
42203
42475
|
*/
|
|
42204
42476
|
getRecordingMediaretentionpolicies(opts) {
|
|
42205
42477
|
opts = opts || {};
|
|
@@ -42209,7 +42481,7 @@ class RecordingApi {
|
|
|
42209
42481
|
'/api/v2/recording/mediaretentionpolicies',
|
|
42210
42482
|
'GET',
|
|
42211
42483
|
{ },
|
|
42212
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
42484
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
42213
42485
|
{ },
|
|
42214
42486
|
{ },
|
|
42215
42487
|
null,
|
|
@@ -42513,8 +42785,8 @@ class RecordingApi {
|
|
|
42513
42785
|
}
|
|
42514
42786
|
|
|
42515
42787
|
/**
|
|
42516
|
-
* Create a recording bulk job
|
|
42517
|
-
*
|
|
42788
|
+
* Create a recording bulk job.
|
|
42789
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
42518
42790
|
* @param {Object} body query
|
|
42519
42791
|
*/
|
|
42520
42792
|
postRecordingJobs(body) {
|
|
@@ -42537,6 +42809,56 @@ class RecordingApi {
|
|
|
42537
42809
|
);
|
|
42538
42810
|
}
|
|
42539
42811
|
|
|
42812
|
+
/**
|
|
42813
|
+
* Setup configurations for encryption key creation
|
|
42814
|
+
*
|
|
42815
|
+
* @param {Object} body Encryption Configuration
|
|
42816
|
+
*/
|
|
42817
|
+
postRecordingKeyconfigurations(body) {
|
|
42818
|
+
// verify the required parameter 'body' is set
|
|
42819
|
+
if (body === undefined || body === null) {
|
|
42820
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
42821
|
+
}
|
|
42822
|
+
|
|
42823
|
+
return this.apiClient.callApi(
|
|
42824
|
+
'/api/v2/recording/keyconfigurations',
|
|
42825
|
+
'POST',
|
|
42826
|
+
{ },
|
|
42827
|
+
{ },
|
|
42828
|
+
{ },
|
|
42829
|
+
{ },
|
|
42830
|
+
body,
|
|
42831
|
+
['PureCloud OAuth'],
|
|
42832
|
+
['application/json'],
|
|
42833
|
+
['application/json']
|
|
42834
|
+
);
|
|
42835
|
+
}
|
|
42836
|
+
|
|
42837
|
+
/**
|
|
42838
|
+
* Validate encryption key configurations without saving it
|
|
42839
|
+
*
|
|
42840
|
+
* @param {Object} body Encryption Configuration
|
|
42841
|
+
*/
|
|
42842
|
+
postRecordingKeyconfigurationsValidate(body) {
|
|
42843
|
+
// verify the required parameter 'body' is set
|
|
42844
|
+
if (body === undefined || body === null) {
|
|
42845
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
42846
|
+
}
|
|
42847
|
+
|
|
42848
|
+
return this.apiClient.callApi(
|
|
42849
|
+
'/api/v2/recording/keyconfigurations/validate',
|
|
42850
|
+
'POST',
|
|
42851
|
+
{ },
|
|
42852
|
+
{ },
|
|
42853
|
+
{ },
|
|
42854
|
+
{ },
|
|
42855
|
+
body,
|
|
42856
|
+
['PureCloud OAuth'],
|
|
42857
|
+
['application/json'],
|
|
42858
|
+
['application/json']
|
|
42859
|
+
);
|
|
42860
|
+
}
|
|
42861
|
+
|
|
42540
42862
|
/**
|
|
42541
42863
|
* create a local recording key
|
|
42542
42864
|
*
|
|
@@ -42871,6 +43193,36 @@ class RecordingApi {
|
|
|
42871
43193
|
);
|
|
42872
43194
|
}
|
|
42873
43195
|
|
|
43196
|
+
/**
|
|
43197
|
+
* Update the encryption key configurations
|
|
43198
|
+
*
|
|
43199
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
43200
|
+
* @param {Object} body Encryption key configuration metadata
|
|
43201
|
+
*/
|
|
43202
|
+
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
43203
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
43204
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
43205
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
43206
|
+
}
|
|
43207
|
+
// verify the required parameter 'body' is set
|
|
43208
|
+
if (body === undefined || body === null) {
|
|
43209
|
+
throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
|
|
43210
|
+
}
|
|
43211
|
+
|
|
43212
|
+
return this.apiClient.callApi(
|
|
43213
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
43214
|
+
'PUT',
|
|
43215
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
43216
|
+
{ },
|
|
43217
|
+
{ },
|
|
43218
|
+
{ },
|
|
43219
|
+
body,
|
|
43220
|
+
['PureCloud OAuth'],
|
|
43221
|
+
['application/json'],
|
|
43222
|
+
['application/json']
|
|
43223
|
+
);
|
|
43224
|
+
}
|
|
43225
|
+
|
|
42874
43226
|
/**
|
|
42875
43227
|
* Update the local encryption settings
|
|
42876
43228
|
*
|
|
@@ -43012,7 +43364,7 @@ class ResponseManagementApi {
|
|
|
43012
43364
|
/**
|
|
43013
43365
|
* ResponseManagement service.
|
|
43014
43366
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
43015
|
-
* @version
|
|
43367
|
+
* @version 136.1.0
|
|
43016
43368
|
*/
|
|
43017
43369
|
|
|
43018
43370
|
/**
|
|
@@ -43496,7 +43848,7 @@ class RoutingApi {
|
|
|
43496
43848
|
/**
|
|
43497
43849
|
* Routing service.
|
|
43498
43850
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
43499
|
-
* @version
|
|
43851
|
+
* @version 136.1.0
|
|
43500
43852
|
*/
|
|
43501
43853
|
|
|
43502
43854
|
/**
|
|
@@ -44155,14 +44507,18 @@ class RoutingApi {
|
|
|
44155
44507
|
/**
|
|
44156
44508
|
* Get domains
|
|
44157
44509
|
*
|
|
44510
|
+
* @param {Object} opts Optional parameters
|
|
44511
|
+
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
44158
44512
|
*/
|
|
44159
|
-
getRoutingEmailDomains() {
|
|
44513
|
+
getRoutingEmailDomains(opts) {
|
|
44514
|
+
opts = opts || {};
|
|
44515
|
+
|
|
44160
44516
|
|
|
44161
44517
|
return this.apiClient.callApi(
|
|
44162
44518
|
'/api/v2/routing/email/domains',
|
|
44163
44519
|
'GET',
|
|
44164
44520
|
{ },
|
|
44165
|
-
{
|
|
44521
|
+
{ 'excludeStatus': opts['excludeStatus'] },
|
|
44166
44522
|
{ },
|
|
44167
44523
|
{ },
|
|
44168
44524
|
null,
|
|
@@ -46419,7 +46775,7 @@ class SCIMApi {
|
|
|
46419
46775
|
/**
|
|
46420
46776
|
* SCIM service.
|
|
46421
46777
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
46422
|
-
* @version
|
|
46778
|
+
* @version 136.1.0
|
|
46423
46779
|
*/
|
|
46424
46780
|
|
|
46425
46781
|
/**
|
|
@@ -47296,7 +47652,7 @@ class ScriptsApi {
|
|
|
47296
47652
|
/**
|
|
47297
47653
|
* Scripts service.
|
|
47298
47654
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
47299
|
-
* @version
|
|
47655
|
+
* @version 136.1.0
|
|
47300
47656
|
*/
|
|
47301
47657
|
|
|
47302
47658
|
/**
|
|
@@ -47412,6 +47768,7 @@ class ScriptsApi {
|
|
|
47412
47768
|
* @param {Object} opts.sortBy SortBy
|
|
47413
47769
|
* @param {Object} opts.sortOrder SortOrder
|
|
47414
47770
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47771
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47415
47772
|
*/
|
|
47416
47773
|
getScripts(opts) {
|
|
47417
47774
|
opts = opts || {};
|
|
@@ -47421,7 +47778,40 @@ class ScriptsApi {
|
|
|
47421
47778
|
'/api/v2/scripts',
|
|
47422
47779
|
'GET',
|
|
47423
47780
|
{ },
|
|
47424
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
47781
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
47782
|
+
{ },
|
|
47783
|
+
{ },
|
|
47784
|
+
null,
|
|
47785
|
+
['PureCloud OAuth'],
|
|
47786
|
+
['application/json'],
|
|
47787
|
+
['application/json']
|
|
47788
|
+
);
|
|
47789
|
+
}
|
|
47790
|
+
|
|
47791
|
+
/**
|
|
47792
|
+
* Get the metadata for a list of scripts
|
|
47793
|
+
*
|
|
47794
|
+
* @param {Object} opts Optional parameters
|
|
47795
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47796
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47797
|
+
* @param {String} opts.expand Expand
|
|
47798
|
+
* @param {String} opts.name Name filter
|
|
47799
|
+
* @param {String} opts.feature Feature filter
|
|
47800
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
47801
|
+
* @param {Object} opts.sortBy SortBy
|
|
47802
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
47803
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47804
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47805
|
+
*/
|
|
47806
|
+
getScriptsDivisionviews(opts) {
|
|
47807
|
+
opts = opts || {};
|
|
47808
|
+
|
|
47809
|
+
|
|
47810
|
+
return this.apiClient.callApi(
|
|
47811
|
+
'/api/v2/scripts/divisionviews',
|
|
47812
|
+
'GET',
|
|
47813
|
+
{ },
|
|
47814
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
47425
47815
|
{ },
|
|
47426
47816
|
{ },
|
|
47427
47817
|
null,
|
|
@@ -47442,6 +47832,7 @@ class ScriptsApi {
|
|
|
47442
47832
|
* @param {String} opts.feature Feature filter
|
|
47443
47833
|
* @param {String} opts.flowId Secure flow id filter
|
|
47444
47834
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47835
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47445
47836
|
*/
|
|
47446
47837
|
getScriptsPublished(opts) {
|
|
47447
47838
|
opts = opts || {};
|
|
@@ -47451,7 +47842,38 @@ class ScriptsApi {
|
|
|
47451
47842
|
'/api/v2/scripts/published',
|
|
47452
47843
|
'GET',
|
|
47453
47844
|
{ },
|
|
47454
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
47845
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
47846
|
+
{ },
|
|
47847
|
+
{ },
|
|
47848
|
+
null,
|
|
47849
|
+
['PureCloud OAuth'],
|
|
47850
|
+
['application/json'],
|
|
47851
|
+
['application/json']
|
|
47852
|
+
);
|
|
47853
|
+
}
|
|
47854
|
+
|
|
47855
|
+
/**
|
|
47856
|
+
* Get the published scripts metadata.
|
|
47857
|
+
*
|
|
47858
|
+
* @param {Object} opts Optional parameters
|
|
47859
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47860
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47861
|
+
* @param {String} opts.expand Expand
|
|
47862
|
+
* @param {String} opts.name Name filter
|
|
47863
|
+
* @param {String} opts.feature Feature filter
|
|
47864
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
47865
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47866
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47867
|
+
*/
|
|
47868
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
47869
|
+
opts = opts || {};
|
|
47870
|
+
|
|
47871
|
+
|
|
47872
|
+
return this.apiClient.callApi(
|
|
47873
|
+
'/api/v2/scripts/published/divisionviews',
|
|
47874
|
+
'GET',
|
|
47875
|
+
{ },
|
|
47876
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
47455
47877
|
{ },
|
|
47456
47878
|
{ },
|
|
47457
47879
|
null,
|
|
@@ -47649,7 +48071,7 @@ class SearchApi {
|
|
|
47649
48071
|
/**
|
|
47650
48072
|
* Search service.
|
|
47651
48073
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
47652
|
-
* @version
|
|
48074
|
+
* @version 136.1.0
|
|
47653
48075
|
*/
|
|
47654
48076
|
|
|
47655
48077
|
/**
|
|
@@ -48184,7 +48606,7 @@ class SpeechTextAnalyticsApi {
|
|
|
48184
48606
|
/**
|
|
48185
48607
|
* SpeechTextAnalytics service.
|
|
48186
48608
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
48187
|
-
* @version
|
|
48609
|
+
* @version 136.1.0
|
|
48188
48610
|
*/
|
|
48189
48611
|
|
|
48190
48612
|
/**
|
|
@@ -49037,7 +49459,7 @@ class StationsApi {
|
|
|
49037
49459
|
/**
|
|
49038
49460
|
* Stations service.
|
|
49039
49461
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
49040
|
-
* @version
|
|
49462
|
+
* @version 136.1.0
|
|
49041
49463
|
*/
|
|
49042
49464
|
|
|
49043
49465
|
/**
|
|
@@ -49184,7 +49606,7 @@ class SuggestApi {
|
|
|
49184
49606
|
/**
|
|
49185
49607
|
* Suggest service.
|
|
49186
49608
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
49187
|
-
* @version
|
|
49609
|
+
* @version 136.1.0
|
|
49188
49610
|
*/
|
|
49189
49611
|
|
|
49190
49612
|
/**
|
|
@@ -49323,7 +49745,7 @@ class TelephonyApi {
|
|
|
49323
49745
|
/**
|
|
49324
49746
|
* Telephony service.
|
|
49325
49747
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
49326
|
-
* @version
|
|
49748
|
+
* @version 136.1.0
|
|
49327
49749
|
*/
|
|
49328
49750
|
|
|
49329
49751
|
/**
|
|
@@ -49431,7 +49853,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
49431
49853
|
/**
|
|
49432
49854
|
* TelephonyProvidersEdge service.
|
|
49433
49855
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
49434
|
-
* @version
|
|
49856
|
+
* @version 136.1.0
|
|
49435
49857
|
*/
|
|
49436
49858
|
|
|
49437
49859
|
/**
|
|
@@ -50846,7 +51268,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
50846
51268
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50847
51269
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50848
51270
|
* @param {String} opts.sortBy Sort by
|
|
50849
|
-
* @param {String} opts._number
|
|
51271
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
50850
51272
|
*/
|
|
50851
51273
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
50852
51274
|
opts = opts || {};
|
|
@@ -53064,7 +53486,7 @@ class TextbotsApi {
|
|
|
53064
53486
|
/**
|
|
53065
53487
|
* Textbots service.
|
|
53066
53488
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
53067
|
-
* @version
|
|
53489
|
+
* @version 136.1.0
|
|
53068
53490
|
*/
|
|
53069
53491
|
|
|
53070
53492
|
/**
|
|
@@ -53192,7 +53614,7 @@ class TokensApi {
|
|
|
53192
53614
|
/**
|
|
53193
53615
|
* Tokens service.
|
|
53194
53616
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
53195
|
-
* @version
|
|
53617
|
+
* @version 136.1.0
|
|
53196
53618
|
*/
|
|
53197
53619
|
|
|
53198
53620
|
/**
|
|
@@ -53298,7 +53720,7 @@ class UploadsApi {
|
|
|
53298
53720
|
/**
|
|
53299
53721
|
* Uploads service.
|
|
53300
53722
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
53301
|
-
* @version
|
|
53723
|
+
* @version 136.1.0
|
|
53302
53724
|
*/
|
|
53303
53725
|
|
|
53304
53726
|
/**
|
|
@@ -53449,7 +53871,7 @@ class UsageApi {
|
|
|
53449
53871
|
/**
|
|
53450
53872
|
* Usage service.
|
|
53451
53873
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
53452
|
-
* @version
|
|
53874
|
+
* @version 136.1.0
|
|
53453
53875
|
*/
|
|
53454
53876
|
|
|
53455
53877
|
/**
|
|
@@ -53520,7 +53942,7 @@ class UserRecordingsApi {
|
|
|
53520
53942
|
/**
|
|
53521
53943
|
* UserRecordings service.
|
|
53522
53944
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
53523
|
-
* @version
|
|
53945
|
+
* @version 136.1.0
|
|
53524
53946
|
*/
|
|
53525
53947
|
|
|
53526
53948
|
/**
|
|
@@ -53704,7 +54126,7 @@ class UsersApi {
|
|
|
53704
54126
|
/**
|
|
53705
54127
|
* Users service.
|
|
53706
54128
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
53707
|
-
* @version
|
|
54129
|
+
* @version 136.1.0
|
|
53708
54130
|
*/
|
|
53709
54131
|
|
|
53710
54132
|
/**
|
|
@@ -56006,7 +56428,7 @@ class UtilitiesApi {
|
|
|
56006
56428
|
/**
|
|
56007
56429
|
* Utilities service.
|
|
56008
56430
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
56009
|
-
* @version
|
|
56431
|
+
* @version 136.1.0
|
|
56010
56432
|
*/
|
|
56011
56433
|
|
|
56012
56434
|
/**
|
|
@@ -56117,7 +56539,7 @@ class VoicemailApi {
|
|
|
56117
56539
|
/**
|
|
56118
56540
|
* Voicemail service.
|
|
56119
56541
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
56120
|
-
* @version
|
|
56542
|
+
* @version 136.1.0
|
|
56121
56543
|
*/
|
|
56122
56544
|
|
|
56123
56545
|
/**
|
|
@@ -56784,7 +57206,7 @@ class WebChatApi {
|
|
|
56784
57206
|
/**
|
|
56785
57207
|
* WebChat service.
|
|
56786
57208
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
56787
|
-
* @version
|
|
57209
|
+
* @version 136.1.0
|
|
56788
57210
|
*/
|
|
56789
57211
|
|
|
56790
57212
|
/**
|
|
@@ -57328,7 +57750,7 @@ class WebDeploymentsApi {
|
|
|
57328
57750
|
/**
|
|
57329
57751
|
* WebDeployments service.
|
|
57330
57752
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
57331
|
-
* @version
|
|
57753
|
+
* @version 136.1.0
|
|
57332
57754
|
*/
|
|
57333
57755
|
|
|
57334
57756
|
/**
|
|
@@ -57683,7 +58105,7 @@ class WebMessagingApi {
|
|
|
57683
58105
|
/**
|
|
57684
58106
|
* WebMessaging service.
|
|
57685
58107
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
57686
|
-
* @version
|
|
58108
|
+
* @version 136.1.0
|
|
57687
58109
|
*/
|
|
57688
58110
|
|
|
57689
58111
|
/**
|
|
@@ -57729,7 +58151,7 @@ class WidgetsApi {
|
|
|
57729
58151
|
/**
|
|
57730
58152
|
* Widgets service.
|
|
57731
58153
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
57732
|
-
* @version
|
|
58154
|
+
* @version 136.1.0
|
|
57733
58155
|
*/
|
|
57734
58156
|
|
|
57735
58157
|
/**
|
|
@@ -57875,7 +58297,7 @@ class WorkforceManagementApi {
|
|
|
57875
58297
|
/**
|
|
57876
58298
|
* WorkforceManagement service.
|
|
57877
58299
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
57878
|
-
* @version
|
|
58300
|
+
* @version 136.1.0
|
|
57879
58301
|
*/
|
|
57880
58302
|
|
|
57881
58303
|
/**
|
|
@@ -58073,7 +58495,7 @@ class WorkforceManagementApi {
|
|
|
58073
58495
|
/**
|
|
58074
58496
|
* Delete a short term forecast
|
|
58075
58497
|
* Must not be tied to any schedules
|
|
58076
|
-
* @param {String} businessUnitId The
|
|
58498
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58077
58499
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
58078
58500
|
* @param {String} forecastId The ID of the forecast
|
|
58079
58501
|
*/
|
|
@@ -58153,7 +58575,7 @@ class WorkforceManagementApi {
|
|
|
58153
58575
|
/**
|
|
58154
58576
|
* Deletes a time off limit object
|
|
58155
58577
|
*
|
|
58156
|
-
* @param {String} managementUnitId The
|
|
58578
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
58157
58579
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
58158
58580
|
*/
|
|
58159
58581
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -58183,7 +58605,7 @@ class WorkforceManagementApi {
|
|
|
58183
58605
|
/**
|
|
58184
58606
|
* Deletes a time off plan
|
|
58185
58607
|
*
|
|
58186
|
-
* @param {String} managementUnitId The management unit
|
|
58608
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
58187
58609
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
58188
58610
|
*/
|
|
58189
58611
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -58452,7 +58874,7 @@ class WorkforceManagementApi {
|
|
|
58452
58874
|
/**
|
|
58453
58875
|
* Get intraday planning groups for the given date
|
|
58454
58876
|
*
|
|
58455
|
-
* @param {String} businessUnitId The
|
|
58877
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
58456
58878
|
* @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
58457
58879
|
*/
|
|
58458
58880
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -58905,7 +59327,7 @@ class WorkforceManagementApi {
|
|
|
58905
59327
|
/**
|
|
58906
59328
|
* Get a short term forecast
|
|
58907
59329
|
*
|
|
58908
|
-
* @param {String} businessUnitId The
|
|
59330
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58909
59331
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
58910
59332
|
* @param {String} forecastId The ID of the forecast
|
|
58911
59333
|
* @param {Object} opts Optional parameters
|
|
@@ -58944,7 +59366,7 @@ class WorkforceManagementApi {
|
|
|
58944
59366
|
/**
|
|
58945
59367
|
* Get the result of a short term forecast calculation
|
|
58946
59368
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
58947
|
-
* @param {String} businessUnitId The
|
|
59369
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58948
59370
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
58949
59371
|
* @param {String} forecastId The ID of the forecast
|
|
58950
59372
|
* @param {Object} opts Optional parameters
|
|
@@ -58984,7 +59406,7 @@ class WorkforceManagementApi {
|
|
|
58984
59406
|
/**
|
|
58985
59407
|
* Gets the forecast generation results
|
|
58986
59408
|
*
|
|
58987
|
-
* @param {String} businessUnitId The
|
|
59409
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58988
59410
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
58989
59411
|
* @param {String} forecastId The ID of the forecast
|
|
58990
59412
|
*/
|
|
@@ -59019,7 +59441,7 @@ class WorkforceManagementApi {
|
|
|
59019
59441
|
/**
|
|
59020
59442
|
* Get the result of a long term forecast calculation
|
|
59021
59443
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
59022
|
-
* @param {String} businessUnitId The
|
|
59444
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
59023
59445
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
59024
59446
|
* @param {String} forecastId The ID of the forecast
|
|
59025
59447
|
* @param {Object} opts Optional parameters
|
|
@@ -59058,7 +59480,7 @@ class WorkforceManagementApi {
|
|
|
59058
59480
|
/**
|
|
59059
59481
|
* Gets the forecast planning group snapshot
|
|
59060
59482
|
*
|
|
59061
|
-
* @param {String} businessUnitId The
|
|
59483
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
59062
59484
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
59063
59485
|
* @param {String} forecastId The ID of the forecast
|
|
59064
59486
|
*/
|
|
@@ -59093,7 +59515,7 @@ class WorkforceManagementApi {
|
|
|
59093
59515
|
/**
|
|
59094
59516
|
* Get short term forecasts
|
|
59095
59517
|
* Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
59096
|
-
* @param {String} businessUnitId The
|
|
59518
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
59097
59519
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
59098
59520
|
*/
|
|
59099
59521
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -59311,7 +59733,7 @@ class WorkforceManagementApi {
|
|
|
59311
59733
|
/**
|
|
59312
59734
|
* Get a list of user schedule adherence records for the requested management unit
|
|
59313
59735
|
*
|
|
59314
|
-
* @param {String} managementUnitId The
|
|
59736
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59315
59737
|
* @param {Object} opts Optional parameters
|
|
59316
59738
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
59317
59739
|
*/
|
|
@@ -59340,7 +59762,7 @@ class WorkforceManagementApi {
|
|
|
59340
59762
|
/**
|
|
59341
59763
|
* Get data for agent in the management unit
|
|
59342
59764
|
*
|
|
59343
|
-
* @param {String} managementUnitId The
|
|
59765
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59344
59766
|
* @param {String} agentId The agent id
|
|
59345
59767
|
* @param {Object} opts Optional parameters
|
|
59346
59768
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -59374,7 +59796,7 @@ class WorkforceManagementApi {
|
|
|
59374
59796
|
/**
|
|
59375
59797
|
* Gets all the shift trades for a given agent
|
|
59376
59798
|
*
|
|
59377
|
-
* @param {String} managementUnitId The
|
|
59799
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59378
59800
|
* @param {String} agentId The agent id
|
|
59379
59801
|
*/
|
|
59380
59802
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -59404,7 +59826,7 @@ class WorkforceManagementApi {
|
|
|
59404
59826
|
/**
|
|
59405
59827
|
* Gets a summary of all shift trades in the matched state
|
|
59406
59828
|
*
|
|
59407
|
-
* @param {String} managementUnitId The
|
|
59829
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59408
59830
|
*/
|
|
59409
59831
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
59410
59832
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59429,7 +59851,7 @@ class WorkforceManagementApi {
|
|
|
59429
59851
|
/**
|
|
59430
59852
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
59431
59853
|
*
|
|
59432
|
-
* @param {String} managementUnitId The
|
|
59854
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59433
59855
|
*/
|
|
59434
59856
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
59435
59857
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59454,7 +59876,7 @@ class WorkforceManagementApi {
|
|
|
59454
59876
|
/**
|
|
59455
59877
|
* Gets a time off limit object
|
|
59456
59878
|
* Returns properties of time off limit object, but not daily values.
|
|
59457
|
-
* @param {String} managementUnitId The
|
|
59879
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59458
59880
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
59459
59881
|
*/
|
|
59460
59882
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -59484,7 +59906,7 @@ class WorkforceManagementApi {
|
|
|
59484
59906
|
/**
|
|
59485
59907
|
* Gets a list of time off limit objects under management unit.
|
|
59486
59908
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
59487
|
-
* @param {String} managementUnitId The
|
|
59909
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59488
59910
|
*/
|
|
59489
59911
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
59490
59912
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59509,7 +59931,7 @@ class WorkforceManagementApi {
|
|
|
59509
59931
|
/**
|
|
59510
59932
|
* Gets a time off plan
|
|
59511
59933
|
*
|
|
59512
|
-
* @param {String} managementUnitId The management unit
|
|
59934
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59513
59935
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
59514
59936
|
*/
|
|
59515
59937
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -59539,7 +59961,7 @@ class WorkforceManagementApi {
|
|
|
59539
59961
|
/**
|
|
59540
59962
|
* Gets a list of time off plans
|
|
59541
59963
|
*
|
|
59542
|
-
* @param {String} managementUnitId The management unit
|
|
59964
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59543
59965
|
*/
|
|
59544
59966
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
59545
59967
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59564,7 +59986,7 @@ class WorkforceManagementApi {
|
|
|
59564
59986
|
/**
|
|
59565
59987
|
* Get a time off request
|
|
59566
59988
|
*
|
|
59567
|
-
* @param {String} managementUnitId The
|
|
59989
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59568
59990
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
59569
59991
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
59570
59992
|
*/
|
|
@@ -59599,7 +60021,7 @@ class WorkforceManagementApi {
|
|
|
59599
60021
|
/**
|
|
59600
60022
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
59601
60023
|
*
|
|
59602
|
-
* @param {String} managementUnitId The
|
|
60024
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59603
60025
|
* @param {String} userId The userId to whom the time off request applies.
|
|
59604
60026
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
59605
60027
|
*/
|
|
@@ -59634,7 +60056,7 @@ class WorkforceManagementApi {
|
|
|
59634
60056
|
/**
|
|
59635
60057
|
* Get a list of time off requests for a given user
|
|
59636
60058
|
*
|
|
59637
|
-
* @param {String} managementUnitId The
|
|
60059
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59638
60060
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
59639
60061
|
* @param {Object} opts Optional parameters
|
|
59640
60062
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -59668,7 +60090,7 @@ class WorkforceManagementApi {
|
|
|
59668
60090
|
/**
|
|
59669
60091
|
* Get users in the management unit
|
|
59670
60092
|
*
|
|
59671
|
-
* @param {String} managementUnitId The
|
|
60093
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59672
60094
|
*/
|
|
59673
60095
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
59674
60096
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59769,7 +60191,7 @@ class WorkforceManagementApi {
|
|
|
59769
60191
|
/**
|
|
59770
60192
|
* Gets all the shift trades for a given week
|
|
59771
60193
|
*
|
|
59772
|
-
* @param {String} managementUnitId The
|
|
60194
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59773
60195
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
59774
60196
|
* @param {Object} opts Optional parameters
|
|
59775
60197
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -60042,7 +60464,7 @@ class WorkforceManagementApi {
|
|
|
60042
60464
|
/**
|
|
60043
60465
|
* Get a time off request for the current user
|
|
60044
60466
|
*
|
|
60045
|
-
* @param {String} timeOffRequestId
|
|
60467
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
60046
60468
|
*/
|
|
60047
60469
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
60048
60470
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -60067,7 +60489,7 @@ class WorkforceManagementApi {
|
|
|
60067
60489
|
/**
|
|
60068
60490
|
* Get the daily waitlist positions of a time off request for the current user
|
|
60069
60491
|
*
|
|
60070
|
-
* @param {String} timeOffRequestId
|
|
60492
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
60071
60493
|
*/
|
|
60072
60494
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
60073
60495
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -60310,7 +60732,7 @@ class WorkforceManagementApi {
|
|
|
60310
60732
|
/**
|
|
60311
60733
|
* Updates a time off limit object.
|
|
60312
60734
|
* Updates time off limit object properties, but not daily values.
|
|
60313
|
-
* @param {String} managementUnitId The
|
|
60735
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
60314
60736
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
60315
60737
|
* @param {Object} opts Optional parameters
|
|
60316
60738
|
* @param {Object} opts.body body
|
|
@@ -60344,7 +60766,7 @@ class WorkforceManagementApi {
|
|
|
60344
60766
|
/**
|
|
60345
60767
|
* Updates a time off plan
|
|
60346
60768
|
*
|
|
60347
|
-
* @param {String} managementUnitId The management unit
|
|
60769
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
60348
60770
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
60349
60771
|
* @param {Object} opts Optional parameters
|
|
60350
60772
|
* @param {Object} opts.body body
|
|
@@ -60378,7 +60800,7 @@ class WorkforceManagementApi {
|
|
|
60378
60800
|
/**
|
|
60379
60801
|
* Update a time off request
|
|
60380
60802
|
*
|
|
60381
|
-
* @param {String} managementUnitId The
|
|
60803
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
60382
60804
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
60383
60805
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
60384
60806
|
* @param {Object} opts Optional parameters
|
|
@@ -60417,7 +60839,7 @@ class WorkforceManagementApi {
|
|
|
60417
60839
|
/**
|
|
60418
60840
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
60419
60841
|
*
|
|
60420
|
-
* @param {String} managementUnitId The
|
|
60842
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
60421
60843
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
60422
60844
|
* @param {Object} body body
|
|
60423
60845
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -60526,7 +60948,7 @@ class WorkforceManagementApi {
|
|
|
60526
60948
|
/**
|
|
60527
60949
|
* Update a time off request for the current user
|
|
60528
60950
|
*
|
|
60529
|
-
* @param {String} timeOffRequestId
|
|
60951
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
60530
60952
|
* @param {Object} opts Optional parameters
|
|
60531
60953
|
* @param {Object} opts.body body
|
|
60532
60954
|
*/
|
|
@@ -60663,7 +61085,7 @@ class WorkforceManagementApi {
|
|
|
60663
61085
|
/**
|
|
60664
61086
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
60665
61087
|
*
|
|
60666
|
-
* @param {String} businessUnitId The
|
|
61088
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
60667
61089
|
* @param {Object} opts Optional parameters
|
|
60668
61090
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
60669
61091
|
* @param {Object} opts.body body
|
|
@@ -61096,7 +61518,7 @@ class WorkforceManagementApi {
|
|
|
61096
61518
|
/**
|
|
61097
61519
|
* Copy a short term forecast
|
|
61098
61520
|
*
|
|
61099
|
-
* @param {String} businessUnitId The
|
|
61521
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61100
61522
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61101
61523
|
* @param {String} forecastId The ID of the forecast to copy
|
|
61102
61524
|
* @param {Object} body body
|
|
@@ -61140,7 +61562,7 @@ class WorkforceManagementApi {
|
|
|
61140
61562
|
/**
|
|
61141
61563
|
* Generate a short term forecast
|
|
61142
61564
|
*
|
|
61143
|
-
* @param {String} businessUnitId The
|
|
61565
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61144
61566
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61145
61567
|
* @param {Object} body
|
|
61146
61568
|
* @param {Object} opts Optional parameters
|
|
@@ -61179,7 +61601,7 @@ class WorkforceManagementApi {
|
|
|
61179
61601
|
/**
|
|
61180
61602
|
* Starts importing the uploaded short term forecast
|
|
61181
61603
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
61182
|
-
* @param {String} businessUnitId The
|
|
61604
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61183
61605
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61184
61606
|
* @param {Object} body
|
|
61185
61607
|
*/
|
|
@@ -61214,7 +61636,7 @@ class WorkforceManagementApi {
|
|
|
61214
61636
|
/**
|
|
61215
61637
|
* Creates a signed upload URL for importing a short term forecast
|
|
61216
61638
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
61217
|
-
* @param {String} businessUnitId The
|
|
61639
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61218
61640
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61219
61641
|
* @param {Object} body body
|
|
61220
61642
|
*/
|
|
@@ -61341,7 +61763,7 @@ class WorkforceManagementApi {
|
|
|
61341
61763
|
/**
|
|
61342
61764
|
* Query published schedules for given given time range for set of users
|
|
61343
61765
|
*
|
|
61344
|
-
* @param {String} managementUnitId The
|
|
61766
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61345
61767
|
* @param {Object} opts Optional parameters
|
|
61346
61768
|
* @param {Object} opts.body body
|
|
61347
61769
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -61372,7 +61794,7 @@ class WorkforceManagementApi {
|
|
|
61372
61794
|
/**
|
|
61373
61795
|
* Request a historical adherence report
|
|
61374
61796
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
61375
|
-
* @param {String} managementUnitId The
|
|
61797
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
61376
61798
|
* @param {Object} opts Optional parameters
|
|
61377
61799
|
* @param {Object} opts.body body
|
|
61378
61800
|
*/
|
|
@@ -61430,7 +61852,7 @@ class WorkforceManagementApi {
|
|
|
61430
61852
|
/**
|
|
61431
61853
|
* Query published schedules for given given time range for set of users
|
|
61432
61854
|
*
|
|
61433
|
-
* @param {String} managementUnitId The
|
|
61855
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61434
61856
|
* @param {Object} opts Optional parameters
|
|
61435
61857
|
* @param {Object} opts.body body
|
|
61436
61858
|
*/
|
|
@@ -61459,7 +61881,7 @@ class WorkforceManagementApi {
|
|
|
61459
61881
|
/**
|
|
61460
61882
|
* Creates a new time off limit object under management unit.
|
|
61461
61883
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
61462
|
-
* @param {String} managementUnitId The
|
|
61884
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61463
61885
|
* @param {Object} opts Optional parameters
|
|
61464
61886
|
* @param {Object} opts.body body
|
|
61465
61887
|
*/
|
|
@@ -61488,7 +61910,7 @@ class WorkforceManagementApi {
|
|
|
61488
61910
|
/**
|
|
61489
61911
|
* Retrieves time off limit related values based on a given set of filters.
|
|
61490
61912
|
*
|
|
61491
|
-
* @param {String} managementUnitId The
|
|
61913
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61492
61914
|
* @param {Object} opts Optional parameters
|
|
61493
61915
|
* @param {Object} opts.body body
|
|
61494
61916
|
*/
|
|
@@ -61517,7 +61939,7 @@ class WorkforceManagementApi {
|
|
|
61517
61939
|
/**
|
|
61518
61940
|
* Creates a new time off plan
|
|
61519
61941
|
*
|
|
61520
|
-
* @param {String} managementUnitId The management unit
|
|
61942
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
61521
61943
|
* @param {Object} opts Optional parameters
|
|
61522
61944
|
* @param {Object} opts.body body
|
|
61523
61945
|
*/
|
|
@@ -61546,7 +61968,7 @@ class WorkforceManagementApi {
|
|
|
61546
61968
|
/**
|
|
61547
61969
|
* Create a new time off request
|
|
61548
61970
|
*
|
|
61549
|
-
* @param {String} managementUnitId The
|
|
61971
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61550
61972
|
* @param {Object} opts Optional parameters
|
|
61551
61973
|
* @param {Object} opts.body body
|
|
61552
61974
|
*/
|
|
@@ -61575,7 +61997,7 @@ class WorkforceManagementApi {
|
|
|
61575
61997
|
/**
|
|
61576
61998
|
* Fetches time off requests matching the conditions specified in the request body
|
|
61577
61999
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
61578
|
-
* @param {String} managementUnitId The
|
|
62000
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61579
62001
|
* @param {Object} opts Optional parameters
|
|
61580
62002
|
* @param {Object} opts.body body
|
|
61581
62003
|
*/
|
|
@@ -61604,7 +62026,7 @@ class WorkforceManagementApi {
|
|
|
61604
62026
|
/**
|
|
61605
62027
|
* Retrieves daily waitlist position for a list of time off requests
|
|
61606
62028
|
*
|
|
61607
|
-
* @param {String} managementUnitId The
|
|
62029
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61608
62030
|
* @param {Object} opts Optional parameters
|
|
61609
62031
|
* @param {Object} opts.body body
|
|
61610
62032
|
*/
|
|
@@ -61633,7 +62055,7 @@ class WorkforceManagementApi {
|
|
|
61633
62055
|
/**
|
|
61634
62056
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
61635
62057
|
*
|
|
61636
|
-
* @param {String} managementUnitId The
|
|
62058
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61637
62059
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61638
62060
|
* @param {Object} body body
|
|
61639
62061
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -61673,7 +62095,7 @@ class WorkforceManagementApi {
|
|
|
61673
62095
|
/**
|
|
61674
62096
|
* Adds a shift trade
|
|
61675
62097
|
*
|
|
61676
|
-
* @param {String} managementUnitId The
|
|
62098
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61677
62099
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61678
62100
|
* @param {Object} body body
|
|
61679
62101
|
*/
|
|
@@ -61708,7 +62130,7 @@ class WorkforceManagementApi {
|
|
|
61708
62130
|
/**
|
|
61709
62131
|
* Searches for potential shift trade matches for the current agent
|
|
61710
62132
|
*
|
|
61711
|
-
* @param {String} managementUnitId The
|
|
62133
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61712
62134
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61713
62135
|
* @param {Object} body body
|
|
61714
62136
|
*/
|
|
@@ -61743,7 +62165,7 @@ class WorkforceManagementApi {
|
|
|
61743
62165
|
/**
|
|
61744
62166
|
* Updates the state of a batch of shift trades
|
|
61745
62167
|
* Admin functionality is not supported with \"mine\".
|
|
61746
|
-
* @param {String} managementUnitId The
|
|
62168
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61747
62169
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61748
62170
|
* @param {Object} body body
|
|
61749
62171
|
* @param {Object} opts Optional parameters
|
|
@@ -62064,7 +62486,7 @@ class WorkforceManagementApi {
|
|
|
62064
62486
|
/**
|
|
62065
62487
|
* Sets daily values for a date range of time off limit object
|
|
62066
62488
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
62067
|
-
* @param {String} managementUnitId The
|
|
62489
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
62068
62490
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
62069
62491
|
* @param {Object} opts Optional parameters
|
|
62070
62492
|
* @param {Object} opts.body body
|
|
@@ -62126,7 +62548,7 @@ class WorkforceManagementApi {
|
|
|
62126
62548
|
* </pre>
|
|
62127
62549
|
* </p>
|
|
62128
62550
|
* @module purecloud-platform-client-v2/index
|
|
62129
|
-
* @version
|
|
62551
|
+
* @version 136.1.0
|
|
62130
62552
|
*/
|
|
62131
62553
|
class platformClient {
|
|
62132
62554
|
constructor() {
|