purecloud-platform-client-v2 187.0.0 → 188.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 +406 -93
  3. package/dist/web-amd/purecloud-platform-client-v2.js +406 -93
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +173 -94
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +261 -139
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +379 -146
  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 +26 -2
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -2
  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 +1 -1
  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 +3 -10
  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 +1 -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 +1 -1
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +201 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -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 +3 -2
  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 +34 -4
  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 +1 -1
  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 +3 -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 +1 -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 -1
  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 +63 -1
  75. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  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 +1 -1
  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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "187.0.0",
3
+ "version": "188.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",
@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
4
4
 
5
5
  /**
6
6
  * @module purecloud-platform-client-v2/ApiClient
7
- * @version 187.0.0
7
+ * @version 188.0.0
8
8
  */
9
9
  class ApiClient {
10
10
  /**
@@ -5,7 +5,7 @@ class AlertingApi {
5
5
  /**
6
6
  * Alerting service.
7
7
  * @module purecloud-platform-client-v2/api/AlertingApi
8
- * @version 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1800,7 +1800,6 @@ class AnalyticsApi {
1800
1800
  * Query for flow execution aggregates
1801
1801
  *
1802
1802
  * @param {Object} body query
1803
- * postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1804
1803
  */
1805
1804
  postAnalyticsFlowexecutionsAggregatesQuery(body) {
1806
1805
  // verify the required parameter 'body' is set
@@ -2057,6 +2056,31 @@ class AnalyticsApi {
2057
2056
  );
2058
2057
  }
2059
2058
 
2059
+ /**
2060
+ * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded
2061
+ *
2062
+ * @param {Object} body query
2063
+ */
2064
+ postAnalyticsRatelimitsAggregatesQuery(body) {
2065
+ // verify the required parameter 'body' is set
2066
+ if (body === undefined || body === null) {
2067
+ throw 'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';
2068
+ }
2069
+
2070
+ return this.apiClient.callApi(
2071
+ '/api/v2/analytics/ratelimits/aggregates/query',
2072
+ 'POST',
2073
+ { },
2074
+ { },
2075
+ { },
2076
+ { },
2077
+ body,
2078
+ ['PureCloud OAuth'],
2079
+ ['application/json'],
2080
+ ['application/json']
2081
+ );
2082
+ }
2083
+
2060
2084
  /**
2061
2085
  * Generate a view export request
2062
2086
  * This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
@@ -5,7 +5,7 @@ class ArchitectApi {
5
5
  /**
6
6
  * Architect service.
7
7
  * @module purecloud-platform-client-v2/api/ArchitectApi
8
- * @version 187.0.0
8
+ * @version 188.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -3384,6 +3384,7 @@ class ArchitectApi {
3384
3384
  * @param {Object} body query
3385
3385
  * @param {Object} opts Optional parameters
3386
3386
  * @param {Boolean} opts.indexOnly indexes only
3387
+ * @param {Number} opts.pageSize number of results to return (default to 50)
3387
3388
  * postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3388
3389
  */
3389
3390
  postFlowsInstancesQuery(body, opts) {
@@ -3398,7 +3399,7 @@ class ArchitectApi {
3398
3399
  '/api/v2/flows/instances/query',
3399
3400
  'POST',
3400
3401
  { },
3401
- { 'indexOnly': opts['indexOnly'] },
3402
+ { 'indexOnly': opts['indexOnly'],'pageSize': opts['pageSize'] },
3402
3403
  { },
3403
3404
  { },
3404
3405
  body,
@@ -5,7 +5,7 @@ class AuditApi {
5
5
  /**
6
6
  * Audit service.
7
7
  * @module purecloud-platform-client-v2/api/AuditApi
8
- * @version 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -179,6 +179,7 @@ class AuthorizationApi {
179
179
  * @param {String} opts.nextPage next page token
180
180
  * @param {String} opts.previousPage Previous page token
181
181
  * @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
182
+ * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
182
183
  * @param {String} opts.name Search term to filter by division name
183
184
  */
184
185
  getAuthorizationDivisions(opts) {
@@ -189,7 +190,7 @@ class AuthorizationApi {
189
190
  '/api/v2/authorization/divisions',
190
191
  'GET',
191
192
  { },
192
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
193
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
193
194
  { },
194
195
  { },
195
196
  null,
@@ -5,7 +5,7 @@ class BillingApi {
5
5
  /**
6
6
  * Billing service.
7
7
  * @module purecloud-platform-client-v2/api/BillingApi
8
- * @version 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -4081,8 +4081,8 @@ class ConversationsApi {
4081
4081
  }
4082
4082
 
4083
4083
  /**
4084
- * Update or activate a WhatsApp messaging integration
4085
- * The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
4084
+ * Update a WhatsApp messaging integration
4085
+ *
4086
4086
  * @param {String} integrationId Integration ID
4087
4087
  * @param {Object} body WhatsAppIntegrationUpdateRequest
4088
4088
  */
@@ -4572,7 +4572,6 @@ class ConversationsApi {
4572
4572
  * @param {String} conversationId conversation ID
4573
4573
  * @param {String} participantId participant ID
4574
4574
  * @param {Object} body Transfer request
4575
- * postConversationParticipantReplaceAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4576
4575
  */
4577
4576
  postConversationParticipantReplaceAgent(conversationId, participantId, body) {
4578
4577
  // verify the required parameter 'conversationId' is set
@@ -4608,7 +4607,6 @@ class ConversationsApi {
4608
4607
  * @param {String} conversationId conversation ID
4609
4608
  * @param {String} participantId participant ID
4610
4609
  * @param {Object} body Transfer request
4611
- * postConversationParticipantReplaceExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4612
4610
  */
4613
4611
  postConversationParticipantReplaceExternal(conversationId, participantId, body) {
4614
4612
  // verify the required parameter 'conversationId' is set
@@ -4644,7 +4642,6 @@ class ConversationsApi {
4644
4642
  * @param {String} conversationId conversation ID
4645
4643
  * @param {String} participantId participant ID
4646
4644
  * @param {Object} body Transfer request
4647
- * postConversationParticipantReplaceQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4648
4645
  */
4649
4646
  postConversationParticipantReplaceQueue(conversationId, participantId, body) {
4650
4647
  // verify the required parameter 'conversationId' is set
@@ -4913,7 +4910,6 @@ class ConversationsApi {
4913
4910
  * @param {String} conversationId conversationId
4914
4911
  * @param {String} participantId participantId
4915
4912
  * @param {Object} body Destination agent and initial speak to
4916
- * postConversationsCallParticipantConsultAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4917
4913
  */
4918
4914
  postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
4919
4915
  // verify the required parameter 'conversationId' is set
@@ -4949,7 +4945,6 @@ class ConversationsApi {
4949
4945
  * @param {String} conversationId conversationId
4950
4946
  * @param {String} participantId participantId
4951
4947
  * @param {Object} body Destination address and initial speak to
4952
- * postConversationsCallParticipantConsultExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4953
4948
  */
4954
4949
  postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
4955
4950
  // verify the required parameter 'conversationId' is set
@@ -4985,7 +4980,6 @@ class ConversationsApi {
4985
4980
  * @param {String} conversationId conversationId
4986
4981
  * @param {String} participantId participantId
4987
4982
  * @param {Object} body Destination queue and initial speak to
4988
- * postConversationsCallParticipantConsultQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4989
4983
  */
4990
4984
  postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
4991
4985
  // verify the required parameter 'conversationId' is set
@@ -6078,7 +6072,6 @@ class ConversationsApi {
6078
6072
  *
6079
6073
  * @param {String} conversationId conversationId
6080
6074
  * @param {String} participantId participantId
6081
- * postConversationsMessageParticipantMonitor is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6082
6075
  */
6083
6076
  postConversationsMessageParticipantMonitor(conversationId, participantId) {
6084
6077
  // verify the required parameter 'conversationId' is set
@@ -5,7 +5,7 @@ class DataExtensionsApi {
5
5
  /**
6
6
  * DataExtensions service.
7
7
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
8
- * @version 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
5
5
  /**
6
6
  * InfrastructureAsCode service.
7
7
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
8
- * @version 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.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 187.0.0
8
+ * @version 188.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1409,6 +1409,41 @@ class KnowledgeApi {
1409
1409
  );
1410
1410
  }
1411
1411
 
1412
+ /**
1413
+ * Get parse job report
1414
+ *
1415
+ * @param {String} knowledgeBaseId Knowledge base ID
1416
+ * @param {String} parseJobId Parse job ID
1417
+ * @param {Object} opts Optional parameters
1418
+ * @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
1419
+ * getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1420
+ */
1421
+ getKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, opts) {
1422
+ opts = opts || {};
1423
+
1424
+ // verify the required parameter 'knowledgeBaseId' is set
1425
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
1426
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseParseJob';
1427
+ }
1428
+ // verify the required parameter 'parseJobId' is set
1429
+ if (parseJobId === undefined || parseJobId === null) {
1430
+ throw 'Missing the required parameter "parseJobId" when calling getKnowledgeKnowledgebaseParseJob';
1431
+ }
1432
+
1433
+ return this.apiClient.callApi(
1434
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}',
1435
+ 'GET',
1436
+ { 'knowledgeBaseId': knowledgeBaseId,'parseJobId': parseJobId },
1437
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
1438
+ { },
1439
+ { },
1440
+ null,
1441
+ ['PureCloud OAuth'],
1442
+ ['application/json'],
1443
+ ['application/json']
1444
+ );
1445
+ }
1446
+
1412
1447
  /**
1413
1448
  * Get knowledge base unanswered group for a particular groupId
1414
1449
  *
@@ -1517,6 +1552,37 @@ class KnowledgeApi {
1517
1552
  );
1518
1553
  }
1519
1554
 
1555
+ /**
1556
+ * Get content upload from URL job status
1557
+ *
1558
+ * @param {String} knowledgeBaseId Knowledge base ID
1559
+ * @param {String} jobId Upload job ID
1560
+ * getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1561
+ */
1562
+ getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
1563
+ // verify the required parameter 'knowledgeBaseId' is set
1564
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
1565
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';
1566
+ }
1567
+ // verify the required parameter 'jobId' is set
1568
+ if (jobId === undefined || jobId === null) {
1569
+ throw 'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';
1570
+ }
1571
+
1572
+ return this.apiClient.callApi(
1573
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}',
1574
+ 'GET',
1575
+ { 'knowledgeBaseId': knowledgeBaseId,'jobId': jobId },
1576
+ { },
1577
+ { },
1578
+ { },
1579
+ null,
1580
+ ['PureCloud OAuth'],
1581
+ ['application/json'],
1582
+ ['application/json']
1583
+ );
1584
+ }
1585
+
1520
1586
  /**
1521
1587
  * Get knowledge bases
1522
1588
  *
@@ -1987,6 +2053,42 @@ class KnowledgeApi {
1987
2053
  );
1988
2054
  }
1989
2055
 
2056
+ /**
2057
+ * Send update to the parse operation
2058
+ *
2059
+ * @param {String} knowledgeBaseId Knowledge base ID
2060
+ * @param {String} parseJobId Parse job ID
2061
+ * @param {Object} body
2062
+ * patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2063
+ */
2064
+ patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, body) {
2065
+ // verify the required parameter 'knowledgeBaseId' is set
2066
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
2067
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseParseJob';
2068
+ }
2069
+ // verify the required parameter 'parseJobId' is set
2070
+ if (parseJobId === undefined || parseJobId === null) {
2071
+ throw 'Missing the required parameter "parseJobId" when calling patchKnowledgeKnowledgebaseParseJob';
2072
+ }
2073
+ // verify the required parameter 'body' is set
2074
+ if (body === undefined || body === null) {
2075
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseParseJob';
2076
+ }
2077
+
2078
+ return this.apiClient.callApi(
2079
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}',
2080
+ 'PATCH',
2081
+ { 'knowledgeBaseId': knowledgeBaseId,'parseJobId': parseJobId },
2082
+ { },
2083
+ { },
2084
+ { },
2085
+ body,
2086
+ ['PureCloud OAuth'],
2087
+ ['application/json'],
2088
+ ['application/json']
2089
+ );
2090
+ }
2091
+
1990
2092
  /**
1991
2093
  * Update a Knowledge base unanswered phrase group
1992
2094
  *
@@ -2827,6 +2929,73 @@ class KnowledgeApi {
2827
2929
  );
2828
2930
  }
2829
2931
 
2932
+ /**
2933
+ * Import the parsed articles
2934
+ *
2935
+ * @param {String} knowledgeBaseId Knowledge base ID
2936
+ * @param {String} parseJobId Parse job ID
2937
+ * @param {Object} body
2938
+ * postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2939
+ */
2940
+ postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId, parseJobId, body) {
2941
+ // verify the required parameter 'knowledgeBaseId' is set
2942
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
2943
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobImport';
2944
+ }
2945
+ // verify the required parameter 'parseJobId' is set
2946
+ if (parseJobId === undefined || parseJobId === null) {
2947
+ throw 'Missing the required parameter "parseJobId" when calling postKnowledgeKnowledgebaseParseJobImport';
2948
+ }
2949
+ // verify the required parameter 'body' is set
2950
+ if (body === undefined || body === null) {
2951
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobImport';
2952
+ }
2953
+
2954
+ return this.apiClient.callApi(
2955
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import',
2956
+ 'POST',
2957
+ { 'knowledgeBaseId': knowledgeBaseId,'parseJobId': parseJobId },
2958
+ { },
2959
+ { },
2960
+ { },
2961
+ body,
2962
+ ['PureCloud OAuth'],
2963
+ ['application/json'],
2964
+ ['application/json']
2965
+ );
2966
+ }
2967
+
2968
+ /**
2969
+ * Create parse job
2970
+ *
2971
+ * @param {String} knowledgeBaseId Knowledge base ID
2972
+ * @param {Object} body
2973
+ * postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2974
+ */
2975
+ postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId, body) {
2976
+ // verify the required parameter 'knowledgeBaseId' is set
2977
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
2978
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobs';
2979
+ }
2980
+ // verify the required parameter 'body' is set
2981
+ if (body === undefined || body === null) {
2982
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobs';
2983
+ }
2984
+
2985
+ return this.apiClient.callApi(
2986
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs',
2987
+ 'POST',
2988
+ { 'knowledgeBaseId': knowledgeBaseId },
2989
+ { },
2990
+ { },
2991
+ { },
2992
+ body,
2993
+ ['PureCloud OAuth'],
2994
+ ['application/json'],
2995
+ ['application/json']
2996
+ );
2997
+ }
2998
+
2830
2999
  /**
2831
3000
  * Search Documents
2832
3001
  *
@@ -2857,6 +3026,37 @@ class KnowledgeApi {
2857
3026
  );
2858
3027
  }
2859
3028
 
3029
+ /**
3030
+ * Create content upload from URL job
3031
+ *
3032
+ * @param {String} knowledgeBaseId Knowledge base ID
3033
+ * @param {Object} body uploadRequest
3034
+ * postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3035
+ */
3036
+ postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
3037
+ // verify the required parameter 'knowledgeBaseId' is set
3038
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
3039
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';
3040
+ }
3041
+ // verify the required parameter 'body' is set
3042
+ if (body === undefined || body === null) {
3043
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';
3044
+ }
3045
+
3046
+ return this.apiClient.callApi(
3047
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs',
3048
+ 'POST',
3049
+ { 'knowledgeBaseId': knowledgeBaseId },
3050
+ { },
3051
+ { },
3052
+ { },
3053
+ body,
3054
+ ['PureCloud OAuth'],
3055
+ ['application/json'],
3056
+ ['application/json']
3057
+ );
3058
+ }
3059
+
2860
3060
  /**
2861
3061
  * Create new knowledge base
2862
3062
  *