purecloud-platform-client-v2 156.0.0 → 158.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 (77) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +652 -73
  3. package/dist/web-amd/purecloud-platform-client-v2.js +652 -73
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +652 -73
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +672 -79
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +263 -5
  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/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +26 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +3 -2
  37. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -3
  39. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +371 -1
  48. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/StationsApi.js +3 -3
  60. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +135 -1
  74. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +50 -1
  77. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class WebChatApi {
5
5
  /**
6
6
  * WebChat service.
7
7
  * @module purecloud-platform-client-v2/api/WebChatApi
8
- * @version 156.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 156.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -70,6 +70,61 @@ class WebDeploymentsApi {
70
70
  );
71
71
  }
72
72
 
73
+ /**
74
+ * Deletes a cobrowse session
75
+ *
76
+ * @param {String} deploymentId WebMessaging deployment ID
77
+ * @param {String} sessionId Cobrowse session id or join code
78
+ */
79
+ deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId) {
80
+ // verify the required parameter 'deploymentId' is set
81
+ if (deploymentId === undefined || deploymentId === null) {
82
+ throw 'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';
83
+ }
84
+ // verify the required parameter 'sessionId' is set
85
+ if (sessionId === undefined || sessionId === null) {
86
+ throw 'Missing the required parameter "sessionId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';
87
+ }
88
+
89
+ return this.apiClient.callApi(
90
+ '/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}',
91
+ 'DELETE',
92
+ { 'deploymentId': deploymentId,'sessionId': sessionId },
93
+ { },
94
+ { },
95
+ { },
96
+ null,
97
+ ['PureCloud OAuth'],
98
+ ['application/json'],
99
+ ['application/json']
100
+ );
101
+ }
102
+
103
+ /**
104
+ * Invalidate JWT
105
+ *
106
+ * @param {Object} opts Optional parameters
107
+ * @param {String} opts.xJourneySessionId The Customer's journey sessionId.
108
+ * @param {String} opts.xJourneySessionType The Customer's journey session type.
109
+ */
110
+ deleteWebdeploymentsTokenRevoke(opts) {
111
+ opts = opts || {};
112
+
113
+
114
+ return this.apiClient.callApi(
115
+ '/api/v2/webdeployments/token/revoke',
116
+ 'DELETE',
117
+ { },
118
+ { },
119
+ { 'X-Journey-Session-Id': opts['xJourneySessionId'],'X-Journey-Session-Type': opts['xJourneySessionType'] },
120
+ { },
121
+ null,
122
+ ['PureCloud OAuth'],
123
+ ['application/json'],
124
+ ['application/json']
125
+ );
126
+ }
127
+
73
128
  /**
74
129
  * Get a configuration version
75
130
  *
@@ -199,6 +254,36 @@ class WebDeploymentsApi {
199
254
  );
200
255
  }
201
256
 
257
+ /**
258
+ * Retrieves a cobrowse session
259
+ *
260
+ * @param {String} deploymentId WebMessaging deployment ID
261
+ * @param {String} sessionId Cobrowse session id or join code
262
+ */
263
+ getWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId) {
264
+ // verify the required parameter 'deploymentId' is set
265
+ if (deploymentId === undefined || deploymentId === null) {
266
+ throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentCobrowseSessionId';
267
+ }
268
+ // verify the required parameter 'sessionId' is set
269
+ if (sessionId === undefined || sessionId === null) {
270
+ throw 'Missing the required parameter "sessionId" when calling getWebdeploymentsDeploymentCobrowseSessionId';
271
+ }
272
+
273
+ return this.apiClient.callApi(
274
+ '/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}',
275
+ 'GET',
276
+ { 'deploymentId': deploymentId,'sessionId': sessionId },
277
+ { },
278
+ { },
279
+ { },
280
+ null,
281
+ ['PureCloud OAuth'],
282
+ ['application/json'],
283
+ ['application/json']
284
+ );
285
+ }
286
+
202
287
  /**
203
288
  * Get active configuration for a given deployment
204
289
  *
@@ -327,6 +412,55 @@ class WebDeploymentsApi {
327
412
  );
328
413
  }
329
414
 
415
+ /**
416
+ * Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.
417
+ *
418
+ * @param {Object} body webDeploymentsOAuthExchangeRequest
419
+ */
420
+ postWebdeploymentsTokenOauthcodegrantjwtexchange(body) {
421
+ // verify the required parameter 'body' is set
422
+ if (body === undefined || body === null) {
423
+ throw 'Missing the required parameter "body" when calling postWebdeploymentsTokenOauthcodegrantjwtexchange';
424
+ }
425
+
426
+ return this.apiClient.callApi(
427
+ '/api/v2/webdeployments/token/oauthcodegrantjwtexchange',
428
+ 'POST',
429
+ { },
430
+ { },
431
+ { },
432
+ { },
433
+ body,
434
+ ['PureCloud OAuth'],
435
+ ['application/json'],
436
+ ['application/json']
437
+ );
438
+ }
439
+
440
+ /**
441
+ * Refresh a JWT.
442
+ *
443
+ * @param {Object} opts Optional parameters
444
+ * @param {Object} opts.body
445
+ */
446
+ postWebdeploymentsTokenRefresh(opts) {
447
+ opts = opts || {};
448
+
449
+
450
+ return this.apiClient.callApi(
451
+ '/api/v2/webdeployments/token/refresh',
452
+ 'POST',
453
+ { },
454
+ { },
455
+ { },
456
+ { },
457
+ opts['body'],
458
+ ['PureCloud OAuth'],
459
+ ['application/json'],
460
+ ['application/json']
461
+ );
462
+ }
463
+
330
464
  /**
331
465
  * Update the configuration draft
332
466
  *
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 156.0.0
8
+ * @version 158.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 156.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
5
5
  /**
6
6
  * WorkforceManagement service.
7
7
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
8
- * @version 156.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -475,6 +475,31 @@ class WorkforceManagementApi {
475
475
  );
476
476
  }
477
477
 
478
+ /**
479
+ * Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status
480
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
481
+ * @param {String} jobId ID of the job to get
482
+ */
483
+ getWorkforcemanagementAdherenceHistoricalBulkJob(jobId) {
484
+ // verify the required parameter 'jobId' is set
485
+ if (jobId === undefined || jobId === null) {
486
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalBulkJob';
487
+ }
488
+
489
+ return this.apiClient.callApi(
490
+ '/api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}',
491
+ 'GET',
492
+ { 'jobId': jobId },
493
+ { },
494
+ { },
495
+ { },
496
+ null,
497
+ ['PureCloud OAuth'],
498
+ ['application/json'],
499
+ ['application/json']
500
+ );
501
+ }
502
+
478
503
  /**
479
504
  * Query the status of a historical adherence request operation. Only the user who started the operation can query the status
480
505
  * Job details are only retained if the initial request returned a 202 ACCEPTED response
@@ -2926,6 +2951,30 @@ class WorkforceManagementApi {
2926
2951
  );
2927
2952
  }
2928
2953
 
2954
+ /**
2955
+ * Request a historical adherence report in bulk
2956
+ *
2957
+ * @param {Object} opts Optional parameters
2958
+ * @param {Object} opts.body body
2959
+ */
2960
+ postWorkforcemanagementAdherenceHistoricalBulk(opts) {
2961
+ opts = opts || {};
2962
+
2963
+
2964
+ return this.apiClient.callApi(
2965
+ '/api/v2/workforcemanagement/adherence/historical/bulk',
2966
+ 'POST',
2967
+ { },
2968
+ { },
2969
+ { },
2970
+ { },
2971
+ opts['body'],
2972
+ ['PureCloud OAuth'],
2973
+ ['application/json'],
2974
+ ['application/json']
2975
+ );
2976
+ }
2977
+
2929
2978
  /**
2930
2979
  * Add an adherence explanation for the requested user
2931
2980
  *
@@ -99,7 +99,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
99
99
  * </pre>
100
100
  * </p>
101
101
  * @module purecloud-platform-client-v2/index
102
- * @version 156.0.0
102
+ * @version 158.0.0
103
103
  */
104
104
  class platformClient {
105
105
  constructor() {