purecloud-platform-client-v2 247.0.0 → 248.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 (96) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +134 -103
  3. package/dist/web-amd/purecloud-platform-client-v2.js +134 -103
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +111 -103
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +111 -103
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +538 -255
  9. package/package.json +2 -2
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +11 -11
  29. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +25 -1
  49. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +2 -3
  79. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  94. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  95. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +13 -5
  96. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class PresenceApi {
5
5
  /**
6
6
  * Presence service.
7
7
  * @module purecloud-platform-client-v2/api/PresenceApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ProcessAutomationApi {
5
5
  /**
6
6
  * ProcessAutomation service.
7
7
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class QualityApi {
5
5
  /**
6
6
  * Quality service.
7
7
  * @module purecloud-platform-client-v2/api/QualityApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RecordingApi {
5
5
  /**
6
6
  * Recording service.
7
7
  * @module purecloud-platform-client-v2/api/RecordingApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RoutingApi {
5
5
  /**
6
6
  * Routing service.
7
7
  * @module purecloud-platform-client-v2/api/RoutingApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SCIMApi {
5
5
  /**
6
6
  * SCIM service.
7
7
  * @module purecloud-platform-client-v2/api/SCIMApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ScriptsApi {
5
5
  /**
6
6
  * Scripts service.
7
7
  * @module purecloud-platform-client-v2/api/ScriptsApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SearchApi {
5
5
  /**
6
6
  * Search service.
7
7
  * @module purecloud-platform-client-v2/api/SearchApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SettingsApi {
5
5
  /**
6
6
  * Settings service.
7
7
  * @module purecloud-platform-client-v2/api/SettingsApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SocialMediaApi {
5
5
  /**
6
6
  * SocialMedia service.
7
7
  * @module purecloud-platform-client-v2/api/SocialMediaApi
8
- * @version 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1887,9 +1887,8 @@ class TaskManagementApi {
1887
1887
 
1888
1888
  /**
1889
1889
  * Query for workitems
1890
- * This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
1890
+ * This query requires at least one EQ filter on the workbinId, assigneeId, queueId or typeId attributes. A maximum of three filters are allowed.
1891
1891
  * @param {Object} body WorkitemQueryPostRequest
1892
- * postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1893
1892
  */
1894
1893
  postTaskmanagementWorkitemsQuery(body) {
1895
1894
  // verify the required parameter 'body' is set
@@ -5,7 +5,7 @@ class TeamsApi {
5
5
  /**
6
6
  * Teams service.
7
7
  * @module purecloud-platform-client-v2/api/TeamsApi
8
- * @version 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsersRulesApi {
5
5
  /**
6
6
  * UsersRules service.
7
7
  * @module purecloud-platform-client-v2/api/UsersRulesApi
8
- * @version 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.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 247.0.0
8
+ * @version 248.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1311,8 +1311,12 @@ class WorkforceManagementApi {
1311
1311
  *
1312
1312
  * @param {String} businessUnitId The ID of the business unit
1313
1313
  * @param {String} capacityPlanId The ID of the capacity plan
1314
+ * @param {Object} opts Optional parameters
1315
+ * @param {Object} opts.granularity Granularity to access staffing group data, defaults to weekly
1314
1316
  */
1315
- getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId) {
1317
+ getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId, opts) {
1318
+ opts = opts || {};
1319
+
1316
1320
  // verify the required parameter 'businessUnitId' is set
1317
1321
  if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
1318
1322
  throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
@@ -1326,7 +1330,7 @@ class WorkforceManagementApi {
1326
1330
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations',
1327
1331
  'GET',
1328
1332
  { 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
1329
- { },
1333
+ { 'granularity': opts['granularity'] },
1330
1334
  { },
1331
1335
  { },
1332
1336
  null,
@@ -1372,8 +1376,12 @@ class WorkforceManagementApi {
1372
1376
  * @param {String} businessUnitId
1373
1377
  * @param {String} weekDateId weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1374
1378
  * @param {String} forecastId forecastId of forecast
1379
+ * @param {Object} opts Optional parameters
1380
+ * @param {Object} opts.granularity Granularity to access staffing requirements data, defaults to weekly
1375
1381
  */
1376
- getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(businessUnitId, weekDateId, forecastId) {
1382
+ getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(businessUnitId, weekDateId, forecastId, opts) {
1383
+ opts = opts || {};
1384
+
1377
1385
  // verify the required parameter 'businessUnitId' is set
1378
1386
  if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
1379
1387
  throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
@@ -1391,7 +1399,7 @@ class WorkforceManagementApi {
1391
1399
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}',
1392
1400
  'GET',
1393
1401
  { 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
1394
- { },
1402
+ { 'granularity': opts['granularity'] },
1395
1403
  { },
1396
1404
  { },
1397
1405
  null,
@@ -121,7 +121,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
121
121
  * </pre>
122
122
  * </p>
123
123
  * @module purecloud-platform-client-v2/index
124
- * @version 247.0.0
124
+ * @version 248.0.0
125
125
  */
126
126
  class platformClient {
127
127
  constructor() {