purecloud-platform-client-v2 182.1.0 → 184.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 (84) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +786 -127
  3. package/dist/web-amd/purecloud-platform-client-v2.js +786 -127
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +295 -119
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +295 -119
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +554 -229
  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 +30 -19
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +149 -5
  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 +7 -8
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +2 -2
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +4 -8
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +39 -2
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +75 -0
  45. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +7 -8
  50. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OutboundApi.js +401 -1
  54. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -6
  55. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/QualityApi.js +7 -4
  57. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class JourneyApi {
5
5
  /**
6
6
  * Journey service.
7
7
  * @module purecloud-platform-client-v2/api/JourneyApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -452,14 +452,14 @@ class JourneyApi {
452
452
  *
453
453
  * @param {String} deploymentId The ID of the deployment sending the ping.
454
454
  * @param {String} customerCookieId ID of the customer associated with the ping.
455
- * @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
456
455
  * @param {Object} opts Optional parameters
457
456
  * @param {String} opts.dl Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.
458
457
  * @param {String} opts.dt Document Title. A human readable name for the page or screen
459
458
  * @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
459
+ * @param {String} opts.sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
460
460
  * @param {Number} opts.sinceLastBeaconMilliseconds How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.
461
461
  */
462
- getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, sessionId, opts) {
462
+ getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, opts) {
463
463
  opts = opts || {};
464
464
 
465
465
  // verify the required parameter 'deploymentId' is set
@@ -470,16 +470,12 @@ class JourneyApi {
470
470
  if (customerCookieId === undefined || customerCookieId === null) {
471
471
  throw 'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';
472
472
  }
473
- // verify the required parameter 'sessionId' is set
474
- if (sessionId === undefined || sessionId === null) {
475
- throw 'Missing the required parameter "sessionId" when calling getJourneyDeploymentCustomerPing';
476
- }
477
473
 
478
474
  return this.apiClient.callApi(
479
475
  '/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping',
480
476
  'GET',
481
477
  { 'deploymentId': deploymentId,'customerCookieId': customerCookieId },
482
- { 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': sessionId,'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
478
+ { 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': opts['sessionId'],'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
483
479
  { },
484
480
  { },
485
481
  null,
@@ -5,7 +5,7 @@ class KnowledgeApi {
5
5
  /**
6
6
  * Knowledge service.
7
7
  * @module purecloud-platform-client-v2/api/KnowledgeApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
5
5
  /**
6
6
  * LanguageUnderstanding service.
7
7
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LanguagesApi {
5
5
  /**
6
6
  * Languages service.
7
7
  * @module purecloud-platform-client-v2/api/LanguagesApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LearningApi {
5
5
  /**
6
6
  * Learning service.
7
7
  * @module purecloud-platform-client-v2/api/LearningApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -306,6 +306,7 @@ class LearningApi {
306
306
  * @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
307
307
  * @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
308
308
  * @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
309
+ * @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
309
310
  */
310
311
  getLearningModules(opts) {
311
312
  opts = opts || {};
@@ -315,7 +316,7 @@ class LearningApi {
315
316
  '/api/v2/learning/modules',
316
317
  'GET',
317
318
  { },
318
- { 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi') },
319
+ { 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
319
320
  { },
320
321
  { },
321
322
  null,
@@ -442,6 +443,42 @@ class LearningApi {
442
443
  );
443
444
  }
444
445
 
446
+ /**
447
+ * Update an external assignment for a specific user
448
+ *
449
+ * @param {String} moduleId Key identifier for the module
450
+ * @param {String} userId Key identifier for the user
451
+ * @param {Object} body The learning request for updating the assignment
452
+ * patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
453
+ */
454
+ patchLearningModuleUserAssignments(moduleId, userId, body) {
455
+ // verify the required parameter 'moduleId' is set
456
+ if (moduleId === undefined || moduleId === null) {
457
+ throw 'Missing the required parameter "moduleId" when calling patchLearningModuleUserAssignments';
458
+ }
459
+ // verify the required parameter 'userId' is set
460
+ if (userId === undefined || userId === null) {
461
+ throw 'Missing the required parameter "userId" when calling patchLearningModuleUserAssignments';
462
+ }
463
+ // verify the required parameter 'body' is set
464
+ if (body === undefined || body === null) {
465
+ throw 'Missing the required parameter "body" when calling patchLearningModuleUserAssignments';
466
+ }
467
+
468
+ return this.apiClient.callApi(
469
+ '/api/v2/learning/modules/{moduleId}/users/{userId}/assignments',
470
+ 'PATCH',
471
+ { 'moduleId': moduleId,'userId': userId },
472
+ { },
473
+ { },
474
+ { },
475
+ body,
476
+ ['PureCloud OAuth'],
477
+ ['application/json'],
478
+ ['application/json']
479
+ );
480
+ }
481
+
445
482
  /**
446
483
  * Score learning assessment for preview
447
484
  *
@@ -5,7 +5,7 @@ class LicenseApi {
5
5
  /**
6
6
  * License service.
7
7
  * @module purecloud-platform-client-v2/api/LicenseApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LocationsApi {
5
5
  /**
6
6
  * Locations service.
7
7
  * @module purecloud-platform-client-v2/api/LocationsApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -0,0 +1,75 @@
1
+ import ApiClient from '../ApiClient.js';
2
+
3
+
4
+ class LogCaptureApi {
5
+ /**
6
+ * LogCapture service.
7
+ * @module purecloud-platform-client-v2/api/LogCaptureApi
8
+ * @version 184.0.0
9
+ */
10
+
11
+ /**
12
+ * Constructs a new LogCaptureApi.
13
+ * @alias module:purecloud-platform-client-v2/api/LogCaptureApi
14
+ * @class
15
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
16
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
17
+ */
18
+ constructor(apiClient) {
19
+ this.apiClient = apiClient || ApiClient.instance;
20
+ }
21
+
22
+
23
+ /**
24
+ * Gets status of async download execution
25
+ *
26
+ * @param {String} jobId Job ID
27
+ */
28
+ getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId) {
29
+ // verify the required parameter 'jobId' is set
30
+ if (jobId === undefined || jobId === null) {
31
+ throw 'Missing the required parameter "jobId" when calling getDiagnosticsLogcaptureBrowserEntriesDownloadJob';
32
+ }
33
+
34
+ return this.apiClient.callApi(
35
+ '/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}',
36
+ 'GET',
37
+ { 'jobId': jobId },
38
+ { },
39
+ { },
40
+ { },
41
+ null,
42
+ ['PureCloud OAuth'],
43
+ ['application/json'],
44
+ ['application/json']
45
+ );
46
+ }
47
+
48
+ /**
49
+ * Creates an async download execution
50
+ *
51
+ * @param {Object} opts Optional parameters
52
+ * @param {Object} opts.body
53
+ */
54
+ postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(opts) {
55
+ opts = opts || {};
56
+
57
+
58
+ return this.apiClient.callApi(
59
+ '/api/v2/diagnostics/logcapture/browser/entries/download/jobs',
60
+ 'POST',
61
+ { },
62
+ { },
63
+ { },
64
+ { },
65
+ opts['body'],
66
+ ['PureCloud OAuth'],
67
+ ['application/json'],
68
+ ['application/json']
69
+ );
70
+ }
71
+
72
+ }
73
+
74
+
75
+ export default LogCaptureApi;
@@ -5,7 +5,7 @@ class MessagingApi {
5
5
  /**
6
6
  * Messaging service.
7
7
  * @module purecloud-platform-client-v2/api/MessagingApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class MobileDevicesApi {
5
5
  /**
6
6
  * MobileDevices service.
7
7
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class NotificationsApi {
5
5
  /**
6
6
  * Notifications service.
7
7
  * @module purecloud-platform-client-v2/api/NotificationsApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OAuthApi {
5
5
  /**
6
6
  * OAuth service.
7
7
  * @module purecloud-platform-client-v2/api/OAuthApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ObjectsApi {
5
5
  /**
6
6
  * Objects service.
7
7
  * @module purecloud-platform-client-v2/api/ObjectsApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -189,17 +189,16 @@ class ObjectsApi {
189
189
  * Recreate a previously deleted division.
190
190
  *
191
191
  * @param {String} divisionId Division ID
192
- * @param {Object} body Recreated division data
192
+ * @param {Object} opts Optional parameters
193
+ * @param {Object} opts.body Recreated division data
193
194
  */
194
- postAuthorizationDivisionRestore(divisionId, body) {
195
+ postAuthorizationDivisionRestore(divisionId, opts) {
196
+ opts = opts || {};
197
+
195
198
  // verify the required parameter 'divisionId' is set
196
199
  if (divisionId === undefined || divisionId === null) {
197
200
  throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
198
201
  }
199
- // verify the required parameter 'body' is set
200
- if (body === undefined || body === null) {
201
- throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
202
- }
203
202
 
204
203
  return this.apiClient.callApi(
205
204
  '/api/v2/authorization/divisions/{divisionId}/restore',
@@ -208,7 +207,7 @@ class ObjectsApi {
208
207
  { },
209
208
  { },
210
209
  { },
211
- body,
210
+ opts['body'],
212
211
  ['PureCloud OAuth'],
213
212
  ['application/json'],
214
213
  ['application/json']
@@ -5,7 +5,7 @@ class OperationalEventsApi {
5
5
  /**
6
6
  * OperationalEvents service.
7
7
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OrganizationApi {
5
5
  /**
6
6
  * Organization service.
7
7
  * @module purecloud-platform-client-v2/api/OrganizationApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
5
5
  /**
6
6
  * OrganizationAuthorization service.
7
7
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
8
- * @version 182.1.0
8
+ * @version 184.0.0
9
9
  */
10
10
 
11
11
  /**