purecloud-platform-client-v2 253.0.0 → 254.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 (97) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1159 -304
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1159 -304
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +438 -304
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +438 -304
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +462 -15
  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/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 -62
  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 +435 -1
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +207 -125
  26. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -6
  30. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -5
  39. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -5
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -9
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +155 -3
  71. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +268 -1
  82. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -5
  89. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  94. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  95. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  96. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +10 -5
  97. 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 253.0.0
8
+ * @version 254.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -26,7 +26,6 @@ class UsersApi {
26
26
  * @param {String} jobId jobId
27
27
  * @param {Object} opts Optional parameters
28
28
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
29
- * deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30
29
  */
31
30
  deleteAnalyticsUsersAggregatesJob(jobId, opts) {
32
31
  opts = opts || {};
@@ -537,7 +536,6 @@ class UsersApi {
537
536
  * @param {String} jobId jobId
538
537
  * @param {Object} opts Optional parameters
539
538
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
540
- * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
541
539
  */
542
540
  getAnalyticsUsersAggregatesJob(jobId, opts) {
543
541
  opts = opts || {};
@@ -569,7 +567,6 @@ class UsersApi {
569
567
  * @param {Object} opts Optional parameters
570
568
  * @param {String} opts.cursor Cursor token to retrieve next page
571
569
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
572
- * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
573
570
  */
574
571
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
575
572
  opts = opts || {};
@@ -2717,7 +2714,6 @@ class UsersApi {
2717
2714
  * @param {Object} body query
2718
2715
  * @param {Object} opts Optional parameters
2719
2716
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
2720
- * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2721
2717
  */
2722
2718
  postAnalyticsUsersAggregatesJobs(body, opts) {
2723
2719
  opts = opts || {};
@@ -5,7 +5,7 @@ class UsersRulesApi {
5
5
  /**
6
6
  * UsersRules service.
7
7
  * @module purecloud-platform-client-v2/api/UsersRulesApi
8
- * @version 253.0.0
8
+ * @version 254.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 253.0.0
8
+ * @version 254.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 253.0.0
8
+ * @version 254.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 253.0.0
8
+ * @version 254.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 253.0.0
8
+ * @version 254.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 253.0.0
8
+ * @version 254.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 253.0.0
8
+ * @version 254.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 253.0.0
8
+ * @version 254.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -2526,6 +2526,7 @@ class WorkforceManagementApi {
2526
2526
  * @param {Object} opts Optional parameters
2527
2527
  * @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
2528
2528
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
2529
+ * @param {Array.<String>} opts.expand Include to access additional data for the time-off plans
2529
2530
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
2530
2531
  */
2531
2532
  getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
@@ -2540,7 +2541,7 @@ class WorkforceManagementApi {
2540
2541
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
2541
2542
  'GET',
2542
2543
  { 'businessUnitId': businessUnitId },
2543
- { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
2544
+ { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
2544
2545
  { },
2545
2546
  { },
2546
2547
  null,
@@ -2840,6 +2841,8 @@ class WorkforceManagementApi {
2840
2841
  * @param {String} businessUnitId The ID of the business unit
2841
2842
  * @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
2842
2843
  * @param {Object} opts Optional parameters
2844
+ * @param {String} opts.earliestWeekDate If weekId == 'recent', specify the earliest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
2845
+ * @param {String} opts.latestWeekDate If weekId == 'recent', specify the latest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
2843
2846
  * @param {Boolean} opts.includeOnlyPublished includeOnlyPublished
2844
2847
  * @param {Object} opts.expand expand
2845
2848
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
@@ -2860,7 +2863,7 @@ class WorkforceManagementApi {
2860
2863
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules',
2861
2864
  'GET',
2862
2865
  { 'businessUnitId': businessUnitId,'weekId': weekId },
2863
- { 'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
2866
+ { 'earliestWeekDate': opts['earliestWeekDate'],'latestWeekDate': opts['latestWeekDate'],'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
2864
2867
  { },
2865
2868
  { },
2866
2869
  null,
@@ -9694,6 +9697,7 @@ class WorkforceManagementApi {
9694
9697
  * @param {String} userId The id of the user for whom the time off request estimate is requested
9695
9698
  * @param {Object} body body
9696
9699
  * @param {Object} opts Optional parameters
9700
+ * @param {Object} opts.includeOnly Limit response to the specified field
9697
9701
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9698
9702
  */
9699
9703
  postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body, opts) {
@@ -9716,7 +9720,7 @@ class WorkforceManagementApi {
9716
9720
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
9717
9721
  'POST',
9718
9722
  { 'managementUnitId': managementUnitId,'userId': userId },
9719
- { },
9723
+ { 'includeOnly': opts['includeOnly'] },
9720
9724
  { },
9721
9725
  { },
9722
9726
  body,
@@ -10513,6 +10517,7 @@ class WorkforceManagementApi {
10513
10517
  *
10514
10518
  * @param {Object} body body
10515
10519
  * @param {Object} opts Optional parameters
10520
+ * @param {Object} opts.includeOnly Limit response to the specified field
10516
10521
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
10517
10522
  */
10518
10523
  postWorkforcemanagementTimeoffrequestsEstimate(body, opts) {
@@ -10527,7 +10532,7 @@ class WorkforceManagementApi {
10527
10532
  '/api/v2/workforcemanagement/timeoffrequests/estimate',
10528
10533
  'POST',
10529
10534
  { },
10530
- { },
10535
+ { 'includeOnly': opts['includeOnly'] },
10531
10536
  { },
10532
10537
  { },
10533
10538
  body,
@@ -122,7 +122,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
122
122
  * </pre>
123
123
  * </p>
124
124
  * @module purecloud-platform-client-v2/index
125
- * @version 253.0.0
125
+ * @version 254.0.0
126
126
  */
127
127
  class platformClient {
128
128
  constructor() {