purecloud-platform-client-v2 172.0.0 → 173.1.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 (82) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +1061 -96
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1061 -96
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +1061 -96
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +1061 -96
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +430 -19
  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 +337 -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/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 +259 -9
  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 +70 -0
  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 +10 -4
  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 +1 -1
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +3 -3
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/MessagingApi.js +204 -1
  45. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/RoutingApi.js +5 -5
  58. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/SettingsApi.js +70 -0
  62. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +31 -1
  63. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
  69. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +8 -8
  82. package/src/purecloud-platform-client-v2/index.js +13 -1
@@ -5,7 +5,7 @@ class SuggestApi {
5
5
  /**
6
6
  * Suggest service.
7
7
  * @module purecloud-platform-client-v2/api/SuggestApi
8
- * @version 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -1461,7 +1461,7 @@ class TelephonyProvidersEdgeApi {
1461
1461
  /**
1462
1462
  * Get the metrics for a list of edges.
1463
1463
  *
1464
- * @param {String} edgeIds Comma separated list of Edge Id's
1464
+ * @param {String} edgeIds Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.
1465
1465
  */
1466
1466
  getTelephonyProvidersEdgesMetrics(edgeIds) {
1467
1467
  // verify the required parameter 'edgeIds' is set
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.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 172.0.0
8
+ * @version 173.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -744,8 +744,8 @@ class WorkforceManagementApi {
744
744
  *
745
745
  * @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
746
746
  * @param {Object} opts Optional parameters
747
- * @param {Object} opts.feature
748
- * @param {String} opts.divisionId
747
+ * @param {Object} opts.feature If specified, the list of management units for which the user is authorized to use the requested feature will be returned
748
+ * @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
749
749
  */
750
750
  getWorkforcemanagementBusinessunitManagementunits(businessUnitId, opts) {
751
751
  opts = opts || {};
@@ -1384,8 +1384,8 @@ class WorkforceManagementApi {
1384
1384
  * Get business units
1385
1385
  *
1386
1386
  * @param {Object} opts Optional parameters
1387
- * @param {Object} opts.feature
1388
- * @param {String} opts.divisionId
1387
+ * @param {Object} opts.feature If specified, the list of business units for which the user is authorized to use the requested feature will be returned
1388
+ * @param {String} opts.divisionId If specified, the list of business units belonging to the specified division will be returned
1389
1389
  */
1390
1390
  getWorkforcemanagementBusinessunits(opts) {
1391
1391
  opts = opts || {};
@@ -1544,7 +1544,7 @@ class WorkforceManagementApi {
1544
1544
  }
1545
1545
 
1546
1546
  /**
1547
- * Get activity codes
1547
+ * Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
1548
1548
  *
1549
1549
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1550
1550
  * @deprecated
@@ -2192,8 +2192,8 @@ class WorkforceManagementApi {
2192
2192
  * @param {Number} opts.pageSize Deprecated, paging is not supported
2193
2193
  * @param {Number} opts.pageNumber Deprecated, paging is not supported
2194
2194
  * @param {Object} opts.expand Deprecated, expand settings on the single MU route
2195
- * @param {Object} opts.feature
2196
- * @param {String} opts.divisionId
2195
+ * @param {Object} opts.feature If specified, the list of management units for which the user is authorized to use the requested feature will be returned
2196
+ * @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
2197
2197
  */
2198
2198
  getWorkforcemanagementManagementunits(opts) {
2199
2199
  opts = opts || {};
@@ -14,6 +14,7 @@ import ContentManagementApi from './api/ContentManagementApi.js';
14
14
  import ConversationsApi from './api/ConversationsApi.js';
15
15
  import DataExtensionsApi from './api/DataExtensionsApi.js';
16
16
  import DownloadsApi from './api/DownloadsApi.js';
17
+ import EmailsApi from './api/EmailsApi.js';
17
18
  import EventsApi from './api/EventsApi.js';
18
19
  import ExternalContactsApi from './api/ExternalContactsApi.js';
19
20
  import FaxApi from './api/FaxApi.js';
@@ -50,6 +51,7 @@ import RoutingApi from './api/RoutingApi.js';
50
51
  import SCIMApi from './api/SCIMApi.js';
51
52
  import ScriptsApi from './api/ScriptsApi.js';
52
53
  import SearchApi from './api/SearchApi.js';
54
+ import SettingsApi from './api/SettingsApi.js';
53
55
  import SpeechTextAnalyticsApi from './api/SpeechTextAnalyticsApi.js';
54
56
  import StationsApi from './api/StationsApi.js';
55
57
  import SuggestApi from './api/SuggestApi.js';
@@ -102,7 +104,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
102
104
  * </pre>
103
105
  * </p>
104
106
  * @module purecloud-platform-client-v2/index
105
- * @version 172.0.0
107
+ * @version 173.1.0
106
108
  */
107
109
  class platformClient {
108
110
  constructor() {
@@ -181,6 +183,11 @@ class platformClient {
181
183
  * @property {module:purecloud-platform-client-v2/api/DownloadsApi}
182
184
  */
183
185
  this.DownloadsApi = DownloadsApi;
186
+ /**
187
+ * The EmailsApi service constructor.
188
+ * @property {module:purecloud-platform-client-v2/api/EmailsApi}
189
+ */
190
+ this.EmailsApi = EmailsApi;
184
191
  /**
185
192
  * The EventsApi service constructor.
186
193
  * @property {module:purecloud-platform-client-v2/api/EventsApi}
@@ -361,6 +368,11 @@ class platformClient {
361
368
  * @property {module:purecloud-platform-client-v2/api/SearchApi}
362
369
  */
363
370
  this.SearchApi = SearchApi;
371
+ /**
372
+ * The SettingsApi service constructor.
373
+ * @property {module:purecloud-platform-client-v2/api/SettingsApi}
374
+ */
375
+ this.SettingsApi = SettingsApi;
364
376
  /**
365
377
  * The SpeechTextAnalyticsApi service constructor.
366
378
  * @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}