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
|
@@ -393,7 +393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
393
393
|
|
|
394
394
|
/**
|
|
395
395
|
* @module purecloud-platform-client-v2/ApiClient
|
|
396
|
-
* @version
|
|
396
|
+
* @version 136.1.0
|
|
397
397
|
*/
|
|
398
398
|
class ApiClient {
|
|
399
399
|
/**
|
|
@@ -1340,7 +1340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1340
1340
|
|
|
1341
1341
|
// set header parameters
|
|
1342
1342
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1343
|
-
//request.set({ 'purecloud-sdk': '
|
|
1343
|
+
//request.set({ 'purecloud-sdk': '136.1.0' });
|
|
1344
1344
|
|
|
1345
1345
|
// set request timeout
|
|
1346
1346
|
request.timeout(that.timeout);
|
|
@@ -1440,7 +1440,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1440
1440
|
/**
|
|
1441
1441
|
* Alerting service.
|
|
1442
1442
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1443
|
-
* @version
|
|
1443
|
+
* @version 136.1.0
|
|
1444
1444
|
*/
|
|
1445
1445
|
|
|
1446
1446
|
/**
|
|
@@ -1754,7 +1754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1754
1754
|
/**
|
|
1755
1755
|
* Analytics service.
|
|
1756
1756
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1757
|
-
* @version
|
|
1757
|
+
* @version 136.1.0
|
|
1758
1758
|
*/
|
|
1759
1759
|
|
|
1760
1760
|
/**
|
|
@@ -2936,7 +2936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2936
2936
|
/**
|
|
2937
2937
|
* Architect service.
|
|
2938
2938
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2939
|
-
* @version
|
|
2939
|
+
* @version 136.1.0
|
|
2940
2940
|
*/
|
|
2941
2941
|
|
|
2942
2942
|
/**
|
|
@@ -4700,6 +4700,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4700
4700
|
);
|
|
4701
4701
|
}
|
|
4702
4702
|
|
|
4703
|
+
/**
|
|
4704
|
+
* Fetch Architect Job Status
|
|
4705
|
+
*
|
|
4706
|
+
* @param {String} jobId Job ID
|
|
4707
|
+
* @param {Object} opts Optional parameters
|
|
4708
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
4709
|
+
*/
|
|
4710
|
+
getFlowsJob(jobId, opts) {
|
|
4711
|
+
opts = opts || {};
|
|
4712
|
+
|
|
4713
|
+
// verify the required parameter 'jobId' is set
|
|
4714
|
+
if (jobId === undefined || jobId === null) {
|
|
4715
|
+
throw 'Missing the required parameter "jobId" when calling getFlowsJob';
|
|
4716
|
+
}
|
|
4717
|
+
|
|
4718
|
+
return this.apiClient.callApi(
|
|
4719
|
+
'/api/v2/flows/jobs/{jobId}',
|
|
4720
|
+
'GET',
|
|
4721
|
+
{ 'jobId': jobId },
|
|
4722
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
4723
|
+
{ },
|
|
4724
|
+
{ },
|
|
4725
|
+
null,
|
|
4726
|
+
['PureCloud OAuth'],
|
|
4727
|
+
['application/json'],
|
|
4728
|
+
['application/json']
|
|
4729
|
+
);
|
|
4730
|
+
}
|
|
4731
|
+
|
|
4703
4732
|
/**
|
|
4704
4733
|
* Get a flow milestone
|
|
4705
4734
|
* Returns a specified flow milestone
|
|
@@ -5502,6 +5531,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5502
5531
|
);
|
|
5503
5532
|
}
|
|
5504
5533
|
|
|
5534
|
+
/**
|
|
5535
|
+
* 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.
|
|
5536
|
+
*
|
|
5537
|
+
*/
|
|
5538
|
+
postFlowsJobs() {
|
|
5539
|
+
|
|
5540
|
+
return this.apiClient.callApi(
|
|
5541
|
+
'/api/v2/flows/jobs',
|
|
5542
|
+
'POST',
|
|
5543
|
+
{ },
|
|
5544
|
+
{ },
|
|
5545
|
+
{ },
|
|
5546
|
+
{ },
|
|
5547
|
+
null,
|
|
5548
|
+
['PureCloud OAuth'],
|
|
5549
|
+
['application/json'],
|
|
5550
|
+
['application/json']
|
|
5551
|
+
);
|
|
5552
|
+
}
|
|
5553
|
+
|
|
5505
5554
|
/**
|
|
5506
5555
|
* Create a flow milestone
|
|
5507
5556
|
*
|
|
@@ -5932,7 +5981,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5932
5981
|
/**
|
|
5933
5982
|
* Audit service.
|
|
5934
5983
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5935
|
-
* @version
|
|
5984
|
+
* @version 136.1.0
|
|
5936
5985
|
*/
|
|
5937
5986
|
|
|
5938
5987
|
/**
|
|
@@ -6103,7 +6152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6103
6152
|
/**
|
|
6104
6153
|
* Authorization service.
|
|
6105
6154
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6106
|
-
* @version
|
|
6155
|
+
* @version 136.1.0
|
|
6107
6156
|
*/
|
|
6108
6157
|
|
|
6109
6158
|
/**
|
|
@@ -7286,7 +7335,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7286
7335
|
/**
|
|
7287
7336
|
* Billing service.
|
|
7288
7337
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7289
|
-
* @version
|
|
7338
|
+
* @version 136.1.0
|
|
7290
7339
|
*/
|
|
7291
7340
|
|
|
7292
7341
|
/**
|
|
@@ -7366,7 +7415,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7366
7415
|
/**
|
|
7367
7416
|
* Chat service.
|
|
7368
7417
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7369
|
-
* @version
|
|
7418
|
+
* @version 136.1.0
|
|
7370
7419
|
*/
|
|
7371
7420
|
|
|
7372
7421
|
/**
|
|
@@ -7457,7 +7506,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7457
7506
|
/**
|
|
7458
7507
|
* Coaching service.
|
|
7459
7508
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7460
|
-
* @version
|
|
7509
|
+
* @version 136.1.0
|
|
7461
7510
|
*/
|
|
7462
7511
|
|
|
7463
7512
|
/**
|
|
@@ -8034,7 +8083,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8034
8083
|
/**
|
|
8035
8084
|
* ContentManagement service.
|
|
8036
8085
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8037
|
-
* @version
|
|
8086
|
+
* @version 136.1.0
|
|
8038
8087
|
*/
|
|
8039
8088
|
|
|
8040
8089
|
/**
|
|
@@ -9174,7 +9223,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9174
9223
|
/**
|
|
9175
9224
|
* Conversations service.
|
|
9176
9225
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9177
|
-
* @version
|
|
9226
|
+
* @version 136.1.0
|
|
9178
9227
|
*/
|
|
9179
9228
|
|
|
9180
9229
|
/**
|
|
@@ -11079,7 +11128,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11079
11128
|
/**
|
|
11080
11129
|
* Get a list of Messaging Stickers
|
|
11081
11130
|
*
|
|
11082
|
-
* @param {
|
|
11131
|
+
* @param {Object} messengerType Messenger Type
|
|
11083
11132
|
* @param {Object} opts Optional parameters
|
|
11084
11133
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11085
11134
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -11267,7 +11316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11267
11316
|
}
|
|
11268
11317
|
|
|
11269
11318
|
/**
|
|
11270
|
-
* Update a conversation by setting
|
|
11319
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
11271
11320
|
*
|
|
11272
11321
|
* @param {String} conversationId conversationId
|
|
11273
11322
|
* @param {Object} body Conversation
|
|
@@ -12253,8 +12302,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12253
12302
|
}
|
|
12254
12303
|
|
|
12255
12304
|
/**
|
|
12256
|
-
* Update or activate a WhatsApp messaging integration
|
|
12257
|
-
* The following steps are required in order to fully activate a
|
|
12305
|
+
* Update or activate a WhatsApp messaging integration
|
|
12306
|
+
* 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.
|
|
12258
12307
|
* @param {String} integrationId Integration ID
|
|
12259
12308
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
12260
12309
|
*/
|
|
@@ -13838,7 +13887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13838
13887
|
/**
|
|
13839
13888
|
* DataExtensions service.
|
|
13840
13889
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13841
|
-
* @version
|
|
13890
|
+
* @version 136.1.0
|
|
13842
13891
|
*/
|
|
13843
13892
|
|
|
13844
13893
|
/**
|
|
@@ -13924,7 +13973,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13924
13973
|
/**
|
|
13925
13974
|
* ExternalContacts service.
|
|
13926
13975
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13927
|
-
* @version
|
|
13976
|
+
* @version 136.1.0
|
|
13928
13977
|
*/
|
|
13929
13978
|
|
|
13930
13979
|
/**
|
|
@@ -15667,7 +15716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15667
15716
|
/**
|
|
15668
15717
|
* Fax service.
|
|
15669
15718
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15670
|
-
* @version
|
|
15719
|
+
* @version 136.1.0
|
|
15671
15720
|
*/
|
|
15672
15721
|
|
|
15673
15722
|
/**
|
|
@@ -15838,7 +15887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15838
15887
|
/**
|
|
15839
15888
|
* Flows service.
|
|
15840
15889
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15841
|
-
* @version
|
|
15890
|
+
* @version 136.1.0
|
|
15842
15891
|
*/
|
|
15843
15892
|
|
|
15844
15893
|
/**
|
|
@@ -15909,7 +15958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15909
15958
|
/**
|
|
15910
15959
|
* Gamification service.
|
|
15911
15960
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15912
|
-
* @version
|
|
15961
|
+
* @version 136.1.0
|
|
15913
15962
|
*/
|
|
15914
15963
|
|
|
15915
15964
|
/**
|
|
@@ -16155,18 +16204,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16155
16204
|
/**
|
|
16156
16205
|
* Performance profile by id
|
|
16157
16206
|
*
|
|
16158
|
-
* @param {String} performanceProfileId
|
|
16207
|
+
* @param {String} profileId performanceProfileId
|
|
16159
16208
|
*/
|
|
16160
|
-
getGamificationProfile(
|
|
16161
|
-
// verify the required parameter '
|
|
16162
|
-
if (
|
|
16163
|
-
throw 'Missing the required parameter "
|
|
16209
|
+
getGamificationProfile(profileId) {
|
|
16210
|
+
// verify the required parameter 'profileId' is set
|
|
16211
|
+
if (profileId === undefined || profileId === null) {
|
|
16212
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
16164
16213
|
}
|
|
16165
16214
|
|
|
16166
16215
|
return this.apiClient.callApi(
|
|
16167
|
-
'/api/v2/gamification/profiles/{
|
|
16216
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
16168
16217
|
'GET',
|
|
16169
|
-
{ '
|
|
16218
|
+
{ 'profileId': profileId },
|
|
16170
16219
|
{ },
|
|
16171
16220
|
{ },
|
|
16172
16221
|
{ },
|
|
@@ -17009,18 +17058,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17009
17058
|
/**
|
|
17010
17059
|
* Activate a performance profile
|
|
17011
17060
|
*
|
|
17012
|
-
* @param {String} performanceProfileId
|
|
17061
|
+
* @param {String} profileId performanceProfileId
|
|
17013
17062
|
*/
|
|
17014
|
-
postGamificationProfileActivate(
|
|
17015
|
-
// verify the required parameter '
|
|
17016
|
-
if (
|
|
17017
|
-
throw 'Missing the required parameter "
|
|
17063
|
+
postGamificationProfileActivate(profileId) {
|
|
17064
|
+
// verify the required parameter 'profileId' is set
|
|
17065
|
+
if (profileId === undefined || profileId === null) {
|
|
17066
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
17018
17067
|
}
|
|
17019
17068
|
|
|
17020
17069
|
return this.apiClient.callApi(
|
|
17021
|
-
'/api/v2/gamification/profiles/{
|
|
17070
|
+
'/api/v2/gamification/profiles/{profileId}/activate',
|
|
17022
17071
|
'POST',
|
|
17023
|
-
{ '
|
|
17072
|
+
{ 'profileId': profileId },
|
|
17024
17073
|
{ },
|
|
17025
17074
|
{ },
|
|
17026
17075
|
{ },
|
|
@@ -17034,18 +17083,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17034
17083
|
/**
|
|
17035
17084
|
* Deactivate a performance profile
|
|
17036
17085
|
*
|
|
17037
|
-
* @param {String} performanceProfileId
|
|
17086
|
+
* @param {String} profileId performanceProfileId
|
|
17038
17087
|
*/
|
|
17039
|
-
postGamificationProfileDeactivate(
|
|
17040
|
-
// verify the required parameter '
|
|
17041
|
-
if (
|
|
17042
|
-
throw 'Missing the required parameter "
|
|
17088
|
+
postGamificationProfileDeactivate(profileId) {
|
|
17089
|
+
// verify the required parameter 'profileId' is set
|
|
17090
|
+
if (profileId === undefined || profileId === null) {
|
|
17091
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
17043
17092
|
}
|
|
17044
17093
|
|
|
17045
17094
|
return this.apiClient.callApi(
|
|
17046
|
-
'/api/v2/gamification/profiles/{
|
|
17095
|
+
'/api/v2/gamification/profiles/{profileId}/deactivate',
|
|
17047
17096
|
'POST',
|
|
17048
|
-
{ '
|
|
17097
|
+
{ 'profileId': profileId },
|
|
17049
17098
|
{ },
|
|
17050
17099
|
{ },
|
|
17051
17100
|
{ },
|
|
@@ -17247,22 +17296,22 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17247
17296
|
/**
|
|
17248
17297
|
* Updates a performance profile
|
|
17249
17298
|
*
|
|
17250
|
-
* @param {String} performanceProfileId
|
|
17299
|
+
* @param {String} profileId performanceProfileId
|
|
17251
17300
|
* @param {Object} opts Optional parameters
|
|
17252
17301
|
* @param {Object} opts.body performanceProfile
|
|
17253
17302
|
*/
|
|
17254
|
-
putGamificationProfile(
|
|
17303
|
+
putGamificationProfile(profileId, opts) {
|
|
17255
17304
|
opts = opts || {};
|
|
17256
17305
|
|
|
17257
|
-
// verify the required parameter '
|
|
17258
|
-
if (
|
|
17259
|
-
throw 'Missing the required parameter "
|
|
17306
|
+
// verify the required parameter 'profileId' is set
|
|
17307
|
+
if (profileId === undefined || profileId === null) {
|
|
17308
|
+
throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
|
|
17260
17309
|
}
|
|
17261
17310
|
|
|
17262
17311
|
return this.apiClient.callApi(
|
|
17263
|
-
'/api/v2/gamification/profiles/{
|
|
17312
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
17264
17313
|
'PUT',
|
|
17265
|
-
{ '
|
|
17314
|
+
{ 'profileId': profileId },
|
|
17266
17315
|
{ },
|
|
17267
17316
|
{ },
|
|
17268
17317
|
{ },
|
|
@@ -17339,7 +17388,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17339
17388
|
/**
|
|
17340
17389
|
* GeneralDataProtectionRegulation service.
|
|
17341
17390
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17342
|
-
* @version
|
|
17391
|
+
* @version 136.1.0
|
|
17343
17392
|
*/
|
|
17344
17393
|
|
|
17345
17394
|
/**
|
|
@@ -17469,7 +17518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17469
17518
|
/**
|
|
17470
17519
|
* Geolocation service.
|
|
17471
17520
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17472
|
-
* @version
|
|
17521
|
+
* @version 136.1.0
|
|
17473
17522
|
*/
|
|
17474
17523
|
|
|
17475
17524
|
/**
|
|
@@ -17600,7 +17649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17600
17649
|
/**
|
|
17601
17650
|
* Greetings service.
|
|
17602
17651
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17603
|
-
* @version
|
|
17652
|
+
* @version 136.1.0
|
|
17604
17653
|
*/
|
|
17605
17654
|
|
|
17606
17655
|
/**
|
|
@@ -18055,7 +18104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18055
18104
|
/**
|
|
18056
18105
|
* Groups service.
|
|
18057
18106
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18058
|
-
* @version
|
|
18107
|
+
* @version 136.1.0
|
|
18059
18108
|
*/
|
|
18060
18109
|
|
|
18061
18110
|
/**
|
|
@@ -18460,7 +18509,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18460
18509
|
/**
|
|
18461
18510
|
* IdentityProvider service.
|
|
18462
18511
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18463
|
-
* @version
|
|
18512
|
+
* @version 136.1.0
|
|
18464
18513
|
*/
|
|
18465
18514
|
|
|
18466
18515
|
/**
|
|
@@ -19216,7 +19265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19216
19265
|
/**
|
|
19217
19266
|
* Integrations service.
|
|
19218
19267
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19219
|
-
* @version
|
|
19268
|
+
* @version 136.1.0
|
|
19220
19269
|
*/
|
|
19221
19270
|
|
|
19222
19271
|
/**
|
|
@@ -19634,9 +19683,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19634
19683
|
* @param {String} opts.previousPage Previous page token
|
|
19635
19684
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
19636
19685
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
19637
|
-
* @param {String} opts.category Filter by category name
|
|
19638
|
-
* @param {String} opts.name Filter by
|
|
19639
|
-
* @param {
|
|
19686
|
+
* @param {String} opts.category Filter by category name.
|
|
19687
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
19688
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
19689
|
+
* @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.
|
|
19640
19690
|
* @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)
|
|
19641
19691
|
*/
|
|
19642
19692
|
getIntegrationsActions(opts) {
|
|
@@ -19647,7 +19697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19647
19697
|
'/api/v2/integrations/actions',
|
|
19648
19698
|
'GET',
|
|
19649
19699
|
{ },
|
|
19650
|
-
{ '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'] },
|
|
19700
|
+
{ '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'] },
|
|
19651
19701
|
{ },
|
|
19652
19702
|
{ },
|
|
19653
19703
|
null,
|
|
@@ -19697,9 +19747,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19697
19747
|
* @param {String} opts.previousPage Previous page token
|
|
19698
19748
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
19699
19749
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
19700
|
-
* @param {String} opts.category Filter by category name
|
|
19701
|
-
* @param {String} opts.name Filter by
|
|
19702
|
-
* @param {
|
|
19750
|
+
* @param {String} opts.category Filter by category name.
|
|
19751
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
19752
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
19753
|
+
* @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.
|
|
19703
19754
|
* @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)
|
|
19704
19755
|
*/
|
|
19705
19756
|
getIntegrationsActionsDrafts(opts) {
|
|
@@ -19710,7 +19761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19710
19761
|
'/api/v2/integrations/actions/drafts',
|
|
19711
19762
|
'GET',
|
|
19712
19763
|
{ },
|
|
19713
|
-
{ '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'] },
|
|
19764
|
+
{ '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'] },
|
|
19714
19765
|
{ },
|
|
19715
19766
|
{ },
|
|
19716
19767
|
null,
|
|
@@ -20891,7 +20942,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20891
20942
|
/**
|
|
20892
20943
|
* Journey service.
|
|
20893
20944
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20894
|
-
* @version
|
|
20945
|
+
* @version 136.1.0
|
|
20895
20946
|
*/
|
|
20896
20947
|
|
|
20897
20948
|
/**
|
|
@@ -21602,7 +21653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21602
21653
|
/**
|
|
21603
21654
|
* Knowledge service.
|
|
21604
21655
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21605
|
-
* @version
|
|
21656
|
+
* @version 136.1.0
|
|
21606
21657
|
*/
|
|
21607
21658
|
|
|
21608
21659
|
/**
|
|
@@ -22502,7 +22553,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22502
22553
|
/**
|
|
22503
22554
|
* LanguageUnderstanding service.
|
|
22504
22555
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22505
|
-
* @version
|
|
22556
|
+
* @version 136.1.0
|
|
22506
22557
|
*/
|
|
22507
22558
|
|
|
22508
22559
|
/**
|
|
@@ -23406,7 +23457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23406
23457
|
/**
|
|
23407
23458
|
* Languages service.
|
|
23408
23459
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23409
|
-
* @version
|
|
23460
|
+
* @version 136.1.0
|
|
23410
23461
|
*/
|
|
23411
23462
|
|
|
23412
23463
|
/**
|
|
@@ -23674,7 +23725,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23674
23725
|
/**
|
|
23675
23726
|
* Learning service.
|
|
23676
23727
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23677
|
-
* @version
|
|
23728
|
+
* @version 136.1.0
|
|
23678
23729
|
*/
|
|
23679
23730
|
|
|
23680
23731
|
/**
|
|
@@ -24265,7 +24316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24265
24316
|
/**
|
|
24266
24317
|
* License service.
|
|
24267
24318
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24268
|
-
* @version
|
|
24319
|
+
* @version 136.1.0
|
|
24269
24320
|
*/
|
|
24270
24321
|
|
|
24271
24322
|
/**
|
|
@@ -24503,7 +24554,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24503
24554
|
/**
|
|
24504
24555
|
* Locations service.
|
|
24505
24556
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24506
|
-
* @version
|
|
24557
|
+
* @version 136.1.0
|
|
24507
24558
|
*/
|
|
24508
24559
|
|
|
24509
24560
|
/**
|
|
@@ -24739,7 +24790,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24739
24790
|
/**
|
|
24740
24791
|
* Messaging service.
|
|
24741
24792
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24742
|
-
* @version
|
|
24793
|
+
* @version 136.1.0
|
|
24743
24794
|
*/
|
|
24744
24795
|
|
|
24745
24796
|
/**
|
|
@@ -24890,7 +24941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24890
24941
|
/**
|
|
24891
24942
|
* MobileDevices service.
|
|
24892
24943
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24893
|
-
* @version
|
|
24944
|
+
* @version 136.1.0
|
|
24894
24945
|
*/
|
|
24895
24946
|
|
|
24896
24947
|
/**
|
|
@@ -25041,7 +25092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25041
25092
|
/**
|
|
25042
25093
|
* Notifications service.
|
|
25043
25094
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25044
|
-
* @version
|
|
25095
|
+
* @version 136.1.0
|
|
25045
25096
|
*/
|
|
25046
25097
|
|
|
25047
25098
|
/**
|
|
@@ -25266,7 +25317,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25266
25317
|
/**
|
|
25267
25318
|
* OAuth service.
|
|
25268
25319
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25269
|
-
* @version
|
|
25320
|
+
* @version 136.1.0
|
|
25270
25321
|
*/
|
|
25271
25322
|
|
|
25272
25323
|
/**
|
|
@@ -25632,7 +25683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25632
25683
|
/**
|
|
25633
25684
|
* Objects service.
|
|
25634
25685
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25635
|
-
* @version
|
|
25686
|
+
* @version 136.1.0
|
|
25636
25687
|
*/
|
|
25637
25688
|
|
|
25638
25689
|
/**
|
|
@@ -25903,7 +25954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25903
25954
|
/**
|
|
25904
25955
|
* Organization service.
|
|
25905
25956
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25906
|
-
* @version
|
|
25957
|
+
* @version 136.1.0
|
|
25907
25958
|
*/
|
|
25908
25959
|
|
|
25909
25960
|
/**
|
|
@@ -26306,7 +26357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26306
26357
|
/**
|
|
26307
26358
|
* OrganizationAuthorization service.
|
|
26308
26359
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26309
|
-
* @version
|
|
26360
|
+
* @version 136.1.0
|
|
26310
26361
|
*/
|
|
26311
26362
|
|
|
26312
26363
|
/**
|
|
@@ -27231,7 +27282,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27231
27282
|
/**
|
|
27232
27283
|
* Outbound service.
|
|
27233
27284
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27234
|
-
* @version
|
|
27285
|
+
* @version 136.1.0
|
|
27235
27286
|
*/
|
|
27236
27287
|
|
|
27237
27288
|
/**
|
|
@@ -27581,6 +27632,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27581
27632
|
);
|
|
27582
27633
|
}
|
|
27583
27634
|
|
|
27635
|
+
/**
|
|
27636
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
27637
|
+
*
|
|
27638
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
27639
|
+
*/
|
|
27640
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
27641
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
27642
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
27643
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
27644
|
+
}
|
|
27645
|
+
|
|
27646
|
+
return this.apiClient.callApi(
|
|
27647
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
27648
|
+
'DELETE',
|
|
27649
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
27650
|
+
{ },
|
|
27651
|
+
{ },
|
|
27652
|
+
{ },
|
|
27653
|
+
null,
|
|
27654
|
+
['PureCloud OAuth'],
|
|
27655
|
+
['application/json'],
|
|
27656
|
+
['application/json']
|
|
27657
|
+
);
|
|
27658
|
+
}
|
|
27659
|
+
|
|
27584
27660
|
/**
|
|
27585
27661
|
* Delete a Rule Set.
|
|
27586
27662
|
*
|
|
@@ -27631,6 +27707,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27631
27707
|
);
|
|
27632
27708
|
}
|
|
27633
27709
|
|
|
27710
|
+
/**
|
|
27711
|
+
* Delete an email campaign schedule.
|
|
27712
|
+
*
|
|
27713
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
27714
|
+
*/
|
|
27715
|
+
deleteOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
27716
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
27717
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
27718
|
+
throw 'Missing the required parameter "emailCampaignId" when calling deleteOutboundSchedulesEmailcampaign';
|
|
27719
|
+
}
|
|
27720
|
+
|
|
27721
|
+
return this.apiClient.callApi(
|
|
27722
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
27723
|
+
'DELETE',
|
|
27724
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
27725
|
+
{ },
|
|
27726
|
+
{ },
|
|
27727
|
+
{ },
|
|
27728
|
+
null,
|
|
27729
|
+
['PureCloud OAuth'],
|
|
27730
|
+
['application/json'],
|
|
27731
|
+
['application/json']
|
|
27732
|
+
);
|
|
27733
|
+
}
|
|
27734
|
+
|
|
27735
|
+
/**
|
|
27736
|
+
* Delete a messaging campaign schedule.
|
|
27737
|
+
*
|
|
27738
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
27739
|
+
*/
|
|
27740
|
+
deleteOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
27741
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
27742
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
27743
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundSchedulesMessagingcampaign';
|
|
27744
|
+
}
|
|
27745
|
+
|
|
27746
|
+
return this.apiClient.callApi(
|
|
27747
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
27748
|
+
'DELETE',
|
|
27749
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
27750
|
+
{ },
|
|
27751
|
+
{ },
|
|
27752
|
+
{ },
|
|
27753
|
+
null,
|
|
27754
|
+
['PureCloud OAuth'],
|
|
27755
|
+
['application/json'],
|
|
27756
|
+
['application/json']
|
|
27757
|
+
);
|
|
27758
|
+
}
|
|
27759
|
+
|
|
27634
27760
|
/**
|
|
27635
27761
|
* Delete a dialer sequence schedule.
|
|
27636
27762
|
*
|
|
@@ -28967,6 +29093,96 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28967
29093
|
);
|
|
28968
29094
|
}
|
|
28969
29095
|
|
|
29096
|
+
/**
|
|
29097
|
+
* Get an email campaign schedule.
|
|
29098
|
+
*
|
|
29099
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
29100
|
+
*/
|
|
29101
|
+
getOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
29102
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
29103
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
29104
|
+
throw 'Missing the required parameter "emailCampaignId" when calling getOutboundSchedulesEmailcampaign';
|
|
29105
|
+
}
|
|
29106
|
+
|
|
29107
|
+
return this.apiClient.callApi(
|
|
29108
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
29109
|
+
'GET',
|
|
29110
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
29111
|
+
{ },
|
|
29112
|
+
{ },
|
|
29113
|
+
{ },
|
|
29114
|
+
null,
|
|
29115
|
+
['PureCloud OAuth'],
|
|
29116
|
+
['application/json'],
|
|
29117
|
+
['application/json']
|
|
29118
|
+
);
|
|
29119
|
+
}
|
|
29120
|
+
|
|
29121
|
+
/**
|
|
29122
|
+
* Query for a list of email campaign schedules.
|
|
29123
|
+
*
|
|
29124
|
+
*/
|
|
29125
|
+
getOutboundSchedulesEmailcampaigns() {
|
|
29126
|
+
|
|
29127
|
+
return this.apiClient.callApi(
|
|
29128
|
+
'/api/v2/outbound/schedules/emailcampaigns',
|
|
29129
|
+
'GET',
|
|
29130
|
+
{ },
|
|
29131
|
+
{ },
|
|
29132
|
+
{ },
|
|
29133
|
+
{ },
|
|
29134
|
+
null,
|
|
29135
|
+
['PureCloud OAuth'],
|
|
29136
|
+
['application/json'],
|
|
29137
|
+
['application/json']
|
|
29138
|
+
);
|
|
29139
|
+
}
|
|
29140
|
+
|
|
29141
|
+
/**
|
|
29142
|
+
* Get a messaging campaign schedule.
|
|
29143
|
+
*
|
|
29144
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
29145
|
+
*/
|
|
29146
|
+
getOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
29147
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
29148
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
29149
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundSchedulesMessagingcampaign';
|
|
29150
|
+
}
|
|
29151
|
+
|
|
29152
|
+
return this.apiClient.callApi(
|
|
29153
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
29154
|
+
'GET',
|
|
29155
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
29156
|
+
{ },
|
|
29157
|
+
{ },
|
|
29158
|
+
{ },
|
|
29159
|
+
null,
|
|
29160
|
+
['PureCloud OAuth'],
|
|
29161
|
+
['application/json'],
|
|
29162
|
+
['application/json']
|
|
29163
|
+
);
|
|
29164
|
+
}
|
|
29165
|
+
|
|
29166
|
+
/**
|
|
29167
|
+
* Query for a list of messaging campaign schedules.
|
|
29168
|
+
*
|
|
29169
|
+
*/
|
|
29170
|
+
getOutboundSchedulesMessagingcampaigns() {
|
|
29171
|
+
|
|
29172
|
+
return this.apiClient.callApi(
|
|
29173
|
+
'/api/v2/outbound/schedules/messagingcampaigns',
|
|
29174
|
+
'GET',
|
|
29175
|
+
{ },
|
|
29176
|
+
{ },
|
|
29177
|
+
{ },
|
|
29178
|
+
{ },
|
|
29179
|
+
null,
|
|
29180
|
+
['PureCloud OAuth'],
|
|
29181
|
+
['application/json'],
|
|
29182
|
+
['application/json']
|
|
29183
|
+
);
|
|
29184
|
+
}
|
|
29185
|
+
|
|
28970
29186
|
/**
|
|
28971
29187
|
* Get a dialer sequence schedule.
|
|
28972
29188
|
*
|
|
@@ -30170,6 +30386,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30170
30386
|
);
|
|
30171
30387
|
}
|
|
30172
30388
|
|
|
30389
|
+
/**
|
|
30390
|
+
* Update an email campaign schedule.
|
|
30391
|
+
*
|
|
30392
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
30393
|
+
* @param {Object} body EmailCampaignSchedule
|
|
30394
|
+
*/
|
|
30395
|
+
putOutboundSchedulesEmailcampaign(emailCampaignId, body) {
|
|
30396
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
30397
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
30398
|
+
throw 'Missing the required parameter "emailCampaignId" when calling putOutboundSchedulesEmailcampaign';
|
|
30399
|
+
}
|
|
30400
|
+
// verify the required parameter 'body' is set
|
|
30401
|
+
if (body === undefined || body === null) {
|
|
30402
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesEmailcampaign';
|
|
30403
|
+
}
|
|
30404
|
+
|
|
30405
|
+
return this.apiClient.callApi(
|
|
30406
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
30407
|
+
'PUT',
|
|
30408
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
30409
|
+
{ },
|
|
30410
|
+
{ },
|
|
30411
|
+
{ },
|
|
30412
|
+
body,
|
|
30413
|
+
['PureCloud OAuth'],
|
|
30414
|
+
['application/json'],
|
|
30415
|
+
['application/json']
|
|
30416
|
+
);
|
|
30417
|
+
}
|
|
30418
|
+
|
|
30419
|
+
/**
|
|
30420
|
+
* Update a new messaging campaign schedule.
|
|
30421
|
+
*
|
|
30422
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
30423
|
+
* @param {Object} body MessagingCampaignSchedule
|
|
30424
|
+
*/
|
|
30425
|
+
putOutboundSchedulesMessagingcampaign(messagingCampaignId, body) {
|
|
30426
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
30427
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
30428
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling putOutboundSchedulesMessagingcampaign';
|
|
30429
|
+
}
|
|
30430
|
+
// verify the required parameter 'body' is set
|
|
30431
|
+
if (body === undefined || body === null) {
|
|
30432
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesMessagingcampaign';
|
|
30433
|
+
}
|
|
30434
|
+
|
|
30435
|
+
return this.apiClient.callApi(
|
|
30436
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
30437
|
+
'PUT',
|
|
30438
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
30439
|
+
{ },
|
|
30440
|
+
{ },
|
|
30441
|
+
{ },
|
|
30442
|
+
body,
|
|
30443
|
+
['PureCloud OAuth'],
|
|
30444
|
+
['application/json'],
|
|
30445
|
+
['application/json']
|
|
30446
|
+
);
|
|
30447
|
+
}
|
|
30448
|
+
|
|
30173
30449
|
/**
|
|
30174
30450
|
* Update a new sequence schedule.
|
|
30175
30451
|
*
|
|
@@ -30261,7 +30537,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30261
30537
|
/**
|
|
30262
30538
|
* Presence service.
|
|
30263
30539
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30264
|
-
* @version
|
|
30540
|
+
* @version 136.1.0
|
|
30265
30541
|
*/
|
|
30266
30542
|
|
|
30267
30543
|
/**
|
|
@@ -30407,31 +30683,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30407
30683
|
);
|
|
30408
30684
|
}
|
|
30409
30685
|
|
|
30410
|
-
/**
|
|
30411
|
-
* Get a user's Microsoft Teams presence.
|
|
30412
|
-
* 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.
|
|
30413
|
-
* @param {String} userId user Id
|
|
30414
|
-
*/
|
|
30415
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
30416
|
-
// verify the required parameter 'userId' is set
|
|
30417
|
-
if (userId === undefined || userId === null) {
|
|
30418
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
30419
|
-
}
|
|
30420
|
-
|
|
30421
|
-
return this.apiClient.callApi(
|
|
30422
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
30423
|
-
'GET',
|
|
30424
|
-
{ 'userId': userId },
|
|
30425
|
-
{ },
|
|
30426
|
-
{ },
|
|
30427
|
-
{ },
|
|
30428
|
-
null,
|
|
30429
|
-
['PureCloud OAuth'],
|
|
30430
|
-
['application/json'],
|
|
30431
|
-
['application/json']
|
|
30432
|
-
);
|
|
30433
|
-
}
|
|
30434
|
-
|
|
30435
30686
|
/**
|
|
30436
30687
|
* Get a user's Genesys Cloud presence.
|
|
30437
30688
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -30457,31 +30708,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30457
30708
|
);
|
|
30458
30709
|
}
|
|
30459
30710
|
|
|
30460
|
-
/**
|
|
30461
|
-
* Get a user's Zoom Phone presence.
|
|
30462
|
-
* 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.
|
|
30463
|
-
* @param {String} userId user Id
|
|
30464
|
-
*/
|
|
30465
|
-
getUserPresencesZoomphone(userId) {
|
|
30466
|
-
// verify the required parameter 'userId' is set
|
|
30467
|
-
if (userId === undefined || userId === null) {
|
|
30468
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
30469
|
-
}
|
|
30470
|
-
|
|
30471
|
-
return this.apiClient.callApi(
|
|
30472
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
30473
|
-
'GET',
|
|
30474
|
-
{ 'userId': userId },
|
|
30475
|
-
{ },
|
|
30476
|
-
{ },
|
|
30477
|
-
{ },
|
|
30478
|
-
null,
|
|
30479
|
-
['PureCloud OAuth'],
|
|
30480
|
-
['application/json'],
|
|
30481
|
-
['application/json']
|
|
30482
|
-
);
|
|
30483
|
-
}
|
|
30484
|
-
|
|
30485
30711
|
/**
|
|
30486
30712
|
* Patch a user's Presence
|
|
30487
30713
|
* 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.
|
|
@@ -30633,7 +30859,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30633
30859
|
/**
|
|
30634
30860
|
* Quality service.
|
|
30635
30861
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30636
|
-
* @version
|
|
30862
|
+
* @version 136.1.0
|
|
30637
30863
|
*/
|
|
30638
30864
|
|
|
30639
30865
|
/**
|
|
@@ -32211,7 +32437,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32211
32437
|
/**
|
|
32212
32438
|
* Recording service.
|
|
32213
32439
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32214
|
-
* @version
|
|
32440
|
+
* @version 136.1.0
|
|
32215
32441
|
*/
|
|
32216
32442
|
|
|
32217
32443
|
/**
|
|
@@ -32734,6 +32960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32734
32960
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32735
32961
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32736
32962
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32963
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32737
32964
|
*/
|
|
32738
32965
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
32739
32966
|
opts = opts || {};
|
|
@@ -32743,7 +32970,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32743
32970
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
32744
32971
|
'GET',
|
|
32745
32972
|
{ },
|
|
32746
|
-
{ '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'] },
|
|
32973
|
+
{ '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'] },
|
|
32747
32974
|
{ },
|
|
32748
32975
|
{ },
|
|
32749
32976
|
null,
|
|
@@ -32866,6 +33093,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32866
33093
|
);
|
|
32867
33094
|
}
|
|
32868
33095
|
|
|
33096
|
+
/**
|
|
33097
|
+
* Get the encryption key configurations
|
|
33098
|
+
*
|
|
33099
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
33100
|
+
*/
|
|
33101
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
33102
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
33103
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
33104
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
33105
|
+
}
|
|
33106
|
+
|
|
33107
|
+
return this.apiClient.callApi(
|
|
33108
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
33109
|
+
'GET',
|
|
33110
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
33111
|
+
{ },
|
|
33112
|
+
{ },
|
|
33113
|
+
{ },
|
|
33114
|
+
null,
|
|
33115
|
+
['PureCloud OAuth'],
|
|
33116
|
+
['application/json'],
|
|
33117
|
+
['application/json']
|
|
33118
|
+
);
|
|
33119
|
+
}
|
|
33120
|
+
|
|
33121
|
+
/**
|
|
33122
|
+
* Get a list of key configurations data
|
|
33123
|
+
*
|
|
33124
|
+
*/
|
|
33125
|
+
getRecordingKeyconfigurations() {
|
|
33126
|
+
|
|
33127
|
+
return this.apiClient.callApi(
|
|
33128
|
+
'/api/v2/recording/keyconfigurations',
|
|
33129
|
+
'GET',
|
|
33130
|
+
{ },
|
|
33131
|
+
{ },
|
|
33132
|
+
{ },
|
|
33133
|
+
{ },
|
|
33134
|
+
null,
|
|
33135
|
+
['PureCloud OAuth'],
|
|
33136
|
+
['application/json'],
|
|
33137
|
+
['application/json']
|
|
33138
|
+
);
|
|
33139
|
+
}
|
|
33140
|
+
|
|
32869
33141
|
/**
|
|
32870
33142
|
* Get the local encryption settings
|
|
32871
33143
|
*
|
|
@@ -32925,6 +33197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32925
33197
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32926
33198
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32927
33199
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
33200
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32928
33201
|
*/
|
|
32929
33202
|
getRecordingMediaretentionpolicies(opts) {
|
|
32930
33203
|
opts = opts || {};
|
|
@@ -32934,7 +33207,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32934
33207
|
'/api/v2/recording/mediaretentionpolicies',
|
|
32935
33208
|
'GET',
|
|
32936
33209
|
{ },
|
|
32937
|
-
{ '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'] },
|
|
33210
|
+
{ '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'] },
|
|
32938
33211
|
{ },
|
|
32939
33212
|
{ },
|
|
32940
33213
|
null,
|
|
@@ -33238,8 +33511,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33238
33511
|
}
|
|
33239
33512
|
|
|
33240
33513
|
/**
|
|
33241
|
-
* Create a recording bulk job
|
|
33242
|
-
*
|
|
33514
|
+
* Create a recording bulk job.
|
|
33515
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
33243
33516
|
* @param {Object} body query
|
|
33244
33517
|
*/
|
|
33245
33518
|
postRecordingJobs(body) {
|
|
@@ -33262,6 +33535,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33262
33535
|
);
|
|
33263
33536
|
}
|
|
33264
33537
|
|
|
33538
|
+
/**
|
|
33539
|
+
* Setup configurations for encryption key creation
|
|
33540
|
+
*
|
|
33541
|
+
* @param {Object} body Encryption Configuration
|
|
33542
|
+
*/
|
|
33543
|
+
postRecordingKeyconfigurations(body) {
|
|
33544
|
+
// verify the required parameter 'body' is set
|
|
33545
|
+
if (body === undefined || body === null) {
|
|
33546
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
33547
|
+
}
|
|
33548
|
+
|
|
33549
|
+
return this.apiClient.callApi(
|
|
33550
|
+
'/api/v2/recording/keyconfigurations',
|
|
33551
|
+
'POST',
|
|
33552
|
+
{ },
|
|
33553
|
+
{ },
|
|
33554
|
+
{ },
|
|
33555
|
+
{ },
|
|
33556
|
+
body,
|
|
33557
|
+
['PureCloud OAuth'],
|
|
33558
|
+
['application/json'],
|
|
33559
|
+
['application/json']
|
|
33560
|
+
);
|
|
33561
|
+
}
|
|
33562
|
+
|
|
33563
|
+
/**
|
|
33564
|
+
* Validate encryption key configurations without saving it
|
|
33565
|
+
*
|
|
33566
|
+
* @param {Object} body Encryption Configuration
|
|
33567
|
+
*/
|
|
33568
|
+
postRecordingKeyconfigurationsValidate(body) {
|
|
33569
|
+
// verify the required parameter 'body' is set
|
|
33570
|
+
if (body === undefined || body === null) {
|
|
33571
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
33572
|
+
}
|
|
33573
|
+
|
|
33574
|
+
return this.apiClient.callApi(
|
|
33575
|
+
'/api/v2/recording/keyconfigurations/validate',
|
|
33576
|
+
'POST',
|
|
33577
|
+
{ },
|
|
33578
|
+
{ },
|
|
33579
|
+
{ },
|
|
33580
|
+
{ },
|
|
33581
|
+
body,
|
|
33582
|
+
['PureCloud OAuth'],
|
|
33583
|
+
['application/json'],
|
|
33584
|
+
['application/json']
|
|
33585
|
+
);
|
|
33586
|
+
}
|
|
33587
|
+
|
|
33265
33588
|
/**
|
|
33266
33589
|
* create a local recording key
|
|
33267
33590
|
*
|
|
@@ -33596,6 +33919,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33596
33919
|
);
|
|
33597
33920
|
}
|
|
33598
33921
|
|
|
33922
|
+
/**
|
|
33923
|
+
* Update the encryption key configurations
|
|
33924
|
+
*
|
|
33925
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
33926
|
+
* @param {Object} body Encryption key configuration metadata
|
|
33927
|
+
*/
|
|
33928
|
+
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
33929
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
33930
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
33931
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
33932
|
+
}
|
|
33933
|
+
// verify the required parameter 'body' is set
|
|
33934
|
+
if (body === undefined || body === null) {
|
|
33935
|
+
throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
|
|
33936
|
+
}
|
|
33937
|
+
|
|
33938
|
+
return this.apiClient.callApi(
|
|
33939
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
33940
|
+
'PUT',
|
|
33941
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
33942
|
+
{ },
|
|
33943
|
+
{ },
|
|
33944
|
+
{ },
|
|
33945
|
+
body,
|
|
33946
|
+
['PureCloud OAuth'],
|
|
33947
|
+
['application/json'],
|
|
33948
|
+
['application/json']
|
|
33949
|
+
);
|
|
33950
|
+
}
|
|
33951
|
+
|
|
33599
33952
|
/**
|
|
33600
33953
|
* Update the local encryption settings
|
|
33601
33954
|
*
|
|
@@ -33737,7 +34090,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33737
34090
|
/**
|
|
33738
34091
|
* ResponseManagement service.
|
|
33739
34092
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33740
|
-
* @version
|
|
34093
|
+
* @version 136.1.0
|
|
33741
34094
|
*/
|
|
33742
34095
|
|
|
33743
34096
|
/**
|
|
@@ -34221,7 +34574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34221
34574
|
/**
|
|
34222
34575
|
* Routing service.
|
|
34223
34576
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34224
|
-
* @version
|
|
34577
|
+
* @version 136.1.0
|
|
34225
34578
|
*/
|
|
34226
34579
|
|
|
34227
34580
|
/**
|
|
@@ -34880,14 +35233,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34880
35233
|
/**
|
|
34881
35234
|
* Get domains
|
|
34882
35235
|
*
|
|
35236
|
+
* @param {Object} opts Optional parameters
|
|
35237
|
+
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
34883
35238
|
*/
|
|
34884
|
-
getRoutingEmailDomains() {
|
|
35239
|
+
getRoutingEmailDomains(opts) {
|
|
35240
|
+
opts = opts || {};
|
|
35241
|
+
|
|
34885
35242
|
|
|
34886
35243
|
return this.apiClient.callApi(
|
|
34887
35244
|
'/api/v2/routing/email/domains',
|
|
34888
35245
|
'GET',
|
|
34889
35246
|
{ },
|
|
34890
|
-
{
|
|
35247
|
+
{ 'excludeStatus': opts['excludeStatus'] },
|
|
34891
35248
|
{ },
|
|
34892
35249
|
{ },
|
|
34893
35250
|
null,
|
|
@@ -37144,7 +37501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37144
37501
|
/**
|
|
37145
37502
|
* SCIM service.
|
|
37146
37503
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37147
|
-
* @version
|
|
37504
|
+
* @version 136.1.0
|
|
37148
37505
|
*/
|
|
37149
37506
|
|
|
37150
37507
|
/**
|
|
@@ -38021,7 +38378,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38021
38378
|
/**
|
|
38022
38379
|
* Scripts service.
|
|
38023
38380
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38024
|
-
* @version
|
|
38381
|
+
* @version 136.1.0
|
|
38025
38382
|
*/
|
|
38026
38383
|
|
|
38027
38384
|
/**
|
|
@@ -38137,6 +38494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38137
38494
|
* @param {Object} opts.sortBy SortBy
|
|
38138
38495
|
* @param {Object} opts.sortOrder SortOrder
|
|
38139
38496
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38497
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38140
38498
|
*/
|
|
38141
38499
|
getScripts(opts) {
|
|
38142
38500
|
opts = opts || {};
|
|
@@ -38146,7 +38504,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38146
38504
|
'/api/v2/scripts',
|
|
38147
38505
|
'GET',
|
|
38148
38506
|
{ },
|
|
38149
|
-
{ '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'] },
|
|
38507
|
+
{ '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'] },
|
|
38508
|
+
{ },
|
|
38509
|
+
{ },
|
|
38510
|
+
null,
|
|
38511
|
+
['PureCloud OAuth'],
|
|
38512
|
+
['application/json'],
|
|
38513
|
+
['application/json']
|
|
38514
|
+
);
|
|
38515
|
+
}
|
|
38516
|
+
|
|
38517
|
+
/**
|
|
38518
|
+
* Get the metadata for a list of scripts
|
|
38519
|
+
*
|
|
38520
|
+
* @param {Object} opts Optional parameters
|
|
38521
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38522
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38523
|
+
* @param {String} opts.expand Expand
|
|
38524
|
+
* @param {String} opts.name Name filter
|
|
38525
|
+
* @param {String} opts.feature Feature filter
|
|
38526
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38527
|
+
* @param {Object} opts.sortBy SortBy
|
|
38528
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
38529
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38530
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38531
|
+
*/
|
|
38532
|
+
getScriptsDivisionviews(opts) {
|
|
38533
|
+
opts = opts || {};
|
|
38534
|
+
|
|
38535
|
+
|
|
38536
|
+
return this.apiClient.callApi(
|
|
38537
|
+
'/api/v2/scripts/divisionviews',
|
|
38538
|
+
'GET',
|
|
38539
|
+
{ },
|
|
38540
|
+
{ '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'] },
|
|
38150
38541
|
{ },
|
|
38151
38542
|
{ },
|
|
38152
38543
|
null,
|
|
@@ -38167,6 +38558,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38167
38558
|
* @param {String} opts.feature Feature filter
|
|
38168
38559
|
* @param {String} opts.flowId Secure flow id filter
|
|
38169
38560
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38561
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38170
38562
|
*/
|
|
38171
38563
|
getScriptsPublished(opts) {
|
|
38172
38564
|
opts = opts || {};
|
|
@@ -38176,7 +38568,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38176
38568
|
'/api/v2/scripts/published',
|
|
38177
38569
|
'GET',
|
|
38178
38570
|
{ },
|
|
38179
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38571
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38572
|
+
{ },
|
|
38573
|
+
{ },
|
|
38574
|
+
null,
|
|
38575
|
+
['PureCloud OAuth'],
|
|
38576
|
+
['application/json'],
|
|
38577
|
+
['application/json']
|
|
38578
|
+
);
|
|
38579
|
+
}
|
|
38580
|
+
|
|
38581
|
+
/**
|
|
38582
|
+
* Get the published scripts metadata.
|
|
38583
|
+
*
|
|
38584
|
+
* @param {Object} opts Optional parameters
|
|
38585
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38586
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38587
|
+
* @param {String} opts.expand Expand
|
|
38588
|
+
* @param {String} opts.name Name filter
|
|
38589
|
+
* @param {String} opts.feature Feature filter
|
|
38590
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38591
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38592
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38593
|
+
*/
|
|
38594
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
38595
|
+
opts = opts || {};
|
|
38596
|
+
|
|
38597
|
+
|
|
38598
|
+
return this.apiClient.callApi(
|
|
38599
|
+
'/api/v2/scripts/published/divisionviews',
|
|
38600
|
+
'GET',
|
|
38601
|
+
{ },
|
|
38602
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38180
38603
|
{ },
|
|
38181
38604
|
{ },
|
|
38182
38605
|
null,
|
|
@@ -38374,7 +38797,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38374
38797
|
/**
|
|
38375
38798
|
* Search service.
|
|
38376
38799
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38377
|
-
* @version
|
|
38800
|
+
* @version 136.1.0
|
|
38378
38801
|
*/
|
|
38379
38802
|
|
|
38380
38803
|
/**
|
|
@@ -38909,7 +39332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38909
39332
|
/**
|
|
38910
39333
|
* SpeechTextAnalytics service.
|
|
38911
39334
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38912
|
-
* @version
|
|
39335
|
+
* @version 136.1.0
|
|
38913
39336
|
*/
|
|
38914
39337
|
|
|
38915
39338
|
/**
|
|
@@ -39762,7 +40185,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39762
40185
|
/**
|
|
39763
40186
|
* Stations service.
|
|
39764
40187
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
39765
|
-
* @version
|
|
40188
|
+
* @version 136.1.0
|
|
39766
40189
|
*/
|
|
39767
40190
|
|
|
39768
40191
|
/**
|
|
@@ -39909,7 +40332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39909
40332
|
/**
|
|
39910
40333
|
* Suggest service.
|
|
39911
40334
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
39912
|
-
* @version
|
|
40335
|
+
* @version 136.1.0
|
|
39913
40336
|
*/
|
|
39914
40337
|
|
|
39915
40338
|
/**
|
|
@@ -40048,7 +40471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40048
40471
|
/**
|
|
40049
40472
|
* Telephony service.
|
|
40050
40473
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40051
|
-
* @version
|
|
40474
|
+
* @version 136.1.0
|
|
40052
40475
|
*/
|
|
40053
40476
|
|
|
40054
40477
|
/**
|
|
@@ -40156,7 +40579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40156
40579
|
/**
|
|
40157
40580
|
* TelephonyProvidersEdge service.
|
|
40158
40581
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40159
|
-
* @version
|
|
40582
|
+
* @version 136.1.0
|
|
40160
40583
|
*/
|
|
40161
40584
|
|
|
40162
40585
|
/**
|
|
@@ -41571,7 +41994,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41571
41994
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41572
41995
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41573
41996
|
* @param {String} opts.sortBy Sort by
|
|
41574
|
-
* @param {String} opts._number
|
|
41997
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
41575
41998
|
*/
|
|
41576
41999
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
41577
42000
|
opts = opts || {};
|
|
@@ -43789,7 +44212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43789
44212
|
/**
|
|
43790
44213
|
* Textbots service.
|
|
43791
44214
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
43792
|
-
* @version
|
|
44215
|
+
* @version 136.1.0
|
|
43793
44216
|
*/
|
|
43794
44217
|
|
|
43795
44218
|
/**
|
|
@@ -43917,7 +44340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43917
44340
|
/**
|
|
43918
44341
|
* Tokens service.
|
|
43919
44342
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
43920
|
-
* @version
|
|
44343
|
+
* @version 136.1.0
|
|
43921
44344
|
*/
|
|
43922
44345
|
|
|
43923
44346
|
/**
|
|
@@ -44023,7 +44446,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44023
44446
|
/**
|
|
44024
44447
|
* Uploads service.
|
|
44025
44448
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44026
|
-
* @version
|
|
44449
|
+
* @version 136.1.0
|
|
44027
44450
|
*/
|
|
44028
44451
|
|
|
44029
44452
|
/**
|
|
@@ -44174,7 +44597,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44174
44597
|
/**
|
|
44175
44598
|
* Usage service.
|
|
44176
44599
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44177
|
-
* @version
|
|
44600
|
+
* @version 136.1.0
|
|
44178
44601
|
*/
|
|
44179
44602
|
|
|
44180
44603
|
/**
|
|
@@ -44245,7 +44668,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44245
44668
|
/**
|
|
44246
44669
|
* UserRecordings service.
|
|
44247
44670
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44248
|
-
* @version
|
|
44671
|
+
* @version 136.1.0
|
|
44249
44672
|
*/
|
|
44250
44673
|
|
|
44251
44674
|
/**
|
|
@@ -44429,7 +44852,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44429
44852
|
/**
|
|
44430
44853
|
* Users service.
|
|
44431
44854
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44432
|
-
* @version
|
|
44855
|
+
* @version 136.1.0
|
|
44433
44856
|
*/
|
|
44434
44857
|
|
|
44435
44858
|
/**
|
|
@@ -46731,7 +47154,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46731
47154
|
/**
|
|
46732
47155
|
* Utilities service.
|
|
46733
47156
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
46734
|
-
* @version
|
|
47157
|
+
* @version 136.1.0
|
|
46735
47158
|
*/
|
|
46736
47159
|
|
|
46737
47160
|
/**
|
|
@@ -46842,7 +47265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46842
47265
|
/**
|
|
46843
47266
|
* Voicemail service.
|
|
46844
47267
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
46845
|
-
* @version
|
|
47268
|
+
* @version 136.1.0
|
|
46846
47269
|
*/
|
|
46847
47270
|
|
|
46848
47271
|
/**
|
|
@@ -47509,7 +47932,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47509
47932
|
/**
|
|
47510
47933
|
* WebChat service.
|
|
47511
47934
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47512
|
-
* @version
|
|
47935
|
+
* @version 136.1.0
|
|
47513
47936
|
*/
|
|
47514
47937
|
|
|
47515
47938
|
/**
|
|
@@ -48053,7 +48476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48053
48476
|
/**
|
|
48054
48477
|
* WebDeployments service.
|
|
48055
48478
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48056
|
-
* @version
|
|
48479
|
+
* @version 136.1.0
|
|
48057
48480
|
*/
|
|
48058
48481
|
|
|
48059
48482
|
/**
|
|
@@ -48408,7 +48831,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48408
48831
|
/**
|
|
48409
48832
|
* WebMessaging service.
|
|
48410
48833
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48411
|
-
* @version
|
|
48834
|
+
* @version 136.1.0
|
|
48412
48835
|
*/
|
|
48413
48836
|
|
|
48414
48837
|
/**
|
|
@@ -48454,7 +48877,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48454
48877
|
/**
|
|
48455
48878
|
* Widgets service.
|
|
48456
48879
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48457
|
-
* @version
|
|
48880
|
+
* @version 136.1.0
|
|
48458
48881
|
*/
|
|
48459
48882
|
|
|
48460
48883
|
/**
|
|
@@ -48600,7 +49023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48600
49023
|
/**
|
|
48601
49024
|
* WorkforceManagement service.
|
|
48602
49025
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
48603
|
-
* @version
|
|
49026
|
+
* @version 136.1.0
|
|
48604
49027
|
*/
|
|
48605
49028
|
|
|
48606
49029
|
/**
|
|
@@ -48798,7 +49221,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48798
49221
|
/**
|
|
48799
49222
|
* Delete a short term forecast
|
|
48800
49223
|
* Must not be tied to any schedules
|
|
48801
|
-
* @param {String} businessUnitId The
|
|
49224
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
48802
49225
|
* @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
|
|
48803
49226
|
* @param {String} forecastId The ID of the forecast
|
|
48804
49227
|
*/
|
|
@@ -48878,7 +49301,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48878
49301
|
/**
|
|
48879
49302
|
* Deletes a time off limit object
|
|
48880
49303
|
*
|
|
48881
|
-
* @param {String} managementUnitId The
|
|
49304
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
48882
49305
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48883
49306
|
*/
|
|
48884
49307
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -48908,7 +49331,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48908
49331
|
/**
|
|
48909
49332
|
* Deletes a time off plan
|
|
48910
49333
|
*
|
|
48911
|
-
* @param {String} managementUnitId The management unit
|
|
49334
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
48912
49335
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48913
49336
|
*/
|
|
48914
49337
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -49177,7 +49600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49177
49600
|
/**
|
|
49178
49601
|
* Get intraday planning groups for the given date
|
|
49179
49602
|
*
|
|
49180
|
-
* @param {String} businessUnitId The
|
|
49603
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
49181
49604
|
* @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
|
|
49182
49605
|
*/
|
|
49183
49606
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -49630,7 +50053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49630
50053
|
/**
|
|
49631
50054
|
* Get a short term forecast
|
|
49632
50055
|
*
|
|
49633
|
-
* @param {String} businessUnitId The
|
|
50056
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49634
50057
|
* @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
|
|
49635
50058
|
* @param {String} forecastId The ID of the forecast
|
|
49636
50059
|
* @param {Object} opts Optional parameters
|
|
@@ -49669,7 +50092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49669
50092
|
/**
|
|
49670
50093
|
* Get the result of a short term forecast calculation
|
|
49671
50094
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49672
|
-
* @param {String} businessUnitId The
|
|
50095
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49673
50096
|
* @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
|
|
49674
50097
|
* @param {String} forecastId The ID of the forecast
|
|
49675
50098
|
* @param {Object} opts Optional parameters
|
|
@@ -49709,7 +50132,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49709
50132
|
/**
|
|
49710
50133
|
* Gets the forecast generation results
|
|
49711
50134
|
*
|
|
49712
|
-
* @param {String} businessUnitId The
|
|
50135
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49713
50136
|
* @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
|
|
49714
50137
|
* @param {String} forecastId The ID of the forecast
|
|
49715
50138
|
*/
|
|
@@ -49744,7 +50167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49744
50167
|
/**
|
|
49745
50168
|
* Get the result of a long term forecast calculation
|
|
49746
50169
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49747
|
-
* @param {String} businessUnitId The
|
|
50170
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49748
50171
|
* @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
|
|
49749
50172
|
* @param {String} forecastId The ID of the forecast
|
|
49750
50173
|
* @param {Object} opts Optional parameters
|
|
@@ -49783,7 +50206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49783
50206
|
/**
|
|
49784
50207
|
* Gets the forecast planning group snapshot
|
|
49785
50208
|
*
|
|
49786
|
-
* @param {String} businessUnitId The
|
|
50209
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49787
50210
|
* @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
|
|
49788
50211
|
* @param {String} forecastId The ID of the forecast
|
|
49789
50212
|
*/
|
|
@@ -49818,7 +50241,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49818
50241
|
/**
|
|
49819
50242
|
* Get short term forecasts
|
|
49820
50243
|
* 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
|
|
49821
|
-
* @param {String} businessUnitId The
|
|
50244
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49822
50245
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
49823
50246
|
*/
|
|
49824
50247
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -50036,7 +50459,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50036
50459
|
/**
|
|
50037
50460
|
* Get a list of user schedule adherence records for the requested management unit
|
|
50038
50461
|
*
|
|
50039
|
-
* @param {String} managementUnitId The
|
|
50462
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50040
50463
|
* @param {Object} opts Optional parameters
|
|
50041
50464
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
50042
50465
|
*/
|
|
@@ -50065,7 +50488,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50065
50488
|
/**
|
|
50066
50489
|
* Get data for agent in the management unit
|
|
50067
50490
|
*
|
|
50068
|
-
* @param {String} managementUnitId The
|
|
50491
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50069
50492
|
* @param {String} agentId The agent id
|
|
50070
50493
|
* @param {Object} opts Optional parameters
|
|
50071
50494
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -50099,7 +50522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50099
50522
|
/**
|
|
50100
50523
|
* Gets all the shift trades for a given agent
|
|
50101
50524
|
*
|
|
50102
|
-
* @param {String} managementUnitId The
|
|
50525
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50103
50526
|
* @param {String} agentId The agent id
|
|
50104
50527
|
*/
|
|
50105
50528
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -50129,7 +50552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50129
50552
|
/**
|
|
50130
50553
|
* Gets a summary of all shift trades in the matched state
|
|
50131
50554
|
*
|
|
50132
|
-
* @param {String} managementUnitId The
|
|
50555
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50133
50556
|
*/
|
|
50134
50557
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
50135
50558
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50154,7 +50577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50154
50577
|
/**
|
|
50155
50578
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
50156
50579
|
*
|
|
50157
|
-
* @param {String} managementUnitId The
|
|
50580
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50158
50581
|
*/
|
|
50159
50582
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
50160
50583
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50179,7 +50602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50179
50602
|
/**
|
|
50180
50603
|
* Gets a time off limit object
|
|
50181
50604
|
* Returns properties of time off limit object, but not daily values.
|
|
50182
|
-
* @param {String} managementUnitId The
|
|
50605
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50183
50606
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
50184
50607
|
*/
|
|
50185
50608
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50209,7 +50632,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50209
50632
|
/**
|
|
50210
50633
|
* Gets a list of time off limit objects under management unit.
|
|
50211
50634
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
50212
|
-
* @param {String} managementUnitId The
|
|
50635
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50213
50636
|
*/
|
|
50214
50637
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
50215
50638
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50234,7 +50657,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50234
50657
|
/**
|
|
50235
50658
|
* Gets a time off plan
|
|
50236
50659
|
*
|
|
50237
|
-
* @param {String} managementUnitId The management unit
|
|
50660
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50238
50661
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
50239
50662
|
*/
|
|
50240
50663
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -50264,7 +50687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50264
50687
|
/**
|
|
50265
50688
|
* Gets a list of time off plans
|
|
50266
50689
|
*
|
|
50267
|
-
* @param {String} managementUnitId The management unit
|
|
50690
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50268
50691
|
*/
|
|
50269
50692
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
50270
50693
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50289,7 +50712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50289
50712
|
/**
|
|
50290
50713
|
* Get a time off request
|
|
50291
50714
|
*
|
|
50292
|
-
* @param {String} managementUnitId The
|
|
50715
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50293
50716
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50294
50717
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
50295
50718
|
*/
|
|
@@ -50324,7 +50747,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50324
50747
|
/**
|
|
50325
50748
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
50326
50749
|
*
|
|
50327
|
-
* @param {String} managementUnitId The
|
|
50750
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50328
50751
|
* @param {String} userId The userId to whom the time off request applies.
|
|
50329
50752
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
50330
50753
|
*/
|
|
@@ -50359,7 +50782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50359
50782
|
/**
|
|
50360
50783
|
* Get a list of time off requests for a given user
|
|
50361
50784
|
*
|
|
50362
|
-
* @param {String} managementUnitId The
|
|
50785
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50363
50786
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50364
50787
|
* @param {Object} opts Optional parameters
|
|
50365
50788
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -50393,7 +50816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50393
50816
|
/**
|
|
50394
50817
|
* Get users in the management unit
|
|
50395
50818
|
*
|
|
50396
|
-
* @param {String} managementUnitId The
|
|
50819
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50397
50820
|
*/
|
|
50398
50821
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
50399
50822
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50494,7 +50917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50494
50917
|
/**
|
|
50495
50918
|
* Gets all the shift trades for a given week
|
|
50496
50919
|
*
|
|
50497
|
-
* @param {String} managementUnitId The
|
|
50920
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50498
50921
|
* @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
|
|
50499
50922
|
* @param {Object} opts Optional parameters
|
|
50500
50923
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -50767,7 +51190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50767
51190
|
/**
|
|
50768
51191
|
* Get a time off request for the current user
|
|
50769
51192
|
*
|
|
50770
|
-
* @param {String} timeOffRequestId
|
|
51193
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50771
51194
|
*/
|
|
50772
51195
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
50773
51196
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -50792,7 +51215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50792
51215
|
/**
|
|
50793
51216
|
* Get the daily waitlist positions of a time off request for the current user
|
|
50794
51217
|
*
|
|
50795
|
-
* @param {String} timeOffRequestId
|
|
51218
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50796
51219
|
*/
|
|
50797
51220
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
50798
51221
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -51035,7 +51458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51035
51458
|
/**
|
|
51036
51459
|
* Updates a time off limit object.
|
|
51037
51460
|
* Updates time off limit object properties, but not daily values.
|
|
51038
|
-
* @param {String} managementUnitId The
|
|
51461
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
51039
51462
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
51040
51463
|
* @param {Object} opts Optional parameters
|
|
51041
51464
|
* @param {Object} opts.body body
|
|
@@ -51069,7 +51492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51069
51492
|
/**
|
|
51070
51493
|
* Updates a time off plan
|
|
51071
51494
|
*
|
|
51072
|
-
* @param {String} managementUnitId The management unit
|
|
51495
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51073
51496
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
51074
51497
|
* @param {Object} opts Optional parameters
|
|
51075
51498
|
* @param {Object} opts.body body
|
|
@@ -51103,7 +51526,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51103
51526
|
/**
|
|
51104
51527
|
* Update a time off request
|
|
51105
51528
|
*
|
|
51106
|
-
* @param {String} managementUnitId The
|
|
51529
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51107
51530
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
51108
51531
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
51109
51532
|
* @param {Object} opts Optional parameters
|
|
@@ -51142,7 +51565,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51142
51565
|
/**
|
|
51143
51566
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
51144
51567
|
*
|
|
51145
|
-
* @param {String} managementUnitId The
|
|
51568
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51146
51569
|
* @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
|
|
51147
51570
|
* @param {Object} body body
|
|
51148
51571
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -51251,7 +51674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51251
51674
|
/**
|
|
51252
51675
|
* Update a time off request for the current user
|
|
51253
51676
|
*
|
|
51254
|
-
* @param {String} timeOffRequestId
|
|
51677
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
51255
51678
|
* @param {Object} opts Optional parameters
|
|
51256
51679
|
* @param {Object} opts.body body
|
|
51257
51680
|
*/
|
|
@@ -51388,7 +51811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51388
51811
|
/**
|
|
51389
51812
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
51390
51813
|
*
|
|
51391
|
-
* @param {String} businessUnitId The
|
|
51814
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51392
51815
|
* @param {Object} opts Optional parameters
|
|
51393
51816
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
51394
51817
|
* @param {Object} opts.body body
|
|
@@ -51821,7 +52244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51821
52244
|
/**
|
|
51822
52245
|
* Copy a short term forecast
|
|
51823
52246
|
*
|
|
51824
|
-
* @param {String} businessUnitId The
|
|
52247
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51825
52248
|
* @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
|
|
51826
52249
|
* @param {String} forecastId The ID of the forecast to copy
|
|
51827
52250
|
* @param {Object} body body
|
|
@@ -51865,7 +52288,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51865
52288
|
/**
|
|
51866
52289
|
* Generate a short term forecast
|
|
51867
52290
|
*
|
|
51868
|
-
* @param {String} businessUnitId The
|
|
52291
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51869
52292
|
* @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
|
|
51870
52293
|
* @param {Object} body
|
|
51871
52294
|
* @param {Object} opts Optional parameters
|
|
@@ -51904,7 +52327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51904
52327
|
/**
|
|
51905
52328
|
* Starts importing the uploaded short term forecast
|
|
51906
52329
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
51907
|
-
* @param {String} businessUnitId The
|
|
52330
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51908
52331
|
* @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
|
|
51909
52332
|
* @param {Object} body
|
|
51910
52333
|
*/
|
|
@@ -51939,7 +52362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51939
52362
|
/**
|
|
51940
52363
|
* Creates a signed upload URL for importing a short term forecast
|
|
51941
52364
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
51942
|
-
* @param {String} businessUnitId The
|
|
52365
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51943
52366
|
* @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
|
|
51944
52367
|
* @param {Object} body body
|
|
51945
52368
|
*/
|
|
@@ -52066,7 +52489,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52066
52489
|
/**
|
|
52067
52490
|
* Query published schedules for given given time range for set of users
|
|
52068
52491
|
*
|
|
52069
|
-
* @param {String} managementUnitId The
|
|
52492
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52070
52493
|
* @param {Object} opts Optional parameters
|
|
52071
52494
|
* @param {Object} opts.body body
|
|
52072
52495
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -52097,7 +52520,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52097
52520
|
/**
|
|
52098
52521
|
* Request a historical adherence report
|
|
52099
52522
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
52100
|
-
* @param {String} managementUnitId The
|
|
52523
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52101
52524
|
* @param {Object} opts Optional parameters
|
|
52102
52525
|
* @param {Object} opts.body body
|
|
52103
52526
|
*/
|
|
@@ -52155,7 +52578,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52155
52578
|
/**
|
|
52156
52579
|
* Query published schedules for given given time range for set of users
|
|
52157
52580
|
*
|
|
52158
|
-
* @param {String} managementUnitId The
|
|
52581
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52159
52582
|
* @param {Object} opts Optional parameters
|
|
52160
52583
|
* @param {Object} opts.body body
|
|
52161
52584
|
*/
|
|
@@ -52184,7 +52607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52184
52607
|
/**
|
|
52185
52608
|
* Creates a new time off limit object under management unit.
|
|
52186
52609
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
52187
|
-
* @param {String} managementUnitId The
|
|
52610
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52188
52611
|
* @param {Object} opts Optional parameters
|
|
52189
52612
|
* @param {Object} opts.body body
|
|
52190
52613
|
*/
|
|
@@ -52213,7 +52636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52213
52636
|
/**
|
|
52214
52637
|
* Retrieves time off limit related values based on a given set of filters.
|
|
52215
52638
|
*
|
|
52216
|
-
* @param {String} managementUnitId The
|
|
52639
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52217
52640
|
* @param {Object} opts Optional parameters
|
|
52218
52641
|
* @param {Object} opts.body body
|
|
52219
52642
|
*/
|
|
@@ -52242,7 +52665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52242
52665
|
/**
|
|
52243
52666
|
* Creates a new time off plan
|
|
52244
52667
|
*
|
|
52245
|
-
* @param {String} managementUnitId The management unit
|
|
52668
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52246
52669
|
* @param {Object} opts Optional parameters
|
|
52247
52670
|
* @param {Object} opts.body body
|
|
52248
52671
|
*/
|
|
@@ -52271,7 +52694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52271
52694
|
/**
|
|
52272
52695
|
* Create a new time off request
|
|
52273
52696
|
*
|
|
52274
|
-
* @param {String} managementUnitId The
|
|
52697
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52275
52698
|
* @param {Object} opts Optional parameters
|
|
52276
52699
|
* @param {Object} opts.body body
|
|
52277
52700
|
*/
|
|
@@ -52300,7 +52723,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52300
52723
|
/**
|
|
52301
52724
|
* Fetches time off requests matching the conditions specified in the request body
|
|
52302
52725
|
* 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
|
|
52303
|
-
* @param {String} managementUnitId The
|
|
52726
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52304
52727
|
* @param {Object} opts Optional parameters
|
|
52305
52728
|
* @param {Object} opts.body body
|
|
52306
52729
|
*/
|
|
@@ -52329,7 +52752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52329
52752
|
/**
|
|
52330
52753
|
* Retrieves daily waitlist position for a list of time off requests
|
|
52331
52754
|
*
|
|
52332
|
-
* @param {String} managementUnitId The
|
|
52755
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52333
52756
|
* @param {Object} opts Optional parameters
|
|
52334
52757
|
* @param {Object} opts.body body
|
|
52335
52758
|
*/
|
|
@@ -52358,7 +52781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52358
52781
|
/**
|
|
52359
52782
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52360
52783
|
*
|
|
52361
|
-
* @param {String} managementUnitId The
|
|
52784
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52362
52785
|
* @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
|
|
52363
52786
|
* @param {Object} body body
|
|
52364
52787
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -52398,7 +52821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52398
52821
|
/**
|
|
52399
52822
|
* Adds a shift trade
|
|
52400
52823
|
*
|
|
52401
|
-
* @param {String} managementUnitId The
|
|
52824
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52402
52825
|
* @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
|
|
52403
52826
|
* @param {Object} body body
|
|
52404
52827
|
*/
|
|
@@ -52433,7 +52856,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52433
52856
|
/**
|
|
52434
52857
|
* Searches for potential shift trade matches for the current agent
|
|
52435
52858
|
*
|
|
52436
|
-
* @param {String} managementUnitId The
|
|
52859
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52437
52860
|
* @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
|
|
52438
52861
|
* @param {Object} body body
|
|
52439
52862
|
*/
|
|
@@ -52468,7 +52891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52468
52891
|
/**
|
|
52469
52892
|
* Updates the state of a batch of shift trades
|
|
52470
52893
|
* Admin functionality is not supported with \"mine\".
|
|
52471
|
-
* @param {String} managementUnitId The
|
|
52894
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52472
52895
|
* @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
|
|
52473
52896
|
* @param {Object} body body
|
|
52474
52897
|
* @param {Object} opts Optional parameters
|
|
@@ -52789,7 +53212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52789
53212
|
/**
|
|
52790
53213
|
* Sets daily values for a date range of time off limit object
|
|
52791
53214
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
52792
|
-
* @param {String} managementUnitId The
|
|
53215
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52793
53216
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
52794
53217
|
* @param {Object} opts Optional parameters
|
|
52795
53218
|
* @param {Object} opts.body body
|
|
@@ -52851,7 +53274,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52851
53274
|
* </pre>
|
|
52852
53275
|
* </p>
|
|
52853
53276
|
* @module purecloud-platform-client-v2/index
|
|
52854
|
-
* @version
|
|
53277
|
+
* @version 136.1.0
|
|
52855
53278
|
*/
|
|
52856
53279
|
class platformClient {
|
|
52857
53280
|
constructor() {
|