purecloud-platform-client-v2 191.0.0 → 192.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 (85) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +417 -168
  3. package/dist/web-amd/purecloud-platform-client-v2.js +417 -168
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +203 -126
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +251 -161
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +438 -247
  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 +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 +13 -5
  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 +127 -39
  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 +30 -16
  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 +1 -1
  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 +45 -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 +3 -2
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +22 -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 +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OutboundApi.js +4 -3
  54. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/QualityApi.js +3 -3
  57. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
  66. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +79 -1
  69. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -22
  72. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UsageApi.js +8 -3
  76. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -5
  78. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WebChatApi.js +5 -3
  81. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class TeamsApi {
5
5
  /**
6
6
  * Teams service.
7
7
  * @module purecloud-platform-client-v2/api/TeamsApi
8
- * @version 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -772,27 +772,6 @@ class TelephonyProvidersEdgeApi {
772
772
  );
773
773
  }
774
774
 
775
- /**
776
- * Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
777
- *
778
- * @deprecated
779
- */
780
- getTelephonyProvidersEdgesAvailablelanguages() {
781
-
782
- return this.apiClient.callApi(
783
- '/api/v2/telephony/providers/edges/availablelanguages',
784
- 'GET',
785
- { },
786
- { },
787
- { },
788
- { },
789
- null,
790
- ['PureCloud OAuth'],
791
- ['application/json'],
792
- ['application/json']
793
- );
794
- }
795
-
796
775
  /**
797
776
  * Get the list of certificate authorities.
798
777
  *
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -108,8 +108,13 @@ class UsageApi {
108
108
  * Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
109
109
  *
110
110
  * @param {String} executionId ID of the search execution
111
+ * @param {Object} opts Optional parameters
112
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned
113
+ * @param {Number} opts.pageSize The max number of entities to be returned per request. Maximum page size of 1000
111
114
  */
112
- getUsageSimplesearchExecutionIdResults(executionId) {
115
+ getUsageSimplesearchExecutionIdResults(executionId, opts) {
116
+ opts = opts || {};
117
+
113
118
  // verify the required parameter 'executionId' is set
114
119
  if (executionId === undefined || executionId === null) {
115
120
  throw 'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';
@@ -119,7 +124,7 @@ class UsageApi {
119
124
  '/api/v2/usage/simplesearch/{executionId}/results',
120
125
  'GET',
121
126
  { 'executionId': executionId },
122
- { },
127
+ { 'after': opts['after'],'pageSize': opts['pageSize'] },
123
128
  { },
124
129
  { },
125
130
  null,
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -501,8 +501,12 @@ class UsersApi {
501
501
  * Returns a listing of roles and permissions for a user.
502
502
  *
503
503
  * @param {String} subjectId Subject ID (user or group)
504
+ * @param {Object} opts Optional parameters
505
+ * @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
504
506
  */
505
- getAuthorizationSubject(subjectId) {
507
+ getAuthorizationSubject(subjectId, opts) {
508
+ opts = opts || {};
509
+
506
510
  // verify the required parameter 'subjectId' is set
507
511
  if (subjectId === undefined || subjectId === null) {
508
512
  throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
@@ -512,7 +516,7 @@ class UsersApi {
512
516
  '/api/v2/authorization/subjects/{subjectId}',
513
517
  'GET',
514
518
  { 'subjectId': subjectId },
515
- { },
519
+ { 'includeDuplicates': opts['includeDuplicates'] },
516
520
  { },
517
521
  { },
518
522
  null,
@@ -525,14 +529,18 @@ class UsersApi {
525
529
  /**
526
530
  * Returns a listing of roles and permissions for the currently authenticated user.
527
531
  *
532
+ * @param {Object} opts Optional parameters
533
+ * @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
528
534
  */
529
- getAuthorizationSubjectsMe() {
535
+ getAuthorizationSubjectsMe(opts) {
536
+ opts = opts || {};
537
+
530
538
 
531
539
  return this.apiClient.callApi(
532
540
  '/api/v2/authorization/subjects/me',
533
541
  'GET',
534
542
  { },
535
- { },
543
+ { 'includeDuplicates': opts['includeDuplicates'] },
536
544
  { },
537
545
  { },
538
546
  null,
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -145,9 +145,10 @@ class WebChatApi {
145
145
 
146
146
  /**
147
147
  * Get a media request in the conversation
148
- *
148
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
149
149
  * @param {String} conversationId conversationId
150
150
  * @param {String} mediaRequestId mediaRequestId
151
+ * @deprecated
151
152
  */
152
153
  getWebchatGuestConversationMediarequest(conversationId, mediaRequestId) {
153
154
  // verify the required parameter 'conversationId' is set
@@ -343,10 +344,11 @@ class WebChatApi {
343
344
 
344
345
  /**
345
346
  * Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
346
- *
347
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
347
348
  * @param {String} conversationId conversationId
348
349
  * @param {String} mediaRequestId mediaRequestId
349
350
  * @param {Object} body Request
351
+ * @deprecated
350
352
  */
351
353
  patchWebchatGuestConversationMediarequest(conversationId, mediaRequestId, body) {
352
354
  // verify the required parameter 'conversationId' 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 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.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 191.0.0
8
+ * @version 192.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -107,7 +107,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
107
107
  * </pre>
108
108
  * </p>
109
109
  * @module purecloud-platform-client-v2/index
110
- * @version 191.0.0
110
+ * @version 192.0.0
111
111
  */
112
112
  class platformClient {
113
113
  constructor() {