purecloud-platform-client-v2 169.0.0 → 169.1.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 (80) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +24865 -20195
  3. package/dist/web-amd/purecloud-platform-client-v2.js +24865 -20195
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +24865 -20195
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +24865 -20195
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +2314 -2
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1418 -227
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +142 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -2
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +171 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +114 -1
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +114 -4
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +333 -1
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +260 -1
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +198 -21
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +53 -1
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +136 -1
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +174 -10
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +199 -6
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +80 -2
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1282 -0
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +32 -1
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +33 -2
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +47 -1
  69. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsersApi.js +172 -7
  73. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
  76. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
  80. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class JourneyApi {
5
5
  /**
6
6
  * Journey service.
7
7
  * @module purecloud-platform-client-v2/api/JourneyApi
8
- * @version 169.0.0
8
+ * @version 169.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -149,6 +149,62 @@ class JourneyApi {
149
149
  );
150
150
  }
151
151
 
152
+ /**
153
+ * Get status for async query for journey aggregates
154
+ *
155
+ * @param {String} jobId jobId
156
+ * Preview Endpoint
157
+ */
158
+ getAnalyticsJourneysAggregatesJob(jobId) {
159
+ // verify the required parameter 'jobId' is set
160
+ if (jobId === undefined || jobId === null) {
161
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';
162
+ }
163
+
164
+ return this.apiClient.callApi(
165
+ '/api/v2/analytics/journeys/aggregates/jobs/{jobId}',
166
+ 'GET',
167
+ { 'jobId': jobId },
168
+ { },
169
+ { },
170
+ { },
171
+ null,
172
+ ['PureCloud OAuth'],
173
+ ['application/json'],
174
+ ['application/json']
175
+ );
176
+ }
177
+
178
+ /**
179
+ * Fetch a page of results for an async aggregates query
180
+ *
181
+ * @param {String} jobId jobId
182
+ * @param {Object} opts Optional parameters
183
+ * @param {String} opts.cursor Cursor token to retrieve next page
184
+ * Preview Endpoint
185
+ */
186
+ getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
187
+ opts = opts || {};
188
+
189
+ // verify the required parameter 'jobId' is set
190
+ if (jobId === undefined || jobId === null) {
191
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';
192
+ }
193
+
194
+ return this.apiClient.callApi(
195
+ '/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results',
196
+ 'GET',
197
+ { 'jobId': jobId },
198
+ { 'cursor': opts['cursor'] },
199
+ { },
200
+ { },
201
+ null,
202
+ ['PureCloud OAuth'],
203
+ ['application/json'],
204
+ ['application/json']
205
+ );
206
+ }
207
+
152
208
  /**
153
209
  * Retrieve a single action map.
154
210
  *
@@ -360,6 +416,42 @@ class JourneyApi {
360
416
  );
361
417
  }
362
418
 
419
+ /**
420
+ * Retrieve all sessions for a given customer.
421
+ *
422
+ * @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
423
+ * @param {String} customerId Primary identifier of the customer in the source of the session.
424
+ * @param {Object} opts Optional parameters
425
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
426
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
427
+ * Preview Endpoint
428
+ */
429
+ getJourneyCustomerCustomerIdSessions(customerIdType, customerId, opts) {
430
+ opts = opts || {};
431
+
432
+ // verify the required parameter 'customerIdType' is set
433
+ if (customerIdType === undefined || customerIdType === null) {
434
+ throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSessions';
435
+ }
436
+ // verify the required parameter 'customerId' is set
437
+ if (customerId === undefined || customerId === null) {
438
+ throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSessions';
439
+ }
440
+
441
+ return this.apiClient.callApi(
442
+ '/api/v2/journey/customers/{customerIdType}/{customerId}/sessions',
443
+ 'GET',
444
+ { 'customerIdType': customerIdType,'customerId': customerId },
445
+ { 'pageSize': opts['pageSize'],'after': opts['after'] },
446
+ { },
447
+ { },
448
+ null,
449
+ ['PureCloud OAuth'],
450
+ ['application/json'],
451
+ ['application/json']
452
+ );
453
+ }
454
+
363
455
  /**
364
456
  * Retrieve a single outcome.
365
457
  *
@@ -414,6 +506,58 @@ class JourneyApi {
414
506
  );
415
507
  }
416
508
 
509
+ /**
510
+ * Get job status.
511
+ *
512
+ * @param {String} jobId ID of the job.
513
+ * Preview Endpoint
514
+ */
515
+ getJourneyOutcomesAttributionsJob(jobId) {
516
+ // verify the required parameter 'jobId' is set
517
+ if (jobId === undefined || jobId === null) {
518
+ throw 'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJob';
519
+ }
520
+
521
+ return this.apiClient.callApi(
522
+ '/api/v2/journey/outcomes/attributions/jobs/{jobId}',
523
+ 'GET',
524
+ { 'jobId': jobId },
525
+ { },
526
+ { },
527
+ { },
528
+ null,
529
+ ['PureCloud OAuth'],
530
+ ['application/json'],
531
+ ['application/json']
532
+ );
533
+ }
534
+
535
+ /**
536
+ * Get outcome attribution entities from completed job.
537
+ *
538
+ * @param {String} jobId ID of the job.
539
+ * Preview Endpoint
540
+ */
541
+ getJourneyOutcomesAttributionsJobResults(jobId) {
542
+ // verify the required parameter 'jobId' is set
543
+ if (jobId === undefined || jobId === null) {
544
+ throw 'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJobResults';
545
+ }
546
+
547
+ return this.apiClient.callApi(
548
+ '/api/v2/journey/outcomes/attributions/jobs/{jobId}/results',
549
+ 'GET',
550
+ { 'jobId': jobId },
551
+ { },
552
+ { },
553
+ { },
554
+ null,
555
+ ['PureCloud OAuth'],
556
+ ['application/json'],
557
+ ['application/json']
558
+ );
559
+ }
560
+
417
561
  /**
418
562
  * Retrieve a single outcome predictor.
419
563
  *
@@ -539,6 +683,37 @@ class JourneyApi {
539
683
  );
540
684
  }
541
685
 
686
+ /**
687
+ * Retrieve all events for a given session.
688
+ *
689
+ * @param {String} sessionId System-generated UUID that represents the session the event is a part of.
690
+ * @param {Object} opts Optional parameters
691
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
692
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
693
+ * Preview Endpoint
694
+ */
695
+ getJourneySessionEvents(sessionId, opts) {
696
+ opts = opts || {};
697
+
698
+ // verify the required parameter 'sessionId' is set
699
+ if (sessionId === undefined || sessionId === null) {
700
+ throw 'Missing the required parameter "sessionId" when calling getJourneySessionEvents';
701
+ }
702
+
703
+ return this.apiClient.callApi(
704
+ '/api/v2/journey/sessions/{sessionId}/events',
705
+ 'GET',
706
+ { 'sessionId': sessionId },
707
+ { 'pageSize': opts['pageSize'],'after': opts['after'] },
708
+ { },
709
+ { },
710
+ null,
711
+ ['PureCloud OAuth'],
712
+ ['application/json'],
713
+ ['application/json']
714
+ );
715
+ }
716
+
542
717
  /**
543
718
  * Retrieve latest outcome score associated with a session for all outcomes.
544
719
  *
@@ -564,6 +739,39 @@ class JourneyApi {
564
739
  );
565
740
  }
566
741
 
742
+ /**
743
+ * Retrieve segment assignments by session ID.
744
+ *
745
+ * @param {String} sessionId ID of the session to query for segment assignments.
746
+ * @param {Object} opts Optional parameters
747
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
748
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
749
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
750
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
751
+ * Preview Endpoint
752
+ */
753
+ getJourneySessionSegments(sessionId, opts) {
754
+ opts = opts || {};
755
+
756
+ // verify the required parameter 'sessionId' is set
757
+ if (sessionId === undefined || sessionId === null) {
758
+ throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
759
+ }
760
+
761
+ return this.apiClient.callApi(
762
+ '/api/v2/journey/sessions/{sessionId}/segments',
763
+ 'GET',
764
+ { 'sessionId': sessionId },
765
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
766
+ { },
767
+ { },
768
+ null,
769
+ ['PureCloud OAuth'],
770
+ ['application/json'],
771
+ ['application/json']
772
+ );
773
+ }
774
+
567
775
  /**
568
776
  * Update single action map.
569
777
  *
@@ -709,6 +917,32 @@ class JourneyApi {
709
917
  );
710
918
  }
711
919
 
920
+ /**
921
+ * Query for journey aggregates asynchronously
922
+ *
923
+ * @param {Object} body query
924
+ * Preview Endpoint
925
+ */
926
+ postAnalyticsJourneysAggregatesJobs(body) {
927
+ // verify the required parameter 'body' is set
928
+ if (body === undefined || body === null) {
929
+ throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';
930
+ }
931
+
932
+ return this.apiClient.callApi(
933
+ '/api/v2/analytics/journeys/aggregates/jobs',
934
+ 'POST',
935
+ { },
936
+ { },
937
+ { },
938
+ { },
939
+ body,
940
+ ['PureCloud OAuth'],
941
+ ['application/json'],
942
+ ['application/json']
943
+ );
944
+ }
945
+
712
946
  /**
713
947
  * Query for journey aggregates
714
948
  *
@@ -831,6 +1065,31 @@ class JourneyApi {
831
1065
  );
832
1066
  }
833
1067
 
1068
+ /**
1069
+ * Create Outcome Attributions
1070
+ *
1071
+ * @param {Object} opts Optional parameters
1072
+ * @param {Object} opts.body outcome attribution request
1073
+ * Preview Endpoint
1074
+ */
1075
+ postJourneyOutcomesAttributionsJobs(opts) {
1076
+ opts = opts || {};
1077
+
1078
+
1079
+ return this.apiClient.callApi(
1080
+ '/api/v2/journey/outcomes/attributions/jobs',
1081
+ 'POST',
1082
+ { },
1083
+ { },
1084
+ { },
1085
+ { },
1086
+ opts['body'],
1087
+ ['PureCloud OAuth'],
1088
+ ['application/json'],
1089
+ ['application/json']
1090
+ );
1091
+ }
1092
+
834
1093
  /**
835
1094
  * Create an outcome predictor.
836
1095
  *
@@ -5,7 +5,7 @@ class KnowledgeApi {
5
5
  /**
6
6
  * Knowledge service.
7
7
  * @module purecloud-platform-client-v2/api/KnowledgeApi
8
- * @version 169.0.0
8
+ * @version 169.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -236,7 +236,7 @@ class KnowledgeApi {
236
236
  * @param {String} categoryId Category ID
237
237
  * @param {String} knowledgeBaseId Knowledge base ID
238
238
  * @param {Object} languageCode Language code, format: iso2-LOCALE
239
- * @deprecated
239
+ * @deprecated
240
240
  */
241
241
  deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
242
242
  // verify the required parameter 'categoryId' is set
@@ -272,7 +272,7 @@ class KnowledgeApi {
272
272
  * @param {String} documentId Document ID
273
273
  * @param {String} knowledgeBaseId Knowledge base ID
274
274
  * @param {Object} languageCode Language code, format: iso2-LOCALE
275
- * @deprecated
275
+ * @deprecated
276
276
  */
277
277
  deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
278
278
  // verify the required parameter 'documentId' is set
@@ -308,7 +308,7 @@ class KnowledgeApi {
308
308
  * @param {String} knowledgeBaseId Knowledge base ID
309
309
  * @param {Object} languageCode Language code, format: iso2-LOCALE
310
310
  * @param {String} importId Import ID
311
- * @deprecated
311
+ * @deprecated
312
312
  */
313
313
  deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
314
314
  // verify the required parameter 'knowledgeBaseId' is set
@@ -967,7 +967,7 @@ class KnowledgeApi {
967
967
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
968
968
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
969
969
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
970
- * @deprecated
970
+ * @deprecated
971
971
  */
972
972
  getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
973
973
  opts = opts || {};
@@ -1001,7 +1001,7 @@ class KnowledgeApi {
1001
1001
  * @param {String} categoryId Category ID
1002
1002
  * @param {String} knowledgeBaseId Knowledge base ID
1003
1003
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1004
- * @deprecated
1004
+ * @deprecated
1005
1005
  */
1006
1006
  getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
1007
1007
  // verify the required parameter 'categoryId' is set
@@ -1037,7 +1037,7 @@ class KnowledgeApi {
1037
1037
  * @param {String} documentId Document ID
1038
1038
  * @param {String} knowledgeBaseId Knowledge base ID
1039
1039
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1040
- * @deprecated
1040
+ * @deprecated
1041
1041
  */
1042
1042
  getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
1043
1043
  // verify the required parameter 'documentId' is set
@@ -1067,6 +1067,48 @@ class KnowledgeApi {
1067
1067
  );
1068
1068
  }
1069
1069
 
1070
+ /**
1071
+ * Get document content upload status
1072
+ *
1073
+ * @param {String} documentId Document ID
1074
+ * @param {String} knowledgeBaseId Knowledge base ID
1075
+ * @param {Object} languageCode Language code, format: iso2-LOCALE
1076
+ * @param {String} uploadId UploadId
1077
+ * @deprecated
1078
+ * Preview Endpoint
1079
+ */
1080
+ getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
1081
+ // verify the required parameter 'documentId' is set
1082
+ if (documentId === undefined || documentId === null) {
1083
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
1084
+ }
1085
+ // verify the required parameter 'knowledgeBaseId' is set
1086
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
1087
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
1088
+ }
1089
+ // verify the required parameter 'languageCode' is set
1090
+ if (languageCode === undefined || languageCode === null) {
1091
+ throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
1092
+ }
1093
+ // verify the required parameter 'uploadId' is set
1094
+ if (uploadId === undefined || uploadId === null) {
1095
+ throw 'Missing the required parameter "uploadId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
1096
+ }
1097
+
1098
+ return this.apiClient.callApi(
1099
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}',
1100
+ 'GET',
1101
+ { 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'uploadId': uploadId },
1102
+ { },
1103
+ { },
1104
+ { },
1105
+ null,
1106
+ ['PureCloud OAuth'],
1107
+ ['application/json'],
1108
+ ['application/json']
1109
+ );
1110
+ }
1111
+
1070
1112
  /**
1071
1113
  * Get documents
1072
1114
  *
@@ -1082,7 +1124,7 @@ class KnowledgeApi {
1082
1124
  * @param {Object} opts.sortBy Sort by.
1083
1125
  * @param {Object} opts.sortOrder Sort Order.
1084
1126
  * @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
1085
- * @deprecated
1127
+ * @deprecated
1086
1128
  */
1087
1129
  getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
1088
1130
  opts = opts || {};
@@ -1116,7 +1158,7 @@ class KnowledgeApi {
1116
1158
  * @param {String} knowledgeBaseId Knowledge base ID
1117
1159
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1118
1160
  * @param {String} importId Import ID
1119
- * @deprecated
1161
+ * @deprecated
1120
1162
  */
1121
1163
  getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
1122
1164
  // verify the required parameter 'knowledgeBaseId' is set
@@ -1152,7 +1194,7 @@ class KnowledgeApi {
1152
1194
  * @param {String} knowledgeBaseId Knowledge base ID
1153
1195
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1154
1196
  * @param {String} trainingId Training ID
1155
- * @deprecated
1197
+ * @deprecated
1156
1198
  */
1157
1199
  getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
1158
1200
  // verify the required parameter 'knowledgeBaseId' is set
@@ -1193,7 +1235,7 @@ class KnowledgeApi {
1193
1235
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
1194
1236
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
1195
1237
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
1196
- * @deprecated
1238
+ * @deprecated
1197
1239
  */
1198
1240
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
1199
1241
  opts = opts || {};
@@ -1641,7 +1683,7 @@ class KnowledgeApi {
1641
1683
  * @param {String} knowledgeBaseId Knowledge base ID
1642
1684
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1643
1685
  * @param {Object} body
1644
- * @deprecated
1686
+ * @deprecated
1645
1687
  */
1646
1688
  patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
1647
1689
  // verify the required parameter 'categoryId' is set
@@ -1682,7 +1724,7 @@ class KnowledgeApi {
1682
1724
  * @param {String} knowledgeBaseId Knowledge base ID
1683
1725
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1684
1726
  * @param {Object} body
1685
- * @deprecated
1727
+ * @deprecated
1686
1728
  */
1687
1729
  patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
1688
1730
  // verify the required parameter 'documentId' is set
@@ -1722,7 +1764,7 @@ class KnowledgeApi {
1722
1764
  * @param {String} knowledgeBaseId Knowledge base ID
1723
1765
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1724
1766
  * @param {Array.<Object>} body
1725
- * @deprecated
1767
+ * @deprecated
1726
1768
  */
1727
1769
  patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
1728
1770
  // verify the required parameter 'knowledgeBaseId' is set
@@ -1759,7 +1801,7 @@ class KnowledgeApi {
1759
1801
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1760
1802
  * @param {String} importId Import ID
1761
1803
  * @param {Object} body
1762
- * @deprecated
1804
+ * @deprecated
1763
1805
  */
1764
1806
  patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
1765
1807
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2072,6 +2114,68 @@ class KnowledgeApi {
2072
2114
  );
2073
2115
  }
2074
2116
 
2117
+ /**
2118
+ * Bulk remove documents.
2119
+ *
2120
+ * @param {String} knowledgeBaseId Knowledge base ID
2121
+ * @param {Object} body
2122
+ * Preview Endpoint
2123
+ */
2124
+ postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
2125
+ // verify the required parameter 'knowledgeBaseId' is set
2126
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
2127
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';
2128
+ }
2129
+ // verify the required parameter 'body' is set
2130
+ if (body === undefined || body === null) {
2131
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';
2132
+ }
2133
+
2134
+ return this.apiClient.callApi(
2135
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove',
2136
+ 'POST',
2137
+ { 'knowledgeBaseId': knowledgeBaseId },
2138
+ { },
2139
+ { },
2140
+ { },
2141
+ body,
2142
+ ['PureCloud OAuth'],
2143
+ ['application/json'],
2144
+ ['application/json']
2145
+ );
2146
+ }
2147
+
2148
+ /**
2149
+ * Bulk update documents.
2150
+ *
2151
+ * @param {String} knowledgeBaseId Knowledge base ID
2152
+ * @param {Object} body
2153
+ * Preview Endpoint
2154
+ */
2155
+ postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
2156
+ // verify the required parameter 'knowledgeBaseId' is set
2157
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
2158
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';
2159
+ }
2160
+ // verify the required parameter 'body' is set
2161
+ if (body === undefined || body === null) {
2162
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';
2163
+ }
2164
+
2165
+ return this.apiClient.callApi(
2166
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update',
2167
+ 'POST',
2168
+ { 'knowledgeBaseId': knowledgeBaseId },
2169
+ { },
2170
+ { },
2171
+ { },
2172
+ body,
2173
+ ['PureCloud OAuth'],
2174
+ ['application/json'],
2175
+ ['application/json']
2176
+ );
2177
+ }
2178
+
2075
2179
  /**
2076
2180
  * Search the documents in a knowledge base.
2077
2181
  *
@@ -2131,6 +2235,37 @@ class KnowledgeApi {
2131
2235
  );
2132
2236
  }
2133
2237
 
2238
+ /**
2239
+ * Bulk add document versions.
2240
+ *
2241
+ * @param {String} knowledgeBaseId Knowledge base ID
2242
+ * @param {Object} body
2243
+ * Preview Endpoint
2244
+ */
2245
+ postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
2246
+ // verify the required parameter 'knowledgeBaseId' is set
2247
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
2248
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';
2249
+ }
2250
+ // verify the required parameter 'body' is set
2251
+ if (body === undefined || body === null) {
2252
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';
2253
+ }
2254
+
2255
+ return this.apiClient.callApi(
2256
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add',
2257
+ 'POST',
2258
+ { 'knowledgeBaseId': knowledgeBaseId },
2259
+ { },
2260
+ { },
2261
+ { },
2262
+ body,
2263
+ ['PureCloud OAuth'],
2264
+ ['application/json'],
2265
+ ['application/json']
2266
+ );
2267
+ }
2268
+
2134
2269
  /**
2135
2270
  * Create export job
2136
2271
  *
@@ -2227,7 +2362,7 @@ class KnowledgeApi {
2227
2362
  * @param {String} knowledgeBaseId Knowledge base ID
2228
2363
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2229
2364
  * @param {Object} body
2230
- * @deprecated
2365
+ * @deprecated
2231
2366
  */
2232
2367
  postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
2233
2368
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2257,13 +2392,55 @@ class KnowledgeApi {
2257
2392
  );
2258
2393
  }
2259
2394
 
2395
+ /**
2396
+ * Upload Article Content
2397
+ *
2398
+ * @param {String} documentId Document ID
2399
+ * @param {String} knowledgeBaseId Knowledge base ID
2400
+ * @param {Object} languageCode Language code, format: iso2-LOCALE
2401
+ * @param {Object} body
2402
+ * @deprecated
2403
+ * Preview Endpoint
2404
+ */
2405
+ postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
2406
+ // verify the required parameter 'documentId' is set
2407
+ if (documentId === undefined || documentId === null) {
2408
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
2409
+ }
2410
+ // verify the required parameter 'knowledgeBaseId' is set
2411
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
2412
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
2413
+ }
2414
+ // verify the required parameter 'languageCode' is set
2415
+ if (languageCode === undefined || languageCode === null) {
2416
+ throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
2417
+ }
2418
+ // verify the required parameter 'body' is set
2419
+ if (body === undefined || body === null) {
2420
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
2421
+ }
2422
+
2423
+ return this.apiClient.callApi(
2424
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads',
2425
+ 'POST',
2426
+ { 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
2427
+ { },
2428
+ { },
2429
+ { },
2430
+ body,
2431
+ ['PureCloud OAuth'],
2432
+ ['application/json'],
2433
+ ['application/json']
2434
+ );
2435
+ }
2436
+
2260
2437
  /**
2261
2438
  * Create document
2262
2439
  *
2263
2440
  * @param {String} knowledgeBaseId Knowledge base ID
2264
2441
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2265
2442
  * @param {Object} body
2266
- * @deprecated
2443
+ * @deprecated
2267
2444
  */
2268
2445
  postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
2269
2446
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2299,7 +2476,7 @@ class KnowledgeApi {
2299
2476
  * @param {String} knowledgeBaseId Knowledge base ID
2300
2477
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2301
2478
  * @param {Object} body
2302
- * @deprecated
2479
+ * @deprecated
2303
2480
  */
2304
2481
  postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
2305
2482
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2335,7 +2512,7 @@ class KnowledgeApi {
2335
2512
  * @param {String} knowledgeBaseId Knowledge base ID
2336
2513
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2337
2514
  * @param {String} trainingId Training ID
2338
- * @deprecated
2515
+ * @deprecated
2339
2516
  */
2340
2517
  postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
2341
2518
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2370,7 +2547,7 @@ class KnowledgeApi {
2370
2547
  *
2371
2548
  * @param {String} knowledgeBaseId Knowledge base ID
2372
2549
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2373
- * @deprecated
2550
+ * @deprecated
2374
2551
  */
2375
2552
  postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
2376
2553
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2402,7 +2579,7 @@ class KnowledgeApi {
2402
2579
  * @param {String} knowledgeBaseId Knowledge base ID
2403
2580
  * @param {Object} opts Optional parameters
2404
2581
  * @param {Object} opts.body
2405
- * @deprecated
2582
+ * @deprecated
2406
2583
  */
2407
2584
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
2408
2585
  opts = opts || {};