purecloud-platform-client-v2 135.0.0 → 136.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 (73) hide show
  1. package/README.md +32 -29
  2. package/dist/node/purecloud-platform-client-v2.js +238 -107
  3. package/dist/web-amd/purecloud-platform-client-v2.js +238 -107
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +238 -107
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +248 -118
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +368 -227
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -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 +3 -3
  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 +29 -29
  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 +11 -9
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  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 +1 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +128 -3
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -3
  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/TelephonyApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  73. 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 135.0.0
8
+ * @version 136.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -661,6 +661,51 @@ class RecordingApi {
661
661
  );
662
662
  }
663
663
 
664
+ /**
665
+ * Get the encryption key configurations
666
+ *
667
+ * @param {String} keyConfigurationId Key Configurations Id
668
+ */
669
+ getRecordingKeyconfiguration(keyConfigurationId) {
670
+ // verify the required parameter 'keyConfigurationId' is set
671
+ if (keyConfigurationId === undefined || keyConfigurationId === null) {
672
+ throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
673
+ }
674
+
675
+ return this.apiClient.callApi(
676
+ '/api/v2/recording/keyconfigurations/{keyConfigurationId}',
677
+ 'GET',
678
+ { 'keyConfigurationId': keyConfigurationId },
679
+ { },
680
+ { },
681
+ { },
682
+ null,
683
+ ['PureCloud OAuth'],
684
+ ['application/json'],
685
+ ['application/json']
686
+ );
687
+ }
688
+
689
+ /**
690
+ * Get a list of key configurations data
691
+ *
692
+ */
693
+ getRecordingKeyconfigurations() {
694
+
695
+ return this.apiClient.callApi(
696
+ '/api/v2/recording/keyconfigurations',
697
+ 'GET',
698
+ { },
699
+ { },
700
+ { },
701
+ { },
702
+ null,
703
+ ['PureCloud OAuth'],
704
+ ['application/json'],
705
+ ['application/json']
706
+ );
707
+ }
708
+
664
709
  /**
665
710
  * Get the local encryption settings
666
711
  *
@@ -1034,8 +1079,8 @@ class RecordingApi {
1034
1079
  }
1035
1080
 
1036
1081
  /**
1037
- * Create a recording bulk job
1038
- *
1082
+ * Create a recording bulk job.
1083
+ * Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
1039
1084
  * @param {Object} body query
1040
1085
  */
1041
1086
  postRecordingJobs(body) {
@@ -1058,6 +1103,56 @@ class RecordingApi {
1058
1103
  );
1059
1104
  }
1060
1105
 
1106
+ /**
1107
+ * Setup configurations for encryption key creation
1108
+ *
1109
+ * @param {Object} body Encryption Configuration
1110
+ */
1111
+ postRecordingKeyconfigurations(body) {
1112
+ // verify the required parameter 'body' is set
1113
+ if (body === undefined || body === null) {
1114
+ throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
1115
+ }
1116
+
1117
+ return this.apiClient.callApi(
1118
+ '/api/v2/recording/keyconfigurations',
1119
+ 'POST',
1120
+ { },
1121
+ { },
1122
+ { },
1123
+ { },
1124
+ body,
1125
+ ['PureCloud OAuth'],
1126
+ ['application/json'],
1127
+ ['application/json']
1128
+ );
1129
+ }
1130
+
1131
+ /**
1132
+ * Validate encryption key configurations without saving it
1133
+ *
1134
+ * @param {Object} body Encryption Configuration
1135
+ */
1136
+ postRecordingKeyconfigurationsValidate(body) {
1137
+ // verify the required parameter 'body' is set
1138
+ if (body === undefined || body === null) {
1139
+ throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
1140
+ }
1141
+
1142
+ return this.apiClient.callApi(
1143
+ '/api/v2/recording/keyconfigurations/validate',
1144
+ 'POST',
1145
+ { },
1146
+ { },
1147
+ { },
1148
+ { },
1149
+ body,
1150
+ ['PureCloud OAuth'],
1151
+ ['application/json'],
1152
+ ['application/json']
1153
+ );
1154
+ }
1155
+
1061
1156
  /**
1062
1157
  * create a local recording key
1063
1158
  *
@@ -1392,6 +1487,36 @@ class RecordingApi {
1392
1487
  );
1393
1488
  }
1394
1489
 
1490
+ /**
1491
+ * Update the encryption key configurations
1492
+ *
1493
+ * @param {String} keyConfigurationId Key Configurations Id
1494
+ * @param {Object} body Encryption key configuration metadata
1495
+ */
1496
+ putRecordingKeyconfiguration(keyConfigurationId, body) {
1497
+ // verify the required parameter 'keyConfigurationId' is set
1498
+ if (keyConfigurationId === undefined || keyConfigurationId === null) {
1499
+ throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
1500
+ }
1501
+ // verify the required parameter 'body' is set
1502
+ if (body === undefined || body === null) {
1503
+ throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
1504
+ }
1505
+
1506
+ return this.apiClient.callApi(
1507
+ '/api/v2/recording/keyconfigurations/{keyConfigurationId}',
1508
+ 'PUT',
1509
+ { 'keyConfigurationId': keyConfigurationId },
1510
+ { },
1511
+ { },
1512
+ { },
1513
+ body,
1514
+ ['PureCloud OAuth'],
1515
+ ['application/json'],
1516
+ ['application/json']
1517
+ );
1518
+ }
1519
+
1395
1520
  /**
1396
1521
  * Update the local encryption settings
1397
1522
  *
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -664,14 +664,18 @@ class RoutingApi {
664
664
  /**
665
665
  * Get domains
666
666
  *
667
+ * @param {Object} opts Optional parameters
668
+ * @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
667
669
  */
668
- getRoutingEmailDomains() {
670
+ getRoutingEmailDomains(opts) {
671
+ opts = opts || {};
672
+
669
673
 
670
674
  return this.apiClient.callApi(
671
675
  '/api/v2/routing/email/domains',
672
676
  'GET',
673
677
  { },
674
- { },
678
+ { 'excludeStatus': opts['excludeStatus'] },
675
679
  { },
676
680
  { },
677
681
  null,
@@ -5,7 +5,7 @@ class SCIMApi {
5
5
  /**
6
6
  * SCIM service.
7
7
  * @module purecloud-platform-client-v2/api/SCIMApi
8
- * @version 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.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 135.0.0
8
+ * @version 136.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -94,7 +94,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
94
94
  * </pre>
95
95
  * </p>
96
96
  * @module purecloud-platform-client-v2/index
97
- * @version 135.0.0
97
+ * @version 136.0.0
98
98
  */
99
99
  class platformClient {
100
100
  constructor() {