purecloud-platform-client-v2 218.1.0 → 220.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 (91) hide show
  1. package/README.md +4 -4
  2. package/dist/node/purecloud-platform-client-v2.js +1195 -118
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1195 -118
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +390 -130
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +390 -130
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1494 -763
  9. package/package.json +2 -2
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  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 +2 -2
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +54 -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 -1
  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 +37 -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 +1 -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 +399 -5
  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 +366 -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 +1 -1
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  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 +54 -1
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +60 -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 -1
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -3
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +6 -4
  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 +33 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  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 +66 -10
  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 +1 -1
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +3 -3
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -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 +1 -1
  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 +1 -1
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -5
  91. package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "218.1.0",
3
+ "version": "220.0.0",
4
4
  "description": "A JavaScript library to interface with the PureCloud Platform API",
5
5
  "license": "MIT",
6
6
  "main": "dist/node/purecloud-platform-client-v2.js",
@@ -27,7 +27,7 @@
27
27
  "author": {
28
28
  "name": "Genesys Developer Evangelists",
29
29
  "email": "DeveloperEvangelists@genesys.com",
30
- "url": "https://developer.mypurecloud.com"
30
+ "url": "https://developer.genesys.cloud/"
31
31
  },
32
32
  "dependencies": {
33
33
  "axios": "^1.7.4",
@@ -6,7 +6,7 @@ import { default as qs } from 'qs';
6
6
 
7
7
  /**
8
8
  * @module purecloud-platform-client-v2/ApiClient
9
- * @version 218.1.0
9
+ * @version 220.0.0
10
10
  */
11
11
  class ApiClient {
12
12
  /**
@@ -101,7 +101,7 @@ class ApiClient {
101
101
  /**
102
102
  * The default HTTP timeout for all API calls.
103
103
  * @type {Number}
104
- * @default 60000
104
+ * @default 16000
105
105
  */
106
106
  this.timeout = 16000;
107
107
 
@@ -5,7 +5,7 @@ class AgentAssistantsApi {
5
5
  /**
6
6
  * AgentAssistants service.
7
7
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AgentCopilotApi {
5
5
  /**
6
6
  * AgentCopilot service.
7
7
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AgentUIApi {
5
5
  /**
6
6
  * AgentUI service.
7
7
  * @module purecloud-platform-client-v2/api/AgentUIApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AlertingApi {
5
5
  /**
6
6
  * Alerting service.
7
7
  * @module purecloud-platform-client-v2/api/AlertingApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AnalyticsApi {
5
5
  /**
6
6
  * Analytics service.
7
7
  * @module purecloud-platform-client-v2/api/AnalyticsApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ArchitectApi {
5
5
  /**
6
6
  * Architect service.
7
7
  * @module purecloud-platform-client-v2/api/ArchitectApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1400,7 +1400,7 @@ class ArchitectApi {
1400
1400
  * @param {Number} opts.pageNumber Page number (default to 1)
1401
1401
  * @param {Number} opts.pageSize Page size (default to 25)
1402
1402
  * @param {String} opts.sortBy Sort by (default to name)
1403
- * @param {String} opts.sortOrder Sort order (default to ASC)
1403
+ * @param {String} opts.sortOrder Sort order (default to asc)
1404
1404
  * @param {String} opts.name Name of the Schedule to filter by.
1405
1405
  * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
1406
1406
  */
@@ -5,7 +5,7 @@ class AuditApi {
5
5
  /**
6
6
  * Audit service.
7
7
  * @module purecloud-platform-client-v2/api/AuditApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AuthorizationApi {
5
5
  /**
6
6
  * Authorization service.
7
7
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -231,6 +231,31 @@ class AuthorizationApi {
231
231
  );
232
232
  }
233
233
 
234
+ /**
235
+ * Get a list of soft deleted divisions for the org
236
+ *
237
+ * @param {Object} opts Optional parameters
238
+ * @param {Number} opts.pageNumber Page number (default to 1)
239
+ * @param {Number} opts.pageSize Page size (default to 25)
240
+ */
241
+ getAuthorizationDivisionsDeleted(opts) {
242
+ opts = opts || {};
243
+
244
+
245
+ return this.apiClient.callApi(
246
+ '/api/v2/authorization/divisions/deleted',
247
+ 'GET',
248
+ { },
249
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
250
+ { },
251
+ { },
252
+ null,
253
+ ['PureCloud OAuth'],
254
+ ['application/json'],
255
+ ['application/json']
256
+ );
257
+ }
258
+
234
259
  /**
235
260
  * Retrieve the home division for the organization.
236
261
  * Will not include object counts.
@@ -271,6 +296,34 @@ class AuthorizationApi {
271
296
  );
272
297
  }
273
298
 
299
+ /**
300
+ * Retrieve a list of all divisions defined for the organization with cursor
301
+ * Use "after" and "before" param to fetch next/previous page}
302
+ * @param {Object} opts Optional parameters
303
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
304
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
305
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
306
+ * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
307
+ * @param {String} opts.name Optionally request specific divisions by division name
308
+ */
309
+ getAuthorizationDivisionsQuery(opts) {
310
+ opts = opts || {};
311
+
312
+
313
+ return this.apiClient.callApi(
314
+ '/api/v2/authorization/divisions/query',
315
+ 'GET',
316
+ { },
317
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
318
+ { },
319
+ { },
320
+ null,
321
+ ['PureCloud OAuth'],
322
+ ['application/json'],
323
+ ['application/json']
324
+ );
325
+ }
326
+
274
327
  /**
275
328
  * Returns which divisions the current user has the given permission in.
276
329
  * This route is deprecated, use authorization/divisionspermitted/paged/me instead.
@@ -5,7 +5,7 @@ class BillingApi {
5
5
  /**
6
6
  * Billing service.
7
7
  * @module purecloud-platform-client-v2/api/BillingApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class CarrierServicesApi {
5
5
  /**
6
6
  * CarrierServices service.
7
7
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ChatApi {
5
5
  /**
6
6
  * Chat service.
7
7
  * @module purecloud-platform-client-v2/api/ChatApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class CoachingApi {
5
5
  /**
6
6
  * Coaching service.
7
7
  * @module purecloud-platform-client-v2/api/CoachingApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ContentManagementApi {
5
5
  /**
6
6
  * ContentManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ConversationsApi {
5
5
  /**
6
6
  * Conversations service.
7
7
  * @module purecloud-platform-client-v2/api/ConversationsApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -6181,6 +6181,7 @@ class ConversationsApi {
6181
6181
  * See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
6182
6182
  * @param {String} conversationId conversationId
6183
6183
  * @param {String} communicationId communicationId
6184
+ * @deprecated
6184
6185
  */
6185
6186
  postConversationsMessageCommunicationMessagesMedia(conversationId, communicationId) {
6186
6187
  // verify the required parameter 'conversationId' is set
@@ -6206,6 +6207,41 @@ class ConversationsApi {
6206
6207
  );
6207
6208
  }
6208
6209
 
6210
+ /**
6211
+ * Create a URL to upload a message media file
6212
+ * See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
6213
+ * @param {String} conversationId conversationId
6214
+ * @param {String} communicationId communicationId
6215
+ * @param {Object} body request
6216
+ */
6217
+ postConversationsMessageCommunicationMessagesMediaUploads(conversationId, communicationId, body) {
6218
+ // verify the required parameter 'conversationId' is set
6219
+ if (conversationId === undefined || conversationId === null) {
6220
+ throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessagesMediaUploads';
6221
+ }
6222
+ // verify the required parameter 'communicationId' is set
6223
+ if (communicationId === undefined || communicationId === null) {
6224
+ throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessagesMediaUploads';
6225
+ }
6226
+ // verify the required parameter 'body' is set
6227
+ if (body === undefined || body === null) {
6228
+ throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationMessagesMediaUploads';
6229
+ }
6230
+
6231
+ return this.apiClient.callApi(
6232
+ '/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/uploads',
6233
+ 'POST',
6234
+ { 'conversationId': conversationId,'communicationId': communicationId },
6235
+ { },
6236
+ { },
6237
+ { },
6238
+ body,
6239
+ ['PureCloud OAuth'],
6240
+ ['application/json'],
6241
+ ['application/json']
6242
+ );
6243
+ }
6244
+
6209
6245
  /**
6210
6246
  * Send message typing event
6211
6247
  * Send message typing event for existing conversation/communication.
@@ -5,7 +5,7 @@ class DataExtensionsApi {
5
5
  /**
6
6
  * DataExtensions service.
7
7
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class DataPrivacyApi {
5
5
  /**
6
6
  * DataPrivacy service.
7
7
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class DownloadsApi {
5
5
  /**
6
6
  * Downloads service.
7
7
  * @module purecloud-platform-client-v2/api/DownloadsApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class EmailsApi {
5
5
  /**
6
6
  * Emails service.
7
7
  * @module purecloud-platform-client-v2/api/EmailsApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class EmployeeEngagementApi {
5
5
  /**
6
6
  * EmployeeEngagement service.
7
7
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class EventsApi {
5
5
  /**
6
6
  * Events service.
7
7
  * @module purecloud-platform-client-v2/api/EventsApi
8
- * @version 218.1.0
8
+ * @version 220.0.0
9
9
  */
10
10
 
11
11
  /**