purecloud-platform-client-v2 169.0.0 → 170.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 (80) hide show
  1. package/README.md +6 -4
  2. package/dist/node/purecloud-platform-client-v2.js +25367 -20288
  3. package/dist/web-amd/purecloud-platform-client-v2.js +25367 -20288
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +25367 -20288
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +25367 -20288
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +2519 -31
  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 +1418 -227
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +142 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
  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 +4 -4
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +526 -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/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +114 -1
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +114 -4
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +363 -1
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +224 -1
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +200 -22
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +53 -1
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +189 -1
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +174 -10
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +199 -6
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +80 -2
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1286 -0
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +32 -1
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +34 -3
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +47 -1
  69. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsersApi.js +172 -7
  73. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
  76. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
  80. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class FlowsApi {
5
5
  /**
6
6
  * Flows service.
7
7
  * @module purecloud-platform-client-v2/api/FlowsApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -20,6 +20,119 @@ class FlowsApi {
20
20
  }
21
21
 
22
22
 
23
+ /**
24
+ * Get status for async query for Flow aggregates
25
+ *
26
+ * @param {String} jobId jobId
27
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28
+ */
29
+ getAnalyticsFlowsAggregatesJob(jobId) {
30
+ // verify the required parameter 'jobId' is set
31
+ if (jobId === undefined || jobId === null) {
32
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';
33
+ }
34
+
35
+ return this.apiClient.callApi(
36
+ '/api/v2/analytics/flows/aggregates/jobs/{jobId}',
37
+ 'GET',
38
+ { 'jobId': jobId },
39
+ { },
40
+ { },
41
+ { },
42
+ null,
43
+ ['PureCloud OAuth'],
44
+ ['application/json'],
45
+ ['application/json']
46
+ );
47
+ }
48
+
49
+ /**
50
+ * Fetch a page of results for an async aggregates query
51
+ *
52
+ * @param {String} jobId jobId
53
+ * @param {Object} opts Optional parameters
54
+ * @param {String} opts.cursor Cursor token to retrieve next page
55
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
56
+ */
57
+ getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
58
+ opts = opts || {};
59
+
60
+ // verify the required parameter 'jobId' is set
61
+ if (jobId === undefined || jobId === null) {
62
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJobResults';
63
+ }
64
+
65
+ return this.apiClient.callApi(
66
+ '/api/v2/analytics/flows/aggregates/jobs/{jobId}/results',
67
+ 'GET',
68
+ { 'jobId': jobId },
69
+ { 'cursor': opts['cursor'] },
70
+ { },
71
+ { },
72
+ null,
73
+ ['PureCloud OAuth'],
74
+ ['application/json'],
75
+ ['application/json']
76
+ );
77
+ }
78
+
79
+ /**
80
+ * Query for flow activity observations
81
+ *
82
+ * @param {Object} body query
83
+ * @param {Object} opts Optional parameters
84
+ * @param {Number} opts.pageSize The desired page size
85
+ * @param {Number} opts.pageNumber The desired page number
86
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
87
+ */
88
+ postAnalyticsFlowsActivityQuery(body, opts) {
89
+ opts = opts || {};
90
+
91
+ // verify the required parameter 'body' is set
92
+ if (body === undefined || body === null) {
93
+ throw 'Missing the required parameter "body" when calling postAnalyticsFlowsActivityQuery';
94
+ }
95
+
96
+ return this.apiClient.callApi(
97
+ '/api/v2/analytics/flows/activity/query',
98
+ 'POST',
99
+ { },
100
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
101
+ { },
102
+ { },
103
+ body,
104
+ ['PureCloud OAuth'],
105
+ ['application/json'],
106
+ ['application/json']
107
+ );
108
+ }
109
+
110
+ /**
111
+ * Query for flow aggregates asynchronously
112
+ *
113
+ * @param {Object} body query
114
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
115
+ */
116
+ postAnalyticsFlowsAggregatesJobs(body) {
117
+ // verify the required parameter 'body' is set
118
+ if (body === undefined || body === null) {
119
+ throw 'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';
120
+ }
121
+
122
+ return this.apiClient.callApi(
123
+ '/api/v2/analytics/flows/aggregates/jobs',
124
+ 'POST',
125
+ { },
126
+ { },
127
+ { },
128
+ { },
129
+ body,
130
+ ['PureCloud OAuth'],
131
+ ['application/json'],
132
+ ['application/json']
133
+ );
134
+ }
135
+
23
136
  /**
24
137
  * Query for flow aggregates
25
138
  *
@@ -5,7 +5,7 @@ class GamificationApi {
5
5
  /**
6
6
  * Gamification service.
7
7
  * @module purecloud-platform-client-v2/api/GamificationApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
5
5
  /**
6
6
  * GeneralDataProtectionRegulation service.
7
7
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
8
- * @version 169.0.0
8
+ * @version 170.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 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GreetingsApi {
5
5
  /**
6
6
  * Greetings service.
7
7
  * @module purecloud-platform-client-v2/api/GreetingsApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GroupsApi {
5
5
  /**
6
6
  * Groups service.
7
7
  * @module purecloud-platform-client-v2/api/GroupsApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -45,6 +45,32 @@ class GroupsApi {
45
45
  );
46
46
  }
47
47
 
48
+ /**
49
+ * Remove dynamic group definition
50
+ *
51
+ * @param {String} groupId Group ID
52
+ * deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53
+ */
54
+ deleteGroupDynamicsettings(groupId) {
55
+ // verify the required parameter 'groupId' is set
56
+ if (groupId === undefined || groupId === null) {
57
+ throw 'Missing the required parameter "groupId" when calling deleteGroupDynamicsettings';
58
+ }
59
+
60
+ return this.apiClient.callApi(
61
+ '/api/v2/groups/{groupId}/dynamicsettings',
62
+ 'DELETE',
63
+ { 'groupId': groupId },
64
+ { },
65
+ { },
66
+ { },
67
+ null,
68
+ ['PureCloud OAuth'],
69
+ ['application/json'],
70
+ ['application/json']
71
+ );
72
+ }
73
+
48
74
  /**
49
75
  * Remove members
50
76
  *
@@ -79,7 +105,7 @@ class GroupsApi {
79
105
  * Fetch field config for an entity type
80
106
  *
81
107
  * @param {Object} type Field type
82
- * @deprecated
108
+ * @deprecated
83
109
  */
84
110
  getFieldconfig(type) {
85
111
  // verify the required parameter 'type' is set
@@ -126,6 +152,32 @@ class GroupsApi {
126
152
  );
127
153
  }
128
154
 
155
+ /**
156
+ * Get dynamic group definition
157
+ *
158
+ * @param {String} groupId Group ID
159
+ * getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
160
+ */
161
+ getGroupDynamicsettings(groupId) {
162
+ // verify the required parameter 'groupId' is set
163
+ if (groupId === undefined || groupId === null) {
164
+ throw 'Missing the required parameter "groupId" when calling getGroupDynamicsettings';
165
+ }
166
+
167
+ return this.apiClient.callApi(
168
+ '/api/v2/groups/{groupId}/dynamicsettings',
169
+ 'GET',
170
+ { 'groupId': groupId },
171
+ { },
172
+ { },
173
+ { },
174
+ null,
175
+ ['PureCloud OAuth'],
176
+ ['application/json'],
177
+ ['application/json']
178
+ );
179
+ }
180
+
129
181
  /**
130
182
  * Get all individuals associated with the group
131
183
  *
@@ -189,7 +241,7 @@ class GroupsApi {
189
241
  * @param {String} groupId groupId
190
242
  * @param {Object} opts Optional parameters
191
243
  * @param {String} opts.fields Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
192
- * @deprecated
244
+ * @deprecated
193
245
  */
194
246
  getGroupProfile(groupId, opts) {
195
247
  opts = opts || {};
@@ -279,7 +331,7 @@ class GroupsApi {
279
331
  * @param {Array.<String>} opts.id id
280
332
  * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
281
333
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
282
- * @deprecated
334
+ * @deprecated
283
335
  */
284
336
  getProfilesGroups(opts) {
285
337
  opts = opts || {};
@@ -354,6 +406,33 @@ class GroupsApi {
354
406
  );
355
407
  }
356
408
 
409
+ /**
410
+ * Preview the number of users selected for a dynamic group definition query
411
+ *
412
+ * @param {Object} body Group query to preview
413
+ * @deprecated
414
+ * postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
415
+ */
416
+ postGroupsDynamicsettingsPreview(body) {
417
+ // verify the required parameter 'body' is set
418
+ if (body === undefined || body === null) {
419
+ throw 'Missing the required parameter "body" when calling postGroupsDynamicsettingsPreview';
420
+ }
421
+
422
+ return this.apiClient.callApi(
423
+ '/api/v2/groups/dynamicsettings/preview',
424
+ 'POST',
425
+ { },
426
+ { },
427
+ { },
428
+ { },
429
+ body,
430
+ ['PureCloud OAuth'],
431
+ ['application/json'],
432
+ ['application/json']
433
+ );
434
+ }
435
+
357
436
  /**
358
437
  * Search groups
359
438
  *
@@ -408,6 +487,37 @@ class GroupsApi {
408
487
  );
409
488
  }
410
489
 
490
+ /**
491
+ * Create / Update dynamic group definition
492
+ *
493
+ * @param {String} groupId Group ID
494
+ * @param {Object} body Create/Update dynamic groups
495
+ * putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
496
+ */
497
+ putGroupDynamicsettings(groupId, body) {
498
+ // verify the required parameter 'groupId' is set
499
+ if (groupId === undefined || groupId === null) {
500
+ throw 'Missing the required parameter "groupId" when calling putGroupDynamicsettings';
501
+ }
502
+ // verify the required parameter 'body' is set
503
+ if (body === undefined || body === null) {
504
+ throw 'Missing the required parameter "body" when calling putGroupDynamicsettings';
505
+ }
506
+
507
+ return this.apiClient.callApi(
508
+ '/api/v2/groups/{groupId}/dynamicsettings',
509
+ 'PUT',
510
+ { 'groupId': groupId },
511
+ { },
512
+ { },
513
+ { },
514
+ body,
515
+ ['PureCloud OAuth'],
516
+ ['application/json'],
517
+ ['application/json']
518
+ );
519
+ }
520
+
411
521
  }
412
522
 
413
523
 
@@ -5,7 +5,7 @@ class IdentityProviderApi {
5
5
  /**
6
6
  * IdentityProvider service.
7
7
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
5
5
  /**
6
6
  * InfrastructureAsCode service.
7
7
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**