purecloud-platform-client-v2 168.0.0 → 168.2.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 (79) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +181 -75
  3. package/dist/web-amd/purecloud-platform-client-v2.js +181 -75
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +181 -75
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +229 -102
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +315 -257
  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/AlertingApi.js +2 -2
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +2 -2
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +2 -2
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +2 -2
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +5 -2
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +2 -2
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +3 -2
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -2
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +2 -2
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +2 -2
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +2 -2
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +2 -2
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +2 -2
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +2 -2
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +2 -2
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +2 -2
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +2 -2
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +5 -2
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +2 -2
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +2 -2
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +2 -2
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +2 -2
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +2 -2
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +2 -2
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +6 -2
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +2 -2
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +2 -2
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +2 -2
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +2 -2
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +2 -2
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +2 -2
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +2 -2
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +2 -2
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +5 -2
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +2 -2
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +3 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +2 -2
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +2 -2
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +11 -2
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +2 -2
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -2
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +2 -2
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +2 -2
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +2 -2
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +2 -2
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +2 -2
  63. package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
  64. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
  66. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +2 -2
  67. package/src/purecloud-platform-client-v2/api/TokensApi.js +2 -2
  68. package/src/purecloud-platform-client-v2/api/UploadsApi.js +2 -2
  69. package/src/purecloud-platform-client-v2/api/UsageApi.js +2 -2
  70. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +2 -2
  71. package/src/purecloud-platform-client-v2/api/UsersApi.js +8 -2
  72. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +2 -2
  73. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
  74. package/src/purecloud-platform-client-v2/api/WebChatApi.js +7 -2
  75. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +2 -2
  76. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +2 -2
  77. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +2 -2
  78. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +70 -7
  79. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 168.0.0
8
+ * @version 168.2.0
9
9
  */
10
10
 
11
11
  /**
@@ -524,4 +524,4 @@ class WebDeploymentsApi {
524
524
  }
525
525
 
526
526
 
527
- export default WebDeploymentsApi;
527
+ export default WebDeploymentsApi;
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 168.0.0
8
+ * @version 168.2.0
9
9
  */
10
10
 
11
11
  /**
@@ -48,4 +48,4 @@ class WebMessagingApi {
48
48
  }
49
49
 
50
50
 
51
- export default WebMessagingApi;
51
+ export default WebMessagingApi;
@@ -5,7 +5,7 @@ class WidgetsApi {
5
5
  /**
6
6
  * Widgets service.
7
7
  * @module purecloud-platform-client-v2/api/WidgetsApi
8
- * @version 168.0.0
8
+ * @version 168.2.0
9
9
  */
10
10
 
11
11
  /**
@@ -148,4 +148,4 @@ class WidgetsApi {
148
148
  }
149
149
 
150
150
 
151
- export default WidgetsApi;
151
+ export default WidgetsApi;
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
5
5
  /**
6
6
  * WorkforceManagement service.
7
7
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
8
- * @version 168.0.0
8
+ * @version 168.2.0
9
9
  */
10
10
 
11
11
  /**
@@ -630,7 +630,7 @@ class WorkforceManagementApi {
630
630
  * Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
631
631
  * @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
632
632
  * @param {Object} opts Optional parameters
633
- * @param {Array.<String>} opts.expand
633
+ * @param {Array.<String>} opts.expand Include to access additional data on the business unit
634
634
  */
635
635
  getWorkforcemanagementBusinessunit(businessUnitId, opts) {
636
636
  opts = opts || {};
@@ -1169,7 +1169,7 @@ class WorkforceManagementApi {
1169
1169
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1170
1170
  * @param {String} forecastId The ID of the forecast
1171
1171
  * @param {Object} opts Optional parameters
1172
- * @param {Array.<String>} opts.expand
1172
+ * @param {Array.<String>} opts.expand Include to access additional data on the forecast
1173
1173
  */
1174
1174
  getWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId, weekDateId, forecastId, opts) {
1175
1175
  opts = opts || {};
@@ -1547,6 +1547,7 @@ class WorkforceManagementApi {
1547
1547
  * Get activity codes
1548
1548
  *
1549
1549
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1550
+ * @deprecated
1550
1551
  */
1551
1552
  getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
1552
1553
  // verify the required parameter 'managementUnitId' is set
@@ -1959,6 +1960,7 @@ class WorkforceManagementApi {
1959
1960
  * @param {Object} opts Optional parameters
1960
1961
  * @param {Object} opts.expand Which fields, if any, to expand
1961
1962
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
1963
+ * @deprecated
1962
1964
  */
1963
1965
  getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
1964
1966
  opts = opts || {};
@@ -1999,6 +2001,7 @@ class WorkforceManagementApi {
1999
2001
  * @param {Boolean} opts.includeOnlyPublished Return only published schedules
2000
2002
  * @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
2001
2003
  * @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
2004
+ * @deprecated
2002
2005
  */
2003
2006
  getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
2004
2007
  opts = opts || {};
@@ -2158,7 +2161,7 @@ class WorkforceManagementApi {
2158
2161
  * "expand=details" is deprecated
2159
2162
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2160
2163
  * @param {Object} opts Optional parameters
2161
- * @param {Array.<String>} opts.expand
2164
+ * @param {Array.<String>} opts.expand Include to access additional data on the work plans
2162
2165
  */
2163
2166
  getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
2164
2167
  opts = opts || {};
@@ -3666,7 +3669,7 @@ class WorkforceManagementApi {
3666
3669
  *
3667
3670
  * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
3668
3671
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3669
- * @param {Object} body
3672
+ * @param {Object} body body
3670
3673
  * @param {Object} opts Optional parameters
3671
3674
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3672
3675
  */
@@ -3705,7 +3708,7 @@ class WorkforceManagementApi {
3705
3708
  * Call after uploading the forecast data to the url supplied by the /import/uploadurl route
3706
3709
  * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
3707
3710
  * @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3708
- * @param {Object} body
3711
+ * @param {Object} body body
3709
3712
  */
3710
3713
  postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body) {
3711
3714
  // verify the required parameter 'businessUnitId' is set
@@ -3957,6 +3960,7 @@ class WorkforceManagementApi {
3957
3960
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3958
3961
  * @param {Object} opts Optional parameters
3959
3962
  * @param {Object} opts.body body
3963
+ * @deprecated
3960
3964
  */
3961
3965
  postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
3962
3966
  opts = opts || {};
@@ -4617,6 +4621,7 @@ class WorkforceManagementApi {
4617
4621
  *
4618
4622
  * @param {Object} opts Optional parameters
4619
4623
  * @param {Object} opts.body body
4624
+ * @deprecated
4620
4625
  */
4621
4626
  postWorkforcemanagementSchedules(opts) {
4622
4627
  opts = opts || {};
@@ -4636,6 +4641,64 @@ class WorkforceManagementApi {
4636
4641
  );
4637
4642
  }
4638
4643
 
4644
+ /**
4645
+ * Request a teams historical adherence report
4646
+ * The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
4647
+ * @param {String} teamId The ID of the team
4648
+ * @param {Object} opts Optional parameters
4649
+ * @param {Object} opts.body body
4650
+ */
4651
+ postWorkforcemanagementTeamAdherenceHistorical(teamId, opts) {
4652
+ opts = opts || {};
4653
+
4654
+ // verify the required parameter 'teamId' is set
4655
+ if (teamId === undefined || teamId === null) {
4656
+ throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';
4657
+ }
4658
+
4659
+ return this.apiClient.callApi(
4660
+ '/api/v2/workforcemanagement/teams/{teamId}/adherence/historical',
4661
+ 'POST',
4662
+ { 'teamId': teamId },
4663
+ { },
4664
+ { },
4665
+ { },
4666
+ opts['body'],
4667
+ ['PureCloud OAuth'],
4668
+ ['application/json'],
4669
+ ['application/json']
4670
+ );
4671
+ }
4672
+
4673
+ /**
4674
+ * Request a historical shrinkage report
4675
+ * The maximum supported range for historical shrinkage queries is up to 32 days
4676
+ * @param {String} teamId The ID of the team
4677
+ * @param {Object} opts Optional parameters
4678
+ * @param {Object} opts.body body
4679
+ */
4680
+ postWorkforcemanagementTeamShrinkageJobs(teamId, opts) {
4681
+ opts = opts || {};
4682
+
4683
+ // verify the required parameter 'teamId' is set
4684
+ if (teamId === undefined || teamId === null) {
4685
+ throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';
4686
+ }
4687
+
4688
+ return this.apiClient.callApi(
4689
+ '/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs',
4690
+ 'POST',
4691
+ { 'teamId': teamId },
4692
+ { },
4693
+ { },
4694
+ { },
4695
+ opts['body'],
4696
+ ['PureCloud OAuth'],
4697
+ ['application/json'],
4698
+ ['application/json']
4699
+ );
4700
+ }
4701
+
4639
4702
  /**
4640
4703
  * Queries available time off for the current user
4641
4704
  *
@@ -4721,4 +4784,4 @@ class WorkforceManagementApi {
4721
4784
  }
4722
4785
 
4723
4786
 
4724
- export default WorkforceManagementApi;
4787
+ export default WorkforceManagementApi;
@@ -101,7 +101,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
101
101
  * </pre>
102
102
  * </p>
103
103
  * @module purecloud-platform-client-v2/index
104
- * @version 168.0.0
104
+ * @version 168.2.0
105
105
  */
106
106
  class platformClient {
107
107
  constructor() {