purecloud-platform-client-v2 96.0.0 → 99.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 (67) hide show
  1. package/README.md +3 -2
  2. package/dist/node/purecloud-platform-client-v2.js +263 -68
  3. package/dist/web-amd/purecloud-platform-client-v2.js +263 -68
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +263 -68
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +265 -71
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +541 -386
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  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 +4 -2
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +8 -5
  32. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/QualityApi.js +3 -2
  45. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
  48. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/UsersApi.js +2 -2
  62. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +190 -2
  67. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 96.0.0
8
+ * @version 99.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1118,7 +1118,7 @@ class UsersApi {
1118
1118
 
1119
1119
  /**
1120
1120
  * Get a Development Activity
1121
- *
1121
+ * Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.
1122
1122
  * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
1123
1123
  * @param {Object} type Specifies the activity type.
1124
1124
  */
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 96.0.0
8
+ * @version 99.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class VoicemailApi {
5
5
  /**
6
6
  * Voicemail service.
7
7
  * @module purecloud-platform-client-v2/api/VoicemailApi
8
- * @version 96.0.0
8
+ * @version 99.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebChatApi {
5
5
  /**
6
6
  * WebChat service.
7
7
  * @module purecloud-platform-client-v2/api/WebChatApi
8
- * @version 96.0.0
8
+ * @version 99.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 96.0.0
8
+ * @version 99.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 96.0.0
8
+ * @version 99.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -290,6 +290,36 @@ class WorkforceManagementApi {
290
290
  );
291
291
  }
292
292
 
293
+ /**
294
+ * Delete a work plan rotation
295
+ *
296
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
297
+ * @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
298
+ */
299
+ deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
300
+ // verify the required parameter 'managementUnitId' is set
301
+ if (managementUnitId === undefined || managementUnitId === null) {
302
+ throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
303
+ }
304
+ // verify the required parameter 'workPlanRotationId' is set
305
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
306
+ throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
307
+ }
308
+
309
+ return this.apiClient.callApi(
310
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
311
+ 'DELETE',
312
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
313
+ { },
314
+ { },
315
+ { },
316
+ null,
317
+ ['PureCloud OAuth'],
318
+ ['application/json'],
319
+ ['application/json']
320
+ );
321
+ }
322
+
293
323
  /**
294
324
  * Get a list of UserScheduleAdherence records for the requested users
295
325
  *
@@ -1496,6 +1526,65 @@ class WorkforceManagementApi {
1496
1526
  );
1497
1527
  }
1498
1528
 
1529
+ /**
1530
+ * Get a work plan rotation
1531
+ *
1532
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1533
+ * @param {String} workPlanRotationId The ID of the work plan rotation to fetch
1534
+ */
1535
+ getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
1536
+ // verify the required parameter 'managementUnitId' is set
1537
+ if (managementUnitId === undefined || managementUnitId === null) {
1538
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
1539
+ }
1540
+ // verify the required parameter 'workPlanRotationId' is set
1541
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
1542
+ throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
1543
+ }
1544
+
1545
+ return this.apiClient.callApi(
1546
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
1547
+ 'GET',
1548
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
1549
+ { },
1550
+ { },
1551
+ { },
1552
+ null,
1553
+ ['PureCloud OAuth'],
1554
+ ['application/json'],
1555
+ ['application/json']
1556
+ );
1557
+ }
1558
+
1559
+ /**
1560
+ * Get work plan rotations
1561
+ *
1562
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1563
+ * @param {Object} opts Optional parameters
1564
+ * @param {Array.<String>} opts.expand
1565
+ */
1566
+ getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
1567
+ opts = opts || {};
1568
+
1569
+ // verify the required parameter 'managementUnitId' is set
1570
+ if (managementUnitId === undefined || managementUnitId === null) {
1571
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
1572
+ }
1573
+
1574
+ return this.apiClient.callApi(
1575
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
1576
+ 'GET',
1577
+ { 'managementUnitId': managementUnitId },
1578
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
1579
+ { },
1580
+ { },
1581
+ null,
1582
+ ['PureCloud OAuth'],
1583
+ ['application/json'],
1584
+ ['application/json']
1585
+ );
1586
+ }
1587
+
1499
1588
  /**
1500
1589
  * Get work plans
1501
1590
  *
@@ -1971,6 +2060,7 @@ class WorkforceManagementApi {
1971
2060
  * @param {String} workPlanId The ID of the work plan to update
1972
2061
  * @param {Object} opts Optional parameters
1973
2062
  * @param {Object} opts.body body
2063
+ * @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
1974
2064
  */
1975
2065
  patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
1976
2066
  opts = opts || {};
@@ -1988,6 +2078,40 @@ class WorkforceManagementApi {
1988
2078
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
1989
2079
  'PATCH',
1990
2080
  { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
2081
+ { 'validationMode': opts['validationMode'] },
2082
+ { },
2083
+ { },
2084
+ opts['body'],
2085
+ ['PureCloud OAuth'],
2086
+ ['application/json'],
2087
+ ['application/json']
2088
+ );
2089
+ }
2090
+
2091
+ /**
2092
+ * Update a work plan rotation
2093
+ *
2094
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2095
+ * @param {String} workPlanRotationId The ID of the work plan rotation to update
2096
+ * @param {Object} opts Optional parameters
2097
+ * @param {Object} opts.body body
2098
+ */
2099
+ patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
2100
+ opts = opts || {};
2101
+
2102
+ // verify the required parameter 'managementUnitId' is set
2103
+ if (managementUnitId === undefined || managementUnitId === null) {
2104
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
2105
+ }
2106
+ // verify the required parameter 'workPlanRotationId' is set
2107
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
2108
+ throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
2109
+ }
2110
+
2111
+ return this.apiClient.callApi(
2112
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
2113
+ 'PATCH',
2114
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
1991
2115
  { },
1992
2116
  { },
1993
2117
  { },
@@ -2919,12 +3043,76 @@ class WorkforceManagementApi {
2919
3043
  );
2920
3044
  }
2921
3045
 
3046
+ /**
3047
+ * Create a copy of work plan rotation
3048
+ *
3049
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3050
+ * @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
3051
+ * @param {Object} opts Optional parameters
3052
+ * @param {Object} opts.body body
3053
+ */
3054
+ postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
3055
+ opts = opts || {};
3056
+
3057
+ // verify the required parameter 'managementUnitId' is set
3058
+ if (managementUnitId === undefined || managementUnitId === null) {
3059
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
3060
+ }
3061
+ // verify the required parameter 'workPlanRotationId' is set
3062
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
3063
+ throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
3064
+ }
3065
+
3066
+ return this.apiClient.callApi(
3067
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
3068
+ 'POST',
3069
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
3070
+ { },
3071
+ { },
3072
+ { },
3073
+ opts['body'],
3074
+ ['PureCloud OAuth'],
3075
+ ['application/json'],
3076
+ ['application/json']
3077
+ );
3078
+ }
3079
+
3080
+ /**
3081
+ * Create a new work plan rotation
3082
+ *
3083
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3084
+ * @param {Object} opts Optional parameters
3085
+ * @param {Object} opts.body body
3086
+ */
3087
+ postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
3088
+ opts = opts || {};
3089
+
3090
+ // verify the required parameter 'managementUnitId' is set
3091
+ if (managementUnitId === undefined || managementUnitId === null) {
3092
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
3093
+ }
3094
+
3095
+ return this.apiClient.callApi(
3096
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
3097
+ 'POST',
3098
+ { 'managementUnitId': managementUnitId },
3099
+ { },
3100
+ { },
3101
+ { },
3102
+ opts['body'],
3103
+ ['PureCloud OAuth'],
3104
+ ['application/json'],
3105
+ ['application/json']
3106
+ );
3107
+ }
3108
+
2922
3109
  /**
2923
3110
  * Create a new work plan
2924
3111
  *
2925
3112
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2926
3113
  * @param {Object} opts Optional parameters
2927
3114
  * @param {Object} opts.body body
3115
+ * @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
2928
3116
  */
2929
3117
  postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
2930
3118
  opts = opts || {};
@@ -2938,7 +3126,7 @@ class WorkforceManagementApi {
2938
3126
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
2939
3127
  'POST',
2940
3128
  { 'managementUnitId': managementUnitId },
2941
- { },
3129
+ { 'validationMode': opts['validationMode'] },
2942
3130
  { },
2943
3131
  { },
2944
3132
  opts['body'],
@@ -88,7 +88,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
88
88
  * </pre>
89
89
  * </p>
90
90
  * @module purecloud-platform-client-v2/index
91
- * @version 96.0.0
91
+ * @version 99.0.0
92
92
  */
93
93
  class platformClient {
94
94
  constructor() {