purecloud-platform-client-v2 223.0.0 → 224.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 (93) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1046 -116
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1046 -116
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +378 -120
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +378 -120
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +730 -249
  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/AIStudioApi.js +387 -0
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +4 -2
  18. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +49 -4
  22. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +292 -16
  27. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +89 -2
  40. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +27 -1
  44. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/RoutingApi.js +31 -1
  67. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
  78. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +43 -2
  80. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UsersApi.js +31 -1
  86. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
  88. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +16 -10
  93. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class TokensApi {
5
5
  /**
6
6
  * Tokens service.
7
7
  * @module purecloud-platform-client-v2/api/TokensApi
8
- * @version 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1594,6 +1594,36 @@ class UsersApi {
1594
1594
  );
1595
1595
  }
1596
1596
 
1597
+ /**
1598
+ * Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required
1599
+ *
1600
+ * @param {Object} opts Optional parameters
1601
+ * @param {String} opts.cursor Cursor token to retrieve next page
1602
+ * @param {Number} opts.pageSize Page size (default to 25)
1603
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
1604
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
1605
+ * @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. When using this parameter the maximum number of users that can be returned is 100.
1606
+ * @param {Object} opts.state Only list users of this state (default to active)
1607
+ * getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1608
+ */
1609
+ getUsersQuery(opts) {
1610
+ opts = opts || {};
1611
+
1612
+
1613
+ return this.apiClient.callApi(
1614
+ '/api/v2/users/query',
1615
+ 'GET',
1616
+ { },
1617
+ { 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
1618
+ { },
1619
+ { },
1620
+ null,
1621
+ ['PureCloud OAuth'],
1622
+ ['application/json'],
1623
+ ['application/json']
1624
+ );
1625
+ }
1626
+
1597
1627
  /**
1598
1628
  * Search users using the q64 value returned from a previous search
1599
1629
  *
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -261,7 +261,7 @@ class VoicemailApi {
261
261
 
262
262
  /**
263
263
  * Get media playback URI for this voicemail message
264
- *
264
+ * API should migrate to use GET api/v2/voicemail/messages/{messageId}/downloads
265
265
  * @param {String} messageId Message ID
266
266
  * @param {Object} opts Optional parameters
267
267
  * @param {Object} opts.formatId The desired media format. (default to WEBM)
@@ -5,7 +5,7 @@ class WebChatApi {
5
5
  /**
6
6
  * WebChat service.
7
7
  * @module purecloud-platform-client-v2/api/WebChatApi
8
- * @version 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.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 223.0.0
8
+ * @version 224.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1618,6 +1618,7 @@ class WorkforceManagementApi {
1618
1618
  * @param {String} businessUnitId The ID of the business unit
1619
1619
  * @param {Object} opts Optional parameters
1620
1620
  * @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
1621
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
1621
1622
  */
1622
1623
  getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
1623
1624
  opts = opts || {};
@@ -1631,7 +1632,7 @@ class WorkforceManagementApi {
1631
1632
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
1632
1633
  'GET',
1633
1634
  { 'businessUnitId': businessUnitId },
1634
- { 'managementUnitId': opts['managementUnitId'] },
1635
+ { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
1635
1636
  { },
1636
1637
  { },
1637
1638
  null,
@@ -5335,8 +5336,12 @@ class WorkforceManagementApi {
5335
5336
  *
5336
5337
  * @param {String} businessUnitId The ID of the business unit
5337
5338
  * @param {Object} body body
5339
+ * @param {Object} opts Optional parameters
5340
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service
5338
5341
  */
5339
- postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, body) {
5342
+ postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, body, opts) {
5343
+ opts = opts || {};
5344
+
5340
5345
  // verify the required parameter 'businessUnitId' is set
5341
5346
  if (businessUnitId === undefined || businessUnitId === null) {
5342
5347
  throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
@@ -5350,7 +5355,7 @@ class WorkforceManagementApi {
5350
5355
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
5351
5356
  'POST',
5352
5357
  { 'businessUnitId': businessUnitId },
5353
- { },
5358
+ { 'forceDownloadService': opts['forceDownloadService'] },
5354
5359
  { },
5355
5360
  { },
5356
5361
  body,
@@ -6033,12 +6038,9 @@ class WorkforceManagementApi {
6033
6038
  *
6034
6039
  * @param {String} businessUnitId The ID of the business unit
6035
6040
  * @param {String} bidId The ID of the work plan bid to copy
6036
- * @param {Object} opts Optional parameters
6037
- * @param {Object} opts.body body
6041
+ * @param {Object} body body
6038
6042
  */
6039
- postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, opts) {
6040
- opts = opts || {};
6041
-
6043
+ postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, body) {
6042
6044
  // verify the required parameter 'businessUnitId' is set
6043
6045
  if (businessUnitId === undefined || businessUnitId === null) {
6044
6046
  throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
@@ -6047,6 +6049,10 @@ class WorkforceManagementApi {
6047
6049
  if (bidId === undefined || bidId === null) {
6048
6050
  throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
6049
6051
  }
6052
+ // verify the required parameter 'body' is set
6053
+ if (body === undefined || body === null) {
6054
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
6055
+ }
6050
6056
 
6051
6057
  return this.apiClient.callApi(
6052
6058
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
@@ -6055,7 +6061,7 @@ class WorkforceManagementApi {
6055
6061
  { },
6056
6062
  { },
6057
6063
  { },
6058
- opts['body'],
6064
+ body,
6059
6065
  ['PureCloud OAuth'],
6060
6066
  ['application/json'],
6061
6067
  ['application/json']
@@ -4,6 +4,7 @@ import DefaultHttpClient from './DefaultHttpClient.js';
4
4
  import AbstractHttpClient from './AbstractHttpClient.js';
5
5
  import HttpRequestOptions from './HttpRequestOptions.js';
6
6
  import ApiClient from './ApiClient.js';
7
+ import AIStudioApi from './api/AIStudioApi.js';
7
8
  import AgentAssistantsApi from './api/AgentAssistantsApi.js';
8
9
  import AgentCopilotApi from './api/AgentCopilotApi.js';
9
10
  import AgentUIApi from './api/AgentUIApi.js';
@@ -117,7 +118,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
117
118
  * </pre>
118
119
  * </p>
119
120
  * @module purecloud-platform-client-v2/index
120
- * @version 223.0.0
121
+ * @version 224.0.0
121
122
  */
122
123
  class platformClient {
123
124
  constructor() {
@@ -131,6 +132,11 @@ class platformClient {
131
132
  * @property {module:purecloud-platform-client-v2/ApiClient}
132
133
  */
133
134
  this.ApiClientClass = ApiClient;
135
+ /**
136
+ * The AIStudioApi service constructor.
137
+ * @property {module:purecloud-platform-client-v2/api/AIStudioApi}
138
+ */
139
+ this.AIStudioApi = AIStudioApi;
134
140
  /**
135
141
  * The AgentAssistantsApi service constructor.
136
142
  * @property {module:purecloud-platform-client-v2/api/AgentAssistantsApi}