purecloud-platform-client-v2 94.0.0 → 97.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 (68) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +547 -1265
  3. package/dist/web-amd/purecloud-platform-client-v2.js +547 -1265
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +547 -1265
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +552 -1269
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +513 -289
  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 +3 -3
  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 +26 -10
  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 +131 -1
  31. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +4 -3
  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 +7 -7
  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 +1 -1
  48. package/src/purecloud-platform-client-v2/api/SCIMApi.js +26 -26
  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 +3 -3
  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 +123 -1
  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 +306 -1147
  67. package/src/purecloud-platform-client-v2/index.js +1 -7
  68. package/src/purecloud-platform-client-v2/api/UserDevelopmentApi.js +0 -148
@@ -50,7 +50,6 @@ import TextbotsApi from './api/TextbotsApi.js';
50
50
  import TokensApi from './api/TokensApi.js';
51
51
  import UploadsApi from './api/UploadsApi.js';
52
52
  import UsageApi from './api/UsageApi.js';
53
- import UserDevelopmentApi from './api/UserDevelopmentApi.js';
54
53
  import UserRecordingsApi from './api/UserRecordingsApi.js';
55
54
  import UsersApi from './api/UsersApi.js';
56
55
  import UtilitiesApi from './api/UtilitiesApi.js';
@@ -89,7 +88,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
89
88
  * </pre>
90
89
  * </p>
91
90
  * @module purecloud-platform-client-v2/index
92
- * @version 94.0.0
91
+ * @version 97.0.0
93
92
  */
94
93
  class platformClient {
95
94
  constructor() {
@@ -348,11 +347,6 @@ class platformClient {
348
347
  * @property {module:purecloud-platform-client-v2/api/UsageApi}
349
348
  */
350
349
  this.UsageApi = UsageApi;
351
- /**
352
- * The UserDevelopmentApi service constructor.
353
- * @property {module:purecloud-platform-client-v2/api/UserDevelopmentApi}
354
- */
355
- this.UserDevelopmentApi = UserDevelopmentApi;
356
350
  /**
357
351
  * The UserRecordingsApi service constructor.
358
352
  * @property {module:purecloud-platform-client-v2/api/UserRecordingsApi}
@@ -1,148 +0,0 @@
1
- import ApiClient from '../ApiClient.js';
2
-
3
-
4
- class UserDevelopmentApi {
5
- /**
6
- * UserDevelopment service.
7
- * @module purecloud-platform-client-v2/api/UserDevelopmentApi
8
- * @version 94.0.0
9
- */
10
-
11
- /**
12
- * Constructs a new UserDevelopmentApi.
13
- * @alias module:purecloud-platform-client-v2/api/UserDevelopmentApi
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
- * Get list of Development Activities
25
- * Either moduleId or userId is required. Results are filtered based on the applicable permissions.
26
- * @param {Object} opts Optional parameters
27
- * @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.
28
- * @param {String} opts.moduleId Specifies the ID of the learning module.
29
- * @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
30
- * @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
31
- * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
32
- * @param {Number} opts.pageSize Page size (default to 25)
33
- * @param {Number} opts.pageNumber Page number (default to 1)
34
- * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
35
- * @param {Array.<String>} opts.types Specifies the activity types.
36
- * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
37
- * @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
38
- */
39
- getUsersDevelopmentActivities(opts) {
40
- opts = opts || {};
41
-
42
-
43
- return this.apiClient.callApi(
44
- '/api/v2/users/development/activities',
45
- 'GET',
46
- { },
47
- { 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
48
- { },
49
- { },
50
- null,
51
- ['PureCloud OAuth'],
52
- ['application/json'],
53
- ['application/json']
54
- );
55
- }
56
-
57
- /**
58
- * Get list of Development Activities for current user
59
- * Results are filtered based on the applicable permissions.
60
- * @param {Object} opts Optional parameters
61
- * @param {String} opts.moduleId Specifies the ID of the learning module.
62
- * @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
63
- * @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
64
- * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
65
- * @param {Number} opts.pageSize Page size (default to 25)
66
- * @param {Number} opts.pageNumber Page number (default to 1)
67
- * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
68
- * @param {Array.<String>} opts.types Specifies the activity types.
69
- * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
70
- * @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
71
- */
72
- getUsersDevelopmentActivitiesMe(opts) {
73
- opts = opts || {};
74
-
75
-
76
- return this.apiClient.callApi(
77
- '/api/v2/users/development/activities/me',
78
- 'GET',
79
- { },
80
- { 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
81
- { },
82
- { },
83
- null,
84
- ['PureCloud OAuth'],
85
- ['application/json'],
86
- ['application/json']
87
- );
88
- }
89
-
90
- /**
91
- * Get a Development Activity
92
- *
93
- * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
94
- * @param {Object} type Specifies the activity type.
95
- */
96
- getUsersDevelopmentActivity(activityId, type) {
97
- // verify the required parameter 'activityId' is set
98
- if (activityId === undefined || activityId === null) {
99
- throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
100
- }
101
- // verify the required parameter 'type' is set
102
- if (type === undefined || type === null) {
103
- throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
104
- }
105
-
106
- return this.apiClient.callApi(
107
- '/api/v2/users/development/activities/{activityId}',
108
- 'GET',
109
- { 'activityId': activityId },
110
- { 'type': type },
111
- { },
112
- { },
113
- null,
114
- ['PureCloud OAuth'],
115
- ['application/json'],
116
- ['application/json']
117
- );
118
- }
119
-
120
- /**
121
- * Retrieve aggregated development activity data
122
- * Results are filtered based on the applicable permissions.
123
- * @param {Object} body Aggregate Request
124
- */
125
- postUsersDevelopmentActivitiesAggregatesQuery(body) {
126
- // verify the required parameter 'body' is set
127
- if (body === undefined || body === null) {
128
- throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
129
- }
130
-
131
- return this.apiClient.callApi(
132
- '/api/v2/users/development/activities/aggregates/query',
133
- 'POST',
134
- { },
135
- { },
136
- { },
137
- { },
138
- body,
139
- ['PureCloud OAuth'],
140
- ['application/json'],
141
- ['application/json']
142
- );
143
- }
144
-
145
- }
146
-
147
-
148
- export default UserDevelopmentApi;