purecloud-platform-client-v2 143.0.0 → 146.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 (75) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +1884 -74
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1884 -74
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +1884 -74
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +1884 -74
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +896 -14
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +1 -0
  12. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
  15. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/BillingApi.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 +211 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/GamificationApi.js +4 -8
  27. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1778 -246
  35. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LearningApi.js +26 -1
  38. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/RoutingApi.js +21 -1
  53. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -1
  65. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UsersApi.js +2 -2
  68. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -7048,6 +7048,7 @@ var PureCloudRegionHosts = {
7048
7048
  eu_west_2: 'euw2.pure.cloud',
7049
7049
  ap_south_1: 'aps1.pure.cloud',
7050
7050
  us_east_2: 'use2.us-gov-pure.cloud',
7051
+ sa_east_1: 'sae1.pure.cloud',
7051
7052
  };
7052
7053
 
7053
7054
  var global$1 = (typeof global !== "undefined" ? global :
@@ -9306,7 +9307,7 @@ class Configuration {
9306
9307
 
9307
9308
  /**
9308
9309
  * @module purecloud-platform-client-v2/ApiClient
9309
- * @version 143.0.0
9310
+ * @version 146.0.0
9310
9311
  */
9311
9312
  class ApiClient {
9312
9313
  /**
@@ -10378,7 +10379,7 @@ class AlertingApi {
10378
10379
  /**
10379
10380
  * Alerting service.
10380
10381
  * @module purecloud-platform-client-v2/api/AlertingApi
10381
- * @version 143.0.0
10382
+ * @version 146.0.0
10382
10383
  */
10383
10384
 
10384
10385
  /**
@@ -10692,7 +10693,7 @@ class AnalyticsApi {
10692
10693
  /**
10693
10694
  * Analytics service.
10694
10695
  * @module purecloud-platform-client-v2/api/AnalyticsApi
10695
- * @version 143.0.0
10696
+ * @version 146.0.0
10696
10697
  */
10697
10698
 
10698
10699
  /**
@@ -11874,7 +11875,7 @@ class ArchitectApi {
11874
11875
  /**
11875
11876
  * Architect service.
11876
11877
  * @module purecloud-platform-client-v2/api/ArchitectApi
11877
- * @version 143.0.0
11878
+ * @version 146.0.0
11878
11879
  */
11879
11880
 
11880
11881
  /**
@@ -12632,6 +12633,7 @@ class ArchitectApi {
12632
12633
  * @param {String} opts.sortBy Sort by (default to name)
12633
12634
  * @param {String} opts.sortOrder Sort order (default to ASC)
12634
12635
  * @param {String} opts.name Name of the IVR to filter by.
12636
+ * @param {String} opts.dnis The phone number of the IVR to filter by.
12635
12637
  */
12636
12638
  getArchitectIvrs(opts) {
12637
12639
  opts = opts || {};
@@ -12641,7 +12643,7 @@ class ArchitectApi {
12641
12643
  '/api/v2/architect/ivrs',
12642
12644
  'GET',
12643
12645
  { },
12644
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
12646
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
12645
12647
  { },
12646
12648
  { },
12647
12649
  null,
@@ -14919,7 +14921,7 @@ class AuditApi {
14919
14921
  /**
14920
14922
  * Audit service.
14921
14923
  * @module purecloud-platform-client-v2/api/AuditApi
14922
- * @version 143.0.0
14924
+ * @version 146.0.0
14923
14925
  */
14924
14926
 
14925
14927
  /**
@@ -15090,7 +15092,7 @@ class AuthorizationApi {
15090
15092
  /**
15091
15093
  * Authorization service.
15092
15094
  * @module purecloud-platform-client-v2/api/AuthorizationApi
15093
- * @version 143.0.0
15095
+ * @version 146.0.0
15094
15096
  */
15095
15097
 
15096
15098
  /**
@@ -16273,7 +16275,7 @@ class BillingApi {
16273
16275
  /**
16274
16276
  * Billing service.
16275
16277
  * @module purecloud-platform-client-v2/api/BillingApi
16276
- * @version 143.0.0
16278
+ * @version 146.0.0
16277
16279
  */
16278
16280
 
16279
16281
  /**
@@ -16353,7 +16355,7 @@ class ChatApi {
16353
16355
  /**
16354
16356
  * Chat service.
16355
16357
  * @module purecloud-platform-client-v2/api/ChatApi
16356
- * @version 143.0.0
16358
+ * @version 146.0.0
16357
16359
  */
16358
16360
 
16359
16361
  /**
@@ -16444,7 +16446,7 @@ class CoachingApi {
16444
16446
  /**
16445
16447
  * Coaching service.
16446
16448
  * @module purecloud-platform-client-v2/api/CoachingApi
16447
- * @version 143.0.0
16449
+ * @version 146.0.0
16448
16450
  */
16449
16451
 
16450
16452
  /**
@@ -17021,7 +17023,7 @@ class ContentManagementApi {
17021
17023
  /**
17022
17024
  * ContentManagement service.
17023
17025
  * @module purecloud-platform-client-v2/api/ContentManagementApi
17024
- * @version 143.0.0
17026
+ * @version 146.0.0
17025
17027
  */
17026
17028
 
17027
17029
  /**
@@ -18161,7 +18163,7 @@ class ConversationsApi {
18161
18163
  /**
18162
18164
  * Conversations service.
18163
18165
  * @module purecloud-platform-client-v2/api/ConversationsApi
18164
- * @version 143.0.0
18166
+ * @version 146.0.0
18165
18167
  */
18166
18168
 
18167
18169
  /**
@@ -18754,6 +18756,31 @@ class ConversationsApi {
18754
18756
  );
18755
18757
  }
18756
18758
 
18759
+ /**
18760
+ * Get the secure attributes on a conversation.
18761
+ *
18762
+ * @param {String} conversationId conversation ID
18763
+ */
18764
+ getConversationSecureattributes(conversationId) {
18765
+ // verify the required parameter 'conversationId' is set
18766
+ if (conversationId === undefined || conversationId === null) {
18767
+ throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
18768
+ }
18769
+
18770
+ return this.apiClient.callApi(
18771
+ '/api/v2/conversations/{conversationId}/secureattributes',
18772
+ 'GET',
18773
+ { 'conversationId': conversationId },
18774
+ { },
18775
+ { },
18776
+ { },
18777
+ null,
18778
+ ['PureCloud OAuth'],
18779
+ ['application/json'],
18780
+ ['application/json']
18781
+ );
18782
+ }
18783
+
18757
18784
  /**
18758
18785
  * Get active conversations for the logged in user
18759
18786
  *
@@ -19537,6 +19564,51 @@ class ConversationsApi {
19537
19564
  );
19538
19565
  }
19539
19566
 
19567
+ /**
19568
+ * Get the encryption key configurations
19569
+ *
19570
+ * @param {String} keyconfigurationsId Key Configurations Id
19571
+ */
19572
+ getConversationsKeyconfiguration(keyconfigurationsId) {
19573
+ // verify the required parameter 'keyconfigurationsId' is set
19574
+ if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
19575
+ throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
19576
+ }
19577
+
19578
+ return this.apiClient.callApi(
19579
+ '/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
19580
+ 'GET',
19581
+ { 'keyconfigurationsId': keyconfigurationsId },
19582
+ { },
19583
+ { },
19584
+ { },
19585
+ null,
19586
+ ['PureCloud OAuth'],
19587
+ ['application/json'],
19588
+ ['application/json']
19589
+ );
19590
+ }
19591
+
19592
+ /**
19593
+ * Get a list of key configurations data
19594
+ *
19595
+ */
19596
+ getConversationsKeyconfigurations() {
19597
+
19598
+ return this.apiClient.callApi(
19599
+ '/api/v2/conversations/keyconfigurations',
19600
+ 'GET',
19601
+ { },
19602
+ { },
19603
+ { },
19604
+ { },
19605
+ null,
19606
+ ['PureCloud OAuth'],
19607
+ ['application/json'],
19608
+ ['application/json']
19609
+ );
19610
+ }
19611
+
19540
19612
  /**
19541
19613
  * Get message conversation
19542
19614
  *
@@ -20253,6 +20325,36 @@ class ConversationsApi {
20253
20325
  );
20254
20326
  }
20255
20327
 
20328
+ /**
20329
+ * Update the secure attributes on a conversation.
20330
+ *
20331
+ * @param {String} conversationId conversation ID
20332
+ * @param {Object} body Conversation Secure Attributes
20333
+ */
20334
+ patchConversationSecureattributes(conversationId, body) {
20335
+ // verify the required parameter 'conversationId' is set
20336
+ if (conversationId === undefined || conversationId === null) {
20337
+ throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
20338
+ }
20339
+ // verify the required parameter 'body' is set
20340
+ if (body === undefined || body === null) {
20341
+ throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
20342
+ }
20343
+
20344
+ return this.apiClient.callApi(
20345
+ '/api/v2/conversations/{conversationId}/secureattributes',
20346
+ 'PATCH',
20347
+ { 'conversationId': conversationId },
20348
+ { },
20349
+ { },
20350
+ { },
20351
+ body,
20352
+ ['PureCloud OAuth'],
20353
+ ['application/json'],
20354
+ ['application/json']
20355
+ );
20356
+ }
20357
+
20256
20358
  /**
20257
20359
  * Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
20258
20360
  *
@@ -22255,6 +22357,56 @@ class ConversationsApi {
22255
22357
  );
22256
22358
  }
22257
22359
 
22360
+ /**
22361
+ * Setup configurations for encryption key creation
22362
+ *
22363
+ * @param {Object} body Encryption Configuration
22364
+ */
22365
+ postConversationsKeyconfigurations(body) {
22366
+ // verify the required parameter 'body' is set
22367
+ if (body === undefined || body === null) {
22368
+ throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
22369
+ }
22370
+
22371
+ return this.apiClient.callApi(
22372
+ '/api/v2/conversations/keyconfigurations',
22373
+ 'POST',
22374
+ { },
22375
+ { },
22376
+ { },
22377
+ { },
22378
+ body,
22379
+ ['PureCloud OAuth'],
22380
+ ['application/json'],
22381
+ ['application/json']
22382
+ );
22383
+ }
22384
+
22385
+ /**
22386
+ * Validate encryption key configurations without saving it
22387
+ *
22388
+ * @param {Object} body Encryption Configuration
22389
+ */
22390
+ postConversationsKeyconfigurationsValidate(body) {
22391
+ // verify the required parameter 'body' is set
22392
+ if (body === undefined || body === null) {
22393
+ throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
22394
+ }
22395
+
22396
+ return this.apiClient.callApi(
22397
+ '/api/v2/conversations/keyconfigurations/validate',
22398
+ 'POST',
22399
+ { },
22400
+ { },
22401
+ { },
22402
+ { },
22403
+ body,
22404
+ ['PureCloud OAuth'],
22405
+ ['application/json'],
22406
+ ['application/json']
22407
+ );
22408
+ }
22409
+
22258
22410
  /**
22259
22411
  * Send message
22260
22412
  * Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.
@@ -22639,6 +22791,36 @@ class ConversationsApi {
22639
22791
  );
22640
22792
  }
22641
22793
 
22794
+ /**
22795
+ * Set the secure attributes on a conversation.
22796
+ *
22797
+ * @param {String} conversationId conversation ID
22798
+ * @param {Object} body Conversation Secure Attributes
22799
+ */
22800
+ putConversationSecureattributes(conversationId, body) {
22801
+ // verify the required parameter 'conversationId' is set
22802
+ if (conversationId === undefined || conversationId === null) {
22803
+ throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
22804
+ }
22805
+ // verify the required parameter 'body' is set
22806
+ if (body === undefined || body === null) {
22807
+ throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
22808
+ }
22809
+
22810
+ return this.apiClient.callApi(
22811
+ '/api/v2/conversations/{conversationId}/secureattributes',
22812
+ 'PUT',
22813
+ { 'conversationId': conversationId },
22814
+ { },
22815
+ { },
22816
+ { },
22817
+ body,
22818
+ ['PureCloud OAuth'],
22819
+ ['application/json'],
22820
+ ['application/json']
22821
+ );
22822
+ }
22823
+
22642
22824
  /**
22643
22825
  * Update the tags on a conversation.
22644
22826
  *
@@ -22889,6 +23071,36 @@ class ConversationsApi {
22889
23071
  );
22890
23072
  }
22891
23073
 
23074
+ /**
23075
+ * Update the encryption key configurations
23076
+ *
23077
+ * @param {String} keyconfigurationsId Key Configurations Id
23078
+ * @param {Object} body Encryption key configuration metadata
23079
+ */
23080
+ putConversationsKeyconfiguration(keyconfigurationsId, body) {
23081
+ // verify the required parameter 'keyconfigurationsId' is set
23082
+ if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
23083
+ throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
23084
+ }
23085
+ // verify the required parameter 'body' is set
23086
+ if (body === undefined || body === null) {
23087
+ throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
23088
+ }
23089
+
23090
+ return this.apiClient.callApi(
23091
+ '/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
23092
+ 'PUT',
23093
+ { 'keyconfigurationsId': keyconfigurationsId },
23094
+ { },
23095
+ { },
23096
+ { },
23097
+ body,
23098
+ ['PureCloud OAuth'],
23099
+ ['application/json'],
23100
+ ['application/json']
23101
+ );
23102
+ }
23103
+
22892
23104
  /**
22893
23105
  * Update a conversation by setting its recording state
22894
23106
  *
@@ -23095,7 +23307,7 @@ class DataExtensionsApi {
23095
23307
  /**
23096
23308
  * DataExtensions service.
23097
23309
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
23098
- * @version 143.0.0
23310
+ * @version 146.0.0
23099
23311
  */
23100
23312
 
23101
23313
  /**
@@ -23181,7 +23393,7 @@ class ExternalContactsApi {
23181
23393
  /**
23182
23394
  * ExternalContacts service.
23183
23395
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
23184
- * @version 143.0.0
23396
+ * @version 146.0.0
23185
23397
  */
23186
23398
 
23187
23399
  /**
@@ -24924,7 +25136,7 @@ class FaxApi {
24924
25136
  /**
24925
25137
  * Fax service.
24926
25138
  * @module purecloud-platform-client-v2/api/FaxApi
24927
- * @version 143.0.0
25139
+ * @version 146.0.0
24928
25140
  */
24929
25141
 
24930
25142
  /**
@@ -25095,7 +25307,7 @@ class FlowsApi {
25095
25307
  /**
25096
25308
  * Flows service.
25097
25309
  * @module purecloud-platform-client-v2/api/FlowsApi
25098
- * @version 143.0.0
25310
+ * @version 146.0.0
25099
25311
  */
25100
25312
 
25101
25313
  /**
@@ -25166,7 +25378,7 @@ class GamificationApi {
25166
25378
  /**
25167
25379
  * Gamification service.
25168
25380
  * @module purecloud-platform-client-v2/api/GamificationApi
25169
- * @version 143.0.0
25381
+ * @version 146.0.0
25170
25382
  */
25171
25383
 
25172
25384
  /**
@@ -25920,14 +26132,14 @@ class GamificationApi {
25920
26132
  * @param {String} profileId performanceProfileId
25921
26133
  * @param {String} metricId metricId
25922
26134
  * @param {Object} filterType Filter type for the query request.
25923
- * @param {String} filterId ID for the filter type. For example, division Id
25924
26135
  * @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
25925
26136
  * @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
25926
26137
  * @param {Object} opts Optional parameters
26138
+ * @param {String} opts.filterId ID for the filter type. Only required when filterType is Division.
25927
26139
  * @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
25928
26140
  * @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
25929
26141
  */
25930
- getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
26142
+ getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, opts) {
25931
26143
  opts = opts || {};
25932
26144
 
25933
26145
  // verify the required parameter 'profileId' is set
@@ -25942,10 +26154,6 @@ class GamificationApi {
25942
26154
  if (filterType === undefined || filterType === null) {
25943
26155
  throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
25944
26156
  }
25945
- // verify the required parameter 'filterId' is set
25946
- if (filterId === undefined || filterId === null) {
25947
- throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
25948
- }
25949
26157
  // verify the required parameter 'startWorkday' is set
25950
26158
  if (startWorkday === undefined || startWorkday === null) {
25951
26159
  throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
@@ -25959,7 +26167,7 @@ class GamificationApi {
25959
26167
  '/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
25960
26168
  'GET',
25961
26169
  { 'profileId': profileId,'metricId': metricId },
25962
- { 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
26170
+ { 'filterType': filterType,'filterId': opts['filterId'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
25963
26171
  { },
25964
26172
  { },
25965
26173
  null,
@@ -26901,7 +27109,7 @@ class GeneralDataProtectionRegulationApi {
26901
27109
  /**
26902
27110
  * GeneralDataProtectionRegulation service.
26903
27111
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
26904
- * @version 143.0.0
27112
+ * @version 146.0.0
26905
27113
  */
26906
27114
 
26907
27115
  /**
@@ -27031,7 +27239,7 @@ class GeolocationApi {
27031
27239
  /**
27032
27240
  * Geolocation service.
27033
27241
  * @module purecloud-platform-client-v2/api/GeolocationApi
27034
- * @version 143.0.0
27242
+ * @version 146.0.0
27035
27243
  */
27036
27244
 
27037
27245
  /**
@@ -27162,7 +27370,7 @@ class GreetingsApi {
27162
27370
  /**
27163
27371
  * Greetings service.
27164
27372
  * @module purecloud-platform-client-v2/api/GreetingsApi
27165
- * @version 143.0.0
27373
+ * @version 146.0.0
27166
27374
  */
27167
27375
 
27168
27376
  /**
@@ -27617,7 +27825,7 @@ class GroupsApi {
27617
27825
  /**
27618
27826
  * Groups service.
27619
27827
  * @module purecloud-platform-client-v2/api/GroupsApi
27620
- * @version 143.0.0
27828
+ * @version 146.0.0
27621
27829
  */
27622
27830
 
27623
27831
  /**
@@ -28022,7 +28230,7 @@ class IdentityProviderApi {
28022
28230
  /**
28023
28231
  * IdentityProvider service.
28024
28232
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
28025
- * @version 143.0.0
28233
+ * @version 146.0.0
28026
28234
  */
28027
28235
 
28028
28236
  /**
@@ -28778,7 +28986,7 @@ class IntegrationsApi {
28778
28986
  /**
28779
28987
  * Integrations service.
28780
28988
  * @module purecloud-platform-client-v2/api/IntegrationsApi
28781
- * @version 143.0.0
28989
+ * @version 146.0.0
28782
28990
  */
28783
28991
 
28784
28992
  /**
@@ -30455,7 +30663,7 @@ class JourneyApi {
30455
30663
  /**
30456
30664
  * Journey service.
30457
30665
  * @module purecloud-platform-client-v2/api/JourneyApi
30458
- * @version 143.0.0
30666
+ * @version 146.0.0
30459
30667
  */
30460
30668
 
30461
30669
  /**
@@ -31166,7 +31374,7 @@ class KnowledgeApi {
31166
31374
  /**
31167
31375
  * Knowledge service.
31168
31376
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31169
- * @version 143.0.0
31377
+ * @version 146.0.0
31170
31378
  */
31171
31379
 
31172
31380
  /**
@@ -31206,6 +31414,191 @@ class KnowledgeApi {
31206
31414
  );
31207
31415
  }
31208
31416
 
31417
+ /**
31418
+ * Delete category
31419
+ *
31420
+ * @param {String} knowledgeBaseId Knowledge base ID
31421
+ * @param {String} categoryId Category ID
31422
+ */
31423
+ deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
31424
+ // verify the required parameter 'knowledgeBaseId' is set
31425
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31426
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
31427
+ }
31428
+ // verify the required parameter 'categoryId' is set
31429
+ if (categoryId === undefined || categoryId === null) {
31430
+ throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
31431
+ }
31432
+
31433
+ return this.apiClient.callApi(
31434
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
31435
+ 'DELETE',
31436
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
31437
+ { },
31438
+ { },
31439
+ { },
31440
+ null,
31441
+ ['PureCloud OAuth'],
31442
+ ['application/json'],
31443
+ ['application/json']
31444
+ );
31445
+ }
31446
+
31447
+ /**
31448
+ * Delete document.
31449
+ *
31450
+ * @param {String} knowledgeBaseId Knowledge base ID.
31451
+ * @param {String} documentId Document ID.
31452
+ */
31453
+ deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
31454
+ // verify the required parameter 'knowledgeBaseId' is set
31455
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31456
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
31457
+ }
31458
+ // verify the required parameter 'documentId' is set
31459
+ if (documentId === undefined || documentId === null) {
31460
+ throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
31461
+ }
31462
+
31463
+ return this.apiClient.callApi(
31464
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
31465
+ 'DELETE',
31466
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
31467
+ { },
31468
+ { },
31469
+ { },
31470
+ null,
31471
+ ['PureCloud OAuth'],
31472
+ ['application/json'],
31473
+ ['application/json']
31474
+ );
31475
+ }
31476
+
31477
+ /**
31478
+ * Delete a variation for a document.
31479
+ *
31480
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
31481
+ * @param {String} documentId Globally unique identifier for a document.
31482
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
31483
+ */
31484
+ deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
31485
+ // verify the required parameter 'documentVariationId' is set
31486
+ if (documentVariationId === undefined || documentVariationId === null) {
31487
+ throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
31488
+ }
31489
+ // verify the required parameter 'documentId' is set
31490
+ if (documentId === undefined || documentId === null) {
31491
+ throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
31492
+ }
31493
+ // verify the required parameter 'knowledgeBaseId' is set
31494
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31495
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
31496
+ }
31497
+
31498
+ return this.apiClient.callApi(
31499
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
31500
+ 'DELETE',
31501
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
31502
+ { },
31503
+ { },
31504
+ { },
31505
+ null,
31506
+ ['PureCloud OAuth'],
31507
+ ['application/json'],
31508
+ ['application/json']
31509
+ );
31510
+ }
31511
+
31512
+ /**
31513
+ * Delete export job
31514
+ *
31515
+ * @param {String} knowledgeBaseId Knowledge base ID
31516
+ * @param {String} exportJobId Export job ID
31517
+ */
31518
+ deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
31519
+ // verify the required parameter 'knowledgeBaseId' is set
31520
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31521
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
31522
+ }
31523
+ // verify the required parameter 'exportJobId' is set
31524
+ if (exportJobId === undefined || exportJobId === null) {
31525
+ throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
31526
+ }
31527
+
31528
+ return this.apiClient.callApi(
31529
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
31530
+ 'DELETE',
31531
+ { 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
31532
+ { },
31533
+ { },
31534
+ { },
31535
+ null,
31536
+ ['PureCloud OAuth'],
31537
+ ['application/json'],
31538
+ ['application/json']
31539
+ );
31540
+ }
31541
+
31542
+ /**
31543
+ * Delete import job
31544
+ *
31545
+ * @param {String} knowledgeBaseId Knowledge base ID
31546
+ * @param {String} importJobId Import job ID
31547
+ */
31548
+ deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
31549
+ // verify the required parameter 'knowledgeBaseId' is set
31550
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31551
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
31552
+ }
31553
+ // verify the required parameter 'importJobId' is set
31554
+ if (importJobId === undefined || importJobId === null) {
31555
+ throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
31556
+ }
31557
+
31558
+ return this.apiClient.callApi(
31559
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
31560
+ 'DELETE',
31561
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
31562
+ { },
31563
+ { },
31564
+ { },
31565
+ null,
31566
+ ['PureCloud OAuth'],
31567
+ ['application/json'],
31568
+ ['application/json']
31569
+ );
31570
+ }
31571
+
31572
+ /**
31573
+ * Delete label
31574
+ *
31575
+ * @param {String} knowledgeBaseId Knowledge base ID
31576
+ * @param {String} labelId Label ID
31577
+ */
31578
+ deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
31579
+ // verify the required parameter 'knowledgeBaseId' is set
31580
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31581
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
31582
+ }
31583
+ // verify the required parameter 'labelId' is set
31584
+ if (labelId === undefined || labelId === null) {
31585
+ throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
31586
+ }
31587
+
31588
+ return this.apiClient.callApi(
31589
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
31590
+ 'DELETE',
31591
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
31592
+ { },
31593
+ { },
31594
+ { },
31595
+ null,
31596
+ ['PureCloud OAuth'],
31597
+ ['application/json'],
31598
+ ['application/json']
31599
+ );
31600
+ }
31601
+
31209
31602
  /**
31210
31603
  * Delete category
31211
31604
  *
@@ -31311,6 +31704,104 @@ class KnowledgeApi {
31311
31704
  );
31312
31705
  }
31313
31706
 
31707
+ /**
31708
+ * Get categories
31709
+ *
31710
+ * @param {String} sessionId Knowledge guest session ID.
31711
+ * @param {Object} opts Optional parameters
31712
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
31713
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
31714
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
31715
+ * @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
31716
+ * @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
31717
+ * @param {String} opts.name Filter to return the categories that starts with the given category name.
31718
+ * @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
31719
+ * @param {String} opts.expand The specified entity attribute will be filled. Supported value:Ancestors: every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.
31720
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
31721
+ */
31722
+ getKnowledgeGuestSessionCategories(sessionId, opts) {
31723
+ opts = opts || {};
31724
+
31725
+ // verify the required parameter 'sessionId' is set
31726
+ if (sessionId === undefined || sessionId === null) {
31727
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
31728
+ }
31729
+
31730
+ return this.apiClient.callApi(
31731
+ '/api/v2/knowledge/guest/sessions/{sessionId}/categories',
31732
+ 'GET',
31733
+ { 'sessionId': sessionId },
31734
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'],'isRoot': opts['isRoot'],'name': opts['name'],'sortBy': opts['sortBy'],'expand': opts['expand'],'includeDocumentCount': opts['includeDocumentCount'] },
31735
+ { },
31736
+ { },
31737
+ null,
31738
+ ['PureCloud OAuth'],
31739
+ ['application/json'],
31740
+ ['application/json']
31741
+ );
31742
+ }
31743
+
31744
+ /**
31745
+ * Get a knowledge document by ID.
31746
+ *
31747
+ * @param {String} sessionId Knowledge guest session ID.
31748
+ * @param {String} documentId Document ID
31749
+ */
31750
+ getKnowledgeGuestSessionDocument(sessionId, documentId) {
31751
+ // verify the required parameter 'sessionId' is set
31752
+ if (sessionId === undefined || sessionId === null) {
31753
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
31754
+ }
31755
+ // verify the required parameter 'documentId' is set
31756
+ if (documentId === undefined || documentId === null) {
31757
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
31758
+ }
31759
+
31760
+ return this.apiClient.callApi(
31761
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
31762
+ 'GET',
31763
+ { 'sessionId': sessionId,'documentId': documentId },
31764
+ { },
31765
+ { },
31766
+ { },
31767
+ null,
31768
+ ['PureCloud OAuth'],
31769
+ ['application/json'],
31770
+ ['application/json']
31771
+ );
31772
+ }
31773
+
31774
+ /**
31775
+ * Get documents.
31776
+ *
31777
+ * @param {String} sessionId Knowledge guest session ID.
31778
+ * @param {Object} opts Optional parameters
31779
+ * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
31780
+ * @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
31781
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
31782
+ */
31783
+ getKnowledgeGuestSessionDocuments(sessionId, opts) {
31784
+ opts = opts || {};
31785
+
31786
+ // verify the required parameter 'sessionId' is set
31787
+ if (sessionId === undefined || sessionId === null) {
31788
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
31789
+ }
31790
+
31791
+ return this.apiClient.callApi(
31792
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents',
31793
+ 'GET',
31794
+ { 'sessionId': sessionId },
31795
+ { 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
31796
+ { },
31797
+ { },
31798
+ null,
31799
+ ['PureCloud OAuth'],
31800
+ ['application/json'],
31801
+ ['application/json']
31802
+ );
31803
+ }
31804
+
31314
31805
  /**
31315
31806
  * Get knowledge base
31316
31807
  *
@@ -31336,6 +31827,501 @@ class KnowledgeApi {
31336
31827
  );
31337
31828
  }
31338
31829
 
31830
+ /**
31831
+ * Get categories
31832
+ *
31833
+ * @param {String} knowledgeBaseId Knowledge base ID
31834
+ * @param {Object} opts Optional parameters
31835
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
31836
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
31837
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
31838
+ * @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
31839
+ * @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
31840
+ * @param {String} opts.name Filter to return the categories that starts with the given category name.
31841
+ * @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
31842
+ * @param {String} opts.expand The specified entity attribute will be filled. Supported value:Ancestors: every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.
31843
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
31844
+ */
31845
+ getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
31846
+ opts = opts || {};
31847
+
31848
+ // verify the required parameter 'knowledgeBaseId' is set
31849
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31850
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
31851
+ }
31852
+
31853
+ return this.apiClient.callApi(
31854
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
31855
+ 'GET',
31856
+ { 'knowledgeBaseId': knowledgeBaseId },
31857
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'],'isRoot': opts['isRoot'],'name': opts['name'],'sortBy': opts['sortBy'],'expand': opts['expand'],'includeDocumentCount': opts['includeDocumentCount'] },
31858
+ { },
31859
+ { },
31860
+ null,
31861
+ ['PureCloud OAuth'],
31862
+ ['application/json'],
31863
+ ['application/json']
31864
+ );
31865
+ }
31866
+
31867
+ /**
31868
+ * Get category
31869
+ *
31870
+ * @param {String} knowledgeBaseId Knowledge base ID
31871
+ * @param {String} categoryId Category ID
31872
+ */
31873
+ getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
31874
+ // verify the required parameter 'knowledgeBaseId' is set
31875
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31876
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
31877
+ }
31878
+ // verify the required parameter 'categoryId' is set
31879
+ if (categoryId === undefined || categoryId === null) {
31880
+ throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
31881
+ }
31882
+
31883
+ return this.apiClient.callApi(
31884
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
31885
+ 'GET',
31886
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
31887
+ { },
31888
+ { },
31889
+ { },
31890
+ null,
31891
+ ['PureCloud OAuth'],
31892
+ ['application/json'],
31893
+ ['application/json']
31894
+ );
31895
+ }
31896
+
31897
+ /**
31898
+ * Get document.
31899
+ *
31900
+ * @param {String} knowledgeBaseId Knowledge base ID.
31901
+ * @param {String} documentId Document ID.
31902
+ * @param {Object} opts Optional parameters
31903
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20.
31904
+ * @param {Object} opts.state when state is Draft, draft version of the document is returned,otherwise by default published version is returned in the response.
31905
+ */
31906
+ getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
31907
+ opts = opts || {};
31908
+
31909
+ // verify the required parameter 'knowledgeBaseId' is set
31910
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31911
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
31912
+ }
31913
+ // verify the required parameter 'documentId' is set
31914
+ if (documentId === undefined || documentId === null) {
31915
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
31916
+ }
31917
+
31918
+ return this.apiClient.callApi(
31919
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
31920
+ 'GET',
31921
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
31922
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
31923
+ { },
31924
+ { },
31925
+ null,
31926
+ ['PureCloud OAuth'],
31927
+ ['application/json'],
31928
+ ['application/json']
31929
+ );
31930
+ }
31931
+
31932
+ /**
31933
+ * Get a variation for a document.
31934
+ *
31935
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
31936
+ * @param {String} documentId Globally unique identifier for a document.
31937
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
31938
+ * @param {Object} opts Optional parameters
31939
+ * @param {Object} opts.documentState The state of the document.
31940
+ */
31941
+ getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
31942
+ opts = opts || {};
31943
+
31944
+ // verify the required parameter 'documentVariationId' is set
31945
+ if (documentVariationId === undefined || documentVariationId === null) {
31946
+ throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
31947
+ }
31948
+ // verify the required parameter 'documentId' is set
31949
+ if (documentId === undefined || documentId === null) {
31950
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
31951
+ }
31952
+ // verify the required parameter 'knowledgeBaseId' is set
31953
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31954
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
31955
+ }
31956
+
31957
+ return this.apiClient.callApi(
31958
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
31959
+ 'GET',
31960
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
31961
+ { 'documentState': opts['documentState'] },
31962
+ { },
31963
+ { },
31964
+ null,
31965
+ ['PureCloud OAuth'],
31966
+ ['application/json'],
31967
+ ['application/json']
31968
+ );
31969
+ }
31970
+
31971
+ /**
31972
+ * Get variations for a document.
31973
+ *
31974
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
31975
+ * @param {String} documentId Globally unique identifier for the document.
31976
+ * @param {Object} opts Optional parameters
31977
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
31978
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
31979
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
31980
+ * @param {Object} opts.documentState The state of the document.
31981
+ */
31982
+ getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
31983
+ opts = opts || {};
31984
+
31985
+ // verify the required parameter 'knowledgeBaseId' is set
31986
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31987
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
31988
+ }
31989
+ // verify the required parameter 'documentId' is set
31990
+ if (documentId === undefined || documentId === null) {
31991
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
31992
+ }
31993
+
31994
+ return this.apiClient.callApi(
31995
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
31996
+ 'GET',
31997
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
31998
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
31999
+ { },
32000
+ { },
32001
+ null,
32002
+ ['PureCloud OAuth'],
32003
+ ['application/json'],
32004
+ ['application/json']
32005
+ );
32006
+ }
32007
+
32008
+ /**
32009
+ * Get document version.
32010
+ *
32011
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
32012
+ * @param {String} documentId Globally unique identifier for the document.
32013
+ * @param {String} versionId Globally unique identifier for the document version.
32014
+ * @param {Object} opts Optional parameters
32015
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
32016
+ */
32017
+ getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
32018
+ opts = opts || {};
32019
+
32020
+ // verify the required parameter 'knowledgeBaseId' is set
32021
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32022
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
32023
+ }
32024
+ // verify the required parameter 'documentId' is set
32025
+ if (documentId === undefined || documentId === null) {
32026
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
32027
+ }
32028
+ // verify the required parameter 'versionId' is set
32029
+ if (versionId === undefined || versionId === null) {
32030
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
32031
+ }
32032
+
32033
+ return this.apiClient.callApi(
32034
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
32035
+ 'GET',
32036
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
32037
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
32038
+ { },
32039
+ { },
32040
+ null,
32041
+ ['PureCloud OAuth'],
32042
+ ['application/json'],
32043
+ ['application/json']
32044
+ );
32045
+ }
32046
+
32047
+ /**
32048
+ * Get variation for the given document version.
32049
+ *
32050
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
32051
+ * @param {String} documentId Globally unique identifier for the document.
32052
+ * @param {String} versionId Globally unique identifier for the document version.
32053
+ * @param {String} variationId Globally unique identifier for the document version variation.
32054
+ */
32055
+ getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
32056
+ // verify the required parameter 'knowledgeBaseId' is set
32057
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32058
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
32059
+ }
32060
+ // verify the required parameter 'documentId' is set
32061
+ if (documentId === undefined || documentId === null) {
32062
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
32063
+ }
32064
+ // verify the required parameter 'versionId' is set
32065
+ if (versionId === undefined || versionId === null) {
32066
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
32067
+ }
32068
+ // verify the required parameter 'variationId' is set
32069
+ if (variationId === undefined || variationId === null) {
32070
+ throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
32071
+ }
32072
+
32073
+ return this.apiClient.callApi(
32074
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
32075
+ 'GET',
32076
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
32077
+ { },
32078
+ { },
32079
+ { },
32080
+ null,
32081
+ ['PureCloud OAuth'],
32082
+ ['application/json'],
32083
+ ['application/json']
32084
+ );
32085
+ }
32086
+
32087
+ /**
32088
+ * Get variations for the given document version.
32089
+ *
32090
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
32091
+ * @param {String} documentId Globally unique identifier for the document.
32092
+ * @param {String} versionId Globally unique identifier for the document version.
32093
+ * @param {Object} opts Optional parameters
32094
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
32095
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
32096
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
32097
+ */
32098
+ getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
32099
+ opts = opts || {};
32100
+
32101
+ // verify the required parameter 'knowledgeBaseId' is set
32102
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32103
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
32104
+ }
32105
+ // verify the required parameter 'documentId' is set
32106
+ if (documentId === undefined || documentId === null) {
32107
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
32108
+ }
32109
+ // verify the required parameter 'versionId' is set
32110
+ if (versionId === undefined || versionId === null) {
32111
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
32112
+ }
32113
+
32114
+ return this.apiClient.callApi(
32115
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
32116
+ 'GET',
32117
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
32118
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
32119
+ { },
32120
+ { },
32121
+ null,
32122
+ ['PureCloud OAuth'],
32123
+ ['application/json'],
32124
+ ['application/json']
32125
+ );
32126
+ }
32127
+
32128
+ /**
32129
+ * Get document versions.
32130
+ *
32131
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
32132
+ * @param {String} documentId Globally unique identifier for the document.
32133
+ * @param {Object} opts Optional parameters
32134
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
32135
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
32136
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
32137
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
32138
+ */
32139
+ getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
32140
+ opts = opts || {};
32141
+
32142
+ // verify the required parameter 'knowledgeBaseId' is set
32143
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32144
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
32145
+ }
32146
+ // verify the required parameter 'documentId' is set
32147
+ if (documentId === undefined || documentId === null) {
32148
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
32149
+ }
32150
+
32151
+ return this.apiClient.callApi(
32152
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
32153
+ 'GET',
32154
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
32155
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
32156
+ { },
32157
+ { },
32158
+ null,
32159
+ ['PureCloud OAuth'],
32160
+ ['application/json'],
32161
+ ['application/json']
32162
+ );
32163
+ }
32164
+
32165
+ /**
32166
+ * Get documents.
32167
+ *
32168
+ * @param {String} knowledgeBaseId Knowledge base ID
32169
+ * @param {Object} opts Optional parameters
32170
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
32171
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
32172
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
32173
+ * @param {String} opts.interval Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
32174
+ * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
32175
+ * @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
32176
+ * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
32177
+ * @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
32178
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
32179
+ */
32180
+ getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
32181
+ opts = opts || {};
32182
+
32183
+ // verify the required parameter 'knowledgeBaseId' is set
32184
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32185
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
32186
+ }
32187
+
32188
+ return this.apiClient.callApi(
32189
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
32190
+ 'GET',
32191
+ { 'knowledgeBaseId': knowledgeBaseId },
32192
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
32193
+ { },
32194
+ { },
32195
+ null,
32196
+ ['PureCloud OAuth'],
32197
+ ['application/json'],
32198
+ ['application/json']
32199
+ );
32200
+ }
32201
+
32202
+ /**
32203
+ * Get export job report
32204
+ *
32205
+ * @param {String} knowledgeBaseId Knowledge base ID
32206
+ * @param {String} exportJobId Export job ID
32207
+ */
32208
+ getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
32209
+ // verify the required parameter 'knowledgeBaseId' is set
32210
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32211
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
32212
+ }
32213
+ // verify the required parameter 'exportJobId' is set
32214
+ if (exportJobId === undefined || exportJobId === null) {
32215
+ throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
32216
+ }
32217
+
32218
+ return this.apiClient.callApi(
32219
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
32220
+ 'GET',
32221
+ { 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
32222
+ { },
32223
+ { },
32224
+ { },
32225
+ null,
32226
+ ['PureCloud OAuth'],
32227
+ ['application/json'],
32228
+ ['application/json']
32229
+ );
32230
+ }
32231
+
32232
+ /**
32233
+ * Get import job report
32234
+ *
32235
+ * @param {String} knowledgeBaseId Knowledge base ID
32236
+ * @param {String} importJobId Import job ID
32237
+ */
32238
+ getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
32239
+ // verify the required parameter 'knowledgeBaseId' is set
32240
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32241
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
32242
+ }
32243
+ // verify the required parameter 'importJobId' is set
32244
+ if (importJobId === undefined || importJobId === null) {
32245
+ throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
32246
+ }
32247
+
32248
+ return this.apiClient.callApi(
32249
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
32250
+ 'GET',
32251
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
32252
+ { },
32253
+ { },
32254
+ { },
32255
+ null,
32256
+ ['PureCloud OAuth'],
32257
+ ['application/json'],
32258
+ ['application/json']
32259
+ );
32260
+ }
32261
+
32262
+ /**
32263
+ * Get label
32264
+ *
32265
+ * @param {String} knowledgeBaseId Knowledge base ID
32266
+ * @param {String} labelId Label ID
32267
+ */
32268
+ getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
32269
+ // verify the required parameter 'knowledgeBaseId' is set
32270
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32271
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
32272
+ }
32273
+ // verify the required parameter 'labelId' is set
32274
+ if (labelId === undefined || labelId === null) {
32275
+ throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
32276
+ }
32277
+
32278
+ return this.apiClient.callApi(
32279
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
32280
+ 'GET',
32281
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
32282
+ { },
32283
+ { },
32284
+ { },
32285
+ null,
32286
+ ['PureCloud OAuth'],
32287
+ ['application/json'],
32288
+ ['application/json']
32289
+ );
32290
+ }
32291
+
32292
+ /**
32293
+ * Get labels
32294
+ *
32295
+ * @param {String} knowledgeBaseId Knowledge base ID
32296
+ * @param {Object} opts Optional parameters
32297
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
32298
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
32299
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
32300
+ * @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
32301
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
32302
+ */
32303
+ getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
32304
+ opts = opts || {};
32305
+
32306
+ // verify the required parameter 'knowledgeBaseId' is set
32307
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32308
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
32309
+ }
32310
+
32311
+ return this.apiClient.callApi(
32312
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
32313
+ 'GET',
32314
+ { 'knowledgeBaseId': knowledgeBaseId },
32315
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
32316
+ { },
32317
+ { },
32318
+ null,
32319
+ ['PureCloud OAuth'],
32320
+ ['application/json'],
32321
+ ['application/json']
32322
+ );
32323
+ }
32324
+
31339
32325
  /**
31340
32326
  * Get categories
31341
32327
  *
@@ -31594,6 +32580,108 @@ class KnowledgeApi {
31594
32580
  );
31595
32581
  }
31596
32582
 
32583
+ /**
32584
+ * Get knowledge base unanswered group for a particular groupId
32585
+ *
32586
+ * @param {String} knowledgeBaseId Knowledge base ID
32587
+ * @param {String} groupId The ID of the group to be retrieved.
32588
+ * @param {Object} opts Optional parameters
32589
+ * @param {Object} opts.app The app value to be used for filtering phrases.
32590
+ */
32591
+ getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
32592
+ opts = opts || {};
32593
+
32594
+ // verify the required parameter 'knowledgeBaseId' is set
32595
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32596
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
32597
+ }
32598
+ // verify the required parameter 'groupId' is set
32599
+ if (groupId === undefined || groupId === null) {
32600
+ throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
32601
+ }
32602
+
32603
+ return this.apiClient.callApi(
32604
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
32605
+ 'GET',
32606
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
32607
+ { 'app': opts['app'] },
32608
+ { },
32609
+ { },
32610
+ null,
32611
+ ['PureCloud OAuth'],
32612
+ ['application/json'],
32613
+ ['application/json']
32614
+ );
32615
+ }
32616
+
32617
+ /**
32618
+ * Get knowledge base unanswered phrase group for a particular phraseGroupId
32619
+ *
32620
+ * @param {String} knowledgeBaseId Knowledge base ID
32621
+ * @param {String} groupId The ID of the group to be retrieved.
32622
+ * @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
32623
+ * @param {Object} opts Optional parameters
32624
+ * @param {Object} opts.app The app value to be used for filtering phrases.
32625
+ */
32626
+ getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
32627
+ opts = opts || {};
32628
+
32629
+ // verify the required parameter 'knowledgeBaseId' is set
32630
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32631
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
32632
+ }
32633
+ // verify the required parameter 'groupId' is set
32634
+ if (groupId === undefined || groupId === null) {
32635
+ throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
32636
+ }
32637
+ // verify the required parameter 'phraseGroupId' is set
32638
+ if (phraseGroupId === undefined || phraseGroupId === null) {
32639
+ throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
32640
+ }
32641
+
32642
+ return this.apiClient.callApi(
32643
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
32644
+ 'GET',
32645
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
32646
+ { 'app': opts['app'] },
32647
+ { },
32648
+ { },
32649
+ null,
32650
+ ['PureCloud OAuth'],
32651
+ ['application/json'],
32652
+ ['application/json']
32653
+ );
32654
+ }
32655
+
32656
+ /**
32657
+ * Get knowledge base unanswered groups
32658
+ *
32659
+ * @param {String} knowledgeBaseId Knowledge base ID
32660
+ * @param {Object} opts Optional parameters
32661
+ * @param {Object} opts.app The app value to be used for filtering phrases.
32662
+ */
32663
+ getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
32664
+ opts = opts || {};
32665
+
32666
+ // verify the required parameter 'knowledgeBaseId' is set
32667
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32668
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
32669
+ }
32670
+
32671
+ return this.apiClient.callApi(
32672
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
32673
+ 'GET',
32674
+ { 'knowledgeBaseId': knowledgeBaseId },
32675
+ { 'app': opts['app'] },
32676
+ { },
32677
+ { },
32678
+ null,
32679
+ ['PureCloud OAuth'],
32680
+ ['application/json'],
32681
+ ['application/json']
32682
+ );
32683
+ }
32684
+
31597
32685
  /**
31598
32686
  * Get knowledge bases
31599
32687
  *
@@ -31626,6 +32714,41 @@ class KnowledgeApi {
31626
32714
  );
31627
32715
  }
31628
32716
 
32717
+ /**
32718
+ * Update search result.
32719
+ *
32720
+ * @param {String} sessionId Knowledge guest session ID.
32721
+ * @param {String} searchId Search Result ID
32722
+ * @param {Object} body
32723
+ */
32724
+ patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
32725
+ // verify the required parameter 'sessionId' is set
32726
+ if (sessionId === undefined || sessionId === null) {
32727
+ throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
32728
+ }
32729
+ // verify the required parameter 'searchId' is set
32730
+ if (searchId === undefined || searchId === null) {
32731
+ throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
32732
+ }
32733
+ // verify the required parameter 'body' is set
32734
+ if (body === undefined || body === null) {
32735
+ throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
32736
+ }
32737
+
32738
+ return this.apiClient.callApi(
32739
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
32740
+ 'PATCH',
32741
+ { 'sessionId': sessionId,'searchId': searchId },
32742
+ { },
32743
+ { },
32744
+ { },
32745
+ body,
32746
+ ['PureCloud OAuth'],
32747
+ ['application/json'],
32748
+ ['application/json']
32749
+ );
32750
+ }
32751
+
31629
32752
  /**
31630
32753
  * Update knowledge base
31631
32754
  *
@@ -31656,6 +32779,220 @@ class KnowledgeApi {
31656
32779
  );
31657
32780
  }
31658
32781
 
32782
+ /**
32783
+ * Update category
32784
+ *
32785
+ * @param {String} knowledgeBaseId Knowledge base ID
32786
+ * @param {String} categoryId Category ID
32787
+ * @param {Object} body
32788
+ */
32789
+ patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
32790
+ // verify the required parameter 'knowledgeBaseId' is set
32791
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32792
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
32793
+ }
32794
+ // verify the required parameter 'categoryId' is set
32795
+ if (categoryId === undefined || categoryId === null) {
32796
+ throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
32797
+ }
32798
+ // verify the required parameter 'body' is set
32799
+ if (body === undefined || body === null) {
32800
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
32801
+ }
32802
+
32803
+ return this.apiClient.callApi(
32804
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
32805
+ 'PATCH',
32806
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
32807
+ { },
32808
+ { },
32809
+ { },
32810
+ body,
32811
+ ['PureCloud OAuth'],
32812
+ ['application/json'],
32813
+ ['application/json']
32814
+ );
32815
+ }
32816
+
32817
+ /**
32818
+ * Update document.
32819
+ *
32820
+ * @param {String} knowledgeBaseId Knowledge base ID.
32821
+ * @param {String} documentId Document ID.
32822
+ * @param {Object} body
32823
+ */
32824
+ patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
32825
+ // verify the required parameter 'knowledgeBaseId' is set
32826
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32827
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
32828
+ }
32829
+ // verify the required parameter 'documentId' is set
32830
+ if (documentId === undefined || documentId === null) {
32831
+ throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
32832
+ }
32833
+ // verify the required parameter 'body' is set
32834
+ if (body === undefined || body === null) {
32835
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
32836
+ }
32837
+
32838
+ return this.apiClient.callApi(
32839
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
32840
+ 'PATCH',
32841
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
32842
+ { },
32843
+ { },
32844
+ { },
32845
+ body,
32846
+ ['PureCloud OAuth'],
32847
+ ['application/json'],
32848
+ ['application/json']
32849
+ );
32850
+ }
32851
+
32852
+ /**
32853
+ * Update a variation for a document.
32854
+ *
32855
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
32856
+ * @param {String} documentId Globally unique identifier for a document.
32857
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
32858
+ * @param {Object} body
32859
+ */
32860
+ patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
32861
+ // verify the required parameter 'documentVariationId' is set
32862
+ if (documentVariationId === undefined || documentVariationId === null) {
32863
+ throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
32864
+ }
32865
+ // verify the required parameter 'documentId' is set
32866
+ if (documentId === undefined || documentId === null) {
32867
+ throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
32868
+ }
32869
+ // verify the required parameter 'knowledgeBaseId' is set
32870
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32871
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
32872
+ }
32873
+ // verify the required parameter 'body' is set
32874
+ if (body === undefined || body === null) {
32875
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
32876
+ }
32877
+
32878
+ return this.apiClient.callApi(
32879
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
32880
+ 'PATCH',
32881
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
32882
+ { },
32883
+ { },
32884
+ { },
32885
+ body,
32886
+ ['PureCloud OAuth'],
32887
+ ['application/json'],
32888
+ ['application/json']
32889
+ );
32890
+ }
32891
+
32892
+ /**
32893
+ * Update search result.
32894
+ *
32895
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
32896
+ * @param {String} searchId Search Result ID
32897
+ * @param {Object} opts Optional parameters
32898
+ * @param {Object} opts.body
32899
+ */
32900
+ patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
32901
+ opts = opts || {};
32902
+
32903
+ // verify the required parameter 'knowledgeBaseId' is set
32904
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32905
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
32906
+ }
32907
+ // verify the required parameter 'searchId' is set
32908
+ if (searchId === undefined || searchId === null) {
32909
+ throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
32910
+ }
32911
+
32912
+ return this.apiClient.callApi(
32913
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
32914
+ 'PATCH',
32915
+ { 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
32916
+ { },
32917
+ { },
32918
+ { },
32919
+ opts['body'],
32920
+ ['PureCloud OAuth'],
32921
+ ['application/json'],
32922
+ ['application/json']
32923
+ );
32924
+ }
32925
+
32926
+ /**
32927
+ * Start import job
32928
+ *
32929
+ * @param {String} knowledgeBaseId Knowledge base ID
32930
+ * @param {String} importJobId Import job ID
32931
+ * @param {Object} body
32932
+ */
32933
+ patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
32934
+ // verify the required parameter 'knowledgeBaseId' is set
32935
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32936
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
32937
+ }
32938
+ // verify the required parameter 'importJobId' is set
32939
+ if (importJobId === undefined || importJobId === null) {
32940
+ throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
32941
+ }
32942
+ // verify the required parameter 'body' is set
32943
+ if (body === undefined || body === null) {
32944
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
32945
+ }
32946
+
32947
+ return this.apiClient.callApi(
32948
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
32949
+ 'PATCH',
32950
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
32951
+ { },
32952
+ { },
32953
+ { },
32954
+ body,
32955
+ ['PureCloud OAuth'],
32956
+ ['application/json'],
32957
+ ['application/json']
32958
+ );
32959
+ }
32960
+
32961
+ /**
32962
+ * Update label
32963
+ *
32964
+ * @param {String} knowledgeBaseId Knowledge base ID
32965
+ * @param {String} labelId Label ID
32966
+ * @param {Object} body
32967
+ */
32968
+ patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
32969
+ // verify the required parameter 'knowledgeBaseId' is set
32970
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
32971
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
32972
+ }
32973
+ // verify the required parameter 'labelId' is set
32974
+ if (labelId === undefined || labelId === null) {
32975
+ throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
32976
+ }
32977
+ // verify the required parameter 'body' is set
32978
+ if (body === undefined || body === null) {
32979
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
32980
+ }
32981
+
32982
+ return this.apiClient.callApi(
32983
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
32984
+ 'PATCH',
32985
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
32986
+ { },
32987
+ { },
32988
+ { },
32989
+ body,
32990
+ ['PureCloud OAuth'],
32991
+ ['application/json'],
32992
+ ['application/json']
32993
+ );
32994
+ }
32995
+
31659
32996
  /**
31660
32997
  * Update category
31661
32998
  *
@@ -31811,6 +33148,46 @@ class KnowledgeApi {
31811
33148
  );
31812
33149
  }
31813
33150
 
33151
+ /**
33152
+ * Update a Knowledge base unanswered phrase group
33153
+ *
33154
+ * @param {String} knowledgeBaseId Knowledge base ID
33155
+ * @param {String} groupId The ID of the group to be updated.
33156
+ * @param {String} phraseGroupId The ID of the phraseGroup to be updated.
33157
+ * @param {Object} body Request body of the update unanswered group endpoint.
33158
+ */
33159
+ patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
33160
+ // verify the required parameter 'knowledgeBaseId' is set
33161
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33162
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
33163
+ }
33164
+ // verify the required parameter 'groupId' is set
33165
+ if (groupId === undefined || groupId === null) {
33166
+ throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
33167
+ }
33168
+ // verify the required parameter 'phraseGroupId' is set
33169
+ if (phraseGroupId === undefined || phraseGroupId === null) {
33170
+ throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
33171
+ }
33172
+ // verify the required parameter 'body' is set
33173
+ if (body === undefined || body === null) {
33174
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
33175
+ }
33176
+
33177
+ return this.apiClient.callApi(
33178
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
33179
+ 'PATCH',
33180
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
33181
+ { },
33182
+ { },
33183
+ { },
33184
+ body,
33185
+ ['PureCloud OAuth'],
33186
+ ['application/json'],
33187
+ ['application/json']
33188
+ );
33189
+ }
33190
+
31814
33191
  /**
31815
33192
  * Creates a presigned URL for uploading a knowledge import file with a set of documents
31816
33193
  *
@@ -31836,6 +33213,369 @@ class KnowledgeApi {
31836
33213
  );
31837
33214
  }
31838
33215
 
33216
+ /**
33217
+ * Search the documents in a guest session.
33218
+ *
33219
+ * @param {String} sessionId Knowledge guest session ID.
33220
+ * @param {Object} opts Optional parameters
33221
+ * @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
33222
+ * @param {Object} opts.body
33223
+ */
33224
+ postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
33225
+ opts = opts || {};
33226
+
33227
+ // verify the required parameter 'sessionId' is set
33228
+ if (sessionId === undefined || sessionId === null) {
33229
+ throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
33230
+ }
33231
+
33232
+ return this.apiClient.callApi(
33233
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
33234
+ 'POST',
33235
+ { 'sessionId': sessionId },
33236
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
33237
+ { },
33238
+ { },
33239
+ opts['body'],
33240
+ ['PureCloud OAuth'],
33241
+ ['application/json'],
33242
+ ['application/json']
33243
+ );
33244
+ }
33245
+
33246
+ /**
33247
+ * Query the knowledge documents to provide suggestions for auto completion.
33248
+ *
33249
+ * @param {String} sessionId Knowledge guest session ID.
33250
+ * @param {Object} opts Optional parameters
33251
+ * @param {Object} opts.body
33252
+ */
33253
+ postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
33254
+ opts = opts || {};
33255
+
33256
+ // verify the required parameter 'sessionId' is set
33257
+ if (sessionId === undefined || sessionId === null) {
33258
+ throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
33259
+ }
33260
+
33261
+ return this.apiClient.callApi(
33262
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
33263
+ 'POST',
33264
+ { 'sessionId': sessionId },
33265
+ { },
33266
+ { },
33267
+ { },
33268
+ opts['body'],
33269
+ ['PureCloud OAuth'],
33270
+ ['application/json'],
33271
+ ['application/json']
33272
+ );
33273
+ }
33274
+
33275
+ /**
33276
+ * Create guest session
33277
+ *
33278
+ * @param {Object} body
33279
+ */
33280
+ postKnowledgeGuestSessions(body) {
33281
+ // verify the required parameter 'body' is set
33282
+ if (body === undefined || body === null) {
33283
+ throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
33284
+ }
33285
+
33286
+ return this.apiClient.callApi(
33287
+ '/api/v2/knowledge/guest/sessions',
33288
+ 'POST',
33289
+ { },
33290
+ { },
33291
+ { },
33292
+ { },
33293
+ body,
33294
+ ['PureCloud OAuth'],
33295
+ ['application/json'],
33296
+ ['application/json']
33297
+ );
33298
+ }
33299
+
33300
+ /**
33301
+ * Create new category
33302
+ *
33303
+ * @param {String} knowledgeBaseId Knowledge base ID
33304
+ * @param {Object} body
33305
+ */
33306
+ postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
33307
+ // verify the required parameter 'knowledgeBaseId' is set
33308
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33309
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
33310
+ }
33311
+ // verify the required parameter 'body' is set
33312
+ if (body === undefined || body === null) {
33313
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
33314
+ }
33315
+
33316
+ return this.apiClient.callApi(
33317
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
33318
+ 'POST',
33319
+ { 'knowledgeBaseId': knowledgeBaseId },
33320
+ { },
33321
+ { },
33322
+ { },
33323
+ body,
33324
+ ['PureCloud OAuth'],
33325
+ ['application/json'],
33326
+ ['application/json']
33327
+ );
33328
+ }
33329
+
33330
+ /**
33331
+ * Create a variation for a document.
33332
+ *
33333
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
33334
+ * @param {String} documentId Globally unique identifier for the document.
33335
+ * @param {Object} body
33336
+ */
33337
+ postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
33338
+ // verify the required parameter 'knowledgeBaseId' is set
33339
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33340
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
33341
+ }
33342
+ // verify the required parameter 'documentId' is set
33343
+ if (documentId === undefined || documentId === null) {
33344
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
33345
+ }
33346
+ // verify the required parameter 'body' is set
33347
+ if (body === undefined || body === null) {
33348
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
33349
+ }
33350
+
33351
+ return this.apiClient.callApi(
33352
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
33353
+ 'POST',
33354
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
33355
+ { },
33356
+ { },
33357
+ { },
33358
+ body,
33359
+ ['PureCloud OAuth'],
33360
+ ['application/json'],
33361
+ ['application/json']
33362
+ );
33363
+ }
33364
+
33365
+ /**
33366
+ * Creates or restores a document version.
33367
+ *
33368
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
33369
+ * @param {String} documentId Globally unique identifier for the document.
33370
+ * @param {Object} body
33371
+ */
33372
+ postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
33373
+ // verify the required parameter 'knowledgeBaseId' is set
33374
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33375
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
33376
+ }
33377
+ // verify the required parameter 'documentId' is set
33378
+ if (documentId === undefined || documentId === null) {
33379
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
33380
+ }
33381
+ // verify the required parameter 'body' is set
33382
+ if (body === undefined || body === null) {
33383
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
33384
+ }
33385
+
33386
+ return this.apiClient.callApi(
33387
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
33388
+ 'POST',
33389
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
33390
+ { },
33391
+ { },
33392
+ { },
33393
+ body,
33394
+ ['PureCloud OAuth'],
33395
+ ['application/json'],
33396
+ ['application/json']
33397
+ );
33398
+ }
33399
+
33400
+ /**
33401
+ * Create document.
33402
+ *
33403
+ * @param {String} knowledgeBaseId Knowledge base ID
33404
+ * @param {Object} body
33405
+ */
33406
+ postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
33407
+ // verify the required parameter 'knowledgeBaseId' is set
33408
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33409
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
33410
+ }
33411
+ // verify the required parameter 'body' is set
33412
+ if (body === undefined || body === null) {
33413
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
33414
+ }
33415
+
33416
+ return this.apiClient.callApi(
33417
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
33418
+ 'POST',
33419
+ { 'knowledgeBaseId': knowledgeBaseId },
33420
+ { },
33421
+ { },
33422
+ { },
33423
+ body,
33424
+ ['PureCloud OAuth'],
33425
+ ['application/json'],
33426
+ ['application/json']
33427
+ );
33428
+ }
33429
+
33430
+ /**
33431
+ * Search the documents in a knowledge base.
33432
+ *
33433
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
33434
+ * @param {Object} opts Optional parameters
33435
+ * @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
33436
+ * @param {Object} opts.body
33437
+ */
33438
+ postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
33439
+ opts = opts || {};
33440
+
33441
+ // verify the required parameter 'knowledgeBaseId' is set
33442
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33443
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
33444
+ }
33445
+
33446
+ return this.apiClient.callApi(
33447
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
33448
+ 'POST',
33449
+ { 'knowledgeBaseId': knowledgeBaseId },
33450
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
33451
+ { },
33452
+ { },
33453
+ opts['body'],
33454
+ ['PureCloud OAuth'],
33455
+ ['application/json'],
33456
+ ['application/json']
33457
+ );
33458
+ }
33459
+
33460
+ /**
33461
+ * Query the knowledge documents to provide suggestions for auto completion.
33462
+ *
33463
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
33464
+ * @param {Object} opts Optional parameters
33465
+ * @param {Object} opts.body
33466
+ */
33467
+ postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
33468
+ opts = opts || {};
33469
+
33470
+ // verify the required parameter 'knowledgeBaseId' is set
33471
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33472
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
33473
+ }
33474
+
33475
+ return this.apiClient.callApi(
33476
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
33477
+ 'POST',
33478
+ { 'knowledgeBaseId': knowledgeBaseId },
33479
+ { },
33480
+ { },
33481
+ { },
33482
+ opts['body'],
33483
+ ['PureCloud OAuth'],
33484
+ ['application/json'],
33485
+ ['application/json']
33486
+ );
33487
+ }
33488
+
33489
+ /**
33490
+ * Create export job
33491
+ *
33492
+ * @param {String} knowledgeBaseId Knowledge base ID
33493
+ * @param {Object} body
33494
+ */
33495
+ postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
33496
+ // verify the required parameter 'knowledgeBaseId' is set
33497
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33498
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
33499
+ }
33500
+ // verify the required parameter 'body' is set
33501
+ if (body === undefined || body === null) {
33502
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
33503
+ }
33504
+
33505
+ return this.apiClient.callApi(
33506
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
33507
+ 'POST',
33508
+ { 'knowledgeBaseId': knowledgeBaseId },
33509
+ { },
33510
+ { },
33511
+ { },
33512
+ body,
33513
+ ['PureCloud OAuth'],
33514
+ ['application/json'],
33515
+ ['application/json']
33516
+ );
33517
+ }
33518
+
33519
+ /**
33520
+ * Create import job
33521
+ *
33522
+ * @param {String} knowledgeBaseId Knowledge base ID
33523
+ * @param {Object} body
33524
+ */
33525
+ postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
33526
+ // verify the required parameter 'knowledgeBaseId' is set
33527
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33528
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
33529
+ }
33530
+ // verify the required parameter 'body' is set
33531
+ if (body === undefined || body === null) {
33532
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
33533
+ }
33534
+
33535
+ return this.apiClient.callApi(
33536
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
33537
+ 'POST',
33538
+ { 'knowledgeBaseId': knowledgeBaseId },
33539
+ { },
33540
+ { },
33541
+ { },
33542
+ body,
33543
+ ['PureCloud OAuth'],
33544
+ ['application/json'],
33545
+ ['application/json']
33546
+ );
33547
+ }
33548
+
33549
+ /**
33550
+ * Create new label
33551
+ *
33552
+ * @param {String} knowledgeBaseId Knowledge base ID
33553
+ * @param {Object} body
33554
+ */
33555
+ postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
33556
+ // verify the required parameter 'knowledgeBaseId' is set
33557
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
33558
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
33559
+ }
33560
+ // verify the required parameter 'body' is set
33561
+ if (body === undefined || body === null) {
33562
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
33563
+ }
33564
+
33565
+ return this.apiClient.callApi(
33566
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
33567
+ 'POST',
33568
+ { 'knowledgeBaseId': knowledgeBaseId },
33569
+ { },
33570
+ { },
33571
+ { },
33572
+ body,
33573
+ ['PureCloud OAuth'],
33574
+ ['application/json'],
33575
+ ['application/json']
33576
+ );
33577
+ }
33578
+
31839
33579
  /**
31840
33580
  * Create new category
31841
33581
  *
@@ -32066,7 +33806,7 @@ class LanguageUnderstandingApi {
32066
33806
  /**
32067
33807
  * LanguageUnderstanding service.
32068
33808
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
32069
- * @version 143.0.0
33809
+ * @version 146.0.0
32070
33810
  */
32071
33811
 
32072
33812
  /**
@@ -32970,7 +34710,7 @@ class LanguagesApi {
32970
34710
  /**
32971
34711
  * Languages service.
32972
34712
  * @module purecloud-platform-client-v2/api/LanguagesApi
32973
- * @version 143.0.0
34713
+ * @version 146.0.0
32974
34714
  */
32975
34715
 
32976
34716
  /**
@@ -33238,7 +34978,7 @@ class LearningApi {
33238
34978
  /**
33239
34979
  * Learning service.
33240
34980
  * @module purecloud-platform-client-v2/api/LearningApi
33241
- * @version 143.0.0
34981
+ * @version 146.0.0
33242
34982
  */
33243
34983
 
33244
34984
  /**
@@ -33591,6 +35331,31 @@ class LearningApi {
33591
35331
  );
33592
35332
  }
33593
35333
 
35334
+ /**
35335
+ * Get a specific Learning Module cover art using ID
35336
+ *
35337
+ * @param {String} coverArtId Key identifier for the cover art
35338
+ */
35339
+ getLearningModulesCoverartCoverArtId(coverArtId) {
35340
+ // verify the required parameter 'coverArtId' is set
35341
+ if (coverArtId === undefined || coverArtId === null) {
35342
+ throw 'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';
35343
+ }
35344
+
35345
+ return this.apiClient.callApi(
35346
+ '/api/v2/learning/modules/coverart/{coverArtId}',
35347
+ 'GET',
35348
+ { 'coverArtId': coverArtId },
35349
+ { },
35350
+ { },
35351
+ { },
35352
+ null,
35353
+ ['PureCloud OAuth'],
35354
+ ['application/json'],
35355
+ ['application/json']
35356
+ );
35357
+ }
35358
+
33594
35359
  /**
33595
35360
  * Update Learning Assignment
33596
35361
  *
@@ -33973,7 +35738,7 @@ class LicenseApi {
33973
35738
  /**
33974
35739
  * License service.
33975
35740
  * @module purecloud-platform-client-v2/api/LicenseApi
33976
- * @version 143.0.0
35741
+ * @version 146.0.0
33977
35742
  */
33978
35743
 
33979
35744
  /**
@@ -34211,7 +35976,7 @@ class LocationsApi {
34211
35976
  /**
34212
35977
  * Locations service.
34213
35978
  * @module purecloud-platform-client-v2/api/LocationsApi
34214
- * @version 143.0.0
35979
+ * @version 146.0.0
34215
35980
  */
34216
35981
 
34217
35982
  /**
@@ -34447,7 +36212,7 @@ class MessagingApi {
34447
36212
  /**
34448
36213
  * Messaging service.
34449
36214
  * @module purecloud-platform-client-v2/api/MessagingApi
34450
- * @version 143.0.0
36215
+ * @version 146.0.0
34451
36216
  */
34452
36217
 
34453
36218
  /**
@@ -34598,7 +36363,7 @@ class MobileDevicesApi {
34598
36363
  /**
34599
36364
  * MobileDevices service.
34600
36365
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
34601
- * @version 143.0.0
36366
+ * @version 146.0.0
34602
36367
  */
34603
36368
 
34604
36369
  /**
@@ -34749,7 +36514,7 @@ class NotificationsApi {
34749
36514
  /**
34750
36515
  * Notifications service.
34751
36516
  * @module purecloud-platform-client-v2/api/NotificationsApi
34752
- * @version 143.0.0
36517
+ * @version 146.0.0
34753
36518
  */
34754
36519
 
34755
36520
  /**
@@ -34974,7 +36739,7 @@ class OAuthApi {
34974
36739
  /**
34975
36740
  * OAuth service.
34976
36741
  * @module purecloud-platform-client-v2/api/OAuthApi
34977
- * @version 143.0.0
36742
+ * @version 146.0.0
34978
36743
  */
34979
36744
 
34980
36745
  /**
@@ -35340,7 +37105,7 @@ class ObjectsApi {
35340
37105
  /**
35341
37106
  * Objects service.
35342
37107
  * @module purecloud-platform-client-v2/api/ObjectsApi
35343
- * @version 143.0.0
37108
+ * @version 146.0.0
35344
37109
  */
35345
37110
 
35346
37111
  /**
@@ -35611,7 +37376,7 @@ class OrganizationApi {
35611
37376
  /**
35612
37377
  * Organization service.
35613
37378
  * @module purecloud-platform-client-v2/api/OrganizationApi
35614
- * @version 143.0.0
37379
+ * @version 146.0.0
35615
37380
  */
35616
37381
 
35617
37382
  /**
@@ -36014,7 +37779,7 @@ class OrganizationAuthorizationApi {
36014
37779
  /**
36015
37780
  * OrganizationAuthorization service.
36016
37781
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
36017
- * @version 143.0.0
37782
+ * @version 146.0.0
36018
37783
  */
36019
37784
 
36020
37785
  /**
@@ -36939,7 +38704,7 @@ class OutboundApi {
36939
38704
  /**
36940
38705
  * Outbound service.
36941
38706
  * @module purecloud-platform-client-v2/api/OutboundApi
36942
- * @version 143.0.0
38707
+ * @version 146.0.0
36943
38708
  */
36944
38709
 
36945
38710
  /**
@@ -40194,7 +41959,7 @@ class PresenceApi {
40194
41959
  /**
40195
41960
  * Presence service.
40196
41961
  * @module purecloud-platform-client-v2/api/PresenceApi
40197
- * @version 143.0.0
41962
+ * @version 146.0.0
40198
41963
  */
40199
41964
 
40200
41965
  /**
@@ -40516,7 +42281,7 @@ class QualityApi {
40516
42281
  /**
40517
42282
  * Quality service.
40518
42283
  * @module purecloud-platform-client-v2/api/QualityApi
40519
- * @version 143.0.0
42284
+ * @version 146.0.0
40520
42285
  */
40521
42286
 
40522
42287
  /**
@@ -42094,7 +43859,7 @@ class RecordingApi {
42094
43859
  /**
42095
43860
  * Recording service.
42096
43861
  * @module purecloud-platform-client-v2/api/RecordingApi
42097
- * @version 143.0.0
43862
+ * @version 146.0.0
42098
43863
  */
42099
43864
 
42100
43865
  /**
@@ -43747,7 +45512,7 @@ class ResponseManagementApi {
43747
45512
  /**
43748
45513
  * ResponseManagement service.
43749
45514
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
43750
- * @version 143.0.0
45515
+ * @version 146.0.0
43751
45516
  */
43752
45517
 
43753
45518
  /**
@@ -44231,7 +45996,7 @@ class RoutingApi {
44231
45996
  /**
44232
45997
  * Routing service.
44233
45998
  * @module purecloud-platform-client-v2/api/RoutingApi
44234
- * @version 143.0.0
45999
+ * @version 146.0.0
44235
46000
  */
44236
46001
 
44237
46002
  /**
@@ -44797,6 +46562,26 @@ class RoutingApi {
44797
46562
  );
44798
46563
  }
44799
46564
 
46565
+ /**
46566
+ * Get available media types
46567
+ *
46568
+ */
46569
+ getRoutingAvailablemediatypes() {
46570
+
46571
+ return this.apiClient.callApi(
46572
+ '/api/v2/routing/availablemediatypes',
46573
+ 'GET',
46574
+ { },
46575
+ { },
46576
+ { },
46577
+ { },
46578
+ null,
46579
+ ['PureCloud OAuth'],
46580
+ ['application/json'],
46581
+ ['application/json']
46582
+ );
46583
+ }
46584
+
44800
46585
  /**
44801
46586
  * Get domain
44802
46587
  *
@@ -47152,7 +48937,7 @@ class SCIMApi {
47152
48937
  /**
47153
48938
  * SCIM service.
47154
48939
  * @module purecloud-platform-client-v2/api/SCIMApi
47155
- * @version 143.0.0
48940
+ * @version 146.0.0
47156
48941
  */
47157
48942
 
47158
48943
  /**
@@ -48029,7 +49814,7 @@ class ScriptsApi {
48029
49814
  /**
48030
49815
  * Scripts service.
48031
49816
  * @module purecloud-platform-client-v2/api/ScriptsApi
48032
- * @version 143.0.0
49817
+ * @version 146.0.0
48033
49818
  */
48034
49819
 
48035
49820
  /**
@@ -48448,7 +50233,7 @@ class SearchApi {
48448
50233
  /**
48449
50234
  * Search service.
48450
50235
  * @module purecloud-platform-client-v2/api/SearchApi
48451
- * @version 143.0.0
50236
+ * @version 146.0.0
48452
50237
  */
48453
50238
 
48454
50239
  /**
@@ -49008,7 +50793,7 @@ class SpeechTextAnalyticsApi {
49008
50793
  /**
49009
50794
  * SpeechTextAnalytics service.
49010
50795
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
49011
- * @version 143.0.0
50796
+ * @version 146.0.0
49012
50797
  */
49013
50798
 
49014
50799
  /**
@@ -49862,7 +51647,7 @@ class StationsApi {
49862
51647
  /**
49863
51648
  * Stations service.
49864
51649
  * @module purecloud-platform-client-v2/api/StationsApi
49865
- * @version 143.0.0
51650
+ * @version 146.0.0
49866
51651
  */
49867
51652
 
49868
51653
  /**
@@ -50009,7 +51794,7 @@ class SuggestApi {
50009
51794
  /**
50010
51795
  * Suggest service.
50011
51796
  * @module purecloud-platform-client-v2/api/SuggestApi
50012
- * @version 143.0.0
51797
+ * @version 146.0.0
50013
51798
  */
50014
51799
 
50015
51800
  /**
@@ -50148,7 +51933,7 @@ class TeamsApi {
50148
51933
  /**
50149
51934
  * Teams service.
50150
51935
  * @module purecloud-platform-client-v2/api/TeamsApi
50151
- * @version 143.0.0
51936
+ * @version 146.0.0
50152
51937
  */
50153
51938
 
50154
51939
  /**
@@ -50327,7 +52112,7 @@ class TelephonyApi {
50327
52112
  /**
50328
52113
  * Telephony service.
50329
52114
  * @module purecloud-platform-client-v2/api/TelephonyApi
50330
- * @version 143.0.0
52115
+ * @version 146.0.0
50331
52116
  */
50332
52117
 
50333
52118
  /**
@@ -50435,7 +52220,7 @@ class TelephonyProvidersEdgeApi {
50435
52220
  /**
50436
52221
  * TelephonyProvidersEdge service.
50437
52222
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
50438
- * @version 143.0.0
52223
+ * @version 146.0.0
50439
52224
  */
50440
52225
 
50441
52226
  /**
@@ -54068,7 +55853,7 @@ class TextbotsApi {
54068
55853
  /**
54069
55854
  * Textbots service.
54070
55855
  * @module purecloud-platform-client-v2/api/TextbotsApi
54071
- * @version 143.0.0
55856
+ * @version 146.0.0
54072
55857
  */
54073
55858
 
54074
55859
  /**
@@ -54196,7 +55981,7 @@ class TokensApi {
54196
55981
  /**
54197
55982
  * Tokens service.
54198
55983
  * @module purecloud-platform-client-v2/api/TokensApi
54199
- * @version 143.0.0
55984
+ * @version 146.0.0
54200
55985
  */
54201
55986
 
54202
55987
  /**
@@ -54302,7 +56087,7 @@ class UploadsApi {
54302
56087
  /**
54303
56088
  * Uploads service.
54304
56089
  * @module purecloud-platform-client-v2/api/UploadsApi
54305
- * @version 143.0.0
56090
+ * @version 146.0.0
54306
56091
  */
54307
56092
 
54308
56093
  /**
@@ -54372,6 +56157,31 @@ class UploadsApi {
54372
56157
  );
54373
56158
  }
54374
56159
 
56160
+ /**
56161
+ * Generates pre-signed URL to upload cover art for learning modules
56162
+ *
56163
+ * @param {Object} body query
56164
+ */
56165
+ postUploadsLearningCoverart(body) {
56166
+ // verify the required parameter 'body' is set
56167
+ if (body === undefined || body === null) {
56168
+ throw 'Missing the required parameter "body" when calling postUploadsLearningCoverart';
56169
+ }
56170
+
56171
+ return this.apiClient.callApi(
56172
+ '/api/v2/uploads/learning/coverart',
56173
+ 'POST',
56174
+ { },
56175
+ { },
56176
+ { },
56177
+ { },
56178
+ body,
56179
+ ['PureCloud OAuth'],
56180
+ ['application/json'],
56181
+ ['application/json']
56182
+ );
56183
+ }
56184
+
54375
56185
  /**
54376
56186
  * Creates presigned url for uploading a public asset image
54377
56187
  *
@@ -54453,7 +56263,7 @@ class UsageApi {
54453
56263
  /**
54454
56264
  * Usage service.
54455
56265
  * @module purecloud-platform-client-v2/api/UsageApi
54456
- * @version 143.0.0
56266
+ * @version 146.0.0
54457
56267
  */
54458
56268
 
54459
56269
  /**
@@ -54524,7 +56334,7 @@ class UserRecordingsApi {
54524
56334
  /**
54525
56335
  * UserRecordings service.
54526
56336
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
54527
- * @version 143.0.0
56337
+ * @version 146.0.0
54528
56338
  */
54529
56339
 
54530
56340
  /**
@@ -54708,7 +56518,7 @@ class UsersApi {
54708
56518
  /**
54709
56519
  * Users service.
54710
56520
  * @module purecloud-platform-client-v2/api/UsersApi
54711
- * @version 143.0.0
56521
+ * @version 146.0.0
54712
56522
  */
54713
56523
 
54714
56524
  /**
@@ -56571,7 +58381,7 @@ class UsersApi {
56571
58381
 
56572
58382
  /**
56573
58383
  * Create user
56574
- *
58384
+ * If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
56575
58385
  * @param {Object} body User
56576
58386
  */
56577
58387
  postUsers(body) {
@@ -57010,7 +58820,7 @@ class UtilitiesApi {
57010
58820
  /**
57011
58821
  * Utilities service.
57012
58822
  * @module purecloud-platform-client-v2/api/UtilitiesApi
57013
- * @version 143.0.0
58823
+ * @version 146.0.0
57014
58824
  */
57015
58825
 
57016
58826
  /**
@@ -57121,7 +58931,7 @@ class VoicemailApi {
57121
58931
  /**
57122
58932
  * Voicemail service.
57123
58933
  * @module purecloud-platform-client-v2/api/VoicemailApi
57124
- * @version 143.0.0
58934
+ * @version 146.0.0
57125
58935
  */
57126
58936
 
57127
58937
  /**
@@ -57788,7 +59598,7 @@ class WebChatApi {
57788
59598
  /**
57789
59599
  * WebChat service.
57790
59600
  * @module purecloud-platform-client-v2/api/WebChatApi
57791
- * @version 143.0.0
59601
+ * @version 146.0.0
57792
59602
  */
57793
59603
 
57794
59604
  /**
@@ -58332,7 +60142,7 @@ class WebDeploymentsApi {
58332
60142
  /**
58333
60143
  * WebDeployments service.
58334
60144
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
58335
- * @version 143.0.0
60145
+ * @version 146.0.0
58336
60146
  */
58337
60147
 
58338
60148
  /**
@@ -58687,7 +60497,7 @@ class WebMessagingApi {
58687
60497
  /**
58688
60498
  * WebMessaging service.
58689
60499
  * @module purecloud-platform-client-v2/api/WebMessagingApi
58690
- * @version 143.0.0
60500
+ * @version 146.0.0
58691
60501
  */
58692
60502
 
58693
60503
  /**
@@ -58733,7 +60543,7 @@ class WidgetsApi {
58733
60543
  /**
58734
60544
  * Widgets service.
58735
60545
  * @module purecloud-platform-client-v2/api/WidgetsApi
58736
- * @version 143.0.0
60546
+ * @version 146.0.0
58737
60547
  */
58738
60548
 
58739
60549
  /**
@@ -58879,7 +60689,7 @@ class WorkforceManagementApi {
58879
60689
  /**
58880
60690
  * WorkforceManagement service.
58881
60691
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
58882
- * @version 143.0.0
60692
+ * @version 146.0.0
58883
60693
  */
58884
60694
 
58885
60695
  /**
@@ -63155,7 +64965,7 @@ class WorkforceManagementApi {
63155
64965
  * </pre>
63156
64966
  * </p>
63157
64967
  * @module purecloud-platform-client-v2/index
63158
- * @version 143.0.0
64968
+ * @version 146.0.0
63159
64969
  */
63160
64970
  class platformClient {
63161
64971
  constructor() {