purecloud-platform-client-v2 197.0.0 → 199.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 -112
- package/dist/web-amd/purecloud-platform-client-v2.js +401 -112
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +167 -92
- package/dist/web-cjs/purecloud-platform-client-v2.js +170 -93
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +733 -238
- 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 -3
- 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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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
|
*
|
|
@@ -17843,7 +17879,6 @@ class ConversationsApi {
|
|
|
17843
17879
|
* Barge a conversation creating a barged in conference of connected participants.
|
|
17844
17880
|
*
|
|
17845
17881
|
* @param {String} conversationId conversation ID
|
|
17846
|
-
* postConversationBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17847
17882
|
*/
|
|
17848
17883
|
postConversationBarge(conversationId) {
|
|
17849
17884
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18291,7 +18326,6 @@ class ConversationsApi {
|
|
|
18291
18326
|
*
|
|
18292
18327
|
* @param {String} conversationId conversationId
|
|
18293
18328
|
* @param {String} participantId participantId
|
|
18294
|
-
* postConversationsCallParticipantBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18295
18329
|
*/
|
|
18296
18330
|
postConversationsCallParticipantBarge(conversationId, participantId) {
|
|
18297
18331
|
// verify the required parameter 'conversationId' is set
|
|
@@ -20639,7 +20673,7 @@ class DataExtensionsApi {
|
|
|
20639
20673
|
/**
|
|
20640
20674
|
* DataExtensions service.
|
|
20641
20675
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20642
|
-
* @version
|
|
20676
|
+
* @version 199.0.0
|
|
20643
20677
|
*/
|
|
20644
20678
|
|
|
20645
20679
|
/**
|
|
@@ -20725,7 +20759,7 @@ class DownloadsApi {
|
|
|
20725
20759
|
/**
|
|
20726
20760
|
* Downloads service.
|
|
20727
20761
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20728
|
-
* @version
|
|
20762
|
+
* @version 199.0.0
|
|
20729
20763
|
*/
|
|
20730
20764
|
|
|
20731
20765
|
/**
|
|
@@ -20777,7 +20811,7 @@ class EmailsApi {
|
|
|
20777
20811
|
/**
|
|
20778
20812
|
* Emails service.
|
|
20779
20813
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20780
|
-
* @version
|
|
20814
|
+
* @version 199.0.0
|
|
20781
20815
|
*/
|
|
20782
20816
|
|
|
20783
20817
|
/**
|
|
@@ -20842,7 +20876,7 @@ class EmployeeEngagementApi {
|
|
|
20842
20876
|
/**
|
|
20843
20877
|
* EmployeeEngagement service.
|
|
20844
20878
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20845
|
-
* @version
|
|
20879
|
+
* @version 199.0.0
|
|
20846
20880
|
*/
|
|
20847
20881
|
|
|
20848
20882
|
/**
|
|
@@ -20993,7 +21027,7 @@ class EventsApi {
|
|
|
20993
21027
|
/**
|
|
20994
21028
|
* Events service.
|
|
20995
21029
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20996
|
-
* @version
|
|
21030
|
+
* @version 199.0.0
|
|
20997
21031
|
*/
|
|
20998
21032
|
|
|
20999
21033
|
/**
|
|
@@ -21089,7 +21123,7 @@ class ExternalContactsApi {
|
|
|
21089
21123
|
/**
|
|
21090
21124
|
* ExternalContacts service.
|
|
21091
21125
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21092
|
-
* @version
|
|
21126
|
+
* @version 199.0.0
|
|
21093
21127
|
*/
|
|
21094
21128
|
|
|
21095
21129
|
/**
|
|
@@ -21445,7 +21479,7 @@ class ExternalContactsApi {
|
|
|
21445
21479
|
*
|
|
21446
21480
|
* @param {String} contactId ExternalContact ID
|
|
21447
21481
|
* @param {Object} opts Optional parameters
|
|
21448
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
21482
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
21449
21483
|
*/
|
|
21450
21484
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
21451
21485
|
opts = opts || {};
|
|
@@ -23051,7 +23085,7 @@ class FaxApi {
|
|
|
23051
23085
|
/**
|
|
23052
23086
|
* Fax service.
|
|
23053
23087
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23054
|
-
* @version
|
|
23088
|
+
* @version 199.0.0
|
|
23055
23089
|
*/
|
|
23056
23090
|
|
|
23057
23091
|
/**
|
|
@@ -23266,7 +23300,7 @@ class FlowsApi {
|
|
|
23266
23300
|
/**
|
|
23267
23301
|
* Flows service.
|
|
23268
23302
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23269
|
-
* @version
|
|
23303
|
+
* @version 199.0.0
|
|
23270
23304
|
*/
|
|
23271
23305
|
|
|
23272
23306
|
/**
|
|
@@ -23449,7 +23483,7 @@ class GamificationApi {
|
|
|
23449
23483
|
/**
|
|
23450
23484
|
* Gamification service.
|
|
23451
23485
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23452
|
-
* @version
|
|
23486
|
+
* @version 199.0.0
|
|
23453
23487
|
*/
|
|
23454
23488
|
|
|
23455
23489
|
/**
|
|
@@ -25535,7 +25569,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25535
25569
|
/**
|
|
25536
25570
|
* GeneralDataProtectionRegulation service.
|
|
25537
25571
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25538
|
-
* @version
|
|
25572
|
+
* @version 199.0.0
|
|
25539
25573
|
*/
|
|
25540
25574
|
|
|
25541
25575
|
/**
|
|
@@ -25665,7 +25699,7 @@ class GeolocationApi {
|
|
|
25665
25699
|
/**
|
|
25666
25700
|
* Geolocation service.
|
|
25667
25701
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25668
|
-
* @version
|
|
25702
|
+
* @version 199.0.0
|
|
25669
25703
|
*/
|
|
25670
25704
|
|
|
25671
25705
|
/**
|
|
@@ -25796,7 +25830,7 @@ class GreetingsApi {
|
|
|
25796
25830
|
/**
|
|
25797
25831
|
* Greetings service.
|
|
25798
25832
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25799
|
-
* @version
|
|
25833
|
+
* @version 199.0.0
|
|
25800
25834
|
*/
|
|
25801
25835
|
|
|
25802
25836
|
/**
|
|
@@ -26251,7 +26285,7 @@ class GroupsApi {
|
|
|
26251
26285
|
/**
|
|
26252
26286
|
* Groups service.
|
|
26253
26287
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26254
|
-
* @version
|
|
26288
|
+
* @version 199.0.0
|
|
26255
26289
|
*/
|
|
26256
26290
|
|
|
26257
26291
|
/**
|
|
@@ -26770,7 +26804,7 @@ class IdentityProviderApi {
|
|
|
26770
26804
|
/**
|
|
26771
26805
|
* IdentityProvider service.
|
|
26772
26806
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26773
|
-
* @version
|
|
26807
|
+
* @version 199.0.0
|
|
26774
26808
|
*/
|
|
26775
26809
|
|
|
26776
26810
|
/**
|
|
@@ -27631,7 +27665,7 @@ class InfrastructureAsCodeApi {
|
|
|
27631
27665
|
/**
|
|
27632
27666
|
* InfrastructureAsCode service.
|
|
27633
27667
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27634
|
-
* @version
|
|
27668
|
+
* @version 199.0.0
|
|
27635
27669
|
*/
|
|
27636
27670
|
|
|
27637
27671
|
/**
|
|
@@ -27798,7 +27832,7 @@ class IntegrationsApi {
|
|
|
27798
27832
|
/**
|
|
27799
27833
|
* Integrations service.
|
|
27800
27834
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27801
|
-
* @version
|
|
27835
|
+
* @version 199.0.0
|
|
27802
27836
|
*/
|
|
27803
27837
|
|
|
27804
27838
|
/**
|
|
@@ -30150,7 +30184,7 @@ class JourneyApi {
|
|
|
30150
30184
|
/**
|
|
30151
30185
|
* Journey service.
|
|
30152
30186
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30153
|
-
* @version
|
|
30187
|
+
* @version 199.0.0
|
|
30154
30188
|
*/
|
|
30155
30189
|
|
|
30156
30190
|
/**
|
|
@@ -30895,7 +30929,6 @@ class JourneyApi {
|
|
|
30895
30929
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
30896
30930
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
30897
30931
|
* @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
30932
|
*/
|
|
30900
30933
|
getJourneySessionEvents(sessionId, opts) {
|
|
30901
30934
|
opts = opts || {};
|
|
@@ -31528,6 +31561,35 @@ class JourneyApi {
|
|
|
31528
31561
|
);
|
|
31529
31562
|
}
|
|
31530
31563
|
|
|
31564
|
+
/**
|
|
31565
|
+
* Send a journey web event, used for tracking customer activity on a website.
|
|
31566
|
+
*
|
|
31567
|
+
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
31568
|
+
* @param {Object} opts Optional parameters
|
|
31569
|
+
* @param {Object} opts.body
|
|
31570
|
+
*/
|
|
31571
|
+
postJourneyDeploymentWebevents(deploymentId, opts) {
|
|
31572
|
+
opts = opts || {};
|
|
31573
|
+
|
|
31574
|
+
// verify the required parameter 'deploymentId' is set
|
|
31575
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
31576
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';
|
|
31577
|
+
}
|
|
31578
|
+
|
|
31579
|
+
return this.apiClient.callApi(
|
|
31580
|
+
'/api/v2/journey/deployments/{deploymentId}/webevents',
|
|
31581
|
+
'POST',
|
|
31582
|
+
{ 'deploymentId': deploymentId },
|
|
31583
|
+
{ },
|
|
31584
|
+
{ },
|
|
31585
|
+
{ },
|
|
31586
|
+
opts['body'],
|
|
31587
|
+
['PureCloud OAuth'],
|
|
31588
|
+
['application/json'],
|
|
31589
|
+
['application/json']
|
|
31590
|
+
);
|
|
31591
|
+
}
|
|
31592
|
+
|
|
31531
31593
|
/**
|
|
31532
31594
|
* Query for flow paths.
|
|
31533
31595
|
*
|
|
@@ -31768,7 +31830,7 @@ class KnowledgeApi {
|
|
|
31768
31830
|
/**
|
|
31769
31831
|
* Knowledge service.
|
|
31770
31832
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31771
|
-
* @version
|
|
31833
|
+
* @version 199.0.0
|
|
31772
31834
|
*/
|
|
31773
31835
|
|
|
31774
31836
|
/**
|
|
@@ -35012,7 +35074,7 @@ class LanguageUnderstandingApi {
|
|
|
35012
35074
|
/**
|
|
35013
35075
|
* LanguageUnderstanding service.
|
|
35014
35076
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
35015
|
-
* @version
|
|
35077
|
+
* @version 199.0.0
|
|
35016
35078
|
*/
|
|
35017
35079
|
|
|
35018
35080
|
/**
|
|
@@ -36046,7 +36108,7 @@ class LanguagesApi {
|
|
|
36046
36108
|
/**
|
|
36047
36109
|
* Languages service.
|
|
36048
36110
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
36049
|
-
* @version
|
|
36111
|
+
* @version 199.0.0
|
|
36050
36112
|
*/
|
|
36051
36113
|
|
|
36052
36114
|
/**
|
|
@@ -36268,7 +36330,7 @@ class LearningApi {
|
|
|
36268
36330
|
/**
|
|
36269
36331
|
* Learning service.
|
|
36270
36332
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36271
|
-
* @version
|
|
36333
|
+
* @version 199.0.0
|
|
36272
36334
|
*/
|
|
36273
36335
|
|
|
36274
36336
|
/**
|
|
@@ -37297,7 +37359,7 @@ class LicenseApi {
|
|
|
37297
37359
|
/**
|
|
37298
37360
|
* License service.
|
|
37299
37361
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37300
|
-
* @version
|
|
37362
|
+
* @version 199.0.0
|
|
37301
37363
|
*/
|
|
37302
37364
|
|
|
37303
37365
|
/**
|
|
@@ -37535,7 +37597,7 @@ class LocationsApi {
|
|
|
37535
37597
|
/**
|
|
37536
37598
|
* Locations service.
|
|
37537
37599
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37538
|
-
* @version
|
|
37600
|
+
* @version 199.0.0
|
|
37539
37601
|
*/
|
|
37540
37602
|
|
|
37541
37603
|
/**
|
|
@@ -37771,7 +37833,7 @@ class LogCaptureApi {
|
|
|
37771
37833
|
/**
|
|
37772
37834
|
* LogCapture service.
|
|
37773
37835
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37774
|
-
* @version
|
|
37836
|
+
* @version 199.0.0
|
|
37775
37837
|
*/
|
|
37776
37838
|
|
|
37777
37839
|
/**
|
|
@@ -37971,7 +38033,7 @@ class MessagingApi {
|
|
|
37971
38033
|
/**
|
|
37972
38034
|
* Messaging service.
|
|
37973
38035
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37974
|
-
* @version
|
|
38036
|
+
* @version 199.0.0
|
|
37975
38037
|
*/
|
|
37976
38038
|
|
|
37977
38039
|
/**
|
|
@@ -38330,7 +38392,7 @@ class MobileDevicesApi {
|
|
|
38330
38392
|
/**
|
|
38331
38393
|
* MobileDevices service.
|
|
38332
38394
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38333
|
-
* @version
|
|
38395
|
+
* @version 199.0.0
|
|
38334
38396
|
*/
|
|
38335
38397
|
|
|
38336
38398
|
/**
|
|
@@ -38481,7 +38543,7 @@ class NotificationsApi {
|
|
|
38481
38543
|
/**
|
|
38482
38544
|
* Notifications service.
|
|
38483
38545
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38484
|
-
* @version
|
|
38546
|
+
* @version 199.0.0
|
|
38485
38547
|
*/
|
|
38486
38548
|
|
|
38487
38549
|
/**
|
|
@@ -38714,7 +38776,7 @@ class OAuthApi {
|
|
|
38714
38776
|
/**
|
|
38715
38777
|
* OAuth service.
|
|
38716
38778
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38717
|
-
* @version
|
|
38779
|
+
* @version 199.0.0
|
|
38718
38780
|
*/
|
|
38719
38781
|
|
|
38720
38782
|
/**
|
|
@@ -39080,7 +39142,7 @@ class ObjectsApi {
|
|
|
39080
39142
|
/**
|
|
39081
39143
|
* Objects service.
|
|
39082
39144
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
39083
|
-
* @version
|
|
39145
|
+
* @version 199.0.0
|
|
39084
39146
|
*/
|
|
39085
39147
|
|
|
39086
39148
|
/**
|
|
@@ -39350,7 +39412,7 @@ class OperationalEventsApi {
|
|
|
39350
39412
|
/**
|
|
39351
39413
|
* OperationalEvents service.
|
|
39352
39414
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39353
|
-
* @version
|
|
39415
|
+
* @version 199.0.0
|
|
39354
39416
|
*/
|
|
39355
39417
|
|
|
39356
39418
|
/**
|
|
@@ -39416,7 +39478,7 @@ class OrganizationApi {
|
|
|
39416
39478
|
/**
|
|
39417
39479
|
* Organization service.
|
|
39418
39480
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39419
|
-
* @version
|
|
39481
|
+
* @version 199.0.0
|
|
39420
39482
|
*/
|
|
39421
39483
|
|
|
39422
39484
|
/**
|
|
@@ -39891,7 +39953,7 @@ class OrganizationAuthorizationApi {
|
|
|
39891
39953
|
/**
|
|
39892
39954
|
* OrganizationAuthorization service.
|
|
39893
39955
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39894
|
-
* @version
|
|
39956
|
+
* @version 199.0.0
|
|
39895
39957
|
*/
|
|
39896
39958
|
|
|
39897
39959
|
/**
|
|
@@ -41238,7 +41300,7 @@ class OutboundApi {
|
|
|
41238
41300
|
/**
|
|
41239
41301
|
* Outbound service.
|
|
41240
41302
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
41241
|
-
* @version
|
|
41303
|
+
* @version 199.0.0
|
|
41242
41304
|
*/
|
|
41243
41305
|
|
|
41244
41306
|
/**
|
|
@@ -41852,7 +41914,7 @@ class OutboundApi {
|
|
|
41852
41914
|
|
|
41853
41915
|
/**
|
|
41854
41916
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
41855
|
-
*
|
|
41917
|
+
* Documented permissions are applicable based on campaign type.
|
|
41856
41918
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
41857
41919
|
*/
|
|
41858
41920
|
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
@@ -45600,7 +45662,7 @@ class PresenceApi {
|
|
|
45600
45662
|
/**
|
|
45601
45663
|
* Presence service.
|
|
45602
45664
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45603
|
-
* @version
|
|
45665
|
+
* @version 199.0.0
|
|
45604
45666
|
*/
|
|
45605
45667
|
|
|
45606
45668
|
/**
|
|
@@ -46344,7 +46406,7 @@ class ProcessAutomationApi {
|
|
|
46344
46406
|
/**
|
|
46345
46407
|
* ProcessAutomation service.
|
|
46346
46408
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
46347
|
-
* @version
|
|
46409
|
+
* @version 199.0.0
|
|
46348
46410
|
*/
|
|
46349
46411
|
|
|
46350
46412
|
/**
|
|
@@ -46583,7 +46645,7 @@ class QualityApi {
|
|
|
46583
46645
|
/**
|
|
46584
46646
|
* Quality service.
|
|
46585
46647
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46586
|
-
* @version
|
|
46648
|
+
* @version 199.0.0
|
|
46587
46649
|
*/
|
|
46588
46650
|
|
|
46589
46651
|
/**
|
|
@@ -48272,6 +48334,37 @@ class QualityApi {
|
|
|
48272
48334
|
);
|
|
48273
48335
|
}
|
|
48274
48336
|
|
|
48337
|
+
/**
|
|
48338
|
+
* Update the AI Scoring settings of an evaluation form.
|
|
48339
|
+
*
|
|
48340
|
+
* @param {String} formId Form ID
|
|
48341
|
+
* @param {Object} body AI Scoring Settings
|
|
48342
|
+
* putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48343
|
+
*/
|
|
48344
|
+
putQualityFormsEvaluationAiscoringSettings(formId, body) {
|
|
48345
|
+
// verify the required parameter 'formId' is set
|
|
48346
|
+
if (formId === undefined || formId === null) {
|
|
48347
|
+
throw 'Missing the required parameter "formId" when calling putQualityFormsEvaluationAiscoringSettings';
|
|
48348
|
+
}
|
|
48349
|
+
// verify the required parameter 'body' is set
|
|
48350
|
+
if (body === undefined || body === null) {
|
|
48351
|
+
throw 'Missing the required parameter "body" when calling putQualityFormsEvaluationAiscoringSettings';
|
|
48352
|
+
}
|
|
48353
|
+
|
|
48354
|
+
return this.apiClient.callApi(
|
|
48355
|
+
'/api/v2/quality/forms/evaluations/{formId}/aiscoring/settings',
|
|
48356
|
+
'PUT',
|
|
48357
|
+
{ 'formId': formId },
|
|
48358
|
+
{ },
|
|
48359
|
+
{ },
|
|
48360
|
+
{ },
|
|
48361
|
+
body,
|
|
48362
|
+
['PureCloud OAuth'],
|
|
48363
|
+
['application/json'],
|
|
48364
|
+
['application/json']
|
|
48365
|
+
);
|
|
48366
|
+
}
|
|
48367
|
+
|
|
48275
48368
|
/**
|
|
48276
48369
|
* Update a survey form.
|
|
48277
48370
|
*
|
|
@@ -48338,7 +48431,7 @@ class RecordingApi {
|
|
|
48338
48431
|
/**
|
|
48339
48432
|
* Recording service.
|
|
48340
48433
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
48341
|
-
* @version
|
|
48434
|
+
* @version 199.0.0
|
|
48342
48435
|
*/
|
|
48343
48436
|
|
|
48344
48437
|
/**
|
|
@@ -49996,7 +50089,7 @@ class ResponseManagementApi {
|
|
|
49996
50089
|
/**
|
|
49997
50090
|
* ResponseManagement service.
|
|
49998
50091
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49999
|
-
* @version
|
|
50092
|
+
* @version 199.0.0
|
|
50000
50093
|
*/
|
|
50001
50094
|
|
|
50002
50095
|
/**
|
|
@@ -50506,7 +50599,7 @@ class RoutingApi {
|
|
|
50506
50599
|
/**
|
|
50507
50600
|
* Routing service.
|
|
50508
50601
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50509
|
-
* @version
|
|
50602
|
+
* @version 199.0.0
|
|
50510
50603
|
*/
|
|
50511
50604
|
|
|
50512
50605
|
/**
|
|
@@ -54480,7 +54573,7 @@ class SCIMApi {
|
|
|
54480
54573
|
/**
|
|
54481
54574
|
* SCIM service.
|
|
54482
54575
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54483
|
-
* @version
|
|
54576
|
+
* @version 199.0.0
|
|
54484
54577
|
*/
|
|
54485
54578
|
|
|
54486
54579
|
/**
|
|
@@ -55357,7 +55450,7 @@ class ScreenRecordingApi {
|
|
|
55357
55450
|
/**
|
|
55358
55451
|
* ScreenRecording service.
|
|
55359
55452
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
55360
|
-
* @version
|
|
55453
|
+
* @version 199.0.0
|
|
55361
55454
|
*/
|
|
55362
55455
|
|
|
55363
55456
|
/**
|
|
@@ -55402,7 +55495,7 @@ class ScriptsApi {
|
|
|
55402
55495
|
/**
|
|
55403
55496
|
* Scripts service.
|
|
55404
55497
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55405
|
-
* @version
|
|
55498
|
+
* @version 199.0.0
|
|
55406
55499
|
*/
|
|
55407
55500
|
|
|
55408
55501
|
/**
|
|
@@ -55846,7 +55939,7 @@ class SearchApi {
|
|
|
55846
55939
|
/**
|
|
55847
55940
|
* Search service.
|
|
55848
55941
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55849
|
-
* @version
|
|
55942
|
+
* @version 199.0.0
|
|
55850
55943
|
*/
|
|
55851
55944
|
|
|
55852
55945
|
/**
|
|
@@ -56535,7 +56628,7 @@ class SettingsApi {
|
|
|
56535
56628
|
/**
|
|
56536
56629
|
* Settings service.
|
|
56537
56630
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56538
|
-
* @version
|
|
56631
|
+
* @version 199.0.0
|
|
56539
56632
|
*/
|
|
56540
56633
|
|
|
56541
56634
|
/**
|
|
@@ -56757,7 +56850,7 @@ class SpeechTextAnalyticsApi {
|
|
|
56757
56850
|
/**
|
|
56758
56851
|
* SpeechTextAnalytics service.
|
|
56759
56852
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56760
|
-
* @version
|
|
56853
|
+
* @version 199.0.0
|
|
56761
56854
|
*/
|
|
56762
56855
|
|
|
56763
56856
|
/**
|
|
@@ -58035,7 +58128,7 @@ class StationsApi {
|
|
|
58035
58128
|
/**
|
|
58036
58129
|
* Stations service.
|
|
58037
58130
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
58038
|
-
* @version
|
|
58131
|
+
* @version 199.0.0
|
|
58039
58132
|
*/
|
|
58040
58133
|
|
|
58041
58134
|
/**
|
|
@@ -58137,7 +58230,7 @@ class SuggestApi {
|
|
|
58137
58230
|
/**
|
|
58138
58231
|
* Suggest service.
|
|
58139
58232
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
58140
|
-
* @version
|
|
58233
|
+
* @version 199.0.0
|
|
58141
58234
|
*/
|
|
58142
58235
|
|
|
58143
58236
|
/**
|
|
@@ -58276,7 +58369,7 @@ class TaskManagementApi {
|
|
|
58276
58369
|
/**
|
|
58277
58370
|
* TaskManagement service.
|
|
58278
58371
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
58279
|
-
* @version
|
|
58372
|
+
* @version 199.0.0
|
|
58280
58373
|
*/
|
|
58281
58374
|
|
|
58282
58375
|
/**
|
|
@@ -58921,6 +59014,7 @@ class TaskManagementApi {
|
|
|
58921
59014
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
58922
59015
|
* @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
59016
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59017
|
+
* @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
59018
|
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58925
59019
|
*/
|
|
58926
59020
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
@@ -58935,7 +59029,7 @@ class TaskManagementApi {
|
|
|
58935
59029
|
'/api/v2/taskmanagement/worktypes/{worktypeId}/history',
|
|
58936
59030
|
'GET',
|
|
58937
59031
|
{ 'worktypeId': worktypeId },
|
|
58938
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
|
|
59032
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
|
|
58939
59033
|
{ },
|
|
58940
59034
|
{ },
|
|
58941
59035
|
null,
|
|
@@ -59624,7 +59718,7 @@ class TeamsApi {
|
|
|
59624
59718
|
/**
|
|
59625
59719
|
* Teams service.
|
|
59626
59720
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59627
|
-
* @version
|
|
59721
|
+
* @version 199.0.0
|
|
59628
59722
|
*/
|
|
59629
59723
|
|
|
59630
59724
|
/**
|
|
@@ -59925,7 +60019,7 @@ class TelephonyApi {
|
|
|
59925
60019
|
/**
|
|
59926
60020
|
* Telephony service.
|
|
59927
60021
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59928
|
-
* @version
|
|
60022
|
+
* @version 199.0.0
|
|
59929
60023
|
*/
|
|
59930
60024
|
|
|
59931
60025
|
/**
|
|
@@ -60107,7 +60201,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
60107
60201
|
/**
|
|
60108
60202
|
* TelephonyProvidersEdge service.
|
|
60109
60203
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
60110
|
-
* @version
|
|
60204
|
+
* @version 199.0.0
|
|
60111
60205
|
*/
|
|
60112
60206
|
|
|
60113
60207
|
/**
|
|
@@ -63435,7 +63529,7 @@ class TextbotsApi {
|
|
|
63435
63529
|
/**
|
|
63436
63530
|
* Textbots service.
|
|
63437
63531
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
63438
|
-
* @version
|
|
63532
|
+
* @version 199.0.0
|
|
63439
63533
|
*/
|
|
63440
63534
|
|
|
63441
63535
|
/**
|
|
@@ -63563,7 +63657,7 @@ class TokensApi {
|
|
|
63563
63657
|
/**
|
|
63564
63658
|
* Tokens service.
|
|
63565
63659
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63566
|
-
* @version
|
|
63660
|
+
* @version 199.0.0
|
|
63567
63661
|
*/
|
|
63568
63662
|
|
|
63569
63663
|
/**
|
|
@@ -63717,7 +63811,7 @@ class UploadsApi {
|
|
|
63717
63811
|
/**
|
|
63718
63812
|
* Uploads service.
|
|
63719
63813
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63720
|
-
* @version
|
|
63814
|
+
* @version 199.0.0
|
|
63721
63815
|
*/
|
|
63722
63816
|
|
|
63723
63817
|
/**
|
|
@@ -63986,7 +64080,7 @@ class UsageApi {
|
|
|
63986
64080
|
/**
|
|
63987
64081
|
* Usage service.
|
|
63988
64082
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63989
|
-
* @version
|
|
64083
|
+
* @version 199.0.0
|
|
63990
64084
|
*/
|
|
63991
64085
|
|
|
63992
64086
|
/**
|
|
@@ -64201,7 +64295,7 @@ class UserRecordingsApi {
|
|
|
64201
64295
|
/**
|
|
64202
64296
|
* UserRecordings service.
|
|
64203
64297
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
64204
|
-
* @version
|
|
64298
|
+
* @version 199.0.0
|
|
64205
64299
|
*/
|
|
64206
64300
|
|
|
64207
64301
|
/**
|
|
@@ -64386,7 +64480,7 @@ class UsersApi {
|
|
|
64386
64480
|
/**
|
|
64387
64481
|
* Users service.
|
|
64388
64482
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
64389
|
-
* @version
|
|
64483
|
+
* @version 199.0.0
|
|
64390
64484
|
*/
|
|
64391
64485
|
|
|
64392
64486
|
/**
|
|
@@ -65018,7 +65112,7 @@ class UsersApi {
|
|
|
65018
65112
|
*
|
|
65019
65113
|
* @param {String} userId User ID
|
|
65020
65114
|
* @param {Object} opts Optional parameters
|
|
65021
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65115
|
+
* @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
65116
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
65023
65117
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
65024
65118
|
*/
|
|
@@ -65589,7 +65683,7 @@ class UsersApi {
|
|
|
65589
65683
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
65590
65684
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
65591
65685
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
65592
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65686
|
+
* @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
65687
|
* @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
65688
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
65595
65689
|
*/
|
|
@@ -67044,7 +67138,7 @@ class UtilitiesApi {
|
|
|
67044
67138
|
/**
|
|
67045
67139
|
* Utilities service.
|
|
67046
67140
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
67047
|
-
* @version
|
|
67141
|
+
* @version 199.0.0
|
|
67048
67142
|
*/
|
|
67049
67143
|
|
|
67050
67144
|
/**
|
|
@@ -67155,7 +67249,7 @@ class VoicemailApi {
|
|
|
67155
67249
|
/**
|
|
67156
67250
|
* Voicemail service.
|
|
67157
67251
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
67158
|
-
* @version
|
|
67252
|
+
* @version 199.0.0
|
|
67159
67253
|
*/
|
|
67160
67254
|
|
|
67161
67255
|
/**
|
|
@@ -67822,7 +67916,7 @@ class WebChatApi {
|
|
|
67822
67916
|
/**
|
|
67823
67917
|
* WebChat service.
|
|
67824
67918
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67825
|
-
* @version
|
|
67919
|
+
* @version 199.0.0
|
|
67826
67920
|
*/
|
|
67827
67921
|
|
|
67828
67922
|
/**
|
|
@@ -68373,7 +68467,7 @@ class WebDeploymentsApi {
|
|
|
68373
68467
|
/**
|
|
68374
68468
|
* WebDeployments service.
|
|
68375
68469
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
68376
|
-
* @version
|
|
68470
|
+
* @version 199.0.0
|
|
68377
68471
|
*/
|
|
68378
68472
|
|
|
68379
68473
|
/**
|
|
@@ -68900,7 +68994,7 @@ class WebMessagingApi {
|
|
|
68900
68994
|
/**
|
|
68901
68995
|
* WebMessaging service.
|
|
68902
68996
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68903
|
-
* @version
|
|
68997
|
+
* @version 199.0.0
|
|
68904
68998
|
*/
|
|
68905
68999
|
|
|
68906
69000
|
/**
|
|
@@ -68946,7 +69040,7 @@ class WidgetsApi {
|
|
|
68946
69040
|
/**
|
|
68947
69041
|
* Widgets service.
|
|
68948
69042
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68949
|
-
* @version
|
|
69043
|
+
* @version 199.0.0
|
|
68950
69044
|
*/
|
|
68951
69045
|
|
|
68952
69046
|
/**
|
|
@@ -69092,7 +69186,7 @@ class WorkforceManagementApi {
|
|
|
69092
69186
|
/**
|
|
69093
69187
|
* WorkforceManagement service.
|
|
69094
69188
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
69095
|
-
* @version
|
|
69189
|
+
* @version 199.0.0
|
|
69096
69190
|
*/
|
|
69097
69191
|
|
|
69098
69192
|
/**
|
|
@@ -69702,32 +69796,6 @@ class WorkforceManagementApi {
|
|
|
69702
69796
|
);
|
|
69703
69797
|
}
|
|
69704
69798
|
|
|
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
69799
|
/**
|
|
69732
69800
|
* Get an adherence explanation
|
|
69733
69801
|
*
|
|
@@ -69891,6 +69959,129 @@ class WorkforceManagementApi {
|
|
|
69891
69959
|
);
|
|
69892
69960
|
}
|
|
69893
69961
|
|
|
69962
|
+
/**
|
|
69963
|
+
* Get an activity plan
|
|
69964
|
+
*
|
|
69965
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69966
|
+
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
69967
|
+
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69968
|
+
*/
|
|
69969
|
+
getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
|
|
69970
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69971
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69972
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';
|
|
69973
|
+
}
|
|
69974
|
+
// verify the required parameter 'activityPlanId' is set
|
|
69975
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
69976
|
+
throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplan';
|
|
69977
|
+
}
|
|
69978
|
+
|
|
69979
|
+
return this.apiClient.callApi(
|
|
69980
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
69981
|
+
'GET',
|
|
69982
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
69983
|
+
{ },
|
|
69984
|
+
{ },
|
|
69985
|
+
{ },
|
|
69986
|
+
null,
|
|
69987
|
+
['PureCloud OAuth'],
|
|
69988
|
+
['application/json'],
|
|
69989
|
+
['application/json']
|
|
69990
|
+
);
|
|
69991
|
+
}
|
|
69992
|
+
|
|
69993
|
+
/**
|
|
69994
|
+
* Gets an activity plan run job
|
|
69995
|
+
*
|
|
69996
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69997
|
+
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
69998
|
+
* @param {String} jobId The ID of the activity plan run job
|
|
69999
|
+
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70000
|
+
*/
|
|
70001
|
+
getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
|
|
70002
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70003
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70004
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70005
|
+
}
|
|
70006
|
+
// verify the required parameter 'activityPlanId' is set
|
|
70007
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
70008
|
+
throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70009
|
+
}
|
|
70010
|
+
// verify the required parameter 'jobId' is set
|
|
70011
|
+
if (jobId === undefined || jobId === null) {
|
|
70012
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70013
|
+
}
|
|
70014
|
+
|
|
70015
|
+
return this.apiClient.callApi(
|
|
70016
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}',
|
|
70017
|
+
'GET',
|
|
70018
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId,'jobId': jobId },
|
|
70019
|
+
{ },
|
|
70020
|
+
{ },
|
|
70021
|
+
{ },
|
|
70022
|
+
null,
|
|
70023
|
+
['PureCloud OAuth'],
|
|
70024
|
+
['application/json'],
|
|
70025
|
+
['application/json']
|
|
70026
|
+
);
|
|
70027
|
+
}
|
|
70028
|
+
|
|
70029
|
+
/**
|
|
70030
|
+
* Get activity plans
|
|
70031
|
+
*
|
|
70032
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70033
|
+
* @param {Object} opts Optional parameters
|
|
70034
|
+
* @param {Object} opts.state Optionally filter by activity plan state
|
|
70035
|
+
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70036
|
+
*/
|
|
70037
|
+
getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
|
|
70038
|
+
opts = opts || {};
|
|
70039
|
+
|
|
70040
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70041
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70042
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplans';
|
|
70043
|
+
}
|
|
70044
|
+
|
|
70045
|
+
return this.apiClient.callApi(
|
|
70046
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
|
|
70047
|
+
'GET',
|
|
70048
|
+
{ 'businessUnitId': businessUnitId },
|
|
70049
|
+
{ 'state': opts['state'] },
|
|
70050
|
+
{ },
|
|
70051
|
+
{ },
|
|
70052
|
+
null,
|
|
70053
|
+
['PureCloud OAuth'],
|
|
70054
|
+
['application/json'],
|
|
70055
|
+
['application/json']
|
|
70056
|
+
);
|
|
70057
|
+
}
|
|
70058
|
+
|
|
70059
|
+
/**
|
|
70060
|
+
* Gets the latest job for all activity plans in the business unit
|
|
70061
|
+
*
|
|
70062
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70063
|
+
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70064
|
+
*/
|
|
70065
|
+
getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
|
|
70066
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70067
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70068
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplansJobs';
|
|
70069
|
+
}
|
|
70070
|
+
|
|
70071
|
+
return this.apiClient.callApi(
|
|
70072
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs',
|
|
70073
|
+
'GET',
|
|
70074
|
+
{ 'businessUnitId': businessUnitId },
|
|
70075
|
+
{ },
|
|
70076
|
+
{ },
|
|
70077
|
+
{ },
|
|
70078
|
+
null,
|
|
70079
|
+
['PureCloud OAuth'],
|
|
70080
|
+
['application/json'],
|
|
70081
|
+
['application/json']
|
|
70082
|
+
);
|
|
70083
|
+
}
|
|
70084
|
+
|
|
69894
70085
|
/**
|
|
69895
70086
|
* Get intraday planning groups for the given date
|
|
69896
70087
|
*
|
|
@@ -72054,6 +72245,42 @@ class WorkforceManagementApi {
|
|
|
72054
72245
|
);
|
|
72055
72246
|
}
|
|
72056
72247
|
|
|
72248
|
+
/**
|
|
72249
|
+
* Update an activity plan
|
|
72250
|
+
* If a job associated with the activity plan is in Processing state the activity plan cannot be updated
|
|
72251
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72252
|
+
* @param {String} activityPlanId The ID of the activity plan to update
|
|
72253
|
+
* @param {Object} body body
|
|
72254
|
+
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
72255
|
+
*/
|
|
72256
|
+
patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
|
|
72257
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72258
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72259
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72260
|
+
}
|
|
72261
|
+
// verify the required parameter 'activityPlanId' is set
|
|
72262
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
72263
|
+
throw 'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72264
|
+
}
|
|
72265
|
+
// verify the required parameter 'body' is set
|
|
72266
|
+
if (body === undefined || body === null) {
|
|
72267
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72268
|
+
}
|
|
72269
|
+
|
|
72270
|
+
return this.apiClient.callApi(
|
|
72271
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
72272
|
+
'PATCH',
|
|
72273
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
72274
|
+
{ },
|
|
72275
|
+
{ },
|
|
72276
|
+
{ },
|
|
72277
|
+
body,
|
|
72278
|
+
['PureCloud OAuth'],
|
|
72279
|
+
['application/json'],
|
|
72280
|
+
['application/json']
|
|
72281
|
+
);
|
|
72282
|
+
}
|
|
72283
|
+
|
|
72057
72284
|
/**
|
|
72058
72285
|
* Updates the planning group
|
|
72059
72286
|
*
|
|
@@ -72861,6 +73088,68 @@ class WorkforceManagementApi {
|
|
|
72861
73088
|
);
|
|
72862
73089
|
}
|
|
72863
73090
|
|
|
73091
|
+
/**
|
|
73092
|
+
* Run an activity plan manually
|
|
73093
|
+
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
73094
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73095
|
+
* @param {String} activityPlanId The ID of the activity plan to run
|
|
73096
|
+
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73097
|
+
*/
|
|
73098
|
+
postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
|
|
73099
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73100
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73101
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
|
|
73102
|
+
}
|
|
73103
|
+
// verify the required parameter 'activityPlanId' is set
|
|
73104
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
73105
|
+
throw 'Missing the required parameter "activityPlanId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
|
|
73106
|
+
}
|
|
73107
|
+
|
|
73108
|
+
return this.apiClient.callApi(
|
|
73109
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs',
|
|
73110
|
+
'POST',
|
|
73111
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
73112
|
+
{ },
|
|
73113
|
+
{ },
|
|
73114
|
+
{ },
|
|
73115
|
+
null,
|
|
73116
|
+
['PureCloud OAuth'],
|
|
73117
|
+
['application/json'],
|
|
73118
|
+
['application/json']
|
|
73119
|
+
);
|
|
73120
|
+
}
|
|
73121
|
+
|
|
73122
|
+
/**
|
|
73123
|
+
* Create an activity plan
|
|
73124
|
+
*
|
|
73125
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73126
|
+
* @param {Object} body body
|
|
73127
|
+
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73128
|
+
*/
|
|
73129
|
+
postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
|
|
73130
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73131
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73132
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';
|
|
73133
|
+
}
|
|
73134
|
+
// verify the required parameter 'body' is set
|
|
73135
|
+
if (body === undefined || body === null) {
|
|
73136
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivityplans';
|
|
73137
|
+
}
|
|
73138
|
+
|
|
73139
|
+
return this.apiClient.callApi(
|
|
73140
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
|
|
73141
|
+
'POST',
|
|
73142
|
+
{ 'businessUnitId': businessUnitId },
|
|
73143
|
+
{ },
|
|
73144
|
+
{ },
|
|
73145
|
+
{ },
|
|
73146
|
+
body,
|
|
73147
|
+
['PureCloud OAuth'],
|
|
73148
|
+
['application/json'],
|
|
73149
|
+
['application/json']
|
|
73150
|
+
);
|
|
73151
|
+
}
|
|
73152
|
+
|
|
72864
73153
|
/**
|
|
72865
73154
|
* Query adherence explanations across an entire business unit for the requested period
|
|
72866
73155
|
*
|
|
@@ -75005,7 +75294,7 @@ class WorkforceManagementApi {
|
|
|
75005
75294
|
* </pre>
|
|
75006
75295
|
* </p>
|
|
75007
75296
|
* @module purecloud-platform-client-v2/index
|
|
75008
|
-
* @version
|
|
75297
|
+
* @version 199.0.0
|
|
75009
75298
|
*/
|
|
75010
75299
|
class platformClient {
|
|
75011
75300
|
constructor() {
|