purecloud-platform-client-v2 201.0.0 → 202.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 (87) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +165 -87
  3. package/dist/web-amd/purecloud-platform-client-v2.js +165 -87
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +101 -88
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +101 -88
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +537 -220
  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/AgentUIApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OutboundApi.js +56 -1
  56. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
  60. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +32 -2
  79. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -8
  87. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class SettingsApi {
5
5
  /**
6
6
  * Settings service.
7
7
  * @module purecloud-platform-client-v2/api/SettingsApi
8
- * @version 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -76,11 +76,12 @@ class UserRecordingsApi {
76
76
 
77
77
  /**
78
78
  * Download a user recording.
79
- *
79
+ * API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
80
80
  * @param {String} recordingId User Recording ID
81
81
  * @param {Object} opts Optional parameters
82
82
  * @param {Object} opts.formatId The desired media format. (default to WEBM)
83
83
  * @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
84
+ * @deprecated
84
85
  */
85
86
  getUserrecordingMedia(recordingId, opts) {
86
87
  opts = opts || {};
@@ -104,6 +105,35 @@ class UserRecordingsApi {
104
105
  );
105
106
  }
106
107
 
108
+ /**
109
+ * Download a user recording.
110
+ *
111
+ * @param {String} recordingId User Recording ID
112
+ * @param {Object} opts Optional parameters
113
+ * @param {Object} opts.formatId The desired media format. (default to WEBM)
114
+ */
115
+ getUserrecordingTranscoding(recordingId, opts) {
116
+ opts = opts || {};
117
+
118
+ // verify the required parameter 'recordingId' is set
119
+ if (recordingId === undefined || recordingId === null) {
120
+ throw 'Missing the required parameter "recordingId" when calling getUserrecordingTranscoding';
121
+ }
122
+
123
+ return this.apiClient.callApi(
124
+ '/api/v2/userrecordings/{recordingId}/transcoding',
125
+ 'GET',
126
+ { 'recordingId': recordingId },
127
+ { 'formatId': opts['formatId'] },
128
+ { },
129
+ { },
130
+ null,
131
+ ['PureCloud OAuth'],
132
+ ['application/json'],
133
+ ['application/json']
134
+ );
135
+ }
136
+
107
137
  /**
108
138
  * Get a list of user recordings.
109
139
  *
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.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 201.0.0
8
+ * @version 202.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1017,7 +1017,6 @@ class WorkforceManagementApi {
1017
1017
  *
1018
1018
  * @param {String} businessUnitId The ID of the business unit
1019
1019
  * @param {String} activityPlanId The ID of the activity plan to fetch
1020
- * getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1021
1020
  */
1022
1021
  getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
1023
1022
  // verify the required parameter 'businessUnitId' is set
@@ -1049,7 +1048,6 @@ class WorkforceManagementApi {
1049
1048
  * @param {String} businessUnitId The ID of the business unit
1050
1049
  * @param {String} activityPlanId The ID of the activity plan associated with the run job
1051
1050
  * @param {String} jobId The ID of the activity plan run job
1052
- * getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1053
1051
  */
1054
1052
  getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
1055
1053
  // verify the required parameter 'businessUnitId' is set
@@ -1085,7 +1083,6 @@ class WorkforceManagementApi {
1085
1083
  * @param {String} businessUnitId The ID of the business unit
1086
1084
  * @param {Object} opts Optional parameters
1087
1085
  * @param {Object} opts.state Optionally filter by activity plan state
1088
- * getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1089
1086
  */
1090
1087
  getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
1091
1088
  opts = opts || {};
@@ -1113,7 +1110,6 @@ class WorkforceManagementApi {
1113
1110
  * Gets the latest job for all activity plans in the business unit
1114
1111
  *
1115
1112
  * @param {String} businessUnitId The ID of the business unit
1116
- * getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1117
1113
  */
1118
1114
  getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
1119
1115
  // verify the required parameter 'businessUnitId' is set
@@ -3693,7 +3689,6 @@ class WorkforceManagementApi {
3693
3689
  * @param {String} businessUnitId The ID of the business unit
3694
3690
  * @param {String} activityPlanId The ID of the activity plan to update
3695
3691
  * @param {Object} body body
3696
- * patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3697
3692
  */
3698
3693
  patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
3699
3694
  // verify the required parameter 'businessUnitId' is set
@@ -4835,7 +4830,6 @@ class WorkforceManagementApi {
4835
4830
  * Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
4836
4831
  * @param {String} businessUnitId The ID of the business unit
4837
4832
  * @param {String} activityPlanId The ID of the activity plan to run
4838
- * postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4839
4833
  */
4840
4834
  postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
4841
4835
  // verify the required parameter 'businessUnitId' is set
@@ -4866,7 +4860,6 @@ class WorkforceManagementApi {
4866
4860
  *
4867
4861
  * @param {String} businessUnitId The ID of the business unit
4868
4862
  * @param {Object} body body
4869
- * postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4870
4863
  */
4871
4864
  postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
4872
4865
  // verify the required parameter 'businessUnitId' is set
@@ -109,7 +109,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
109
109
  * </pre>
110
110
  * </p>
111
111
  * @module purecloud-platform-client-v2/index
112
- * @version 201.0.0
112
+ * @version 202.0.0
113
113
  */
114
114
  class platformClient {
115
115
  constructor() {