purecloud-platform-client-v2 122.0.0 → 126.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 (73) hide show
  1. package/README.md +6 -2
  2. package/dist/node/purecloud-platform-client-v2.js +1005 -142
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1005 -142
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +965 -146
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +978 -1309
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1546 -243
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -26
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +8 -4
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -2
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +7 -3
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +3 -3
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +216 -1
  45. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
  48. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/RoutingApi.js +22 -11
  51. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +96 -2
  55. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +31 -1
  67. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +51 -0
  70. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +473 -1
  72. package/src/purecloud-platform-client-v2/configuration.js +42 -35
  73. package/src/purecloud-platform-client-v2/index.js +7 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "122.0.0",
3
+ "version": "126.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",
@@ -3,7 +3,7 @@ import Configuration from './configuration.js';
3
3
 
4
4
  /**
5
5
  * @module purecloud-platform-client-v2/ApiClient
6
- * @version 122.0.0
6
+ * @version 126.0.0
7
7
  */
8
8
  class ApiClient {
9
9
  /**
@@ -950,7 +950,7 @@ class ApiClient {
950
950
 
951
951
  // set header parameters
952
952
  request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
953
- //request.set({ 'purecloud-sdk': '122.0.0' });
953
+ //request.set({ 'purecloud-sdk': '126.0.0' });
954
954
 
955
955
  // set request timeout
956
956
  request.timeout(that.timeout);
@@ -5,7 +5,7 @@ class AlertingApi {
5
5
  /**
6
6
  * Alerting service.
7
7
  * @module purecloud-platform-client-v2/api/AlertingApi
8
- * @version 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -601,31 +601,6 @@ class AnalyticsApi {
601
601
  );
602
602
  }
603
603
 
604
- /**
605
- * Patch AnalyticsReportingSettings values for an organization
606
- *
607
- * @param {Object} body AnalyticsReportingSettingsRequest
608
- */
609
- patchAnalyticsReportingSettings(body) {
610
- // verify the required parameter 'body' is set
611
- if (body === undefined || body === null) {
612
- throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
613
- }
614
-
615
- return this.apiClient.callApi(
616
- '/api/v2/analytics/reporting/settings',
617
- 'PATCH',
618
- { },
619
- { },
620
- { },
621
- { },
622
- body,
623
- ['PureCloud OAuth'],
624
- ['application/json'],
625
- ['application/json']
626
- );
627
- }
628
-
629
604
  /**
630
605
  * Query for bot aggregates
631
606
  *
@@ -5,7 +5,7 @@ class ArchitectApi {
5
5
  /**
6
6
  * Architect service.
7
7
  * @module purecloud-platform-client-v2/api/ArchitectApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -2873,17 +2873,21 @@ class ArchitectApi {
2873
2873
  * Updates a specific datatable by id
2874
2874
  * Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
2875
2875
  * @param {String} datatableId id of datatable
2876
+ * @param {Object} body datatable json-schema
2876
2877
  * @param {Object} opts Optional parameters
2877
2878
  * @param {Object} opts.expand Expand instructions for the result
2878
- * @param {Object} opts.body datatable json-schema
2879
2879
  */
2880
- putFlowsDatatable(datatableId, opts) {
2880
+ putFlowsDatatable(datatableId, body, opts) {
2881
2881
  opts = opts || {};
2882
2882
 
2883
2883
  // verify the required parameter 'datatableId' is set
2884
2884
  if (datatableId === undefined || datatableId === null) {
2885
2885
  throw 'Missing the required parameter "datatableId" when calling putFlowsDatatable';
2886
2886
  }
2887
+ // verify the required parameter 'body' is set
2888
+ if (body === undefined || body === null) {
2889
+ throw 'Missing the required parameter "body" when calling putFlowsDatatable';
2890
+ }
2887
2891
 
2888
2892
  return this.apiClient.callApi(
2889
2893
  '/api/v2/flows/datatables/{datatableId}',
@@ -2892,7 +2896,7 @@ class ArchitectApi {
2892
2896
  { 'expand': opts['expand'] },
2893
2897
  { },
2894
2898
  { },
2895
- opts['body'],
2899
+ body,
2896
2900
  ['PureCloud OAuth'],
2897
2901
  ['application/json'],
2898
2902
  ['application/json']
@@ -5,7 +5,7 @@ class AuditApi {
5
5
  /**
6
6
  * Audit service.
7
7
  * @module purecloud-platform-client-v2/api/AuditApi
8
- * @version 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class BillingApi {
5
5
  /**
6
6
  * Billing service.
7
7
  * @module purecloud-platform-client-v2/api/BillingApi
8
- * @version 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -3074,7 +3074,7 @@ class ConversationsApi {
3074
3074
  }
3075
3075
 
3076
3076
  /**
3077
- * Attempts to manually assign a specified conversation to a specified agent. Ignores bullseye ring, PAR score, skills, and languages.
3077
+ * Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
3078
3078
  *
3079
3079
  * @param {String} conversationId conversation ID
3080
3080
  * @param {Object} body Targeted user
@@ -5,7 +5,7 @@ class DataExtensionsApi {
5
5
  /**
6
6
  * DataExtensions service.
7
7
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ExternalContactsApi {
5
5
  /**
6
6
  * ExternalContacts service.
7
7
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class FaxApi {
5
5
  /**
6
6
  * Fax service.
7
7
  * @module purecloud-platform-client-v2/api/FaxApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class FlowsApi {
5
5
  /**
6
6
  * Flows service.
7
7
  * @module purecloud-platform-client-v2/api/FlowsApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GamificationApi {
5
5
  /**
6
6
  * Gamification service.
7
7
  * @module purecloud-platform-client-v2/api/GamificationApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
5
5
  /**
6
6
  * GeneralDataProtectionRegulation service.
7
7
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GeolocationApi {
5
5
  /**
6
6
  * Geolocation service.
7
7
  * @module purecloud-platform-client-v2/api/GeolocationApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GreetingsApi {
5
5
  /**
6
6
  * Greetings service.
7
7
  * @module purecloud-platform-client-v2/api/GreetingsApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class GroupsApi {
5
5
  /**
6
6
  * Groups service.
7
7
  * @module purecloud-platform-client-v2/api/GroupsApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class IdentityProviderApi {
5
5
  /**
6
6
  * IdentityProvider service.
7
7
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class IntegrationsApi {
5
5
  /**
6
6
  * Integrations service.
7
7
  * @module purecloud-platform-client-v2/api/IntegrationsApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class JourneyApi {
5
5
  /**
6
6
  * Journey service.
7
7
  * @module purecloud-platform-client-v2/api/JourneyApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class KnowledgeApi {
5
5
  /**
6
6
  * Knowledge service.
7
7
  * @module purecloud-platform-client-v2/api/KnowledgeApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -295,6 +295,8 @@ class KnowledgeApi {
295
295
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
296
296
  * @param {String} opts.categories Filter by categories ids, comma separated values expected.
297
297
  * @param {String} opts.title Filter by document title.
298
+ * @param {Object} opts.sortBy Sort by.
299
+ * @param {Object} opts.sortOrder Sort Order.
298
300
  * @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
299
301
  */
300
302
  getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
@@ -313,7 +315,7 @@ class KnowledgeApi {
313
315
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
314
316
  'GET',
315
317
  { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
316
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'],'documentIds': this.apiClient.buildCollectionParam(opts['documentIds'], 'multi') },
318
+ { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'documentIds': this.apiClient.buildCollectionParam(opts['documentIds'], 'multi') },
317
319
  { },
318
320
  { },
319
321
  null,
@@ -442,6 +444,8 @@ class KnowledgeApi {
442
444
  * @param {String} opts.name Filter by Name.
443
445
  * @param {Object} opts.coreLanguage Filter by core language.
444
446
  * @param {Boolean} opts.published Filter by published status.
447
+ * @param {Object} opts.sortBy Sort by.
448
+ * @param {Object} opts.sortOrder Sort Order.
445
449
  */
446
450
  getKnowledgeKnowledgebases(opts) {
447
451
  opts = opts || {};
@@ -451,7 +455,7 @@ class KnowledgeApi {
451
455
  '/api/v2/knowledge/knowledgebases',
452
456
  'GET',
453
457
  { },
454
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'coreLanguage': opts['coreLanguage'],'published': opts['published'] },
458
+ { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'coreLanguage': opts['coreLanguage'],'published': opts['published'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
455
459
  { },
456
460
  { },
457
461
  null,
@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
5
5
  /**
6
6
  * LanguageUnderstanding service.
7
7
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -571,7 +571,7 @@ class LanguageUnderstandingApi {
571
571
  }
572
572
 
573
573
  /**
574
- * Save information for the draft
574
+ * Save information for the draft. Either topic draft or intent draft should be sent.
575
575
  *
576
576
  * @param {String} minerId Miner ID
577
577
  * @param {String} draftId Draft ID
@@ -815,7 +815,7 @@ class LanguageUnderstandingApi {
815
815
  }
816
816
 
817
817
  /**
818
- * Start the mining process. Specify date range pair with mediaType and queueIds for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.
818
+ * Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.
819
819
  *
820
820
  * @param {String} minerId Miner ID
821
821
  * @param {Object} opts Optional parameters
@@ -5,7 +5,7 @@ class LanguagesApi {
5
5
  /**
6
6
  * Languages service.
7
7
  * @module purecloud-platform-client-v2/api/LanguagesApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LearningApi {
5
5
  /**
6
6
  * Learning service.
7
7
  * @module purecloud-platform-client-v2/api/LearningApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LicenseApi {
5
5
  /**
6
6
  * License service.
7
7
  * @module purecloud-platform-client-v2/api/LicenseApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LocationsApi {
5
5
  /**
6
6
  * Locations service.
7
7
  * @module purecloud-platform-client-v2/api/LocationsApi
8
- * @version 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class MobileDevicesApi {
5
5
  /**
6
6
  * MobileDevices service.
7
7
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
8
- * @version 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.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 122.0.0
8
+ * @version 126.0.0
9
9
  */
10
10
 
11
11
  /**