purecloud-platform-client-v2 129.0.0 → 130.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 (72) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +83 -77
  3. package/dist/web-amd/purecloud-platform-client-v2.js +83 -77
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +83 -77
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +83 -77
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +137 -12
  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 +5 -3
  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 +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/MobileDevicesApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/RecordingApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -4
  51. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +2 -2
  66. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class JourneyApi {
5
5
  /**
6
6
  * Journey service.
7
7
  * @module purecloud-platform-client-v2/api/JourneyApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class KnowledgeApi {
5
5
  /**
6
6
  * Knowledge service.
7
7
  * @module purecloud-platform-client-v2/api/KnowledgeApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
5
5
  /**
6
6
  * LanguageUnderstanding service.
7
7
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LanguagesApi {
5
5
  /**
6
6
  * Languages service.
7
7
  * @module purecloud-platform-client-v2/api/LanguagesApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LearningApi {
5
5
  /**
6
6
  * Learning service.
7
7
  * @module purecloud-platform-client-v2/api/LearningApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LicenseApi {
5
5
  /**
6
6
  * License service.
7
7
  * @module purecloud-platform-client-v2/api/LicenseApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LocationsApi {
5
5
  /**
6
6
  * Locations service.
7
7
  * @module purecloud-platform-client-v2/api/LocationsApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class MobileDevicesApi {
5
5
  /**
6
6
  * MobileDevices service.
7
7
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class NotificationsApi {
5
5
  /**
6
6
  * Notifications service.
7
7
  * @module purecloud-platform-client-v2/api/NotificationsApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OAuthApi {
5
5
  /**
6
6
  * OAuth service.
7
7
  * @module purecloud-platform-client-v2/api/OAuthApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ObjectsApi {
5
5
  /**
6
6
  * Objects service.
7
7
  * @module purecloud-platform-client-v2/api/ObjectsApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OrganizationApi {
5
5
  /**
6
6
  * Organization service.
7
7
  * @module purecloud-platform-client-v2/api/OrganizationApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
5
5
  /**
6
6
  * OrganizationAuthorization service.
7
7
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OutboundApi {
5
5
  /**
6
6
  * Outbound service.
7
7
  * @module purecloud-platform-client-v2/api/OutboundApi
8
- * @version 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class PresenceApi {
5
5
  /**
6
6
  * Presence service.
7
7
  * @module purecloud-platform-client-v2/api/PresenceApi
8
- * @version 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -211,11 +211,11 @@ class RecordingApi {
211
211
  * @param {String} conversationId Conversation ID
212
212
  * @param {String} recordingId Recording ID
213
213
  * @param {Object} opts Optional parameters
214
- * @param {Object} opts.formatId The desired media format. (default to WEBM)
215
- * @param {Object} opts.emailFormatId The desired media format when downloading an email recording. (default to EML)
216
- * @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. (default to ZIP)
217
- * @param {Object} opts.messageFormatId The desired media format when downloading a message recording. (default to ZIP)
218
- * @param {Boolean} opts.download requesting a download format of the recording (default to false)
214
+ * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE (default to WEBM)
215
+ * @param {Object} opts.emailFormatId The desired media format when downloading an email recording. Valid values:EML,NONE (default to EML)
216
+ * @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. Valid values:ZIP,NONE (default to ZIP)
217
+ * @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
218
+ * @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
219
219
  * @param {String} opts.fileName the name of the downloaded fileName
220
220
  * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
221
221
  */
@@ -311,7 +311,7 @@ class RecordingApi {
311
311
  }
312
312
 
313
313
  /**
314
- * Get recording metadata for a conversation. Does not return playable media.
314
+ * Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if recording:recording:view permission is missing.
315
315
  *
316
316
  * @param {String} conversationId Conversation ID
317
317
  */
@@ -371,7 +371,7 @@ class RecordingApi {
371
371
  * @param {String} conversationId Conversation ID
372
372
  * @param {Object} opts Optional parameters
373
373
  * @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
374
- * @param {Object} opts.formatId The desired media format (default to WEBM)
374
+ * @param {Object} opts.formatId The desired media format . Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
375
375
  */
376
376
  getConversationRecordings(conversationId, opts) {
377
377
  opts = opts || {};
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1443,10 +1443,14 @@ class RoutingApi {
1443
1443
  *
1444
1444
  * @param {Object} opts Optional parameters
1445
1445
  * @param {String} opts.phoneNumber Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.
1446
- * @param {Object} opts.phoneNumberType Filter on phone number type
1447
- * @param {Object} opts.phoneNumberStatus Filter on phone number status
1446
+ * @param {Array.<String>} opts.phoneNumberType Filter on phone number type
1447
+ * @param {Array.<String>} opts.phoneNumberStatus Filter on phone number status
1448
+ * @param {Array.<String>} opts.countryCode Filter on country code
1448
1449
  * @param {Number} opts.pageSize Page size (default to 25)
1449
1450
  * @param {Number} opts.pageNumber Page number (default to 1)
1451
+ * @param {Object} opts.sortBy Optional field to sort results
1452
+ * @param {Object} opts.sortOrder Sort order
1453
+ * @param {String} opts.language A language tag (which is sometimes referred to as a \&quot;locale identifier\&quot;) to use to localize country field and sort operations (default to en-US)
1450
1454
  */
1451
1455
  getRoutingSmsPhonenumbers(opts) {
1452
1456
  opts = opts || {};
@@ -1456,7 +1460,7 @@ class RoutingApi {
1456
1460
  '/api/v2/routing/sms/phonenumbers',
1457
1461
  'GET',
1458
1462
  { },
1459
- { 'phoneNumber': opts['phoneNumber'],'phoneNumberType': opts['phoneNumberType'],'phoneNumberStatus': opts['phoneNumberStatus'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
1463
+ { 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'] },
1460
1464
  { },
1461
1465
  { },
1462
1466
  null,
@@ -5,7 +5,7 @@ class SCIMApi {
5
5
  /**
6
6
  * SCIM service.
7
7
  * @module purecloud-platform-client-v2/api/SCIMApi
8
- * @version 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -41,7 +41,7 @@ class UtilitiesApi {
41
41
  }
42
42
 
43
43
  /**
44
- * Get public ip address ranges for PureCloud
44
+ * Get public ip address ranges for Genesys Cloud
45
45
  *
46
46
  */
47
47
  getIpranges() {
@@ -5,7 +5,7 @@ class VoicemailApi {
5
5
  /**
6
6
  * Voicemail service.
7
7
  * @module purecloud-platform-client-v2/api/VoicemailApi
8
- * @version 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.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 129.0.0
8
+ * @version 130.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -93,7 +93,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
93
93
  * </pre>
94
94
  * </p>
95
95
  * @module purecloud-platform-client-v2/index
96
- * @version 129.0.0
96
+ * @version 130.0.0
97
97
  */
98
98
  class platformClient {
99
99
  constructor() {