purecloud-platform-client-v2 212.1.0 → 213.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +150 -103
- package/dist/web-amd/purecloud-platform-client-v2.js +150 -103
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +130 -103
- package/dist/web-cjs/purecloud-platform-client-v2.js +168 -110
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +281 -229
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +3 -2
- 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 +35 -18
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +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 +7 -3
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +26 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -617,7 +617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
617
617
|
|
|
618
618
|
/**
|
|
619
619
|
* @module purecloud-platform-client-v2/ApiClient
|
|
620
|
-
* @version
|
|
620
|
+
* @version 213.1.0
|
|
621
621
|
*/
|
|
622
622
|
class ApiClient {
|
|
623
623
|
/**
|
|
@@ -2141,7 +2141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2141
2141
|
/**
|
|
2142
2142
|
* AgentAssistants service.
|
|
2143
2143
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2144
|
-
* @version
|
|
2144
|
+
* @version 213.1.0
|
|
2145
2145
|
*/
|
|
2146
2146
|
|
|
2147
2147
|
/**
|
|
@@ -2517,7 +2517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2517
2517
|
/**
|
|
2518
2518
|
* AgentCopilot service.
|
|
2519
2519
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2520
|
-
* @version
|
|
2520
|
+
* @version 213.1.0
|
|
2521
2521
|
*/
|
|
2522
2522
|
|
|
2523
2523
|
/**
|
|
@@ -2593,7 +2593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2593
2593
|
/**
|
|
2594
2594
|
* AgentUI service.
|
|
2595
2595
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2596
|
-
* @version
|
|
2596
|
+
* @version 213.1.0
|
|
2597
2597
|
*/
|
|
2598
2598
|
|
|
2599
2599
|
/**
|
|
@@ -2724,7 +2724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2724
2724
|
/**
|
|
2725
2725
|
* Alerting service.
|
|
2726
2726
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2727
|
-
* @version
|
|
2727
|
+
* @version 213.1.0
|
|
2728
2728
|
*/
|
|
2729
2729
|
|
|
2730
2730
|
/**
|
|
@@ -3385,7 +3385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3385
3385
|
/**
|
|
3386
3386
|
* Analytics service.
|
|
3387
3387
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3388
|
-
* @version
|
|
3388
|
+
* @version 213.1.0
|
|
3389
3389
|
*/
|
|
3390
3390
|
|
|
3391
3391
|
/**
|
|
@@ -4354,6 +4354,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4354
4354
|
* @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
|
|
4355
4355
|
* @param {Object} opts Optional parameters
|
|
4356
4356
|
* @param {String} opts.name name of the dashboard
|
|
4357
|
+
* @param {Object} opts.dashboardState List dashboard of given state (default to Active)
|
|
4357
4358
|
* @param {String} opts.sortBy (default to desc)
|
|
4358
4359
|
* @param {Number} opts.pageNumber (default to 1)
|
|
4359
4360
|
* @param {Number} opts.pageSize (default to 9)
|
|
@@ -4374,7 +4375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4374
4375
|
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
4375
4376
|
'GET',
|
|
4376
4377
|
{ },
|
|
4377
|
-
{ 'name': opts['name'],'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
4378
|
+
{ 'name': opts['name'],'dashboardType': dashboardType,'dashboardState': opts['dashboardState'],'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
4378
4379
|
{ },
|
|
4379
4380
|
{ },
|
|
4380
4381
|
null,
|
|
@@ -6209,7 +6210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6209
6210
|
/**
|
|
6210
6211
|
* Architect service.
|
|
6211
6212
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6212
|
-
* @version
|
|
6213
|
+
* @version 213.1.0
|
|
6213
6214
|
*/
|
|
6214
6215
|
|
|
6215
6216
|
/**
|
|
@@ -10331,7 +10332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10331
10332
|
/**
|
|
10332
10333
|
* Audit service.
|
|
10333
10334
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10334
|
-
* @version
|
|
10335
|
+
* @version 213.1.0
|
|
10335
10336
|
*/
|
|
10336
10337
|
|
|
10337
10338
|
/**
|
|
@@ -10532,7 +10533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10532
10533
|
/**
|
|
10533
10534
|
* Authorization service.
|
|
10534
10535
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10535
|
-
* @version
|
|
10536
|
+
* @version 213.1.0
|
|
10536
10537
|
*/
|
|
10537
10538
|
|
|
10538
10539
|
/**
|
|
@@ -11815,7 +11816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11815
11816
|
/**
|
|
11816
11817
|
* Billing service.
|
|
11817
11818
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11818
|
-
* @version
|
|
11819
|
+
* @version 213.1.0
|
|
11819
11820
|
*/
|
|
11820
11821
|
|
|
11821
11822
|
/**
|
|
@@ -11895,7 +11896,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11895
11896
|
/**
|
|
11896
11897
|
* CarrierServices service.
|
|
11897
11898
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11898
|
-
* @version
|
|
11899
|
+
* @version 213.1.0
|
|
11899
11900
|
*/
|
|
11900
11901
|
|
|
11901
11902
|
/**
|
|
@@ -11965,7 +11966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11965
11966
|
/**
|
|
11966
11967
|
* Chat service.
|
|
11967
11968
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11968
|
-
* @version
|
|
11969
|
+
* @version 213.1.0
|
|
11969
11970
|
*/
|
|
11970
11971
|
|
|
11971
11972
|
/**
|
|
@@ -12901,7 +12902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12901
12902
|
/**
|
|
12902
12903
|
* Coaching service.
|
|
12903
12904
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12904
|
-
* @version
|
|
12905
|
+
* @version 213.1.0
|
|
12905
12906
|
*/
|
|
12906
12907
|
|
|
12907
12908
|
/**
|
|
@@ -13478,7 +13479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13478
13479
|
/**
|
|
13479
13480
|
* ContentManagement service.
|
|
13480
13481
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13481
|
-
* @version
|
|
13482
|
+
* @version 213.1.0
|
|
13482
13483
|
*/
|
|
13483
13484
|
|
|
13484
13485
|
/**
|
|
@@ -14559,7 +14560,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14559
14560
|
/**
|
|
14560
14561
|
* Conversations service.
|
|
14561
14562
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14562
|
-
* @version
|
|
14563
|
+
* @version 213.1.0
|
|
14563
14564
|
*/
|
|
14564
14565
|
|
|
14565
14566
|
/**
|
|
@@ -15735,8 +15736,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15735
15736
|
|
|
15736
15737
|
/**
|
|
15737
15738
|
* Get chat conversation
|
|
15738
|
-
*
|
|
15739
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15739
15740
|
* @param {String} conversationId conversationId
|
|
15741
|
+
* @deprecated
|
|
15740
15742
|
*/
|
|
15741
15743
|
getConversationsChat(conversationId) {
|
|
15742
15744
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15760,9 +15762,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15760
15762
|
|
|
15761
15763
|
/**
|
|
15762
15764
|
* Get a web chat conversation message
|
|
15763
|
-
* The current user must be involved with the conversation to get its messages.
|
|
15765
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
15764
15766
|
* @param {String} conversationId conversationId
|
|
15765
15767
|
* @param {String} messageId messageId
|
|
15768
|
+
* @deprecated
|
|
15766
15769
|
*/
|
|
15767
15770
|
getConversationsChatMessage(conversationId, messageId) {
|
|
15768
15771
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15790,13 +15793,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15790
15793
|
|
|
15791
15794
|
/**
|
|
15792
15795
|
* Get the messages of a chat conversation.
|
|
15793
|
-
* The current user must be involved with the conversation to get its messages.
|
|
15796
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
15794
15797
|
* @param {String} conversationId conversationId
|
|
15795
15798
|
* @param {Object} opts Optional parameters
|
|
15796
15799
|
* @param {String} opts.after If specified, get the messages chronologically after the id of this message
|
|
15797
15800
|
* @param {String} opts.before If specified, get the messages chronologically before the id of this message
|
|
15798
15801
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
15799
15802
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
15803
|
+
* @deprecated
|
|
15800
15804
|
*/
|
|
15801
15805
|
getConversationsChatMessages(conversationId, opts) {
|
|
15802
15806
|
opts = opts || {};
|
|
@@ -15822,12 +15826,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15822
15826
|
|
|
15823
15827
|
/**
|
|
15824
15828
|
* Get the wrap-up for this conversation communication.
|
|
15825
|
-
*
|
|
15829
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15826
15830
|
* @param {String} conversationId conversationId
|
|
15827
15831
|
* @param {String} participantId participantId
|
|
15828
15832
|
* @param {String} communicationId communicationId
|
|
15829
15833
|
* @param {Object} opts Optional parameters
|
|
15830
15834
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
15835
|
+
* @deprecated
|
|
15831
15836
|
*/
|
|
15832
15837
|
getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
15833
15838
|
opts = opts || {};
|
|
@@ -15861,11 +15866,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15861
15866
|
|
|
15862
15867
|
/**
|
|
15863
15868
|
* Get the wrap-up for this conversation participant.
|
|
15864
|
-
*
|
|
15869
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15865
15870
|
* @param {String} conversationId conversationId
|
|
15866
15871
|
* @param {String} participantId participantId
|
|
15867
15872
|
* @param {Object} opts Optional parameters
|
|
15868
15873
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
15874
|
+
* @deprecated
|
|
15869
15875
|
*/
|
|
15870
15876
|
getConversationsChatParticipantWrapup(conversationId, participantId, opts) {
|
|
15871
15877
|
opts = opts || {};
|
|
@@ -15895,9 +15901,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15895
15901
|
|
|
15896
15902
|
/**
|
|
15897
15903
|
* Get list of wrapup codes for this conversation participant
|
|
15898
|
-
*
|
|
15904
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15899
15905
|
* @param {String} conversationId conversationId
|
|
15900
15906
|
* @param {String} participantId participantId
|
|
15907
|
+
* @deprecated
|
|
15901
15908
|
*/
|
|
15902
15909
|
getConversationsChatParticipantWrapupcodes(conversationId, participantId) {
|
|
15903
15910
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15925,7 +15932,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15925
15932
|
|
|
15926
15933
|
/**
|
|
15927
15934
|
* Get active chat conversations for the logged in user
|
|
15928
|
-
*
|
|
15935
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
15936
|
+
* @deprecated
|
|
15929
15937
|
*/
|
|
15930
15938
|
getConversationsChats() {
|
|
15931
15939
|
|
|
@@ -17847,9 +17855,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17847
17855
|
|
|
17848
17856
|
/**
|
|
17849
17857
|
* Update a conversation by disconnecting all of the participants
|
|
17850
|
-
*
|
|
17858
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17851
17859
|
* @param {String} conversationId conversationId
|
|
17852
17860
|
* @param {Object} body Conversation
|
|
17861
|
+
* @deprecated
|
|
17853
17862
|
*/
|
|
17854
17863
|
patchConversationsChat(conversationId, body) {
|
|
17855
17864
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17877,10 +17886,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17877
17886
|
|
|
17878
17887
|
/**
|
|
17879
17888
|
* Update conversation participant
|
|
17880
|
-
*
|
|
17889
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17881
17890
|
* @param {String} conversationId conversationId
|
|
17882
17891
|
* @param {String} participantId participantId
|
|
17883
17892
|
* @param {Object} body Update request
|
|
17893
|
+
* @deprecated
|
|
17884
17894
|
*/
|
|
17885
17895
|
patchConversationsChatParticipant(conversationId, participantId, body) {
|
|
17886
17896
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17912,10 +17922,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17912
17922
|
|
|
17913
17923
|
/**
|
|
17914
17924
|
* Update the attributes on a conversation participant.
|
|
17915
|
-
*
|
|
17925
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17916
17926
|
* @param {String} conversationId conversationId
|
|
17917
17927
|
* @param {String} participantId participantId
|
|
17918
17928
|
* @param {Object} body Participant attributes
|
|
17929
|
+
* @deprecated
|
|
17919
17930
|
*/
|
|
17920
17931
|
patchConversationsChatParticipantAttributes(conversationId, participantId, body) {
|
|
17921
17932
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17947,11 +17958,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17947
17958
|
|
|
17948
17959
|
/**
|
|
17949
17960
|
* Update conversation participant's communication by disconnecting it.
|
|
17950
|
-
*
|
|
17961
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17951
17962
|
* @param {String} conversationId conversationId
|
|
17952
17963
|
* @param {String} participantId participantId
|
|
17953
17964
|
* @param {String} communicationId communicationId
|
|
17954
17965
|
* @param {Object} body Participant
|
|
17966
|
+
* @deprecated
|
|
17955
17967
|
*/
|
|
17956
17968
|
patchConversationsChatParticipantCommunication(conversationId, participantId, communicationId, body) {
|
|
17957
17969
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19854,10 +19866,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19854
19866
|
|
|
19855
19867
|
/**
|
|
19856
19868
|
* Send a message on behalf of a communication in a chat conversation.
|
|
19857
|
-
*
|
|
19869
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19858
19870
|
* @param {String} conversationId conversationId
|
|
19859
19871
|
* @param {String} communicationId communicationId
|
|
19860
19872
|
* @param {Object} body Message
|
|
19873
|
+
* @deprecated
|
|
19861
19874
|
*/
|
|
19862
19875
|
postConversationsChatCommunicationMessages(conversationId, communicationId, body) {
|
|
19863
19876
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19889,9 +19902,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19889
19902
|
|
|
19890
19903
|
/**
|
|
19891
19904
|
* Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
19892
|
-
*
|
|
19905
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19893
19906
|
* @param {String} conversationId conversationId
|
|
19894
19907
|
* @param {String} communicationId communicationId
|
|
19908
|
+
* @deprecated
|
|
19895
19909
|
*/
|
|
19896
19910
|
postConversationsChatCommunicationTyping(conversationId, communicationId) {
|
|
19897
19911
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19919,12 +19933,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19919
19933
|
|
|
19920
19934
|
/**
|
|
19921
19935
|
* Apply wrap-up for this conversation communication
|
|
19922
|
-
*
|
|
19936
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19923
19937
|
* @param {String} conversationId conversationId
|
|
19924
19938
|
* @param {String} participantId participantId
|
|
19925
19939
|
* @param {String} communicationId communicationId
|
|
19926
19940
|
* @param {Object} opts Optional parameters
|
|
19927
19941
|
* @param {Object} opts.body Wrap-up
|
|
19942
|
+
* @deprecated
|
|
19928
19943
|
*/
|
|
19929
19944
|
postConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
19930
19945
|
opts = opts || {};
|
|
@@ -19958,10 +19973,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19958
19973
|
|
|
19959
19974
|
/**
|
|
19960
19975
|
* Replace this participant with the specified user and/or address
|
|
19961
|
-
*
|
|
19976
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19962
19977
|
* @param {String} conversationId conversationId
|
|
19963
19978
|
* @param {String} participantId participantId
|
|
19964
19979
|
* @param {Object} body Transfer request
|
|
19980
|
+
* @deprecated
|
|
19965
19981
|
*/
|
|
19966
19982
|
postConversationsChatParticipantReplace(conversationId, participantId, body) {
|
|
19967
19983
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19993,8 +20009,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19993
20009
|
|
|
19994
20010
|
/**
|
|
19995
20011
|
* Create a web chat conversation
|
|
19996
|
-
*
|
|
20012
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19997
20013
|
* @param {Object} body Create web chat request
|
|
20014
|
+
* @deprecated
|
|
19998
20015
|
*/
|
|
19999
20016
|
postConversationsChats(body) {
|
|
20000
20017
|
// verify the required parameter 'body' is set
|
|
@@ -21354,9 +21371,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21354
21371
|
|
|
21355
21372
|
/**
|
|
21356
21373
|
* Update a conversation by setting its recording state
|
|
21357
|
-
*
|
|
21374
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
21358
21375
|
* @param {String} conversationId conversationId
|
|
21359
21376
|
* @param {Object} body SetRecordingState
|
|
21377
|
+
* @deprecated
|
|
21360
21378
|
*/
|
|
21361
21379
|
putConversationsChatRecordingstate(conversationId, body) {
|
|
21362
21380
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21704,7 +21722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21704
21722
|
/**
|
|
21705
21723
|
* DataExtensions service.
|
|
21706
21724
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21707
|
-
* @version
|
|
21725
|
+
* @version 213.1.0
|
|
21708
21726
|
*/
|
|
21709
21727
|
|
|
21710
21728
|
/**
|
|
@@ -21790,7 +21808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21790
21808
|
/**
|
|
21791
21809
|
* DataPrivacy service.
|
|
21792
21810
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21793
|
-
* @version
|
|
21811
|
+
* @version 213.1.0
|
|
21794
21812
|
*/
|
|
21795
21813
|
|
|
21796
21814
|
/**
|
|
@@ -21960,7 +21978,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21960
21978
|
/**
|
|
21961
21979
|
* Downloads service.
|
|
21962
21980
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21963
|
-
* @version
|
|
21981
|
+
* @version 213.1.0
|
|
21964
21982
|
*/
|
|
21965
21983
|
|
|
21966
21984
|
/**
|
|
@@ -22012,7 +22030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22012
22030
|
/**
|
|
22013
22031
|
* Emails service.
|
|
22014
22032
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22015
|
-
* @version
|
|
22033
|
+
* @version 213.1.0
|
|
22016
22034
|
*/
|
|
22017
22035
|
|
|
22018
22036
|
/**
|
|
@@ -22077,7 +22095,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22077
22095
|
/**
|
|
22078
22096
|
* EmployeeEngagement service.
|
|
22079
22097
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22080
|
-
* @version
|
|
22098
|
+
* @version 213.1.0
|
|
22081
22099
|
*/
|
|
22082
22100
|
|
|
22083
22101
|
/**
|
|
@@ -22228,7 +22246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22228
22246
|
/**
|
|
22229
22247
|
* Events service.
|
|
22230
22248
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22231
|
-
* @version
|
|
22249
|
+
* @version 213.1.0
|
|
22232
22250
|
*/
|
|
22233
22251
|
|
|
22234
22252
|
/**
|
|
@@ -22324,7 +22342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22324
22342
|
/**
|
|
22325
22343
|
* ExternalContacts service.
|
|
22326
22344
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22327
|
-
* @version
|
|
22345
|
+
* @version 213.1.0
|
|
22328
22346
|
*/
|
|
22329
22347
|
|
|
22330
22348
|
/**
|
|
@@ -24889,7 +24907,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24889
24907
|
/**
|
|
24890
24908
|
* Fax service.
|
|
24891
24909
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24892
|
-
* @version
|
|
24910
|
+
* @version 213.1.0
|
|
24893
24911
|
*/
|
|
24894
24912
|
|
|
24895
24913
|
/**
|
|
@@ -25104,7 +25122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25104
25122
|
/**
|
|
25105
25123
|
* Flows service.
|
|
25106
25124
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25107
|
-
* @version
|
|
25125
|
+
* @version 213.1.0
|
|
25108
25126
|
*/
|
|
25109
25127
|
|
|
25110
25128
|
/**
|
|
@@ -25287,7 +25305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25287
25305
|
/**
|
|
25288
25306
|
* Gamification service.
|
|
25289
25307
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25290
|
-
* @version
|
|
25308
|
+
* @version 213.1.0
|
|
25291
25309
|
*/
|
|
25292
25310
|
|
|
25293
25311
|
/**
|
|
@@ -27429,7 +27447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27429
27447
|
/**
|
|
27430
27448
|
* GeneralDataProtectionRegulation service.
|
|
27431
27449
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27432
|
-
* @version
|
|
27450
|
+
* @version 213.1.0
|
|
27433
27451
|
*/
|
|
27434
27452
|
|
|
27435
27453
|
/**
|
|
@@ -27559,7 +27577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27559
27577
|
/**
|
|
27560
27578
|
* Geolocation service.
|
|
27561
27579
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27562
|
-
* @version
|
|
27580
|
+
* @version 213.1.0
|
|
27563
27581
|
*/
|
|
27564
27582
|
|
|
27565
27583
|
/**
|
|
@@ -27690,7 +27708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27690
27708
|
/**
|
|
27691
27709
|
* Greetings service.
|
|
27692
27710
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27693
|
-
* @version
|
|
27711
|
+
* @version 213.1.0
|
|
27694
27712
|
*/
|
|
27695
27713
|
|
|
27696
27714
|
/**
|
|
@@ -28145,7 +28163,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28145
28163
|
/**
|
|
28146
28164
|
* Groups service.
|
|
28147
28165
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28148
|
-
* @version
|
|
28166
|
+
* @version 213.1.0
|
|
28149
28167
|
*/
|
|
28150
28168
|
|
|
28151
28169
|
/**
|
|
@@ -28215,7 +28233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28215
28233
|
* Remove members
|
|
28216
28234
|
*
|
|
28217
28235
|
* @param {String} groupId Group ID
|
|
28218
|
-
* @param {String} ids Comma separated list of userIds to remove
|
|
28236
|
+
* @param {String} ids Comma separated list of userIds to remove. A maximum of 50 members are allowed per request.
|
|
28219
28237
|
*/
|
|
28220
28238
|
deleteGroupMembers(groupId, ids) {
|
|
28221
28239
|
// verify the required parameter 'groupId' is set
|
|
@@ -28664,7 +28682,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28664
28682
|
/**
|
|
28665
28683
|
* IdentityProvider service.
|
|
28666
28684
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28667
|
-
* @version
|
|
28685
|
+
* @version 213.1.0
|
|
28668
28686
|
*/
|
|
28669
28687
|
|
|
28670
28688
|
/**
|
|
@@ -29525,7 +29543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29525
29543
|
/**
|
|
29526
29544
|
* InfrastructureAsCode service.
|
|
29527
29545
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
29528
|
-
* @version
|
|
29546
|
+
* @version 213.1.0
|
|
29529
29547
|
*/
|
|
29530
29548
|
|
|
29531
29549
|
/**
|
|
@@ -29692,7 +29710,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29692
29710
|
/**
|
|
29693
29711
|
* Integrations service.
|
|
29694
29712
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29695
|
-
* @version
|
|
29713
|
+
* @version 213.1.0
|
|
29696
29714
|
*/
|
|
29697
29715
|
|
|
29698
29716
|
/**
|
|
@@ -32134,7 +32152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32134
32152
|
/**
|
|
32135
32153
|
* Journey service.
|
|
32136
32154
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
32137
|
-
* @version
|
|
32155
|
+
* @version 213.1.0
|
|
32138
32156
|
*/
|
|
32139
32157
|
|
|
32140
32158
|
/**
|
|
@@ -34099,7 +34117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34099
34117
|
/**
|
|
34100
34118
|
* Knowledge service.
|
|
34101
34119
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
34102
|
-
* @version
|
|
34120
|
+
* @version 213.1.0
|
|
34103
34121
|
*/
|
|
34104
34122
|
|
|
34105
34123
|
/**
|
|
@@ -37975,7 +37993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37975
37993
|
/**
|
|
37976
37994
|
* LanguageUnderstanding service.
|
|
37977
37995
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
37978
|
-
* @version
|
|
37996
|
+
* @version 213.1.0
|
|
37979
37997
|
*/
|
|
37980
37998
|
|
|
37981
37999
|
/**
|
|
@@ -39008,7 +39026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39008
39026
|
/**
|
|
39009
39027
|
* Languages service.
|
|
39010
39028
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39011
|
-
* @version
|
|
39029
|
+
* @version 213.1.0
|
|
39012
39030
|
*/
|
|
39013
39031
|
|
|
39014
39032
|
/**
|
|
@@ -39230,7 +39248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39230
39248
|
/**
|
|
39231
39249
|
* Learning service.
|
|
39232
39250
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39233
|
-
* @version
|
|
39251
|
+
* @version 213.1.0
|
|
39234
39252
|
*/
|
|
39235
39253
|
|
|
39236
39254
|
/**
|
|
@@ -40259,7 +40277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40259
40277
|
/**
|
|
40260
40278
|
* License service.
|
|
40261
40279
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40262
|
-
* @version
|
|
40280
|
+
* @version 213.1.0
|
|
40263
40281
|
*/
|
|
40264
40282
|
|
|
40265
40283
|
/**
|
|
@@ -40497,7 +40515,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40497
40515
|
/**
|
|
40498
40516
|
* Locations service.
|
|
40499
40517
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
40500
|
-
* @version
|
|
40518
|
+
* @version 213.1.0
|
|
40501
40519
|
*/
|
|
40502
40520
|
|
|
40503
40521
|
/**
|
|
@@ -40733,7 +40751,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40733
40751
|
/**
|
|
40734
40752
|
* LogCapture service.
|
|
40735
40753
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
40736
|
-
* @version
|
|
40754
|
+
* @version 213.1.0
|
|
40737
40755
|
*/
|
|
40738
40756
|
|
|
40739
40757
|
/**
|
|
@@ -40933,7 +40951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40933
40951
|
/**
|
|
40934
40952
|
* Messaging service.
|
|
40935
40953
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40936
|
-
* @version
|
|
40954
|
+
* @version 213.1.0
|
|
40937
40955
|
*/
|
|
40938
40956
|
|
|
40939
40957
|
/**
|
|
@@ -41292,7 +41310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41292
41310
|
/**
|
|
41293
41311
|
* MobileDevices service.
|
|
41294
41312
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41295
|
-
* @version
|
|
41313
|
+
* @version 213.1.0
|
|
41296
41314
|
*/
|
|
41297
41315
|
|
|
41298
41316
|
/**
|
|
@@ -41443,7 +41461,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41443
41461
|
/**
|
|
41444
41462
|
* Notifications service.
|
|
41445
41463
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41446
|
-
* @version
|
|
41464
|
+
* @version 213.1.0
|
|
41447
41465
|
*/
|
|
41448
41466
|
|
|
41449
41467
|
/**
|
|
@@ -41676,7 +41694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41676
41694
|
/**
|
|
41677
41695
|
* OAuth service.
|
|
41678
41696
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
41679
|
-
* @version
|
|
41697
|
+
* @version 213.1.0
|
|
41680
41698
|
*/
|
|
41681
41699
|
|
|
41682
41700
|
/**
|
|
@@ -42042,7 +42060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42042
42060
|
/**
|
|
42043
42061
|
* Objects service.
|
|
42044
42062
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
42045
|
-
* @version
|
|
42063
|
+
* @version 213.1.0
|
|
42046
42064
|
*/
|
|
42047
42065
|
|
|
42048
42066
|
/**
|
|
@@ -42312,7 +42330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42312
42330
|
/**
|
|
42313
42331
|
* OperationalEvents service.
|
|
42314
42332
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
42315
|
-
* @version
|
|
42333
|
+
* @version 213.1.0
|
|
42316
42334
|
*/
|
|
42317
42335
|
|
|
42318
42336
|
/**
|
|
@@ -42429,7 +42447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42429
42447
|
/**
|
|
42430
42448
|
* Organization service.
|
|
42431
42449
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42432
|
-
* @version
|
|
42450
|
+
* @version 213.1.0
|
|
42433
42451
|
*/
|
|
42434
42452
|
|
|
42435
42453
|
/**
|
|
@@ -42971,7 +42989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42971
42989
|
/**
|
|
42972
42990
|
* OrganizationAuthorization service.
|
|
42973
42991
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42974
|
-
* @version
|
|
42992
|
+
* @version 213.1.0
|
|
42975
42993
|
*/
|
|
42976
42994
|
|
|
42977
42995
|
/**
|
|
@@ -44365,7 +44383,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44365
44383
|
/**
|
|
44366
44384
|
* Outbound service.
|
|
44367
44385
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44368
|
-
* @version
|
|
44386
|
+
* @version 213.1.0
|
|
44369
44387
|
*/
|
|
44370
44388
|
|
|
44371
44389
|
/**
|
|
@@ -46662,6 +46680,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46662
46680
|
* @param {Object} opts.type Campaign Type
|
|
46663
46681
|
* @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
|
|
46664
46682
|
* @param {Array.<String>} opts.id A list of messaging campaign ids to bulk fetch
|
|
46683
|
+
* @param {String} opts.contentTemplateId Content template ID
|
|
46684
|
+
* @param {Object} opts.campaignStatus Campaign Status
|
|
46665
46685
|
*/
|
|
46666
46686
|
getOutboundMessagingcampaigns(opts) {
|
|
46667
46687
|
opts = opts || {};
|
|
@@ -46671,7 +46691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46671
46691
|
'/api/v2/outbound/messagingcampaigns',
|
|
46672
46692
|
'GET',
|
|
46673
46693
|
{ },
|
|
46674
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'contactListId': opts['contactListId'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'type': opts['type'],'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
46694
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'contactListId': opts['contactListId'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'type': opts['type'],'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'contentTemplateId': opts['contentTemplateId'],'campaignStatus': opts['campaignStatus'] },
|
|
46675
46695
|
{ },
|
|
46676
46696
|
{ },
|
|
46677
46697
|
null,
|
|
@@ -46717,6 +46737,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46717
46737
|
* @param {Object} opts.type Campaign Type
|
|
46718
46738
|
* @param {Array.<String>} opts.id id
|
|
46719
46739
|
* @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
|
|
46740
|
+
* @param {String} opts.contentTemplateId Content template ID
|
|
46741
|
+
* @param {Object} opts.campaignStatus Campaign Status
|
|
46720
46742
|
*/
|
|
46721
46743
|
getOutboundMessagingcampaignsDivisionviews(opts) {
|
|
46722
46744
|
opts = opts || {};
|
|
@@ -46726,7 +46748,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46726
46748
|
'/api/v2/outbound/messagingcampaigns/divisionviews',
|
|
46727
46749
|
'GET',
|
|
46728
46750
|
{ },
|
|
46729
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'],'type': opts['type'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'] },
|
|
46751
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'],'type': opts['type'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'contentTemplateId': opts['contentTemplateId'],'campaignStatus': opts['campaignStatus'] },
|
|
46730
46752
|
{ },
|
|
46731
46753
|
{ },
|
|
46732
46754
|
null,
|
|
@@ -48912,7 +48934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48912
48934
|
/**
|
|
48913
48935
|
* Presence service.
|
|
48914
48936
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
48915
|
-
* @version
|
|
48937
|
+
* @version 213.1.0
|
|
48916
48938
|
*/
|
|
48917
48939
|
|
|
48918
48940
|
/**
|
|
@@ -49656,7 +49678,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49656
49678
|
/**
|
|
49657
49679
|
* ProcessAutomation service.
|
|
49658
49680
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
49659
|
-
* @version
|
|
49681
|
+
* @version 213.1.0
|
|
49660
49682
|
*/
|
|
49661
49683
|
|
|
49662
49684
|
/**
|
|
@@ -49895,7 +49917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49895
49917
|
/**
|
|
49896
49918
|
* Quality service.
|
|
49897
49919
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
49898
|
-
* @version
|
|
49920
|
+
* @version 213.1.0
|
|
49899
49921
|
*/
|
|
49900
49922
|
|
|
49901
49923
|
/**
|
|
@@ -51683,7 +51705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51683
51705
|
/**
|
|
51684
51706
|
* Recording service.
|
|
51685
51707
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
51686
|
-
* @version
|
|
51708
|
+
* @version 213.1.0
|
|
51687
51709
|
*/
|
|
51688
51710
|
|
|
51689
51711
|
/**
|
|
@@ -53342,7 +53364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53342
53364
|
/**
|
|
53343
53365
|
* ResponseManagement service.
|
|
53344
53366
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
53345
|
-
* @version
|
|
53367
|
+
* @version 213.1.0
|
|
53346
53368
|
*/
|
|
53347
53369
|
|
|
53348
53370
|
/**
|
|
@@ -53852,7 +53874,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53852
53874
|
/**
|
|
53853
53875
|
* Routing service.
|
|
53854
53876
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
53855
|
-
* @version
|
|
53877
|
+
* @version 213.1.0
|
|
53856
53878
|
*/
|
|
53857
53879
|
|
|
53858
53880
|
/**
|
|
@@ -58004,7 +58026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58004
58026
|
/**
|
|
58005
58027
|
* SCIM service.
|
|
58006
58028
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
58007
|
-
* @version
|
|
58029
|
+
* @version 213.1.0
|
|
58008
58030
|
*/
|
|
58009
58031
|
|
|
58010
58032
|
/**
|
|
@@ -58881,7 +58903,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58881
58903
|
/**
|
|
58882
58904
|
* ScreenRecording service.
|
|
58883
58905
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
58884
|
-
* @version
|
|
58906
|
+
* @version 213.1.0
|
|
58885
58907
|
*/
|
|
58886
58908
|
|
|
58887
58909
|
/**
|
|
@@ -58926,7 +58948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58926
58948
|
/**
|
|
58927
58949
|
* Scripts service.
|
|
58928
58950
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
58929
|
-
* @version
|
|
58951
|
+
* @version 213.1.0
|
|
58930
58952
|
*/
|
|
58931
58953
|
|
|
58932
58954
|
/**
|
|
@@ -59370,7 +59392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59370
59392
|
/**
|
|
59371
59393
|
* Search service.
|
|
59372
59394
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
59373
|
-
* @version
|
|
59395
|
+
* @version 213.1.0
|
|
59374
59396
|
*/
|
|
59375
59397
|
|
|
59376
59398
|
/**
|
|
@@ -60113,7 +60135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60113
60135
|
/**
|
|
60114
60136
|
* Settings service.
|
|
60115
60137
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
60116
|
-
* @version
|
|
60138
|
+
* @version 213.1.0
|
|
60117
60139
|
*/
|
|
60118
60140
|
|
|
60119
60141
|
/**
|
|
@@ -60333,7 +60355,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60333
60355
|
/**
|
|
60334
60356
|
* SocialMedia service.
|
|
60335
60357
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
60336
|
-
* @version
|
|
60358
|
+
* @version 213.1.0
|
|
60337
60359
|
*/
|
|
60338
60360
|
|
|
60339
60361
|
/**
|
|
@@ -61238,7 +61260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61238
61260
|
/**
|
|
61239
61261
|
* SpeechTextAnalytics service.
|
|
61240
61262
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
61241
|
-
* @version
|
|
61263
|
+
* @version 213.1.0
|
|
61242
61264
|
*/
|
|
61243
61265
|
|
|
61244
61266
|
/**
|
|
@@ -62573,7 +62595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62573
62595
|
/**
|
|
62574
62596
|
* Stations service.
|
|
62575
62597
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
62576
|
-
* @version
|
|
62598
|
+
* @version 213.1.0
|
|
62577
62599
|
*/
|
|
62578
62600
|
|
|
62579
62601
|
/**
|
|
@@ -62675,7 +62697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62675
62697
|
/**
|
|
62676
62698
|
* Suggest service.
|
|
62677
62699
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
62678
|
-
* @version
|
|
62700
|
+
* @version 213.1.0
|
|
62679
62701
|
*/
|
|
62680
62702
|
|
|
62681
62703
|
/**
|
|
@@ -62814,7 +62836,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62814
62836
|
/**
|
|
62815
62837
|
* TaskManagement service.
|
|
62816
62838
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
62817
|
-
* @version
|
|
62839
|
+
* @version 213.1.0
|
|
62818
62840
|
*/
|
|
62819
62841
|
|
|
62820
62842
|
/**
|
|
@@ -64920,7 +64942,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64920
64942
|
/**
|
|
64921
64943
|
* Teams service.
|
|
64922
64944
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
64923
|
-
* @version
|
|
64945
|
+
* @version 213.1.0
|
|
64924
64946
|
*/
|
|
64925
64947
|
|
|
64926
64948
|
/**
|
|
@@ -65225,7 +65247,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65225
65247
|
/**
|
|
65226
65248
|
* Telephony service.
|
|
65227
65249
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
65228
|
-
* @version
|
|
65250
|
+
* @version 213.1.0
|
|
65229
65251
|
*/
|
|
65230
65252
|
|
|
65231
65253
|
/**
|
|
@@ -65407,7 +65429,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65407
65429
|
/**
|
|
65408
65430
|
* TelephonyProvidersEdge service.
|
|
65409
65431
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
65410
|
-
* @version
|
|
65432
|
+
* @version 213.1.0
|
|
65411
65433
|
*/
|
|
65412
65434
|
|
|
65413
65435
|
/**
|
|
@@ -68858,7 +68880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68858
68880
|
/**
|
|
68859
68881
|
* Textbots service.
|
|
68860
68882
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
68861
|
-
* @version
|
|
68883
|
+
* @version 213.1.0
|
|
68862
68884
|
*/
|
|
68863
68885
|
|
|
68864
68886
|
/**
|
|
@@ -68986,7 +69008,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68986
69008
|
/**
|
|
68987
69009
|
* Tokens service.
|
|
68988
69010
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
68989
|
-
* @version
|
|
69011
|
+
* @version 213.1.0
|
|
68990
69012
|
*/
|
|
68991
69013
|
|
|
68992
69014
|
/**
|
|
@@ -69140,7 +69162,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69140
69162
|
/**
|
|
69141
69163
|
* Uploads service.
|
|
69142
69164
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
69143
|
-
* @version
|
|
69165
|
+
* @version 213.1.0
|
|
69144
69166
|
*/
|
|
69145
69167
|
|
|
69146
69168
|
/**
|
|
@@ -69409,7 +69431,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69409
69431
|
/**
|
|
69410
69432
|
* Usage service.
|
|
69411
69433
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
69412
|
-
* @version
|
|
69434
|
+
* @version 213.1.0
|
|
69413
69435
|
*/
|
|
69414
69436
|
|
|
69415
69437
|
/**
|
|
@@ -69624,7 +69646,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69624
69646
|
/**
|
|
69625
69647
|
* UserRecordings service.
|
|
69626
69648
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
69627
|
-
* @version
|
|
69649
|
+
* @version 213.1.0
|
|
69628
69650
|
*/
|
|
69629
69651
|
|
|
69630
69652
|
/**
|
|
@@ -69839,7 +69861,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69839
69861
|
/**
|
|
69840
69862
|
* Users service.
|
|
69841
69863
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
69842
|
-
* @version
|
|
69864
|
+
* @version 213.1.0
|
|
69843
69865
|
*/
|
|
69844
69866
|
|
|
69845
69867
|
/**
|
|
@@ -72668,7 +72690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72668
72690
|
/**
|
|
72669
72691
|
* Utilities service.
|
|
72670
72692
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
72671
|
-
* @version
|
|
72693
|
+
* @version 213.1.0
|
|
72672
72694
|
*/
|
|
72673
72695
|
|
|
72674
72696
|
/**
|
|
@@ -72779,7 +72801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72779
72801
|
/**
|
|
72780
72802
|
* Voicemail service.
|
|
72781
72803
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
72782
|
-
* @version
|
|
72804
|
+
* @version 213.1.0
|
|
72783
72805
|
*/
|
|
72784
72806
|
|
|
72785
72807
|
/**
|
|
@@ -73501,7 +73523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73501
73523
|
/**
|
|
73502
73524
|
* WebChat service.
|
|
73503
73525
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
73504
|
-
* @version
|
|
73526
|
+
* @version 213.1.0
|
|
73505
73527
|
*/
|
|
73506
73528
|
|
|
73507
73529
|
/**
|
|
@@ -74052,7 +74074,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74052
74074
|
/**
|
|
74053
74075
|
* WebDeployments service.
|
|
74054
74076
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
74055
|
-
* @version
|
|
74077
|
+
* @version 213.1.0
|
|
74056
74078
|
*/
|
|
74057
74079
|
|
|
74058
74080
|
/**
|
|
@@ -74579,7 +74601,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74579
74601
|
/**
|
|
74580
74602
|
* WebMessaging service.
|
|
74581
74603
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
74582
|
-
* @version
|
|
74604
|
+
* @version 213.1.0
|
|
74583
74605
|
*/
|
|
74584
74606
|
|
|
74585
74607
|
/**
|
|
@@ -74625,7 +74647,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74625
74647
|
/**
|
|
74626
74648
|
* Widgets service.
|
|
74627
74649
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
74628
|
-
* @version
|
|
74650
|
+
* @version 213.1.0
|
|
74629
74651
|
*/
|
|
74630
74652
|
|
|
74631
74653
|
/**
|
|
@@ -74771,7 +74793,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74771
74793
|
/**
|
|
74772
74794
|
* WorkforceManagement service.
|
|
74773
74795
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
74774
|
-
* @version
|
|
74796
|
+
* @version 213.1.0
|
|
74775
74797
|
*/
|
|
74776
74798
|
|
|
74777
74799
|
/**
|
|
@@ -77335,6 +77357,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77335
77357
|
);
|
|
77336
77358
|
}
|
|
77337
77359
|
|
|
77360
|
+
/**
|
|
77361
|
+
* Retrieves status of the historical data imports associated with job id
|
|
77362
|
+
*
|
|
77363
|
+
* @param {String} jobId The job Id of the historical data import request
|
|
77364
|
+
*/
|
|
77365
|
+
getWorkforcemanagementHistoricaldataImportstatusJobId(jobId) {
|
|
77366
|
+
// verify the required parameter 'jobId' is set
|
|
77367
|
+
if (jobId === undefined || jobId === null) {
|
|
77368
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementHistoricaldataImportstatusJobId';
|
|
77369
|
+
}
|
|
77370
|
+
|
|
77371
|
+
return this.apiClient.callApi(
|
|
77372
|
+
'/api/v2/workforcemanagement/historicaldata/importstatus/{jobId}',
|
|
77373
|
+
'GET',
|
|
77374
|
+
{ 'jobId': jobId },
|
|
77375
|
+
{ },
|
|
77376
|
+
{ },
|
|
77377
|
+
{ },
|
|
77378
|
+
null,
|
|
77379
|
+
['PureCloud OAuth'],
|
|
77380
|
+
['application/json'],
|
|
77381
|
+
['application/json']
|
|
77382
|
+
);
|
|
77383
|
+
}
|
|
77384
|
+
|
|
77338
77385
|
/**
|
|
77339
77386
|
* Get integrations
|
|
77340
77387
|
*
|
|
@@ -82070,7 +82117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82070
82117
|
* </pre>
|
|
82071
82118
|
* </p>
|
|
82072
82119
|
* @module purecloud-platform-client-v2/index
|
|
82073
|
-
* @version
|
|
82120
|
+
* @version 213.1.0
|
|
82074
82121
|
*/
|
|
82075
82122
|
class platformClient {
|
|
82076
82123
|
constructor() {
|