purecloud-platform-client-v2 194.0.0 → 195.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 (85) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +589 -116
  3. package/dist/web-amd/purecloud-platform-client-v2.js +589 -116
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +205 -96
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +205 -96
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +401 -299
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +4 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +147 -3
  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/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +26 -32
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -2
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +174 -1
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -7
  60. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +165 -1
  66. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 194.0.0
8
+ * @version 195.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -20,6 +20,31 @@ class SpeechTextAnalyticsApi {
20
20
  }
21
21
 
22
22
 
23
+ /**
24
+ * Delete a Speech and Text Analytics category by ID
25
+ *
26
+ * @param {String} categoryId The id of the category
27
+ */
28
+ deleteSpeechandtextanalyticsCategory(categoryId) {
29
+ // verify the required parameter 'categoryId' is set
30
+ if (categoryId === undefined || categoryId === null) {
31
+ throw 'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory';
32
+ }
33
+
34
+ return this.apiClient.callApi(
35
+ '/api/v2/speechandtextanalytics/categories/{categoryId}',
36
+ 'DELETE',
37
+ { 'categoryId': categoryId },
38
+ { },
39
+ { },
40
+ { },
41
+ null,
42
+ ['PureCloud OAuth'],
43
+ ['application/json'],
44
+ ['application/json']
45
+ );
46
+ }
47
+
23
48
  /**
24
49
  * Delete a Speech and Text Analytics DictionaryFeedback by Id
25
50
  *
@@ -144,6 +169,60 @@ class SpeechTextAnalyticsApi {
144
169
  );
145
170
  }
146
171
 
172
+ /**
173
+ * Get the list of Speech and Text Analytics categories
174
+ *
175
+ * @param {Object} opts Optional parameters
176
+ * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25)
177
+ * @param {Number} opts.pageNumber The page number for the listing (default to 1)
178
+ * @param {String} opts.name The category name filter applied to the listing
179
+ * @param {Object} opts.sortOrder The sort order for the listing (default to asc)
180
+ * @param {Object} opts.sortBy The field to sort by for the listing (default to name)
181
+ * @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
182
+ */
183
+ getSpeechandtextanalyticsCategories(opts) {
184
+ opts = opts || {};
185
+
186
+
187
+ return this.apiClient.callApi(
188
+ '/api/v2/speechandtextanalytics/categories',
189
+ 'GET',
190
+ { },
191
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') },
192
+ { },
193
+ { },
194
+ null,
195
+ ['PureCloud OAuth'],
196
+ ['application/json'],
197
+ ['application/json']
198
+ );
199
+ }
200
+
201
+ /**
202
+ * Get a Speech and Text Analytics Category by ID
203
+ *
204
+ * @param {String} categoryId The id of the category
205
+ */
206
+ getSpeechandtextanalyticsCategory(categoryId) {
207
+ // verify the required parameter 'categoryId' is set
208
+ if (categoryId === undefined || categoryId === null) {
209
+ throw 'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory';
210
+ }
211
+
212
+ return this.apiClient.callApi(
213
+ '/api/v2/speechandtextanalytics/categories/{categoryId}',
214
+ 'GET',
215
+ { 'categoryId': categoryId },
216
+ { },
217
+ { },
218
+ { },
219
+ null,
220
+ ['PureCloud OAuth'],
221
+ ['application/json'],
222
+ ['application/json']
223
+ );
224
+ }
225
+
147
226
  /**
148
227
  * Get Speech and Text Analytics for a specific conversation
149
228
  *
@@ -169,6 +248,36 @@ class SpeechTextAnalyticsApi {
169
248
  );
170
249
  }
171
250
 
251
+ /**
252
+ * Get the list of detected Speech and Text Analytics categories of conversation
253
+ *
254
+ * @param {String} conversationId The id of the conversation
255
+ * @param {Object} opts Optional parameters
256
+ * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25)
257
+ * @param {Number} opts.pageNumber The page number for the listing (default to 1)
258
+ */
259
+ getSpeechandtextanalyticsConversationCategories(conversationId, opts) {
260
+ opts = opts || {};
261
+
262
+ // verify the required parameter 'conversationId' is set
263
+ if (conversationId === undefined || conversationId === null) {
264
+ throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories';
265
+ }
266
+
267
+ return this.apiClient.callApi(
268
+ '/api/v2/speechandtextanalytics/conversations/{conversationId}/categories',
269
+ 'GET',
270
+ { 'conversationId': conversationId },
271
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
272
+ { },
273
+ { },
274
+ null,
275
+ ['PureCloud OAuth'],
276
+ ['application/json'],
277
+ ['application/json']
278
+ );
279
+ }
280
+
172
281
  /**
173
282
  * Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
174
283
  *
@@ -739,6 +848,31 @@ class SpeechTextAnalyticsApi {
739
848
  );
740
849
  }
741
850
 
851
+ /**
852
+ * Create new Speech and Text Analytics category
853
+ *
854
+ * @param {Object} body The category to create
855
+ */
856
+ postSpeechandtextanalyticsCategories(body) {
857
+ // verify the required parameter 'body' is set
858
+ if (body === undefined || body === null) {
859
+ throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories';
860
+ }
861
+
862
+ return this.apiClient.callApi(
863
+ '/api/v2/speechandtextanalytics/categories',
864
+ 'POST',
865
+ { },
866
+ { },
867
+ { },
868
+ { },
869
+ body,
870
+ ['PureCloud OAuth'],
871
+ ['application/json'],
872
+ ['application/json']
873
+ );
874
+ }
875
+
742
876
  /**
743
877
  * Create a Speech and Text Analytics DictionaryFeedback
744
878
  *
@@ -939,6 +1073,36 @@ class SpeechTextAnalyticsApi {
939
1073
  );
940
1074
  }
941
1075
 
1076
+ /**
1077
+ * Update a Speech and Text Analytics category by ID
1078
+ *
1079
+ * @param {String} categoryId The id of the category
1080
+ * @param {Object} body The updated category
1081
+ */
1082
+ putSpeechandtextanalyticsCategory(categoryId, body) {
1083
+ // verify the required parameter 'categoryId' is set
1084
+ if (categoryId === undefined || categoryId === null) {
1085
+ throw 'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory';
1086
+ }
1087
+ // verify the required parameter 'body' is set
1088
+ if (body === undefined || body === null) {
1089
+ throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory';
1090
+ }
1091
+
1092
+ return this.apiClient.callApi(
1093
+ '/api/v2/speechandtextanalytics/categories/{categoryId}',
1094
+ 'PUT',
1095
+ { 'categoryId': categoryId },
1096
+ { },
1097
+ { },
1098
+ { },
1099
+ body,
1100
+ ['PureCloud OAuth'],
1101
+ ['application/json'],
1102
+ ['application/json']
1103
+ );
1104
+ }
1105
+
942
1106
  /**
943
1107
  * Update existing Speech and Text Analytics dictionary feedback by id
944
1108
  *
@@ -5,7 +5,7 @@ class StationsApi {
5
5
  /**
6
6
  * Stations service.
7
7
  * @module purecloud-platform-client-v2/api/StationsApi
8
- * @version 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.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 194.0.0
8
+ * @version 195.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -107,7 +107,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
107
107
  * </pre>
108
108
  * </p>
109
109
  * @module purecloud-platform-client-v2/index
110
- * @version 194.0.0
110
+ * @version 195.0.0
111
111
  */
112
112
  class platformClient {
113
113
  constructor() {