purecloud-platform-client-v2 235.0.0 → 237.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +492 -88
- package/dist/web-amd/purecloud-platform-client-v2.js +492 -88
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +201 -89
- package/dist/web-cjs/purecloud-platform-client-v2.js +201 -89
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +889 -596
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +37 -3
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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/EmployeeEngagementApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +2 -2
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +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/SocialMediaApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +294 -0
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -748,7 +748,7 @@ class Configuration {
|
|
|
748
748
|
|
|
749
749
|
/**
|
|
750
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
751
|
-
* @version
|
|
751
|
+
* @version 237.0.0
|
|
752
752
|
*/
|
|
753
753
|
class ApiClient {
|
|
754
754
|
/**
|
|
@@ -2361,7 +2361,7 @@ class AIStudioApi {
|
|
|
2361
2361
|
/**
|
|
2362
2362
|
* AIStudio service.
|
|
2363
2363
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2364
|
-
* @version
|
|
2364
|
+
* @version 237.0.0
|
|
2365
2365
|
*/
|
|
2366
2366
|
|
|
2367
2367
|
/**
|
|
@@ -2933,7 +2933,7 @@ class AgentAssistantsApi {
|
|
|
2933
2933
|
/**
|
|
2934
2934
|
* AgentAssistants service.
|
|
2935
2935
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2936
|
-
* @version
|
|
2936
|
+
* @version 237.0.0
|
|
2937
2937
|
*/
|
|
2938
2938
|
|
|
2939
2939
|
/**
|
|
@@ -3419,7 +3419,7 @@ class AgentCopilotApi {
|
|
|
3419
3419
|
/**
|
|
3420
3420
|
* AgentCopilot service.
|
|
3421
3421
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3422
|
-
* @version
|
|
3422
|
+
* @version 237.0.0
|
|
3423
3423
|
*/
|
|
3424
3424
|
|
|
3425
3425
|
/**
|
|
@@ -3519,7 +3519,7 @@ class AgentUIApi {
|
|
|
3519
3519
|
/**
|
|
3520
3520
|
* AgentUI service.
|
|
3521
3521
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3522
|
-
* @version
|
|
3522
|
+
* @version 237.0.0
|
|
3523
3523
|
*/
|
|
3524
3524
|
|
|
3525
3525
|
/**
|
|
@@ -3650,7 +3650,7 @@ class AlertingApi {
|
|
|
3650
3650
|
/**
|
|
3651
3651
|
* Alerting service.
|
|
3652
3652
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3653
|
-
* @version
|
|
3653
|
+
* @version 237.0.0
|
|
3654
3654
|
*/
|
|
3655
3655
|
|
|
3656
3656
|
/**
|
|
@@ -4051,7 +4051,7 @@ class AnalyticsApi {
|
|
|
4051
4051
|
/**
|
|
4052
4052
|
* Analytics service.
|
|
4053
4053
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4054
|
-
* @version
|
|
4054
|
+
* @version 237.0.0
|
|
4055
4055
|
*/
|
|
4056
4056
|
|
|
4057
4057
|
/**
|
|
@@ -7319,7 +7319,7 @@ class ArchitectApi {
|
|
|
7319
7319
|
/**
|
|
7320
7320
|
* Architect service.
|
|
7321
7321
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7322
|
-
* @version
|
|
7322
|
+
* @version 237.0.0
|
|
7323
7323
|
*/
|
|
7324
7324
|
|
|
7325
7325
|
/**
|
|
@@ -11614,7 +11614,7 @@ class AuditApi {
|
|
|
11614
11614
|
/**
|
|
11615
11615
|
* Audit service.
|
|
11616
11616
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11617
|
-
* @version
|
|
11617
|
+
* @version 237.0.0
|
|
11618
11618
|
*/
|
|
11619
11619
|
|
|
11620
11620
|
/**
|
|
@@ -11815,7 +11815,7 @@ class AuthorizationApi {
|
|
|
11815
11815
|
/**
|
|
11816
11816
|
* Authorization service.
|
|
11817
11817
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11818
|
-
* @version
|
|
11818
|
+
* @version 237.0.0
|
|
11819
11819
|
*/
|
|
11820
11820
|
|
|
11821
11821
|
/**
|
|
@@ -12112,7 +12112,7 @@ class AuthorizationApi {
|
|
|
12112
12112
|
* @param {Object} opts Optional parameters
|
|
12113
12113
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12114
12114
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12115
|
-
* @param {String} opts.pageSize
|
|
12115
|
+
* @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
|
|
12116
12116
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
12117
12117
|
* @param {String} opts.name Optionally request specific divisions by division name
|
|
12118
12118
|
*/
|
|
@@ -13530,7 +13530,7 @@ class BillingApi {
|
|
|
13530
13530
|
/**
|
|
13531
13531
|
* Billing service.
|
|
13532
13532
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13533
|
-
* @version
|
|
13533
|
+
* @version 237.0.0
|
|
13534
13534
|
*/
|
|
13535
13535
|
|
|
13536
13536
|
/**
|
|
@@ -13786,7 +13786,7 @@ class BusinessRulesApi {
|
|
|
13786
13786
|
/**
|
|
13787
13787
|
* BusinessRules service.
|
|
13788
13788
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13789
|
-
* @version
|
|
13789
|
+
* @version 237.0.0
|
|
13790
13790
|
*/
|
|
13791
13791
|
|
|
13792
13792
|
/**
|
|
@@ -14673,7 +14673,7 @@ class CarrierServicesApi {
|
|
|
14673
14673
|
/**
|
|
14674
14674
|
* CarrierServices service.
|
|
14675
14675
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14676
|
-
* @version
|
|
14676
|
+
* @version 237.0.0
|
|
14677
14677
|
*/
|
|
14678
14678
|
|
|
14679
14679
|
/**
|
|
@@ -14743,7 +14743,7 @@ class ChatApi {
|
|
|
14743
14743
|
/**
|
|
14744
14744
|
* Chat service.
|
|
14745
14745
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14746
|
-
* @version
|
|
14746
|
+
* @version 237.0.0
|
|
14747
14747
|
*/
|
|
14748
14748
|
|
|
14749
14749
|
/**
|
|
@@ -15724,7 +15724,7 @@ class CoachingApi {
|
|
|
15724
15724
|
/**
|
|
15725
15725
|
* Coaching service.
|
|
15726
15726
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15727
|
-
* @version
|
|
15727
|
+
* @version 237.0.0
|
|
15728
15728
|
*/
|
|
15729
15729
|
|
|
15730
15730
|
/**
|
|
@@ -16351,7 +16351,7 @@ class ContentManagementApi {
|
|
|
16351
16351
|
/**
|
|
16352
16352
|
* ContentManagement service.
|
|
16353
16353
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
16354
|
-
* @version
|
|
16354
|
+
* @version 237.0.0
|
|
16355
16355
|
*/
|
|
16356
16356
|
|
|
16357
16357
|
/**
|
|
@@ -17432,7 +17432,7 @@ class ConversationsApi {
|
|
|
17432
17432
|
/**
|
|
17433
17433
|
* Conversations service.
|
|
17434
17434
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17435
|
-
* @version
|
|
17435
|
+
* @version 237.0.0
|
|
17436
17436
|
*/
|
|
17437
17437
|
|
|
17438
17438
|
/**
|
|
@@ -19513,6 +19513,42 @@ class ConversationsApi {
|
|
|
19513
19513
|
);
|
|
19514
19514
|
}
|
|
19515
19515
|
|
|
19516
|
+
/**
|
|
19517
|
+
* Get message media list by status
|
|
19518
|
+
*
|
|
19519
|
+
* @param {String} conversationId conversationId
|
|
19520
|
+
* @param {String} communicationId communicationId
|
|
19521
|
+
* @param {Object} opts Optional parameters
|
|
19522
|
+
* @param {Object} opts.status The status on which to filter the response.
|
|
19523
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19524
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19525
|
+
*/
|
|
19526
|
+
getConversationsMessageCommunicationMessagesMedia(conversationId, communicationId, opts) {
|
|
19527
|
+
opts = opts || {};
|
|
19528
|
+
|
|
19529
|
+
// verify the required parameter 'conversationId' is set
|
|
19530
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
19531
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationsMessageCommunicationMessagesMedia';
|
|
19532
|
+
}
|
|
19533
|
+
// verify the required parameter 'communicationId' is set
|
|
19534
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
19535
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationsMessageCommunicationMessagesMedia';
|
|
19536
|
+
}
|
|
19537
|
+
|
|
19538
|
+
return this.apiClient.callApi(
|
|
19539
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media',
|
|
19540
|
+
'GET',
|
|
19541
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
19542
|
+
{ 'status': opts['status'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
19543
|
+
{ },
|
|
19544
|
+
{ },
|
|
19545
|
+
null,
|
|
19546
|
+
['PureCloud OAuth'],
|
|
19547
|
+
['application/json'],
|
|
19548
|
+
['application/json']
|
|
19549
|
+
);
|
|
19550
|
+
}
|
|
19551
|
+
|
|
19516
19552
|
/**
|
|
19517
19553
|
* Get media
|
|
19518
19554
|
* See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
|
|
@@ -20752,7 +20788,6 @@ class ConversationsApi {
|
|
|
20752
20788
|
* Gets a record for a given meetingId
|
|
20753
20789
|
*
|
|
20754
20790
|
* @param {String} meetingId meetingId
|
|
20755
|
-
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20756
20791
|
*/
|
|
20757
20792
|
getConversationsVideosMeeting(meetingId) {
|
|
20758
20793
|
// verify the required parameter 'meetingId' is set
|
|
@@ -25277,7 +25312,6 @@ class ConversationsApi {
|
|
|
25277
25312
|
* Generate a meetingId for a given conferenceId
|
|
25278
25313
|
*
|
|
25279
25314
|
* @param {Object} body MeetingIdRequest
|
|
25280
|
-
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25281
25315
|
*/
|
|
25282
25316
|
postConversationsVideosMeetings(body) {
|
|
25283
25317
|
// verify the required parameter 'body' is set
|
|
@@ -26023,7 +26057,7 @@ class DataExtensionsApi {
|
|
|
26023
26057
|
/**
|
|
26024
26058
|
* DataExtensions service.
|
|
26025
26059
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
26026
|
-
* @version
|
|
26060
|
+
* @version 237.0.0
|
|
26027
26061
|
*/
|
|
26028
26062
|
|
|
26029
26063
|
/**
|
|
@@ -26109,7 +26143,7 @@ class DataPrivacyApi {
|
|
|
26109
26143
|
/**
|
|
26110
26144
|
* DataPrivacy service.
|
|
26111
26145
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
26112
|
-
* @version
|
|
26146
|
+
* @version 237.0.0
|
|
26113
26147
|
*/
|
|
26114
26148
|
|
|
26115
26149
|
/**
|
|
@@ -26279,7 +26313,7 @@ class DownloadsApi {
|
|
|
26279
26313
|
/**
|
|
26280
26314
|
* Downloads service.
|
|
26281
26315
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26282
|
-
* @version
|
|
26316
|
+
* @version 237.0.0
|
|
26283
26317
|
*/
|
|
26284
26318
|
|
|
26285
26319
|
/**
|
|
@@ -26331,7 +26365,7 @@ class EmailsApi {
|
|
|
26331
26365
|
/**
|
|
26332
26366
|
* Emails service.
|
|
26333
26367
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26334
|
-
* @version
|
|
26368
|
+
* @version 237.0.0
|
|
26335
26369
|
*/
|
|
26336
26370
|
|
|
26337
26371
|
/**
|
|
@@ -26460,7 +26494,7 @@ class EmployeeEngagementApi {
|
|
|
26460
26494
|
/**
|
|
26461
26495
|
* EmployeeEngagement service.
|
|
26462
26496
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26463
|
-
* @version
|
|
26497
|
+
* @version 237.0.0
|
|
26464
26498
|
*/
|
|
26465
26499
|
|
|
26466
26500
|
/**
|
|
@@ -26611,7 +26645,7 @@ class EventsApi {
|
|
|
26611
26645
|
/**
|
|
26612
26646
|
* Events service.
|
|
26613
26647
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26614
|
-
* @version
|
|
26648
|
+
* @version 237.0.0
|
|
26615
26649
|
*/
|
|
26616
26650
|
|
|
26617
26651
|
/**
|
|
@@ -26707,7 +26741,7 @@ class ExternalContactsApi {
|
|
|
26707
26741
|
/**
|
|
26708
26742
|
* ExternalContacts service.
|
|
26709
26743
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26710
|
-
* @version
|
|
26744
|
+
* @version 237.0.0
|
|
26711
26745
|
*/
|
|
26712
26746
|
|
|
26713
26747
|
/**
|
|
@@ -29954,7 +29988,7 @@ class FaxApi {
|
|
|
29954
29988
|
/**
|
|
29955
29989
|
* Fax service.
|
|
29956
29990
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29957
|
-
* @version
|
|
29991
|
+
* @version 237.0.0
|
|
29958
29992
|
*/
|
|
29959
29993
|
|
|
29960
29994
|
/**
|
|
@@ -30169,7 +30203,7 @@ class FlowsApi {
|
|
|
30169
30203
|
/**
|
|
30170
30204
|
* Flows service.
|
|
30171
30205
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
30172
|
-
* @version
|
|
30206
|
+
* @version 237.0.0
|
|
30173
30207
|
*/
|
|
30174
30208
|
|
|
30175
30209
|
/**
|
|
@@ -30378,7 +30412,7 @@ class GamificationApi {
|
|
|
30378
30412
|
/**
|
|
30379
30413
|
* Gamification service.
|
|
30380
30414
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30381
|
-
* @version
|
|
30415
|
+
* @version 237.0.0
|
|
30382
30416
|
*/
|
|
30383
30417
|
|
|
30384
30418
|
/**
|
|
@@ -32936,7 +32970,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
32936
32970
|
/**
|
|
32937
32971
|
* GeneralDataProtectionRegulation service.
|
|
32938
32972
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32939
|
-
* @version
|
|
32973
|
+
* @version 237.0.0
|
|
32940
32974
|
*/
|
|
32941
32975
|
|
|
32942
32976
|
/**
|
|
@@ -33066,7 +33100,7 @@ class GeolocationApi {
|
|
|
33066
33100
|
/**
|
|
33067
33101
|
* Geolocation service.
|
|
33068
33102
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
33069
|
-
* @version
|
|
33103
|
+
* @version 237.0.0
|
|
33070
33104
|
*/
|
|
33071
33105
|
|
|
33072
33106
|
/**
|
|
@@ -33197,7 +33231,7 @@ class GreetingsApi {
|
|
|
33197
33231
|
/**
|
|
33198
33232
|
* Greetings service.
|
|
33199
33233
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
33200
|
-
* @version
|
|
33234
|
+
* @version 237.0.0
|
|
33201
33235
|
*/
|
|
33202
33236
|
|
|
33203
33237
|
/**
|
|
@@ -33739,7 +33773,7 @@ class GroupsApi {
|
|
|
33739
33773
|
/**
|
|
33740
33774
|
* Groups service.
|
|
33741
33775
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33742
|
-
* @version
|
|
33776
|
+
* @version 237.0.0
|
|
33743
33777
|
*/
|
|
33744
33778
|
|
|
33745
33779
|
/**
|
|
@@ -34258,7 +34292,7 @@ class IdentityProviderApi {
|
|
|
34258
34292
|
/**
|
|
34259
34293
|
* IdentityProvider service.
|
|
34260
34294
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
34261
|
-
* @version
|
|
34295
|
+
* @version 237.0.0
|
|
34262
34296
|
*/
|
|
34263
34297
|
|
|
34264
34298
|
/**
|
|
@@ -35119,7 +35153,7 @@ class InfrastructureAsCodeApi {
|
|
|
35119
35153
|
/**
|
|
35120
35154
|
* InfrastructureAsCode service.
|
|
35121
35155
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
35122
|
-
* @version
|
|
35156
|
+
* @version 237.0.0
|
|
35123
35157
|
*/
|
|
35124
35158
|
|
|
35125
35159
|
/**
|
|
@@ -35286,7 +35320,7 @@ class IntegrationsApi {
|
|
|
35286
35320
|
/**
|
|
35287
35321
|
* Integrations service.
|
|
35288
35322
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
35289
|
-
* @version
|
|
35323
|
+
* @version 237.0.0
|
|
35290
35324
|
*/
|
|
35291
35325
|
|
|
35292
35326
|
/**
|
|
@@ -37934,7 +37968,7 @@ class JourneyApi {
|
|
|
37934
37968
|
/**
|
|
37935
37969
|
* Journey service.
|
|
37936
37970
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37937
|
-
* @version
|
|
37971
|
+
* @version 237.0.0
|
|
37938
37972
|
*/
|
|
37939
37973
|
|
|
37940
37974
|
/**
|
|
@@ -40031,7 +40065,7 @@ class KnowledgeApi {
|
|
|
40031
40065
|
/**
|
|
40032
40066
|
* Knowledge service.
|
|
40033
40067
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
40034
|
-
* @version
|
|
40068
|
+
* @version 237.0.0
|
|
40035
40069
|
*/
|
|
40036
40070
|
|
|
40037
40071
|
/**
|
|
@@ -43114,7 +43148,7 @@ class LanguageUnderstandingApi {
|
|
|
43114
43148
|
/**
|
|
43115
43149
|
* LanguageUnderstanding service.
|
|
43116
43150
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43117
|
-
* @version
|
|
43151
|
+
* @version 237.0.0
|
|
43118
43152
|
*/
|
|
43119
43153
|
|
|
43120
43154
|
/**
|
|
@@ -44333,7 +44367,7 @@ class LanguagesApi {
|
|
|
44333
44367
|
/**
|
|
44334
44368
|
* Languages service.
|
|
44335
44369
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44336
|
-
* @version
|
|
44370
|
+
* @version 237.0.0
|
|
44337
44371
|
*/
|
|
44338
44372
|
|
|
44339
44373
|
/**
|
|
@@ -44555,7 +44589,7 @@ class LearningApi {
|
|
|
44555
44589
|
/**
|
|
44556
44590
|
* Learning service.
|
|
44557
44591
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44558
|
-
* @version
|
|
44592
|
+
* @version 237.0.0
|
|
44559
44593
|
*/
|
|
44560
44594
|
|
|
44561
44595
|
/**
|
|
@@ -45404,6 +45438,32 @@ class LearningApi {
|
|
|
45404
45438
|
);
|
|
45405
45439
|
}
|
|
45406
45440
|
|
|
45441
|
+
/**
|
|
45442
|
+
* Migrate a legacy learning module rule to a users rule.
|
|
45443
|
+
*
|
|
45444
|
+
* @param {String} moduleId The ID of the learning module
|
|
45445
|
+
* postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
45446
|
+
*/
|
|
45447
|
+
postLearningModuleRuleMigrate(moduleId) {
|
|
45448
|
+
// verify the required parameter 'moduleId' is set
|
|
45449
|
+
if (moduleId === undefined || moduleId === null || moduleId === '') {
|
|
45450
|
+
throw 'Missing the required parameter "moduleId" when calling postLearningModuleRuleMigrate';
|
|
45451
|
+
}
|
|
45452
|
+
|
|
45453
|
+
return this.apiClient.callApi(
|
|
45454
|
+
'/api/v2/learning/modules/{moduleId}/rule/migrate',
|
|
45455
|
+
'POST',
|
|
45456
|
+
{ 'moduleId': moduleId },
|
|
45457
|
+
{ },
|
|
45458
|
+
{ },
|
|
45459
|
+
{ },
|
|
45460
|
+
null,
|
|
45461
|
+
['PureCloud OAuth'],
|
|
45462
|
+
['application/json'],
|
|
45463
|
+
['application/json']
|
|
45464
|
+
);
|
|
45465
|
+
}
|
|
45466
|
+
|
|
45407
45467
|
/**
|
|
45408
45468
|
* Create a new learning module
|
|
45409
45469
|
* This will create a new unpublished learning module with the specified fields.
|
|
@@ -45638,7 +45698,7 @@ class LicenseApi {
|
|
|
45638
45698
|
/**
|
|
45639
45699
|
* License service.
|
|
45640
45700
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45641
|
-
* @version
|
|
45701
|
+
* @version 237.0.0
|
|
45642
45702
|
*/
|
|
45643
45703
|
|
|
45644
45704
|
/**
|
|
@@ -45876,7 +45936,7 @@ class LocationsApi {
|
|
|
45876
45936
|
/**
|
|
45877
45937
|
* Locations service.
|
|
45878
45938
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45879
|
-
* @version
|
|
45939
|
+
* @version 237.0.0
|
|
45880
45940
|
*/
|
|
45881
45941
|
|
|
45882
45942
|
/**
|
|
@@ -46112,7 +46172,7 @@ class LogCaptureApi {
|
|
|
46112
46172
|
/**
|
|
46113
46173
|
* LogCapture service.
|
|
46114
46174
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
46115
|
-
* @version
|
|
46175
|
+
* @version 237.0.0
|
|
46116
46176
|
*/
|
|
46117
46177
|
|
|
46118
46178
|
/**
|
|
@@ -46311,7 +46371,7 @@ class MessagingApi {
|
|
|
46311
46371
|
/**
|
|
46312
46372
|
* Messaging service.
|
|
46313
46373
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46314
|
-
* @version
|
|
46374
|
+
* @version 237.0.0
|
|
46315
46375
|
*/
|
|
46316
46376
|
|
|
46317
46377
|
/**
|
|
@@ -46670,7 +46730,7 @@ class MobileDevicesApi {
|
|
|
46670
46730
|
/**
|
|
46671
46731
|
* MobileDevices service.
|
|
46672
46732
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46673
|
-
* @version
|
|
46733
|
+
* @version 237.0.0
|
|
46674
46734
|
*/
|
|
46675
46735
|
|
|
46676
46736
|
/**
|
|
@@ -46821,7 +46881,7 @@ class NotificationsApi {
|
|
|
46821
46881
|
/**
|
|
46822
46882
|
* Notifications service.
|
|
46823
46883
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46824
|
-
* @version
|
|
46884
|
+
* @version 237.0.0
|
|
46825
46885
|
*/
|
|
46826
46886
|
|
|
46827
46887
|
/**
|
|
@@ -47054,7 +47114,7 @@ class OAuthApi {
|
|
|
47054
47114
|
/**
|
|
47055
47115
|
* OAuth service.
|
|
47056
47116
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
47057
|
-
* @version
|
|
47117
|
+
* @version 237.0.0
|
|
47058
47118
|
*/
|
|
47059
47119
|
|
|
47060
47120
|
/**
|
|
@@ -47420,7 +47480,7 @@ class ObjectsApi {
|
|
|
47420
47480
|
/**
|
|
47421
47481
|
* Objects service.
|
|
47422
47482
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47423
|
-
* @version
|
|
47483
|
+
* @version 237.0.0
|
|
47424
47484
|
*/
|
|
47425
47485
|
|
|
47426
47486
|
/**
|
|
@@ -47596,7 +47656,7 @@ class ObjectsApi {
|
|
|
47596
47656
|
* @param {Object} opts Optional parameters
|
|
47597
47657
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
47598
47658
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
47599
|
-
* @param {String} opts.pageSize
|
|
47659
|
+
* @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
|
|
47600
47660
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
47601
47661
|
* @param {String} opts.name Optionally request specific divisions by division name
|
|
47602
47662
|
*/
|
|
@@ -47744,7 +47804,7 @@ class OperationalEventsApi {
|
|
|
47744
47804
|
/**
|
|
47745
47805
|
* OperationalEvents service.
|
|
47746
47806
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47747
|
-
* @version
|
|
47807
|
+
* @version 237.0.0
|
|
47748
47808
|
*/
|
|
47749
47809
|
|
|
47750
47810
|
/**
|
|
@@ -47861,7 +47921,7 @@ class OrganizationApi {
|
|
|
47861
47921
|
/**
|
|
47862
47922
|
* Organization service.
|
|
47863
47923
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47864
|
-
* @version
|
|
47924
|
+
* @version 237.0.0
|
|
47865
47925
|
*/
|
|
47866
47926
|
|
|
47867
47927
|
/**
|
|
@@ -48336,7 +48396,7 @@ class OrganizationAuthorizationApi {
|
|
|
48336
48396
|
/**
|
|
48337
48397
|
* OrganizationAuthorization service.
|
|
48338
48398
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48339
|
-
* @version
|
|
48399
|
+
* @version 237.0.0
|
|
48340
48400
|
*/
|
|
48341
48401
|
|
|
48342
48402
|
/**
|
|
@@ -49730,7 +49790,7 @@ class OutboundApi {
|
|
|
49730
49790
|
/**
|
|
49731
49791
|
* Outbound service.
|
|
49732
49792
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49733
|
-
* @version
|
|
49793
|
+
* @version 237.0.0
|
|
49734
49794
|
*/
|
|
49735
49795
|
|
|
49736
49796
|
/**
|
|
@@ -54477,7 +54537,7 @@ class PresenceApi {
|
|
|
54477
54537
|
/**
|
|
54478
54538
|
* Presence service.
|
|
54479
54539
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54480
|
-
* @version
|
|
54540
|
+
* @version 237.0.0
|
|
54481
54541
|
*/
|
|
54482
54542
|
|
|
54483
54543
|
/**
|
|
@@ -55221,7 +55281,7 @@ class ProcessAutomationApi {
|
|
|
55221
55281
|
/**
|
|
55222
55282
|
* ProcessAutomation service.
|
|
55223
55283
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55224
|
-
* @version
|
|
55284
|
+
* @version 237.0.0
|
|
55225
55285
|
*/
|
|
55226
55286
|
|
|
55227
55287
|
/**
|
|
@@ -55460,7 +55520,7 @@ class QualityApi {
|
|
|
55460
55520
|
/**
|
|
55461
55521
|
* Quality service.
|
|
55462
55522
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55463
|
-
* @version
|
|
55523
|
+
* @version 237.0.0
|
|
55464
55524
|
*/
|
|
55465
55525
|
|
|
55466
55526
|
/**
|
|
@@ -57299,7 +57359,7 @@ class RecordingApi {
|
|
|
57299
57359
|
/**
|
|
57300
57360
|
* Recording service.
|
|
57301
57361
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57302
|
-
* @version
|
|
57362
|
+
* @version 237.0.0
|
|
57303
57363
|
*/
|
|
57304
57364
|
|
|
57305
57365
|
/**
|
|
@@ -58904,7 +58964,7 @@ class ResponseManagementApi {
|
|
|
58904
58964
|
/**
|
|
58905
58965
|
* ResponseManagement service.
|
|
58906
58966
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58907
|
-
* @version
|
|
58967
|
+
* @version 237.0.0
|
|
58908
58968
|
*/
|
|
58909
58969
|
|
|
58910
58970
|
/**
|
|
@@ -59414,7 +59474,7 @@ class RoutingApi {
|
|
|
59414
59474
|
/**
|
|
59415
59475
|
* Routing service.
|
|
59416
59476
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59417
|
-
* @version
|
|
59477
|
+
* @version 237.0.0
|
|
59418
59478
|
*/
|
|
59419
59479
|
|
|
59420
59480
|
/**
|
|
@@ -63897,7 +63957,7 @@ class SCIMApi {
|
|
|
63897
63957
|
/**
|
|
63898
63958
|
* SCIM service.
|
|
63899
63959
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63900
|
-
* @version
|
|
63960
|
+
* @version 237.0.0
|
|
63901
63961
|
*/
|
|
63902
63962
|
|
|
63903
63963
|
/**
|
|
@@ -64774,7 +64834,7 @@ class ScreenRecordingApi {
|
|
|
64774
64834
|
/**
|
|
64775
64835
|
* ScreenRecording service.
|
|
64776
64836
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64777
|
-
* @version
|
|
64837
|
+
* @version 237.0.0
|
|
64778
64838
|
*/
|
|
64779
64839
|
|
|
64780
64840
|
/**
|
|
@@ -64819,7 +64879,7 @@ class ScriptsApi {
|
|
|
64819
64879
|
/**
|
|
64820
64880
|
* Scripts service.
|
|
64821
64881
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64822
|
-
* @version
|
|
64882
|
+
* @version 237.0.0
|
|
64823
64883
|
*/
|
|
64824
64884
|
|
|
64825
64885
|
/**
|
|
@@ -65295,7 +65355,7 @@ class SearchApi {
|
|
|
65295
65355
|
/**
|
|
65296
65356
|
* Search service.
|
|
65297
65357
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65298
|
-
* @version
|
|
65358
|
+
* @version 237.0.0
|
|
65299
65359
|
*/
|
|
65300
65360
|
|
|
65301
65361
|
/**
|
|
@@ -65983,7 +66043,7 @@ class SettingsApi {
|
|
|
65983
66043
|
/**
|
|
65984
66044
|
* Settings service.
|
|
65985
66045
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
65986
|
-
* @version
|
|
66046
|
+
* @version 237.0.0
|
|
65987
66047
|
*/
|
|
65988
66048
|
|
|
65989
66049
|
/**
|
|
@@ -66331,7 +66391,7 @@ class SocialMediaApi {
|
|
|
66331
66391
|
/**
|
|
66332
66392
|
* SocialMedia service.
|
|
66333
66393
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66334
|
-
* @version
|
|
66394
|
+
* @version 237.0.0
|
|
66335
66395
|
*/
|
|
66336
66396
|
|
|
66337
66397
|
/**
|
|
@@ -67926,7 +67986,7 @@ class SpeechTextAnalyticsApi {
|
|
|
67926
67986
|
/**
|
|
67927
67987
|
* SpeechTextAnalytics service.
|
|
67928
67988
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67929
|
-
* @version
|
|
67989
|
+
* @version 237.0.0
|
|
67930
67990
|
*/
|
|
67931
67991
|
|
|
67932
67992
|
/**
|
|
@@ -69573,7 +69633,7 @@ class StationsApi {
|
|
|
69573
69633
|
/**
|
|
69574
69634
|
* Stations service.
|
|
69575
69635
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69576
|
-
* @version
|
|
69636
|
+
* @version 237.0.0
|
|
69577
69637
|
*/
|
|
69578
69638
|
|
|
69579
69639
|
/**
|
|
@@ -69675,7 +69735,7 @@ class SuggestApi {
|
|
|
69675
69735
|
/**
|
|
69676
69736
|
* Suggest service.
|
|
69677
69737
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
69678
|
-
* @version
|
|
69738
|
+
* @version 237.0.0
|
|
69679
69739
|
*/
|
|
69680
69740
|
|
|
69681
69741
|
/**
|
|
@@ -69814,7 +69874,7 @@ class TaskManagementApi {
|
|
|
69814
69874
|
/**
|
|
69815
69875
|
* TaskManagement service.
|
|
69816
69876
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69817
|
-
* @version
|
|
69877
|
+
* @version 237.0.0
|
|
69818
69878
|
*/
|
|
69819
69879
|
|
|
69820
69880
|
/**
|
|
@@ -71976,7 +72036,7 @@ class TeamsApi {
|
|
|
71976
72036
|
/**
|
|
71977
72037
|
* Teams service.
|
|
71978
72038
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
71979
|
-
* @version
|
|
72039
|
+
* @version 237.0.0
|
|
71980
72040
|
*/
|
|
71981
72041
|
|
|
71982
72042
|
/**
|
|
@@ -72281,7 +72341,7 @@ class TelephonyApi {
|
|
|
72281
72341
|
/**
|
|
72282
72342
|
* Telephony service.
|
|
72283
72343
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72284
|
-
* @version
|
|
72344
|
+
* @version 237.0.0
|
|
72285
72345
|
*/
|
|
72286
72346
|
|
|
72287
72347
|
/**
|
|
@@ -72567,7 +72627,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
72567
72627
|
/**
|
|
72568
72628
|
* TelephonyProvidersEdge service.
|
|
72569
72629
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72570
|
-
* @version
|
|
72630
|
+
* @version 237.0.0
|
|
72571
72631
|
*/
|
|
72572
72632
|
|
|
72573
72633
|
/**
|
|
@@ -76060,7 +76120,7 @@ class TextbotsApi {
|
|
|
76060
76120
|
/**
|
|
76061
76121
|
* Textbots service.
|
|
76062
76122
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
76063
|
-
* @version
|
|
76123
|
+
* @version 237.0.0
|
|
76064
76124
|
*/
|
|
76065
76125
|
|
|
76066
76126
|
/**
|
|
@@ -76189,7 +76249,7 @@ class TokensApi {
|
|
|
76189
76249
|
/**
|
|
76190
76250
|
* Tokens service.
|
|
76191
76251
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76192
|
-
* @version
|
|
76252
|
+
* @version 237.0.0
|
|
76193
76253
|
*/
|
|
76194
76254
|
|
|
76195
76255
|
/**
|
|
@@ -76343,7 +76403,7 @@ class UploadsApi {
|
|
|
76343
76403
|
/**
|
|
76344
76404
|
* Uploads service.
|
|
76345
76405
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76346
|
-
* @version
|
|
76406
|
+
* @version 237.0.0
|
|
76347
76407
|
*/
|
|
76348
76408
|
|
|
76349
76409
|
/**
|
|
@@ -76634,7 +76694,7 @@ class UsageApi {
|
|
|
76634
76694
|
/**
|
|
76635
76695
|
* Usage service.
|
|
76636
76696
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76637
|
-
* @version
|
|
76697
|
+
* @version 237.0.0
|
|
76638
76698
|
*/
|
|
76639
76699
|
|
|
76640
76700
|
/**
|
|
@@ -76969,7 +77029,7 @@ class UserRecordingsApi {
|
|
|
76969
77029
|
/**
|
|
76970
77030
|
* UserRecordings service.
|
|
76971
77031
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
76972
|
-
* @version
|
|
77032
|
+
* @version 237.0.0
|
|
76973
77033
|
*/
|
|
76974
77034
|
|
|
76975
77035
|
/**
|
|
@@ -77153,7 +77213,7 @@ class UsersApi {
|
|
|
77153
77213
|
/**
|
|
77154
77214
|
* Users service.
|
|
77155
77215
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77156
|
-
* @version
|
|
77216
|
+
* @version 237.0.0
|
|
77157
77217
|
*/
|
|
77158
77218
|
|
|
77159
77219
|
/**
|
|
@@ -80158,11 +80218,300 @@ class UsersApi {
|
|
|
80158
80218
|
|
|
80159
80219
|
}
|
|
80160
80220
|
|
|
80221
|
+
class UsersRulesApi {
|
|
80222
|
+
/**
|
|
80223
|
+
* UsersRules service.
|
|
80224
|
+
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
80225
|
+
* @version 237.0.0
|
|
80226
|
+
*/
|
|
80227
|
+
|
|
80228
|
+
/**
|
|
80229
|
+
* Constructs a new UsersRulesApi.
|
|
80230
|
+
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
80231
|
+
* @class
|
|
80232
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
80233
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
80234
|
+
*/
|
|
80235
|
+
constructor(apiClient) {
|
|
80236
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
80237
|
+
}
|
|
80238
|
+
|
|
80239
|
+
|
|
80240
|
+
/**
|
|
80241
|
+
* Delete an existing users rule
|
|
80242
|
+
*
|
|
80243
|
+
* @param {String} ruleId The id of the rule
|
|
80244
|
+
* deleteUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80245
|
+
*/
|
|
80246
|
+
deleteUsersRule(ruleId) {
|
|
80247
|
+
// verify the required parameter 'ruleId' is set
|
|
80248
|
+
if (ruleId === undefined || ruleId === null || ruleId === '') {
|
|
80249
|
+
throw 'Missing the required parameter "ruleId" when calling deleteUsersRule';
|
|
80250
|
+
}
|
|
80251
|
+
|
|
80252
|
+
return this.apiClient.callApi(
|
|
80253
|
+
'/api/v2/users/rules/{ruleId}',
|
|
80254
|
+
'DELETE',
|
|
80255
|
+
{ 'ruleId': ruleId },
|
|
80256
|
+
{ },
|
|
80257
|
+
{ },
|
|
80258
|
+
{ },
|
|
80259
|
+
null,
|
|
80260
|
+
['PureCloud OAuth'],
|
|
80261
|
+
['application/json'],
|
|
80262
|
+
['application/json']
|
|
80263
|
+
);
|
|
80264
|
+
}
|
|
80265
|
+
|
|
80266
|
+
/**
|
|
80267
|
+
* Get a users rule
|
|
80268
|
+
*
|
|
80269
|
+
* @param {String} ruleId The ID of the rule to retrieve
|
|
80270
|
+
* getUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80271
|
+
*/
|
|
80272
|
+
getUsersRule(ruleId) {
|
|
80273
|
+
// verify the required parameter 'ruleId' is set
|
|
80274
|
+
if (ruleId === undefined || ruleId === null || ruleId === '') {
|
|
80275
|
+
throw 'Missing the required parameter "ruleId" when calling getUsersRule';
|
|
80276
|
+
}
|
|
80277
|
+
|
|
80278
|
+
return this.apiClient.callApi(
|
|
80279
|
+
'/api/v2/users/rules/{ruleId}',
|
|
80280
|
+
'GET',
|
|
80281
|
+
{ 'ruleId': ruleId },
|
|
80282
|
+
{ },
|
|
80283
|
+
{ },
|
|
80284
|
+
{ },
|
|
80285
|
+
null,
|
|
80286
|
+
['PureCloud OAuth'],
|
|
80287
|
+
['application/json'],
|
|
80288
|
+
['application/json']
|
|
80289
|
+
);
|
|
80290
|
+
}
|
|
80291
|
+
|
|
80292
|
+
/**
|
|
80293
|
+
* Get dependent of a users rule
|
|
80294
|
+
*
|
|
80295
|
+
* @param {String} ruleId The ID of the rule for which to retrieve dependents
|
|
80296
|
+
* @param {Object} ruleType The type of the dependent
|
|
80297
|
+
* @param {String} typeId The type ID of the dependent
|
|
80298
|
+
* getUsersRuleDependentTypeId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80299
|
+
*/
|
|
80300
|
+
getUsersRuleDependentTypeId(ruleId, ruleType, typeId) {
|
|
80301
|
+
// verify the required parameter 'ruleId' is set
|
|
80302
|
+
if (ruleId === undefined || ruleId === null || ruleId === '') {
|
|
80303
|
+
throw 'Missing the required parameter "ruleId" when calling getUsersRuleDependentTypeId';
|
|
80304
|
+
}
|
|
80305
|
+
// verify the required parameter 'ruleType' is set
|
|
80306
|
+
if (ruleType === undefined || ruleType === null || ruleType === '') {
|
|
80307
|
+
throw 'Missing the required parameter "ruleType" when calling getUsersRuleDependentTypeId';
|
|
80308
|
+
}
|
|
80309
|
+
// verify the required parameter 'typeId' is set
|
|
80310
|
+
if (typeId === undefined || typeId === null || typeId === '') {
|
|
80311
|
+
throw 'Missing the required parameter "typeId" when calling getUsersRuleDependentTypeId';
|
|
80312
|
+
}
|
|
80313
|
+
|
|
80314
|
+
return this.apiClient.callApi(
|
|
80315
|
+
'/api/v2/users/rules/{ruleId}/dependents/{ruleType}/{typeId}',
|
|
80316
|
+
'GET',
|
|
80317
|
+
{ 'ruleId': ruleId,'ruleType': ruleType,'typeId': typeId },
|
|
80318
|
+
{ },
|
|
80319
|
+
{ },
|
|
80320
|
+
{ },
|
|
80321
|
+
null,
|
|
80322
|
+
['PureCloud OAuth'],
|
|
80323
|
+
['application/json'],
|
|
80324
|
+
['application/json']
|
|
80325
|
+
);
|
|
80326
|
+
}
|
|
80327
|
+
|
|
80328
|
+
/**
|
|
80329
|
+
* Get dependents for a users rule
|
|
80330
|
+
*
|
|
80331
|
+
* @param {String} ruleId The ID of the rule for which to retrieve dependents
|
|
80332
|
+
* @param {Object} opts Optional parameters
|
|
80333
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
80334
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
80335
|
+
* @param {Object} opts.sortOrder Sort order for dependents (by last run date, then created date) (default to descending)
|
|
80336
|
+
* getUsersRuleDependents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80337
|
+
*/
|
|
80338
|
+
getUsersRuleDependents(ruleId, opts) {
|
|
80339
|
+
opts = opts || {};
|
|
80340
|
+
|
|
80341
|
+
// verify the required parameter 'ruleId' is set
|
|
80342
|
+
if (ruleId === undefined || ruleId === null || ruleId === '') {
|
|
80343
|
+
throw 'Missing the required parameter "ruleId" when calling getUsersRuleDependents';
|
|
80344
|
+
}
|
|
80345
|
+
|
|
80346
|
+
return this.apiClient.callApi(
|
|
80347
|
+
'/api/v2/users/rules/{ruleId}/dependents',
|
|
80348
|
+
'GET',
|
|
80349
|
+
{ 'ruleId': ruleId },
|
|
80350
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
80351
|
+
{ },
|
|
80352
|
+
{ },
|
|
80353
|
+
null,
|
|
80354
|
+
['PureCloud OAuth'],
|
|
80355
|
+
['application/json'],
|
|
80356
|
+
['application/json']
|
|
80357
|
+
);
|
|
80358
|
+
}
|
|
80359
|
+
|
|
80360
|
+
/**
|
|
80361
|
+
* Get the list of users rules
|
|
80362
|
+
*
|
|
80363
|
+
* @param {Array.<String>} types The types of the rule
|
|
80364
|
+
* @param {Object} opts Optional parameters
|
|
80365
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
80366
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
80367
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
80368
|
+
* @param {String} opts.searchTerm a search term for finding a rule by name
|
|
80369
|
+
* @param {Object} opts.sortOrder sort rules by name, ascending, descending (default to ascending)
|
|
80370
|
+
* getUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80371
|
+
*/
|
|
80372
|
+
getUsersRules(types, opts) {
|
|
80373
|
+
opts = opts || {};
|
|
80374
|
+
|
|
80375
|
+
// verify the required parameter 'types' is set
|
|
80376
|
+
if (types === undefined || types === null) {
|
|
80377
|
+
throw 'Missing the required parameter "types" when calling getUsersRules';
|
|
80378
|
+
}
|
|
80379
|
+
|
|
80380
|
+
return this.apiClient.callApi(
|
|
80381
|
+
'/api/v2/users/rules',
|
|
80382
|
+
'GET',
|
|
80383
|
+
{ },
|
|
80384
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'types': this.apiClient.buildCollectionParam(types, 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'searchTerm': opts['searchTerm'],'sortOrder': opts['sortOrder'] },
|
|
80385
|
+
{ },
|
|
80386
|
+
{ },
|
|
80387
|
+
null,
|
|
80388
|
+
['PureCloud OAuth'],
|
|
80389
|
+
['application/json'],
|
|
80390
|
+
['application/json']
|
|
80391
|
+
);
|
|
80392
|
+
}
|
|
80393
|
+
|
|
80394
|
+
/**
|
|
80395
|
+
* Get the settings for a specific users rule type
|
|
80396
|
+
*
|
|
80397
|
+
* @param {Object} ruleType The type of the rule
|
|
80398
|
+
* getUsersRulesSetting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80399
|
+
*/
|
|
80400
|
+
getUsersRulesSetting(ruleType) {
|
|
80401
|
+
// verify the required parameter 'ruleType' is set
|
|
80402
|
+
if (ruleType === undefined || ruleType === null || ruleType === '') {
|
|
80403
|
+
throw 'Missing the required parameter "ruleType" when calling getUsersRulesSetting';
|
|
80404
|
+
}
|
|
80405
|
+
|
|
80406
|
+
return this.apiClient.callApi(
|
|
80407
|
+
'/api/v2/users/rules/settings/{ruleType}',
|
|
80408
|
+
'GET',
|
|
80409
|
+
{ 'ruleType': ruleType },
|
|
80410
|
+
{ },
|
|
80411
|
+
{ },
|
|
80412
|
+
{ },
|
|
80413
|
+
null,
|
|
80414
|
+
['PureCloud OAuth'],
|
|
80415
|
+
['application/json'],
|
|
80416
|
+
['application/json']
|
|
80417
|
+
);
|
|
80418
|
+
}
|
|
80419
|
+
|
|
80420
|
+
/**
|
|
80421
|
+
* Update an existing users rule
|
|
80422
|
+
* This will update an existing users rule with the specified fields.
|
|
80423
|
+
* @param {String} ruleId The ID of the rule to update
|
|
80424
|
+
* @param {Object} body updateRuleRequest
|
|
80425
|
+
* patchUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80426
|
+
*/
|
|
80427
|
+
patchUsersRule(ruleId, body) {
|
|
80428
|
+
// verify the required parameter 'ruleId' is set
|
|
80429
|
+
if (ruleId === undefined || ruleId === null || ruleId === '') {
|
|
80430
|
+
throw 'Missing the required parameter "ruleId" when calling patchUsersRule';
|
|
80431
|
+
}
|
|
80432
|
+
// verify the required parameter 'body' is set
|
|
80433
|
+
if (body === undefined || body === null) {
|
|
80434
|
+
throw 'Missing the required parameter "body" when calling patchUsersRule';
|
|
80435
|
+
}
|
|
80436
|
+
|
|
80437
|
+
return this.apiClient.callApi(
|
|
80438
|
+
'/api/v2/users/rules/{ruleId}',
|
|
80439
|
+
'PATCH',
|
|
80440
|
+
{ 'ruleId': ruleId },
|
|
80441
|
+
{ },
|
|
80442
|
+
{ },
|
|
80443
|
+
{ },
|
|
80444
|
+
body,
|
|
80445
|
+
['PureCloud OAuth'],
|
|
80446
|
+
['application/json'],
|
|
80447
|
+
['application/json']
|
|
80448
|
+
);
|
|
80449
|
+
}
|
|
80450
|
+
|
|
80451
|
+
/**
|
|
80452
|
+
* Create a new rule
|
|
80453
|
+
* This will create a new rule with the specified fields.
|
|
80454
|
+
* @param {Object} body usersRulesCreateRuleRequest
|
|
80455
|
+
* postUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80456
|
+
*/
|
|
80457
|
+
postUsersRules(body) {
|
|
80458
|
+
// verify the required parameter 'body' is set
|
|
80459
|
+
if (body === undefined || body === null) {
|
|
80460
|
+
throw 'Missing the required parameter "body" when calling postUsersRules';
|
|
80461
|
+
}
|
|
80462
|
+
|
|
80463
|
+
return this.apiClient.callApi(
|
|
80464
|
+
'/api/v2/users/rules',
|
|
80465
|
+
'POST',
|
|
80466
|
+
{ },
|
|
80467
|
+
{ },
|
|
80468
|
+
{ },
|
|
80469
|
+
{ },
|
|
80470
|
+
body,
|
|
80471
|
+
['PureCloud OAuth'],
|
|
80472
|
+
['application/json'],
|
|
80473
|
+
['application/json']
|
|
80474
|
+
);
|
|
80475
|
+
}
|
|
80476
|
+
|
|
80477
|
+
/**
|
|
80478
|
+
* Query the result of a users rule
|
|
80479
|
+
* This will query the result of a rule.
|
|
80480
|
+
* @param {Object} body usersRulesQueryRuleRequest
|
|
80481
|
+
* @param {Object} opts Optional parameters
|
|
80482
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
80483
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
80484
|
+
* postUsersRulesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80485
|
+
*/
|
|
80486
|
+
postUsersRulesQuery(body, opts) {
|
|
80487
|
+
opts = opts || {};
|
|
80488
|
+
|
|
80489
|
+
// verify the required parameter 'body' is set
|
|
80490
|
+
if (body === undefined || body === null) {
|
|
80491
|
+
throw 'Missing the required parameter "body" when calling postUsersRulesQuery';
|
|
80492
|
+
}
|
|
80493
|
+
|
|
80494
|
+
return this.apiClient.callApi(
|
|
80495
|
+
'/api/v2/users/rules/query',
|
|
80496
|
+
'POST',
|
|
80497
|
+
{ },
|
|
80498
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
80499
|
+
{ },
|
|
80500
|
+
{ },
|
|
80501
|
+
body,
|
|
80502
|
+
['PureCloud OAuth'],
|
|
80503
|
+
['application/json'],
|
|
80504
|
+
['application/json']
|
|
80505
|
+
);
|
|
80506
|
+
}
|
|
80507
|
+
|
|
80508
|
+
}
|
|
80509
|
+
|
|
80161
80510
|
class UtilitiesApi {
|
|
80162
80511
|
/**
|
|
80163
80512
|
* Utilities service.
|
|
80164
80513
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80165
|
-
* @version
|
|
80514
|
+
* @version 237.0.0
|
|
80166
80515
|
*/
|
|
80167
80516
|
|
|
80168
80517
|
/**
|
|
@@ -80273,7 +80622,7 @@ class VoicemailApi {
|
|
|
80273
80622
|
/**
|
|
80274
80623
|
* Voicemail service.
|
|
80275
80624
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80276
|
-
* @version
|
|
80625
|
+
* @version 237.0.0
|
|
80277
80626
|
*/
|
|
80278
80627
|
|
|
80279
80628
|
/**
|
|
@@ -80995,7 +81344,7 @@ class WebChatApi {
|
|
|
80995
81344
|
/**
|
|
80996
81345
|
* WebChat service.
|
|
80997
81346
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
80998
|
-
* @version
|
|
81347
|
+
* @version 237.0.0
|
|
80999
81348
|
*/
|
|
81000
81349
|
|
|
81001
81350
|
/**
|
|
@@ -81558,7 +81907,7 @@ class WebDeploymentsApi {
|
|
|
81558
81907
|
/**
|
|
81559
81908
|
* WebDeployments service.
|
|
81560
81909
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81561
|
-
* @version
|
|
81910
|
+
* @version 237.0.0
|
|
81562
81911
|
*/
|
|
81563
81912
|
|
|
81564
81913
|
/**
|
|
@@ -82140,7 +82489,7 @@ class WebMessagingApi {
|
|
|
82140
82489
|
/**
|
|
82141
82490
|
* WebMessaging service.
|
|
82142
82491
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82143
|
-
* @version
|
|
82492
|
+
* @version 237.0.0
|
|
82144
82493
|
*/
|
|
82145
82494
|
|
|
82146
82495
|
/**
|
|
@@ -82286,7 +82635,7 @@ class WidgetsApi {
|
|
|
82286
82635
|
/**
|
|
82287
82636
|
* Widgets service.
|
|
82288
82637
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82289
|
-
* @version
|
|
82638
|
+
* @version 237.0.0
|
|
82290
82639
|
*/
|
|
82291
82640
|
|
|
82292
82641
|
/**
|
|
@@ -82437,7 +82786,7 @@ class WorkforceManagementApi {
|
|
|
82437
82786
|
/**
|
|
82438
82787
|
* WorkforceManagement service.
|
|
82439
82788
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
82440
|
-
* @version
|
|
82789
|
+
* @version 237.0.0
|
|
82441
82790
|
*/
|
|
82442
82791
|
|
|
82443
82792
|
/**
|
|
@@ -83201,6 +83550,31 @@ class WorkforceManagementApi {
|
|
|
83201
83550
|
);
|
|
83202
83551
|
}
|
|
83203
83552
|
|
|
83553
|
+
/**
|
|
83554
|
+
* Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status
|
|
83555
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
83556
|
+
* @param {String} jobId ID of the job to get
|
|
83557
|
+
*/
|
|
83558
|
+
getWorkforcemanagementAgentsMeAdherenceHistoricalJob(jobId) {
|
|
83559
|
+
// verify the required parameter 'jobId' is set
|
|
83560
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
83561
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAgentsMeAdherenceHistoricalJob';
|
|
83562
|
+
}
|
|
83563
|
+
|
|
83564
|
+
return this.apiClient.callApi(
|
|
83565
|
+
'/api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}',
|
|
83566
|
+
'GET',
|
|
83567
|
+
{ 'jobId': jobId },
|
|
83568
|
+
{ },
|
|
83569
|
+
{ },
|
|
83570
|
+
{ },
|
|
83571
|
+
null,
|
|
83572
|
+
['PureCloud OAuth'],
|
|
83573
|
+
['application/json'],
|
|
83574
|
+
['application/json']
|
|
83575
|
+
);
|
|
83576
|
+
}
|
|
83577
|
+
|
|
83204
83578
|
/**
|
|
83205
83579
|
* Get the management unit to which the currently logged in agent belongs
|
|
83206
83580
|
*
|
|
@@ -87549,6 +87923,31 @@ class WorkforceManagementApi {
|
|
|
87549
87923
|
);
|
|
87550
87924
|
}
|
|
87551
87925
|
|
|
87926
|
+
/**
|
|
87927
|
+
* Request an agent historical adherence report
|
|
87928
|
+
* The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
|
|
87929
|
+
* @param {Object} opts Optional parameters
|
|
87930
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities.
|
|
87931
|
+
* @param {Object} opts.body body
|
|
87932
|
+
*/
|
|
87933
|
+
postWorkforcemanagementAgentsMeAdherenceHistoricalJobs(opts) {
|
|
87934
|
+
opts = opts || {};
|
|
87935
|
+
|
|
87936
|
+
|
|
87937
|
+
return this.apiClient.callApi(
|
|
87938
|
+
'/api/v2/workforcemanagement/agents/me/adherence/historical/jobs',
|
|
87939
|
+
'POST',
|
|
87940
|
+
{ },
|
|
87941
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
87942
|
+
{ },
|
|
87943
|
+
{ },
|
|
87944
|
+
opts['body'],
|
|
87945
|
+
['PureCloud OAuth'],
|
|
87946
|
+
['application/json'],
|
|
87947
|
+
['application/json']
|
|
87948
|
+
);
|
|
87949
|
+
}
|
|
87950
|
+
|
|
87552
87951
|
/**
|
|
87553
87952
|
* Get agent possible work shifts for requested time frame
|
|
87554
87953
|
*
|
|
@@ -90438,7 +90837,7 @@ class WorkforceManagementApi {
|
|
|
90438
90837
|
* </pre>
|
|
90439
90838
|
* </p>
|
|
90440
90839
|
* @module purecloud-platform-client-v2/index
|
|
90441
|
-
* @version
|
|
90840
|
+
* @version 237.0.0
|
|
90442
90841
|
*/
|
|
90443
90842
|
class platformClient {
|
|
90444
90843
|
constructor() {
|
|
@@ -90827,6 +91226,11 @@ class platformClient {
|
|
|
90827
91226
|
* @property {module:purecloud-platform-client-v2/api/UsersApi}
|
|
90828
91227
|
*/
|
|
90829
91228
|
this.UsersApi = UsersApi;
|
|
91229
|
+
/**
|
|
91230
|
+
* The UsersRulesApi service constructor.
|
|
91231
|
+
* @property {module:purecloud-platform-client-v2/api/UsersRulesApi}
|
|
91232
|
+
*/
|
|
91233
|
+
this.UsersRulesApi = UsersRulesApi;
|
|
90830
91234
|
/**
|
|
90831
91235
|
* The UtilitiesApi service constructor.
|
|
90832
91236
|
* @property {module:purecloud-platform-client-v2/api/UtilitiesApi}
|