purecloud-platform-client-v2 189.1.0 → 191.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +1160 -114
- package/dist/web-amd/purecloud-platform-client-v2.js +1160 -114
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +516 -274
- package/dist/web-cjs/purecloud-platform-client-v2.js +517 -277
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1229 -495
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +162 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +86 -20
- 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 +33 -8
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +207 -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 -2
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +24 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +34 -7
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +4 -4
- 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 +516 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 191.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1821,7 +1821,7 @@ class AlertingApi {
|
|
|
1821
1821
|
/**
|
|
1822
1822
|
* Alerting service.
|
|
1823
1823
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1824
|
-
* @version
|
|
1824
|
+
* @version 191.0.0
|
|
1825
1825
|
*/
|
|
1826
1826
|
|
|
1827
1827
|
/**
|
|
@@ -2482,7 +2482,7 @@ class AnalyticsApi {
|
|
|
2482
2482
|
/**
|
|
2483
2483
|
* Analytics service.
|
|
2484
2484
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2485
|
-
* @version
|
|
2485
|
+
* @version 191.0.0
|
|
2486
2486
|
*/
|
|
2487
2487
|
|
|
2488
2488
|
/**
|
|
@@ -3232,6 +3232,59 @@ class AnalyticsApi {
|
|
|
3232
3232
|
);
|
|
3233
3233
|
}
|
|
3234
3234
|
|
|
3235
|
+
/**
|
|
3236
|
+
* Get dashboards summary for a user
|
|
3237
|
+
*
|
|
3238
|
+
* @param {String} userId User ID
|
|
3239
|
+
*/
|
|
3240
|
+
getAnalyticsReportingDashboardsUser(userId) {
|
|
3241
|
+
// verify the required parameter 'userId' is set
|
|
3242
|
+
if (userId === undefined || userId === null) {
|
|
3243
|
+
throw 'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';
|
|
3244
|
+
}
|
|
3245
|
+
|
|
3246
|
+
return this.apiClient.callApi(
|
|
3247
|
+
'/api/v2/analytics/reporting/dashboards/users/{userId}',
|
|
3248
|
+
'GET',
|
|
3249
|
+
{ 'userId': userId },
|
|
3250
|
+
{ },
|
|
3251
|
+
{ },
|
|
3252
|
+
{ },
|
|
3253
|
+
null,
|
|
3254
|
+
['PureCloud OAuth'],
|
|
3255
|
+
['application/json'],
|
|
3256
|
+
['application/json']
|
|
3257
|
+
);
|
|
3258
|
+
}
|
|
3259
|
+
|
|
3260
|
+
/**
|
|
3261
|
+
* Get dashboards summary for users in a org
|
|
3262
|
+
*
|
|
3263
|
+
* @param {Object} opts Optional parameters
|
|
3264
|
+
* @param {String} opts.sortBy (default to asc)
|
|
3265
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
3266
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
3267
|
+
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
3268
|
+
* @param {Object} opts.state Only list users of this state
|
|
3269
|
+
*/
|
|
3270
|
+
getAnalyticsReportingDashboardsUsers(opts) {
|
|
3271
|
+
opts = opts || {};
|
|
3272
|
+
|
|
3273
|
+
|
|
3274
|
+
return this.apiClient.callApi(
|
|
3275
|
+
'/api/v2/analytics/reporting/dashboards/users',
|
|
3276
|
+
'GET',
|
|
3277
|
+
{ },
|
|
3278
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
|
|
3279
|
+
{ },
|
|
3280
|
+
{ },
|
|
3281
|
+
null,
|
|
3282
|
+
['PureCloud OAuth'],
|
|
3283
|
+
['application/json'],
|
|
3284
|
+
['application/json']
|
|
3285
|
+
);
|
|
3286
|
+
}
|
|
3287
|
+
|
|
3235
3288
|
/**
|
|
3236
3289
|
* Get all view export requests for a user
|
|
3237
3290
|
*
|
|
@@ -3507,6 +3560,39 @@ class AnalyticsApi {
|
|
|
3507
3560
|
);
|
|
3508
3561
|
}
|
|
3509
3562
|
|
|
3563
|
+
/**
|
|
3564
|
+
* Get list of dashboards for an user
|
|
3565
|
+
*
|
|
3566
|
+
* @param {String} userId User ID
|
|
3567
|
+
* @param {Object} opts Optional parameters
|
|
3568
|
+
* @param {String} opts.sortBy (default to asc)
|
|
3569
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
3570
|
+
* @param {Number} opts.pageSize (default to 50)
|
|
3571
|
+
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
3572
|
+
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
3573
|
+
*/
|
|
3574
|
+
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
3575
|
+
opts = opts || {};
|
|
3576
|
+
|
|
3577
|
+
// verify the required parameter 'userId' is set
|
|
3578
|
+
if (userId === undefined || userId === null) {
|
|
3579
|
+
throw 'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';
|
|
3580
|
+
}
|
|
3581
|
+
|
|
3582
|
+
return this.apiClient.callApi(
|
|
3583
|
+
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
3584
|
+
'GET',
|
|
3585
|
+
{ 'userId': userId },
|
|
3586
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
|
|
3587
|
+
{ },
|
|
3588
|
+
{ },
|
|
3589
|
+
null,
|
|
3590
|
+
['PureCloud OAuth'],
|
|
3591
|
+
['application/json'],
|
|
3592
|
+
['application/json']
|
|
3593
|
+
);
|
|
3594
|
+
}
|
|
3595
|
+
|
|
3510
3596
|
/**
|
|
3511
3597
|
* Get a list of report time periods.
|
|
3512
3598
|
*
|
|
@@ -4557,6 +4643,31 @@ class AnalyticsApi {
|
|
|
4557
4643
|
);
|
|
4558
4644
|
}
|
|
4559
4645
|
|
|
4646
|
+
/**
|
|
4647
|
+
* Bulk delete dashboards owned by other user(s)
|
|
4648
|
+
*
|
|
4649
|
+
* @param {Array.<String>} body List of userIds
|
|
4650
|
+
*/
|
|
4651
|
+
postAnalyticsReportingDashboardsUsersBulkRemove(body) {
|
|
4652
|
+
// verify the required parameter 'body' is set
|
|
4653
|
+
if (body === undefined || body === null) {
|
|
4654
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';
|
|
4655
|
+
}
|
|
4656
|
+
|
|
4657
|
+
return this.apiClient.callApi(
|
|
4658
|
+
'/api/v2/analytics/reporting/dashboards/users/bulk/remove',
|
|
4659
|
+
'POST',
|
|
4660
|
+
{ },
|
|
4661
|
+
{ },
|
|
4662
|
+
{ },
|
|
4663
|
+
{ },
|
|
4664
|
+
body,
|
|
4665
|
+
['PureCloud OAuth'],
|
|
4666
|
+
['application/json'],
|
|
4667
|
+
['application/json']
|
|
4668
|
+
);
|
|
4669
|
+
}
|
|
4670
|
+
|
|
4560
4671
|
/**
|
|
4561
4672
|
* Generate a view export request
|
|
4562
4673
|
* This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
|
|
@@ -4634,6 +4745,56 @@ class AnalyticsApi {
|
|
|
4634
4745
|
);
|
|
4635
4746
|
}
|
|
4636
4747
|
|
|
4748
|
+
/**
|
|
4749
|
+
* Bulk remove dashboard configurations
|
|
4750
|
+
*
|
|
4751
|
+
* @param {Object} body
|
|
4752
|
+
*/
|
|
4753
|
+
postAnalyticsReportingSettingsDashboardsBulkRemove(body) {
|
|
4754
|
+
// verify the required parameter 'body' is set
|
|
4755
|
+
if (body === undefined || body === null) {
|
|
4756
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';
|
|
4757
|
+
}
|
|
4758
|
+
|
|
4759
|
+
return this.apiClient.callApi(
|
|
4760
|
+
'/api/v2/analytics/reporting/settings/dashboards/bulk/remove',
|
|
4761
|
+
'POST',
|
|
4762
|
+
{ },
|
|
4763
|
+
{ },
|
|
4764
|
+
{ },
|
|
4765
|
+
{ },
|
|
4766
|
+
body,
|
|
4767
|
+
['PureCloud OAuth'],
|
|
4768
|
+
['application/json'],
|
|
4769
|
+
['application/json']
|
|
4770
|
+
);
|
|
4771
|
+
}
|
|
4772
|
+
|
|
4773
|
+
/**
|
|
4774
|
+
* Query dashboard configurations
|
|
4775
|
+
*
|
|
4776
|
+
* @param {Object} body
|
|
4777
|
+
*/
|
|
4778
|
+
postAnalyticsReportingSettingsDashboardsQuery(body) {
|
|
4779
|
+
// verify the required parameter 'body' is set
|
|
4780
|
+
if (body === undefined || body === null) {
|
|
4781
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';
|
|
4782
|
+
}
|
|
4783
|
+
|
|
4784
|
+
return this.apiClient.callApi(
|
|
4785
|
+
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
4786
|
+
'POST',
|
|
4787
|
+
{ },
|
|
4788
|
+
{ },
|
|
4789
|
+
{ },
|
|
4790
|
+
{ },
|
|
4791
|
+
body,
|
|
4792
|
+
['PureCloud OAuth'],
|
|
4793
|
+
['application/json'],
|
|
4794
|
+
['application/json']
|
|
4795
|
+
);
|
|
4796
|
+
}
|
|
4797
|
+
|
|
4637
4798
|
/**
|
|
4638
4799
|
* Query for resolution aggregates asynchronously
|
|
4639
4800
|
*
|
|
@@ -5095,7 +5256,7 @@ class ArchitectApi {
|
|
|
5095
5256
|
/**
|
|
5096
5257
|
* Architect service.
|
|
5097
5258
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5098
|
-
* @version
|
|
5259
|
+
* @version 191.0.0
|
|
5099
5260
|
*/
|
|
5100
5261
|
|
|
5101
5262
|
/**
|
|
@@ -9241,7 +9402,7 @@ class AuditApi {
|
|
|
9241
9402
|
/**
|
|
9242
9403
|
* Audit service.
|
|
9243
9404
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9244
|
-
* @version
|
|
9405
|
+
* @version 191.0.0
|
|
9245
9406
|
*/
|
|
9246
9407
|
|
|
9247
9408
|
/**
|
|
@@ -9412,7 +9573,7 @@ class AuthorizationApi {
|
|
|
9412
9573
|
/**
|
|
9413
9574
|
* Authorization service.
|
|
9414
9575
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9415
|
-
* @version
|
|
9576
|
+
* @version 191.0.0
|
|
9416
9577
|
*/
|
|
9417
9578
|
|
|
9418
9579
|
/**
|
|
@@ -10642,7 +10803,7 @@ class BillingApi {
|
|
|
10642
10803
|
/**
|
|
10643
10804
|
* Billing service.
|
|
10644
10805
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10645
|
-
* @version
|
|
10806
|
+
* @version 191.0.0
|
|
10646
10807
|
*/
|
|
10647
10808
|
|
|
10648
10809
|
/**
|
|
@@ -10722,7 +10883,7 @@ class CarrierServicesApi {
|
|
|
10722
10883
|
/**
|
|
10723
10884
|
* CarrierServices service.
|
|
10724
10885
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10725
|
-
* @version
|
|
10886
|
+
* @version 191.0.0
|
|
10726
10887
|
*/
|
|
10727
10888
|
|
|
10728
10889
|
/**
|
|
@@ -10792,7 +10953,7 @@ class ChatApi {
|
|
|
10792
10953
|
/**
|
|
10793
10954
|
* Chat service.
|
|
10794
10955
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10795
|
-
* @version
|
|
10956
|
+
* @version 191.0.0
|
|
10796
10957
|
*/
|
|
10797
10958
|
|
|
10798
10959
|
/**
|
|
@@ -10812,7 +10973,6 @@ class ChatApi {
|
|
|
10812
10973
|
*
|
|
10813
10974
|
* @param {String} roomJid roomId
|
|
10814
10975
|
* @param {String} messageId messageId
|
|
10815
|
-
* deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10816
10976
|
*/
|
|
10817
10977
|
deleteChatsRoomMessage(roomJid, messageId) {
|
|
10818
10978
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10843,7 +11003,6 @@ class ChatApi {
|
|
|
10843
11003
|
*
|
|
10844
11004
|
* @param {String} roomJid roomJid
|
|
10845
11005
|
* @param {String} userId userId
|
|
10846
|
-
* deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10847
11006
|
*/
|
|
10848
11007
|
deleteChatsRoomParticipant(roomJid, userId) {
|
|
10849
11008
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10874,7 +11033,6 @@ class ChatApi {
|
|
|
10874
11033
|
*
|
|
10875
11034
|
* @param {String} roomJid roomJid
|
|
10876
11035
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
10877
|
-
* deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10878
11036
|
*/
|
|
10879
11037
|
deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) {
|
|
10880
11038
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10905,7 +11063,6 @@ class ChatApi {
|
|
|
10905
11063
|
*
|
|
10906
11064
|
* @param {String} userId userId
|
|
10907
11065
|
* @param {String} messageId messageId
|
|
10908
|
-
* deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10909
11066
|
*/
|
|
10910
11067
|
deleteChatsUserMessage(userId, messageId) {
|
|
10911
11068
|
// verify the required parameter 'userId' is set
|
|
@@ -10935,7 +11092,6 @@ class ChatApi {
|
|
|
10935
11092
|
* Get a message
|
|
10936
11093
|
*
|
|
10937
11094
|
* @param {String} messageId messageId
|
|
10938
|
-
* getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10939
11095
|
*/
|
|
10940
11096
|
getChatsMessage(messageId) {
|
|
10941
11097
|
// verify the required parameter 'messageId' is set
|
|
@@ -10961,7 +11117,6 @@ class ChatApi {
|
|
|
10961
11117
|
* Get a room
|
|
10962
11118
|
*
|
|
10963
11119
|
* @param {String} roomJid roomJid
|
|
10964
|
-
* getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10965
11120
|
*/
|
|
10966
11121
|
getChatsRoom(roomJid) {
|
|
10967
11122
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10988,7 +11143,6 @@ class ChatApi {
|
|
|
10988
11143
|
*
|
|
10989
11144
|
* @param {String} roomJid roomJid
|
|
10990
11145
|
* @param {String} messageIds messageIds, comma separated
|
|
10991
|
-
* getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10992
11146
|
*/
|
|
10993
11147
|
getChatsRoomMessage(roomJid, messageIds) {
|
|
10994
11148
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11022,7 +11176,6 @@ class ChatApi {
|
|
|
11022
11176
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11023
11177
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11024
11178
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11025
|
-
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11026
11179
|
*/
|
|
11027
11180
|
getChatsRoomMessages(roomJid, opts) {
|
|
11028
11181
|
opts = opts || {};
|
|
@@ -11046,6 +11199,61 @@ class ChatApi {
|
|
|
11046
11199
|
);
|
|
11047
11200
|
}
|
|
11048
11201
|
|
|
11202
|
+
/**
|
|
11203
|
+
* Get a room participant
|
|
11204
|
+
*
|
|
11205
|
+
* @param {String} roomJid roomJid
|
|
11206
|
+
* @param {String} participantJid participantJid
|
|
11207
|
+
*/
|
|
11208
|
+
getChatsRoomParticipant(roomJid, participantJid) {
|
|
11209
|
+
// verify the required parameter 'roomJid' is set
|
|
11210
|
+
if (roomJid === undefined || roomJid === null) {
|
|
11211
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';
|
|
11212
|
+
}
|
|
11213
|
+
// verify the required parameter 'participantJid' is set
|
|
11214
|
+
if (participantJid === undefined || participantJid === null) {
|
|
11215
|
+
throw 'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';
|
|
11216
|
+
}
|
|
11217
|
+
|
|
11218
|
+
return this.apiClient.callApi(
|
|
11219
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{participantJid}',
|
|
11220
|
+
'GET',
|
|
11221
|
+
{ 'roomJid': roomJid,'participantJid': participantJid },
|
|
11222
|
+
{ },
|
|
11223
|
+
{ },
|
|
11224
|
+
{ },
|
|
11225
|
+
null,
|
|
11226
|
+
['PureCloud OAuth'],
|
|
11227
|
+
['application/json'],
|
|
11228
|
+
['application/json']
|
|
11229
|
+
);
|
|
11230
|
+
}
|
|
11231
|
+
|
|
11232
|
+
/**
|
|
11233
|
+
* Get room participants in a room
|
|
11234
|
+
*
|
|
11235
|
+
* @param {String} roomJid roomJid
|
|
11236
|
+
*/
|
|
11237
|
+
getChatsRoomParticipants(roomJid) {
|
|
11238
|
+
// verify the required parameter 'roomJid' is set
|
|
11239
|
+
if (roomJid === undefined || roomJid === null) {
|
|
11240
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
|
|
11241
|
+
}
|
|
11242
|
+
|
|
11243
|
+
return this.apiClient.callApi(
|
|
11244
|
+
'/api/v2/chats/rooms/{roomJid}/participants',
|
|
11245
|
+
'GET',
|
|
11246
|
+
{ 'roomJid': roomJid },
|
|
11247
|
+
{ },
|
|
11248
|
+
{ },
|
|
11249
|
+
{ },
|
|
11250
|
+
null,
|
|
11251
|
+
['PureCloud OAuth'],
|
|
11252
|
+
['application/json'],
|
|
11253
|
+
['application/json']
|
|
11254
|
+
);
|
|
11255
|
+
}
|
|
11256
|
+
|
|
11049
11257
|
/**
|
|
11050
11258
|
* Get Chat Settings.
|
|
11051
11259
|
*
|
|
@@ -11074,7 +11282,6 @@ class ChatApi {
|
|
|
11074
11282
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11075
11283
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11076
11284
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11077
|
-
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11078
11285
|
*/
|
|
11079
11286
|
getChatsThreadMessages(threadId, opts) {
|
|
11080
11287
|
opts = opts || {};
|
|
@@ -11103,7 +11310,6 @@ class ChatApi {
|
|
|
11103
11310
|
*
|
|
11104
11311
|
* @param {String} userId userId
|
|
11105
11312
|
* @param {String} messageIds messageIds, comma separated
|
|
11106
|
-
* getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11107
11313
|
*/
|
|
11108
11314
|
getChatsUserMessage(userId, messageIds) {
|
|
11109
11315
|
// verify the required parameter 'userId' is set
|
|
@@ -11137,7 +11343,6 @@ class ChatApi {
|
|
|
11137
11343
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11138
11344
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11139
11345
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11140
|
-
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11141
11346
|
*/
|
|
11142
11347
|
getChatsUserMessages(userId, opts) {
|
|
11143
11348
|
opts = opts || {};
|
|
@@ -11192,7 +11397,6 @@ class ChatApi {
|
|
|
11192
11397
|
*
|
|
11193
11398
|
* @param {String} roomJid roomJid
|
|
11194
11399
|
* @param {Object} body Room properties
|
|
11195
|
-
* patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11196
11400
|
*/
|
|
11197
11401
|
patchChatsRoom(roomJid, body) {
|
|
11198
11402
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11224,7 +11428,6 @@ class ChatApi {
|
|
|
11224
11428
|
* @param {String} roomJid roomId
|
|
11225
11429
|
* @param {String} messageId messageId
|
|
11226
11430
|
* @param {Object} body messageBody
|
|
11227
|
-
* patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11228
11431
|
*/
|
|
11229
11432
|
patchChatsRoomMessage(roomJid, messageId, body) {
|
|
11230
11433
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11285,7 +11488,6 @@ class ChatApi {
|
|
|
11285
11488
|
* @param {String} userId userId
|
|
11286
11489
|
* @param {String} messageId messageId
|
|
11287
11490
|
* @param {Object} body message body
|
|
11288
|
-
* patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11289
11491
|
*/
|
|
11290
11492
|
patchChatsUserMessage(userId, messageId, body) {
|
|
11291
11493
|
// verify the required parameter 'userId' is set
|
|
@@ -11351,7 +11553,6 @@ class ChatApi {
|
|
|
11351
11553
|
*
|
|
11352
11554
|
* @param {String} roomJid roomId
|
|
11353
11555
|
* @param {Object} body messageBody
|
|
11354
|
-
* postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11355
11556
|
*/
|
|
11356
11557
|
postChatsRoomMessages(roomJid, body) {
|
|
11357
11558
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11382,7 +11583,6 @@ class ChatApi {
|
|
|
11382
11583
|
*
|
|
11383
11584
|
* @param {String} roomJid roomJid
|
|
11384
11585
|
* @param {String} userId userId
|
|
11385
|
-
* postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11386
11586
|
*/
|
|
11387
11587
|
postChatsRoomParticipant(roomJid, userId) {
|
|
11388
11588
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11413,7 +11613,6 @@ class ChatApi {
|
|
|
11413
11613
|
*
|
|
11414
11614
|
* @param {String} roomJid roomJid
|
|
11415
11615
|
* @param {Object} body Pinned Message Ids
|
|
11416
|
-
* postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11417
11616
|
*/
|
|
11418
11617
|
postChatsRoomPinnedmessages(roomJid, body) {
|
|
11419
11618
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11443,7 +11642,6 @@ class ChatApi {
|
|
|
11443
11642
|
* Create an adhoc room
|
|
11444
11643
|
*
|
|
11445
11644
|
* @param {Object} body Room properties
|
|
11446
|
-
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11447
11645
|
*/
|
|
11448
11646
|
postChatsRooms(body) {
|
|
11449
11647
|
// verify the required parameter 'body' is set
|
|
@@ -11470,7 +11668,6 @@ class ChatApi {
|
|
|
11470
11668
|
*
|
|
11471
11669
|
* @param {String} userId userId
|
|
11472
11670
|
* @param {Object} body message body
|
|
11473
|
-
* postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11474
11671
|
*/
|
|
11475
11672
|
postChatsUserMessages(userId, body) {
|
|
11476
11673
|
// verify the required parameter 'userId' is set
|
|
@@ -11496,6 +11693,36 @@ class ChatApi {
|
|
|
11496
11693
|
);
|
|
11497
11694
|
}
|
|
11498
11695
|
|
|
11696
|
+
/**
|
|
11697
|
+
* Update reactions to a message
|
|
11698
|
+
*
|
|
11699
|
+
* @param {String} messageId messageId
|
|
11700
|
+
* @param {Object} body reactionUpdate
|
|
11701
|
+
*/
|
|
11702
|
+
putChatsMessageReactions(messageId, body) {
|
|
11703
|
+
// verify the required parameter 'messageId' is set
|
|
11704
|
+
if (messageId === undefined || messageId === null) {
|
|
11705
|
+
throw 'Missing the required parameter "messageId" when calling putChatsMessageReactions';
|
|
11706
|
+
}
|
|
11707
|
+
// verify the required parameter 'body' is set
|
|
11708
|
+
if (body === undefined || body === null) {
|
|
11709
|
+
throw 'Missing the required parameter "body" when calling putChatsMessageReactions';
|
|
11710
|
+
}
|
|
11711
|
+
|
|
11712
|
+
return this.apiClient.callApi(
|
|
11713
|
+
'/api/v2/chats/messages/{messageId}/reactions',
|
|
11714
|
+
'PUT',
|
|
11715
|
+
{ 'messageId': messageId },
|
|
11716
|
+
{ },
|
|
11717
|
+
{ },
|
|
11718
|
+
{ },
|
|
11719
|
+
body,
|
|
11720
|
+
['PureCloud OAuth'],
|
|
11721
|
+
['application/json'],
|
|
11722
|
+
['application/json']
|
|
11723
|
+
);
|
|
11724
|
+
}
|
|
11725
|
+
|
|
11499
11726
|
/**
|
|
11500
11727
|
* Update Chat Settings.
|
|
11501
11728
|
*
|
|
@@ -11527,7 +11754,7 @@ class CoachingApi {
|
|
|
11527
11754
|
/**
|
|
11528
11755
|
* Coaching service.
|
|
11529
11756
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11530
|
-
* @version
|
|
11757
|
+
* @version 191.0.0
|
|
11531
11758
|
*/
|
|
11532
11759
|
|
|
11533
11760
|
/**
|
|
@@ -12104,7 +12331,7 @@ class ContentManagementApi {
|
|
|
12104
12331
|
/**
|
|
12105
12332
|
* ContentManagement service.
|
|
12106
12333
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12107
|
-
* @version
|
|
12334
|
+
* @version 191.0.0
|
|
12108
12335
|
*/
|
|
12109
12336
|
|
|
12110
12337
|
/**
|
|
@@ -13186,7 +13413,7 @@ class ConversationsApi {
|
|
|
13186
13413
|
/**
|
|
13187
13414
|
* Conversations service.
|
|
13188
13415
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13189
|
-
* @version
|
|
13416
|
+
* @version 191.0.0
|
|
13190
13417
|
*/
|
|
13191
13418
|
|
|
13192
13419
|
/**
|
|
@@ -13479,8 +13706,9 @@ class ConversationsApi {
|
|
|
13479
13706
|
|
|
13480
13707
|
/**
|
|
13481
13708
|
* Delete a Twitter messaging integration
|
|
13482
|
-
*
|
|
13709
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
13483
13710
|
* @param {String} integrationId Integration ID
|
|
13711
|
+
* @deprecated
|
|
13484
13712
|
*/
|
|
13485
13713
|
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
13486
13714
|
// verify the required parameter 'integrationId' is set
|
|
@@ -15296,6 +15524,26 @@ class ConversationsApi {
|
|
|
15296
15524
|
);
|
|
15297
15525
|
}
|
|
15298
15526
|
|
|
15527
|
+
/**
|
|
15528
|
+
* Get a list of Facebook Permissions
|
|
15529
|
+
*
|
|
15530
|
+
*/
|
|
15531
|
+
getConversationsMessagingFacebookPermissions() {
|
|
15532
|
+
|
|
15533
|
+
return this.apiClient.callApi(
|
|
15534
|
+
'/api/v2/conversations/messaging/facebook/permissions',
|
|
15535
|
+
'GET',
|
|
15536
|
+
{ },
|
|
15537
|
+
{ },
|
|
15538
|
+
{ },
|
|
15539
|
+
{ },
|
|
15540
|
+
null,
|
|
15541
|
+
['PureCloud OAuth'],
|
|
15542
|
+
['application/json'],
|
|
15543
|
+
['application/json']
|
|
15544
|
+
);
|
|
15545
|
+
}
|
|
15546
|
+
|
|
15299
15547
|
/**
|
|
15300
15548
|
* Get a list of Integrations
|
|
15301
15549
|
*
|
|
@@ -15555,14 +15803,15 @@ class ConversationsApi {
|
|
|
15555
15803
|
}
|
|
15556
15804
|
|
|
15557
15805
|
/**
|
|
15558
|
-
* Get a list of Twitter Integrations
|
|
15559
|
-
*
|
|
15806
|
+
* Get a list of Twitter Integrations (Deprecated)
|
|
15807
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15560
15808
|
* @param {Object} opts Optional parameters
|
|
15561
15809
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15562
15810
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15563
15811
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15564
15812
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
15565
15813
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
15814
|
+
* @deprecated
|
|
15566
15815
|
*/
|
|
15567
15816
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
15568
15817
|
opts = opts || {};
|
|
@@ -15583,11 +15832,12 @@ class ConversationsApi {
|
|
|
15583
15832
|
}
|
|
15584
15833
|
|
|
15585
15834
|
/**
|
|
15586
|
-
* Get a Twitter messaging integration
|
|
15587
|
-
*
|
|
15835
|
+
* Get a Twitter messaging integration (Deprecated)
|
|
15836
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15588
15837
|
* @param {String} integrationId Integration ID
|
|
15589
15838
|
* @param {Object} opts Optional parameters
|
|
15590
15839
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15840
|
+
* @deprecated
|
|
15591
15841
|
*/
|
|
15592
15842
|
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
15593
15843
|
opts = opts || {};
|
|
@@ -17206,9 +17456,10 @@ class ConversationsApi {
|
|
|
17206
17456
|
|
|
17207
17457
|
/**
|
|
17208
17458
|
* Update Twitter messaging integration
|
|
17209
|
-
*
|
|
17459
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
17210
17460
|
* @param {String} integrationId Integration ID
|
|
17211
17461
|
* @param {Object} body TwitterIntegrationRequest
|
|
17462
|
+
* @deprecated
|
|
17212
17463
|
*/
|
|
17213
17464
|
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
17214
17465
|
// verify the required parameter 'integrationId' is set
|
|
@@ -19494,8 +19745,9 @@ class ConversationsApi {
|
|
|
19494
19745
|
|
|
19495
19746
|
/**
|
|
19496
19747
|
* Create a Twitter Integration
|
|
19497
|
-
*
|
|
19748
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
19498
19749
|
* @param {Object} body TwitterIntegrationRequest
|
|
19750
|
+
* @deprecated
|
|
19499
19751
|
*/
|
|
19500
19752
|
postConversationsMessagingIntegrationsTwitter(body) {
|
|
19501
19753
|
// verify the required parameter 'body' is set
|
|
@@ -20358,7 +20610,7 @@ class DataExtensionsApi {
|
|
|
20358
20610
|
/**
|
|
20359
20611
|
* DataExtensions service.
|
|
20360
20612
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20361
|
-
* @version
|
|
20613
|
+
* @version 191.0.0
|
|
20362
20614
|
*/
|
|
20363
20615
|
|
|
20364
20616
|
/**
|
|
@@ -20444,7 +20696,7 @@ class DownloadsApi {
|
|
|
20444
20696
|
/**
|
|
20445
20697
|
* Downloads service.
|
|
20446
20698
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20447
|
-
* @version
|
|
20699
|
+
* @version 191.0.0
|
|
20448
20700
|
*/
|
|
20449
20701
|
|
|
20450
20702
|
/**
|
|
@@ -20496,7 +20748,7 @@ class EmailsApi {
|
|
|
20496
20748
|
/**
|
|
20497
20749
|
* Emails service.
|
|
20498
20750
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20499
|
-
* @version
|
|
20751
|
+
* @version 191.0.0
|
|
20500
20752
|
*/
|
|
20501
20753
|
|
|
20502
20754
|
/**
|
|
@@ -20561,7 +20813,7 @@ class EventsApi {
|
|
|
20561
20813
|
/**
|
|
20562
20814
|
* Events service.
|
|
20563
20815
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20564
|
-
* @version
|
|
20816
|
+
* @version 191.0.0
|
|
20565
20817
|
*/
|
|
20566
20818
|
|
|
20567
20819
|
/**
|
|
@@ -20657,7 +20909,7 @@ class ExternalContactsApi {
|
|
|
20657
20909
|
/**
|
|
20658
20910
|
* ExternalContacts service.
|
|
20659
20911
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20660
|
-
* @version
|
|
20912
|
+
* @version 191.0.0
|
|
20661
20913
|
*/
|
|
20662
20914
|
|
|
20663
20915
|
/**
|
|
@@ -22615,7 +22867,7 @@ class FaxApi {
|
|
|
22615
22867
|
/**
|
|
22616
22868
|
* Fax service.
|
|
22617
22869
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22618
|
-
* @version
|
|
22870
|
+
* @version 191.0.0
|
|
22619
22871
|
*/
|
|
22620
22872
|
|
|
22621
22873
|
/**
|
|
@@ -22786,7 +23038,7 @@ class FlowsApi {
|
|
|
22786
23038
|
/**
|
|
22787
23039
|
* Flows service.
|
|
22788
23040
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22789
|
-
* @version
|
|
23041
|
+
* @version 191.0.0
|
|
22790
23042
|
*/
|
|
22791
23043
|
|
|
22792
23044
|
/**
|
|
@@ -22970,7 +23222,7 @@ class GamificationApi {
|
|
|
22970
23222
|
/**
|
|
22971
23223
|
* Gamification service.
|
|
22972
23224
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22973
|
-
* @version
|
|
23225
|
+
* @version 191.0.0
|
|
22974
23226
|
*/
|
|
22975
23227
|
|
|
22976
23228
|
/**
|
|
@@ -25056,7 +25308,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25056
25308
|
/**
|
|
25057
25309
|
* GeneralDataProtectionRegulation service.
|
|
25058
25310
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25059
|
-
* @version
|
|
25311
|
+
* @version 191.0.0
|
|
25060
25312
|
*/
|
|
25061
25313
|
|
|
25062
25314
|
/**
|
|
@@ -25186,7 +25438,7 @@ class GeolocationApi {
|
|
|
25186
25438
|
/**
|
|
25187
25439
|
* Geolocation service.
|
|
25188
25440
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25189
|
-
* @version
|
|
25441
|
+
* @version 191.0.0
|
|
25190
25442
|
*/
|
|
25191
25443
|
|
|
25192
25444
|
/**
|
|
@@ -25317,7 +25569,7 @@ class GreetingsApi {
|
|
|
25317
25569
|
/**
|
|
25318
25570
|
* Greetings service.
|
|
25319
25571
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25320
|
-
* @version
|
|
25572
|
+
* @version 191.0.0
|
|
25321
25573
|
*/
|
|
25322
25574
|
|
|
25323
25575
|
/**
|
|
@@ -25772,7 +26024,7 @@ class GroupsApi {
|
|
|
25772
26024
|
/**
|
|
25773
26025
|
* Groups service.
|
|
25774
26026
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25775
|
-
* @version
|
|
26027
|
+
* @version 191.0.0
|
|
25776
26028
|
*/
|
|
25777
26029
|
|
|
25778
26030
|
/**
|
|
@@ -26291,7 +26543,7 @@ class IdentityProviderApi {
|
|
|
26291
26543
|
/**
|
|
26292
26544
|
* IdentityProvider service.
|
|
26293
26545
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26294
|
-
* @version
|
|
26546
|
+
* @version 191.0.0
|
|
26295
26547
|
*/
|
|
26296
26548
|
|
|
26297
26549
|
/**
|
|
@@ -27152,7 +27404,7 @@ class InfrastructureAsCodeApi {
|
|
|
27152
27404
|
/**
|
|
27153
27405
|
* InfrastructureAsCode service.
|
|
27154
27406
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27155
|
-
* @version
|
|
27407
|
+
* @version 191.0.0
|
|
27156
27408
|
*/
|
|
27157
27409
|
|
|
27158
27410
|
/**
|
|
@@ -27319,7 +27571,7 @@ class IntegrationsApi {
|
|
|
27319
27571
|
/**
|
|
27320
27572
|
* Integrations service.
|
|
27321
27573
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27322
|
-
* @version
|
|
27574
|
+
* @version 191.0.0
|
|
27323
27575
|
*/
|
|
27324
27576
|
|
|
27325
27577
|
/**
|
|
@@ -29670,7 +29922,7 @@ class JourneyApi {
|
|
|
29670
29922
|
/**
|
|
29671
29923
|
* Journey service.
|
|
29672
29924
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29673
|
-
* @version
|
|
29925
|
+
* @version 191.0.0
|
|
29674
29926
|
*/
|
|
29675
29927
|
|
|
29676
29928
|
/**
|
|
@@ -30520,6 +30772,109 @@ class JourneyApi {
|
|
|
30520
30772
|
);
|
|
30521
30773
|
}
|
|
30522
30774
|
|
|
30775
|
+
/**
|
|
30776
|
+
* Get the job for a journey view version.
|
|
30777
|
+
* used for long descriptions
|
|
30778
|
+
* @param {String} viewId Journey View Id
|
|
30779
|
+
* @param {String} journeyVersionId Journey View Version
|
|
30780
|
+
* @param {String} jobId JobId
|
|
30781
|
+
* getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30782
|
+
*/
|
|
30783
|
+
getJourneyViewVersionJob(viewId, journeyVersionId, jobId) {
|
|
30784
|
+
// verify the required parameter 'viewId' is set
|
|
30785
|
+
if (viewId === undefined || viewId === null) {
|
|
30786
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';
|
|
30787
|
+
}
|
|
30788
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
30789
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
30790
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';
|
|
30791
|
+
}
|
|
30792
|
+
// verify the required parameter 'jobId' is set
|
|
30793
|
+
if (jobId === undefined || jobId === null) {
|
|
30794
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';
|
|
30795
|
+
}
|
|
30796
|
+
|
|
30797
|
+
return this.apiClient.callApi(
|
|
30798
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}',
|
|
30799
|
+
'GET',
|
|
30800
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
|
|
30801
|
+
{ },
|
|
30802
|
+
{ },
|
|
30803
|
+
{ },
|
|
30804
|
+
null,
|
|
30805
|
+
['PureCloud OAuth'],
|
|
30806
|
+
['application/json'],
|
|
30807
|
+
['application/json']
|
|
30808
|
+
);
|
|
30809
|
+
}
|
|
30810
|
+
|
|
30811
|
+
/**
|
|
30812
|
+
* Get the result of a job for a journey view version.
|
|
30813
|
+
* used for long descriptions
|
|
30814
|
+
* @param {String} viewId JourneyViewResult id
|
|
30815
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
30816
|
+
* @param {String} jobId Id of the executing job
|
|
30817
|
+
* getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30818
|
+
*/
|
|
30819
|
+
getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId) {
|
|
30820
|
+
// verify the required parameter 'viewId' is set
|
|
30821
|
+
if (viewId === undefined || viewId === null) {
|
|
30822
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';
|
|
30823
|
+
}
|
|
30824
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
30825
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
30826
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';
|
|
30827
|
+
}
|
|
30828
|
+
// verify the required parameter 'jobId' is set
|
|
30829
|
+
if (jobId === undefined || jobId === null) {
|
|
30830
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';
|
|
30831
|
+
}
|
|
30832
|
+
|
|
30833
|
+
return this.apiClient.callApi(
|
|
30834
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results',
|
|
30835
|
+
'GET',
|
|
30836
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'jobId': jobId },
|
|
30837
|
+
{ },
|
|
30838
|
+
{ },
|
|
30839
|
+
{ },
|
|
30840
|
+
null,
|
|
30841
|
+
['PureCloud OAuth'],
|
|
30842
|
+
['application/json'],
|
|
30843
|
+
['application/json']
|
|
30844
|
+
);
|
|
30845
|
+
}
|
|
30846
|
+
|
|
30847
|
+
/**
|
|
30848
|
+
* Get the latest job of a journey view version.
|
|
30849
|
+
* used for long descriptions
|
|
30850
|
+
* @param {String} viewId Journey View Id
|
|
30851
|
+
* @param {String} journeyVersionId Journey View Version
|
|
30852
|
+
* getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30853
|
+
*/
|
|
30854
|
+
getJourneyViewVersionJobsLatest(viewId, journeyVersionId) {
|
|
30855
|
+
// verify the required parameter 'viewId' is set
|
|
30856
|
+
if (viewId === undefined || viewId === null) {
|
|
30857
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';
|
|
30858
|
+
}
|
|
30859
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
30860
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
30861
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';
|
|
30862
|
+
}
|
|
30863
|
+
|
|
30864
|
+
return this.apiClient.callApi(
|
|
30865
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest',
|
|
30866
|
+
'GET',
|
|
30867
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId },
|
|
30868
|
+
{ },
|
|
30869
|
+
{ },
|
|
30870
|
+
{ },
|
|
30871
|
+
null,
|
|
30872
|
+
['PureCloud OAuth'],
|
|
30873
|
+
['application/json'],
|
|
30874
|
+
['application/json']
|
|
30875
|
+
);
|
|
30876
|
+
}
|
|
30877
|
+
|
|
30523
30878
|
/**
|
|
30524
30879
|
* Get a list of Journey Views
|
|
30525
30880
|
*
|
|
@@ -30541,6 +30896,53 @@ class JourneyApi {
|
|
|
30541
30896
|
);
|
|
30542
30897
|
}
|
|
30543
30898
|
|
|
30899
|
+
/**
|
|
30900
|
+
* Get an Event Definition
|
|
30901
|
+
*
|
|
30902
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
30903
|
+
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30904
|
+
*/
|
|
30905
|
+
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
30906
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
30907
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null) {
|
|
30908
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';
|
|
30909
|
+
}
|
|
30910
|
+
|
|
30911
|
+
return this.apiClient.callApi(
|
|
30912
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
|
|
30913
|
+
'GET',
|
|
30914
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
30915
|
+
{ },
|
|
30916
|
+
{ },
|
|
30917
|
+
{ },
|
|
30918
|
+
null,
|
|
30919
|
+
['PureCloud OAuth'],
|
|
30920
|
+
['application/json'],
|
|
30921
|
+
['application/json']
|
|
30922
|
+
);
|
|
30923
|
+
}
|
|
30924
|
+
|
|
30925
|
+
/**
|
|
30926
|
+
* Get a list of Event Definitions
|
|
30927
|
+
*
|
|
30928
|
+
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30929
|
+
*/
|
|
30930
|
+
getJourneyViewsEventdefinitions() {
|
|
30931
|
+
|
|
30932
|
+
return this.apiClient.callApi(
|
|
30933
|
+
'/api/v2/journey/views/eventdefinitions',
|
|
30934
|
+
'GET',
|
|
30935
|
+
{ },
|
|
30936
|
+
{ },
|
|
30937
|
+
{ },
|
|
30938
|
+
{ },
|
|
30939
|
+
null,
|
|
30940
|
+
['PureCloud OAuth'],
|
|
30941
|
+
['application/json'],
|
|
30942
|
+
['application/json']
|
|
30943
|
+
);
|
|
30944
|
+
}
|
|
30945
|
+
|
|
30544
30946
|
/**
|
|
30545
30947
|
* Update single action map.
|
|
30546
30948
|
*
|
|
@@ -30991,6 +31393,37 @@ class JourneyApi {
|
|
|
30991
31393
|
);
|
|
30992
31394
|
}
|
|
30993
31395
|
|
|
31396
|
+
/**
|
|
31397
|
+
* Submit a job request for a journey view version.
|
|
31398
|
+
* used for long descriptions
|
|
31399
|
+
* @param {String} viewId Journey View Id
|
|
31400
|
+
* @param {String} journeyVersionId Journey View Version
|
|
31401
|
+
* postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31402
|
+
*/
|
|
31403
|
+
postJourneyViewVersionJobs(viewId, journeyVersionId) {
|
|
31404
|
+
// verify the required parameter 'viewId' is set
|
|
31405
|
+
if (viewId === undefined || viewId === null) {
|
|
31406
|
+
throw 'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';
|
|
31407
|
+
}
|
|
31408
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
31409
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
31410
|
+
throw 'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';
|
|
31411
|
+
}
|
|
31412
|
+
|
|
31413
|
+
return this.apiClient.callApi(
|
|
31414
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs',
|
|
31415
|
+
'POST',
|
|
31416
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId },
|
|
31417
|
+
{ },
|
|
31418
|
+
{ },
|
|
31419
|
+
{ },
|
|
31420
|
+
null,
|
|
31421
|
+
['PureCloud OAuth'],
|
|
31422
|
+
['application/json'],
|
|
31423
|
+
['application/json']
|
|
31424
|
+
);
|
|
31425
|
+
}
|
|
31426
|
+
|
|
30994
31427
|
/**
|
|
30995
31428
|
* Update a Journey View by ID
|
|
30996
31429
|
* creates a new version
|
|
@@ -31048,13 +31481,38 @@ class JourneyApi {
|
|
|
31048
31481
|
);
|
|
31049
31482
|
}
|
|
31050
31483
|
|
|
31484
|
+
/**
|
|
31485
|
+
* Validate whether an encoding exist for a label/value combination.
|
|
31486
|
+
* True indicates a valid encoding
|
|
31487
|
+
* @param {Object} opts Optional parameters
|
|
31488
|
+
* @param {Array.<Object>} opts.body
|
|
31489
|
+
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31490
|
+
*/
|
|
31491
|
+
postJourneyViewsEncodingsValidate(opts) {
|
|
31492
|
+
opts = opts || {};
|
|
31493
|
+
|
|
31494
|
+
|
|
31495
|
+
return this.apiClient.callApi(
|
|
31496
|
+
'/api/v2/journey/views/encodings/validate',
|
|
31497
|
+
'POST',
|
|
31498
|
+
{ },
|
|
31499
|
+
{ },
|
|
31500
|
+
{ },
|
|
31501
|
+
{ },
|
|
31502
|
+
opts['body'],
|
|
31503
|
+
['PureCloud OAuth'],
|
|
31504
|
+
['application/json'],
|
|
31505
|
+
['application/json']
|
|
31506
|
+
);
|
|
31507
|
+
}
|
|
31508
|
+
|
|
31051
31509
|
}
|
|
31052
31510
|
|
|
31053
31511
|
class KnowledgeApi {
|
|
31054
31512
|
/**
|
|
31055
31513
|
* Knowledge service.
|
|
31056
31514
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31057
|
-
* @version
|
|
31515
|
+
* @version 191.0.0
|
|
31058
31516
|
*/
|
|
31059
31517
|
|
|
31060
31518
|
/**
|
|
@@ -34297,7 +34755,7 @@ class LanguageUnderstandingApi {
|
|
|
34297
34755
|
/**
|
|
34298
34756
|
* LanguageUnderstanding service.
|
|
34299
34757
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34300
|
-
* @version
|
|
34758
|
+
* @version 191.0.0
|
|
34301
34759
|
*/
|
|
34302
34760
|
|
|
34303
34761
|
/**
|
|
@@ -35310,7 +35768,7 @@ class LanguagesApi {
|
|
|
35310
35768
|
/**
|
|
35311
35769
|
* Languages service.
|
|
35312
35770
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35313
|
-
* @version
|
|
35771
|
+
* @version 191.0.0
|
|
35314
35772
|
*/
|
|
35315
35773
|
|
|
35316
35774
|
/**
|
|
@@ -35532,7 +35990,7 @@ class LearningApi {
|
|
|
35532
35990
|
/**
|
|
35533
35991
|
* Learning service.
|
|
35534
35992
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35535
|
-
* @version
|
|
35993
|
+
* @version 191.0.0
|
|
35536
35994
|
*/
|
|
35537
35995
|
|
|
35538
35996
|
/**
|
|
@@ -35976,7 +36434,6 @@ class LearningApi {
|
|
|
35976
36434
|
* @param {String} moduleId Key identifier for the module
|
|
35977
36435
|
* @param {String} userId Key identifier for the user
|
|
35978
36436
|
* @param {Object} body The learning request for updating the assignment
|
|
35979
|
-
* patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35980
36437
|
*/
|
|
35981
36438
|
patchLearningModuleUserAssignments(moduleId, userId, body) {
|
|
35982
36439
|
// verify the required parameter 'moduleId' is set
|
|
@@ -36388,7 +36845,7 @@ class LicenseApi {
|
|
|
36388
36845
|
/**
|
|
36389
36846
|
* License service.
|
|
36390
36847
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36391
|
-
* @version
|
|
36848
|
+
* @version 191.0.0
|
|
36392
36849
|
*/
|
|
36393
36850
|
|
|
36394
36851
|
/**
|
|
@@ -36626,7 +37083,7 @@ class LocationsApi {
|
|
|
36626
37083
|
/**
|
|
36627
37084
|
* Locations service.
|
|
36628
37085
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36629
|
-
* @version
|
|
37086
|
+
* @version 191.0.0
|
|
36630
37087
|
*/
|
|
36631
37088
|
|
|
36632
37089
|
/**
|
|
@@ -36862,7 +37319,7 @@ class LogCaptureApi {
|
|
|
36862
37319
|
/**
|
|
36863
37320
|
* LogCapture service.
|
|
36864
37321
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
36865
|
-
* @version
|
|
37322
|
+
* @version 191.0.0
|
|
36866
37323
|
*/
|
|
36867
37324
|
|
|
36868
37325
|
/**
|
|
@@ -37062,7 +37519,7 @@ class MessagingApi {
|
|
|
37062
37519
|
/**
|
|
37063
37520
|
* Messaging service.
|
|
37064
37521
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37065
|
-
* @version
|
|
37522
|
+
* @version 191.0.0
|
|
37066
37523
|
*/
|
|
37067
37524
|
|
|
37068
37525
|
/**
|
|
@@ -37421,7 +37878,7 @@ class MobileDevicesApi {
|
|
|
37421
37878
|
/**
|
|
37422
37879
|
* MobileDevices service.
|
|
37423
37880
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37424
|
-
* @version
|
|
37881
|
+
* @version 191.0.0
|
|
37425
37882
|
*/
|
|
37426
37883
|
|
|
37427
37884
|
/**
|
|
@@ -37572,7 +38029,7 @@ class NotificationsApi {
|
|
|
37572
38029
|
/**
|
|
37573
38030
|
* Notifications service.
|
|
37574
38031
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
37575
|
-
* @version
|
|
38032
|
+
* @version 191.0.0
|
|
37576
38033
|
*/
|
|
37577
38034
|
|
|
37578
38035
|
/**
|
|
@@ -37805,7 +38262,7 @@ class OAuthApi {
|
|
|
37805
38262
|
/**
|
|
37806
38263
|
* OAuth service.
|
|
37807
38264
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37808
|
-
* @version
|
|
38265
|
+
* @version 191.0.0
|
|
37809
38266
|
*/
|
|
37810
38267
|
|
|
37811
38268
|
/**
|
|
@@ -38171,7 +38628,7 @@ class ObjectsApi {
|
|
|
38171
38628
|
/**
|
|
38172
38629
|
* Objects service.
|
|
38173
38630
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38174
|
-
* @version
|
|
38631
|
+
* @version 191.0.0
|
|
38175
38632
|
*/
|
|
38176
38633
|
|
|
38177
38634
|
/**
|
|
@@ -38441,7 +38898,7 @@ class OperationalEventsApi {
|
|
|
38441
38898
|
/**
|
|
38442
38899
|
* OperationalEvents service.
|
|
38443
38900
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38444
|
-
* @version
|
|
38901
|
+
* @version 191.0.0
|
|
38445
38902
|
*/
|
|
38446
38903
|
|
|
38447
38904
|
/**
|
|
@@ -38507,7 +38964,7 @@ class OrganizationApi {
|
|
|
38507
38964
|
/**
|
|
38508
38965
|
* Organization service.
|
|
38509
38966
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38510
|
-
* @version
|
|
38967
|
+
* @version 191.0.0
|
|
38511
38968
|
*/
|
|
38512
38969
|
|
|
38513
38970
|
/**
|
|
@@ -38664,7 +39121,7 @@ class OrganizationApi {
|
|
|
38664
39121
|
}
|
|
38665
39122
|
|
|
38666
39123
|
/**
|
|
38667
|
-
* Get
|
|
39124
|
+
* Get limit documentation
|
|
38668
39125
|
*
|
|
38669
39126
|
*/
|
|
38670
39127
|
getOrganizationsLimitsDocs() {
|
|
@@ -38962,7 +39419,7 @@ class OrganizationAuthorizationApi {
|
|
|
38962
39419
|
/**
|
|
38963
39420
|
* OrganizationAuthorization service.
|
|
38964
39421
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38965
|
-
* @version
|
|
39422
|
+
* @version 191.0.0
|
|
38966
39423
|
*/
|
|
38967
39424
|
|
|
38968
39425
|
/**
|
|
@@ -40309,7 +40766,7 @@ class OutboundApi {
|
|
|
40309
40766
|
/**
|
|
40310
40767
|
* Outbound service.
|
|
40311
40768
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40312
|
-
* @version
|
|
40769
|
+
* @version 191.0.0
|
|
40313
40770
|
*/
|
|
40314
40771
|
|
|
40315
40772
|
/**
|
|
@@ -44550,7 +45007,7 @@ class PresenceApi {
|
|
|
44550
45007
|
/**
|
|
44551
45008
|
* Presence service.
|
|
44552
45009
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
44553
|
-
* @version
|
|
45010
|
+
* @version 191.0.0
|
|
44554
45011
|
*/
|
|
44555
45012
|
|
|
44556
45013
|
/**
|
|
@@ -45294,7 +45751,7 @@ class ProcessAutomationApi {
|
|
|
45294
45751
|
/**
|
|
45295
45752
|
* ProcessAutomation service.
|
|
45296
45753
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45297
|
-
* @version
|
|
45754
|
+
* @version 191.0.0
|
|
45298
45755
|
*/
|
|
45299
45756
|
|
|
45300
45757
|
/**
|
|
@@ -45533,7 +45990,7 @@ class QualityApi {
|
|
|
45533
45990
|
/**
|
|
45534
45991
|
* Quality service.
|
|
45535
45992
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
45536
|
-
* @version
|
|
45993
|
+
* @version 191.0.0
|
|
45537
45994
|
*/
|
|
45538
45995
|
|
|
45539
45996
|
/**
|
|
@@ -47290,7 +47747,7 @@ class RecordingApi {
|
|
|
47290
47747
|
/**
|
|
47291
47748
|
* Recording service.
|
|
47292
47749
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47293
|
-
* @version
|
|
47750
|
+
* @version 191.0.0
|
|
47294
47751
|
*/
|
|
47295
47752
|
|
|
47296
47753
|
/**
|
|
@@ -48176,10 +48633,11 @@ class RecordingApi {
|
|
|
48176
48633
|
|
|
48177
48634
|
/**
|
|
48178
48635
|
* Retrieves a paged listing of screen recording sessions
|
|
48179
|
-
*
|
|
48636
|
+
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
48180
48637
|
* @param {Object} opts Optional parameters
|
|
48181
48638
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
48182
48639
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
48640
|
+
* @deprecated
|
|
48183
48641
|
*/
|
|
48184
48642
|
getRecordingsScreensessions(opts) {
|
|
48185
48643
|
opts = opts || {};
|
|
@@ -48199,6 +48657,27 @@ class RecordingApi {
|
|
|
48199
48657
|
);
|
|
48200
48658
|
}
|
|
48201
48659
|
|
|
48660
|
+
/**
|
|
48661
|
+
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
48662
|
+
*
|
|
48663
|
+
* getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48664
|
+
*/
|
|
48665
|
+
getRecordingsScreensessionsDetails() {
|
|
48666
|
+
|
|
48667
|
+
return this.apiClient.callApi(
|
|
48668
|
+
'/api/v2/recordings/screensessions/details',
|
|
48669
|
+
'GET',
|
|
48670
|
+
{ },
|
|
48671
|
+
{ },
|
|
48672
|
+
{ },
|
|
48673
|
+
{ },
|
|
48674
|
+
null,
|
|
48675
|
+
['PureCloud OAuth'],
|
|
48676
|
+
['application/json'],
|
|
48677
|
+
['application/json']
|
|
48678
|
+
);
|
|
48679
|
+
}
|
|
48680
|
+
|
|
48202
48681
|
/**
|
|
48203
48682
|
* Patch a media retention policy
|
|
48204
48683
|
*
|
|
@@ -48927,7 +49406,7 @@ class ResponseManagementApi {
|
|
|
48927
49406
|
/**
|
|
48928
49407
|
* ResponseManagement service.
|
|
48929
49408
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
48930
|
-
* @version
|
|
49409
|
+
* @version 191.0.0
|
|
48931
49410
|
*/
|
|
48932
49411
|
|
|
48933
49412
|
/**
|
|
@@ -49204,6 +49683,31 @@ class ResponseManagementApi {
|
|
|
49204
49683
|
);
|
|
49205
49684
|
}
|
|
49206
49685
|
|
|
49686
|
+
/**
|
|
49687
|
+
* Get response libraries.
|
|
49688
|
+
*
|
|
49689
|
+
* @param {Object} body LibraryIDs (max allowed 50)
|
|
49690
|
+
*/
|
|
49691
|
+
postResponsemanagementLibrariesBulk(body) {
|
|
49692
|
+
// verify the required parameter 'body' is set
|
|
49693
|
+
if (body === undefined || body === null) {
|
|
49694
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementLibrariesBulk';
|
|
49695
|
+
}
|
|
49696
|
+
|
|
49697
|
+
return this.apiClient.callApi(
|
|
49698
|
+
'/api/v2/responsemanagement/libraries/bulk',
|
|
49699
|
+
'POST',
|
|
49700
|
+
{ },
|
|
49701
|
+
{ },
|
|
49702
|
+
{ },
|
|
49703
|
+
{ },
|
|
49704
|
+
body,
|
|
49705
|
+
['PureCloud OAuth'],
|
|
49706
|
+
['application/json'],
|
|
49707
|
+
['application/json']
|
|
49708
|
+
);
|
|
49709
|
+
}
|
|
49710
|
+
|
|
49207
49711
|
/**
|
|
49208
49712
|
* Search response assets
|
|
49209
49713
|
*
|
|
@@ -49412,7 +49916,7 @@ class RoutingApi {
|
|
|
49412
49916
|
/**
|
|
49413
49917
|
* Routing service.
|
|
49414
49918
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
49415
|
-
* @version
|
|
49919
|
+
* @version 191.0.0
|
|
49416
49920
|
*/
|
|
49417
49921
|
|
|
49418
49922
|
/**
|
|
@@ -50860,11 +51364,12 @@ class RoutingApi {
|
|
|
50860
51364
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50861
51365
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50862
51366
|
* @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
|
|
50863
|
-
* @param {String} opts.name
|
|
50864
|
-
* @param {Array.<String>} opts.id
|
|
50865
|
-
* @param {Array.<String>} opts.divisionId
|
|
50866
|
-
* @param {Array.<String>} opts.peerId
|
|
50867
|
-
* @param {
|
|
51367
|
+
* @param {String} opts.name Include only queues with the given name (leading and trailing asterisks allowed)
|
|
51368
|
+
* @param {Array.<String>} opts.id Include only queues with the specified ID(s)
|
|
51369
|
+
* @param {Array.<String>} opts.divisionId Include only queues in the specified division ID(s)
|
|
51370
|
+
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
51371
|
+
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
51372
|
+
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
50868
51373
|
*/
|
|
50869
51374
|
getRoutingQueues(opts) {
|
|
50870
51375
|
opts = opts || {};
|
|
@@ -50874,7 +51379,7 @@ class RoutingApi {
|
|
|
50874
51379
|
'/api/v2/routing/queues',
|
|
50875
51380
|
'GET',
|
|
50876
51381
|
{ },
|
|
50877
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
|
|
51382
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'cannedResponseLibraryId': opts['cannedResponseLibraryId'],'hasPeer': opts['hasPeer'] },
|
|
50878
51383
|
{ },
|
|
50879
51384
|
{ },
|
|
50880
51385
|
null,
|
|
@@ -52816,6 +53321,32 @@ class RoutingApi {
|
|
|
52816
53321
|
);
|
|
52817
53322
|
}
|
|
52818
53323
|
|
|
53324
|
+
/**
|
|
53325
|
+
* Provision an alphanumeric number for SMS
|
|
53326
|
+
*
|
|
53327
|
+
* @param {Object} body SmsPhoneNumber
|
|
53328
|
+
* postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53329
|
+
*/
|
|
53330
|
+
postRoutingSmsPhonenumbersAlphanumeric(body) {
|
|
53331
|
+
// verify the required parameter 'body' is set
|
|
53332
|
+
if (body === undefined || body === null) {
|
|
53333
|
+
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersAlphanumeric';
|
|
53334
|
+
}
|
|
53335
|
+
|
|
53336
|
+
return this.apiClient.callApi(
|
|
53337
|
+
'/api/v2/routing/sms/phonenumbers/alphanumeric',
|
|
53338
|
+
'POST',
|
|
53339
|
+
{ },
|
|
53340
|
+
{ },
|
|
53341
|
+
{ },
|
|
53342
|
+
{ },
|
|
53343
|
+
body,
|
|
53344
|
+
['PureCloud OAuth'],
|
|
53345
|
+
['application/json'],
|
|
53346
|
+
['application/json']
|
|
53347
|
+
);
|
|
53348
|
+
}
|
|
53349
|
+
|
|
52819
53350
|
/**
|
|
52820
53351
|
* Imports a phone number for SMS
|
|
52821
53352
|
*
|
|
@@ -53365,7 +53896,7 @@ class SCIMApi {
|
|
|
53365
53896
|
/**
|
|
53366
53897
|
* SCIM service.
|
|
53367
53898
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
53368
|
-
* @version
|
|
53899
|
+
* @version 191.0.0
|
|
53369
53900
|
*/
|
|
53370
53901
|
|
|
53371
53902
|
/**
|
|
@@ -54242,7 +54773,7 @@ class ScreenRecordingApi {
|
|
|
54242
54773
|
/**
|
|
54243
54774
|
* ScreenRecording service.
|
|
54244
54775
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54245
|
-
* @version
|
|
54776
|
+
* @version 191.0.0
|
|
54246
54777
|
*/
|
|
54247
54778
|
|
|
54248
54779
|
/**
|
|
@@ -54287,7 +54818,7 @@ class ScriptsApi {
|
|
|
54287
54818
|
/**
|
|
54288
54819
|
* Scripts service.
|
|
54289
54820
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54290
|
-
* @version
|
|
54821
|
+
* @version 191.0.0
|
|
54291
54822
|
*/
|
|
54292
54823
|
|
|
54293
54824
|
/**
|
|
@@ -54731,7 +55262,7 @@ class SearchApi {
|
|
|
54731
55262
|
/**
|
|
54732
55263
|
* Search service.
|
|
54733
55264
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
54734
|
-
* @version
|
|
55265
|
+
* @version 191.0.0
|
|
54735
55266
|
*/
|
|
54736
55267
|
|
|
54737
55268
|
/**
|
|
@@ -55420,7 +55951,7 @@ class SettingsApi {
|
|
|
55420
55951
|
/**
|
|
55421
55952
|
* Settings service.
|
|
55422
55953
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
55423
|
-
* @version
|
|
55954
|
+
* @version 191.0.0
|
|
55424
55955
|
*/
|
|
55425
55956
|
|
|
55426
55957
|
/**
|
|
@@ -55532,7 +56063,7 @@ class SpeechTextAnalyticsApi {
|
|
|
55532
56063
|
/**
|
|
55533
56064
|
* SpeechTextAnalytics service.
|
|
55534
56065
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
55535
|
-
* @version
|
|
56066
|
+
* @version 191.0.0
|
|
55536
56067
|
*/
|
|
55537
56068
|
|
|
55538
56069
|
/**
|
|
@@ -56646,7 +57177,7 @@ class StationsApi {
|
|
|
56646
57177
|
/**
|
|
56647
57178
|
* Stations service.
|
|
56648
57179
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
56649
|
-
* @version
|
|
57180
|
+
* @version 191.0.0
|
|
56650
57181
|
*/
|
|
56651
57182
|
|
|
56652
57183
|
/**
|
|
@@ -56748,7 +57279,7 @@ class SuggestApi {
|
|
|
56748
57279
|
/**
|
|
56749
57280
|
* Suggest service.
|
|
56750
57281
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
56751
|
-
* @version
|
|
57282
|
+
* @version 191.0.0
|
|
56752
57283
|
*/
|
|
56753
57284
|
|
|
56754
57285
|
/**
|
|
@@ -56887,7 +57418,7 @@ class TaskManagementApi {
|
|
|
56887
57418
|
/**
|
|
56888
57419
|
* TaskManagement service.
|
|
56889
57420
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
56890
|
-
* @version
|
|
57421
|
+
* @version 191.0.0
|
|
56891
57422
|
*/
|
|
56892
57423
|
|
|
56893
57424
|
/**
|
|
@@ -58194,7 +58725,7 @@ class TeamsApi {
|
|
|
58194
58725
|
/**
|
|
58195
58726
|
* Teams service.
|
|
58196
58727
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
58197
|
-
* @version
|
|
58728
|
+
* @version 191.0.0
|
|
58198
58729
|
*/
|
|
58199
58730
|
|
|
58200
58731
|
/**
|
|
@@ -58496,7 +59027,7 @@ class TelephonyApi {
|
|
|
58496
59027
|
/**
|
|
58497
59028
|
* Telephony service.
|
|
58498
59029
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
58499
|
-
* @version
|
|
59030
|
+
* @version 191.0.0
|
|
58500
59031
|
*/
|
|
58501
59032
|
|
|
58502
59033
|
/**
|
|
@@ -58678,7 +59209,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
58678
59209
|
/**
|
|
58679
59210
|
* TelephonyProvidersEdge service.
|
|
58680
59211
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
58681
|
-
* @version
|
|
59212
|
+
* @version 191.0.0
|
|
58682
59213
|
*/
|
|
58683
59214
|
|
|
58684
59215
|
/**
|
|
@@ -62027,7 +62558,7 @@ class TextbotsApi {
|
|
|
62027
62558
|
/**
|
|
62028
62559
|
* Textbots service.
|
|
62029
62560
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62030
|
-
* @version
|
|
62561
|
+
* @version 191.0.0
|
|
62031
62562
|
*/
|
|
62032
62563
|
|
|
62033
62564
|
/**
|
|
@@ -62155,7 +62686,7 @@ class TokensApi {
|
|
|
62155
62686
|
/**
|
|
62156
62687
|
* Tokens service.
|
|
62157
62688
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62158
|
-
* @version
|
|
62689
|
+
* @version 191.0.0
|
|
62159
62690
|
*/
|
|
62160
62691
|
|
|
62161
62692
|
/**
|
|
@@ -62309,7 +62840,7 @@ class UploadsApi {
|
|
|
62309
62840
|
/**
|
|
62310
62841
|
* Uploads service.
|
|
62311
62842
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
62312
|
-
* @version
|
|
62843
|
+
* @version 191.0.0
|
|
62313
62844
|
*/
|
|
62314
62845
|
|
|
62315
62846
|
/**
|
|
@@ -62578,7 +63109,7 @@ class UsageApi {
|
|
|
62578
63109
|
/**
|
|
62579
63110
|
* Usage service.
|
|
62580
63111
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
62581
|
-
* @version
|
|
63112
|
+
* @version 191.0.0
|
|
62582
63113
|
*/
|
|
62583
63114
|
|
|
62584
63115
|
/**
|
|
@@ -62678,7 +63209,7 @@ class UsageApi {
|
|
|
62678
63209
|
}
|
|
62679
63210
|
|
|
62680
63211
|
/**
|
|
62681
|
-
* Get the results of a usage search
|
|
63212
|
+
* Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
|
|
62682
63213
|
*
|
|
62683
63214
|
* @param {String} executionId ID of the search execution
|
|
62684
63215
|
*/
|
|
@@ -62758,8 +63289,8 @@ class UsageApi {
|
|
|
62758
63289
|
}
|
|
62759
63290
|
|
|
62760
63291
|
/**
|
|
62761
|
-
* Search organization API Usage
|
|
62762
|
-
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
63292
|
+
* Search organization API Usage
|
|
63293
|
+
* After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results
|
|
62763
63294
|
* @param {Object} body SimpleSearch
|
|
62764
63295
|
*/
|
|
62765
63296
|
postUsageSimplesearch(body) {
|
|
@@ -62788,7 +63319,7 @@ class UserRecordingsApi {
|
|
|
62788
63319
|
/**
|
|
62789
63320
|
* UserRecordings service.
|
|
62790
63321
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
62791
|
-
* @version
|
|
63322
|
+
* @version 191.0.0
|
|
62792
63323
|
*/
|
|
62793
63324
|
|
|
62794
63325
|
/**
|
|
@@ -62973,7 +63504,7 @@ class UsersApi {
|
|
|
62973
63504
|
/**
|
|
62974
63505
|
* Users service.
|
|
62975
63506
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
62976
|
-
* @version
|
|
63507
|
+
* @version 191.0.0
|
|
62977
63508
|
*/
|
|
62978
63509
|
|
|
62979
63510
|
/**
|
|
@@ -65624,7 +66155,7 @@ class UtilitiesApi {
|
|
|
65624
66155
|
/**
|
|
65625
66156
|
* Utilities service.
|
|
65626
66157
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
65627
|
-
* @version
|
|
66158
|
+
* @version 191.0.0
|
|
65628
66159
|
*/
|
|
65629
66160
|
|
|
65630
66161
|
/**
|
|
@@ -65735,7 +66266,7 @@ class VoicemailApi {
|
|
|
65735
66266
|
/**
|
|
65736
66267
|
* Voicemail service.
|
|
65737
66268
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
65738
|
-
* @version
|
|
66269
|
+
* @version 191.0.0
|
|
65739
66270
|
*/
|
|
65740
66271
|
|
|
65741
66272
|
/**
|
|
@@ -66402,7 +66933,7 @@ class WebChatApi {
|
|
|
66402
66933
|
/**
|
|
66403
66934
|
* WebChat service.
|
|
66404
66935
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
66405
|
-
* @version
|
|
66936
|
+
* @version 191.0.0
|
|
66406
66937
|
*/
|
|
66407
66938
|
|
|
66408
66939
|
/**
|
|
@@ -66951,7 +67482,7 @@ class WebDeploymentsApi {
|
|
|
66951
67482
|
/**
|
|
66952
67483
|
* WebDeployments service.
|
|
66953
67484
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
66954
|
-
* @version
|
|
67485
|
+
* @version 191.0.0
|
|
66955
67486
|
*/
|
|
66956
67487
|
|
|
66957
67488
|
/**
|
|
@@ -67478,7 +68009,7 @@ class WebMessagingApi {
|
|
|
67478
68009
|
/**
|
|
67479
68010
|
* WebMessaging service.
|
|
67480
68011
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
67481
|
-
* @version
|
|
68012
|
+
* @version 191.0.0
|
|
67482
68013
|
*/
|
|
67483
68014
|
|
|
67484
68015
|
/**
|
|
@@ -67524,7 +68055,7 @@ class WidgetsApi {
|
|
|
67524
68055
|
/**
|
|
67525
68056
|
* Widgets service.
|
|
67526
68057
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
67527
|
-
* @version
|
|
68058
|
+
* @version 191.0.0
|
|
67528
68059
|
*/
|
|
67529
68060
|
|
|
67530
68061
|
/**
|
|
@@ -67670,7 +68201,7 @@ class WorkforceManagementApi {
|
|
|
67670
68201
|
/**
|
|
67671
68202
|
* WorkforceManagement service.
|
|
67672
68203
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
67673
|
-
* @version
|
|
68204
|
+
* @version 191.0.0
|
|
67674
68205
|
*/
|
|
67675
68206
|
|
|
67676
68207
|
/**
|
|
@@ -67830,6 +68361,96 @@ class WorkforceManagementApi {
|
|
|
67830
68361
|
);
|
|
67831
68362
|
}
|
|
67832
68363
|
|
|
68364
|
+
/**
|
|
68365
|
+
* Deletes a staffing group
|
|
68366
|
+
*
|
|
68367
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68368
|
+
* @param {String} staffingGroupId The ID of the staffing group to delete
|
|
68369
|
+
*/
|
|
68370
|
+
deleteWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
|
|
68371
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68372
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68373
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
|
|
68374
|
+
}
|
|
68375
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
68376
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
68377
|
+
throw 'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
|
|
68378
|
+
}
|
|
68379
|
+
|
|
68380
|
+
return this.apiClient.callApi(
|
|
68381
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
68382
|
+
'DELETE',
|
|
68383
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
68384
|
+
{ },
|
|
68385
|
+
{ },
|
|
68386
|
+
{ },
|
|
68387
|
+
null,
|
|
68388
|
+
['PureCloud OAuth'],
|
|
68389
|
+
['application/json'],
|
|
68390
|
+
['application/json']
|
|
68391
|
+
);
|
|
68392
|
+
}
|
|
68393
|
+
|
|
68394
|
+
/**
|
|
68395
|
+
* Deletes a time-off limit object
|
|
68396
|
+
*
|
|
68397
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68398
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to delete
|
|
68399
|
+
*/
|
|
68400
|
+
deleteWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
|
|
68401
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68402
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68403
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
|
|
68404
|
+
}
|
|
68405
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
68406
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
68407
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
|
|
68408
|
+
}
|
|
68409
|
+
|
|
68410
|
+
return this.apiClient.callApi(
|
|
68411
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
|
|
68412
|
+
'DELETE',
|
|
68413
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
68414
|
+
{ },
|
|
68415
|
+
{ },
|
|
68416
|
+
{ },
|
|
68417
|
+
null,
|
|
68418
|
+
['PureCloud OAuth'],
|
|
68419
|
+
['application/json'],
|
|
68420
|
+
['application/json']
|
|
68421
|
+
);
|
|
68422
|
+
}
|
|
68423
|
+
|
|
68424
|
+
/**
|
|
68425
|
+
* Deletes a time-off plan
|
|
68426
|
+
*
|
|
68427
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68428
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to delete
|
|
68429
|
+
*/
|
|
68430
|
+
deleteWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
|
|
68431
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68432
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68433
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
|
|
68434
|
+
}
|
|
68435
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
68436
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
68437
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
|
|
68438
|
+
}
|
|
68439
|
+
|
|
68440
|
+
return this.apiClient.callApi(
|
|
68441
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
68442
|
+
'DELETE',
|
|
68443
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
68444
|
+
{ },
|
|
68445
|
+
{ },
|
|
68446
|
+
{ },
|
|
68447
|
+
null,
|
|
68448
|
+
['PureCloud OAuth'],
|
|
68449
|
+
['application/json'],
|
|
68450
|
+
['application/json']
|
|
68451
|
+
);
|
|
68452
|
+
}
|
|
68453
|
+
|
|
67833
68454
|
/**
|
|
67834
68455
|
* Delete a schedule
|
|
67835
68456
|
*
|
|
@@ -68652,6 +69273,184 @@ class WorkforceManagementApi {
|
|
|
68652
69273
|
);
|
|
68653
69274
|
}
|
|
68654
69275
|
|
|
69276
|
+
/**
|
|
69277
|
+
* Gets a staffing group
|
|
69278
|
+
*
|
|
69279
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69280
|
+
* @param {String} staffingGroupId The ID of the staffing group to fetch
|
|
69281
|
+
*/
|
|
69282
|
+
getWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
|
|
69283
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69284
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69285
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
|
|
69286
|
+
}
|
|
69287
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
69288
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
69289
|
+
throw 'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
|
|
69290
|
+
}
|
|
69291
|
+
|
|
69292
|
+
return this.apiClient.callApi(
|
|
69293
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
69294
|
+
'GET',
|
|
69295
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
69296
|
+
{ },
|
|
69297
|
+
{ },
|
|
69298
|
+
{ },
|
|
69299
|
+
null,
|
|
69300
|
+
['PureCloud OAuth'],
|
|
69301
|
+
['application/json'],
|
|
69302
|
+
['application/json']
|
|
69303
|
+
);
|
|
69304
|
+
}
|
|
69305
|
+
|
|
69306
|
+
/**
|
|
69307
|
+
* Gets a list of staffing groups
|
|
69308
|
+
*
|
|
69309
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69310
|
+
* @param {Object} opts Optional parameters
|
|
69311
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
69312
|
+
*/
|
|
69313
|
+
getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
69314
|
+
opts = opts || {};
|
|
69315
|
+
|
|
69316
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69317
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69318
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';
|
|
69319
|
+
}
|
|
69320
|
+
|
|
69321
|
+
return this.apiClient.callApi(
|
|
69322
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
69323
|
+
'GET',
|
|
69324
|
+
{ 'businessUnitId': businessUnitId },
|
|
69325
|
+
{ 'managementUnitId': opts['managementUnitId'] },
|
|
69326
|
+
{ },
|
|
69327
|
+
{ },
|
|
69328
|
+
null,
|
|
69329
|
+
['PureCloud OAuth'],
|
|
69330
|
+
['application/json'],
|
|
69331
|
+
['application/json']
|
|
69332
|
+
);
|
|
69333
|
+
}
|
|
69334
|
+
|
|
69335
|
+
/**
|
|
69336
|
+
* Gets a time-off limit object
|
|
69337
|
+
* Returns properties of time-off limit object, but not daily values
|
|
69338
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69339
|
+
* @param {String} timeOffLimitId The ID of the time-off limit to fetch
|
|
69340
|
+
*/
|
|
69341
|
+
getWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
|
|
69342
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69343
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69344
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
|
|
69345
|
+
}
|
|
69346
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
69347
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
69348
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
|
|
69349
|
+
}
|
|
69350
|
+
|
|
69351
|
+
return this.apiClient.callApi(
|
|
69352
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
|
|
69353
|
+
'GET',
|
|
69354
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
69355
|
+
{ },
|
|
69356
|
+
{ },
|
|
69357
|
+
{ },
|
|
69358
|
+
null,
|
|
69359
|
+
['PureCloud OAuth'],
|
|
69360
|
+
['application/json'],
|
|
69361
|
+
['application/json']
|
|
69362
|
+
);
|
|
69363
|
+
}
|
|
69364
|
+
|
|
69365
|
+
/**
|
|
69366
|
+
* Gets a list of time-off limit objects
|
|
69367
|
+
*
|
|
69368
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69369
|
+
* @param {Object} opts Optional parameters
|
|
69370
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific time-off limit objects
|
|
69371
|
+
*/
|
|
69372
|
+
getWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
|
|
69373
|
+
opts = opts || {};
|
|
69374
|
+
|
|
69375
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69376
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69377
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';
|
|
69378
|
+
}
|
|
69379
|
+
|
|
69380
|
+
return this.apiClient.callApi(
|
|
69381
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
69382
|
+
'GET',
|
|
69383
|
+
{ 'businessUnitId': businessUnitId },
|
|
69384
|
+
{ 'managementUnitId': opts['managementUnitId'] },
|
|
69385
|
+
{ },
|
|
69386
|
+
{ },
|
|
69387
|
+
null,
|
|
69388
|
+
['PureCloud OAuth'],
|
|
69389
|
+
['application/json'],
|
|
69390
|
+
['application/json']
|
|
69391
|
+
);
|
|
69392
|
+
}
|
|
69393
|
+
|
|
69394
|
+
/**
|
|
69395
|
+
* Gets a time-off plan
|
|
69396
|
+
*
|
|
69397
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69398
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to fetch
|
|
69399
|
+
*/
|
|
69400
|
+
getWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
|
|
69401
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69402
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69403
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
|
|
69404
|
+
}
|
|
69405
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
69406
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
69407
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
|
|
69408
|
+
}
|
|
69409
|
+
|
|
69410
|
+
return this.apiClient.callApi(
|
|
69411
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
69412
|
+
'GET',
|
|
69413
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
69414
|
+
{ },
|
|
69415
|
+
{ },
|
|
69416
|
+
{ },
|
|
69417
|
+
null,
|
|
69418
|
+
['PureCloud OAuth'],
|
|
69419
|
+
['application/json'],
|
|
69420
|
+
['application/json']
|
|
69421
|
+
);
|
|
69422
|
+
}
|
|
69423
|
+
|
|
69424
|
+
/**
|
|
69425
|
+
* Gets a list of time-off plans
|
|
69426
|
+
*
|
|
69427
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69428
|
+
* @param {Object} opts Optional parameters
|
|
69429
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
69430
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
69431
|
+
*/
|
|
69432
|
+
getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
69433
|
+
opts = opts || {};
|
|
69434
|
+
|
|
69435
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69436
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69437
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';
|
|
69438
|
+
}
|
|
69439
|
+
|
|
69440
|
+
return this.apiClient.callApi(
|
|
69441
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
69442
|
+
'GET',
|
|
69443
|
+
{ 'businessUnitId': businessUnitId },
|
|
69444
|
+
{ 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
|
|
69445
|
+
{ },
|
|
69446
|
+
{ },
|
|
69447
|
+
null,
|
|
69448
|
+
['PureCloud OAuth'],
|
|
69449
|
+
['application/json'],
|
|
69450
|
+
['application/json']
|
|
69451
|
+
);
|
|
69452
|
+
}
|
|
69453
|
+
|
|
68655
69454
|
/**
|
|
68656
69455
|
* Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
|
|
68657
69456
|
*
|
|
@@ -70464,6 +71263,74 @@ class WorkforceManagementApi {
|
|
|
70464
71263
|
);
|
|
70465
71264
|
}
|
|
70466
71265
|
|
|
71266
|
+
/**
|
|
71267
|
+
* Updates a staffing group
|
|
71268
|
+
*
|
|
71269
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71270
|
+
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
71271
|
+
* @param {Object} opts Optional parameters
|
|
71272
|
+
* @param {Object} opts.body body
|
|
71273
|
+
*/
|
|
71274
|
+
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, opts) {
|
|
71275
|
+
opts = opts || {};
|
|
71276
|
+
|
|
71277
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71278
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71279
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
71280
|
+
}
|
|
71281
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
71282
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
71283
|
+
throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
71284
|
+
}
|
|
71285
|
+
|
|
71286
|
+
return this.apiClient.callApi(
|
|
71287
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
71288
|
+
'PATCH',
|
|
71289
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
71290
|
+
{ },
|
|
71291
|
+
{ },
|
|
71292
|
+
{ },
|
|
71293
|
+
opts['body'],
|
|
71294
|
+
['PureCloud OAuth'],
|
|
71295
|
+
['application/json'],
|
|
71296
|
+
['application/json']
|
|
71297
|
+
);
|
|
71298
|
+
}
|
|
71299
|
+
|
|
71300
|
+
/**
|
|
71301
|
+
* Updates a time-off plan
|
|
71302
|
+
*
|
|
71303
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71304
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
71305
|
+
* @param {Object} opts Optional parameters
|
|
71306
|
+
* @param {Object} opts.body body
|
|
71307
|
+
*/
|
|
71308
|
+
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, opts) {
|
|
71309
|
+
opts = opts || {};
|
|
71310
|
+
|
|
71311
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71312
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71313
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
71314
|
+
}
|
|
71315
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
71316
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
71317
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
71318
|
+
}
|
|
71319
|
+
|
|
71320
|
+
return this.apiClient.callApi(
|
|
71321
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
71322
|
+
'PATCH',
|
|
71323
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
71324
|
+
{ },
|
|
71325
|
+
{ },
|
|
71326
|
+
{ },
|
|
71327
|
+
opts['body'],
|
|
71328
|
+
['PureCloud OAuth'],
|
|
71329
|
+
['application/json'],
|
|
71330
|
+
['application/json']
|
|
71331
|
+
);
|
|
71332
|
+
}
|
|
71333
|
+
|
|
70467
71334
|
/**
|
|
70468
71335
|
* Update the requested management unit
|
|
70469
71336
|
*
|
|
@@ -71255,6 +72122,151 @@ class WorkforceManagementApi {
|
|
|
71255
72122
|
);
|
|
71256
72123
|
}
|
|
71257
72124
|
|
|
72125
|
+
/**
|
|
72126
|
+
* Creates a new staffing group
|
|
72127
|
+
*
|
|
72128
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72129
|
+
* @param {Object} opts Optional parameters
|
|
72130
|
+
* @param {Object} opts.body body
|
|
72131
|
+
*/
|
|
72132
|
+
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
72133
|
+
opts = opts || {};
|
|
72134
|
+
|
|
72135
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72136
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72137
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
72138
|
+
}
|
|
72139
|
+
|
|
72140
|
+
return this.apiClient.callApi(
|
|
72141
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
72142
|
+
'POST',
|
|
72143
|
+
{ 'businessUnitId': businessUnitId },
|
|
72144
|
+
{ },
|
|
72145
|
+
{ },
|
|
72146
|
+
{ },
|
|
72147
|
+
opts['body'],
|
|
72148
|
+
['PureCloud OAuth'],
|
|
72149
|
+
['application/json'],
|
|
72150
|
+
['application/json']
|
|
72151
|
+
);
|
|
72152
|
+
}
|
|
72153
|
+
|
|
72154
|
+
/**
|
|
72155
|
+
* Gets staffing group associations for a list of user IDs
|
|
72156
|
+
*
|
|
72157
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72158
|
+
* @param {Object} opts Optional parameters
|
|
72159
|
+
* @param {Object} opts.body body
|
|
72160
|
+
*/
|
|
72161
|
+
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, opts) {
|
|
72162
|
+
opts = opts || {};
|
|
72163
|
+
|
|
72164
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72165
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72166
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
72167
|
+
}
|
|
72168
|
+
|
|
72169
|
+
return this.apiClient.callApi(
|
|
72170
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
|
|
72171
|
+
'POST',
|
|
72172
|
+
{ 'businessUnitId': businessUnitId },
|
|
72173
|
+
{ },
|
|
72174
|
+
{ },
|
|
72175
|
+
{ },
|
|
72176
|
+
opts['body'],
|
|
72177
|
+
['PureCloud OAuth'],
|
|
72178
|
+
['application/json'],
|
|
72179
|
+
['application/json']
|
|
72180
|
+
);
|
|
72181
|
+
}
|
|
72182
|
+
|
|
72183
|
+
/**
|
|
72184
|
+
* Creates a new time-off limit object
|
|
72185
|
+
*
|
|
72186
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72187
|
+
* @param {Object} opts Optional parameters
|
|
72188
|
+
* @param {Object} opts.body body
|
|
72189
|
+
*/
|
|
72190
|
+
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
|
|
72191
|
+
opts = opts || {};
|
|
72192
|
+
|
|
72193
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72194
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72195
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
72196
|
+
}
|
|
72197
|
+
|
|
72198
|
+
return this.apiClient.callApi(
|
|
72199
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
72200
|
+
'POST',
|
|
72201
|
+
{ 'businessUnitId': businessUnitId },
|
|
72202
|
+
{ },
|
|
72203
|
+
{ },
|
|
72204
|
+
{ },
|
|
72205
|
+
opts['body'],
|
|
72206
|
+
['PureCloud OAuth'],
|
|
72207
|
+
['application/json'],
|
|
72208
|
+
['application/json']
|
|
72209
|
+
);
|
|
72210
|
+
}
|
|
72211
|
+
|
|
72212
|
+
/**
|
|
72213
|
+
* Retrieves time-off limit related values based on a given set of filters.
|
|
72214
|
+
*
|
|
72215
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72216
|
+
* @param {Object} opts Optional parameters
|
|
72217
|
+
* @param {Object} opts.body body
|
|
72218
|
+
*/
|
|
72219
|
+
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId, opts) {
|
|
72220
|
+
opts = opts || {};
|
|
72221
|
+
|
|
72222
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72223
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72224
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
72225
|
+
}
|
|
72226
|
+
|
|
72227
|
+
return this.apiClient.callApi(
|
|
72228
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query',
|
|
72229
|
+
'POST',
|
|
72230
|
+
{ 'businessUnitId': businessUnitId },
|
|
72231
|
+
{ },
|
|
72232
|
+
{ },
|
|
72233
|
+
{ },
|
|
72234
|
+
opts['body'],
|
|
72235
|
+
['PureCloud OAuth'],
|
|
72236
|
+
['application/json'],
|
|
72237
|
+
['application/json']
|
|
72238
|
+
);
|
|
72239
|
+
}
|
|
72240
|
+
|
|
72241
|
+
/**
|
|
72242
|
+
* Creates a new time-off plan
|
|
72243
|
+
*
|
|
72244
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72245
|
+
* @param {Object} opts Optional parameters
|
|
72246
|
+
* @param {Object} opts.body body
|
|
72247
|
+
*/
|
|
72248
|
+
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
72249
|
+
opts = opts || {};
|
|
72250
|
+
|
|
72251
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72252
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72253
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
72254
|
+
}
|
|
72255
|
+
|
|
72256
|
+
return this.apiClient.callApi(
|
|
72257
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
72258
|
+
'POST',
|
|
72259
|
+
{ 'businessUnitId': businessUnitId },
|
|
72260
|
+
{ },
|
|
72261
|
+
{ },
|
|
72262
|
+
{ },
|
|
72263
|
+
opts['body'],
|
|
72264
|
+
['PureCloud OAuth'],
|
|
72265
|
+
['application/json'],
|
|
72266
|
+
['application/json']
|
|
72267
|
+
);
|
|
72268
|
+
}
|
|
72269
|
+
|
|
71258
72270
|
/**
|
|
71259
72271
|
* Loads agent schedule data from the schedule. Used in combination with the metadata route
|
|
71260
72272
|
*
|
|
@@ -73001,6 +74013,40 @@ class WorkforceManagementApi {
|
|
|
73001
74013
|
);
|
|
73002
74014
|
}
|
|
73003
74015
|
|
|
74016
|
+
/**
|
|
74017
|
+
* Sets daily values for a date range of time-off limit object
|
|
74018
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
74019
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
74020
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
74021
|
+
* @param {Object} opts Optional parameters
|
|
74022
|
+
* @param {Object} opts.body body
|
|
74023
|
+
*/
|
|
74024
|
+
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId, opts) {
|
|
74025
|
+
opts = opts || {};
|
|
74026
|
+
|
|
74027
|
+
// verify the required parameter 'businessUnitId' is set
|
|
74028
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
74029
|
+
throw 'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
74030
|
+
}
|
|
74031
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
74032
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
74033
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
74034
|
+
}
|
|
74035
|
+
|
|
74036
|
+
return this.apiClient.callApi(
|
|
74037
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
74038
|
+
'PUT',
|
|
74039
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
74040
|
+
{ },
|
|
74041
|
+
{ },
|
|
74042
|
+
{ },
|
|
74043
|
+
opts['body'],
|
|
74044
|
+
['PureCloud OAuth'],
|
|
74045
|
+
['application/json'],
|
|
74046
|
+
['application/json']
|
|
74047
|
+
);
|
|
74048
|
+
}
|
|
74049
|
+
|
|
73004
74050
|
/**
|
|
73005
74051
|
* Sets daily values for a date range of time off limit object
|
|
73006
74052
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
@@ -73066,7 +74112,7 @@ class WorkforceManagementApi {
|
|
|
73066
74112
|
* </pre>
|
|
73067
74113
|
* </p>
|
|
73068
74114
|
* @module purecloud-platform-client-v2/index
|
|
73069
|
-
* @version
|
|
74115
|
+
* @version 191.0.0
|
|
73070
74116
|
*/
|
|
73071
74117
|
class platformClient {
|
|
73072
74118
|
constructor() {
|