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
@@ -0,0 +1,1286 @@
1
+ import ApiClient from '../ApiClient.js';
2
+
3
+
4
+ class TaskManagementApi {
5
+ /**
6
+ * TaskManagement service.
7
+ * @module purecloud-platform-client-v2/api/TaskManagementApi
8
+ * @version 170.0.0
9
+ */
10
+
11
+ /**
12
+ * Constructs a new TaskManagementApi.
13
+ * @alias module:purecloud-platform-client-v2/api/TaskManagementApi
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
+ * Delete a workbin
25
+ *
26
+ * @param {String} workbinId Workbin ID
27
+ * deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28
+ */
29
+ deleteTaskmanagementWorkbin(workbinId) {
30
+ // verify the required parameter 'workbinId' is set
31
+ if (workbinId === undefined || workbinId === null) {
32
+ throw 'Missing the required parameter "workbinId" when calling deleteTaskmanagementWorkbin';
33
+ }
34
+
35
+ return this.apiClient.callApi(
36
+ '/api/v2/taskmanagement/workbins/{workbinId}',
37
+ 'DELETE',
38
+ { 'workbinId': workbinId },
39
+ { },
40
+ { },
41
+ { },
42
+ null,
43
+ ['PureCloud OAuth'],
44
+ ['application/json'],
45
+ ['application/json']
46
+ );
47
+ }
48
+
49
+ /**
50
+ * Delete a workitem
51
+ *
52
+ * @param {String} workitemId Workitem ID
53
+ * deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
54
+ */
55
+ deleteTaskmanagementWorkitem(workitemId) {
56
+ // verify the required parameter 'workitemId' is set
57
+ if (workitemId === undefined || workitemId === null) {
58
+ throw 'Missing the required parameter "workitemId" when calling deleteTaskmanagementWorkitem';
59
+ }
60
+
61
+ return this.apiClient.callApi(
62
+ '/api/v2/taskmanagement/workitems/{workitemId}',
63
+ 'DELETE',
64
+ { 'workitemId': workitemId },
65
+ { },
66
+ { },
67
+ { },
68
+ null,
69
+ ['PureCloud OAuth'],
70
+ ['application/json'],
71
+ ['application/json']
72
+ );
73
+ }
74
+
75
+ /**
76
+ * Delete a schema
77
+ *
78
+ * @param {String} schemaId Schema ID
79
+ * deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80
+ */
81
+ deleteTaskmanagementWorkitemsSchema(schemaId) {
82
+ // verify the required parameter 'schemaId' is set
83
+ if (schemaId === undefined || schemaId === null) {
84
+ throw 'Missing the required parameter "schemaId" when calling deleteTaskmanagementWorkitemsSchema';
85
+ }
86
+
87
+ return this.apiClient.callApi(
88
+ '/api/v2/taskmanagement/workitems/schemas/{schemaId}',
89
+ 'DELETE',
90
+ { 'schemaId': schemaId },
91
+ { },
92
+ { },
93
+ { },
94
+ null,
95
+ ['PureCloud OAuth'],
96
+ ['application/json'],
97
+ ['application/json']
98
+ );
99
+ }
100
+
101
+ /**
102
+ * Delete a worktype
103
+ *
104
+ * @param {String} worktypeId Worktype id
105
+ * deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
106
+ */
107
+ deleteTaskmanagementWorktype(worktypeId) {
108
+ // verify the required parameter 'worktypeId' is set
109
+ if (worktypeId === undefined || worktypeId === null) {
110
+ throw 'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktype';
111
+ }
112
+
113
+ return this.apiClient.callApi(
114
+ '/api/v2/taskmanagement/worktypes/{worktypeId}',
115
+ 'DELETE',
116
+ { 'worktypeId': worktypeId },
117
+ { },
118
+ { },
119
+ { },
120
+ null,
121
+ ['PureCloud OAuth'],
122
+ ['application/json'],
123
+ ['application/json']
124
+ );
125
+ }
126
+
127
+ /**
128
+ * Delete a status
129
+ *
130
+ * @param {String} worktypeId Worktype id
131
+ * @param {String} statusId Status id
132
+ * deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
133
+ */
134
+ deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
135
+ // verify the required parameter 'worktypeId' is set
136
+ if (worktypeId === undefined || worktypeId === null) {
137
+ throw 'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeStatus';
138
+ }
139
+ // verify the required parameter 'statusId' is set
140
+ if (statusId === undefined || statusId === null) {
141
+ throw 'Missing the required parameter "statusId" when calling deleteTaskmanagementWorktypeStatus';
142
+ }
143
+
144
+ return this.apiClient.callApi(
145
+ '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}',
146
+ 'DELETE',
147
+ { 'worktypeId': worktypeId,'statusId': statusId },
148
+ { },
149
+ { },
150
+ { },
151
+ null,
152
+ ['PureCloud OAuth'],
153
+ ['application/json'],
154
+ ['application/json']
155
+ );
156
+ }
157
+
158
+ /**
159
+ * Get a workbin
160
+ *
161
+ * @param {String} workbinId Workbin ID
162
+ * getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
163
+ */
164
+ getTaskmanagementWorkbin(workbinId) {
165
+ // verify the required parameter 'workbinId' is set
166
+ if (workbinId === undefined || workbinId === null) {
167
+ throw 'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbin';
168
+ }
169
+
170
+ return this.apiClient.callApi(
171
+ '/api/v2/taskmanagement/workbins/{workbinId}',
172
+ 'GET',
173
+ { 'workbinId': workbinId },
174
+ { },
175
+ { },
176
+ { },
177
+ null,
178
+ ['PureCloud OAuth'],
179
+ ['application/json'],
180
+ ['application/json']
181
+ );
182
+ }
183
+
184
+ /**
185
+ * Get a listing of a workbin's attribute change history
186
+ *
187
+ * @param {String} workbinId Workbin ID
188
+ * @param {Object} opts Optional parameters
189
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
190
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
191
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
192
+ * getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
193
+ */
194
+ getTaskmanagementWorkbinHistory(workbinId, opts) {
195
+ opts = opts || {};
196
+
197
+ // verify the required parameter 'workbinId' is set
198
+ if (workbinId === undefined || workbinId === null) {
199
+ throw 'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinHistory';
200
+ }
201
+
202
+ return this.apiClient.callApi(
203
+ '/api/v2/taskmanagement/workbins/{workbinId}/history',
204
+ 'GET',
205
+ { 'workbinId': workbinId },
206
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
207
+ { },
208
+ { },
209
+ null,
210
+ ['PureCloud OAuth'],
211
+ ['application/json'],
212
+ ['application/json']
213
+ );
214
+ }
215
+
216
+ /**
217
+ * Get a version of a workbin
218
+ *
219
+ * @param {String} workbinId Workbin ID
220
+ * @param {Number} entityVersion Workbin version
221
+ * getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
222
+ */
223
+ getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
224
+ // verify the required parameter 'workbinId' is set
225
+ if (workbinId === undefined || workbinId === null) {
226
+ throw 'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinVersion';
227
+ }
228
+ // verify the required parameter 'entityVersion' is set
229
+ if (entityVersion === undefined || entityVersion === null) {
230
+ throw 'Missing the required parameter "entityVersion" when calling getTaskmanagementWorkbinVersion';
231
+ }
232
+
233
+ return this.apiClient.callApi(
234
+ '/api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion}',
235
+ 'GET',
236
+ { 'workbinId': workbinId,'entityVersion': entityVersion },
237
+ { },
238
+ { },
239
+ { },
240
+ null,
241
+ ['PureCloud OAuth'],
242
+ ['application/json'],
243
+ ['application/json']
244
+ );
245
+ }
246
+
247
+ /**
248
+ * Get all versions of a workbin
249
+ *
250
+ * @param {String} workbinId Workbin ID
251
+ * @param {Object} opts Optional parameters
252
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
253
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
254
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
255
+ * getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
256
+ */
257
+ getTaskmanagementWorkbinVersions(workbinId, opts) {
258
+ opts = opts || {};
259
+
260
+ // verify the required parameter 'workbinId' is set
261
+ if (workbinId === undefined || workbinId === null) {
262
+ throw 'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinVersions';
263
+ }
264
+
265
+ return this.apiClient.callApi(
266
+ '/api/v2/taskmanagement/workbins/{workbinId}/versions',
267
+ 'GET',
268
+ { 'workbinId': workbinId },
269
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
270
+ { },
271
+ { },
272
+ null,
273
+ ['PureCloud OAuth'],
274
+ ['application/json'],
275
+ ['application/json']
276
+ );
277
+ }
278
+
279
+ /**
280
+ * Get a workitem
281
+ *
282
+ * @param {String} workitemId Workitem ID
283
+ * @param {Object} opts Optional parameters
284
+ * @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
285
+ * getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
286
+ */
287
+ getTaskmanagementWorkitem(workitemId, opts) {
288
+ opts = opts || {};
289
+
290
+ // verify the required parameter 'workitemId' is set
291
+ if (workitemId === undefined || workitemId === null) {
292
+ throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitem';
293
+ }
294
+
295
+ return this.apiClient.callApi(
296
+ '/api/v2/taskmanagement/workitems/{workitemId}',
297
+ 'GET',
298
+ { 'workitemId': workitemId },
299
+ { 'expands': opts['expands'] },
300
+ { },
301
+ { },
302
+ null,
303
+ ['PureCloud OAuth'],
304
+ ['application/json'],
305
+ ['application/json']
306
+ );
307
+ }
308
+
309
+ /**
310
+ * Get a listing of a workitem's attribute change history
311
+ *
312
+ * @param {String} workitemId Workitem ID
313
+ * @param {Object} opts Optional parameters
314
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
315
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
316
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
317
+ * getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
318
+ */
319
+ getTaskmanagementWorkitemHistory(workitemId, opts) {
320
+ opts = opts || {};
321
+
322
+ // verify the required parameter 'workitemId' is set
323
+ if (workitemId === undefined || workitemId === null) {
324
+ throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemHistory';
325
+ }
326
+
327
+ return this.apiClient.callApi(
328
+ '/api/v2/taskmanagement/workitems/{workitemId}/history',
329
+ 'GET',
330
+ { 'workitemId': workitemId },
331
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
332
+ { },
333
+ { },
334
+ null,
335
+ ['PureCloud OAuth'],
336
+ ['application/json'],
337
+ ['application/json']
338
+ );
339
+ }
340
+
341
+ /**
342
+ * Get all wrapup codes added for the given user for a workitem.
343
+ *
344
+ * @param {String} workitemId The ID of the Workitem.
345
+ * @param {String} userId The ID of the user
346
+ * @param {Object} opts Optional parameters
347
+ * @param {Object} opts.expands Which fields, if any, to expand.
348
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
349
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (default to 25)
350
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
351
+ * getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
352
+ */
353
+ getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
354
+ opts = opts || {};
355
+
356
+ // verify the required parameter 'workitemId' is set
357
+ if (workitemId === undefined || workitemId === null) {
358
+ throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemUserWrapups';
359
+ }
360
+ // verify the required parameter 'userId' is set
361
+ if (userId === undefined || userId === null) {
362
+ throw 'Missing the required parameter "userId" when calling getTaskmanagementWorkitemUserWrapups';
363
+ }
364
+
365
+ return this.apiClient.callApi(
366
+ '/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups',
367
+ 'GET',
368
+ { 'workitemId': workitemId,'userId': userId },
369
+ { 'expands': opts['expands'],'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
370
+ { },
371
+ { },
372
+ null,
373
+ ['PureCloud OAuth'],
374
+ ['application/json'],
375
+ ['application/json']
376
+ );
377
+ }
378
+
379
+ /**
380
+ * Get a version of a workitem
381
+ *
382
+ * @param {String} workitemId Workitem ID
383
+ * @param {Number} entityVersion Workitem version
384
+ * getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
385
+ */
386
+ getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
387
+ // verify the required parameter 'workitemId' is set
388
+ if (workitemId === undefined || workitemId === null) {
389
+ throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemVersion';
390
+ }
391
+ // verify the required parameter 'entityVersion' is set
392
+ if (entityVersion === undefined || entityVersion === null) {
393
+ throw 'Missing the required parameter "entityVersion" when calling getTaskmanagementWorkitemVersion';
394
+ }
395
+
396
+ return this.apiClient.callApi(
397
+ '/api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion}',
398
+ 'GET',
399
+ { 'workitemId': workitemId,'entityVersion': entityVersion },
400
+ { },
401
+ { },
402
+ { },
403
+ null,
404
+ ['PureCloud OAuth'],
405
+ ['application/json'],
406
+ ['application/json']
407
+ );
408
+ }
409
+
410
+ /**
411
+ * Get all versions of a workitem
412
+ *
413
+ * @param {String} workitemId Workitem ID
414
+ * @param {Object} opts Optional parameters
415
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
416
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
417
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
418
+ * getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
419
+ */
420
+ getTaskmanagementWorkitemVersions(workitemId, opts) {
421
+ opts = opts || {};
422
+
423
+ // verify the required parameter 'workitemId' is set
424
+ if (workitemId === undefined || workitemId === null) {
425
+ throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemVersions';
426
+ }
427
+
428
+ return this.apiClient.callApi(
429
+ '/api/v2/taskmanagement/workitems/{workitemId}/versions',
430
+ 'GET',
431
+ { 'workitemId': workitemId },
432
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
433
+ { },
434
+ { },
435
+ null,
436
+ ['PureCloud OAuth'],
437
+ ['application/json'],
438
+ ['application/json']
439
+ );
440
+ }
441
+
442
+ /**
443
+ * Get all wrapup codes added for all users for a workitem.
444
+ *
445
+ * @param {String} workitemId The ID of the Workitem.
446
+ * @param {Object} opts Optional parameters
447
+ * @param {Object} opts.expands Which fields, if any, to expand.
448
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
449
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (default to 25)
450
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
451
+ * getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
452
+ */
453
+ getTaskmanagementWorkitemWrapups(workitemId, opts) {
454
+ opts = opts || {};
455
+
456
+ // verify the required parameter 'workitemId' is set
457
+ if (workitemId === undefined || workitemId === null) {
458
+ throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemWrapups';
459
+ }
460
+
461
+ return this.apiClient.callApi(
462
+ '/api/v2/taskmanagement/workitems/{workitemId}/wrapups',
463
+ 'GET',
464
+ { 'workitemId': workitemId },
465
+ { 'expands': opts['expands'],'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
466
+ { },
467
+ { },
468
+ null,
469
+ ['PureCloud OAuth'],
470
+ ['application/json'],
471
+ ['application/json']
472
+ );
473
+ }
474
+
475
+ /**
476
+ * Get a schema
477
+ *
478
+ * @param {String} schemaId Schema ID
479
+ * getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
480
+ */
481
+ getTaskmanagementWorkitemsSchema(schemaId) {
482
+ // verify the required parameter 'schemaId' is set
483
+ if (schemaId === undefined || schemaId === null) {
484
+ throw 'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchema';
485
+ }
486
+
487
+ return this.apiClient.callApi(
488
+ '/api/v2/taskmanagement/workitems/schemas/{schemaId}',
489
+ 'GET',
490
+ { 'schemaId': schemaId },
491
+ { },
492
+ { },
493
+ { },
494
+ null,
495
+ ['PureCloud OAuth'],
496
+ ['application/json'],
497
+ ['application/json']
498
+ );
499
+ }
500
+
501
+ /**
502
+ * Get a specific version of a schema
503
+ *
504
+ * @param {String} schemaId Schema ID
505
+ * @param {String} versionId Schema version
506
+ * getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
507
+ */
508
+ getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
509
+ // verify the required parameter 'schemaId' is set
510
+ if (schemaId === undefined || schemaId === null) {
511
+ throw 'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchemaVersion';
512
+ }
513
+ // verify the required parameter 'versionId' is set
514
+ if (versionId === undefined || versionId === null) {
515
+ throw 'Missing the required parameter "versionId" when calling getTaskmanagementWorkitemsSchemaVersion';
516
+ }
517
+
518
+ return this.apiClient.callApi(
519
+ '/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId}',
520
+ 'GET',
521
+ { 'schemaId': schemaId,'versionId': versionId },
522
+ { },
523
+ { },
524
+ { },
525
+ null,
526
+ ['PureCloud OAuth'],
527
+ ['application/json'],
528
+ ['application/json']
529
+ );
530
+ }
531
+
532
+ /**
533
+ * Get all versions of a schema
534
+ *
535
+ * @param {String} schemaId Schema ID
536
+ * getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
537
+ */
538
+ getTaskmanagementWorkitemsSchemaVersions(schemaId) {
539
+ // verify the required parameter 'schemaId' is set
540
+ if (schemaId === undefined || schemaId === null) {
541
+ throw 'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchemaVersions';
542
+ }
543
+
544
+ return this.apiClient.callApi(
545
+ '/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions',
546
+ 'GET',
547
+ { 'schemaId': schemaId },
548
+ { },
549
+ { },
550
+ { },
551
+ null,
552
+ ['PureCloud OAuth'],
553
+ ['application/json'],
554
+ ['application/json']
555
+ );
556
+ }
557
+
558
+ /**
559
+ * Get a list of schemas.
560
+ *
561
+ * getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
562
+ */
563
+ getTaskmanagementWorkitemsSchemas() {
564
+
565
+ return this.apiClient.callApi(
566
+ '/api/v2/taskmanagement/workitems/schemas',
567
+ 'GET',
568
+ { },
569
+ { },
570
+ { },
571
+ { },
572
+ null,
573
+ ['PureCloud OAuth'],
574
+ ['application/json'],
575
+ ['application/json']
576
+ );
577
+ }
578
+
579
+ /**
580
+ * Get a worktype
581
+ *
582
+ * @param {String} worktypeId Worktype id
583
+ * @param {Object} opts Optional parameters
584
+ * @param {Array.<String>} opts.expands Which fields, if any, to expand.
585
+ * getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
586
+ */
587
+ getTaskmanagementWorktype(worktypeId, opts) {
588
+ opts = opts || {};
589
+
590
+ // verify the required parameter 'worktypeId' is set
591
+ if (worktypeId === undefined || worktypeId === null) {
592
+ throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktype';
593
+ }
594
+
595
+ return this.apiClient.callApi(
596
+ '/api/v2/taskmanagement/worktypes/{worktypeId}',
597
+ 'GET',
598
+ { 'worktypeId': worktypeId },
599
+ { 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
600
+ { },
601
+ { },
602
+ null,
603
+ ['PureCloud OAuth'],
604
+ ['application/json'],
605
+ ['application/json']
606
+ );
607
+ }
608
+
609
+ /**
610
+ * Get a listing of a worktype's attribute change history
611
+ *
612
+ * @param {String} worktypeId Worktype id
613
+ * @param {Object} opts Optional parameters
614
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
615
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
616
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
617
+ * getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
618
+ */
619
+ getTaskmanagementWorktypeHistory(worktypeId, opts) {
620
+ opts = opts || {};
621
+
622
+ // verify the required parameter 'worktypeId' is set
623
+ if (worktypeId === undefined || worktypeId === null) {
624
+ throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeHistory';
625
+ }
626
+
627
+ return this.apiClient.callApi(
628
+ '/api/v2/taskmanagement/worktypes/{worktypeId}/history',
629
+ 'GET',
630
+ { 'worktypeId': worktypeId },
631
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
632
+ { },
633
+ { },
634
+ null,
635
+ ['PureCloud OAuth'],
636
+ ['application/json'],
637
+ ['application/json']
638
+ );
639
+ }
640
+
641
+ /**
642
+ * Get a status
643
+ *
644
+ * @param {String} worktypeId Worktype id
645
+ * @param {String} statusId Status id
646
+ * getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
647
+ */
648
+ getTaskmanagementWorktypeStatus(worktypeId, statusId) {
649
+ // verify the required parameter 'worktypeId' is set
650
+ if (worktypeId === undefined || worktypeId === null) {
651
+ throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeStatus';
652
+ }
653
+ // verify the required parameter 'statusId' is set
654
+ if (statusId === undefined || statusId === null) {
655
+ throw 'Missing the required parameter "statusId" when calling getTaskmanagementWorktypeStatus';
656
+ }
657
+
658
+ return this.apiClient.callApi(
659
+ '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}',
660
+ 'GET',
661
+ { 'worktypeId': worktypeId,'statusId': statusId },
662
+ { },
663
+ { },
664
+ { },
665
+ null,
666
+ ['PureCloud OAuth'],
667
+ ['application/json'],
668
+ ['application/json']
669
+ );
670
+ }
671
+
672
+ /**
673
+ * Get a version of a worktype
674
+ *
675
+ * @param {String} worktypeId Worktype id
676
+ * @param {Number} entityVersion Worktype version
677
+ * getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
678
+ */
679
+ getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
680
+ // verify the required parameter 'worktypeId' is set
681
+ if (worktypeId === undefined || worktypeId === null) {
682
+ throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeVersion';
683
+ }
684
+ // verify the required parameter 'entityVersion' is set
685
+ if (entityVersion === undefined || entityVersion === null) {
686
+ throw 'Missing the required parameter "entityVersion" when calling getTaskmanagementWorktypeVersion';
687
+ }
688
+
689
+ return this.apiClient.callApi(
690
+ '/api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion}',
691
+ 'GET',
692
+ { 'worktypeId': worktypeId,'entityVersion': entityVersion },
693
+ { },
694
+ { },
695
+ { },
696
+ null,
697
+ ['PureCloud OAuth'],
698
+ ['application/json'],
699
+ ['application/json']
700
+ );
701
+ }
702
+
703
+ /**
704
+ * Get all versions of a worktype
705
+ *
706
+ * @param {String} worktypeId Worktype id
707
+ * @param {Object} opts Optional parameters
708
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
709
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
710
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
711
+ * getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
712
+ */
713
+ getTaskmanagementWorktypeVersions(worktypeId, opts) {
714
+ opts = opts || {};
715
+
716
+ // verify the required parameter 'worktypeId' is set
717
+ if (worktypeId === undefined || worktypeId === null) {
718
+ throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeVersions';
719
+ }
720
+
721
+ return this.apiClient.callApi(
722
+ '/api/v2/taskmanagement/worktypes/{worktypeId}/versions',
723
+ 'GET',
724
+ { 'worktypeId': worktypeId },
725
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
726
+ { },
727
+ { },
728
+ null,
729
+ ['PureCloud OAuth'],
730
+ ['application/json'],
731
+ ['application/json']
732
+ );
733
+ }
734
+
735
+ /**
736
+ * Update the attributes of a workbin
737
+ *
738
+ * @param {String} workbinId Workbin ID
739
+ * @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
740
+ * patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
741
+ */
742
+ patchTaskmanagementWorkbin(workbinId, body) {
743
+ // verify the required parameter 'workbinId' is set
744
+ if (workbinId === undefined || workbinId === null) {
745
+ throw 'Missing the required parameter "workbinId" when calling patchTaskmanagementWorkbin';
746
+ }
747
+ // verify the required parameter 'body' is set
748
+ if (body === undefined || body === null) {
749
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkbin';
750
+ }
751
+
752
+ return this.apiClient.callApi(
753
+ '/api/v2/taskmanagement/workbins/{workbinId}',
754
+ 'PATCH',
755
+ { 'workbinId': workbinId },
756
+ { },
757
+ { },
758
+ { },
759
+ body,
760
+ ['PureCloud OAuth'],
761
+ ['application/json'],
762
+ ['application/json']
763
+ );
764
+ }
765
+
766
+ /**
767
+ * Update the attributes of a workitem
768
+ *
769
+ * @param {String} workitemId Workitem ID
770
+ * @param {Object} body Workitem
771
+ * patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
772
+ */
773
+ patchTaskmanagementWorkitem(workitemId, body) {
774
+ // verify the required parameter 'workitemId' is set
775
+ if (workitemId === undefined || workitemId === null) {
776
+ throw 'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitem';
777
+ }
778
+ // verify the required parameter 'body' is set
779
+ if (body === undefined || body === null) {
780
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitem';
781
+ }
782
+
783
+ return this.apiClient.callApi(
784
+ '/api/v2/taskmanagement/workitems/{workitemId}',
785
+ 'PATCH',
786
+ { 'workitemId': workitemId },
787
+ { },
788
+ { },
789
+ { },
790
+ body,
791
+ ['PureCloud OAuth'],
792
+ ['application/json'],
793
+ ['application/json']
794
+ );
795
+ }
796
+
797
+ /**
798
+ * Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
799
+ *
800
+ * @param {String} workitemId Workitem ID
801
+ * @param {Object} body Targeted user
802
+ * patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
803
+ */
804
+ patchTaskmanagementWorkitemAssignment(workitemId, body) {
805
+ // verify the required parameter 'workitemId' is set
806
+ if (workitemId === undefined || workitemId === null) {
807
+ throw 'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemAssignment';
808
+ }
809
+ // verify the required parameter 'body' is set
810
+ if (body === undefined || body === null) {
811
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemAssignment';
812
+ }
813
+
814
+ return this.apiClient.callApi(
815
+ '/api/v2/taskmanagement/workitems/{workitemId}/assignment',
816
+ 'PATCH',
817
+ { 'workitemId': workitemId },
818
+ { },
819
+ { },
820
+ { },
821
+ body,
822
+ ['PureCloud OAuth'],
823
+ ['application/json'],
824
+ ['application/json']
825
+ );
826
+ }
827
+
828
+ /**
829
+ * Add/Remove a wrapup code for a given user in a workitem.
830
+ *
831
+ * @param {String} workitemId The ID of the Workitem.
832
+ * @param {String} userId The ID of the user
833
+ * @param {Object} body Request body to add/remove a wrapup code for a workitem
834
+ * patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
835
+ */
836
+ patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
837
+ // verify the required parameter 'workitemId' is set
838
+ if (workitemId === undefined || workitemId === null) {
839
+ throw 'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemUserWrapups';
840
+ }
841
+ // verify the required parameter 'userId' is set
842
+ if (userId === undefined || userId === null) {
843
+ throw 'Missing the required parameter "userId" when calling patchTaskmanagementWorkitemUserWrapups';
844
+ }
845
+ // verify the required parameter 'body' is set
846
+ if (body === undefined || body === null) {
847
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemUserWrapups';
848
+ }
849
+
850
+ return this.apiClient.callApi(
851
+ '/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups',
852
+ 'PATCH',
853
+ { 'workitemId': workitemId,'userId': userId },
854
+ { },
855
+ { },
856
+ { },
857
+ body,
858
+ ['PureCloud OAuth'],
859
+ ['application/json'],
860
+ ['application/json']
861
+ );
862
+ }
863
+
864
+ /**
865
+ * Add/Remove a wrapup code for the current user in a workitem.
866
+ *
867
+ * @param {String} workitemId The ID of the Workitem.
868
+ * @param {Object} body Request body to add/remove the wrapup code for workitem
869
+ * patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
870
+ */
871
+ patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
872
+ // verify the required parameter 'workitemId' is set
873
+ if (workitemId === undefined || workitemId === null) {
874
+ throw 'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemUsersMeWrapups';
875
+ }
876
+ // verify the required parameter 'body' is set
877
+ if (body === undefined || body === null) {
878
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemUsersMeWrapups';
879
+ }
880
+
881
+ return this.apiClient.callApi(
882
+ '/api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups',
883
+ 'PATCH',
884
+ { 'workitemId': workitemId },
885
+ { },
886
+ { },
887
+ { },
888
+ body,
889
+ ['PureCloud OAuth'],
890
+ ['application/json'],
891
+ ['application/json']
892
+ );
893
+ }
894
+
895
+ /**
896
+ * Update the attributes of a worktype
897
+ *
898
+ * @param {String} worktypeId Worktype id
899
+ * @param {Object} opts Optional parameters
900
+ * @param {Object} opts.body body
901
+ * patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
902
+ */
903
+ patchTaskmanagementWorktype(worktypeId, opts) {
904
+ opts = opts || {};
905
+
906
+ // verify the required parameter 'worktypeId' is set
907
+ if (worktypeId === undefined || worktypeId === null) {
908
+ throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';
909
+ }
910
+
911
+ return this.apiClient.callApi(
912
+ '/api/v2/taskmanagement/worktypes/{worktypeId}',
913
+ 'PATCH',
914
+ { 'worktypeId': worktypeId },
915
+ { },
916
+ { },
917
+ { },
918
+ opts['body'],
919
+ ['PureCloud OAuth'],
920
+ ['application/json'],
921
+ ['application/json']
922
+ );
923
+ }
924
+
925
+ /**
926
+ * Update the attributes of a status
927
+ *
928
+ * @param {String} worktypeId Worktype id
929
+ * @param {String} statusId Status id
930
+ * @param {Object} opts Optional parameters
931
+ * @param {Object} opts.body body
932
+ * patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
933
+ */
934
+ patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
935
+ opts = opts || {};
936
+
937
+ // verify the required parameter 'worktypeId' is set
938
+ if (worktypeId === undefined || worktypeId === null) {
939
+ throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeStatus';
940
+ }
941
+ // verify the required parameter 'statusId' is set
942
+ if (statusId === undefined || statusId === null) {
943
+ throw 'Missing the required parameter "statusId" when calling patchTaskmanagementWorktypeStatus';
944
+ }
945
+
946
+ return this.apiClient.callApi(
947
+ '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}',
948
+ 'PATCH',
949
+ { 'worktypeId': worktypeId,'statusId': statusId },
950
+ { },
951
+ { },
952
+ { },
953
+ opts['body'],
954
+ ['PureCloud OAuth'],
955
+ ['application/json'],
956
+ ['application/json']
957
+ );
958
+ }
959
+
960
+ /**
961
+ * Create a workbin
962
+ *
963
+ * @param {Object} opts Optional parameters
964
+ * @param {Object} opts.body body
965
+ * postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
966
+ */
967
+ postTaskmanagementWorkbins(opts) {
968
+ opts = opts || {};
969
+
970
+
971
+ return this.apiClient.callApi(
972
+ '/api/v2/taskmanagement/workbins',
973
+ 'POST',
974
+ { },
975
+ { },
976
+ { },
977
+ { },
978
+ opts['body'],
979
+ ['PureCloud OAuth'],
980
+ ['application/json'],
981
+ ['application/json']
982
+ );
983
+ }
984
+
985
+ /**
986
+ * Query for workbins
987
+ *
988
+ * @param {Object} body QueryPostRequest
989
+ * postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
990
+ */
991
+ postTaskmanagementWorkbinsQuery(body) {
992
+ // verify the required parameter 'body' is set
993
+ if (body === undefined || body === null) {
994
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkbinsQuery';
995
+ }
996
+
997
+ return this.apiClient.callApi(
998
+ '/api/v2/taskmanagement/workbins/query',
999
+ 'POST',
1000
+ { },
1001
+ { },
1002
+ { },
1003
+ { },
1004
+ body,
1005
+ ['PureCloud OAuth'],
1006
+ ['application/json'],
1007
+ ['application/json']
1008
+ );
1009
+ }
1010
+
1011
+ /**
1012
+ * Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
1013
+ *
1014
+ * @param {String} workitemId Workitem ID
1015
+ * postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1016
+ */
1017
+ postTaskmanagementWorkitemAcdCancel(workitemId) {
1018
+ // verify the required parameter 'workitemId' is set
1019
+ if (workitemId === undefined || workitemId === null) {
1020
+ throw 'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemAcdCancel';
1021
+ }
1022
+
1023
+ return this.apiClient.callApi(
1024
+ '/api/v2/taskmanagement/workitems/{workitemId}/acd/cancel',
1025
+ 'POST',
1026
+ { 'workitemId': workitemId },
1027
+ { },
1028
+ { },
1029
+ { },
1030
+ null,
1031
+ ['PureCloud OAuth'],
1032
+ ['application/json'],
1033
+ ['application/json']
1034
+ );
1035
+ }
1036
+
1037
+ /**
1038
+ * Disconnect the assignee of the workitem
1039
+ *
1040
+ * @param {String} workitemId Workitem ID
1041
+ * postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1042
+ */
1043
+ postTaskmanagementWorkitemDisconnect(workitemId) {
1044
+ // verify the required parameter 'workitemId' is set
1045
+ if (workitemId === undefined || workitemId === null) {
1046
+ throw 'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemDisconnect';
1047
+ }
1048
+
1049
+ return this.apiClient.callApi(
1050
+ '/api/v2/taskmanagement/workitems/{workitemId}/disconnect',
1051
+ 'POST',
1052
+ { 'workitemId': workitemId },
1053
+ { },
1054
+ { },
1055
+ { },
1056
+ null,
1057
+ ['PureCloud OAuth'],
1058
+ ['application/json'],
1059
+ ['application/json']
1060
+ );
1061
+ }
1062
+
1063
+ /**
1064
+ * Terminate a workitem
1065
+ *
1066
+ * @param {String} workitemId Workitem ID
1067
+ * @param {Object} opts Optional parameters
1068
+ * @param {Object} opts.body Terminated request
1069
+ * postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1070
+ */
1071
+ postTaskmanagementWorkitemTerminate(workitemId, opts) {
1072
+ opts = opts || {};
1073
+
1074
+ // verify the required parameter 'workitemId' is set
1075
+ if (workitemId === undefined || workitemId === null) {
1076
+ throw 'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemTerminate';
1077
+ }
1078
+
1079
+ return this.apiClient.callApi(
1080
+ '/api/v2/taskmanagement/workitems/{workitemId}/terminate',
1081
+ 'POST',
1082
+ { 'workitemId': workitemId },
1083
+ { },
1084
+ { },
1085
+ { },
1086
+ opts['body'],
1087
+ ['PureCloud OAuth'],
1088
+ ['application/json'],
1089
+ ['application/json']
1090
+ );
1091
+ }
1092
+
1093
+ /**
1094
+ * Create a workitem
1095
+ *
1096
+ * @param {Object} body Workitem
1097
+ * postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1098
+ */
1099
+ postTaskmanagementWorkitems(body) {
1100
+ // verify the required parameter 'body' is set
1101
+ if (body === undefined || body === null) {
1102
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitems';
1103
+ }
1104
+
1105
+ return this.apiClient.callApi(
1106
+ '/api/v2/taskmanagement/workitems',
1107
+ 'POST',
1108
+ { },
1109
+ { },
1110
+ { },
1111
+ { },
1112
+ body,
1113
+ ['PureCloud OAuth'],
1114
+ ['application/json'],
1115
+ ['application/json']
1116
+ );
1117
+ }
1118
+
1119
+ /**
1120
+ * Query for workitems
1121
+ * This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
1122
+ * @param {Object} body WorkitemQueryPostRequest
1123
+ * postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1124
+ */
1125
+ postTaskmanagementWorkitemsQuery(body) {
1126
+ // verify the required parameter 'body' is set
1127
+ if (body === undefined || body === null) {
1128
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQuery';
1129
+ }
1130
+
1131
+ return this.apiClient.callApi(
1132
+ '/api/v2/taskmanagement/workitems/query',
1133
+ 'POST',
1134
+ { },
1135
+ { },
1136
+ { },
1137
+ { },
1138
+ body,
1139
+ ['PureCloud OAuth'],
1140
+ ['application/json'],
1141
+ ['application/json']
1142
+ );
1143
+ }
1144
+
1145
+ /**
1146
+ * Create a schema
1147
+ *
1148
+ * @param {Object} body Schema
1149
+ * postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1150
+ */
1151
+ postTaskmanagementWorkitemsSchemas(body) {
1152
+ // verify the required parameter 'body' is set
1153
+ if (body === undefined || body === null) {
1154
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsSchemas';
1155
+ }
1156
+
1157
+ return this.apiClient.callApi(
1158
+ '/api/v2/taskmanagement/workitems/schemas',
1159
+ 'POST',
1160
+ { },
1161
+ { },
1162
+ { },
1163
+ { },
1164
+ body,
1165
+ ['PureCloud OAuth'],
1166
+ ['application/json'],
1167
+ ['application/json']
1168
+ );
1169
+ }
1170
+
1171
+ /**
1172
+ * Add a status to a worktype
1173
+ *
1174
+ * @param {String} worktypeId Worktype id
1175
+ * @param {Object} opts Optional parameters
1176
+ * @param {Object} opts.body body
1177
+ * postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1178
+ */
1179
+ postTaskmanagementWorktypeStatuses(worktypeId, opts) {
1180
+ opts = opts || {};
1181
+
1182
+ // verify the required parameter 'worktypeId' is set
1183
+ if (worktypeId === undefined || worktypeId === null) {
1184
+ throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeStatuses';
1185
+ }
1186
+
1187
+ return this.apiClient.callApi(
1188
+ '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses',
1189
+ 'POST',
1190
+ { 'worktypeId': worktypeId },
1191
+ { },
1192
+ { },
1193
+ { },
1194
+ opts['body'],
1195
+ ['PureCloud OAuth'],
1196
+ ['application/json'],
1197
+ ['application/json']
1198
+ );
1199
+ }
1200
+
1201
+ /**
1202
+ * Create a worktype
1203
+ *
1204
+ * @param {Object} opts Optional parameters
1205
+ * @param {Object} opts.body body
1206
+ * postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1207
+ */
1208
+ postTaskmanagementWorktypes(opts) {
1209
+ opts = opts || {};
1210
+
1211
+
1212
+ return this.apiClient.callApi(
1213
+ '/api/v2/taskmanagement/worktypes',
1214
+ 'POST',
1215
+ { },
1216
+ { },
1217
+ { },
1218
+ { },
1219
+ opts['body'],
1220
+ ['PureCloud OAuth'],
1221
+ ['application/json'],
1222
+ ['application/json']
1223
+ );
1224
+ }
1225
+
1226
+ /**
1227
+ * Query for worktypes
1228
+ *
1229
+ * @param {Object} body QueryPostRequest
1230
+ * postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1231
+ */
1232
+ postTaskmanagementWorktypesQuery(body) {
1233
+ // verify the required parameter 'body' is set
1234
+ if (body === undefined || body === null) {
1235
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypesQuery';
1236
+ }
1237
+
1238
+ return this.apiClient.callApi(
1239
+ '/api/v2/taskmanagement/worktypes/query',
1240
+ 'POST',
1241
+ { },
1242
+ { },
1243
+ { },
1244
+ { },
1245
+ body,
1246
+ ['PureCloud OAuth'],
1247
+ ['application/json'],
1248
+ ['application/json']
1249
+ );
1250
+ }
1251
+
1252
+ /**
1253
+ * Update a schema
1254
+ *
1255
+ * @param {String} schemaId Schema ID
1256
+ * @param {Object} body Data Schema
1257
+ * putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1258
+ */
1259
+ putTaskmanagementWorkitemsSchema(schemaId, body) {
1260
+ // verify the required parameter 'schemaId' is set
1261
+ if (schemaId === undefined || schemaId === null) {
1262
+ throw 'Missing the required parameter "schemaId" when calling putTaskmanagementWorkitemsSchema';
1263
+ }
1264
+ // verify the required parameter 'body' is set
1265
+ if (body === undefined || body === null) {
1266
+ throw 'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';
1267
+ }
1268
+
1269
+ return this.apiClient.callApi(
1270
+ '/api/v2/taskmanagement/workitems/schemas/{schemaId}',
1271
+ 'PUT',
1272
+ { 'schemaId': schemaId },
1273
+ { },
1274
+ { },
1275
+ { },
1276
+ body,
1277
+ ['PureCloud OAuth'],
1278
+ ['application/json'],
1279
+ ['application/json']
1280
+ );
1281
+ }
1282
+
1283
+ }
1284
+
1285
+
1286
+ export default TaskManagementApi;