purecloud-platform-client-v2 169.1.0 → 170.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 (80) hide show
  1. package/README.md +6 -4
  2. package/dist/node/purecloud-platform-client-v2.js +774 -365
  3. package/dist/web-amd/purecloud-platform-client-v2.js +774 -365
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +774 -365
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +774 -365
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +211 -35
  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 +44 -44
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +6 -6
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
  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 +4 -4
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +362 -7
  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/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +5 -5
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +9 -9
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +41 -11
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -45
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -29
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +3 -3
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +69 -16
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +16 -16
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +13 -13
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +5 -5
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +50 -46
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +4 -4
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +3 -3
  69. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -13
  73. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
  76. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
  80. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -244,7 +244,7 @@ class UsersApi {
244
244
  * Get status for async query for user aggregates
245
245
  *
246
246
  * @param {String} jobId jobId
247
- * Preview Endpoint
247
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
248
248
  */
249
249
  getAnalyticsUsersAggregatesJob(jobId) {
250
250
  // verify the required parameter 'jobId' is set
@@ -272,7 +272,7 @@ class UsersApi {
272
272
  * @param {String} jobId jobId
273
273
  * @param {Object} opts Optional parameters
274
274
  * @param {String} opts.cursor Cursor token to retrieve next page
275
- * Preview Endpoint
275
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
276
276
  */
277
277
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
278
278
  opts = opts || {};
@@ -377,7 +377,7 @@ class UsersApi {
377
377
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
378
378
  * @param {Object} opts Optional parameters
379
379
  * @param {String} opts.name Search term to filter by division name
380
- * @deprecated
380
+ * @deprecated
381
381
  */
382
382
  getAuthorizationDivisionspermittedMe(permission, opts) {
383
383
  opts = opts || {};
@@ -439,7 +439,7 @@ class UsersApi {
439
439
  * @param {Object} opts Optional parameters
440
440
  * @param {Number} opts.pageNumber Page number (default to 1)
441
441
  * @param {Number} opts.pageSize Page size (default to 25)
442
- * @deprecated
442
+ * @deprecated
443
443
  */
444
444
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
445
445
  opts = opts || {};
@@ -516,7 +516,7 @@ class UsersApi {
516
516
  * Fetch field config for an entity type
517
517
  *
518
518
  * @param {Object} type Field type
519
- * @deprecated
519
+ * @deprecated
520
520
  */
521
521
  getFieldconfig(type) {
522
522
  // verify the required parameter 'type' is set
@@ -549,7 +549,7 @@ class UsersApi {
549
549
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
550
550
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
551
551
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand.
552
- * @deprecated
552
+ * @deprecated
553
553
  */
554
554
  getProfilesUsers(opts) {
555
555
  opts = opts || {};
@@ -717,7 +717,7 @@ class UsersApi {
717
717
  * @param {Number} opts.pageNumber Page number (default to 1)
718
718
  * @param {String} opts.sortOrder Sort order (default to ASC)
719
719
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
720
- * @deprecated
720
+ * @deprecated
721
721
  */
722
722
  getUserFavorites(userId, opts) {
723
723
  opts = opts || {};
@@ -803,7 +803,7 @@ class UsersApi {
803
803
  * @param {Object} opts Optional parameters
804
804
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
805
805
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
806
- * @deprecated
806
+ * @deprecated
807
807
  */
808
808
  getUserProfile(userId, opts) {
809
809
  opts = opts || {};
@@ -1612,7 +1612,7 @@ class UsersApi {
1612
1612
  * @param {Object} opts Optional parameters
1613
1613
  * @param {Number} opts.pageSize The desired page size
1614
1614
  * @param {Number} opts.pageNumber The desired page number
1615
- * Preview Endpoint
1615
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1616
1616
  */
1617
1617
  postAnalyticsUsersActivityQuery(body, opts) {
1618
1618
  opts = opts || {};
@@ -1640,7 +1640,7 @@ class UsersApi {
1640
1640
  * Query for user aggregates asynchronously
1641
1641
  *
1642
1642
  * @param {Object} body query
1643
- * Preview Endpoint
1643
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1644
1644
  */
1645
1645
  postAnalyticsUsersAggregatesJobs(body) {
1646
1646
  // verify the required parameter 'body' is set
@@ -2152,7 +2152,7 @@ class UsersApi {
2152
2152
  * Search users as conversation targets
2153
2153
  *
2154
2154
  * @param {Object} body Search request options
2155
- * Preview Endpoint
2155
+ * postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2156
2156
  */
2157
2157
  postUsersSearchConversationTarget(body) {
2158
2158
  // verify the required parameter 'body' is set
@@ -2178,7 +2178,7 @@ class UsersApi {
2178
2178
  * Search manage queue member
2179
2179
  *
2180
2180
  * @param {Object} body Search request options
2181
- * Preview Endpoint
2181
+ * postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2182
2182
  */
2183
2183
  postUsersSearchQueuemembersManage(body) {
2184
2184
  // verify the required parameter 'body' is set
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 169.1.0
8
+ * @version 170.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 169.1.0
8
+ * @version 170.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 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,7 +24,7 @@ class WebChatApi {
24
24
  * Delete a WebChat deployment
25
25
  *
26
26
  * @param {String} deploymentId Deployment Id
27
- * @deprecated
27
+ * @deprecated
28
28
  */
29
29
  deleteWebchatDeployment(deploymentId) {
30
30
  // verify the required parameter 'deploymentId' is set
@@ -100,7 +100,7 @@ class WebChatApi {
100
100
  * Get a WebChat deployment
101
101
  *
102
102
  * @param {String} deploymentId Deployment Id
103
- * @deprecated
103
+ * @deprecated
104
104
  */
105
105
  getWebchatDeployment(deploymentId) {
106
106
  // verify the required parameter 'deploymentId' is set
@@ -125,7 +125,7 @@ class WebChatApi {
125
125
  /**
126
126
  * List WebChat deployments
127
127
  *
128
- * @deprecated
128
+ * @deprecated
129
129
  */
130
130
  getWebchatDeployments() {
131
131
 
@@ -380,7 +380,7 @@ class WebChatApi {
380
380
  * Create WebChat deployment
381
381
  *
382
382
  * @param {Object} body Deployment
383
- * @deprecated
383
+ * @deprecated
384
384
  */
385
385
  postWebchatDeployments(body) {
386
386
  // verify the required parameter 'body' is set
@@ -497,7 +497,7 @@ class WebChatApi {
497
497
  *
498
498
  * @param {String} deploymentId Deployment Id
499
499
  * @param {Object} body Deployment
500
- * @deprecated
500
+ * @deprecated
501
501
  */
502
502
  putWebchatDeployment(deploymentId, body) {
503
503
  // verify the required parameter 'deploymentId' is set
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 169.1.0
8
+ * @version 170.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 169.1.0
8
+ * @version 170.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 169.1.0
8
+ * @version 170.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 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1547,7 +1547,7 @@ class WorkforceManagementApi {
1547
1547
  * Get 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
- * @deprecated
1550
+ * @deprecated
1551
1551
  */
1552
1552
  getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
1553
1553
  // verify the required parameter 'managementUnitId' is set
@@ -1960,7 +1960,7 @@ class WorkforceManagementApi {
1960
1960
  * @param {Object} opts Optional parameters
1961
1961
  * @param {Object} opts.expand Which fields, if any, to expand
1962
1962
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
1963
- * @deprecated
1963
+ * @deprecated
1964
1964
  */
1965
1965
  getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
1966
1966
  opts = opts || {};
@@ -2001,7 +2001,7 @@ class WorkforceManagementApi {
2001
2001
  * @param {Boolean} opts.includeOnlyPublished Return only published schedules
2002
2002
  * @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
2003
2003
  * @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
2004
- * @deprecated
2004
+ * @deprecated
2005
2005
  */
2006
2006
  getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
2007
2007
  opts = opts || {};
@@ -3960,7 +3960,7 @@ class WorkforceManagementApi {
3960
3960
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3961
3961
  * @param {Object} opts Optional parameters
3962
3962
  * @param {Object} opts.body body
3963
- * @deprecated
3963
+ * @deprecated
3964
3964
  */
3965
3965
  postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
3966
3966
  opts = opts || {};
@@ -4621,7 +4621,7 @@ class WorkforceManagementApi {
4621
4621
  *
4622
4622
  * @param {Object} opts Optional parameters
4623
4623
  * @param {Object} opts.body body
4624
- * @deprecated
4624
+ * @deprecated
4625
4625
  */
4626
4626
  postWorkforcemanagementSchedules(opts) {
4627
4627
  opts = opts || {};
@@ -102,7 +102,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
102
102
  * </pre>
103
103
  * </p>
104
104
  * @module purecloud-platform-client-v2/index
105
- * @version 169.1.0
105
+ * @version 170.0.0
106
106
  */
107
107
  class platformClient {
108
108
  constructor() {