purecloud-platform-client-v2 212.0.0 → 213.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 +18 -4
  2. package/dist/node/purecloud-platform-client-v2.js +767 -255
  3. package/dist/web-amd/purecloud-platform-client-v2.js +768 -255
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +430 -293
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +660 -6380
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +441 -2
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +21 -18
  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 +28 -2
  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 -1
  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 +35 -18
  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 +1 -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 +57 -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 +2 -2
  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 -1
  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 -1
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +7 -3
  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 -1
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  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 +1 -1
  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 +288 -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 +1 -1
  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 +1 -1
  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 +1 -1
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +119 -1
  91. package/src/purecloud-platform-client-v2/index.js +8 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "212.0.0",
3
+ "version": "213.0.0",
4
4
  "description": "A JavaScript library to interface with the PureCloud Platform API",
5
5
  "license": "MIT",
6
6
  "main": "dist/node/purecloud-platform-client-v2.js",
@@ -1,5 +1,4 @@
1
1
  import Configuration from './configuration.js';
2
- import https from 'https';
3
2
  import DefaultHttpClient from './DefaultHttpClient.js';
4
3
  import AbstractHttpClient from './AbstractHttpClient.js';
5
4
  import HttpRequestOptions from './HttpRequestOptions.js';
@@ -7,7 +6,7 @@ import { default as qs } from 'qs';
7
6
 
8
7
  /**
9
8
  * @module purecloud-platform-client-v2/ApiClient
10
- * @version 212.0.0
9
+ * @version 213.0.0
11
10
  */
12
11
  class ApiClient {
13
12
  /**
@@ -254,11 +253,11 @@ class ApiClient {
254
253
 
255
254
  agentOptions.rejectUnauthorized = true
256
255
 
257
- this.proxyAgent = new https.Agent(agentOptions);
256
+ this.proxyAgent = new require('https').Agent(agentOptions);
258
257
  const httpClient = this.getHttpClient();
259
258
  httpClient.setHttpsAgent(this.proxyAgent);
260
259
  } else {
261
- throw new Error("Custom Agent Paths/ File System Access are not supported on Browser. Use setMTLSContents instead");
260
+ throw new Error("MTLS authentication is managed by the Browser itself. MTLS certificates cannot be set via code on Browser.");
262
261
  }
263
262
  }
264
263
 
@@ -269,24 +268,28 @@ class ApiClient {
269
268
  * @param {string} caContent - content for public certs
270
269
  */
271
270
  setMTLSContents(certContent, keyContent, caContent) {
272
- const agentOptions = {}
273
- if (certContent) {
274
- agentOptions.cert = certContent;
275
- }
271
+ if (typeof window === 'undefined') {
272
+ const agentOptions = {}
273
+ if (certContent) {
274
+ agentOptions.cert = certContent;
275
+ }
276
276
 
277
- if (keyContent) {
278
- agentOptions.key = keyContent;
279
- }
277
+ if (keyContent) {
278
+ agentOptions.key = keyContent;
279
+ }
280
280
 
281
- if (caContent) {
282
- agentOptions.ca = caContent;
283
- }
281
+ if (caContent) {
282
+ agentOptions.ca = caContent;
283
+ }
284
284
 
285
- agentOptions.rejectUnauthorized = true
285
+ agentOptions.rejectUnauthorized = true
286
286
 
287
- this.proxyAgent = new https.Agent(agentOptions);
288
- const httpClient = this.getHttpClient();
289
- httpClient.setHttpsAgent(this.proxyAgent);
287
+ this.proxyAgent = new require('https').Agent(agentOptions);
288
+ const httpClient = this.getHttpClient();
289
+ httpClient.setHttpsAgent(this.proxyAgent);
290
+ } else {
291
+ throw new Error("MTLS authentication is managed by the Browser itself. MTLS certificates cannot be set via code on Browser.");
292
+ }
290
293
  }
291
294
 
292
295
  /**
@@ -5,7 +5,7 @@ class AgentAssistantsApi {
5
5
  /**
6
6
  * AgentAssistants service.
7
7
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AgentCopilotApi {
5
5
  /**
6
6
  * AgentCopilot service.
7
7
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AgentUIApi {
5
5
  /**
6
6
  * AgentUI service.
7
7
  * @module purecloud-platform-client-v2/api/AgentUIApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AlertingApi {
5
5
  /**
6
6
  * Alerting service.
7
7
  * @module purecloud-platform-client-v2/api/AlertingApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AnalyticsApi {
5
5
  /**
6
6
  * Analytics service.
7
7
  * @module purecloud-platform-client-v2/api/AnalyticsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -974,6 +974,7 @@ class AnalyticsApi {
974
974
  * @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
975
975
  * @param {Object} opts Optional parameters
976
976
  * @param {String} opts.name name of the dashboard
977
+ * @param {Object} opts.dashboardState List dashboard of given state (default to Active)
977
978
  * @param {String} opts.sortBy (default to desc)
978
979
  * @param {Number} opts.pageNumber (default to 1)
979
980
  * @param {Number} opts.pageSize (default to 9)
@@ -994,7 +995,7 @@ class AnalyticsApi {
994
995
  '/api/v2/analytics/reporting/settings/dashboards/query',
995
996
  'GET',
996
997
  { },
997
- { 'name': opts['name'],'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
998
+ { 'name': opts['name'],'dashboardType': dashboardType,'dashboardState': opts['dashboardState'],'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
998
999
  { },
999
1000
  { },
1000
1001
  null,
@@ -2352,6 +2353,31 @@ class AnalyticsApi {
2352
2353
  );
2353
2354
  }
2354
2355
 
2356
+ /**
2357
+ * Query for resolution aggregates
2358
+ *
2359
+ * @param {Object} body query
2360
+ */
2361
+ postAnalyticsResolutionsAggregatesQuery(body) {
2362
+ // verify the required parameter 'body' is set
2363
+ if (body === undefined || body === null) {
2364
+ throw 'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesQuery';
2365
+ }
2366
+
2367
+ return this.apiClient.callApi(
2368
+ '/api/v2/analytics/resolutions/aggregates/query',
2369
+ 'POST',
2370
+ { },
2371
+ { },
2372
+ { },
2373
+ { },
2374
+ body,
2375
+ ['PureCloud OAuth'],
2376
+ ['application/json'],
2377
+ ['application/json']
2378
+ );
2379
+ }
2380
+
2355
2381
  /**
2356
2382
  * Query for user activity observations
2357
2383
  *
@@ -5,7 +5,7 @@ class ArchitectApi {
5
5
  /**
6
6
  * Architect service.
7
7
  * @module purecloud-platform-client-v2/api/ArchitectApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AuditApi {
5
5
  /**
6
6
  * Audit service.
7
7
  * @module purecloud-platform-client-v2/api/AuditApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AuthorizationApi {
5
5
  /**
6
6
  * Authorization service.
7
7
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class BillingApi {
5
5
  /**
6
6
  * Billing service.
7
7
  * @module purecloud-platform-client-v2/api/BillingApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class CarrierServicesApi {
5
5
  /**
6
6
  * CarrierServices service.
7
7
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ChatApi {
5
5
  /**
6
6
  * Chat service.
7
7
  * @module purecloud-platform-client-v2/api/ChatApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class CoachingApi {
5
5
  /**
6
6
  * Coaching service.
7
7
  * @module purecloud-platform-client-v2/api/CoachingApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ContentManagementApi {
5
5
  /**
6
6
  * ContentManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ConversationsApi {
5
5
  /**
6
6
  * Conversations service.
7
7
  * @module purecloud-platform-client-v2/api/ConversationsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1181,8 +1181,9 @@ class ConversationsApi {
1181
1181
 
1182
1182
  /**
1183
1183
  * Get chat conversation
1184
- *
1184
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
1185
1185
  * @param {String} conversationId conversationId
1186
+ * @deprecated
1186
1187
  */
1187
1188
  getConversationsChat(conversationId) {
1188
1189
  // verify the required parameter 'conversationId' is set
@@ -1206,9 +1207,10 @@ class ConversationsApi {
1206
1207
 
1207
1208
  /**
1208
1209
  * Get a web chat conversation message
1209
- * The current user must be involved with the conversation to get its messages.
1210
+ * 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.
1210
1211
  * @param {String} conversationId conversationId
1211
1212
  * @param {String} messageId messageId
1213
+ * @deprecated
1212
1214
  */
1213
1215
  getConversationsChatMessage(conversationId, messageId) {
1214
1216
  // verify the required parameter 'conversationId' is set
@@ -1236,13 +1238,14 @@ class ConversationsApi {
1236
1238
 
1237
1239
  /**
1238
1240
  * Get the messages of a chat conversation.
1239
- * The current user must be involved with the conversation to get its messages.
1241
+ * 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.
1240
1242
  * @param {String} conversationId conversationId
1241
1243
  * @param {Object} opts Optional parameters
1242
1244
  * @param {String} opts.after If specified, get the messages chronologically after the id of this message
1243
1245
  * @param {String} opts.before If specified, get the messages chronologically before the id of this message
1244
1246
  * @param {Object} opts.sortOrder Sort order (default to ascending)
1245
1247
  * @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
1248
+ * @deprecated
1246
1249
  */
1247
1250
  getConversationsChatMessages(conversationId, opts) {
1248
1251
  opts = opts || {};
@@ -1268,12 +1271,13 @@ class ConversationsApi {
1268
1271
 
1269
1272
  /**
1270
1273
  * Get the wrap-up for this conversation communication.
1271
- *
1274
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
1272
1275
  * @param {String} conversationId conversationId
1273
1276
  * @param {String} participantId participantId
1274
1277
  * @param {String} communicationId communicationId
1275
1278
  * @param {Object} opts Optional parameters
1276
1279
  * @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
1280
+ * @deprecated
1277
1281
  */
1278
1282
  getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
1279
1283
  opts = opts || {};
@@ -1307,11 +1311,12 @@ class ConversationsApi {
1307
1311
 
1308
1312
  /**
1309
1313
  * Get the wrap-up for this conversation participant.
1310
- *
1314
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
1311
1315
  * @param {String} conversationId conversationId
1312
1316
  * @param {String} participantId participantId
1313
1317
  * @param {Object} opts Optional parameters
1314
1318
  * @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
1319
+ * @deprecated
1315
1320
  */
1316
1321
  getConversationsChatParticipantWrapup(conversationId, participantId, opts) {
1317
1322
  opts = opts || {};
@@ -1341,9 +1346,10 @@ class ConversationsApi {
1341
1346
 
1342
1347
  /**
1343
1348
  * Get list of wrapup codes for this conversation participant
1344
- *
1349
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
1345
1350
  * @param {String} conversationId conversationId
1346
1351
  * @param {String} participantId participantId
1352
+ * @deprecated
1347
1353
  */
1348
1354
  getConversationsChatParticipantWrapupcodes(conversationId, participantId) {
1349
1355
  // verify the required parameter 'conversationId' is set
@@ -1371,7 +1377,8 @@ class ConversationsApi {
1371
1377
 
1372
1378
  /**
1373
1379
  * Get active chat conversations for the logged in user
1374
- *
1380
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
1381
+ * @deprecated
1375
1382
  */
1376
1383
  getConversationsChats() {
1377
1384
 
@@ -3293,9 +3300,10 @@ class ConversationsApi {
3293
3300
 
3294
3301
  /**
3295
3302
  * Update a conversation by disconnecting all of the participants
3296
- *
3303
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
3297
3304
  * @param {String} conversationId conversationId
3298
3305
  * @param {Object} body Conversation
3306
+ * @deprecated
3299
3307
  */
3300
3308
  patchConversationsChat(conversationId, body) {
3301
3309
  // verify the required parameter 'conversationId' is set
@@ -3323,10 +3331,11 @@ class ConversationsApi {
3323
3331
 
3324
3332
  /**
3325
3333
  * Update conversation participant
3326
- *
3334
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
3327
3335
  * @param {String} conversationId conversationId
3328
3336
  * @param {String} participantId participantId
3329
3337
  * @param {Object} body Update request
3338
+ * @deprecated
3330
3339
  */
3331
3340
  patchConversationsChatParticipant(conversationId, participantId, body) {
3332
3341
  // verify the required parameter 'conversationId' is set
@@ -3358,10 +3367,11 @@ class ConversationsApi {
3358
3367
 
3359
3368
  /**
3360
3369
  * Update the attributes on a conversation participant.
3361
- *
3370
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
3362
3371
  * @param {String} conversationId conversationId
3363
3372
  * @param {String} participantId participantId
3364
3373
  * @param {Object} body Participant attributes
3374
+ * @deprecated
3365
3375
  */
3366
3376
  patchConversationsChatParticipantAttributes(conversationId, participantId, body) {
3367
3377
  // verify the required parameter 'conversationId' is set
@@ -3393,11 +3403,12 @@ class ConversationsApi {
3393
3403
 
3394
3404
  /**
3395
3405
  * Update conversation participant's communication by disconnecting it.
3396
- *
3406
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
3397
3407
  * @param {String} conversationId conversationId
3398
3408
  * @param {String} participantId participantId
3399
3409
  * @param {String} communicationId communicationId
3400
3410
  * @param {Object} body Participant
3411
+ * @deprecated
3401
3412
  */
3402
3413
  patchConversationsChatParticipantCommunication(conversationId, participantId, communicationId, body) {
3403
3414
  // verify the required parameter 'conversationId' is set
@@ -5300,10 +5311,11 @@ class ConversationsApi {
5300
5311
 
5301
5312
  /**
5302
5313
  * Send a message on behalf of a communication in a chat conversation.
5303
- *
5314
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
5304
5315
  * @param {String} conversationId conversationId
5305
5316
  * @param {String} communicationId communicationId
5306
5317
  * @param {Object} body Message
5318
+ * @deprecated
5307
5319
  */
5308
5320
  postConversationsChatCommunicationMessages(conversationId, communicationId, body) {
5309
5321
  // verify the required parameter 'conversationId' is set
@@ -5335,9 +5347,10 @@ class ConversationsApi {
5335
5347
 
5336
5348
  /**
5337
5349
  * Send a typing-indicator on behalf of a communication in a chat conversation.
5338
- *
5350
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
5339
5351
  * @param {String} conversationId conversationId
5340
5352
  * @param {String} communicationId communicationId
5353
+ * @deprecated
5341
5354
  */
5342
5355
  postConversationsChatCommunicationTyping(conversationId, communicationId) {
5343
5356
  // verify the required parameter 'conversationId' is set
@@ -5365,12 +5378,13 @@ class ConversationsApi {
5365
5378
 
5366
5379
  /**
5367
5380
  * Apply wrap-up for this conversation communication
5368
- *
5381
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
5369
5382
  * @param {String} conversationId conversationId
5370
5383
  * @param {String} participantId participantId
5371
5384
  * @param {String} communicationId communicationId
5372
5385
  * @param {Object} opts Optional parameters
5373
5386
  * @param {Object} opts.body Wrap-up
5387
+ * @deprecated
5374
5388
  */
5375
5389
  postConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
5376
5390
  opts = opts || {};
@@ -5404,10 +5418,11 @@ class ConversationsApi {
5404
5418
 
5405
5419
  /**
5406
5420
  * Replace this participant with the specified user and/or address
5407
- *
5421
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
5408
5422
  * @param {String} conversationId conversationId
5409
5423
  * @param {String} participantId participantId
5410
5424
  * @param {Object} body Transfer request
5425
+ * @deprecated
5411
5426
  */
5412
5427
  postConversationsChatParticipantReplace(conversationId, participantId, body) {
5413
5428
  // verify the required parameter 'conversationId' is set
@@ -5439,8 +5454,9 @@ class ConversationsApi {
5439
5454
 
5440
5455
  /**
5441
5456
  * Create a web chat conversation
5442
- *
5457
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
5443
5458
  * @param {Object} body Create web chat request
5459
+ * @deprecated
5444
5460
  */
5445
5461
  postConversationsChats(body) {
5446
5462
  // verify the required parameter 'body' is set
@@ -6800,9 +6816,10 @@ class ConversationsApi {
6800
6816
 
6801
6817
  /**
6802
6818
  * Update a conversation by setting its recording state
6803
- *
6819
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
6804
6820
  * @param {String} conversationId conversationId
6805
6821
  * @param {Object} body SetRecordingState
6822
+ * @deprecated
6806
6823
  */
6807
6824
  putConversationsChatRecordingstate(conversationId, body) {
6808
6825
  // verify the required parameter 'conversationId' is set
@@ -5,7 +5,7 @@ class DataExtensionsApi {
5
5
  /**
6
6
  * DataExtensions service.
7
7
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class DataPrivacyApi {
5
5
  /**
6
6
  * DataPrivacy service.
7
7
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class DownloadsApi {
5
5
  /**
6
6
  * Downloads service.
7
7
  * @module purecloud-platform-client-v2/api/DownloadsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class EmailsApi {
5
5
  /**
6
6
  * Emails service.
7
7
  * @module purecloud-platform-client-v2/api/EmailsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class EmployeeEngagementApi {
5
5
  /**
6
6
  * EmployeeEngagement service.
7
7
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class EventsApi {
5
5
  /**
6
6
  * Events service.
7
7
  * @module purecloud-platform-client-v2/api/EventsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ExternalContactsApi {
5
5
  /**
6
6
  * ExternalContacts service.
7
7
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class FaxApi {
5
5
  /**
6
6
  * Fax service.
7
7
  * @module purecloud-platform-client-v2/api/FaxApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class FlowsApi {
5
5
  /**
6
6
  * Flows service.
7
7
  * @module purecloud-platform-client-v2/api/FlowsApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GamificationApi {
5
5
  /**
6
6
  * Gamification service.
7
7
  * @module purecloud-platform-client-v2/api/GamificationApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -344,6 +344,62 @@ class GamificationApi {
344
344
  );
345
345
  }
346
346
 
347
+ /**
348
+ * Get insights rankings
349
+ *
350
+ * @param {Object} filterType Filter type for the query request.
351
+ * @param {String} filterId ID for the filter type.
352
+ * @param {Object} granularity Granularity
353
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
354
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
355
+ * @param {Object} sortKey Sort key
356
+ * @param {Object} opts Optional parameters
357
+ * @param {String} opts.sortMetricId Sort Metric Id
358
+ * @param {Number} opts.sectionSize The number of top and bottom users to return before ties
359
+ * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
360
+ */
361
+ getGamificationInsightsRankings(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, sortKey, opts) {
362
+ opts = opts || {};
363
+
364
+ // verify the required parameter 'filterType' is set
365
+ if (filterType === undefined || filterType === null) {
366
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsRankings';
367
+ }
368
+ // verify the required parameter 'filterId' is set
369
+ if (filterId === undefined || filterId === null) {
370
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsRankings';
371
+ }
372
+ // verify the required parameter 'granularity' is set
373
+ if (granularity === undefined || granularity === null) {
374
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsRankings';
375
+ }
376
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
377
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
378
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsRankings';
379
+ }
380
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
381
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
382
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsRankings';
383
+ }
384
+ // verify the required parameter 'sortKey' is set
385
+ if (sortKey === undefined || sortKey === null) {
386
+ throw 'Missing the required parameter "sortKey" when calling getGamificationInsightsRankings';
387
+ }
388
+
389
+ return this.apiClient.callApi(
390
+ '/api/v2/gamification/insights/rankings',
391
+ 'GET',
392
+ { },
393
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'sortKey': sortKey,'sortMetricId': opts['sortMetricId'],'sectionSize': opts['sectionSize'],'userIds': opts['userIds'] },
394
+ { },
395
+ { },
396
+ null,
397
+ ['PureCloud OAuth'],
398
+ ['application/json'],
399
+ ['application/json']
400
+ );
401
+ }
402
+
347
403
  /**
348
404
  * Get insights user trend for the current user
349
405
  *
@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
5
5
  /**
6
6
  * GeneralDataProtectionRegulation service.
7
7
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GeolocationApi {
5
5
  /**
6
6
  * Geolocation service.
7
7
  * @module purecloud-platform-client-v2/api/GeolocationApi
8
- * @version 212.0.0
8
+ * @version 213.0.0
9
9
  */
10
10
 
11
11
  /**