purecloud-platform-client-v2 208.0.0 → 210.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 (91) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1514 -138
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1514 -138
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +516 -150
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +697 -259
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +3829 -3147
  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/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +4 -4
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -2
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +175 -0
  27. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +240 -1
  32. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -9
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +7 -3
  44. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +52 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/QualityApi.js +5 -3
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +29 -25
  65. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +910 -0
  71. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +11 -19
  91. package/src/purecloud-platform-client-v2/index.js +13 -1
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class StationsApi {
5
5
  /**
6
6
  * Stations service.
7
7
  * @module purecloud-platform-client-v2/api/StationsApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SuggestApi {
5
5
  /**
6
6
  * Suggest service.
7
7
  * @module purecloud-platform-client-v2/api/SuggestApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TaskManagementApi {
5
5
  /**
6
6
  * TaskManagement service.
7
7
  * @module purecloud-platform-client-v2/api/TaskManagementApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TeamsApi {
5
5
  /**
6
6
  * Teams service.
7
7
  * @module purecloud-platform-client-v2/api/TeamsApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TelephonyApi {
5
5
  /**
6
6
  * Telephony service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
5
5
  /**
6
6
  * TelephonyProvidersEdge service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TokensApi {
5
5
  /**
6
6
  * Tokens service.
7
7
  * @module purecloud-platform-client-v2/api/TokensApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UploadsApi {
5
5
  /**
6
6
  * Uploads service.
7
7
  * @module purecloud-platform-client-v2/api/UploadsApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 208.0.0
8
+ * @version 210.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 208.0.0
8
+ * @version 210.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 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 208.0.0
8
+ * @version 210.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 208.0.0
8
+ * @version 210.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 208.0.0
8
+ * @version 210.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -2905,12 +2905,8 @@ class WorkforceManagementApi {
2905
2905
  *
2906
2906
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2907
2907
  * @param {String} userId The userId to whom the Time Off Request applies.
2908
- * @param {Object} opts Optional parameters
2909
- * @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
2910
2908
  */
2911
- getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId, opts) {
2912
- opts = opts || {};
2913
-
2909
+ getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId) {
2914
2910
  // verify the required parameter 'managementUnitId' is set
2915
2911
  if (managementUnitId === undefined || managementUnitId === null) {
2916
2912
  throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';
@@ -2924,7 +2920,7 @@ class WorkforceManagementApi {
2924
2920
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests',
2925
2921
  'GET',
2926
2922
  { 'managementUnitId': managementUnitId,'userId': userId },
2927
- { 'recentlyReviewed': opts['recentlyReviewed'] },
2923
+ { },
2928
2924
  { },
2929
2925
  { },
2930
2926
  null,
@@ -3041,7 +3037,7 @@ class WorkforceManagementApi {
3041
3037
  * Gets all the shift trades for a given week
3042
3038
  *
3043
3039
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3044
- * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3040
+ * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3045
3041
  * @param {Object} opts Optional parameters
3046
3042
  * @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
3047
3043
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
@@ -3415,18 +3411,14 @@ class WorkforceManagementApi {
3415
3411
  /**
3416
3412
  * Get a list of time off requests for the current user
3417
3413
  *
3418
- * @param {Object} opts Optional parameters
3419
- * @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
3420
3414
  */
3421
- getWorkforcemanagementTimeoffrequests(opts) {
3422
- opts = opts || {};
3423
-
3415
+ getWorkforcemanagementTimeoffrequests() {
3424
3416
 
3425
3417
  return this.apiClient.callApi(
3426
3418
  '/api/v2/workforcemanagement/timeoffrequests',
3427
3419
  'GET',
3428
3420
  { },
3429
- { 'recentlyReviewed': opts['recentlyReviewed'] },
3421
+ { },
3430
3422
  { },
3431
3423
  { },
3432
3424
  null,
@@ -4267,7 +4259,7 @@ class WorkforceManagementApi {
4267
4259
  * Updates a shift trade. This route can only be called by the initiating agent
4268
4260
  *
4269
4261
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
4270
- * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
4262
+ * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
4271
4263
  * @param {String} tradeId The ID of the shift trade to update
4272
4264
  * @param {Object} body body
4273
4265
  */
@@ -6527,7 +6519,7 @@ class WorkforceManagementApi {
6527
6519
  * Matches a shift trade. This route can only be called by the receiving agent
6528
6520
  *
6529
6521
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
6530
- * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
6522
+ * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
6531
6523
  * @param {String} tradeId The ID of the shift trade to update
6532
6524
  * @param {Object} body body
6533
6525
  */
@@ -6567,7 +6559,7 @@ class WorkforceManagementApi {
6567
6559
  * Adds a shift trade
6568
6560
  *
6569
6561
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
6570
- * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
6562
+ * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
6571
6563
  * @param {Object} body body
6572
6564
  */
6573
6565
  postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body) {
@@ -6602,7 +6594,7 @@ class WorkforceManagementApi {
6602
6594
  * Searches for potential shift trade matches for the current agent
6603
6595
  *
6604
6596
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
6605
- * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
6597
+ * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
6606
6598
  * @param {Object} body body
6607
6599
  * @param {Object} opts Optional parameters
6608
6600
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
@@ -6641,7 +6633,7 @@ class WorkforceManagementApi {
6641
6633
  * Updates the state of a batch of shift trades
6642
6634
  * Admin functionality is not supported with "mine".
6643
6635
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
6644
- * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
6636
+ * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
6645
6637
  * @param {Object} body body
6646
6638
  * @param {Object} opts Optional parameters
6647
6639
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
@@ -16,6 +16,7 @@ import CoachingApi from './api/CoachingApi.js';
16
16
  import ContentManagementApi from './api/ContentManagementApi.js';
17
17
  import ConversationsApi from './api/ConversationsApi.js';
18
18
  import DataExtensionsApi from './api/DataExtensionsApi.js';
19
+ import DataPrivacyApi from './api/DataPrivacyApi.js';
19
20
  import DownloadsApi from './api/DownloadsApi.js';
20
21
  import EmailsApi from './api/EmailsApi.js';
21
22
  import EmployeeEngagementApi from './api/EmployeeEngagementApi.js';
@@ -59,6 +60,7 @@ import ScreenRecordingApi from './api/ScreenRecordingApi.js';
59
60
  import ScriptsApi from './api/ScriptsApi.js';
60
61
  import SearchApi from './api/SearchApi.js';
61
62
  import SettingsApi from './api/SettingsApi.js';
63
+ import SocialMediaApi from './api/SocialMediaApi.js';
62
64
  import SpeechTextAnalyticsApi from './api/SpeechTextAnalyticsApi.js';
63
65
  import StationsApi from './api/StationsApi.js';
64
66
  import SuggestApi from './api/SuggestApi.js';
@@ -111,7 +113,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
111
113
  * </pre>
112
114
  * </p>
113
115
  * @module purecloud-platform-client-v2/index
114
- * @version 208.0.0
116
+ * @version 210.0.0
115
117
  */
116
118
  class platformClient {
117
119
  constructor() {
@@ -200,6 +202,11 @@ class platformClient {
200
202
  * @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
201
203
  */
202
204
  this.DataExtensionsApi = DataExtensionsApi;
205
+ /**
206
+ * The DataPrivacyApi service constructor.
207
+ * @property {module:purecloud-platform-client-v2/api/DataPrivacyApi}
208
+ */
209
+ this.DataPrivacyApi = DataPrivacyApi;
203
210
  /**
204
211
  * The DownloadsApi service constructor.
205
212
  * @property {module:purecloud-platform-client-v2/api/DownloadsApi}
@@ -415,6 +422,11 @@ class platformClient {
415
422
  * @property {module:purecloud-platform-client-v2/api/SettingsApi}
416
423
  */
417
424
  this.SettingsApi = SettingsApi;
425
+ /**
426
+ * The SocialMediaApi service constructor.
427
+ * @property {module:purecloud-platform-client-v2/api/SocialMediaApi}
428
+ */
429
+ this.SocialMediaApi = SocialMediaApi;
418
430
  /**
419
431
  * The SpeechTextAnalyticsApi service constructor.
420
432
  * @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}