purecloud-platform-client-v2 236.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 +454 -86
- package/dist/web-amd/purecloud-platform-client-v2.js +454 -86
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +188 -87
- package/dist/web-cjs/purecloud-platform-client-v2.js +188 -87
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +538 -337
- 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 +1 -1
- 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 +1 -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 +1 -1
- 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
|
/**
|
|
@@ -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
|
/**
|
|
@@ -20788,7 +20788,6 @@ class ConversationsApi {
|
|
|
20788
20788
|
* Gets a record for a given meetingId
|
|
20789
20789
|
*
|
|
20790
20790
|
* @param {String} meetingId meetingId
|
|
20791
|
-
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20792
20791
|
*/
|
|
20793
20792
|
getConversationsVideosMeeting(meetingId) {
|
|
20794
20793
|
// verify the required parameter 'meetingId' is set
|
|
@@ -25313,7 +25312,6 @@ class ConversationsApi {
|
|
|
25313
25312
|
* Generate a meetingId for a given conferenceId
|
|
25314
25313
|
*
|
|
25315
25314
|
* @param {Object} body MeetingIdRequest
|
|
25316
|
-
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25317
25315
|
*/
|
|
25318
25316
|
postConversationsVideosMeetings(body) {
|
|
25319
25317
|
// verify the required parameter 'body' is set
|
|
@@ -26059,7 +26057,7 @@ class DataExtensionsApi {
|
|
|
26059
26057
|
/**
|
|
26060
26058
|
* DataExtensions service.
|
|
26061
26059
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
26062
|
-
* @version
|
|
26060
|
+
* @version 237.0.0
|
|
26063
26061
|
*/
|
|
26064
26062
|
|
|
26065
26063
|
/**
|
|
@@ -26145,7 +26143,7 @@ class DataPrivacyApi {
|
|
|
26145
26143
|
/**
|
|
26146
26144
|
* DataPrivacy service.
|
|
26147
26145
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
26148
|
-
* @version
|
|
26146
|
+
* @version 237.0.0
|
|
26149
26147
|
*/
|
|
26150
26148
|
|
|
26151
26149
|
/**
|
|
@@ -26315,7 +26313,7 @@ class DownloadsApi {
|
|
|
26315
26313
|
/**
|
|
26316
26314
|
* Downloads service.
|
|
26317
26315
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26318
|
-
* @version
|
|
26316
|
+
* @version 237.0.0
|
|
26319
26317
|
*/
|
|
26320
26318
|
|
|
26321
26319
|
/**
|
|
@@ -26367,7 +26365,7 @@ class EmailsApi {
|
|
|
26367
26365
|
/**
|
|
26368
26366
|
* Emails service.
|
|
26369
26367
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26370
|
-
* @version
|
|
26368
|
+
* @version 237.0.0
|
|
26371
26369
|
*/
|
|
26372
26370
|
|
|
26373
26371
|
/**
|
|
@@ -26496,7 +26494,7 @@ class EmployeeEngagementApi {
|
|
|
26496
26494
|
/**
|
|
26497
26495
|
* EmployeeEngagement service.
|
|
26498
26496
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26499
|
-
* @version
|
|
26497
|
+
* @version 237.0.0
|
|
26500
26498
|
*/
|
|
26501
26499
|
|
|
26502
26500
|
/**
|
|
@@ -26647,7 +26645,7 @@ class EventsApi {
|
|
|
26647
26645
|
/**
|
|
26648
26646
|
* Events service.
|
|
26649
26647
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26650
|
-
* @version
|
|
26648
|
+
* @version 237.0.0
|
|
26651
26649
|
*/
|
|
26652
26650
|
|
|
26653
26651
|
/**
|
|
@@ -26743,7 +26741,7 @@ class ExternalContactsApi {
|
|
|
26743
26741
|
/**
|
|
26744
26742
|
* ExternalContacts service.
|
|
26745
26743
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26746
|
-
* @version
|
|
26744
|
+
* @version 237.0.0
|
|
26747
26745
|
*/
|
|
26748
26746
|
|
|
26749
26747
|
/**
|
|
@@ -29990,7 +29988,7 @@ class FaxApi {
|
|
|
29990
29988
|
/**
|
|
29991
29989
|
* Fax service.
|
|
29992
29990
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29993
|
-
* @version
|
|
29991
|
+
* @version 237.0.0
|
|
29994
29992
|
*/
|
|
29995
29993
|
|
|
29996
29994
|
/**
|
|
@@ -30205,7 +30203,7 @@ class FlowsApi {
|
|
|
30205
30203
|
/**
|
|
30206
30204
|
* Flows service.
|
|
30207
30205
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
30208
|
-
* @version
|
|
30206
|
+
* @version 237.0.0
|
|
30209
30207
|
*/
|
|
30210
30208
|
|
|
30211
30209
|
/**
|
|
@@ -30414,7 +30412,7 @@ class GamificationApi {
|
|
|
30414
30412
|
/**
|
|
30415
30413
|
* Gamification service.
|
|
30416
30414
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30417
|
-
* @version
|
|
30415
|
+
* @version 237.0.0
|
|
30418
30416
|
*/
|
|
30419
30417
|
|
|
30420
30418
|
/**
|
|
@@ -32972,7 +32970,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
32972
32970
|
/**
|
|
32973
32971
|
* GeneralDataProtectionRegulation service.
|
|
32974
32972
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32975
|
-
* @version
|
|
32973
|
+
* @version 237.0.0
|
|
32976
32974
|
*/
|
|
32977
32975
|
|
|
32978
32976
|
/**
|
|
@@ -33102,7 +33100,7 @@ class GeolocationApi {
|
|
|
33102
33100
|
/**
|
|
33103
33101
|
* Geolocation service.
|
|
33104
33102
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
33105
|
-
* @version
|
|
33103
|
+
* @version 237.0.0
|
|
33106
33104
|
*/
|
|
33107
33105
|
|
|
33108
33106
|
/**
|
|
@@ -33233,7 +33231,7 @@ class GreetingsApi {
|
|
|
33233
33231
|
/**
|
|
33234
33232
|
* Greetings service.
|
|
33235
33233
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
33236
|
-
* @version
|
|
33234
|
+
* @version 237.0.0
|
|
33237
33235
|
*/
|
|
33238
33236
|
|
|
33239
33237
|
/**
|
|
@@ -33775,7 +33773,7 @@ class GroupsApi {
|
|
|
33775
33773
|
/**
|
|
33776
33774
|
* Groups service.
|
|
33777
33775
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33778
|
-
* @version
|
|
33776
|
+
* @version 237.0.0
|
|
33779
33777
|
*/
|
|
33780
33778
|
|
|
33781
33779
|
/**
|
|
@@ -34294,7 +34292,7 @@ class IdentityProviderApi {
|
|
|
34294
34292
|
/**
|
|
34295
34293
|
* IdentityProvider service.
|
|
34296
34294
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
34297
|
-
* @version
|
|
34295
|
+
* @version 237.0.0
|
|
34298
34296
|
*/
|
|
34299
34297
|
|
|
34300
34298
|
/**
|
|
@@ -35155,7 +35153,7 @@ class InfrastructureAsCodeApi {
|
|
|
35155
35153
|
/**
|
|
35156
35154
|
* InfrastructureAsCode service.
|
|
35157
35155
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
35158
|
-
* @version
|
|
35156
|
+
* @version 237.0.0
|
|
35159
35157
|
*/
|
|
35160
35158
|
|
|
35161
35159
|
/**
|
|
@@ -35322,7 +35320,7 @@ class IntegrationsApi {
|
|
|
35322
35320
|
/**
|
|
35323
35321
|
* Integrations service.
|
|
35324
35322
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
35325
|
-
* @version
|
|
35323
|
+
* @version 237.0.0
|
|
35326
35324
|
*/
|
|
35327
35325
|
|
|
35328
35326
|
/**
|
|
@@ -37970,7 +37968,7 @@ class JourneyApi {
|
|
|
37970
37968
|
/**
|
|
37971
37969
|
* Journey service.
|
|
37972
37970
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37973
|
-
* @version
|
|
37971
|
+
* @version 237.0.0
|
|
37974
37972
|
*/
|
|
37975
37973
|
|
|
37976
37974
|
/**
|
|
@@ -40067,7 +40065,7 @@ class KnowledgeApi {
|
|
|
40067
40065
|
/**
|
|
40068
40066
|
* Knowledge service.
|
|
40069
40067
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
40070
|
-
* @version
|
|
40068
|
+
* @version 237.0.0
|
|
40071
40069
|
*/
|
|
40072
40070
|
|
|
40073
40071
|
/**
|
|
@@ -43150,7 +43148,7 @@ class LanguageUnderstandingApi {
|
|
|
43150
43148
|
/**
|
|
43151
43149
|
* LanguageUnderstanding service.
|
|
43152
43150
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43153
|
-
* @version
|
|
43151
|
+
* @version 237.0.0
|
|
43154
43152
|
*/
|
|
43155
43153
|
|
|
43156
43154
|
/**
|
|
@@ -44369,7 +44367,7 @@ class LanguagesApi {
|
|
|
44369
44367
|
/**
|
|
44370
44368
|
* Languages service.
|
|
44371
44369
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44372
|
-
* @version
|
|
44370
|
+
* @version 237.0.0
|
|
44373
44371
|
*/
|
|
44374
44372
|
|
|
44375
44373
|
/**
|
|
@@ -44591,7 +44589,7 @@ class LearningApi {
|
|
|
44591
44589
|
/**
|
|
44592
44590
|
* Learning service.
|
|
44593
44591
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44594
|
-
* @version
|
|
44592
|
+
* @version 237.0.0
|
|
44595
44593
|
*/
|
|
44596
44594
|
|
|
44597
44595
|
/**
|
|
@@ -45440,6 +45438,32 @@ class LearningApi {
|
|
|
45440
45438
|
);
|
|
45441
45439
|
}
|
|
45442
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
|
+
|
|
45443
45467
|
/**
|
|
45444
45468
|
* Create a new learning module
|
|
45445
45469
|
* This will create a new unpublished learning module with the specified fields.
|
|
@@ -45674,7 +45698,7 @@ class LicenseApi {
|
|
|
45674
45698
|
/**
|
|
45675
45699
|
* License service.
|
|
45676
45700
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45677
|
-
* @version
|
|
45701
|
+
* @version 237.0.0
|
|
45678
45702
|
*/
|
|
45679
45703
|
|
|
45680
45704
|
/**
|
|
@@ -45912,7 +45936,7 @@ class LocationsApi {
|
|
|
45912
45936
|
/**
|
|
45913
45937
|
* Locations service.
|
|
45914
45938
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45915
|
-
* @version
|
|
45939
|
+
* @version 237.0.0
|
|
45916
45940
|
*/
|
|
45917
45941
|
|
|
45918
45942
|
/**
|
|
@@ -46148,7 +46172,7 @@ class LogCaptureApi {
|
|
|
46148
46172
|
/**
|
|
46149
46173
|
* LogCapture service.
|
|
46150
46174
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
46151
|
-
* @version
|
|
46175
|
+
* @version 237.0.0
|
|
46152
46176
|
*/
|
|
46153
46177
|
|
|
46154
46178
|
/**
|
|
@@ -46347,7 +46371,7 @@ class MessagingApi {
|
|
|
46347
46371
|
/**
|
|
46348
46372
|
* Messaging service.
|
|
46349
46373
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46350
|
-
* @version
|
|
46374
|
+
* @version 237.0.0
|
|
46351
46375
|
*/
|
|
46352
46376
|
|
|
46353
46377
|
/**
|
|
@@ -46706,7 +46730,7 @@ class MobileDevicesApi {
|
|
|
46706
46730
|
/**
|
|
46707
46731
|
* MobileDevices service.
|
|
46708
46732
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46709
|
-
* @version
|
|
46733
|
+
* @version 237.0.0
|
|
46710
46734
|
*/
|
|
46711
46735
|
|
|
46712
46736
|
/**
|
|
@@ -46857,7 +46881,7 @@ class NotificationsApi {
|
|
|
46857
46881
|
/**
|
|
46858
46882
|
* Notifications service.
|
|
46859
46883
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46860
|
-
* @version
|
|
46884
|
+
* @version 237.0.0
|
|
46861
46885
|
*/
|
|
46862
46886
|
|
|
46863
46887
|
/**
|
|
@@ -47090,7 +47114,7 @@ class OAuthApi {
|
|
|
47090
47114
|
/**
|
|
47091
47115
|
* OAuth service.
|
|
47092
47116
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
47093
|
-
* @version
|
|
47117
|
+
* @version 237.0.0
|
|
47094
47118
|
*/
|
|
47095
47119
|
|
|
47096
47120
|
/**
|
|
@@ -47456,7 +47480,7 @@ class ObjectsApi {
|
|
|
47456
47480
|
/**
|
|
47457
47481
|
* Objects service.
|
|
47458
47482
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47459
|
-
* @version
|
|
47483
|
+
* @version 237.0.0
|
|
47460
47484
|
*/
|
|
47461
47485
|
|
|
47462
47486
|
/**
|
|
@@ -47780,7 +47804,7 @@ class OperationalEventsApi {
|
|
|
47780
47804
|
/**
|
|
47781
47805
|
* OperationalEvents service.
|
|
47782
47806
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47783
|
-
* @version
|
|
47807
|
+
* @version 237.0.0
|
|
47784
47808
|
*/
|
|
47785
47809
|
|
|
47786
47810
|
/**
|
|
@@ -47897,7 +47921,7 @@ class OrganizationApi {
|
|
|
47897
47921
|
/**
|
|
47898
47922
|
* Organization service.
|
|
47899
47923
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47900
|
-
* @version
|
|
47924
|
+
* @version 237.0.0
|
|
47901
47925
|
*/
|
|
47902
47926
|
|
|
47903
47927
|
/**
|
|
@@ -48372,7 +48396,7 @@ class OrganizationAuthorizationApi {
|
|
|
48372
48396
|
/**
|
|
48373
48397
|
* OrganizationAuthorization service.
|
|
48374
48398
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48375
|
-
* @version
|
|
48399
|
+
* @version 237.0.0
|
|
48376
48400
|
*/
|
|
48377
48401
|
|
|
48378
48402
|
/**
|
|
@@ -49766,7 +49790,7 @@ class OutboundApi {
|
|
|
49766
49790
|
/**
|
|
49767
49791
|
* Outbound service.
|
|
49768
49792
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49769
|
-
* @version
|
|
49793
|
+
* @version 237.0.0
|
|
49770
49794
|
*/
|
|
49771
49795
|
|
|
49772
49796
|
/**
|
|
@@ -54513,7 +54537,7 @@ class PresenceApi {
|
|
|
54513
54537
|
/**
|
|
54514
54538
|
* Presence service.
|
|
54515
54539
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54516
|
-
* @version
|
|
54540
|
+
* @version 237.0.0
|
|
54517
54541
|
*/
|
|
54518
54542
|
|
|
54519
54543
|
/**
|
|
@@ -55257,7 +55281,7 @@ class ProcessAutomationApi {
|
|
|
55257
55281
|
/**
|
|
55258
55282
|
* ProcessAutomation service.
|
|
55259
55283
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55260
|
-
* @version
|
|
55284
|
+
* @version 237.0.0
|
|
55261
55285
|
*/
|
|
55262
55286
|
|
|
55263
55287
|
/**
|
|
@@ -55496,7 +55520,7 @@ class QualityApi {
|
|
|
55496
55520
|
/**
|
|
55497
55521
|
* Quality service.
|
|
55498
55522
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55499
|
-
* @version
|
|
55523
|
+
* @version 237.0.0
|
|
55500
55524
|
*/
|
|
55501
55525
|
|
|
55502
55526
|
/**
|
|
@@ -57335,7 +57359,7 @@ class RecordingApi {
|
|
|
57335
57359
|
/**
|
|
57336
57360
|
* Recording service.
|
|
57337
57361
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57338
|
-
* @version
|
|
57362
|
+
* @version 237.0.0
|
|
57339
57363
|
*/
|
|
57340
57364
|
|
|
57341
57365
|
/**
|
|
@@ -58940,7 +58964,7 @@ class ResponseManagementApi {
|
|
|
58940
58964
|
/**
|
|
58941
58965
|
* ResponseManagement service.
|
|
58942
58966
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58943
|
-
* @version
|
|
58967
|
+
* @version 237.0.0
|
|
58944
58968
|
*/
|
|
58945
58969
|
|
|
58946
58970
|
/**
|
|
@@ -59450,7 +59474,7 @@ class RoutingApi {
|
|
|
59450
59474
|
/**
|
|
59451
59475
|
* Routing service.
|
|
59452
59476
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59453
|
-
* @version
|
|
59477
|
+
* @version 237.0.0
|
|
59454
59478
|
*/
|
|
59455
59479
|
|
|
59456
59480
|
/**
|
|
@@ -63933,7 +63957,7 @@ class SCIMApi {
|
|
|
63933
63957
|
/**
|
|
63934
63958
|
* SCIM service.
|
|
63935
63959
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63936
|
-
* @version
|
|
63960
|
+
* @version 237.0.0
|
|
63937
63961
|
*/
|
|
63938
63962
|
|
|
63939
63963
|
/**
|
|
@@ -64810,7 +64834,7 @@ class ScreenRecordingApi {
|
|
|
64810
64834
|
/**
|
|
64811
64835
|
* ScreenRecording service.
|
|
64812
64836
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64813
|
-
* @version
|
|
64837
|
+
* @version 237.0.0
|
|
64814
64838
|
*/
|
|
64815
64839
|
|
|
64816
64840
|
/**
|
|
@@ -64855,7 +64879,7 @@ class ScriptsApi {
|
|
|
64855
64879
|
/**
|
|
64856
64880
|
* Scripts service.
|
|
64857
64881
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64858
|
-
* @version
|
|
64882
|
+
* @version 237.0.0
|
|
64859
64883
|
*/
|
|
64860
64884
|
|
|
64861
64885
|
/**
|
|
@@ -65331,7 +65355,7 @@ class SearchApi {
|
|
|
65331
65355
|
/**
|
|
65332
65356
|
* Search service.
|
|
65333
65357
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65334
|
-
* @version
|
|
65358
|
+
* @version 237.0.0
|
|
65335
65359
|
*/
|
|
65336
65360
|
|
|
65337
65361
|
/**
|
|
@@ -66019,7 +66043,7 @@ class SettingsApi {
|
|
|
66019
66043
|
/**
|
|
66020
66044
|
* Settings service.
|
|
66021
66045
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
66022
|
-
* @version
|
|
66046
|
+
* @version 237.0.0
|
|
66023
66047
|
*/
|
|
66024
66048
|
|
|
66025
66049
|
/**
|
|
@@ -66367,7 +66391,7 @@ class SocialMediaApi {
|
|
|
66367
66391
|
/**
|
|
66368
66392
|
* SocialMedia service.
|
|
66369
66393
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66370
|
-
* @version
|
|
66394
|
+
* @version 237.0.0
|
|
66371
66395
|
*/
|
|
66372
66396
|
|
|
66373
66397
|
/**
|
|
@@ -67962,7 +67986,7 @@ class SpeechTextAnalyticsApi {
|
|
|
67962
67986
|
/**
|
|
67963
67987
|
* SpeechTextAnalytics service.
|
|
67964
67988
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67965
|
-
* @version
|
|
67989
|
+
* @version 237.0.0
|
|
67966
67990
|
*/
|
|
67967
67991
|
|
|
67968
67992
|
/**
|
|
@@ -69609,7 +69633,7 @@ class StationsApi {
|
|
|
69609
69633
|
/**
|
|
69610
69634
|
* Stations service.
|
|
69611
69635
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69612
|
-
* @version
|
|
69636
|
+
* @version 237.0.0
|
|
69613
69637
|
*/
|
|
69614
69638
|
|
|
69615
69639
|
/**
|
|
@@ -69711,7 +69735,7 @@ class SuggestApi {
|
|
|
69711
69735
|
/**
|
|
69712
69736
|
* Suggest service.
|
|
69713
69737
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
69714
|
-
* @version
|
|
69738
|
+
* @version 237.0.0
|
|
69715
69739
|
*/
|
|
69716
69740
|
|
|
69717
69741
|
/**
|
|
@@ -69850,7 +69874,7 @@ class TaskManagementApi {
|
|
|
69850
69874
|
/**
|
|
69851
69875
|
* TaskManagement service.
|
|
69852
69876
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69853
|
-
* @version
|
|
69877
|
+
* @version 237.0.0
|
|
69854
69878
|
*/
|
|
69855
69879
|
|
|
69856
69880
|
/**
|
|
@@ -72012,7 +72036,7 @@ class TeamsApi {
|
|
|
72012
72036
|
/**
|
|
72013
72037
|
* Teams service.
|
|
72014
72038
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
72015
|
-
* @version
|
|
72039
|
+
* @version 237.0.0
|
|
72016
72040
|
*/
|
|
72017
72041
|
|
|
72018
72042
|
/**
|
|
@@ -72317,7 +72341,7 @@ class TelephonyApi {
|
|
|
72317
72341
|
/**
|
|
72318
72342
|
* Telephony service.
|
|
72319
72343
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72320
|
-
* @version
|
|
72344
|
+
* @version 237.0.0
|
|
72321
72345
|
*/
|
|
72322
72346
|
|
|
72323
72347
|
/**
|
|
@@ -72603,7 +72627,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
72603
72627
|
/**
|
|
72604
72628
|
* TelephonyProvidersEdge service.
|
|
72605
72629
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72606
|
-
* @version
|
|
72630
|
+
* @version 237.0.0
|
|
72607
72631
|
*/
|
|
72608
72632
|
|
|
72609
72633
|
/**
|
|
@@ -76096,7 +76120,7 @@ class TextbotsApi {
|
|
|
76096
76120
|
/**
|
|
76097
76121
|
* Textbots service.
|
|
76098
76122
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
76099
|
-
* @version
|
|
76123
|
+
* @version 237.0.0
|
|
76100
76124
|
*/
|
|
76101
76125
|
|
|
76102
76126
|
/**
|
|
@@ -76225,7 +76249,7 @@ class TokensApi {
|
|
|
76225
76249
|
/**
|
|
76226
76250
|
* Tokens service.
|
|
76227
76251
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76228
|
-
* @version
|
|
76252
|
+
* @version 237.0.0
|
|
76229
76253
|
*/
|
|
76230
76254
|
|
|
76231
76255
|
/**
|
|
@@ -76379,7 +76403,7 @@ class UploadsApi {
|
|
|
76379
76403
|
/**
|
|
76380
76404
|
* Uploads service.
|
|
76381
76405
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76382
|
-
* @version
|
|
76406
|
+
* @version 237.0.0
|
|
76383
76407
|
*/
|
|
76384
76408
|
|
|
76385
76409
|
/**
|
|
@@ -76670,7 +76694,7 @@ class UsageApi {
|
|
|
76670
76694
|
/**
|
|
76671
76695
|
* Usage service.
|
|
76672
76696
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76673
|
-
* @version
|
|
76697
|
+
* @version 237.0.0
|
|
76674
76698
|
*/
|
|
76675
76699
|
|
|
76676
76700
|
/**
|
|
@@ -77005,7 +77029,7 @@ class UserRecordingsApi {
|
|
|
77005
77029
|
/**
|
|
77006
77030
|
* UserRecordings service.
|
|
77007
77031
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
77008
|
-
* @version
|
|
77032
|
+
* @version 237.0.0
|
|
77009
77033
|
*/
|
|
77010
77034
|
|
|
77011
77035
|
/**
|
|
@@ -77189,7 +77213,7 @@ class UsersApi {
|
|
|
77189
77213
|
/**
|
|
77190
77214
|
* Users service.
|
|
77191
77215
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77192
|
-
* @version
|
|
77216
|
+
* @version 237.0.0
|
|
77193
77217
|
*/
|
|
77194
77218
|
|
|
77195
77219
|
/**
|
|
@@ -80194,11 +80218,300 @@ class UsersApi {
|
|
|
80194
80218
|
|
|
80195
80219
|
}
|
|
80196
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
|
+
|
|
80197
80510
|
class UtilitiesApi {
|
|
80198
80511
|
/**
|
|
80199
80512
|
* Utilities service.
|
|
80200
80513
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80201
|
-
* @version
|
|
80514
|
+
* @version 237.0.0
|
|
80202
80515
|
*/
|
|
80203
80516
|
|
|
80204
80517
|
/**
|
|
@@ -80309,7 +80622,7 @@ class VoicemailApi {
|
|
|
80309
80622
|
/**
|
|
80310
80623
|
* Voicemail service.
|
|
80311
80624
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80312
|
-
* @version
|
|
80625
|
+
* @version 237.0.0
|
|
80313
80626
|
*/
|
|
80314
80627
|
|
|
80315
80628
|
/**
|
|
@@ -81031,7 +81344,7 @@ class WebChatApi {
|
|
|
81031
81344
|
/**
|
|
81032
81345
|
* WebChat service.
|
|
81033
81346
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
81034
|
-
* @version
|
|
81347
|
+
* @version 237.0.0
|
|
81035
81348
|
*/
|
|
81036
81349
|
|
|
81037
81350
|
/**
|
|
@@ -81594,7 +81907,7 @@ class WebDeploymentsApi {
|
|
|
81594
81907
|
/**
|
|
81595
81908
|
* WebDeployments service.
|
|
81596
81909
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81597
|
-
* @version
|
|
81910
|
+
* @version 237.0.0
|
|
81598
81911
|
*/
|
|
81599
81912
|
|
|
81600
81913
|
/**
|
|
@@ -82176,7 +82489,7 @@ class WebMessagingApi {
|
|
|
82176
82489
|
/**
|
|
82177
82490
|
* WebMessaging service.
|
|
82178
82491
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82179
|
-
* @version
|
|
82492
|
+
* @version 237.0.0
|
|
82180
82493
|
*/
|
|
82181
82494
|
|
|
82182
82495
|
/**
|
|
@@ -82322,7 +82635,7 @@ class WidgetsApi {
|
|
|
82322
82635
|
/**
|
|
82323
82636
|
* Widgets service.
|
|
82324
82637
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82325
|
-
* @version
|
|
82638
|
+
* @version 237.0.0
|
|
82326
82639
|
*/
|
|
82327
82640
|
|
|
82328
82641
|
/**
|
|
@@ -82473,7 +82786,7 @@ class WorkforceManagementApi {
|
|
|
82473
82786
|
/**
|
|
82474
82787
|
* WorkforceManagement service.
|
|
82475
82788
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
82476
|
-
* @version
|
|
82789
|
+
* @version 237.0.0
|
|
82477
82790
|
*/
|
|
82478
82791
|
|
|
82479
82792
|
/**
|
|
@@ -83237,6 +83550,31 @@ class WorkforceManagementApi {
|
|
|
83237
83550
|
);
|
|
83238
83551
|
}
|
|
83239
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
|
+
|
|
83240
83578
|
/**
|
|
83241
83579
|
* Get the management unit to which the currently logged in agent belongs
|
|
83242
83580
|
*
|
|
@@ -87585,6 +87923,31 @@ class WorkforceManagementApi {
|
|
|
87585
87923
|
);
|
|
87586
87924
|
}
|
|
87587
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
|
+
|
|
87588
87951
|
/**
|
|
87589
87952
|
* Get agent possible work shifts for requested time frame
|
|
87590
87953
|
*
|
|
@@ -90474,7 +90837,7 @@ class WorkforceManagementApi {
|
|
|
90474
90837
|
* </pre>
|
|
90475
90838
|
* </p>
|
|
90476
90839
|
* @module purecloud-platform-client-v2/index
|
|
90477
|
-
* @version
|
|
90840
|
+
* @version 237.0.0
|
|
90478
90841
|
*/
|
|
90479
90842
|
class platformClient {
|
|
90480
90843
|
constructor() {
|
|
@@ -90863,6 +91226,11 @@ class platformClient {
|
|
|
90863
91226
|
* @property {module:purecloud-platform-client-v2/api/UsersApi}
|
|
90864
91227
|
*/
|
|
90865
91228
|
this.UsersApi = UsersApi;
|
|
91229
|
+
/**
|
|
91230
|
+
* The UsersRulesApi service constructor.
|
|
91231
|
+
* @property {module:purecloud-platform-client-v2/api/UsersRulesApi}
|
|
91232
|
+
*/
|
|
91233
|
+
this.UsersRulesApi = UsersRulesApi;
|
|
90866
91234
|
/**
|
|
90867
91235
|
* The UtilitiesApi service constructor.
|
|
90868
91236
|
* @property {module:purecloud-platform-client-v2/api/UtilitiesApi}
|