purecloud-platform-client-v2 221.0.0 → 222.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 (92) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +210 -95
  3. package/dist/web-amd/purecloud-platform-client-v2.js +210 -95
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +124 -95
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +124 -95
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +448 -250
  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/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +119 -7
  26. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +3 -3
  33. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +2 -2
  76. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +3 -2
  80. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +3 -2
  92. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class MobileDevicesApi {
5
5
  /**
6
6
  * MobileDevices service.
7
7
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
8
- * @version 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OperationalEventsApi {
5
5
  /**
6
6
  * OperationalEvents service.
7
7
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
8
- * @version 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ProcessAutomationApi {
5
5
  /**
6
6
  * ProcessAutomation service.
7
7
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
8
- * @version 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ScreenRecordingApi {
5
5
  /**
6
6
  * ScreenRecording service.
7
7
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
8
- * @version 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SettingsApi {
5
5
  /**
6
6
  * Settings service.
7
7
  * @module purecloud-platform-client-v2/api/SettingsApi
8
- * @version 221.0.0
8
+ * @version 222.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SocialMediaApi {
5
5
  /**
6
6
  * SocialMedia service.
7
7
  * @module purecloud-platform-client-v2/api/SocialMediaApi
8
- * @version 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.0.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 221.0.0
8
+ * @version 222.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -875,7 +875,7 @@ class TaskManagementApi {
875
875
  }
876
876
 
877
877
  /**
878
- * Get the core types from which all schemas are built.
878
+ * Get a specific named core type.
879
879
  *
880
880
  * @param {String} coreTypeName Name of the core type
881
881
  */
@@ -5,7 +5,7 @@ class TeamsApi {
5
5
  /**
6
6
  * Teams service.
7
7
  * @module purecloud-platform-client-v2/api/TeamsApi
8
- * @version 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -27,6 +27,7 @@ class TextbotsApi {
27
27
  * @param {Array.<String>} opts.botType Bot types
28
28
  * @param {String} opts.botName Bot name
29
29
  * @param {Array.<String>} opts.botId Bot IDs. Maximum of 50
30
+ * @param {Boolean} opts.virtualAgentEnabled Include or exclude virtual agent flows, only applies to GenesysBotFlows or GenesysDigitalBotFlows
30
31
  * @param {Number} opts.pageSize The maximum results to return. Maximum of 100 (default to 25)
31
32
  */
32
33
  getTextbotsBotsSearch(opts) {
@@ -37,7 +38,7 @@ class TextbotsApi {
37
38
  '/api/v2/textbots/bots/search',
38
39
  'GET',
39
40
  { },
40
- { 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
41
+ { 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'virtualAgentEnabled': opts['virtualAgentEnabled'],'pageSize': opts['pageSize'] },
41
42
  { },
42
43
  { },
43
44
  null,
@@ -5,7 +5,7 @@ class TokensApi {
5
5
  /**
6
6
  * Tokens service.
7
7
  * @module purecloud-platform-client-v2/api/TokensApi
8
- * @version 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.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 221.0.0
8
+ * @version 222.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -3204,6 +3204,7 @@ class WorkforceManagementApi {
3204
3204
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3205
3205
  * @param {Object} opts Optional parameters
3206
3206
  * @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
3207
+ * @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
3207
3208
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
3208
3209
  */
3209
3210
  getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
@@ -3222,7 +3223,7 @@ class WorkforceManagementApi {
3222
3223
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades',
3223
3224
  'GET',
3224
3225
  { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
3225
- { 'evaluateMatches': opts['evaluateMatches'],'forceDownloadService': opts['forceDownloadService'] },
3226
+ { 'evaluateMatches': opts['evaluateMatches'],'includeCrossWeekShifts': opts['includeCrossWeekShifts'],'forceDownloadService': opts['forceDownloadService'] },
3226
3227
  { },
3227
3228
  { },
3228
3229
  null,
@@ -117,7 +117,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
117
117
  * </pre>
118
118
  * </p>
119
119
  * @module purecloud-platform-client-v2/index
120
- * @version 221.0.0
120
+ * @version 222.0.0
121
121
  */
122
122
  class platformClient {
123
123
  constructor() {