purecloud-platform-client-v2 197.0.0 → 198.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +401 -110
- package/dist/web-amd/purecloud-platform-client-v2.js +401 -110
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +167 -90
- package/dist/web-cjs/purecloud-platform-client-v2.js +170 -91
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +520 -29
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.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/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 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
- 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 +30 -2
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +2 -2
- 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 +32 -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/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 +3 -2
- 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 +3 -3
- 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 +222 -27
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -405,7 +405,7 @@ class Configuration {
|
|
|
405
405
|
|
|
406
406
|
/**
|
|
407
407
|
* @module purecloud-platform-client-v2/ApiClient
|
|
408
|
-
* @version
|
|
408
|
+
* @version 198.0.0
|
|
409
409
|
*/
|
|
410
410
|
class ApiClient {
|
|
411
411
|
/**
|
|
@@ -1827,7 +1827,7 @@ class AgentUIApi {
|
|
|
1827
1827
|
/**
|
|
1828
1828
|
* AgentUI service.
|
|
1829
1829
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1830
|
-
* @version
|
|
1830
|
+
* @version 198.0.0
|
|
1831
1831
|
*/
|
|
1832
1832
|
|
|
1833
1833
|
/**
|
|
@@ -1958,7 +1958,7 @@ class AlertingApi {
|
|
|
1958
1958
|
/**
|
|
1959
1959
|
* Alerting service.
|
|
1960
1960
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1961
|
-
* @version
|
|
1961
|
+
* @version 198.0.0
|
|
1962
1962
|
*/
|
|
1963
1963
|
|
|
1964
1964
|
/**
|
|
@@ -2619,7 +2619,7 @@ class AnalyticsApi {
|
|
|
2619
2619
|
/**
|
|
2620
2620
|
* Analytics service.
|
|
2621
2621
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2622
|
-
* @version
|
|
2622
|
+
* @version 198.0.0
|
|
2623
2623
|
*/
|
|
2624
2624
|
|
|
2625
2625
|
/**
|
|
@@ -5231,7 +5231,7 @@ class ArchitectApi {
|
|
|
5231
5231
|
/**
|
|
5232
5232
|
* Architect service.
|
|
5233
5233
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5234
|
-
* @version
|
|
5234
|
+
* @version 198.0.0
|
|
5235
5235
|
*/
|
|
5236
5236
|
|
|
5237
5237
|
/**
|
|
@@ -9377,7 +9377,7 @@ class AuditApi {
|
|
|
9377
9377
|
/**
|
|
9378
9378
|
* Audit service.
|
|
9379
9379
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9380
|
-
* @version
|
|
9380
|
+
* @version 198.0.0
|
|
9381
9381
|
*/
|
|
9382
9382
|
|
|
9383
9383
|
/**
|
|
@@ -9577,7 +9577,7 @@ class AuthorizationApi {
|
|
|
9577
9577
|
/**
|
|
9578
9578
|
* Authorization service.
|
|
9579
9579
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9580
|
-
* @version
|
|
9580
|
+
* @version 198.0.0
|
|
9581
9581
|
*/
|
|
9582
9582
|
|
|
9583
9583
|
/**
|
|
@@ -10815,7 +10815,7 @@ class BillingApi {
|
|
|
10815
10815
|
/**
|
|
10816
10816
|
* Billing service.
|
|
10817
10817
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10818
|
-
* @version
|
|
10818
|
+
* @version 198.0.0
|
|
10819
10819
|
*/
|
|
10820
10820
|
|
|
10821
10821
|
/**
|
|
@@ -10895,7 +10895,7 @@ class CarrierServicesApi {
|
|
|
10895
10895
|
/**
|
|
10896
10896
|
* CarrierServices service.
|
|
10897
10897
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10898
|
-
* @version
|
|
10898
|
+
* @version 198.0.0
|
|
10899
10899
|
*/
|
|
10900
10900
|
|
|
10901
10901
|
/**
|
|
@@ -10965,7 +10965,7 @@ class ChatApi {
|
|
|
10965
10965
|
/**
|
|
10966
10966
|
* Chat service.
|
|
10967
10967
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10968
|
-
* @version
|
|
10968
|
+
* @version 198.0.0
|
|
10969
10969
|
*/
|
|
10970
10970
|
|
|
10971
10971
|
/**
|
|
@@ -11901,7 +11901,7 @@ class CoachingApi {
|
|
|
11901
11901
|
/**
|
|
11902
11902
|
* Coaching service.
|
|
11903
11903
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11904
|
-
* @version
|
|
11904
|
+
* @version 198.0.0
|
|
11905
11905
|
*/
|
|
11906
11906
|
|
|
11907
11907
|
/**
|
|
@@ -12478,7 +12478,7 @@ class ContentManagementApi {
|
|
|
12478
12478
|
/**
|
|
12479
12479
|
* ContentManagement service.
|
|
12480
12480
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12481
|
-
* @version
|
|
12481
|
+
* @version 198.0.0
|
|
12482
12482
|
*/
|
|
12483
12483
|
|
|
12484
12484
|
/**
|
|
@@ -13560,7 +13560,7 @@ class ConversationsApi {
|
|
|
13560
13560
|
/**
|
|
13561
13561
|
* Conversations service.
|
|
13562
13562
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13563
|
-
* @version
|
|
13563
|
+
* @version 198.0.0
|
|
13564
13564
|
*/
|
|
13565
13565
|
|
|
13566
13566
|
/**
|
|
@@ -17275,6 +17275,42 @@ class ConversationsApi {
|
|
|
17275
17275
|
);
|
|
17276
17276
|
}
|
|
17277
17277
|
|
|
17278
|
+
/**
|
|
17279
|
+
* Update conversation by setting its parking state
|
|
17280
|
+
*
|
|
17281
|
+
* @param {String} conversationId conversationId
|
|
17282
|
+
* @param {String} participantId participantId
|
|
17283
|
+
* @param {Object} body Parking update request
|
|
17284
|
+
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17285
|
+
*/
|
|
17286
|
+
patchConversationsEmailParticipantParkingstate(conversationId, participantId, body) {
|
|
17287
|
+
// verify the required parameter 'conversationId' is set
|
|
17288
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17289
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';
|
|
17290
|
+
}
|
|
17291
|
+
// verify the required parameter 'participantId' is set
|
|
17292
|
+
if (participantId === undefined || participantId === null) {
|
|
17293
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';
|
|
17294
|
+
}
|
|
17295
|
+
// verify the required parameter 'body' is set
|
|
17296
|
+
if (body === undefined || body === null) {
|
|
17297
|
+
throw 'Missing the required parameter "body" when calling patchConversationsEmailParticipantParkingstate';
|
|
17298
|
+
}
|
|
17299
|
+
|
|
17300
|
+
return this.apiClient.callApi(
|
|
17301
|
+
'/api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate',
|
|
17302
|
+
'PATCH',
|
|
17303
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
17304
|
+
{ },
|
|
17305
|
+
{ },
|
|
17306
|
+
{ },
|
|
17307
|
+
body,
|
|
17308
|
+
['PureCloud OAuth'],
|
|
17309
|
+
['application/json'],
|
|
17310
|
+
['application/json']
|
|
17311
|
+
);
|
|
17312
|
+
}
|
|
17313
|
+
|
|
17278
17314
|
/**
|
|
17279
17315
|
* Update a conversation by disconnecting all of the participants
|
|
17280
17316
|
*
|
|
@@ -20639,7 +20675,7 @@ class DataExtensionsApi {
|
|
|
20639
20675
|
/**
|
|
20640
20676
|
* DataExtensions service.
|
|
20641
20677
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20642
|
-
* @version
|
|
20678
|
+
* @version 198.0.0
|
|
20643
20679
|
*/
|
|
20644
20680
|
|
|
20645
20681
|
/**
|
|
@@ -20725,7 +20761,7 @@ class DownloadsApi {
|
|
|
20725
20761
|
/**
|
|
20726
20762
|
* Downloads service.
|
|
20727
20763
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20728
|
-
* @version
|
|
20764
|
+
* @version 198.0.0
|
|
20729
20765
|
*/
|
|
20730
20766
|
|
|
20731
20767
|
/**
|
|
@@ -20777,7 +20813,7 @@ class EmailsApi {
|
|
|
20777
20813
|
/**
|
|
20778
20814
|
* Emails service.
|
|
20779
20815
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20780
|
-
* @version
|
|
20816
|
+
* @version 198.0.0
|
|
20781
20817
|
*/
|
|
20782
20818
|
|
|
20783
20819
|
/**
|
|
@@ -20842,7 +20878,7 @@ class EmployeeEngagementApi {
|
|
|
20842
20878
|
/**
|
|
20843
20879
|
* EmployeeEngagement service.
|
|
20844
20880
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20845
|
-
* @version
|
|
20881
|
+
* @version 198.0.0
|
|
20846
20882
|
*/
|
|
20847
20883
|
|
|
20848
20884
|
/**
|
|
@@ -20993,7 +21029,7 @@ class EventsApi {
|
|
|
20993
21029
|
/**
|
|
20994
21030
|
* Events service.
|
|
20995
21031
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20996
|
-
* @version
|
|
21032
|
+
* @version 198.0.0
|
|
20997
21033
|
*/
|
|
20998
21034
|
|
|
20999
21035
|
/**
|
|
@@ -21089,7 +21125,7 @@ class ExternalContactsApi {
|
|
|
21089
21125
|
/**
|
|
21090
21126
|
* ExternalContacts service.
|
|
21091
21127
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21092
|
-
* @version
|
|
21128
|
+
* @version 198.0.0
|
|
21093
21129
|
*/
|
|
21094
21130
|
|
|
21095
21131
|
/**
|
|
@@ -21445,7 +21481,7 @@ class ExternalContactsApi {
|
|
|
21445
21481
|
*
|
|
21446
21482
|
* @param {String} contactId ExternalContact ID
|
|
21447
21483
|
* @param {Object} opts Optional parameters
|
|
21448
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
21484
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
21449
21485
|
*/
|
|
21450
21486
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
21451
21487
|
opts = opts || {};
|
|
@@ -23051,7 +23087,7 @@ class FaxApi {
|
|
|
23051
23087
|
/**
|
|
23052
23088
|
* Fax service.
|
|
23053
23089
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23054
|
-
* @version
|
|
23090
|
+
* @version 198.0.0
|
|
23055
23091
|
*/
|
|
23056
23092
|
|
|
23057
23093
|
/**
|
|
@@ -23266,7 +23302,7 @@ class FlowsApi {
|
|
|
23266
23302
|
/**
|
|
23267
23303
|
* Flows service.
|
|
23268
23304
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23269
|
-
* @version
|
|
23305
|
+
* @version 198.0.0
|
|
23270
23306
|
*/
|
|
23271
23307
|
|
|
23272
23308
|
/**
|
|
@@ -23449,7 +23485,7 @@ class GamificationApi {
|
|
|
23449
23485
|
/**
|
|
23450
23486
|
* Gamification service.
|
|
23451
23487
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23452
|
-
* @version
|
|
23488
|
+
* @version 198.0.0
|
|
23453
23489
|
*/
|
|
23454
23490
|
|
|
23455
23491
|
/**
|
|
@@ -25535,7 +25571,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25535
25571
|
/**
|
|
25536
25572
|
* GeneralDataProtectionRegulation service.
|
|
25537
25573
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25538
|
-
* @version
|
|
25574
|
+
* @version 198.0.0
|
|
25539
25575
|
*/
|
|
25540
25576
|
|
|
25541
25577
|
/**
|
|
@@ -25665,7 +25701,7 @@ class GeolocationApi {
|
|
|
25665
25701
|
/**
|
|
25666
25702
|
* Geolocation service.
|
|
25667
25703
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25668
|
-
* @version
|
|
25704
|
+
* @version 198.0.0
|
|
25669
25705
|
*/
|
|
25670
25706
|
|
|
25671
25707
|
/**
|
|
@@ -25796,7 +25832,7 @@ class GreetingsApi {
|
|
|
25796
25832
|
/**
|
|
25797
25833
|
* Greetings service.
|
|
25798
25834
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25799
|
-
* @version
|
|
25835
|
+
* @version 198.0.0
|
|
25800
25836
|
*/
|
|
25801
25837
|
|
|
25802
25838
|
/**
|
|
@@ -26251,7 +26287,7 @@ class GroupsApi {
|
|
|
26251
26287
|
/**
|
|
26252
26288
|
* Groups service.
|
|
26253
26289
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26254
|
-
* @version
|
|
26290
|
+
* @version 198.0.0
|
|
26255
26291
|
*/
|
|
26256
26292
|
|
|
26257
26293
|
/**
|
|
@@ -26770,7 +26806,7 @@ class IdentityProviderApi {
|
|
|
26770
26806
|
/**
|
|
26771
26807
|
* IdentityProvider service.
|
|
26772
26808
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26773
|
-
* @version
|
|
26809
|
+
* @version 198.0.0
|
|
26774
26810
|
*/
|
|
26775
26811
|
|
|
26776
26812
|
/**
|
|
@@ -27631,7 +27667,7 @@ class InfrastructureAsCodeApi {
|
|
|
27631
27667
|
/**
|
|
27632
27668
|
* InfrastructureAsCode service.
|
|
27633
27669
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27634
|
-
* @version
|
|
27670
|
+
* @version 198.0.0
|
|
27635
27671
|
*/
|
|
27636
27672
|
|
|
27637
27673
|
/**
|
|
@@ -27798,7 +27834,7 @@ class IntegrationsApi {
|
|
|
27798
27834
|
/**
|
|
27799
27835
|
* Integrations service.
|
|
27800
27836
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27801
|
-
* @version
|
|
27837
|
+
* @version 198.0.0
|
|
27802
27838
|
*/
|
|
27803
27839
|
|
|
27804
27840
|
/**
|
|
@@ -30150,7 +30186,7 @@ class JourneyApi {
|
|
|
30150
30186
|
/**
|
|
30151
30187
|
* Journey service.
|
|
30152
30188
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30153
|
-
* @version
|
|
30189
|
+
* @version 198.0.0
|
|
30154
30190
|
*/
|
|
30155
30191
|
|
|
30156
30192
|
/**
|
|
@@ -30895,7 +30931,6 @@ class JourneyApi {
|
|
|
30895
30931
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
30896
30932
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
30897
30933
|
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
30898
|
-
* getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30899
30934
|
*/
|
|
30900
30935
|
getJourneySessionEvents(sessionId, opts) {
|
|
30901
30936
|
opts = opts || {};
|
|
@@ -31528,6 +31563,35 @@ class JourneyApi {
|
|
|
31528
31563
|
);
|
|
31529
31564
|
}
|
|
31530
31565
|
|
|
31566
|
+
/**
|
|
31567
|
+
* Send a journey web event, used for tracking customer activity on a website.
|
|
31568
|
+
*
|
|
31569
|
+
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
31570
|
+
* @param {Object} opts Optional parameters
|
|
31571
|
+
* @param {Object} opts.body
|
|
31572
|
+
*/
|
|
31573
|
+
postJourneyDeploymentWebevents(deploymentId, opts) {
|
|
31574
|
+
opts = opts || {};
|
|
31575
|
+
|
|
31576
|
+
// verify the required parameter 'deploymentId' is set
|
|
31577
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
31578
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';
|
|
31579
|
+
}
|
|
31580
|
+
|
|
31581
|
+
return this.apiClient.callApi(
|
|
31582
|
+
'/api/v2/journey/deployments/{deploymentId}/webevents',
|
|
31583
|
+
'POST',
|
|
31584
|
+
{ 'deploymentId': deploymentId },
|
|
31585
|
+
{ },
|
|
31586
|
+
{ },
|
|
31587
|
+
{ },
|
|
31588
|
+
opts['body'],
|
|
31589
|
+
['PureCloud OAuth'],
|
|
31590
|
+
['application/json'],
|
|
31591
|
+
['application/json']
|
|
31592
|
+
);
|
|
31593
|
+
}
|
|
31594
|
+
|
|
31531
31595
|
/**
|
|
31532
31596
|
* Query for flow paths.
|
|
31533
31597
|
*
|
|
@@ -31768,7 +31832,7 @@ class KnowledgeApi {
|
|
|
31768
31832
|
/**
|
|
31769
31833
|
* Knowledge service.
|
|
31770
31834
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31771
|
-
* @version
|
|
31835
|
+
* @version 198.0.0
|
|
31772
31836
|
*/
|
|
31773
31837
|
|
|
31774
31838
|
/**
|
|
@@ -35012,7 +35076,7 @@ class LanguageUnderstandingApi {
|
|
|
35012
35076
|
/**
|
|
35013
35077
|
* LanguageUnderstanding service.
|
|
35014
35078
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
35015
|
-
* @version
|
|
35079
|
+
* @version 198.0.0
|
|
35016
35080
|
*/
|
|
35017
35081
|
|
|
35018
35082
|
/**
|
|
@@ -36046,7 +36110,7 @@ class LanguagesApi {
|
|
|
36046
36110
|
/**
|
|
36047
36111
|
* Languages service.
|
|
36048
36112
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
36049
|
-
* @version
|
|
36113
|
+
* @version 198.0.0
|
|
36050
36114
|
*/
|
|
36051
36115
|
|
|
36052
36116
|
/**
|
|
@@ -36268,7 +36332,7 @@ class LearningApi {
|
|
|
36268
36332
|
/**
|
|
36269
36333
|
* Learning service.
|
|
36270
36334
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36271
|
-
* @version
|
|
36335
|
+
* @version 198.0.0
|
|
36272
36336
|
*/
|
|
36273
36337
|
|
|
36274
36338
|
/**
|
|
@@ -37297,7 +37361,7 @@ class LicenseApi {
|
|
|
37297
37361
|
/**
|
|
37298
37362
|
* License service.
|
|
37299
37363
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37300
|
-
* @version
|
|
37364
|
+
* @version 198.0.0
|
|
37301
37365
|
*/
|
|
37302
37366
|
|
|
37303
37367
|
/**
|
|
@@ -37535,7 +37599,7 @@ class LocationsApi {
|
|
|
37535
37599
|
/**
|
|
37536
37600
|
* Locations service.
|
|
37537
37601
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37538
|
-
* @version
|
|
37602
|
+
* @version 198.0.0
|
|
37539
37603
|
*/
|
|
37540
37604
|
|
|
37541
37605
|
/**
|
|
@@ -37771,7 +37835,7 @@ class LogCaptureApi {
|
|
|
37771
37835
|
/**
|
|
37772
37836
|
* LogCapture service.
|
|
37773
37837
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37774
|
-
* @version
|
|
37838
|
+
* @version 198.0.0
|
|
37775
37839
|
*/
|
|
37776
37840
|
|
|
37777
37841
|
/**
|
|
@@ -37971,7 +38035,7 @@ class MessagingApi {
|
|
|
37971
38035
|
/**
|
|
37972
38036
|
* Messaging service.
|
|
37973
38037
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37974
|
-
* @version
|
|
38038
|
+
* @version 198.0.0
|
|
37975
38039
|
*/
|
|
37976
38040
|
|
|
37977
38041
|
/**
|
|
@@ -38330,7 +38394,7 @@ class MobileDevicesApi {
|
|
|
38330
38394
|
/**
|
|
38331
38395
|
* MobileDevices service.
|
|
38332
38396
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38333
|
-
* @version
|
|
38397
|
+
* @version 198.0.0
|
|
38334
38398
|
*/
|
|
38335
38399
|
|
|
38336
38400
|
/**
|
|
@@ -38481,7 +38545,7 @@ class NotificationsApi {
|
|
|
38481
38545
|
/**
|
|
38482
38546
|
* Notifications service.
|
|
38483
38547
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38484
|
-
* @version
|
|
38548
|
+
* @version 198.0.0
|
|
38485
38549
|
*/
|
|
38486
38550
|
|
|
38487
38551
|
/**
|
|
@@ -38714,7 +38778,7 @@ class OAuthApi {
|
|
|
38714
38778
|
/**
|
|
38715
38779
|
* OAuth service.
|
|
38716
38780
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38717
|
-
* @version
|
|
38781
|
+
* @version 198.0.0
|
|
38718
38782
|
*/
|
|
38719
38783
|
|
|
38720
38784
|
/**
|
|
@@ -39080,7 +39144,7 @@ class ObjectsApi {
|
|
|
39080
39144
|
/**
|
|
39081
39145
|
* Objects service.
|
|
39082
39146
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
39083
|
-
* @version
|
|
39147
|
+
* @version 198.0.0
|
|
39084
39148
|
*/
|
|
39085
39149
|
|
|
39086
39150
|
/**
|
|
@@ -39350,7 +39414,7 @@ class OperationalEventsApi {
|
|
|
39350
39414
|
/**
|
|
39351
39415
|
* OperationalEvents service.
|
|
39352
39416
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39353
|
-
* @version
|
|
39417
|
+
* @version 198.0.0
|
|
39354
39418
|
*/
|
|
39355
39419
|
|
|
39356
39420
|
/**
|
|
@@ -39416,7 +39480,7 @@ class OrganizationApi {
|
|
|
39416
39480
|
/**
|
|
39417
39481
|
* Organization service.
|
|
39418
39482
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39419
|
-
* @version
|
|
39483
|
+
* @version 198.0.0
|
|
39420
39484
|
*/
|
|
39421
39485
|
|
|
39422
39486
|
/**
|
|
@@ -39891,7 +39955,7 @@ class OrganizationAuthorizationApi {
|
|
|
39891
39955
|
/**
|
|
39892
39956
|
* OrganizationAuthorization service.
|
|
39893
39957
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39894
|
-
* @version
|
|
39958
|
+
* @version 198.0.0
|
|
39895
39959
|
*/
|
|
39896
39960
|
|
|
39897
39961
|
/**
|
|
@@ -41238,7 +41302,7 @@ class OutboundApi {
|
|
|
41238
41302
|
/**
|
|
41239
41303
|
* Outbound service.
|
|
41240
41304
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
41241
|
-
* @version
|
|
41305
|
+
* @version 198.0.0
|
|
41242
41306
|
*/
|
|
41243
41307
|
|
|
41244
41308
|
/**
|
|
@@ -41852,7 +41916,7 @@ class OutboundApi {
|
|
|
41852
41916
|
|
|
41853
41917
|
/**
|
|
41854
41918
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
41855
|
-
*
|
|
41919
|
+
* Documented permissions are applicable based on campaign type.
|
|
41856
41920
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
41857
41921
|
*/
|
|
41858
41922
|
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
@@ -45600,7 +45664,7 @@ class PresenceApi {
|
|
|
45600
45664
|
/**
|
|
45601
45665
|
* Presence service.
|
|
45602
45666
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45603
|
-
* @version
|
|
45667
|
+
* @version 198.0.0
|
|
45604
45668
|
*/
|
|
45605
45669
|
|
|
45606
45670
|
/**
|
|
@@ -46344,7 +46408,7 @@ class ProcessAutomationApi {
|
|
|
46344
46408
|
/**
|
|
46345
46409
|
* ProcessAutomation service.
|
|
46346
46410
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
46347
|
-
* @version
|
|
46411
|
+
* @version 198.0.0
|
|
46348
46412
|
*/
|
|
46349
46413
|
|
|
46350
46414
|
/**
|
|
@@ -46583,7 +46647,7 @@ class QualityApi {
|
|
|
46583
46647
|
/**
|
|
46584
46648
|
* Quality service.
|
|
46585
46649
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46586
|
-
* @version
|
|
46650
|
+
* @version 198.0.0
|
|
46587
46651
|
*/
|
|
46588
46652
|
|
|
46589
46653
|
/**
|
|
@@ -48272,6 +48336,37 @@ class QualityApi {
|
|
|
48272
48336
|
);
|
|
48273
48337
|
}
|
|
48274
48338
|
|
|
48339
|
+
/**
|
|
48340
|
+
* Update the Predictive Scoring settings of an evaluation form.
|
|
48341
|
+
*
|
|
48342
|
+
* @param {String} formId Form ID
|
|
48343
|
+
* @param {Object} body Predictive Scoring Settings
|
|
48344
|
+
* putQualityFormsEvaluationPredictivescoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48345
|
+
*/
|
|
48346
|
+
putQualityFormsEvaluationPredictivescoringSettings(formId, body) {
|
|
48347
|
+
// verify the required parameter 'formId' is set
|
|
48348
|
+
if (formId === undefined || formId === null) {
|
|
48349
|
+
throw 'Missing the required parameter "formId" when calling putQualityFormsEvaluationPredictivescoringSettings';
|
|
48350
|
+
}
|
|
48351
|
+
// verify the required parameter 'body' is set
|
|
48352
|
+
if (body === undefined || body === null) {
|
|
48353
|
+
throw 'Missing the required parameter "body" when calling putQualityFormsEvaluationPredictivescoringSettings';
|
|
48354
|
+
}
|
|
48355
|
+
|
|
48356
|
+
return this.apiClient.callApi(
|
|
48357
|
+
'/api/v2/quality/forms/evaluations/{formId}/predictivescoring/settings',
|
|
48358
|
+
'PUT',
|
|
48359
|
+
{ 'formId': formId },
|
|
48360
|
+
{ },
|
|
48361
|
+
{ },
|
|
48362
|
+
{ },
|
|
48363
|
+
body,
|
|
48364
|
+
['PureCloud OAuth'],
|
|
48365
|
+
['application/json'],
|
|
48366
|
+
['application/json']
|
|
48367
|
+
);
|
|
48368
|
+
}
|
|
48369
|
+
|
|
48275
48370
|
/**
|
|
48276
48371
|
* Update a survey form.
|
|
48277
48372
|
*
|
|
@@ -48338,7 +48433,7 @@ class RecordingApi {
|
|
|
48338
48433
|
/**
|
|
48339
48434
|
* Recording service.
|
|
48340
48435
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
48341
|
-
* @version
|
|
48436
|
+
* @version 198.0.0
|
|
48342
48437
|
*/
|
|
48343
48438
|
|
|
48344
48439
|
/**
|
|
@@ -49996,7 +50091,7 @@ class ResponseManagementApi {
|
|
|
49996
50091
|
/**
|
|
49997
50092
|
* ResponseManagement service.
|
|
49998
50093
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49999
|
-
* @version
|
|
50094
|
+
* @version 198.0.0
|
|
50000
50095
|
*/
|
|
50001
50096
|
|
|
50002
50097
|
/**
|
|
@@ -50506,7 +50601,7 @@ class RoutingApi {
|
|
|
50506
50601
|
/**
|
|
50507
50602
|
* Routing service.
|
|
50508
50603
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50509
|
-
* @version
|
|
50604
|
+
* @version 198.0.0
|
|
50510
50605
|
*/
|
|
50511
50606
|
|
|
50512
50607
|
/**
|
|
@@ -54480,7 +54575,7 @@ class SCIMApi {
|
|
|
54480
54575
|
/**
|
|
54481
54576
|
* SCIM service.
|
|
54482
54577
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54483
|
-
* @version
|
|
54578
|
+
* @version 198.0.0
|
|
54484
54579
|
*/
|
|
54485
54580
|
|
|
54486
54581
|
/**
|
|
@@ -55357,7 +55452,7 @@ class ScreenRecordingApi {
|
|
|
55357
55452
|
/**
|
|
55358
55453
|
* ScreenRecording service.
|
|
55359
55454
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
55360
|
-
* @version
|
|
55455
|
+
* @version 198.0.0
|
|
55361
55456
|
*/
|
|
55362
55457
|
|
|
55363
55458
|
/**
|
|
@@ -55402,7 +55497,7 @@ class ScriptsApi {
|
|
|
55402
55497
|
/**
|
|
55403
55498
|
* Scripts service.
|
|
55404
55499
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55405
|
-
* @version
|
|
55500
|
+
* @version 198.0.0
|
|
55406
55501
|
*/
|
|
55407
55502
|
|
|
55408
55503
|
/**
|
|
@@ -55846,7 +55941,7 @@ class SearchApi {
|
|
|
55846
55941
|
/**
|
|
55847
55942
|
* Search service.
|
|
55848
55943
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55849
|
-
* @version
|
|
55944
|
+
* @version 198.0.0
|
|
55850
55945
|
*/
|
|
55851
55946
|
|
|
55852
55947
|
/**
|
|
@@ -56535,7 +56630,7 @@ class SettingsApi {
|
|
|
56535
56630
|
/**
|
|
56536
56631
|
* Settings service.
|
|
56537
56632
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56538
|
-
* @version
|
|
56633
|
+
* @version 198.0.0
|
|
56539
56634
|
*/
|
|
56540
56635
|
|
|
56541
56636
|
/**
|
|
@@ -56757,7 +56852,7 @@ class SpeechTextAnalyticsApi {
|
|
|
56757
56852
|
/**
|
|
56758
56853
|
* SpeechTextAnalytics service.
|
|
56759
56854
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56760
|
-
* @version
|
|
56855
|
+
* @version 198.0.0
|
|
56761
56856
|
*/
|
|
56762
56857
|
|
|
56763
56858
|
/**
|
|
@@ -58035,7 +58130,7 @@ class StationsApi {
|
|
|
58035
58130
|
/**
|
|
58036
58131
|
* Stations service.
|
|
58037
58132
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
58038
|
-
* @version
|
|
58133
|
+
* @version 198.0.0
|
|
58039
58134
|
*/
|
|
58040
58135
|
|
|
58041
58136
|
/**
|
|
@@ -58137,7 +58232,7 @@ class SuggestApi {
|
|
|
58137
58232
|
/**
|
|
58138
58233
|
* Suggest service.
|
|
58139
58234
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
58140
|
-
* @version
|
|
58235
|
+
* @version 198.0.0
|
|
58141
58236
|
*/
|
|
58142
58237
|
|
|
58143
58238
|
/**
|
|
@@ -58276,7 +58371,7 @@ class TaskManagementApi {
|
|
|
58276
58371
|
/**
|
|
58277
58372
|
* TaskManagement service.
|
|
58278
58373
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
58279
|
-
* @version
|
|
58374
|
+
* @version 198.0.0
|
|
58280
58375
|
*/
|
|
58281
58376
|
|
|
58282
58377
|
/**
|
|
@@ -58921,6 +59016,7 @@ class TaskManagementApi {
|
|
|
58921
59016
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
58922
59017
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
58923
59018
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59019
|
+
* @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
|
|
58924
59020
|
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58925
59021
|
*/
|
|
58926
59022
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
@@ -58935,7 +59031,7 @@ class TaskManagementApi {
|
|
|
58935
59031
|
'/api/v2/taskmanagement/worktypes/{worktypeId}/history',
|
|
58936
59032
|
'GET',
|
|
58937
59033
|
{ 'worktypeId': worktypeId },
|
|
58938
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
|
|
59034
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
|
|
58939
59035
|
{ },
|
|
58940
59036
|
{ },
|
|
58941
59037
|
null,
|
|
@@ -59624,7 +59720,7 @@ class TeamsApi {
|
|
|
59624
59720
|
/**
|
|
59625
59721
|
* Teams service.
|
|
59626
59722
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59627
|
-
* @version
|
|
59723
|
+
* @version 198.0.0
|
|
59628
59724
|
*/
|
|
59629
59725
|
|
|
59630
59726
|
/**
|
|
@@ -59925,7 +60021,7 @@ class TelephonyApi {
|
|
|
59925
60021
|
/**
|
|
59926
60022
|
* Telephony service.
|
|
59927
60023
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59928
|
-
* @version
|
|
60024
|
+
* @version 198.0.0
|
|
59929
60025
|
*/
|
|
59930
60026
|
|
|
59931
60027
|
/**
|
|
@@ -60107,7 +60203,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
60107
60203
|
/**
|
|
60108
60204
|
* TelephonyProvidersEdge service.
|
|
60109
60205
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
60110
|
-
* @version
|
|
60206
|
+
* @version 198.0.0
|
|
60111
60207
|
*/
|
|
60112
60208
|
|
|
60113
60209
|
/**
|
|
@@ -63435,7 +63531,7 @@ class TextbotsApi {
|
|
|
63435
63531
|
/**
|
|
63436
63532
|
* Textbots service.
|
|
63437
63533
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
63438
|
-
* @version
|
|
63534
|
+
* @version 198.0.0
|
|
63439
63535
|
*/
|
|
63440
63536
|
|
|
63441
63537
|
/**
|
|
@@ -63563,7 +63659,7 @@ class TokensApi {
|
|
|
63563
63659
|
/**
|
|
63564
63660
|
* Tokens service.
|
|
63565
63661
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63566
|
-
* @version
|
|
63662
|
+
* @version 198.0.0
|
|
63567
63663
|
*/
|
|
63568
63664
|
|
|
63569
63665
|
/**
|
|
@@ -63717,7 +63813,7 @@ class UploadsApi {
|
|
|
63717
63813
|
/**
|
|
63718
63814
|
* Uploads service.
|
|
63719
63815
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63720
|
-
* @version
|
|
63816
|
+
* @version 198.0.0
|
|
63721
63817
|
*/
|
|
63722
63818
|
|
|
63723
63819
|
/**
|
|
@@ -63986,7 +64082,7 @@ class UsageApi {
|
|
|
63986
64082
|
/**
|
|
63987
64083
|
* Usage service.
|
|
63988
64084
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63989
|
-
* @version
|
|
64085
|
+
* @version 198.0.0
|
|
63990
64086
|
*/
|
|
63991
64087
|
|
|
63992
64088
|
/**
|
|
@@ -64201,7 +64297,7 @@ class UserRecordingsApi {
|
|
|
64201
64297
|
/**
|
|
64202
64298
|
* UserRecordings service.
|
|
64203
64299
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
64204
|
-
* @version
|
|
64300
|
+
* @version 198.0.0
|
|
64205
64301
|
*/
|
|
64206
64302
|
|
|
64207
64303
|
/**
|
|
@@ -64386,7 +64482,7 @@ class UsersApi {
|
|
|
64386
64482
|
/**
|
|
64387
64483
|
* Users service.
|
|
64388
64484
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
64389
|
-
* @version
|
|
64485
|
+
* @version 198.0.0
|
|
64390
64486
|
*/
|
|
64391
64487
|
|
|
64392
64488
|
/**
|
|
@@ -65018,7 +65114,7 @@ class UsersApi {
|
|
|
65018
65114
|
*
|
|
65019
65115
|
* @param {String} userId User ID
|
|
65020
65116
|
* @param {Object} opts Optional parameters
|
|
65021
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65117
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
65022
65118
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
65023
65119
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
65024
65120
|
*/
|
|
@@ -65589,7 +65685,7 @@ class UsersApi {
|
|
|
65589
65685
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
65590
65686
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
65591
65687
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
65592
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65688
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
65593
65689
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
65594
65690
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
65595
65691
|
*/
|
|
@@ -67044,7 +67140,7 @@ class UtilitiesApi {
|
|
|
67044
67140
|
/**
|
|
67045
67141
|
* Utilities service.
|
|
67046
67142
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
67047
|
-
* @version
|
|
67143
|
+
* @version 198.0.0
|
|
67048
67144
|
*/
|
|
67049
67145
|
|
|
67050
67146
|
/**
|
|
@@ -67155,7 +67251,7 @@ class VoicemailApi {
|
|
|
67155
67251
|
/**
|
|
67156
67252
|
* Voicemail service.
|
|
67157
67253
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
67158
|
-
* @version
|
|
67254
|
+
* @version 198.0.0
|
|
67159
67255
|
*/
|
|
67160
67256
|
|
|
67161
67257
|
/**
|
|
@@ -67822,7 +67918,7 @@ class WebChatApi {
|
|
|
67822
67918
|
/**
|
|
67823
67919
|
* WebChat service.
|
|
67824
67920
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67825
|
-
* @version
|
|
67921
|
+
* @version 198.0.0
|
|
67826
67922
|
*/
|
|
67827
67923
|
|
|
67828
67924
|
/**
|
|
@@ -68373,7 +68469,7 @@ class WebDeploymentsApi {
|
|
|
68373
68469
|
/**
|
|
68374
68470
|
* WebDeployments service.
|
|
68375
68471
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
68376
|
-
* @version
|
|
68472
|
+
* @version 198.0.0
|
|
68377
68473
|
*/
|
|
68378
68474
|
|
|
68379
68475
|
/**
|
|
@@ -68900,7 +68996,7 @@ class WebMessagingApi {
|
|
|
68900
68996
|
/**
|
|
68901
68997
|
* WebMessaging service.
|
|
68902
68998
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68903
|
-
* @version
|
|
68999
|
+
* @version 198.0.0
|
|
68904
69000
|
*/
|
|
68905
69001
|
|
|
68906
69002
|
/**
|
|
@@ -68946,7 +69042,7 @@ class WidgetsApi {
|
|
|
68946
69042
|
/**
|
|
68947
69043
|
* Widgets service.
|
|
68948
69044
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68949
|
-
* @version
|
|
69045
|
+
* @version 198.0.0
|
|
68950
69046
|
*/
|
|
68951
69047
|
|
|
68952
69048
|
/**
|
|
@@ -69092,7 +69188,7 @@ class WorkforceManagementApi {
|
|
|
69092
69188
|
/**
|
|
69093
69189
|
* WorkforceManagement service.
|
|
69094
69190
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
69095
|
-
* @version
|
|
69191
|
+
* @version 198.0.0
|
|
69096
69192
|
*/
|
|
69097
69193
|
|
|
69098
69194
|
/**
|
|
@@ -69702,32 +69798,6 @@ class WorkforceManagementApi {
|
|
|
69702
69798
|
);
|
|
69703
69799
|
}
|
|
69704
69800
|
|
|
69705
|
-
/**
|
|
69706
|
-
* To get status of the modeling job.
|
|
69707
|
-
* This Endpoint is Deprecated, and not recommended to be used.
|
|
69708
|
-
* @param {String} jobId The id of the modeling job
|
|
69709
|
-
* @deprecated
|
|
69710
|
-
*/
|
|
69711
|
-
getWorkforcemanagementAdhocmodelingjob(jobId) {
|
|
69712
|
-
// verify the required parameter 'jobId' is set
|
|
69713
|
-
if (jobId === undefined || jobId === null) {
|
|
69714
|
-
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';
|
|
69715
|
-
}
|
|
69716
|
-
|
|
69717
|
-
return this.apiClient.callApi(
|
|
69718
|
-
'/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}',
|
|
69719
|
-
'GET',
|
|
69720
|
-
{ 'jobId': jobId },
|
|
69721
|
-
{ },
|
|
69722
|
-
{ },
|
|
69723
|
-
{ },
|
|
69724
|
-
null,
|
|
69725
|
-
['PureCloud OAuth'],
|
|
69726
|
-
['application/json'],
|
|
69727
|
-
['application/json']
|
|
69728
|
-
);
|
|
69729
|
-
}
|
|
69730
|
-
|
|
69731
69801
|
/**
|
|
69732
69802
|
* Get an adherence explanation
|
|
69733
69803
|
*
|
|
@@ -69891,6 +69961,129 @@ class WorkforceManagementApi {
|
|
|
69891
69961
|
);
|
|
69892
69962
|
}
|
|
69893
69963
|
|
|
69964
|
+
/**
|
|
69965
|
+
* Get an activity plan
|
|
69966
|
+
*
|
|
69967
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69968
|
+
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
69969
|
+
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69970
|
+
*/
|
|
69971
|
+
getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
|
|
69972
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69973
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69974
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';
|
|
69975
|
+
}
|
|
69976
|
+
// verify the required parameter 'activityPlanId' is set
|
|
69977
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
69978
|
+
throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplan';
|
|
69979
|
+
}
|
|
69980
|
+
|
|
69981
|
+
return this.apiClient.callApi(
|
|
69982
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
69983
|
+
'GET',
|
|
69984
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
69985
|
+
{ },
|
|
69986
|
+
{ },
|
|
69987
|
+
{ },
|
|
69988
|
+
null,
|
|
69989
|
+
['PureCloud OAuth'],
|
|
69990
|
+
['application/json'],
|
|
69991
|
+
['application/json']
|
|
69992
|
+
);
|
|
69993
|
+
}
|
|
69994
|
+
|
|
69995
|
+
/**
|
|
69996
|
+
* Gets an activity plan run job
|
|
69997
|
+
*
|
|
69998
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69999
|
+
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
70000
|
+
* @param {String} jobId The ID of the activity plan run job
|
|
70001
|
+
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70002
|
+
*/
|
|
70003
|
+
getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
|
|
70004
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70005
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70006
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70007
|
+
}
|
|
70008
|
+
// verify the required parameter 'activityPlanId' is set
|
|
70009
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
70010
|
+
throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70011
|
+
}
|
|
70012
|
+
// verify the required parameter 'jobId' is set
|
|
70013
|
+
if (jobId === undefined || jobId === null) {
|
|
70014
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70015
|
+
}
|
|
70016
|
+
|
|
70017
|
+
return this.apiClient.callApi(
|
|
70018
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}',
|
|
70019
|
+
'GET',
|
|
70020
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId,'jobId': jobId },
|
|
70021
|
+
{ },
|
|
70022
|
+
{ },
|
|
70023
|
+
{ },
|
|
70024
|
+
null,
|
|
70025
|
+
['PureCloud OAuth'],
|
|
70026
|
+
['application/json'],
|
|
70027
|
+
['application/json']
|
|
70028
|
+
);
|
|
70029
|
+
}
|
|
70030
|
+
|
|
70031
|
+
/**
|
|
70032
|
+
* Get activity plans
|
|
70033
|
+
*
|
|
70034
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70035
|
+
* @param {Object} opts Optional parameters
|
|
70036
|
+
* @param {Object} opts.state Optionally filter by activity plan state
|
|
70037
|
+
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70038
|
+
*/
|
|
70039
|
+
getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
|
|
70040
|
+
opts = opts || {};
|
|
70041
|
+
|
|
70042
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70043
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70044
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplans';
|
|
70045
|
+
}
|
|
70046
|
+
|
|
70047
|
+
return this.apiClient.callApi(
|
|
70048
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
|
|
70049
|
+
'GET',
|
|
70050
|
+
{ 'businessUnitId': businessUnitId },
|
|
70051
|
+
{ 'state': opts['state'] },
|
|
70052
|
+
{ },
|
|
70053
|
+
{ },
|
|
70054
|
+
null,
|
|
70055
|
+
['PureCloud OAuth'],
|
|
70056
|
+
['application/json'],
|
|
70057
|
+
['application/json']
|
|
70058
|
+
);
|
|
70059
|
+
}
|
|
70060
|
+
|
|
70061
|
+
/**
|
|
70062
|
+
* Gets the latest job for all activity plans in the business unit
|
|
70063
|
+
*
|
|
70064
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70065
|
+
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70066
|
+
*/
|
|
70067
|
+
getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
|
|
70068
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70069
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70070
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplansJobs';
|
|
70071
|
+
}
|
|
70072
|
+
|
|
70073
|
+
return this.apiClient.callApi(
|
|
70074
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs',
|
|
70075
|
+
'GET',
|
|
70076
|
+
{ 'businessUnitId': businessUnitId },
|
|
70077
|
+
{ },
|
|
70078
|
+
{ },
|
|
70079
|
+
{ },
|
|
70080
|
+
null,
|
|
70081
|
+
['PureCloud OAuth'],
|
|
70082
|
+
['application/json'],
|
|
70083
|
+
['application/json']
|
|
70084
|
+
);
|
|
70085
|
+
}
|
|
70086
|
+
|
|
69894
70087
|
/**
|
|
69895
70088
|
* Get intraday planning groups for the given date
|
|
69896
70089
|
*
|
|
@@ -72054,6 +72247,42 @@ class WorkforceManagementApi {
|
|
|
72054
72247
|
);
|
|
72055
72248
|
}
|
|
72056
72249
|
|
|
72250
|
+
/**
|
|
72251
|
+
* Update an activity plan
|
|
72252
|
+
* If a job associated with the activity plan is in Processing state the activity plan cannot be updated
|
|
72253
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72254
|
+
* @param {String} activityPlanId The ID of the activity plan to update
|
|
72255
|
+
* @param {Object} body body
|
|
72256
|
+
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
72257
|
+
*/
|
|
72258
|
+
patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
|
|
72259
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72260
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72261
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72262
|
+
}
|
|
72263
|
+
// verify the required parameter 'activityPlanId' is set
|
|
72264
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
72265
|
+
throw 'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72266
|
+
}
|
|
72267
|
+
// verify the required parameter 'body' is set
|
|
72268
|
+
if (body === undefined || body === null) {
|
|
72269
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72270
|
+
}
|
|
72271
|
+
|
|
72272
|
+
return this.apiClient.callApi(
|
|
72273
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
72274
|
+
'PATCH',
|
|
72275
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
72276
|
+
{ },
|
|
72277
|
+
{ },
|
|
72278
|
+
{ },
|
|
72279
|
+
body,
|
|
72280
|
+
['PureCloud OAuth'],
|
|
72281
|
+
['application/json'],
|
|
72282
|
+
['application/json']
|
|
72283
|
+
);
|
|
72284
|
+
}
|
|
72285
|
+
|
|
72057
72286
|
/**
|
|
72058
72287
|
* Updates the planning group
|
|
72059
72288
|
*
|
|
@@ -72861,6 +73090,68 @@ class WorkforceManagementApi {
|
|
|
72861
73090
|
);
|
|
72862
73091
|
}
|
|
72863
73092
|
|
|
73093
|
+
/**
|
|
73094
|
+
* Run an activity plan manually
|
|
73095
|
+
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
73096
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73097
|
+
* @param {String} activityPlanId The ID of the activity plan to run
|
|
73098
|
+
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73099
|
+
*/
|
|
73100
|
+
postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
|
|
73101
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73102
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73103
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
|
|
73104
|
+
}
|
|
73105
|
+
// verify the required parameter 'activityPlanId' is set
|
|
73106
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
73107
|
+
throw 'Missing the required parameter "activityPlanId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
|
|
73108
|
+
}
|
|
73109
|
+
|
|
73110
|
+
return this.apiClient.callApi(
|
|
73111
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs',
|
|
73112
|
+
'POST',
|
|
73113
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
73114
|
+
{ },
|
|
73115
|
+
{ },
|
|
73116
|
+
{ },
|
|
73117
|
+
null,
|
|
73118
|
+
['PureCloud OAuth'],
|
|
73119
|
+
['application/json'],
|
|
73120
|
+
['application/json']
|
|
73121
|
+
);
|
|
73122
|
+
}
|
|
73123
|
+
|
|
73124
|
+
/**
|
|
73125
|
+
* Create an activity plan
|
|
73126
|
+
*
|
|
73127
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73128
|
+
* @param {Object} body body
|
|
73129
|
+
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73130
|
+
*/
|
|
73131
|
+
postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
|
|
73132
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73133
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73134
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';
|
|
73135
|
+
}
|
|
73136
|
+
// verify the required parameter 'body' is set
|
|
73137
|
+
if (body === undefined || body === null) {
|
|
73138
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivityplans';
|
|
73139
|
+
}
|
|
73140
|
+
|
|
73141
|
+
return this.apiClient.callApi(
|
|
73142
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
|
|
73143
|
+
'POST',
|
|
73144
|
+
{ 'businessUnitId': businessUnitId },
|
|
73145
|
+
{ },
|
|
73146
|
+
{ },
|
|
73147
|
+
{ },
|
|
73148
|
+
body,
|
|
73149
|
+
['PureCloud OAuth'],
|
|
73150
|
+
['application/json'],
|
|
73151
|
+
['application/json']
|
|
73152
|
+
);
|
|
73153
|
+
}
|
|
73154
|
+
|
|
72864
73155
|
/**
|
|
72865
73156
|
* Query adherence explanations across an entire business unit for the requested period
|
|
72866
73157
|
*
|
|
@@ -75005,7 +75296,7 @@ class WorkforceManagementApi {
|
|
|
75005
75296
|
* </pre>
|
|
75006
75297
|
* </p>
|
|
75007
75298
|
* @module purecloud-platform-client-v2/index
|
|
75008
|
-
* @version
|
|
75299
|
+
* @version 198.0.0
|
|
75009
75300
|
*/
|
|
75010
75301
|
class platformClient {
|
|
75011
75302
|
constructor() {
|