purecloud-platform-client-v2 125.0.0 → 128.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 (72) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +810 -171
  3. package/dist/web-amd/purecloud-platform-client-v2.js +810 -171
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +810 -171
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +810 -171
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +463 -268
  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 +1 -1
  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 +1 -1
  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 +1 -74
  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 +7 -3
  49. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -4
  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 +22 -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 +28 -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 +1 -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 +1 -1
  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/index.js +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "125.0.0",
3
+ "version": "128.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 125.0.0
6
+ * @version 128.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': '125.0.0' });
953
+ //request.set({ 'purecloud-sdk': '128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AuditApi {
5
5
  /**
6
6
  * Audit service.
7
7
  * @module purecloud-platform-client-v2/api/AuditApi
8
- * @version 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class DataExtensionsApi {
5
5
  /**
6
6
  * DataExtensions service.
7
7
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
8
- * @version 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -495,79 +495,6 @@ class KnowledgeApi {
495
495
  );
496
496
  }
497
497
 
498
- /**
499
- * Update specific context data of the knowledge base.
500
- *
501
- * @param {String} knowledgeBaseId Knowledge base ID.
502
- * @param {String} contextId Context ID.
503
- * @param {Object} opts Optional parameters
504
- * @param {Object} opts.body
505
- */
506
- patchKnowledgeKnowledgebaseContext(knowledgeBaseId, contextId, opts) {
507
- opts = opts || {};
508
-
509
- // verify the required parameter 'knowledgeBaseId' is set
510
- if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
511
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContext';
512
- }
513
- // verify the required parameter 'contextId' is set
514
- if (contextId === undefined || contextId === null) {
515
- throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContext';
516
- }
517
-
518
- return this.apiClient.callApi(
519
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}',
520
- 'PATCH',
521
- { 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId },
522
- { },
523
- { },
524
- { },
525
- opts['body'],
526
- ['PureCloud OAuth'],
527
- ['application/json'],
528
- ['application/json']
529
- );
530
- }
531
-
532
- /**
533
- * Update context value.
534
- *
535
- * @param {String} knowledgeBaseId Knowledge base ID.
536
- * @param {String} contextId Context ID.
537
- * @param {String} contextValueId Context Value ID.
538
- * @param {Object} opts Optional parameters
539
- * @param {Object} opts.body
540
- */
541
- patchKnowledgeKnowledgebaseContextValue(knowledgeBaseId, contextId, contextValueId, opts) {
542
- opts = opts || {};
543
-
544
- // verify the required parameter 'knowledgeBaseId' is set
545
- if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
546
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContextValue';
547
- }
548
- // verify the required parameter 'contextId' is set
549
- if (contextId === undefined || contextId === null) {
550
- throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContextValue';
551
- }
552
- // verify the required parameter 'contextValueId' is set
553
- if (contextValueId === undefined || contextValueId === null) {
554
- throw 'Missing the required parameter "contextValueId" when calling patchKnowledgeKnowledgebaseContextValue';
555
- }
556
-
557
- return this.apiClient.callApi(
558
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}/values/{contextValueId}',
559
- 'PATCH',
560
- { 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId,'contextValueId': contextValueId },
561
- { },
562
- { },
563
- { },
564
- opts['body'],
565
- ['PureCloud OAuth'],
566
- ['application/json'],
567
- ['application/json']
568
- );
569
- }
570
-
571
498
  /**
572
499
  * Update category
573
500
  *
@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
5
5
  /**
6
6
  * LanguageUnderstanding service.
7
7
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
8
- * @version 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.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 125.0.0
8
+ * @version 128.0.0
9
9
  */
10
10
 
11
11
  /**