purecloud-platform-client-v2 217.0.0 → 218.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 (91) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1069 -209
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1069 -209
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +342 -169
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +342 -169
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +822 -79
  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 -4
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +61 -1
  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/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -4
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +249 -1
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmailsApi.js +65 -1
  29. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +77 -1
  32. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +31 -1
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -6
  44. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -70
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -11
  60. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -2
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +4 -3
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +65 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +403 -20
  71. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebChatApi.js +19 -10
  87. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class PresenceApi {
5
5
  /**
6
6
  * Presence service.
7
7
  * @module purecloud-platform-client-v2/api/PresenceApi
8
- * @version 217.0.0
8
+ * @version 218.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -25,10 +25,10 @@ class PresenceApi {
25
25
  *
26
26
  * @param {String} definitionId Presence Definition ID
27
27
  */
28
- deletePresenceDefinition0(definitionId) {
28
+ deleteDivisionBasedPresenceDefinition(definitionId) {
29
29
  // verify the required parameter 'definitionId' is set
30
30
  if (definitionId === undefined || definitionId === null) {
31
- throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
31
+ throw 'Missing the required parameter "definitionId" when calling deleteDivisionBasedPresenceDefinition';
32
32
  }
33
33
 
34
34
  return this.apiClient.callApi(
@@ -103,12 +103,12 @@ class PresenceApi {
103
103
  * @param {Object} opts Optional parameters
104
104
  * @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
105
105
  */
106
- getPresenceDefinition0(definitionId, opts) {
106
+ getDivisionBasedPresenceDefinition(definitionId, opts) {
107
107
  opts = opts || {};
108
108
 
109
109
  // verify the required parameter 'definitionId' is set
110
110
  if (definitionId === undefined || definitionId === null) {
111
- throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
111
+ throw 'Missing the required parameter "definitionId" when calling getDivisionBasedPresenceDefinition';
112
112
  }
113
113
 
114
114
  return this.apiClient.callApi(
@@ -133,7 +133,7 @@ class PresenceApi {
133
133
  * @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
134
134
  * @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
135
135
  */
136
- getPresenceDefinitions0(opts) {
136
+ getDivisionBasedPresenceDefinitions(opts) {
137
137
  opts = opts || {};
138
138
 
139
139
 
@@ -501,10 +501,10 @@ class PresenceApi {
501
501
  *
502
502
  * @param {Object} body The Presence Definition to create
503
503
  */
504
- postPresenceDefinitions0(body) {
504
+ postDivisionBasedPresenceDefinitions(body) {
505
505
  // verify the required parameter 'body' is set
506
506
  if (body === undefined || body === null) {
507
- throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
507
+ throw 'Missing the required parameter "body" when calling postDivisionBasedPresenceDefinitions';
508
508
  }
509
509
 
510
510
  return this.apiClient.callApi(
@@ -578,14 +578,14 @@ class PresenceApi {
578
578
  * @param {String} definitionId Presence Definition ID
579
579
  * @param {Object} body The updated Presence Definition
580
580
  */
581
- putPresenceDefinition0(definitionId, body) {
581
+ putDivisionBasedPresenceDefinition(definitionId, body) {
582
582
  // verify the required parameter 'definitionId' is set
583
583
  if (definitionId === undefined || definitionId === null) {
584
- throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
584
+ throw 'Missing the required parameter "definitionId" when calling putDivisionBasedPresenceDefinition';
585
585
  }
586
586
  // verify the required parameter 'body' is set
587
587
  if (body === undefined || body === null) {
588
- throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
588
+ throw 'Missing the required parameter "body" when calling putDivisionBasedPresenceDefinition';
589
589
  }
590
590
 
591
591
  return this.apiClient.callApi(
@@ -5,7 +5,7 @@ class ProcessAutomationApi {
5
5
  /**
6
6
  * ProcessAutomation service.
7
7
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
8
- * @version 217.0.0
8
+ * @version 218.1.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 217.0.0
8
+ * @version 218.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -1701,7 +1701,6 @@ class QualityApi {
1701
1701
  *
1702
1702
  * @param {String} formId Form ID
1703
1703
  * @param {Object} body AI Scoring Settings
1704
- * putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1705
1704
  */
1706
1705
  putQualityFormsEvaluationAiscoringSettings(formId, body) {
1707
1706
  // verify the required parameter 'formId' is set
@@ -5,7 +5,7 @@ class RecordingApi {
5
5
  /**
6
6
  * Recording service.
7
7
  * @module purecloud-platform-client-v2/api/RecordingApi
8
- * @version 217.0.0
8
+ * @version 218.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -312,7 +312,7 @@ class RecordingApi {
312
312
  }
313
313
 
314
314
  /**
315
- * Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.
315
+ * Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.
316
316
  *
317
317
  * @param {String} conversationId Conversation ID
318
318
  */
@@ -375,6 +375,7 @@ class RecordingApi {
375
375
  * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
376
376
  * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
377
377
  * @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
378
+ * @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
378
379
  */
379
380
  getConversationRecordings(conversationId, opts) {
380
381
  opts = opts || {};
@@ -388,7 +389,7 @@ class RecordingApi {
388
389
  '/api/v2/conversations/{conversationId}/recordings',
389
390
  'GET',
390
391
  { 'conversationId': conversationId },
391
- { 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'] },
392
+ { 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'],'includePauseAnnotationsForScreenRecordings': opts['includePauseAnnotationsForScreenRecordings'] },
392
393
  { },
393
394
  { },
394
395
  null,
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 217.0.0
8
+ * @version 218.1.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 217.0.0
8
+ * @version 218.1.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 217.0.0
8
+ * @version 218.1.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 217.0.0
8
+ * @version 218.1.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 217.0.0
8
+ * @version 218.1.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 217.0.0
8
+ * @version 218.1.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 217.0.0
8
+ * @version 218.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -20,6 +20,26 @@ class SettingsApi {
20
20
  }
21
21
 
22
22
 
23
+ /**
24
+ * Reset email threading settings to default
25
+ *
26
+ */
27
+ deleteEmailsSettingsThreading() {
28
+
29
+ return this.apiClient.callApi(
30
+ '/api/v2/emails/settings/threading',
31
+ 'DELETE',
32
+ { },
33
+ { },
34
+ { },
35
+ { },
36
+ null,
37
+ ['PureCloud OAuth'],
38
+ ['application/json'],
39
+ ['application/json']
40
+ );
41
+ }
42
+
23
43
  /**
24
44
  * Delete agent auto answer settings
25
45
  *
@@ -65,6 +85,26 @@ class SettingsApi {
65
85
  );
66
86
  }
67
87
 
88
+ /**
89
+ * Get email threading settings
90
+ *
91
+ */
92
+ getEmailsSettingsThreading() {
93
+
94
+ return this.apiClient.callApi(
95
+ '/api/v2/emails/settings/threading',
96
+ 'GET',
97
+ { },
98
+ { },
99
+ { },
100
+ { },
101
+ null,
102
+ ['PureCloud OAuth'],
103
+ ['application/json'],
104
+ ['application/json']
105
+ );
106
+ }
107
+
68
108
  /**
69
109
  * Get the execution history enabled setting.
70
110
  * Get the execution history enabled setting.
@@ -134,6 +174,30 @@ class SettingsApi {
134
174
  );
135
175
  }
136
176
 
177
+ /**
178
+ * Patch email threading settings
179
+ *
180
+ * @param {Object} opts Optional parameters
181
+ * @param {Object} opts.body
182
+ */
183
+ patchEmailsSettingsThreading(opts) {
184
+ opts = opts || {};
185
+
186
+
187
+ return this.apiClient.callApi(
188
+ '/api/v2/emails/settings/threading',
189
+ 'PATCH',
190
+ { },
191
+ { },
192
+ { },
193
+ { },
194
+ opts['body'],
195
+ ['PureCloud OAuth'],
196
+ ['application/json'],
197
+ ['application/json']
198
+ );
199
+ }
200
+
137
201
  /**
138
202
  * Edit the execution history on off setting.
139
203
  * Edit the execution history on off setting.