purecloud-platform-client-v2 217.0.0 → 218.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.
Files changed (91) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +805 -195
  3. package/dist/web-amd/purecloud-platform-client-v2.js +805 -195
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +275 -152
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +275 -152
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +606 -72
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -4
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +214 -1
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +77 -1
  32. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -6
  44. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -70
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -2
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -2
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +403 -20
  71. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebChatApi.js +19 -10
  87. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class UploadsApi {
5
5
  /**
6
6
  * Uploads service.
7
7
  * @module purecloud-platform-client-v2/api/UploadsApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class VoicemailApi {
5
5
  /**
6
6
  * Voicemail service.
7
7
  * @module purecloud-platform-client-v2/api/VoicemailApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebChatApi {
5
5
  /**
6
6
  * WebChat service.
7
7
  * @module purecloud-platform-client-v2/api/WebChatApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -48,9 +48,10 @@ class WebChatApi {
48
48
 
49
49
  /**
50
50
  * Remove a member from a chat conversation
51
- *
51
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
52
52
  * @param {String} conversationId conversationId
53
53
  * @param {String} memberId memberId
54
+ * @deprecated
54
55
  */
55
56
  deleteWebchatGuestConversationMember(conversationId, memberId) {
56
57
  // verify the required parameter 'conversationId' is set
@@ -176,8 +177,9 @@ class WebChatApi {
176
177
 
177
178
  /**
178
179
  * Get all media requests to the guest in the conversation
179
- *
180
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
180
181
  * @param {String} conversationId conversationId
182
+ * @deprecated
181
183
  */
182
184
  getWebchatGuestConversationMediarequests(conversationId) {
183
185
  // verify the required parameter 'conversationId' is set
@@ -201,9 +203,10 @@ class WebChatApi {
201
203
 
202
204
  /**
203
205
  * Get a web chat conversation member
204
- *
206
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
205
207
  * @param {String} conversationId conversationId
206
208
  * @param {String} memberId memberId
209
+ * @deprecated
207
210
  */
208
211
  getWebchatGuestConversationMember(conversationId, memberId) {
209
212
  // verify the required parameter 'conversationId' is set
@@ -231,12 +234,13 @@ class WebChatApi {
231
234
 
232
235
  /**
233
236
  * Get the members of a chat conversation.
234
- *
237
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
235
238
  * @param {String} conversationId conversationId
236
239
  * @param {Object} opts Optional parameters
237
240
  * @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
238
241
  * @param {Number} opts.pageNumber The page number to return, or omitted for the first page. (default to 1)
239
242
  * @param {Boolean} opts.excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (default to false)
243
+ * @deprecated
240
244
  */
241
245
  getWebchatGuestConversationMembers(conversationId, opts) {
242
246
  opts = opts || {};
@@ -262,9 +266,10 @@ class WebChatApi {
262
266
 
263
267
  /**
264
268
  * Get a web chat conversation message
265
- *
269
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
266
270
  * @param {String} conversationId conversationId
267
271
  * @param {String} messageId messageId
272
+ * @deprecated
268
273
  */
269
274
  getWebchatGuestConversationMessage(conversationId, messageId) {
270
275
  // verify the required parameter 'conversationId' is set
@@ -292,13 +297,14 @@ class WebChatApi {
292
297
 
293
298
  /**
294
299
  * Get the messages of a chat conversation.
295
- *
300
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
296
301
  * @param {String} conversationId conversationId
297
302
  * @param {Object} opts Optional parameters
298
303
  * @param {String} opts.after If available, get the messages chronologically after the id of this message
299
304
  * @param {String} opts.before If available, get the messages chronologically before the id of this message
300
305
  * @param {Object} opts.sortOrder Sort order (default to ascending)
301
306
  * @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
307
+ * @deprecated
302
308
  */
303
309
  getWebchatGuestConversationMessages(conversationId, opts) {
304
310
  opts = opts || {};
@@ -406,10 +412,11 @@ class WebChatApi {
406
412
 
407
413
  /**
408
414
  * Send a message in a chat conversation.
409
- *
415
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
410
416
  * @param {String} conversationId conversationId
411
417
  * @param {String} memberId memberId
412
418
  * @param {Object} body Message
419
+ * @deprecated
413
420
  */
414
421
  postWebchatGuestConversationMemberMessages(conversationId, memberId, body) {
415
422
  // verify the required parameter 'conversationId' is set
@@ -441,9 +448,10 @@ class WebChatApi {
441
448
 
442
449
  /**
443
450
  * Send a typing-indicator in a chat conversation.
444
- *
451
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
445
452
  * @param {String} conversationId conversationId
446
453
  * @param {String} memberId memberId
454
+ * @deprecated
447
455
  */
448
456
  postWebchatGuestConversationMemberTyping(conversationId, memberId) {
449
457
  // verify the required parameter 'conversationId' is set
@@ -471,8 +479,9 @@ class WebChatApi {
471
479
 
472
480
  /**
473
481
  * Create an ACD chat conversation from an external customer.
474
- * This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the memberAuthToken field should include his JWT as generated by the POST /api/v2/signeddata resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the eventStreamUri field of the response; the conversation is not routed until the event stream is attached.
482
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the memberAuthToken field should include his JWT as generated by the POST /api/v2/signeddata resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the eventStreamUri field of the response; the conversation is not routed until the event stream is attached.
475
483
  * @param {Object} body CreateConversationRequest
484
+ * @deprecated
476
485
  */
477
486
  postWebchatGuestConversations(body) {
478
487
  // verify the required parameter 'body' is set
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WidgetsApi {
5
5
  /**
6
6
  * Widgets service.
7
7
  * @module purecloud-platform-client-v2/api/WidgetsApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -22,8 +22,9 @@ class WidgetsApi {
22
22
 
23
23
  /**
24
24
  * Delete a Widget deployment
25
- *
25
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
26
26
  * @param {String} deploymentId Widget Config Id
27
+ * @deprecated
27
28
  */
28
29
  deleteWidgetsDeployment(deploymentId) {
29
30
  // verify the required parameter 'deploymentId' is set
@@ -47,8 +48,9 @@ class WidgetsApi {
47
48
 
48
49
  /**
49
50
  * Get a Widget deployment
50
- *
51
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
51
52
  * @param {String} deploymentId Widget Config Id
53
+ * @deprecated
52
54
  */
53
55
  getWidgetsDeployment(deploymentId) {
54
56
  // verify the required parameter 'deploymentId' is set
@@ -72,7 +74,8 @@ class WidgetsApi {
72
74
 
73
75
  /**
74
76
  * List Widget deployments
75
- *
77
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
78
+ * @deprecated
76
79
  */
77
80
  getWidgetsDeployments() {
78
81
 
@@ -92,8 +95,9 @@ class WidgetsApi {
92
95
 
93
96
  /**
94
97
  * Create Widget deployment
95
- *
98
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
96
99
  * @param {Object} body Deployment
100
+ * @deprecated
97
101
  */
98
102
  postWidgetsDeployments(body) {
99
103
  // verify the required parameter 'body' is set
@@ -117,9 +121,10 @@ class WidgetsApi {
117
121
 
118
122
  /**
119
123
  * Update a Widget deployment
120
- *
124
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
121
125
  * @param {String} deploymentId Widget Config Id
122
126
  * @param {Object} body Deployment
127
+ * @deprecated
123
128
  */
124
129
  putWidgetsDeployment(deploymentId, body) {
125
130
  // verify the required parameter 'deploymentId' is set
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
5
5
  /**
6
6
  * WorkforceManagement service.
7
7
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
8
- * @version 217.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -116,7 +116,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
116
116
  * </pre>
117
117
  * </p>
118
118
  * @module purecloud-platform-client-v2/index
119
- * @version 217.0.0
119
+ * @version 218.0.0
120
120
  */
121
121
  class platformClient {
122
122
  constructor() {