purecloud-platform-client-v2 154.0.0 → 155.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 (77) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +323 -77
  3. package/dist/web-amd/purecloud-platform-client-v2.js +323 -77
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +323 -77
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +323 -77
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +409 -227
  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 +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 +1 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +116 -8
  37. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OutboundApi.js +119 -1
  49. package/src/purecloud-platform-client-v2/api/PresenceApi.js +3 -3
  50. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +21 -1
  63. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class OutboundApi {
5
5
  /**
6
6
  * Outbound service.
7
7
  * @module purecloud-platform-client-v2/api/OutboundApi
8
- * @version 154.0.0
8
+ * @version 155.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -355,6 +355,64 @@ class OutboundApi {
355
355
  );
356
356
  }
357
357
 
358
+ /**
359
+ * Deletes all or expired email addresses from a DNC list.
360
+ * This operation is Only for Internal DNC lists of email addresses
361
+ * @param {String} dncListId DncList ID
362
+ * @param {Object} opts Optional parameters
363
+ * @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
364
+ */
365
+ deleteOutboundDnclistEmailaddresses(dncListId, opts) {
366
+ opts = opts || {};
367
+
368
+ // verify the required parameter 'dncListId' is set
369
+ if (dncListId === undefined || dncListId === null) {
370
+ throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistEmailaddresses';
371
+ }
372
+
373
+ return this.apiClient.callApi(
374
+ '/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
375
+ 'DELETE',
376
+ { 'dncListId': dncListId },
377
+ { 'expiredOnly': opts['expiredOnly'] },
378
+ { },
379
+ { },
380
+ null,
381
+ ['PureCloud OAuth'],
382
+ ['application/json'],
383
+ ['application/json']
384
+ );
385
+ }
386
+
387
+ /**
388
+ * Deletes all or expired phone numbers from a DNC list.
389
+ * This operation is Only for Internal DNC lists of phone numbers
390
+ * @param {String} dncListId DncList ID
391
+ * @param {Object} opts Optional parameters
392
+ * @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
393
+ */
394
+ deleteOutboundDnclistPhonenumbers(dncListId, opts) {
395
+ opts = opts || {};
396
+
397
+ // verify the required parameter 'dncListId' is set
398
+ if (dncListId === undefined || dncListId === null) {
399
+ throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistPhonenumbers';
400
+ }
401
+
402
+ return this.apiClient.callApi(
403
+ '/api/v2/outbound/dnclists/{dncListId}/phonenumbers',
404
+ 'DELETE',
405
+ { 'dncListId': dncListId },
406
+ { 'expiredOnly': opts['expiredOnly'] },
407
+ { },
408
+ { },
409
+ null,
410
+ ['PureCloud OAuth'],
411
+ ['application/json'],
412
+ ['application/json']
413
+ );
414
+ }
415
+
358
416
  /**
359
417
  * Delete an Outbound Messaging Campaign
360
418
  *
@@ -2125,6 +2183,66 @@ class OutboundApi {
2125
2183
  );
2126
2184
  }
2127
2185
 
2186
+ /**
2187
+ * Add emails to or Delete emails from a DNC list.
2188
+ * Only Internal DNC lists may be added to or deleted from
2189
+ * @param {String} dncListId DncList ID
2190
+ * @param {Object} body DNC Emails
2191
+ */
2192
+ patchOutboundDnclistEmailaddresses(dncListId, body) {
2193
+ // verify the required parameter 'dncListId' is set
2194
+ if (dncListId === undefined || dncListId === null) {
2195
+ throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistEmailaddresses';
2196
+ }
2197
+ // verify the required parameter 'body' is set
2198
+ if (body === undefined || body === null) {
2199
+ throw 'Missing the required parameter "body" when calling patchOutboundDnclistEmailaddresses';
2200
+ }
2201
+
2202
+ return this.apiClient.callApi(
2203
+ '/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
2204
+ 'PATCH',
2205
+ { 'dncListId': dncListId },
2206
+ { },
2207
+ { },
2208
+ { },
2209
+ body,
2210
+ ['PureCloud OAuth'],
2211
+ ['application/json'],
2212
+ ['application/json']
2213
+ );
2214
+ }
2215
+
2216
+ /**
2217
+ * Add numbers to or delete numbers from a DNC list.
2218
+ * Only Internal DNC lists may be added to deleted from
2219
+ * @param {String} dncListId DncList ID
2220
+ * @param {Object} body DNC Phone Numbers
2221
+ */
2222
+ patchOutboundDnclistPhonenumbers(dncListId, body) {
2223
+ // verify the required parameter 'dncListId' is set
2224
+ if (dncListId === undefined || dncListId === null) {
2225
+ throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistPhonenumbers';
2226
+ }
2227
+ // verify the required parameter 'body' is set
2228
+ if (body === undefined || body === null) {
2229
+ throw 'Missing the required parameter "body" when calling patchOutboundDnclistPhonenumbers';
2230
+ }
2231
+
2232
+ return this.apiClient.callApi(
2233
+ '/api/v2/outbound/dnclists/{dncListId}/phonenumbers',
2234
+ 'PATCH',
2235
+ { 'dncListId': dncListId },
2236
+ { },
2237
+ { },
2238
+ { },
2239
+ body,
2240
+ ['PureCloud OAuth'],
2241
+ ['application/json'],
2242
+ ['application/json']
2243
+ );
2244
+ }
2245
+
2128
2246
  /**
2129
2247
  * Update the outbound settings for this organization
2130
2248
  *
@@ -5,7 +5,7 @@ class PresenceApi {
5
5
  /**
6
6
  * Presence service.
7
7
  * @module purecloud-platform-client-v2/api/PresenceApi
8
- * @version 154.0.0
8
+ * @version 155.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -222,7 +222,7 @@ class PresenceApi {
222
222
 
223
223
  /**
224
224
  * Get a user's Presence
225
- * Get a users presence for the specified source that is not specifically listed. Used to support custom presence sources.
225
+ * Get a users presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.
226
226
  * @param {String} userId user Id
227
227
  * @param {String} sourceId Presence source ID
228
228
  */
@@ -277,7 +277,7 @@ class PresenceApi {
277
277
 
278
278
  /**
279
279
  * Patch a user's Presence
280
- * Patch a users presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
280
+ * Patch a users presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
281
281
  * @param {String} userId user Id
282
282
  * @param {String} sourceId Presence source ID
283
283
  * @param {Object} body User presence
@@ -5,7 +5,7 @@ class ProcessAutomationApi {
5
5
  /**
6
6
  * ProcessAutomation service.
7
7
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
8
- * @version 154.0.0
8
+ * @version 155.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class QualityApi {
5
5
  /**
6
6
  * Quality service.
7
7
  * @module purecloud-platform-client-v2/api/QualityApi
8
- * @version 154.0.0
8
+ * @version 155.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RecordingApi {
5
5
  /**
6
6
  * Recording service.
7
7
  * @module purecloud-platform-client-v2/api/RecordingApi
8
- * @version 154.0.0
8
+ * @version 155.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -20,6 +20,26 @@ class TelephonyApi {
20
20
  }
21
21
 
22
22
 
23
+ /**
24
+ * Retrieve the list of AWS regions media can stream through.
25
+ *
26
+ */
27
+ getTelephonyMediaregions() {
28
+
29
+ return this.apiClient.callApi(
30
+ '/api/v2/telephony/mediaregions',
31
+ 'GET',
32
+ { },
33
+ { },
34
+ { },
35
+ { },
36
+ null,
37
+ ['PureCloud OAuth'],
38
+ ['application/json'],
39
+ ['application/json']
40
+ );
41
+ }
42
+
23
43
  /**
24
44
  * Fetch SIP metadata
25
45
  * Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
5
5
  /**
6
6
  * TelephonyProvidersEdge service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
8
- * @version 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.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 154.0.0
8
+ * @version 155.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -99,7 +99,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
99
99
  * </pre>
100
100
  * </p>
101
101
  * @module purecloud-platform-client-v2/index
102
- * @version 154.0.0
102
+ * @version 155.0.0
103
103
  */
104
104
  class platformClient {
105
105
  constructor() {