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
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 191.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1818,7 +1818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1818
1818
|
/**
|
|
1819
1819
|
* Alerting service.
|
|
1820
1820
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1821
|
-
* @version
|
|
1821
|
+
* @version 191.0.0
|
|
1822
1822
|
*/
|
|
1823
1823
|
|
|
1824
1824
|
/**
|
|
@@ -2479,7 +2479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2479
2479
|
/**
|
|
2480
2480
|
* Analytics service.
|
|
2481
2481
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2482
|
-
* @version
|
|
2482
|
+
* @version 191.0.0
|
|
2483
2483
|
*/
|
|
2484
2484
|
|
|
2485
2485
|
/**
|
|
@@ -3229,6 +3229,59 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3229
3229
|
);
|
|
3230
3230
|
}
|
|
3231
3231
|
|
|
3232
|
+
/**
|
|
3233
|
+
* Get dashboards summary for a user
|
|
3234
|
+
*
|
|
3235
|
+
* @param {String} userId User ID
|
|
3236
|
+
*/
|
|
3237
|
+
getAnalyticsReportingDashboardsUser(userId) {
|
|
3238
|
+
// verify the required parameter 'userId' is set
|
|
3239
|
+
if (userId === undefined || userId === null) {
|
|
3240
|
+
throw 'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';
|
|
3241
|
+
}
|
|
3242
|
+
|
|
3243
|
+
return this.apiClient.callApi(
|
|
3244
|
+
'/api/v2/analytics/reporting/dashboards/users/{userId}',
|
|
3245
|
+
'GET',
|
|
3246
|
+
{ 'userId': userId },
|
|
3247
|
+
{ },
|
|
3248
|
+
{ },
|
|
3249
|
+
{ },
|
|
3250
|
+
null,
|
|
3251
|
+
['PureCloud OAuth'],
|
|
3252
|
+
['application/json'],
|
|
3253
|
+
['application/json']
|
|
3254
|
+
);
|
|
3255
|
+
}
|
|
3256
|
+
|
|
3257
|
+
/**
|
|
3258
|
+
* Get dashboards summary for users in a org
|
|
3259
|
+
*
|
|
3260
|
+
* @param {Object} opts Optional parameters
|
|
3261
|
+
* @param {String} opts.sortBy (default to asc)
|
|
3262
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
3263
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
3264
|
+
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
3265
|
+
* @param {Object} opts.state Only list users of this state
|
|
3266
|
+
*/
|
|
3267
|
+
getAnalyticsReportingDashboardsUsers(opts) {
|
|
3268
|
+
opts = opts || {};
|
|
3269
|
+
|
|
3270
|
+
|
|
3271
|
+
return this.apiClient.callApi(
|
|
3272
|
+
'/api/v2/analytics/reporting/dashboards/users',
|
|
3273
|
+
'GET',
|
|
3274
|
+
{ },
|
|
3275
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
|
|
3276
|
+
{ },
|
|
3277
|
+
{ },
|
|
3278
|
+
null,
|
|
3279
|
+
['PureCloud OAuth'],
|
|
3280
|
+
['application/json'],
|
|
3281
|
+
['application/json']
|
|
3282
|
+
);
|
|
3283
|
+
}
|
|
3284
|
+
|
|
3232
3285
|
/**
|
|
3233
3286
|
* Get all view export requests for a user
|
|
3234
3287
|
*
|
|
@@ -3504,6 +3557,39 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3504
3557
|
);
|
|
3505
3558
|
}
|
|
3506
3559
|
|
|
3560
|
+
/**
|
|
3561
|
+
* Get list of dashboards for an user
|
|
3562
|
+
*
|
|
3563
|
+
* @param {String} userId User ID
|
|
3564
|
+
* @param {Object} opts Optional parameters
|
|
3565
|
+
* @param {String} opts.sortBy (default to asc)
|
|
3566
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
3567
|
+
* @param {Number} opts.pageSize (default to 50)
|
|
3568
|
+
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
3569
|
+
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
3570
|
+
*/
|
|
3571
|
+
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
3572
|
+
opts = opts || {};
|
|
3573
|
+
|
|
3574
|
+
// verify the required parameter 'userId' is set
|
|
3575
|
+
if (userId === undefined || userId === null) {
|
|
3576
|
+
throw 'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';
|
|
3577
|
+
}
|
|
3578
|
+
|
|
3579
|
+
return this.apiClient.callApi(
|
|
3580
|
+
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
3581
|
+
'GET',
|
|
3582
|
+
{ 'userId': userId },
|
|
3583
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
|
|
3584
|
+
{ },
|
|
3585
|
+
{ },
|
|
3586
|
+
null,
|
|
3587
|
+
['PureCloud OAuth'],
|
|
3588
|
+
['application/json'],
|
|
3589
|
+
['application/json']
|
|
3590
|
+
);
|
|
3591
|
+
}
|
|
3592
|
+
|
|
3507
3593
|
/**
|
|
3508
3594
|
* Get a list of report time periods.
|
|
3509
3595
|
*
|
|
@@ -4554,6 +4640,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4554
4640
|
);
|
|
4555
4641
|
}
|
|
4556
4642
|
|
|
4643
|
+
/**
|
|
4644
|
+
* Bulk delete dashboards owned by other user(s)
|
|
4645
|
+
*
|
|
4646
|
+
* @param {Array.<String>} body List of userIds
|
|
4647
|
+
*/
|
|
4648
|
+
postAnalyticsReportingDashboardsUsersBulkRemove(body) {
|
|
4649
|
+
// verify the required parameter 'body' is set
|
|
4650
|
+
if (body === undefined || body === null) {
|
|
4651
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';
|
|
4652
|
+
}
|
|
4653
|
+
|
|
4654
|
+
return this.apiClient.callApi(
|
|
4655
|
+
'/api/v2/analytics/reporting/dashboards/users/bulk/remove',
|
|
4656
|
+
'POST',
|
|
4657
|
+
{ },
|
|
4658
|
+
{ },
|
|
4659
|
+
{ },
|
|
4660
|
+
{ },
|
|
4661
|
+
body,
|
|
4662
|
+
['PureCloud OAuth'],
|
|
4663
|
+
['application/json'],
|
|
4664
|
+
['application/json']
|
|
4665
|
+
);
|
|
4666
|
+
}
|
|
4667
|
+
|
|
4557
4668
|
/**
|
|
4558
4669
|
* Generate a view export request
|
|
4559
4670
|
* This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
|
|
@@ -4631,6 +4742,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4631
4742
|
);
|
|
4632
4743
|
}
|
|
4633
4744
|
|
|
4745
|
+
/**
|
|
4746
|
+
* Bulk remove dashboard configurations
|
|
4747
|
+
*
|
|
4748
|
+
* @param {Object} body
|
|
4749
|
+
*/
|
|
4750
|
+
postAnalyticsReportingSettingsDashboardsBulkRemove(body) {
|
|
4751
|
+
// verify the required parameter 'body' is set
|
|
4752
|
+
if (body === undefined || body === null) {
|
|
4753
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';
|
|
4754
|
+
}
|
|
4755
|
+
|
|
4756
|
+
return this.apiClient.callApi(
|
|
4757
|
+
'/api/v2/analytics/reporting/settings/dashboards/bulk/remove',
|
|
4758
|
+
'POST',
|
|
4759
|
+
{ },
|
|
4760
|
+
{ },
|
|
4761
|
+
{ },
|
|
4762
|
+
{ },
|
|
4763
|
+
body,
|
|
4764
|
+
['PureCloud OAuth'],
|
|
4765
|
+
['application/json'],
|
|
4766
|
+
['application/json']
|
|
4767
|
+
);
|
|
4768
|
+
}
|
|
4769
|
+
|
|
4770
|
+
/**
|
|
4771
|
+
* Query dashboard configurations
|
|
4772
|
+
*
|
|
4773
|
+
* @param {Object} body
|
|
4774
|
+
*/
|
|
4775
|
+
postAnalyticsReportingSettingsDashboardsQuery(body) {
|
|
4776
|
+
// verify the required parameter 'body' is set
|
|
4777
|
+
if (body === undefined || body === null) {
|
|
4778
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';
|
|
4779
|
+
}
|
|
4780
|
+
|
|
4781
|
+
return this.apiClient.callApi(
|
|
4782
|
+
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
4783
|
+
'POST',
|
|
4784
|
+
{ },
|
|
4785
|
+
{ },
|
|
4786
|
+
{ },
|
|
4787
|
+
{ },
|
|
4788
|
+
body,
|
|
4789
|
+
['PureCloud OAuth'],
|
|
4790
|
+
['application/json'],
|
|
4791
|
+
['application/json']
|
|
4792
|
+
);
|
|
4793
|
+
}
|
|
4794
|
+
|
|
4634
4795
|
/**
|
|
4635
4796
|
* Query for resolution aggregates asynchronously
|
|
4636
4797
|
*
|
|
@@ -5092,7 +5253,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5092
5253
|
/**
|
|
5093
5254
|
* Architect service.
|
|
5094
5255
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5095
|
-
* @version
|
|
5256
|
+
* @version 191.0.0
|
|
5096
5257
|
*/
|
|
5097
5258
|
|
|
5098
5259
|
/**
|
|
@@ -9238,7 +9399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9238
9399
|
/**
|
|
9239
9400
|
* Audit service.
|
|
9240
9401
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9241
|
-
* @version
|
|
9402
|
+
* @version 191.0.0
|
|
9242
9403
|
*/
|
|
9243
9404
|
|
|
9244
9405
|
/**
|
|
@@ -9409,7 +9570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9409
9570
|
/**
|
|
9410
9571
|
* Authorization service.
|
|
9411
9572
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9412
|
-
* @version
|
|
9573
|
+
* @version 191.0.0
|
|
9413
9574
|
*/
|
|
9414
9575
|
|
|
9415
9576
|
/**
|
|
@@ -10639,7 +10800,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10639
10800
|
/**
|
|
10640
10801
|
* Billing service.
|
|
10641
10802
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10642
|
-
* @version
|
|
10803
|
+
* @version 191.0.0
|
|
10643
10804
|
*/
|
|
10644
10805
|
|
|
10645
10806
|
/**
|
|
@@ -10719,7 +10880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10719
10880
|
/**
|
|
10720
10881
|
* CarrierServices service.
|
|
10721
10882
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10722
|
-
* @version
|
|
10883
|
+
* @version 191.0.0
|
|
10723
10884
|
*/
|
|
10724
10885
|
|
|
10725
10886
|
/**
|
|
@@ -10789,7 +10950,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10789
10950
|
/**
|
|
10790
10951
|
* Chat service.
|
|
10791
10952
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10792
|
-
* @version
|
|
10953
|
+
* @version 191.0.0
|
|
10793
10954
|
*/
|
|
10794
10955
|
|
|
10795
10956
|
/**
|
|
@@ -10809,7 +10970,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10809
10970
|
*
|
|
10810
10971
|
* @param {String} roomJid roomId
|
|
10811
10972
|
* @param {String} messageId messageId
|
|
10812
|
-
* deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10813
10973
|
*/
|
|
10814
10974
|
deleteChatsRoomMessage(roomJid, messageId) {
|
|
10815
10975
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10840,7 +11000,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10840
11000
|
*
|
|
10841
11001
|
* @param {String} roomJid roomJid
|
|
10842
11002
|
* @param {String} userId userId
|
|
10843
|
-
* deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10844
11003
|
*/
|
|
10845
11004
|
deleteChatsRoomParticipant(roomJid, userId) {
|
|
10846
11005
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10871,7 +11030,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10871
11030
|
*
|
|
10872
11031
|
* @param {String} roomJid roomJid
|
|
10873
11032
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
10874
|
-
* deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10875
11033
|
*/
|
|
10876
11034
|
deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) {
|
|
10877
11035
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10902,7 +11060,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10902
11060
|
*
|
|
10903
11061
|
* @param {String} userId userId
|
|
10904
11062
|
* @param {String} messageId messageId
|
|
10905
|
-
* deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10906
11063
|
*/
|
|
10907
11064
|
deleteChatsUserMessage(userId, messageId) {
|
|
10908
11065
|
// verify the required parameter 'userId' is set
|
|
@@ -10932,7 +11089,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10932
11089
|
* Get a message
|
|
10933
11090
|
*
|
|
10934
11091
|
* @param {String} messageId messageId
|
|
10935
|
-
* getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10936
11092
|
*/
|
|
10937
11093
|
getChatsMessage(messageId) {
|
|
10938
11094
|
// verify the required parameter 'messageId' is set
|
|
@@ -10958,7 +11114,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10958
11114
|
* Get a room
|
|
10959
11115
|
*
|
|
10960
11116
|
* @param {String} roomJid roomJid
|
|
10961
|
-
* getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10962
11117
|
*/
|
|
10963
11118
|
getChatsRoom(roomJid) {
|
|
10964
11119
|
// verify the required parameter 'roomJid' is set
|
|
@@ -10985,7 +11140,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10985
11140
|
*
|
|
10986
11141
|
* @param {String} roomJid roomJid
|
|
10987
11142
|
* @param {String} messageIds messageIds, comma separated
|
|
10988
|
-
* getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10989
11143
|
*/
|
|
10990
11144
|
getChatsRoomMessage(roomJid, messageIds) {
|
|
10991
11145
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11019,7 +11173,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11019
11173
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11020
11174
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11021
11175
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11022
|
-
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11023
11176
|
*/
|
|
11024
11177
|
getChatsRoomMessages(roomJid, opts) {
|
|
11025
11178
|
opts = opts || {};
|
|
@@ -11043,6 +11196,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11043
11196
|
);
|
|
11044
11197
|
}
|
|
11045
11198
|
|
|
11199
|
+
/**
|
|
11200
|
+
* Get a room participant
|
|
11201
|
+
*
|
|
11202
|
+
* @param {String} roomJid roomJid
|
|
11203
|
+
* @param {String} participantJid participantJid
|
|
11204
|
+
*/
|
|
11205
|
+
getChatsRoomParticipant(roomJid, participantJid) {
|
|
11206
|
+
// verify the required parameter 'roomJid' is set
|
|
11207
|
+
if (roomJid === undefined || roomJid === null) {
|
|
11208
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';
|
|
11209
|
+
}
|
|
11210
|
+
// verify the required parameter 'participantJid' is set
|
|
11211
|
+
if (participantJid === undefined || participantJid === null) {
|
|
11212
|
+
throw 'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';
|
|
11213
|
+
}
|
|
11214
|
+
|
|
11215
|
+
return this.apiClient.callApi(
|
|
11216
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{participantJid}',
|
|
11217
|
+
'GET',
|
|
11218
|
+
{ 'roomJid': roomJid,'participantJid': participantJid },
|
|
11219
|
+
{ },
|
|
11220
|
+
{ },
|
|
11221
|
+
{ },
|
|
11222
|
+
null,
|
|
11223
|
+
['PureCloud OAuth'],
|
|
11224
|
+
['application/json'],
|
|
11225
|
+
['application/json']
|
|
11226
|
+
);
|
|
11227
|
+
}
|
|
11228
|
+
|
|
11229
|
+
/**
|
|
11230
|
+
* Get room participants in a room
|
|
11231
|
+
*
|
|
11232
|
+
* @param {String} roomJid roomJid
|
|
11233
|
+
*/
|
|
11234
|
+
getChatsRoomParticipants(roomJid) {
|
|
11235
|
+
// verify the required parameter 'roomJid' is set
|
|
11236
|
+
if (roomJid === undefined || roomJid === null) {
|
|
11237
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
|
|
11238
|
+
}
|
|
11239
|
+
|
|
11240
|
+
return this.apiClient.callApi(
|
|
11241
|
+
'/api/v2/chats/rooms/{roomJid}/participants',
|
|
11242
|
+
'GET',
|
|
11243
|
+
{ 'roomJid': roomJid },
|
|
11244
|
+
{ },
|
|
11245
|
+
{ },
|
|
11246
|
+
{ },
|
|
11247
|
+
null,
|
|
11248
|
+
['PureCloud OAuth'],
|
|
11249
|
+
['application/json'],
|
|
11250
|
+
['application/json']
|
|
11251
|
+
);
|
|
11252
|
+
}
|
|
11253
|
+
|
|
11046
11254
|
/**
|
|
11047
11255
|
* Get Chat Settings.
|
|
11048
11256
|
*
|
|
@@ -11071,7 +11279,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11071
11279
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11072
11280
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11073
11281
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11074
|
-
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11075
11282
|
*/
|
|
11076
11283
|
getChatsThreadMessages(threadId, opts) {
|
|
11077
11284
|
opts = opts || {};
|
|
@@ -11100,7 +11307,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11100
11307
|
*
|
|
11101
11308
|
* @param {String} userId userId
|
|
11102
11309
|
* @param {String} messageIds messageIds, comma separated
|
|
11103
|
-
* getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11104
11310
|
*/
|
|
11105
11311
|
getChatsUserMessage(userId, messageIds) {
|
|
11106
11312
|
// verify the required parameter 'userId' is set
|
|
@@ -11134,7 +11340,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11134
11340
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
11135
11341
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
11136
11342
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
11137
|
-
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11138
11343
|
*/
|
|
11139
11344
|
getChatsUserMessages(userId, opts) {
|
|
11140
11345
|
opts = opts || {};
|
|
@@ -11189,7 +11394,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11189
11394
|
*
|
|
11190
11395
|
* @param {String} roomJid roomJid
|
|
11191
11396
|
* @param {Object} body Room properties
|
|
11192
|
-
* patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11193
11397
|
*/
|
|
11194
11398
|
patchChatsRoom(roomJid, body) {
|
|
11195
11399
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11221,7 +11425,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11221
11425
|
* @param {String} roomJid roomId
|
|
11222
11426
|
* @param {String} messageId messageId
|
|
11223
11427
|
* @param {Object} body messageBody
|
|
11224
|
-
* patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11225
11428
|
*/
|
|
11226
11429
|
patchChatsRoomMessage(roomJid, messageId, body) {
|
|
11227
11430
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11282,7 +11485,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11282
11485
|
* @param {String} userId userId
|
|
11283
11486
|
* @param {String} messageId messageId
|
|
11284
11487
|
* @param {Object} body message body
|
|
11285
|
-
* patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11286
11488
|
*/
|
|
11287
11489
|
patchChatsUserMessage(userId, messageId, body) {
|
|
11288
11490
|
// verify the required parameter 'userId' is set
|
|
@@ -11348,7 +11550,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11348
11550
|
*
|
|
11349
11551
|
* @param {String} roomJid roomId
|
|
11350
11552
|
* @param {Object} body messageBody
|
|
11351
|
-
* postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11352
11553
|
*/
|
|
11353
11554
|
postChatsRoomMessages(roomJid, body) {
|
|
11354
11555
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11379,7 +11580,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11379
11580
|
*
|
|
11380
11581
|
* @param {String} roomJid roomJid
|
|
11381
11582
|
* @param {String} userId userId
|
|
11382
|
-
* postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11383
11583
|
*/
|
|
11384
11584
|
postChatsRoomParticipant(roomJid, userId) {
|
|
11385
11585
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11410,7 +11610,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11410
11610
|
*
|
|
11411
11611
|
* @param {String} roomJid roomJid
|
|
11412
11612
|
* @param {Object} body Pinned Message Ids
|
|
11413
|
-
* postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11414
11613
|
*/
|
|
11415
11614
|
postChatsRoomPinnedmessages(roomJid, body) {
|
|
11416
11615
|
// verify the required parameter 'roomJid' is set
|
|
@@ -11440,7 +11639,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11440
11639
|
* Create an adhoc room
|
|
11441
11640
|
*
|
|
11442
11641
|
* @param {Object} body Room properties
|
|
11443
|
-
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11444
11642
|
*/
|
|
11445
11643
|
postChatsRooms(body) {
|
|
11446
11644
|
// verify the required parameter 'body' is set
|
|
@@ -11467,7 +11665,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11467
11665
|
*
|
|
11468
11666
|
* @param {String} userId userId
|
|
11469
11667
|
* @param {Object} body message body
|
|
11470
|
-
* postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11471
11668
|
*/
|
|
11472
11669
|
postChatsUserMessages(userId, body) {
|
|
11473
11670
|
// verify the required parameter 'userId' is set
|
|
@@ -11493,6 +11690,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11493
11690
|
);
|
|
11494
11691
|
}
|
|
11495
11692
|
|
|
11693
|
+
/**
|
|
11694
|
+
* Update reactions to a message
|
|
11695
|
+
*
|
|
11696
|
+
* @param {String} messageId messageId
|
|
11697
|
+
* @param {Object} body reactionUpdate
|
|
11698
|
+
*/
|
|
11699
|
+
putChatsMessageReactions(messageId, body) {
|
|
11700
|
+
// verify the required parameter 'messageId' is set
|
|
11701
|
+
if (messageId === undefined || messageId === null) {
|
|
11702
|
+
throw 'Missing the required parameter "messageId" when calling putChatsMessageReactions';
|
|
11703
|
+
}
|
|
11704
|
+
// verify the required parameter 'body' is set
|
|
11705
|
+
if (body === undefined || body === null) {
|
|
11706
|
+
throw 'Missing the required parameter "body" when calling putChatsMessageReactions';
|
|
11707
|
+
}
|
|
11708
|
+
|
|
11709
|
+
return this.apiClient.callApi(
|
|
11710
|
+
'/api/v2/chats/messages/{messageId}/reactions',
|
|
11711
|
+
'PUT',
|
|
11712
|
+
{ 'messageId': messageId },
|
|
11713
|
+
{ },
|
|
11714
|
+
{ },
|
|
11715
|
+
{ },
|
|
11716
|
+
body,
|
|
11717
|
+
['PureCloud OAuth'],
|
|
11718
|
+
['application/json'],
|
|
11719
|
+
['application/json']
|
|
11720
|
+
);
|
|
11721
|
+
}
|
|
11722
|
+
|
|
11496
11723
|
/**
|
|
11497
11724
|
* Update Chat Settings.
|
|
11498
11725
|
*
|
|
@@ -11524,7 +11751,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11524
11751
|
/**
|
|
11525
11752
|
* Coaching service.
|
|
11526
11753
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11527
|
-
* @version
|
|
11754
|
+
* @version 191.0.0
|
|
11528
11755
|
*/
|
|
11529
11756
|
|
|
11530
11757
|
/**
|
|
@@ -12101,7 +12328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12101
12328
|
/**
|
|
12102
12329
|
* ContentManagement service.
|
|
12103
12330
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12104
|
-
* @version
|
|
12331
|
+
* @version 191.0.0
|
|
12105
12332
|
*/
|
|
12106
12333
|
|
|
12107
12334
|
/**
|
|
@@ -13183,7 +13410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13183
13410
|
/**
|
|
13184
13411
|
* Conversations service.
|
|
13185
13412
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13186
|
-
* @version
|
|
13413
|
+
* @version 191.0.0
|
|
13187
13414
|
*/
|
|
13188
13415
|
|
|
13189
13416
|
/**
|
|
@@ -13476,8 +13703,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13476
13703
|
|
|
13477
13704
|
/**
|
|
13478
13705
|
* Delete a Twitter messaging integration
|
|
13479
|
-
*
|
|
13706
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
13480
13707
|
* @param {String} integrationId Integration ID
|
|
13708
|
+
* @deprecated
|
|
13481
13709
|
*/
|
|
13482
13710
|
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
13483
13711
|
// verify the required parameter 'integrationId' is set
|
|
@@ -15293,6 +15521,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15293
15521
|
);
|
|
15294
15522
|
}
|
|
15295
15523
|
|
|
15524
|
+
/**
|
|
15525
|
+
* Get a list of Facebook Permissions
|
|
15526
|
+
*
|
|
15527
|
+
*/
|
|
15528
|
+
getConversationsMessagingFacebookPermissions() {
|
|
15529
|
+
|
|
15530
|
+
return this.apiClient.callApi(
|
|
15531
|
+
'/api/v2/conversations/messaging/facebook/permissions',
|
|
15532
|
+
'GET',
|
|
15533
|
+
{ },
|
|
15534
|
+
{ },
|
|
15535
|
+
{ },
|
|
15536
|
+
{ },
|
|
15537
|
+
null,
|
|
15538
|
+
['PureCloud OAuth'],
|
|
15539
|
+
['application/json'],
|
|
15540
|
+
['application/json']
|
|
15541
|
+
);
|
|
15542
|
+
}
|
|
15543
|
+
|
|
15296
15544
|
/**
|
|
15297
15545
|
* Get a list of Integrations
|
|
15298
15546
|
*
|
|
@@ -15552,14 +15800,15 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15552
15800
|
}
|
|
15553
15801
|
|
|
15554
15802
|
/**
|
|
15555
|
-
* Get a list of Twitter Integrations
|
|
15556
|
-
*
|
|
15803
|
+
* Get a list of Twitter Integrations (Deprecated)
|
|
15804
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15557
15805
|
* @param {Object} opts Optional parameters
|
|
15558
15806
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15559
15807
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15560
15808
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15561
15809
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
15562
15810
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
15811
|
+
* @deprecated
|
|
15563
15812
|
*/
|
|
15564
15813
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
15565
15814
|
opts = opts || {};
|
|
@@ -15580,11 +15829,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15580
15829
|
}
|
|
15581
15830
|
|
|
15582
15831
|
/**
|
|
15583
|
-
* Get a Twitter messaging integration
|
|
15584
|
-
*
|
|
15832
|
+
* Get a Twitter messaging integration (Deprecated)
|
|
15833
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15585
15834
|
* @param {String} integrationId Integration ID
|
|
15586
15835
|
* @param {Object} opts Optional parameters
|
|
15587
15836
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15837
|
+
* @deprecated
|
|
15588
15838
|
*/
|
|
15589
15839
|
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
15590
15840
|
opts = opts || {};
|
|
@@ -17203,9 +17453,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17203
17453
|
|
|
17204
17454
|
/**
|
|
17205
17455
|
* Update Twitter messaging integration
|
|
17206
|
-
*
|
|
17456
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
17207
17457
|
* @param {String} integrationId Integration ID
|
|
17208
17458
|
* @param {Object} body TwitterIntegrationRequest
|
|
17459
|
+
* @deprecated
|
|
17209
17460
|
*/
|
|
17210
17461
|
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
17211
17462
|
// verify the required parameter 'integrationId' is set
|
|
@@ -19491,8 +19742,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19491
19742
|
|
|
19492
19743
|
/**
|
|
19493
19744
|
* Create a Twitter Integration
|
|
19494
|
-
*
|
|
19745
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
19495
19746
|
* @param {Object} body TwitterIntegrationRequest
|
|
19747
|
+
* @deprecated
|
|
19496
19748
|
*/
|
|
19497
19749
|
postConversationsMessagingIntegrationsTwitter(body) {
|
|
19498
19750
|
// verify the required parameter 'body' is set
|
|
@@ -20355,7 +20607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20355
20607
|
/**
|
|
20356
20608
|
* DataExtensions service.
|
|
20357
20609
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20358
|
-
* @version
|
|
20610
|
+
* @version 191.0.0
|
|
20359
20611
|
*/
|
|
20360
20612
|
|
|
20361
20613
|
/**
|
|
@@ -20441,7 +20693,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20441
20693
|
/**
|
|
20442
20694
|
* Downloads service.
|
|
20443
20695
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20444
|
-
* @version
|
|
20696
|
+
* @version 191.0.0
|
|
20445
20697
|
*/
|
|
20446
20698
|
|
|
20447
20699
|
/**
|
|
@@ -20493,7 +20745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20493
20745
|
/**
|
|
20494
20746
|
* Emails service.
|
|
20495
20747
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20496
|
-
* @version
|
|
20748
|
+
* @version 191.0.0
|
|
20497
20749
|
*/
|
|
20498
20750
|
|
|
20499
20751
|
/**
|
|
@@ -20558,7 +20810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20558
20810
|
/**
|
|
20559
20811
|
* Events service.
|
|
20560
20812
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20561
|
-
* @version
|
|
20813
|
+
* @version 191.0.0
|
|
20562
20814
|
*/
|
|
20563
20815
|
|
|
20564
20816
|
/**
|
|
@@ -20654,7 +20906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20654
20906
|
/**
|
|
20655
20907
|
* ExternalContacts service.
|
|
20656
20908
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20657
|
-
* @version
|
|
20909
|
+
* @version 191.0.0
|
|
20658
20910
|
*/
|
|
20659
20911
|
|
|
20660
20912
|
/**
|
|
@@ -22612,7 +22864,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22612
22864
|
/**
|
|
22613
22865
|
* Fax service.
|
|
22614
22866
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22615
|
-
* @version
|
|
22867
|
+
* @version 191.0.0
|
|
22616
22868
|
*/
|
|
22617
22869
|
|
|
22618
22870
|
/**
|
|
@@ -22783,7 +23035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22783
23035
|
/**
|
|
22784
23036
|
* Flows service.
|
|
22785
23037
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22786
|
-
* @version
|
|
23038
|
+
* @version 191.0.0
|
|
22787
23039
|
*/
|
|
22788
23040
|
|
|
22789
23041
|
/**
|
|
@@ -22967,7 +23219,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22967
23219
|
/**
|
|
22968
23220
|
* Gamification service.
|
|
22969
23221
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22970
|
-
* @version
|
|
23222
|
+
* @version 191.0.0
|
|
22971
23223
|
*/
|
|
22972
23224
|
|
|
22973
23225
|
/**
|
|
@@ -25053,7 +25305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25053
25305
|
/**
|
|
25054
25306
|
* GeneralDataProtectionRegulation service.
|
|
25055
25307
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25056
|
-
* @version
|
|
25308
|
+
* @version 191.0.0
|
|
25057
25309
|
*/
|
|
25058
25310
|
|
|
25059
25311
|
/**
|
|
@@ -25183,7 +25435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25183
25435
|
/**
|
|
25184
25436
|
* Geolocation service.
|
|
25185
25437
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25186
|
-
* @version
|
|
25438
|
+
* @version 191.0.0
|
|
25187
25439
|
*/
|
|
25188
25440
|
|
|
25189
25441
|
/**
|
|
@@ -25314,7 +25566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25314
25566
|
/**
|
|
25315
25567
|
* Greetings service.
|
|
25316
25568
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25317
|
-
* @version
|
|
25569
|
+
* @version 191.0.0
|
|
25318
25570
|
*/
|
|
25319
25571
|
|
|
25320
25572
|
/**
|
|
@@ -25769,7 +26021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25769
26021
|
/**
|
|
25770
26022
|
* Groups service.
|
|
25771
26023
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25772
|
-
* @version
|
|
26024
|
+
* @version 191.0.0
|
|
25773
26025
|
*/
|
|
25774
26026
|
|
|
25775
26027
|
/**
|
|
@@ -26288,7 +26540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26288
26540
|
/**
|
|
26289
26541
|
* IdentityProvider service.
|
|
26290
26542
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26291
|
-
* @version
|
|
26543
|
+
* @version 191.0.0
|
|
26292
26544
|
*/
|
|
26293
26545
|
|
|
26294
26546
|
/**
|
|
@@ -27149,7 +27401,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27149
27401
|
/**
|
|
27150
27402
|
* InfrastructureAsCode service.
|
|
27151
27403
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27152
|
-
* @version
|
|
27404
|
+
* @version 191.0.0
|
|
27153
27405
|
*/
|
|
27154
27406
|
|
|
27155
27407
|
/**
|
|
@@ -27316,7 +27568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27316
27568
|
/**
|
|
27317
27569
|
* Integrations service.
|
|
27318
27570
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27319
|
-
* @version
|
|
27571
|
+
* @version 191.0.0
|
|
27320
27572
|
*/
|
|
27321
27573
|
|
|
27322
27574
|
/**
|
|
@@ -29667,7 +29919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29667
29919
|
/**
|
|
29668
29920
|
* Journey service.
|
|
29669
29921
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29670
|
-
* @version
|
|
29922
|
+
* @version 191.0.0
|
|
29671
29923
|
*/
|
|
29672
29924
|
|
|
29673
29925
|
/**
|
|
@@ -30517,6 +30769,109 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30517
30769
|
);
|
|
30518
30770
|
}
|
|
30519
30771
|
|
|
30772
|
+
/**
|
|
30773
|
+
* Get the job for a journey view version.
|
|
30774
|
+
* used for long descriptions
|
|
30775
|
+
* @param {String} viewId Journey View Id
|
|
30776
|
+
* @param {String} journeyVersionId Journey View Version
|
|
30777
|
+
* @param {String} jobId JobId
|
|
30778
|
+
* getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30779
|
+
*/
|
|
30780
|
+
getJourneyViewVersionJob(viewId, journeyVersionId, jobId) {
|
|
30781
|
+
// verify the required parameter 'viewId' is set
|
|
30782
|
+
if (viewId === undefined || viewId === null) {
|
|
30783
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';
|
|
30784
|
+
}
|
|
30785
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
30786
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
30787
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';
|
|
30788
|
+
}
|
|
30789
|
+
// verify the required parameter 'jobId' is set
|
|
30790
|
+
if (jobId === undefined || jobId === null) {
|
|
30791
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';
|
|
30792
|
+
}
|
|
30793
|
+
|
|
30794
|
+
return this.apiClient.callApi(
|
|
30795
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}',
|
|
30796
|
+
'GET',
|
|
30797
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
|
|
30798
|
+
{ },
|
|
30799
|
+
{ },
|
|
30800
|
+
{ },
|
|
30801
|
+
null,
|
|
30802
|
+
['PureCloud OAuth'],
|
|
30803
|
+
['application/json'],
|
|
30804
|
+
['application/json']
|
|
30805
|
+
);
|
|
30806
|
+
}
|
|
30807
|
+
|
|
30808
|
+
/**
|
|
30809
|
+
* Get the result of a job for a journey view version.
|
|
30810
|
+
* used for long descriptions
|
|
30811
|
+
* @param {String} viewId JourneyViewResult id
|
|
30812
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
30813
|
+
* @param {String} jobId Id of the executing job
|
|
30814
|
+
* getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30815
|
+
*/
|
|
30816
|
+
getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId) {
|
|
30817
|
+
// verify the required parameter 'viewId' is set
|
|
30818
|
+
if (viewId === undefined || viewId === null) {
|
|
30819
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';
|
|
30820
|
+
}
|
|
30821
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
30822
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
30823
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';
|
|
30824
|
+
}
|
|
30825
|
+
// verify the required parameter 'jobId' is set
|
|
30826
|
+
if (jobId === undefined || jobId === null) {
|
|
30827
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';
|
|
30828
|
+
}
|
|
30829
|
+
|
|
30830
|
+
return this.apiClient.callApi(
|
|
30831
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results',
|
|
30832
|
+
'GET',
|
|
30833
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'jobId': jobId },
|
|
30834
|
+
{ },
|
|
30835
|
+
{ },
|
|
30836
|
+
{ },
|
|
30837
|
+
null,
|
|
30838
|
+
['PureCloud OAuth'],
|
|
30839
|
+
['application/json'],
|
|
30840
|
+
['application/json']
|
|
30841
|
+
);
|
|
30842
|
+
}
|
|
30843
|
+
|
|
30844
|
+
/**
|
|
30845
|
+
* Get the latest job of a journey view version.
|
|
30846
|
+
* used for long descriptions
|
|
30847
|
+
* @param {String} viewId Journey View Id
|
|
30848
|
+
* @param {String} journeyVersionId Journey View Version
|
|
30849
|
+
* getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30850
|
+
*/
|
|
30851
|
+
getJourneyViewVersionJobsLatest(viewId, journeyVersionId) {
|
|
30852
|
+
// verify the required parameter 'viewId' is set
|
|
30853
|
+
if (viewId === undefined || viewId === null) {
|
|
30854
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';
|
|
30855
|
+
}
|
|
30856
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
30857
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
30858
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';
|
|
30859
|
+
}
|
|
30860
|
+
|
|
30861
|
+
return this.apiClient.callApi(
|
|
30862
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest',
|
|
30863
|
+
'GET',
|
|
30864
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId },
|
|
30865
|
+
{ },
|
|
30866
|
+
{ },
|
|
30867
|
+
{ },
|
|
30868
|
+
null,
|
|
30869
|
+
['PureCloud OAuth'],
|
|
30870
|
+
['application/json'],
|
|
30871
|
+
['application/json']
|
|
30872
|
+
);
|
|
30873
|
+
}
|
|
30874
|
+
|
|
30520
30875
|
/**
|
|
30521
30876
|
* Get a list of Journey Views
|
|
30522
30877
|
*
|
|
@@ -30538,6 +30893,53 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30538
30893
|
);
|
|
30539
30894
|
}
|
|
30540
30895
|
|
|
30896
|
+
/**
|
|
30897
|
+
* Get an Event Definition
|
|
30898
|
+
*
|
|
30899
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
30900
|
+
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30901
|
+
*/
|
|
30902
|
+
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
30903
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
30904
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null) {
|
|
30905
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';
|
|
30906
|
+
}
|
|
30907
|
+
|
|
30908
|
+
return this.apiClient.callApi(
|
|
30909
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
|
|
30910
|
+
'GET',
|
|
30911
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
30912
|
+
{ },
|
|
30913
|
+
{ },
|
|
30914
|
+
{ },
|
|
30915
|
+
null,
|
|
30916
|
+
['PureCloud OAuth'],
|
|
30917
|
+
['application/json'],
|
|
30918
|
+
['application/json']
|
|
30919
|
+
);
|
|
30920
|
+
}
|
|
30921
|
+
|
|
30922
|
+
/**
|
|
30923
|
+
* Get a list of Event Definitions
|
|
30924
|
+
*
|
|
30925
|
+
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30926
|
+
*/
|
|
30927
|
+
getJourneyViewsEventdefinitions() {
|
|
30928
|
+
|
|
30929
|
+
return this.apiClient.callApi(
|
|
30930
|
+
'/api/v2/journey/views/eventdefinitions',
|
|
30931
|
+
'GET',
|
|
30932
|
+
{ },
|
|
30933
|
+
{ },
|
|
30934
|
+
{ },
|
|
30935
|
+
{ },
|
|
30936
|
+
null,
|
|
30937
|
+
['PureCloud OAuth'],
|
|
30938
|
+
['application/json'],
|
|
30939
|
+
['application/json']
|
|
30940
|
+
);
|
|
30941
|
+
}
|
|
30942
|
+
|
|
30541
30943
|
/**
|
|
30542
30944
|
* Update single action map.
|
|
30543
30945
|
*
|
|
@@ -30988,6 +31390,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30988
31390
|
);
|
|
30989
31391
|
}
|
|
30990
31392
|
|
|
31393
|
+
/**
|
|
31394
|
+
* Submit a job request for a journey view version.
|
|
31395
|
+
* used for long descriptions
|
|
31396
|
+
* @param {String} viewId Journey View Id
|
|
31397
|
+
* @param {String} journeyVersionId Journey View Version
|
|
31398
|
+
* postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31399
|
+
*/
|
|
31400
|
+
postJourneyViewVersionJobs(viewId, journeyVersionId) {
|
|
31401
|
+
// verify the required parameter 'viewId' is set
|
|
31402
|
+
if (viewId === undefined || viewId === null) {
|
|
31403
|
+
throw 'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';
|
|
31404
|
+
}
|
|
31405
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
31406
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
31407
|
+
throw 'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';
|
|
31408
|
+
}
|
|
31409
|
+
|
|
31410
|
+
return this.apiClient.callApi(
|
|
31411
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs',
|
|
31412
|
+
'POST',
|
|
31413
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId },
|
|
31414
|
+
{ },
|
|
31415
|
+
{ },
|
|
31416
|
+
{ },
|
|
31417
|
+
null,
|
|
31418
|
+
['PureCloud OAuth'],
|
|
31419
|
+
['application/json'],
|
|
31420
|
+
['application/json']
|
|
31421
|
+
);
|
|
31422
|
+
}
|
|
31423
|
+
|
|
30991
31424
|
/**
|
|
30992
31425
|
* Update a Journey View by ID
|
|
30993
31426
|
* creates a new version
|
|
@@ -31045,13 +31478,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31045
31478
|
);
|
|
31046
31479
|
}
|
|
31047
31480
|
|
|
31481
|
+
/**
|
|
31482
|
+
* Validate whether an encoding exist for a label/value combination.
|
|
31483
|
+
* True indicates a valid encoding
|
|
31484
|
+
* @param {Object} opts Optional parameters
|
|
31485
|
+
* @param {Array.<Object>} opts.body
|
|
31486
|
+
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31487
|
+
*/
|
|
31488
|
+
postJourneyViewsEncodingsValidate(opts) {
|
|
31489
|
+
opts = opts || {};
|
|
31490
|
+
|
|
31491
|
+
|
|
31492
|
+
return this.apiClient.callApi(
|
|
31493
|
+
'/api/v2/journey/views/encodings/validate',
|
|
31494
|
+
'POST',
|
|
31495
|
+
{ },
|
|
31496
|
+
{ },
|
|
31497
|
+
{ },
|
|
31498
|
+
{ },
|
|
31499
|
+
opts['body'],
|
|
31500
|
+
['PureCloud OAuth'],
|
|
31501
|
+
['application/json'],
|
|
31502
|
+
['application/json']
|
|
31503
|
+
);
|
|
31504
|
+
}
|
|
31505
|
+
|
|
31048
31506
|
}
|
|
31049
31507
|
|
|
31050
31508
|
class KnowledgeApi {
|
|
31051
31509
|
/**
|
|
31052
31510
|
* Knowledge service.
|
|
31053
31511
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31054
|
-
* @version
|
|
31512
|
+
* @version 191.0.0
|
|
31055
31513
|
*/
|
|
31056
31514
|
|
|
31057
31515
|
/**
|
|
@@ -34294,7 +34752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34294
34752
|
/**
|
|
34295
34753
|
* LanguageUnderstanding service.
|
|
34296
34754
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34297
|
-
* @version
|
|
34755
|
+
* @version 191.0.0
|
|
34298
34756
|
*/
|
|
34299
34757
|
|
|
34300
34758
|
/**
|
|
@@ -35307,7 +35765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35307
35765
|
/**
|
|
35308
35766
|
* Languages service.
|
|
35309
35767
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35310
|
-
* @version
|
|
35768
|
+
* @version 191.0.0
|
|
35311
35769
|
*/
|
|
35312
35770
|
|
|
35313
35771
|
/**
|
|
@@ -35529,7 +35987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35529
35987
|
/**
|
|
35530
35988
|
* Learning service.
|
|
35531
35989
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35532
|
-
* @version
|
|
35990
|
+
* @version 191.0.0
|
|
35533
35991
|
*/
|
|
35534
35992
|
|
|
35535
35993
|
/**
|
|
@@ -35973,7 +36431,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35973
36431
|
* @param {String} moduleId Key identifier for the module
|
|
35974
36432
|
* @param {String} userId Key identifier for the user
|
|
35975
36433
|
* @param {Object} body The learning request for updating the assignment
|
|
35976
|
-
* patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35977
36434
|
*/
|
|
35978
36435
|
patchLearningModuleUserAssignments(moduleId, userId, body) {
|
|
35979
36436
|
// verify the required parameter 'moduleId' is set
|
|
@@ -36385,7 +36842,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36385
36842
|
/**
|
|
36386
36843
|
* License service.
|
|
36387
36844
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36388
|
-
* @version
|
|
36845
|
+
* @version 191.0.0
|
|
36389
36846
|
*/
|
|
36390
36847
|
|
|
36391
36848
|
/**
|
|
@@ -36623,7 +37080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36623
37080
|
/**
|
|
36624
37081
|
* Locations service.
|
|
36625
37082
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36626
|
-
* @version
|
|
37083
|
+
* @version 191.0.0
|
|
36627
37084
|
*/
|
|
36628
37085
|
|
|
36629
37086
|
/**
|
|
@@ -36859,7 +37316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36859
37316
|
/**
|
|
36860
37317
|
* LogCapture service.
|
|
36861
37318
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
36862
|
-
* @version
|
|
37319
|
+
* @version 191.0.0
|
|
36863
37320
|
*/
|
|
36864
37321
|
|
|
36865
37322
|
/**
|
|
@@ -37059,7 +37516,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37059
37516
|
/**
|
|
37060
37517
|
* Messaging service.
|
|
37061
37518
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37062
|
-
* @version
|
|
37519
|
+
* @version 191.0.0
|
|
37063
37520
|
*/
|
|
37064
37521
|
|
|
37065
37522
|
/**
|
|
@@ -37418,7 +37875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37418
37875
|
/**
|
|
37419
37876
|
* MobileDevices service.
|
|
37420
37877
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37421
|
-
* @version
|
|
37878
|
+
* @version 191.0.0
|
|
37422
37879
|
*/
|
|
37423
37880
|
|
|
37424
37881
|
/**
|
|
@@ -37569,7 +38026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37569
38026
|
/**
|
|
37570
38027
|
* Notifications service.
|
|
37571
38028
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
37572
|
-
* @version
|
|
38029
|
+
* @version 191.0.0
|
|
37573
38030
|
*/
|
|
37574
38031
|
|
|
37575
38032
|
/**
|
|
@@ -37802,7 +38259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37802
38259
|
/**
|
|
37803
38260
|
* OAuth service.
|
|
37804
38261
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37805
|
-
* @version
|
|
38262
|
+
* @version 191.0.0
|
|
37806
38263
|
*/
|
|
37807
38264
|
|
|
37808
38265
|
/**
|
|
@@ -38168,7 +38625,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38168
38625
|
/**
|
|
38169
38626
|
* Objects service.
|
|
38170
38627
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38171
|
-
* @version
|
|
38628
|
+
* @version 191.0.0
|
|
38172
38629
|
*/
|
|
38173
38630
|
|
|
38174
38631
|
/**
|
|
@@ -38438,7 +38895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38438
38895
|
/**
|
|
38439
38896
|
* OperationalEvents service.
|
|
38440
38897
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38441
|
-
* @version
|
|
38898
|
+
* @version 191.0.0
|
|
38442
38899
|
*/
|
|
38443
38900
|
|
|
38444
38901
|
/**
|
|
@@ -38504,7 +38961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38504
38961
|
/**
|
|
38505
38962
|
* Organization service.
|
|
38506
38963
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38507
|
-
* @version
|
|
38964
|
+
* @version 191.0.0
|
|
38508
38965
|
*/
|
|
38509
38966
|
|
|
38510
38967
|
/**
|
|
@@ -38661,7 +39118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38661
39118
|
}
|
|
38662
39119
|
|
|
38663
39120
|
/**
|
|
38664
|
-
* Get
|
|
39121
|
+
* Get limit documentation
|
|
38665
39122
|
*
|
|
38666
39123
|
*/
|
|
38667
39124
|
getOrganizationsLimitsDocs() {
|
|
@@ -38959,7 +39416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38959
39416
|
/**
|
|
38960
39417
|
* OrganizationAuthorization service.
|
|
38961
39418
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38962
|
-
* @version
|
|
39419
|
+
* @version 191.0.0
|
|
38963
39420
|
*/
|
|
38964
39421
|
|
|
38965
39422
|
/**
|
|
@@ -40306,7 +40763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40306
40763
|
/**
|
|
40307
40764
|
* Outbound service.
|
|
40308
40765
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40309
|
-
* @version
|
|
40766
|
+
* @version 191.0.0
|
|
40310
40767
|
*/
|
|
40311
40768
|
|
|
40312
40769
|
/**
|
|
@@ -44547,7 +45004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44547
45004
|
/**
|
|
44548
45005
|
* Presence service.
|
|
44549
45006
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
44550
|
-
* @version
|
|
45007
|
+
* @version 191.0.0
|
|
44551
45008
|
*/
|
|
44552
45009
|
|
|
44553
45010
|
/**
|
|
@@ -45291,7 +45748,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45291
45748
|
/**
|
|
45292
45749
|
* ProcessAutomation service.
|
|
45293
45750
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45294
|
-
* @version
|
|
45751
|
+
* @version 191.0.0
|
|
45295
45752
|
*/
|
|
45296
45753
|
|
|
45297
45754
|
/**
|
|
@@ -45530,7 +45987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45530
45987
|
/**
|
|
45531
45988
|
* Quality service.
|
|
45532
45989
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
45533
|
-
* @version
|
|
45990
|
+
* @version 191.0.0
|
|
45534
45991
|
*/
|
|
45535
45992
|
|
|
45536
45993
|
/**
|
|
@@ -47287,7 +47744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47287
47744
|
/**
|
|
47288
47745
|
* Recording service.
|
|
47289
47746
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47290
|
-
* @version
|
|
47747
|
+
* @version 191.0.0
|
|
47291
47748
|
*/
|
|
47292
47749
|
|
|
47293
47750
|
/**
|
|
@@ -48173,10 +48630,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48173
48630
|
|
|
48174
48631
|
/**
|
|
48175
48632
|
* Retrieves a paged listing of screen recording sessions
|
|
48176
|
-
*
|
|
48633
|
+
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
48177
48634
|
* @param {Object} opts Optional parameters
|
|
48178
48635
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
48179
48636
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
48637
|
+
* @deprecated
|
|
48180
48638
|
*/
|
|
48181
48639
|
getRecordingsScreensessions(opts) {
|
|
48182
48640
|
opts = opts || {};
|
|
@@ -48196,6 +48654,27 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48196
48654
|
);
|
|
48197
48655
|
}
|
|
48198
48656
|
|
|
48657
|
+
/**
|
|
48658
|
+
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
48659
|
+
*
|
|
48660
|
+
* getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48661
|
+
*/
|
|
48662
|
+
getRecordingsScreensessionsDetails() {
|
|
48663
|
+
|
|
48664
|
+
return this.apiClient.callApi(
|
|
48665
|
+
'/api/v2/recordings/screensessions/details',
|
|
48666
|
+
'GET',
|
|
48667
|
+
{ },
|
|
48668
|
+
{ },
|
|
48669
|
+
{ },
|
|
48670
|
+
{ },
|
|
48671
|
+
null,
|
|
48672
|
+
['PureCloud OAuth'],
|
|
48673
|
+
['application/json'],
|
|
48674
|
+
['application/json']
|
|
48675
|
+
);
|
|
48676
|
+
}
|
|
48677
|
+
|
|
48199
48678
|
/**
|
|
48200
48679
|
* Patch a media retention policy
|
|
48201
48680
|
*
|
|
@@ -48924,7 +49403,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48924
49403
|
/**
|
|
48925
49404
|
* ResponseManagement service.
|
|
48926
49405
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
48927
|
-
* @version
|
|
49406
|
+
* @version 191.0.0
|
|
48928
49407
|
*/
|
|
48929
49408
|
|
|
48930
49409
|
/**
|
|
@@ -49201,6 +49680,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49201
49680
|
);
|
|
49202
49681
|
}
|
|
49203
49682
|
|
|
49683
|
+
/**
|
|
49684
|
+
* Get response libraries.
|
|
49685
|
+
*
|
|
49686
|
+
* @param {Object} body LibraryIDs (max allowed 50)
|
|
49687
|
+
*/
|
|
49688
|
+
postResponsemanagementLibrariesBulk(body) {
|
|
49689
|
+
// verify the required parameter 'body' is set
|
|
49690
|
+
if (body === undefined || body === null) {
|
|
49691
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementLibrariesBulk';
|
|
49692
|
+
}
|
|
49693
|
+
|
|
49694
|
+
return this.apiClient.callApi(
|
|
49695
|
+
'/api/v2/responsemanagement/libraries/bulk',
|
|
49696
|
+
'POST',
|
|
49697
|
+
{ },
|
|
49698
|
+
{ },
|
|
49699
|
+
{ },
|
|
49700
|
+
{ },
|
|
49701
|
+
body,
|
|
49702
|
+
['PureCloud OAuth'],
|
|
49703
|
+
['application/json'],
|
|
49704
|
+
['application/json']
|
|
49705
|
+
);
|
|
49706
|
+
}
|
|
49707
|
+
|
|
49204
49708
|
/**
|
|
49205
49709
|
* Search response assets
|
|
49206
49710
|
*
|
|
@@ -49409,7 +49913,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49409
49913
|
/**
|
|
49410
49914
|
* Routing service.
|
|
49411
49915
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
49412
|
-
* @version
|
|
49916
|
+
* @version 191.0.0
|
|
49413
49917
|
*/
|
|
49414
49918
|
|
|
49415
49919
|
/**
|
|
@@ -50857,11 +51361,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50857
51361
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50858
51362
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50859
51363
|
* @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
|
|
50860
|
-
* @param {String} opts.name
|
|
50861
|
-
* @param {Array.<String>} opts.id
|
|
50862
|
-
* @param {Array.<String>} opts.divisionId
|
|
50863
|
-
* @param {Array.<String>} opts.peerId
|
|
50864
|
-
* @param {
|
|
51364
|
+
* @param {String} opts.name Include only queues with the given name (leading and trailing asterisks allowed)
|
|
51365
|
+
* @param {Array.<String>} opts.id Include only queues with the specified ID(s)
|
|
51366
|
+
* @param {Array.<String>} opts.divisionId Include only queues in the specified division ID(s)
|
|
51367
|
+
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
51368
|
+
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
51369
|
+
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
50865
51370
|
*/
|
|
50866
51371
|
getRoutingQueues(opts) {
|
|
50867
51372
|
opts = opts || {};
|
|
@@ -50871,7 +51376,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50871
51376
|
'/api/v2/routing/queues',
|
|
50872
51377
|
'GET',
|
|
50873
51378
|
{ },
|
|
50874
|
-
{ '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'] },
|
|
51379
|
+
{ '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'] },
|
|
50875
51380
|
{ },
|
|
50876
51381
|
{ },
|
|
50877
51382
|
null,
|
|
@@ -52813,6 +53318,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52813
53318
|
);
|
|
52814
53319
|
}
|
|
52815
53320
|
|
|
53321
|
+
/**
|
|
53322
|
+
* Provision an alphanumeric number for SMS
|
|
53323
|
+
*
|
|
53324
|
+
* @param {Object} body SmsPhoneNumber
|
|
53325
|
+
* postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53326
|
+
*/
|
|
53327
|
+
postRoutingSmsPhonenumbersAlphanumeric(body) {
|
|
53328
|
+
// verify the required parameter 'body' is set
|
|
53329
|
+
if (body === undefined || body === null) {
|
|
53330
|
+
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersAlphanumeric';
|
|
53331
|
+
}
|
|
53332
|
+
|
|
53333
|
+
return this.apiClient.callApi(
|
|
53334
|
+
'/api/v2/routing/sms/phonenumbers/alphanumeric',
|
|
53335
|
+
'POST',
|
|
53336
|
+
{ },
|
|
53337
|
+
{ },
|
|
53338
|
+
{ },
|
|
53339
|
+
{ },
|
|
53340
|
+
body,
|
|
53341
|
+
['PureCloud OAuth'],
|
|
53342
|
+
['application/json'],
|
|
53343
|
+
['application/json']
|
|
53344
|
+
);
|
|
53345
|
+
}
|
|
53346
|
+
|
|
52816
53347
|
/**
|
|
52817
53348
|
* Imports a phone number for SMS
|
|
52818
53349
|
*
|
|
@@ -53362,7 +53893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53362
53893
|
/**
|
|
53363
53894
|
* SCIM service.
|
|
53364
53895
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
53365
|
-
* @version
|
|
53896
|
+
* @version 191.0.0
|
|
53366
53897
|
*/
|
|
53367
53898
|
|
|
53368
53899
|
/**
|
|
@@ -54239,7 +54770,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54239
54770
|
/**
|
|
54240
54771
|
* ScreenRecording service.
|
|
54241
54772
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54242
|
-
* @version
|
|
54773
|
+
* @version 191.0.0
|
|
54243
54774
|
*/
|
|
54244
54775
|
|
|
54245
54776
|
/**
|
|
@@ -54284,7 +54815,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54284
54815
|
/**
|
|
54285
54816
|
* Scripts service.
|
|
54286
54817
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54287
|
-
* @version
|
|
54818
|
+
* @version 191.0.0
|
|
54288
54819
|
*/
|
|
54289
54820
|
|
|
54290
54821
|
/**
|
|
@@ -54728,7 +55259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54728
55259
|
/**
|
|
54729
55260
|
* Search service.
|
|
54730
55261
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
54731
|
-
* @version
|
|
55262
|
+
* @version 191.0.0
|
|
54732
55263
|
*/
|
|
54733
55264
|
|
|
54734
55265
|
/**
|
|
@@ -55417,7 +55948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55417
55948
|
/**
|
|
55418
55949
|
* Settings service.
|
|
55419
55950
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
55420
|
-
* @version
|
|
55951
|
+
* @version 191.0.0
|
|
55421
55952
|
*/
|
|
55422
55953
|
|
|
55423
55954
|
/**
|
|
@@ -55529,7 +56060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55529
56060
|
/**
|
|
55530
56061
|
* SpeechTextAnalytics service.
|
|
55531
56062
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
55532
|
-
* @version
|
|
56063
|
+
* @version 191.0.0
|
|
55533
56064
|
*/
|
|
55534
56065
|
|
|
55535
56066
|
/**
|
|
@@ -56643,7 +57174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56643
57174
|
/**
|
|
56644
57175
|
* Stations service.
|
|
56645
57176
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
56646
|
-
* @version
|
|
57177
|
+
* @version 191.0.0
|
|
56647
57178
|
*/
|
|
56648
57179
|
|
|
56649
57180
|
/**
|
|
@@ -56745,7 +57276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56745
57276
|
/**
|
|
56746
57277
|
* Suggest service.
|
|
56747
57278
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
56748
|
-
* @version
|
|
57279
|
+
* @version 191.0.0
|
|
56749
57280
|
*/
|
|
56750
57281
|
|
|
56751
57282
|
/**
|
|
@@ -56884,7 +57415,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56884
57415
|
/**
|
|
56885
57416
|
* TaskManagement service.
|
|
56886
57417
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
56887
|
-
* @version
|
|
57418
|
+
* @version 191.0.0
|
|
56888
57419
|
*/
|
|
56889
57420
|
|
|
56890
57421
|
/**
|
|
@@ -58191,7 +58722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58191
58722
|
/**
|
|
58192
58723
|
* Teams service.
|
|
58193
58724
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
58194
|
-
* @version
|
|
58725
|
+
* @version 191.0.0
|
|
58195
58726
|
*/
|
|
58196
58727
|
|
|
58197
58728
|
/**
|
|
@@ -58493,7 +59024,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58493
59024
|
/**
|
|
58494
59025
|
* Telephony service.
|
|
58495
59026
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
58496
|
-
* @version
|
|
59027
|
+
* @version 191.0.0
|
|
58497
59028
|
*/
|
|
58498
59029
|
|
|
58499
59030
|
/**
|
|
@@ -58675,7 +59206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58675
59206
|
/**
|
|
58676
59207
|
* TelephonyProvidersEdge service.
|
|
58677
59208
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
58678
|
-
* @version
|
|
59209
|
+
* @version 191.0.0
|
|
58679
59210
|
*/
|
|
58680
59211
|
|
|
58681
59212
|
/**
|
|
@@ -62024,7 +62555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62024
62555
|
/**
|
|
62025
62556
|
* Textbots service.
|
|
62026
62557
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62027
|
-
* @version
|
|
62558
|
+
* @version 191.0.0
|
|
62028
62559
|
*/
|
|
62029
62560
|
|
|
62030
62561
|
/**
|
|
@@ -62152,7 +62683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62152
62683
|
/**
|
|
62153
62684
|
* Tokens service.
|
|
62154
62685
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62155
|
-
* @version
|
|
62686
|
+
* @version 191.0.0
|
|
62156
62687
|
*/
|
|
62157
62688
|
|
|
62158
62689
|
/**
|
|
@@ -62306,7 +62837,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62306
62837
|
/**
|
|
62307
62838
|
* Uploads service.
|
|
62308
62839
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
62309
|
-
* @version
|
|
62840
|
+
* @version 191.0.0
|
|
62310
62841
|
*/
|
|
62311
62842
|
|
|
62312
62843
|
/**
|
|
@@ -62575,7 +63106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62575
63106
|
/**
|
|
62576
63107
|
* Usage service.
|
|
62577
63108
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
62578
|
-
* @version
|
|
63109
|
+
* @version 191.0.0
|
|
62579
63110
|
*/
|
|
62580
63111
|
|
|
62581
63112
|
/**
|
|
@@ -62675,7 +63206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62675
63206
|
}
|
|
62676
63207
|
|
|
62677
63208
|
/**
|
|
62678
|
-
* Get the results of a usage search
|
|
63209
|
+
* Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
|
|
62679
63210
|
*
|
|
62680
63211
|
* @param {String} executionId ID of the search execution
|
|
62681
63212
|
*/
|
|
@@ -62755,8 +63286,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62755
63286
|
}
|
|
62756
63287
|
|
|
62757
63288
|
/**
|
|
62758
|
-
* Search organization API Usage
|
|
62759
|
-
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
63289
|
+
* Search organization API Usage
|
|
63290
|
+
* 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
|
|
62760
63291
|
* @param {Object} body SimpleSearch
|
|
62761
63292
|
*/
|
|
62762
63293
|
postUsageSimplesearch(body) {
|
|
@@ -62785,7 +63316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62785
63316
|
/**
|
|
62786
63317
|
* UserRecordings service.
|
|
62787
63318
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
62788
|
-
* @version
|
|
63319
|
+
* @version 191.0.0
|
|
62789
63320
|
*/
|
|
62790
63321
|
|
|
62791
63322
|
/**
|
|
@@ -62970,7 +63501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62970
63501
|
/**
|
|
62971
63502
|
* Users service.
|
|
62972
63503
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
62973
|
-
* @version
|
|
63504
|
+
* @version 191.0.0
|
|
62974
63505
|
*/
|
|
62975
63506
|
|
|
62976
63507
|
/**
|
|
@@ -65621,7 +66152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65621
66152
|
/**
|
|
65622
66153
|
* Utilities service.
|
|
65623
66154
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
65624
|
-
* @version
|
|
66155
|
+
* @version 191.0.0
|
|
65625
66156
|
*/
|
|
65626
66157
|
|
|
65627
66158
|
/**
|
|
@@ -65732,7 +66263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65732
66263
|
/**
|
|
65733
66264
|
* Voicemail service.
|
|
65734
66265
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
65735
|
-
* @version
|
|
66266
|
+
* @version 191.0.0
|
|
65736
66267
|
*/
|
|
65737
66268
|
|
|
65738
66269
|
/**
|
|
@@ -66399,7 +66930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66399
66930
|
/**
|
|
66400
66931
|
* WebChat service.
|
|
66401
66932
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
66402
|
-
* @version
|
|
66933
|
+
* @version 191.0.0
|
|
66403
66934
|
*/
|
|
66404
66935
|
|
|
66405
66936
|
/**
|
|
@@ -66948,7 +67479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66948
67479
|
/**
|
|
66949
67480
|
* WebDeployments service.
|
|
66950
67481
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
66951
|
-
* @version
|
|
67482
|
+
* @version 191.0.0
|
|
66952
67483
|
*/
|
|
66953
67484
|
|
|
66954
67485
|
/**
|
|
@@ -67475,7 +68006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67475
68006
|
/**
|
|
67476
68007
|
* WebMessaging service.
|
|
67477
68008
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
67478
|
-
* @version
|
|
68009
|
+
* @version 191.0.0
|
|
67479
68010
|
*/
|
|
67480
68011
|
|
|
67481
68012
|
/**
|
|
@@ -67521,7 +68052,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67521
68052
|
/**
|
|
67522
68053
|
* Widgets service.
|
|
67523
68054
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
67524
|
-
* @version
|
|
68055
|
+
* @version 191.0.0
|
|
67525
68056
|
*/
|
|
67526
68057
|
|
|
67527
68058
|
/**
|
|
@@ -67667,7 +68198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67667
68198
|
/**
|
|
67668
68199
|
* WorkforceManagement service.
|
|
67669
68200
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
67670
|
-
* @version
|
|
68201
|
+
* @version 191.0.0
|
|
67671
68202
|
*/
|
|
67672
68203
|
|
|
67673
68204
|
/**
|
|
@@ -67827,6 +68358,96 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67827
68358
|
);
|
|
67828
68359
|
}
|
|
67829
68360
|
|
|
68361
|
+
/**
|
|
68362
|
+
* Deletes a staffing group
|
|
68363
|
+
*
|
|
68364
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68365
|
+
* @param {String} staffingGroupId The ID of the staffing group to delete
|
|
68366
|
+
*/
|
|
68367
|
+
deleteWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
|
|
68368
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68369
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68370
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
|
|
68371
|
+
}
|
|
68372
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
68373
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
68374
|
+
throw 'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
|
|
68375
|
+
}
|
|
68376
|
+
|
|
68377
|
+
return this.apiClient.callApi(
|
|
68378
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
68379
|
+
'DELETE',
|
|
68380
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
68381
|
+
{ },
|
|
68382
|
+
{ },
|
|
68383
|
+
{ },
|
|
68384
|
+
null,
|
|
68385
|
+
['PureCloud OAuth'],
|
|
68386
|
+
['application/json'],
|
|
68387
|
+
['application/json']
|
|
68388
|
+
);
|
|
68389
|
+
}
|
|
68390
|
+
|
|
68391
|
+
/**
|
|
68392
|
+
* Deletes a time-off limit object
|
|
68393
|
+
*
|
|
68394
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68395
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to delete
|
|
68396
|
+
*/
|
|
68397
|
+
deleteWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
|
|
68398
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68399
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68400
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
|
|
68401
|
+
}
|
|
68402
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
68403
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
68404
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
|
|
68405
|
+
}
|
|
68406
|
+
|
|
68407
|
+
return this.apiClient.callApi(
|
|
68408
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
|
|
68409
|
+
'DELETE',
|
|
68410
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
68411
|
+
{ },
|
|
68412
|
+
{ },
|
|
68413
|
+
{ },
|
|
68414
|
+
null,
|
|
68415
|
+
['PureCloud OAuth'],
|
|
68416
|
+
['application/json'],
|
|
68417
|
+
['application/json']
|
|
68418
|
+
);
|
|
68419
|
+
}
|
|
68420
|
+
|
|
68421
|
+
/**
|
|
68422
|
+
* Deletes a time-off plan
|
|
68423
|
+
*
|
|
68424
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
68425
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to delete
|
|
68426
|
+
*/
|
|
68427
|
+
deleteWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
|
|
68428
|
+
// verify the required parameter 'businessUnitId' is set
|
|
68429
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
68430
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
|
|
68431
|
+
}
|
|
68432
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
68433
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
68434
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
|
|
68435
|
+
}
|
|
68436
|
+
|
|
68437
|
+
return this.apiClient.callApi(
|
|
68438
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
68439
|
+
'DELETE',
|
|
68440
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
68441
|
+
{ },
|
|
68442
|
+
{ },
|
|
68443
|
+
{ },
|
|
68444
|
+
null,
|
|
68445
|
+
['PureCloud OAuth'],
|
|
68446
|
+
['application/json'],
|
|
68447
|
+
['application/json']
|
|
68448
|
+
);
|
|
68449
|
+
}
|
|
68450
|
+
|
|
67830
68451
|
/**
|
|
67831
68452
|
* Delete a schedule
|
|
67832
68453
|
*
|
|
@@ -68649,6 +69270,184 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68649
69270
|
);
|
|
68650
69271
|
}
|
|
68651
69272
|
|
|
69273
|
+
/**
|
|
69274
|
+
* Gets a staffing group
|
|
69275
|
+
*
|
|
69276
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69277
|
+
* @param {String} staffingGroupId The ID of the staffing group to fetch
|
|
69278
|
+
*/
|
|
69279
|
+
getWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
|
|
69280
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69281
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69282
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
|
|
69283
|
+
}
|
|
69284
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
69285
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
69286
|
+
throw 'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
|
|
69287
|
+
}
|
|
69288
|
+
|
|
69289
|
+
return this.apiClient.callApi(
|
|
69290
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
69291
|
+
'GET',
|
|
69292
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
69293
|
+
{ },
|
|
69294
|
+
{ },
|
|
69295
|
+
{ },
|
|
69296
|
+
null,
|
|
69297
|
+
['PureCloud OAuth'],
|
|
69298
|
+
['application/json'],
|
|
69299
|
+
['application/json']
|
|
69300
|
+
);
|
|
69301
|
+
}
|
|
69302
|
+
|
|
69303
|
+
/**
|
|
69304
|
+
* Gets a list of staffing groups
|
|
69305
|
+
*
|
|
69306
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69307
|
+
* @param {Object} opts Optional parameters
|
|
69308
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
69309
|
+
*/
|
|
69310
|
+
getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
69311
|
+
opts = opts || {};
|
|
69312
|
+
|
|
69313
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69314
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69315
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';
|
|
69316
|
+
}
|
|
69317
|
+
|
|
69318
|
+
return this.apiClient.callApi(
|
|
69319
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
69320
|
+
'GET',
|
|
69321
|
+
{ 'businessUnitId': businessUnitId },
|
|
69322
|
+
{ 'managementUnitId': opts['managementUnitId'] },
|
|
69323
|
+
{ },
|
|
69324
|
+
{ },
|
|
69325
|
+
null,
|
|
69326
|
+
['PureCloud OAuth'],
|
|
69327
|
+
['application/json'],
|
|
69328
|
+
['application/json']
|
|
69329
|
+
);
|
|
69330
|
+
}
|
|
69331
|
+
|
|
69332
|
+
/**
|
|
69333
|
+
* Gets a time-off limit object
|
|
69334
|
+
* Returns properties of time-off limit object, but not daily values
|
|
69335
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69336
|
+
* @param {String} timeOffLimitId The ID of the time-off limit to fetch
|
|
69337
|
+
*/
|
|
69338
|
+
getWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
|
|
69339
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69340
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69341
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
|
|
69342
|
+
}
|
|
69343
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
69344
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
69345
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
|
|
69346
|
+
}
|
|
69347
|
+
|
|
69348
|
+
return this.apiClient.callApi(
|
|
69349
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
|
|
69350
|
+
'GET',
|
|
69351
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
69352
|
+
{ },
|
|
69353
|
+
{ },
|
|
69354
|
+
{ },
|
|
69355
|
+
null,
|
|
69356
|
+
['PureCloud OAuth'],
|
|
69357
|
+
['application/json'],
|
|
69358
|
+
['application/json']
|
|
69359
|
+
);
|
|
69360
|
+
}
|
|
69361
|
+
|
|
69362
|
+
/**
|
|
69363
|
+
* Gets a list of time-off limit objects
|
|
69364
|
+
*
|
|
69365
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69366
|
+
* @param {Object} opts Optional parameters
|
|
69367
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific time-off limit objects
|
|
69368
|
+
*/
|
|
69369
|
+
getWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
|
|
69370
|
+
opts = opts || {};
|
|
69371
|
+
|
|
69372
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69373
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69374
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';
|
|
69375
|
+
}
|
|
69376
|
+
|
|
69377
|
+
return this.apiClient.callApi(
|
|
69378
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
69379
|
+
'GET',
|
|
69380
|
+
{ 'businessUnitId': businessUnitId },
|
|
69381
|
+
{ 'managementUnitId': opts['managementUnitId'] },
|
|
69382
|
+
{ },
|
|
69383
|
+
{ },
|
|
69384
|
+
null,
|
|
69385
|
+
['PureCloud OAuth'],
|
|
69386
|
+
['application/json'],
|
|
69387
|
+
['application/json']
|
|
69388
|
+
);
|
|
69389
|
+
}
|
|
69390
|
+
|
|
69391
|
+
/**
|
|
69392
|
+
* Gets a time-off plan
|
|
69393
|
+
*
|
|
69394
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69395
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to fetch
|
|
69396
|
+
*/
|
|
69397
|
+
getWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
|
|
69398
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69399
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69400
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
|
|
69401
|
+
}
|
|
69402
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
69403
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
69404
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
|
|
69405
|
+
}
|
|
69406
|
+
|
|
69407
|
+
return this.apiClient.callApi(
|
|
69408
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
69409
|
+
'GET',
|
|
69410
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
69411
|
+
{ },
|
|
69412
|
+
{ },
|
|
69413
|
+
{ },
|
|
69414
|
+
null,
|
|
69415
|
+
['PureCloud OAuth'],
|
|
69416
|
+
['application/json'],
|
|
69417
|
+
['application/json']
|
|
69418
|
+
);
|
|
69419
|
+
}
|
|
69420
|
+
|
|
69421
|
+
/**
|
|
69422
|
+
* Gets a list of time-off plans
|
|
69423
|
+
*
|
|
69424
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69425
|
+
* @param {Object} opts Optional parameters
|
|
69426
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
69427
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
69428
|
+
*/
|
|
69429
|
+
getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
69430
|
+
opts = opts || {};
|
|
69431
|
+
|
|
69432
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69433
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69434
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';
|
|
69435
|
+
}
|
|
69436
|
+
|
|
69437
|
+
return this.apiClient.callApi(
|
|
69438
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
69439
|
+
'GET',
|
|
69440
|
+
{ 'businessUnitId': businessUnitId },
|
|
69441
|
+
{ 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
|
|
69442
|
+
{ },
|
|
69443
|
+
{ },
|
|
69444
|
+
null,
|
|
69445
|
+
['PureCloud OAuth'],
|
|
69446
|
+
['application/json'],
|
|
69447
|
+
['application/json']
|
|
69448
|
+
);
|
|
69449
|
+
}
|
|
69450
|
+
|
|
68652
69451
|
/**
|
|
68653
69452
|
* 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
|
|
68654
69453
|
*
|
|
@@ -70461,6 +71260,74 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70461
71260
|
);
|
|
70462
71261
|
}
|
|
70463
71262
|
|
|
71263
|
+
/**
|
|
71264
|
+
* Updates a staffing group
|
|
71265
|
+
*
|
|
71266
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71267
|
+
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
71268
|
+
* @param {Object} opts Optional parameters
|
|
71269
|
+
* @param {Object} opts.body body
|
|
71270
|
+
*/
|
|
71271
|
+
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, opts) {
|
|
71272
|
+
opts = opts || {};
|
|
71273
|
+
|
|
71274
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71275
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71276
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
71277
|
+
}
|
|
71278
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
71279
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
71280
|
+
throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
71281
|
+
}
|
|
71282
|
+
|
|
71283
|
+
return this.apiClient.callApi(
|
|
71284
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
71285
|
+
'PATCH',
|
|
71286
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
71287
|
+
{ },
|
|
71288
|
+
{ },
|
|
71289
|
+
{ },
|
|
71290
|
+
opts['body'],
|
|
71291
|
+
['PureCloud OAuth'],
|
|
71292
|
+
['application/json'],
|
|
71293
|
+
['application/json']
|
|
71294
|
+
);
|
|
71295
|
+
}
|
|
71296
|
+
|
|
71297
|
+
/**
|
|
71298
|
+
* Updates a time-off plan
|
|
71299
|
+
*
|
|
71300
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71301
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
71302
|
+
* @param {Object} opts Optional parameters
|
|
71303
|
+
* @param {Object} opts.body body
|
|
71304
|
+
*/
|
|
71305
|
+
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, opts) {
|
|
71306
|
+
opts = opts || {};
|
|
71307
|
+
|
|
71308
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71309
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71310
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
71311
|
+
}
|
|
71312
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
71313
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
71314
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
71315
|
+
}
|
|
71316
|
+
|
|
71317
|
+
return this.apiClient.callApi(
|
|
71318
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
71319
|
+
'PATCH',
|
|
71320
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
71321
|
+
{ },
|
|
71322
|
+
{ },
|
|
71323
|
+
{ },
|
|
71324
|
+
opts['body'],
|
|
71325
|
+
['PureCloud OAuth'],
|
|
71326
|
+
['application/json'],
|
|
71327
|
+
['application/json']
|
|
71328
|
+
);
|
|
71329
|
+
}
|
|
71330
|
+
|
|
70464
71331
|
/**
|
|
70465
71332
|
* Update the requested management unit
|
|
70466
71333
|
*
|
|
@@ -71252,6 +72119,151 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71252
72119
|
);
|
|
71253
72120
|
}
|
|
71254
72121
|
|
|
72122
|
+
/**
|
|
72123
|
+
* Creates a new staffing group
|
|
72124
|
+
*
|
|
72125
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72126
|
+
* @param {Object} opts Optional parameters
|
|
72127
|
+
* @param {Object} opts.body body
|
|
72128
|
+
*/
|
|
72129
|
+
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
72130
|
+
opts = opts || {};
|
|
72131
|
+
|
|
72132
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72133
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72134
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
72135
|
+
}
|
|
72136
|
+
|
|
72137
|
+
return this.apiClient.callApi(
|
|
72138
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
72139
|
+
'POST',
|
|
72140
|
+
{ 'businessUnitId': businessUnitId },
|
|
72141
|
+
{ },
|
|
72142
|
+
{ },
|
|
72143
|
+
{ },
|
|
72144
|
+
opts['body'],
|
|
72145
|
+
['PureCloud OAuth'],
|
|
72146
|
+
['application/json'],
|
|
72147
|
+
['application/json']
|
|
72148
|
+
);
|
|
72149
|
+
}
|
|
72150
|
+
|
|
72151
|
+
/**
|
|
72152
|
+
* Gets staffing group associations for a list of user IDs
|
|
72153
|
+
*
|
|
72154
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72155
|
+
* @param {Object} opts Optional parameters
|
|
72156
|
+
* @param {Object} opts.body body
|
|
72157
|
+
*/
|
|
72158
|
+
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, opts) {
|
|
72159
|
+
opts = opts || {};
|
|
72160
|
+
|
|
72161
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72162
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72163
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
72164
|
+
}
|
|
72165
|
+
|
|
72166
|
+
return this.apiClient.callApi(
|
|
72167
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
|
|
72168
|
+
'POST',
|
|
72169
|
+
{ 'businessUnitId': businessUnitId },
|
|
72170
|
+
{ },
|
|
72171
|
+
{ },
|
|
72172
|
+
{ },
|
|
72173
|
+
opts['body'],
|
|
72174
|
+
['PureCloud OAuth'],
|
|
72175
|
+
['application/json'],
|
|
72176
|
+
['application/json']
|
|
72177
|
+
);
|
|
72178
|
+
}
|
|
72179
|
+
|
|
72180
|
+
/**
|
|
72181
|
+
* Creates a new time-off limit object
|
|
72182
|
+
*
|
|
72183
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72184
|
+
* @param {Object} opts Optional parameters
|
|
72185
|
+
* @param {Object} opts.body body
|
|
72186
|
+
*/
|
|
72187
|
+
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
|
|
72188
|
+
opts = opts || {};
|
|
72189
|
+
|
|
72190
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72191
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72192
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
72193
|
+
}
|
|
72194
|
+
|
|
72195
|
+
return this.apiClient.callApi(
|
|
72196
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
72197
|
+
'POST',
|
|
72198
|
+
{ 'businessUnitId': businessUnitId },
|
|
72199
|
+
{ },
|
|
72200
|
+
{ },
|
|
72201
|
+
{ },
|
|
72202
|
+
opts['body'],
|
|
72203
|
+
['PureCloud OAuth'],
|
|
72204
|
+
['application/json'],
|
|
72205
|
+
['application/json']
|
|
72206
|
+
);
|
|
72207
|
+
}
|
|
72208
|
+
|
|
72209
|
+
/**
|
|
72210
|
+
* Retrieves time-off limit related values based on a given set of filters.
|
|
72211
|
+
*
|
|
72212
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72213
|
+
* @param {Object} opts Optional parameters
|
|
72214
|
+
* @param {Object} opts.body body
|
|
72215
|
+
*/
|
|
72216
|
+
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId, opts) {
|
|
72217
|
+
opts = opts || {};
|
|
72218
|
+
|
|
72219
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72220
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72221
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
72222
|
+
}
|
|
72223
|
+
|
|
72224
|
+
return this.apiClient.callApi(
|
|
72225
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query',
|
|
72226
|
+
'POST',
|
|
72227
|
+
{ 'businessUnitId': businessUnitId },
|
|
72228
|
+
{ },
|
|
72229
|
+
{ },
|
|
72230
|
+
{ },
|
|
72231
|
+
opts['body'],
|
|
72232
|
+
['PureCloud OAuth'],
|
|
72233
|
+
['application/json'],
|
|
72234
|
+
['application/json']
|
|
72235
|
+
);
|
|
72236
|
+
}
|
|
72237
|
+
|
|
72238
|
+
/**
|
|
72239
|
+
* Creates a new time-off plan
|
|
72240
|
+
*
|
|
72241
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72242
|
+
* @param {Object} opts Optional parameters
|
|
72243
|
+
* @param {Object} opts.body body
|
|
72244
|
+
*/
|
|
72245
|
+
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
72246
|
+
opts = opts || {};
|
|
72247
|
+
|
|
72248
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72249
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72250
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
72251
|
+
}
|
|
72252
|
+
|
|
72253
|
+
return this.apiClient.callApi(
|
|
72254
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
72255
|
+
'POST',
|
|
72256
|
+
{ 'businessUnitId': businessUnitId },
|
|
72257
|
+
{ },
|
|
72258
|
+
{ },
|
|
72259
|
+
{ },
|
|
72260
|
+
opts['body'],
|
|
72261
|
+
['PureCloud OAuth'],
|
|
72262
|
+
['application/json'],
|
|
72263
|
+
['application/json']
|
|
72264
|
+
);
|
|
72265
|
+
}
|
|
72266
|
+
|
|
71255
72267
|
/**
|
|
71256
72268
|
* Loads agent schedule data from the schedule. Used in combination with the metadata route
|
|
71257
72269
|
*
|
|
@@ -72998,6 +74010,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72998
74010
|
);
|
|
72999
74011
|
}
|
|
73000
74012
|
|
|
74013
|
+
/**
|
|
74014
|
+
* Sets daily values for a date range of time-off limit object
|
|
74015
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
74016
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
74017
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
74018
|
+
* @param {Object} opts Optional parameters
|
|
74019
|
+
* @param {Object} opts.body body
|
|
74020
|
+
*/
|
|
74021
|
+
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId, opts) {
|
|
74022
|
+
opts = opts || {};
|
|
74023
|
+
|
|
74024
|
+
// verify the required parameter 'businessUnitId' is set
|
|
74025
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
74026
|
+
throw 'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
74027
|
+
}
|
|
74028
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
74029
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
74030
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
74031
|
+
}
|
|
74032
|
+
|
|
74033
|
+
return this.apiClient.callApi(
|
|
74034
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
74035
|
+
'PUT',
|
|
74036
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
74037
|
+
{ },
|
|
74038
|
+
{ },
|
|
74039
|
+
{ },
|
|
74040
|
+
opts['body'],
|
|
74041
|
+
['PureCloud OAuth'],
|
|
74042
|
+
['application/json'],
|
|
74043
|
+
['application/json']
|
|
74044
|
+
);
|
|
74045
|
+
}
|
|
74046
|
+
|
|
73001
74047
|
/**
|
|
73002
74048
|
* Sets daily values for a date range of time off limit object
|
|
73003
74049
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
@@ -73063,7 +74109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73063
74109
|
* </pre>
|
|
73064
74110
|
* </p>
|
|
73065
74111
|
* @module purecloud-platform-client-v2/index
|
|
73066
|
-
* @version
|
|
74112
|
+
* @version 191.0.0
|
|
73067
74113
|
*/
|
|
73068
74114
|
class platformClient {
|
|
73069
74115
|
constructor() {
|