purecloud-platform-client-v2 146.0.0 → 147.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 (74) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +338 -69
  3. package/dist/web-amd/purecloud-platform-client-v2.js +338 -69
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +338 -69
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +338 -69
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +448 -233
  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 +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +46 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -2
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +135 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +31 -1
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UsersApi.js +31 -1
  67. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +30 -1
  71. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class RecordingApi {
5
5
  /**
6
6
  * Recording service.
7
7
  * @module purecloud-platform-client-v2/api/RecordingApi
8
- * @version 146.0.0
8
+ * @version 147.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -879,6 +879,36 @@ class RecordingApi {
879
879
  );
880
880
  }
881
881
 
882
+ /**
883
+ * Query for recording retention data
884
+ *
885
+ * @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
886
+ * @param {Object} opts Optional parameters
887
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
888
+ * @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
889
+ */
890
+ getRecordingsRetentionQuery(retentionThresholdDays, opts) {
891
+ opts = opts || {};
892
+
893
+ // verify the required parameter 'retentionThresholdDays' is set
894
+ if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
895
+ throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
896
+ }
897
+
898
+ return this.apiClient.callApi(
899
+ '/api/v2/recordings/retention/query',
900
+ 'GET',
901
+ { },
902
+ { 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
903
+ { },
904
+ { },
905
+ null,
906
+ ['PureCloud OAuth'],
907
+ ['application/json'],
908
+ ['application/json']
909
+ );
910
+ }
911
+
882
912
  /**
883
913
  * Retrieves a paged listing of screen recording sessions
884
914
  *
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1747,6 +1747,36 @@ class UsersApi {
1747
1747
  );
1748
1748
  }
1749
1749
 
1750
+ /**
1751
+ * Create mapping between external identifier and user. Limit 100 per entity.
1752
+ * Authority Name and External key are case sensitive.
1753
+ * @param {String} userId User ID
1754
+ * @param {Object} body
1755
+ */
1756
+ postUserExternalid(userId, body) {
1757
+ // verify the required parameter 'userId' is set
1758
+ if (userId === undefined || userId === null) {
1759
+ throw 'Missing the required parameter "userId" when calling postUserExternalid';
1760
+ }
1761
+ // verify the required parameter 'body' is set
1762
+ if (body === undefined || body === null) {
1763
+ throw 'Missing the required parameter "body" when calling postUserExternalid';
1764
+ }
1765
+
1766
+ return this.apiClient.callApi(
1767
+ '/api/v2/users/{userId}/externalid',
1768
+ 'POST',
1769
+ { 'userId': userId },
1770
+ { },
1771
+ { },
1772
+ { },
1773
+ body,
1774
+ ['PureCloud OAuth'],
1775
+ ['application/json'],
1776
+ ['application/json']
1777
+ );
1778
+ }
1779
+
1750
1780
  /**
1751
1781
  * Send an activation email to the user
1752
1782
  *
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -199,6 +199,35 @@ class WebDeploymentsApi {
199
199
  );
200
200
  }
201
201
 
202
+ /**
203
+ * Get active configuration for a given deployment
204
+ *
205
+ * @param {String} deploymentId The deployment ID
206
+ * @param {Object} opts Optional parameters
207
+ * @param {String} opts.type Get active configuration on a deployment
208
+ */
209
+ getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
210
+ opts = opts || {};
211
+
212
+ // verify the required parameter 'deploymentId' is set
213
+ if (deploymentId === undefined || deploymentId === null) {
214
+ throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';
215
+ }
216
+
217
+ return this.apiClient.callApi(
218
+ '/api/v2/webdeployments/deployments/{deploymentId}/configurations',
219
+ 'GET',
220
+ { 'deploymentId': deploymentId },
221
+ { 'type': opts['type'] },
222
+ { },
223
+ { },
224
+ null,
225
+ ['PureCloud OAuth'],
226
+ ['application/json'],
227
+ ['application/json']
228
+ );
229
+ }
230
+
202
231
  /**
203
232
  * Get deployments
204
233
  *
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.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 146.0.0
8
+ * @version 147.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -96,7 +96,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
96
96
  * </pre>
97
97
  * </p>
98
98
  * @module purecloud-platform-client-v2/index
99
- * @version 146.0.0
99
+ * @version 147.0.0
100
100
  */
101
101
  class platformClient {
102
102
  constructor() {