purecloud-platform-client-v2 144.0.0 → 147.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 (74) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +2337 -305
  3. package/dist/web-amd/purecloud-platform-client-v2.js +2337 -305
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +2337 -305
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +2337 -305
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1133 -49
  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 +46 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +211 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1779 -246
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +135 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +31 -1
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +21 -1
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UsersApi.js +32 -2
  67. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +30 -1
  71. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
399
399
 
400
400
  /**
401
401
  * @module purecloud-platform-client-v2/ApiClient
402
- * @version 144.0.0
402
+ * @version 147.0.0
403
403
  */
404
404
  class ApiClient {
405
405
  /**
@@ -1478,7 +1478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1478
1478
  /**
1479
1479
  * Alerting service.
1480
1480
  * @module purecloud-platform-client-v2/api/AlertingApi
1481
- * @version 144.0.0
1481
+ * @version 147.0.0
1482
1482
  */
1483
1483
 
1484
1484
  /**
@@ -1792,7 +1792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1792
1792
  /**
1793
1793
  * Analytics service.
1794
1794
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1795
- * @version 144.0.0
1795
+ * @version 147.0.0
1796
1796
  */
1797
1797
 
1798
1798
  /**
@@ -2038,6 +2038,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2038
2038
  );
2039
2039
  }
2040
2040
 
2041
+ /**
2042
+ * Get analytics data retention setting
2043
+ *
2044
+ */
2045
+ getAnalyticsDataretentionSettings() {
2046
+
2047
+ return this.apiClient.callApi(
2048
+ '/api/v2/analytics/dataretention/settings',
2049
+ 'GET',
2050
+ { },
2051
+ { },
2052
+ { },
2053
+ { },
2054
+ null,
2055
+ ['PureCloud OAuth'],
2056
+ ['application/json'],
2057
+ ['application/json']
2058
+ );
2059
+ }
2060
+
2041
2061
  /**
2042
2062
  * Get all view export requests for a user
2043
2063
  *
@@ -2938,6 +2958,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2938
2958
  );
2939
2959
  }
2940
2960
 
2961
+ /**
2962
+ * Update analytics data retention setting
2963
+ *
2964
+ * @param {Object} body retentionDays
2965
+ */
2966
+ putAnalyticsDataretentionSettings(body) {
2967
+ // verify the required parameter 'body' is set
2968
+ if (body === undefined || body === null) {
2969
+ throw 'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';
2970
+ }
2971
+
2972
+ return this.apiClient.callApi(
2973
+ '/api/v2/analytics/dataretention/settings',
2974
+ 'PUT',
2975
+ { },
2976
+ { },
2977
+ { },
2978
+ { },
2979
+ body,
2980
+ ['PureCloud OAuth'],
2981
+ ['application/json'],
2982
+ ['application/json']
2983
+ );
2984
+ }
2985
+
2941
2986
  /**
2942
2987
  * Update a scheduled report job.
2943
2988
  *
@@ -2974,7 +3019,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2974
3019
  /**
2975
3020
  * Architect service.
2976
3021
  * @module purecloud-platform-client-v2/api/ArchitectApi
2977
- * @version 144.0.0
3022
+ * @version 147.0.0
2978
3023
  */
2979
3024
 
2980
3025
  /**
@@ -3732,6 +3777,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3732
3777
  * @param {String} opts.sortBy Sort by (default to name)
3733
3778
  * @param {String} opts.sortOrder Sort order (default to ASC)
3734
3779
  * @param {String} opts.name Name of the IVR to filter by.
3780
+ * @param {String} opts.dnis The phone number of the IVR to filter by.
3735
3781
  */
3736
3782
  getArchitectIvrs(opts) {
3737
3783
  opts = opts || {};
@@ -3741,7 +3787,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3741
3787
  '/api/v2/architect/ivrs',
3742
3788
  'GET',
3743
3789
  { },
3744
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
3790
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
3745
3791
  { },
3746
3792
  { },
3747
3793
  null,
@@ -6019,7 +6065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6019
6065
  /**
6020
6066
  * Audit service.
6021
6067
  * @module purecloud-platform-client-v2/api/AuditApi
6022
- * @version 144.0.0
6068
+ * @version 147.0.0
6023
6069
  */
6024
6070
 
6025
6071
  /**
@@ -6190,7 +6236,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6190
6236
  /**
6191
6237
  * Authorization service.
6192
6238
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6193
- * @version 144.0.0
6239
+ * @version 147.0.0
6194
6240
  */
6195
6241
 
6196
6242
  /**
@@ -7373,7 +7419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7373
7419
  /**
7374
7420
  * Billing service.
7375
7421
  * @module purecloud-platform-client-v2/api/BillingApi
7376
- * @version 144.0.0
7422
+ * @version 147.0.0
7377
7423
  */
7378
7424
 
7379
7425
  /**
@@ -7453,7 +7499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7453
7499
  /**
7454
7500
  * Chat service.
7455
7501
  * @module purecloud-platform-client-v2/api/ChatApi
7456
- * @version 144.0.0
7502
+ * @version 147.0.0
7457
7503
  */
7458
7504
 
7459
7505
  /**
@@ -7544,7 +7590,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7544
7590
  /**
7545
7591
  * Coaching service.
7546
7592
  * @module purecloud-platform-client-v2/api/CoachingApi
7547
- * @version 144.0.0
7593
+ * @version 147.0.0
7548
7594
  */
7549
7595
 
7550
7596
  /**
@@ -8121,7 +8167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8121
8167
  /**
8122
8168
  * ContentManagement service.
8123
8169
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8124
- * @version 144.0.0
8170
+ * @version 147.0.0
8125
8171
  */
8126
8172
 
8127
8173
  /**
@@ -9261,7 +9307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9261
9307
  /**
9262
9308
  * Conversations service.
9263
9309
  * @module purecloud-platform-client-v2/api/ConversationsApi
9264
- * @version 144.0.0
9310
+ * @version 147.0.0
9265
9311
  */
9266
9312
 
9267
9313
  /**
@@ -9854,6 +9900,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9854
9900
  );
9855
9901
  }
9856
9902
 
9903
+ /**
9904
+ * Get the secure attributes on a conversation.
9905
+ *
9906
+ * @param {String} conversationId conversation ID
9907
+ */
9908
+ getConversationSecureattributes(conversationId) {
9909
+ // verify the required parameter 'conversationId' is set
9910
+ if (conversationId === undefined || conversationId === null) {
9911
+ throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
9912
+ }
9913
+
9914
+ return this.apiClient.callApi(
9915
+ '/api/v2/conversations/{conversationId}/secureattributes',
9916
+ 'GET',
9917
+ { 'conversationId': conversationId },
9918
+ { },
9919
+ { },
9920
+ { },
9921
+ null,
9922
+ ['PureCloud OAuth'],
9923
+ ['application/json'],
9924
+ ['application/json']
9925
+ );
9926
+ }
9927
+
9857
9928
  /**
9858
9929
  * Get active conversations for the logged in user
9859
9930
  *
@@ -10637,6 +10708,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10637
10708
  );
10638
10709
  }
10639
10710
 
10711
+ /**
10712
+ * Get the encryption key configurations
10713
+ *
10714
+ * @param {String} keyconfigurationsId Key Configurations Id
10715
+ */
10716
+ getConversationsKeyconfiguration(keyconfigurationsId) {
10717
+ // verify the required parameter 'keyconfigurationsId' is set
10718
+ if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
10719
+ throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
10720
+ }
10721
+
10722
+ return this.apiClient.callApi(
10723
+ '/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
10724
+ 'GET',
10725
+ { 'keyconfigurationsId': keyconfigurationsId },
10726
+ { },
10727
+ { },
10728
+ { },
10729
+ null,
10730
+ ['PureCloud OAuth'],
10731
+ ['application/json'],
10732
+ ['application/json']
10733
+ );
10734
+ }
10735
+
10736
+ /**
10737
+ * Get a list of key configurations data
10738
+ *
10739
+ */
10740
+ getConversationsKeyconfigurations() {
10741
+
10742
+ return this.apiClient.callApi(
10743
+ '/api/v2/conversations/keyconfigurations',
10744
+ 'GET',
10745
+ { },
10746
+ { },
10747
+ { },
10748
+ { },
10749
+ null,
10750
+ ['PureCloud OAuth'],
10751
+ ['application/json'],
10752
+ ['application/json']
10753
+ );
10754
+ }
10755
+
10640
10756
  /**
10641
10757
  * Get message conversation
10642
10758
  *
@@ -11353,6 +11469,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11353
11469
  );
11354
11470
  }
11355
11471
 
11472
+ /**
11473
+ * Update the secure attributes on a conversation.
11474
+ *
11475
+ * @param {String} conversationId conversation ID
11476
+ * @param {Object} body Conversation Secure Attributes
11477
+ */
11478
+ patchConversationSecureattributes(conversationId, body) {
11479
+ // verify the required parameter 'conversationId' is set
11480
+ if (conversationId === undefined || conversationId === null) {
11481
+ throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
11482
+ }
11483
+ // verify the required parameter 'body' is set
11484
+ if (body === undefined || body === null) {
11485
+ throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
11486
+ }
11487
+
11488
+ return this.apiClient.callApi(
11489
+ '/api/v2/conversations/{conversationId}/secureattributes',
11490
+ 'PATCH',
11491
+ { 'conversationId': conversationId },
11492
+ { },
11493
+ { },
11494
+ { },
11495
+ body,
11496
+ ['PureCloud OAuth'],
11497
+ ['application/json'],
11498
+ ['application/json']
11499
+ );
11500
+ }
11501
+
11356
11502
  /**
11357
11503
  * Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
11358
11504
  *
@@ -13355,6 +13501,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13355
13501
  );
13356
13502
  }
13357
13503
 
13504
+ /**
13505
+ * Setup configurations for encryption key creation
13506
+ *
13507
+ * @param {Object} body Encryption Configuration
13508
+ */
13509
+ postConversationsKeyconfigurations(body) {
13510
+ // verify the required parameter 'body' is set
13511
+ if (body === undefined || body === null) {
13512
+ throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
13513
+ }
13514
+
13515
+ return this.apiClient.callApi(
13516
+ '/api/v2/conversations/keyconfigurations',
13517
+ 'POST',
13518
+ { },
13519
+ { },
13520
+ { },
13521
+ { },
13522
+ body,
13523
+ ['PureCloud OAuth'],
13524
+ ['application/json'],
13525
+ ['application/json']
13526
+ );
13527
+ }
13528
+
13529
+ /**
13530
+ * Validate encryption key configurations without saving it
13531
+ *
13532
+ * @param {Object} body Encryption Configuration
13533
+ */
13534
+ postConversationsKeyconfigurationsValidate(body) {
13535
+ // verify the required parameter 'body' is set
13536
+ if (body === undefined || body === null) {
13537
+ throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
13538
+ }
13539
+
13540
+ return this.apiClient.callApi(
13541
+ '/api/v2/conversations/keyconfigurations/validate',
13542
+ 'POST',
13543
+ { },
13544
+ { },
13545
+ { },
13546
+ { },
13547
+ body,
13548
+ ['PureCloud OAuth'],
13549
+ ['application/json'],
13550
+ ['application/json']
13551
+ );
13552
+ }
13553
+
13358
13554
  /**
13359
13555
  * Send message
13360
13556
  * 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.
@@ -13739,6 +13935,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13739
13935
  );
13740
13936
  }
13741
13937
 
13938
+ /**
13939
+ * Set the secure attributes on a conversation.
13940
+ *
13941
+ * @param {String} conversationId conversation ID
13942
+ * @param {Object} body Conversation Secure Attributes
13943
+ */
13944
+ putConversationSecureattributes(conversationId, body) {
13945
+ // verify the required parameter 'conversationId' is set
13946
+ if (conversationId === undefined || conversationId === null) {
13947
+ throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
13948
+ }
13949
+ // verify the required parameter 'body' is set
13950
+ if (body === undefined || body === null) {
13951
+ throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
13952
+ }
13953
+
13954
+ return this.apiClient.callApi(
13955
+ '/api/v2/conversations/{conversationId}/secureattributes',
13956
+ 'PUT',
13957
+ { 'conversationId': conversationId },
13958
+ { },
13959
+ { },
13960
+ { },
13961
+ body,
13962
+ ['PureCloud OAuth'],
13963
+ ['application/json'],
13964
+ ['application/json']
13965
+ );
13966
+ }
13967
+
13742
13968
  /**
13743
13969
  * Update the tags on a conversation.
13744
13970
  *
@@ -13989,6 +14215,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13989
14215
  );
13990
14216
  }
13991
14217
 
14218
+ /**
14219
+ * Update the encryption key configurations
14220
+ *
14221
+ * @param {String} keyconfigurationsId Key Configurations Id
14222
+ * @param {Object} body Encryption key configuration metadata
14223
+ */
14224
+ putConversationsKeyconfiguration(keyconfigurationsId, body) {
14225
+ // verify the required parameter 'keyconfigurationsId' is set
14226
+ if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
14227
+ throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
14228
+ }
14229
+ // verify the required parameter 'body' is set
14230
+ if (body === undefined || body === null) {
14231
+ throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
14232
+ }
14233
+
14234
+ return this.apiClient.callApi(
14235
+ '/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
14236
+ 'PUT',
14237
+ { 'keyconfigurationsId': keyconfigurationsId },
14238
+ { },
14239
+ { },
14240
+ { },
14241
+ body,
14242
+ ['PureCloud OAuth'],
14243
+ ['application/json'],
14244
+ ['application/json']
14245
+ );
14246
+ }
14247
+
13992
14248
  /**
13993
14249
  * Update a conversation by setting its recording state
13994
14250
  *
@@ -14195,7 +14451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14195
14451
  /**
14196
14452
  * DataExtensions service.
14197
14453
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
14198
- * @version 144.0.0
14454
+ * @version 147.0.0
14199
14455
  */
14200
14456
 
14201
14457
  /**
@@ -14281,7 +14537,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14281
14537
  /**
14282
14538
  * ExternalContacts service.
14283
14539
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
14284
- * @version 144.0.0
14540
+ * @version 147.0.0
14285
14541
  */
14286
14542
 
14287
14543
  /**
@@ -16024,7 +16280,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16024
16280
  /**
16025
16281
  * Fax service.
16026
16282
  * @module purecloud-platform-client-v2/api/FaxApi
16027
- * @version 144.0.0
16283
+ * @version 147.0.0
16028
16284
  */
16029
16285
 
16030
16286
  /**
@@ -16195,7 +16451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16195
16451
  /**
16196
16452
  * Flows service.
16197
16453
  * @module purecloud-platform-client-v2/api/FlowsApi
16198
- * @version 144.0.0
16454
+ * @version 147.0.0
16199
16455
  */
16200
16456
 
16201
16457
  /**
@@ -16266,7 +16522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16266
16522
  /**
16267
16523
  * Gamification service.
16268
16524
  * @module purecloud-platform-client-v2/api/GamificationApi
16269
- * @version 144.0.0
16525
+ * @version 147.0.0
16270
16526
  */
16271
16527
 
16272
16528
  /**
@@ -17997,7 +18253,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17997
18253
  /**
17998
18254
  * GeneralDataProtectionRegulation service.
17999
18255
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
18000
- * @version 144.0.0
18256
+ * @version 147.0.0
18001
18257
  */
18002
18258
 
18003
18259
  /**
@@ -18127,7 +18383,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18127
18383
  /**
18128
18384
  * Geolocation service.
18129
18385
  * @module purecloud-platform-client-v2/api/GeolocationApi
18130
- * @version 144.0.0
18386
+ * @version 147.0.0
18131
18387
  */
18132
18388
 
18133
18389
  /**
@@ -18258,7 +18514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18258
18514
  /**
18259
18515
  * Greetings service.
18260
18516
  * @module purecloud-platform-client-v2/api/GreetingsApi
18261
- * @version 144.0.0
18517
+ * @version 147.0.0
18262
18518
  */
18263
18519
 
18264
18520
  /**
@@ -18713,7 +18969,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18713
18969
  /**
18714
18970
  * Groups service.
18715
18971
  * @module purecloud-platform-client-v2/api/GroupsApi
18716
- * @version 144.0.0
18972
+ * @version 147.0.0
18717
18973
  */
18718
18974
 
18719
18975
  /**
@@ -19118,7 +19374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19118
19374
  /**
19119
19375
  * IdentityProvider service.
19120
19376
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
19121
- * @version 144.0.0
19377
+ * @version 147.0.0
19122
19378
  */
19123
19379
 
19124
19380
  /**
@@ -19874,7 +20130,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19874
20130
  /**
19875
20131
  * Integrations service.
19876
20132
  * @module purecloud-platform-client-v2/api/IntegrationsApi
19877
- * @version 144.0.0
20133
+ * @version 147.0.0
19878
20134
  */
19879
20135
 
19880
20136
  /**
@@ -21551,7 +21807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21551
21807
  /**
21552
21808
  * Journey service.
21553
21809
  * @module purecloud-platform-client-v2/api/JourneyApi
21554
- * @version 144.0.0
21810
+ * @version 147.0.0
21555
21811
  */
21556
21812
 
21557
21813
  /**
@@ -22262,7 +22518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22262
22518
  /**
22263
22519
  * Knowledge service.
22264
22520
  * @module purecloud-platform-client-v2/api/KnowledgeApi
22265
- * @version 144.0.0
22521
+ * @version 147.0.0
22266
22522
  */
22267
22523
 
22268
22524
  /**
@@ -22302,6 +22558,191 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22302
22558
  );
22303
22559
  }
22304
22560
 
22561
+ /**
22562
+ * Delete category
22563
+ *
22564
+ * @param {String} knowledgeBaseId Knowledge base ID
22565
+ * @param {String} categoryId Category ID
22566
+ */
22567
+ deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
22568
+ // verify the required parameter 'knowledgeBaseId' is set
22569
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22570
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
22571
+ }
22572
+ // verify the required parameter 'categoryId' is set
22573
+ if (categoryId === undefined || categoryId === null) {
22574
+ throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
22575
+ }
22576
+
22577
+ return this.apiClient.callApi(
22578
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
22579
+ 'DELETE',
22580
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
22581
+ { },
22582
+ { },
22583
+ { },
22584
+ null,
22585
+ ['PureCloud OAuth'],
22586
+ ['application/json'],
22587
+ ['application/json']
22588
+ );
22589
+ }
22590
+
22591
+ /**
22592
+ * Delete document.
22593
+ *
22594
+ * @param {String} knowledgeBaseId Knowledge base ID.
22595
+ * @param {String} documentId Document ID.
22596
+ */
22597
+ deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
22598
+ // verify the required parameter 'knowledgeBaseId' is set
22599
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22600
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
22601
+ }
22602
+ // verify the required parameter 'documentId' is set
22603
+ if (documentId === undefined || documentId === null) {
22604
+ throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
22605
+ }
22606
+
22607
+ return this.apiClient.callApi(
22608
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
22609
+ 'DELETE',
22610
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
22611
+ { },
22612
+ { },
22613
+ { },
22614
+ null,
22615
+ ['PureCloud OAuth'],
22616
+ ['application/json'],
22617
+ ['application/json']
22618
+ );
22619
+ }
22620
+
22621
+ /**
22622
+ * Delete a variation for a document.
22623
+ *
22624
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
22625
+ * @param {String} documentId Globally unique identifier for a document.
22626
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
22627
+ */
22628
+ deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
22629
+ // verify the required parameter 'documentVariationId' is set
22630
+ if (documentVariationId === undefined || documentVariationId === null) {
22631
+ throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
22632
+ }
22633
+ // verify the required parameter 'documentId' is set
22634
+ if (documentId === undefined || documentId === null) {
22635
+ throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
22636
+ }
22637
+ // verify the required parameter 'knowledgeBaseId' is set
22638
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22639
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
22640
+ }
22641
+
22642
+ return this.apiClient.callApi(
22643
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
22644
+ 'DELETE',
22645
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
22646
+ { },
22647
+ { },
22648
+ { },
22649
+ null,
22650
+ ['PureCloud OAuth'],
22651
+ ['application/json'],
22652
+ ['application/json']
22653
+ );
22654
+ }
22655
+
22656
+ /**
22657
+ * Delete export job
22658
+ *
22659
+ * @param {String} knowledgeBaseId Knowledge base ID
22660
+ * @param {String} exportJobId Export job ID
22661
+ */
22662
+ deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
22663
+ // verify the required parameter 'knowledgeBaseId' is set
22664
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22665
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
22666
+ }
22667
+ // verify the required parameter 'exportJobId' is set
22668
+ if (exportJobId === undefined || exportJobId === null) {
22669
+ throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
22670
+ }
22671
+
22672
+ return this.apiClient.callApi(
22673
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
22674
+ 'DELETE',
22675
+ { 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
22676
+ { },
22677
+ { },
22678
+ { },
22679
+ null,
22680
+ ['PureCloud OAuth'],
22681
+ ['application/json'],
22682
+ ['application/json']
22683
+ );
22684
+ }
22685
+
22686
+ /**
22687
+ * Delete import job
22688
+ *
22689
+ * @param {String} knowledgeBaseId Knowledge base ID
22690
+ * @param {String} importJobId Import job ID
22691
+ */
22692
+ deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
22693
+ // verify the required parameter 'knowledgeBaseId' is set
22694
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22695
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
22696
+ }
22697
+ // verify the required parameter 'importJobId' is set
22698
+ if (importJobId === undefined || importJobId === null) {
22699
+ throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
22700
+ }
22701
+
22702
+ return this.apiClient.callApi(
22703
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
22704
+ 'DELETE',
22705
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
22706
+ { },
22707
+ { },
22708
+ { },
22709
+ null,
22710
+ ['PureCloud OAuth'],
22711
+ ['application/json'],
22712
+ ['application/json']
22713
+ );
22714
+ }
22715
+
22716
+ /**
22717
+ * Delete label
22718
+ *
22719
+ * @param {String} knowledgeBaseId Knowledge base ID
22720
+ * @param {String} labelId Label ID
22721
+ */
22722
+ deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
22723
+ // verify the required parameter 'knowledgeBaseId' is set
22724
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22725
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
22726
+ }
22727
+ // verify the required parameter 'labelId' is set
22728
+ if (labelId === undefined || labelId === null) {
22729
+ throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
22730
+ }
22731
+
22732
+ return this.apiClient.callApi(
22733
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
22734
+ 'DELETE',
22735
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
22736
+ { },
22737
+ { },
22738
+ { },
22739
+ null,
22740
+ ['PureCloud OAuth'],
22741
+ ['application/json'],
22742
+ ['application/json']
22743
+ );
22744
+ }
22745
+
22305
22746
  /**
22306
22747
  * Delete category
22307
22748
  *
@@ -22407,6 +22848,104 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22407
22848
  );
22408
22849
  }
22409
22850
 
22851
+ /**
22852
+ * Get categories
22853
+ *
22854
+ * @param {String} sessionId Knowledge guest session ID.
22855
+ * @param {Object} opts Optional parameters
22856
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
22857
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22858
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22859
+ * @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
22860
+ * @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
22861
+ * @param {String} opts.name Filter to return the categories that starts with the given category name.
22862
+ * @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
22863
+ * @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.
22864
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
22865
+ */
22866
+ getKnowledgeGuestSessionCategories(sessionId, opts) {
22867
+ opts = opts || {};
22868
+
22869
+ // verify the required parameter 'sessionId' is set
22870
+ if (sessionId === undefined || sessionId === null) {
22871
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
22872
+ }
22873
+
22874
+ return this.apiClient.callApi(
22875
+ '/api/v2/knowledge/guest/sessions/{sessionId}/categories',
22876
+ 'GET',
22877
+ { 'sessionId': sessionId },
22878
+ { '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'] },
22879
+ { },
22880
+ { },
22881
+ null,
22882
+ ['PureCloud OAuth'],
22883
+ ['application/json'],
22884
+ ['application/json']
22885
+ );
22886
+ }
22887
+
22888
+ /**
22889
+ * Get a knowledge document by ID.
22890
+ *
22891
+ * @param {String} sessionId Knowledge guest session ID.
22892
+ * @param {String} documentId Document ID
22893
+ */
22894
+ getKnowledgeGuestSessionDocument(sessionId, documentId) {
22895
+ // verify the required parameter 'sessionId' is set
22896
+ if (sessionId === undefined || sessionId === null) {
22897
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
22898
+ }
22899
+ // verify the required parameter 'documentId' is set
22900
+ if (documentId === undefined || documentId === null) {
22901
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
22902
+ }
22903
+
22904
+ return this.apiClient.callApi(
22905
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
22906
+ 'GET',
22907
+ { 'sessionId': sessionId,'documentId': documentId },
22908
+ { },
22909
+ { },
22910
+ { },
22911
+ null,
22912
+ ['PureCloud OAuth'],
22913
+ ['application/json'],
22914
+ ['application/json']
22915
+ );
22916
+ }
22917
+
22918
+ /**
22919
+ * Get documents.
22920
+ *
22921
+ * @param {String} sessionId Knowledge guest session ID.
22922
+ * @param {Object} opts Optional parameters
22923
+ * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
22924
+ * @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
22925
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22926
+ */
22927
+ getKnowledgeGuestSessionDocuments(sessionId, opts) {
22928
+ opts = opts || {};
22929
+
22930
+ // verify the required parameter 'sessionId' is set
22931
+ if (sessionId === undefined || sessionId === null) {
22932
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
22933
+ }
22934
+
22935
+ return this.apiClient.callApi(
22936
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents',
22937
+ 'GET',
22938
+ { 'sessionId': sessionId },
22939
+ { 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
22940
+ { },
22941
+ { },
22942
+ null,
22943
+ ['PureCloud OAuth'],
22944
+ ['application/json'],
22945
+ ['application/json']
22946
+ );
22947
+ }
22948
+
22410
22949
  /**
22411
22950
  * Get knowledge base
22412
22951
  *
@@ -22432,6 +22971,502 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22432
22971
  );
22433
22972
  }
22434
22973
 
22974
+ /**
22975
+ * Get categories
22976
+ *
22977
+ * @param {String} knowledgeBaseId Knowledge base ID
22978
+ * @param {Object} opts Optional parameters
22979
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
22980
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22981
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22982
+ * @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
22983
+ * @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
22984
+ * @param {String} opts.name Filter to return the categories that starts with the given category name.
22985
+ * @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
22986
+ * @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.
22987
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
22988
+ */
22989
+ getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
22990
+ opts = opts || {};
22991
+
22992
+ // verify the required parameter 'knowledgeBaseId' is set
22993
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22994
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
22995
+ }
22996
+
22997
+ return this.apiClient.callApi(
22998
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
22999
+ 'GET',
23000
+ { 'knowledgeBaseId': knowledgeBaseId },
23001
+ { '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'] },
23002
+ { },
23003
+ { },
23004
+ null,
23005
+ ['PureCloud OAuth'],
23006
+ ['application/json'],
23007
+ ['application/json']
23008
+ );
23009
+ }
23010
+
23011
+ /**
23012
+ * Get category
23013
+ *
23014
+ * @param {String} knowledgeBaseId Knowledge base ID
23015
+ * @param {String} categoryId Category ID
23016
+ */
23017
+ getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
23018
+ // verify the required parameter 'knowledgeBaseId' is set
23019
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23020
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
23021
+ }
23022
+ // verify the required parameter 'categoryId' is set
23023
+ if (categoryId === undefined || categoryId === null) {
23024
+ throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
23025
+ }
23026
+
23027
+ return this.apiClient.callApi(
23028
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
23029
+ 'GET',
23030
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
23031
+ { },
23032
+ { },
23033
+ { },
23034
+ null,
23035
+ ['PureCloud OAuth'],
23036
+ ['application/json'],
23037
+ ['application/json']
23038
+ );
23039
+ }
23040
+
23041
+ /**
23042
+ * Get document.
23043
+ *
23044
+ * @param {String} knowledgeBaseId Knowledge base ID.
23045
+ * @param {String} documentId Document ID.
23046
+ * @param {Object} opts Optional parameters
23047
+ * @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.
23048
+ * @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.
23049
+ */
23050
+ getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
23051
+ opts = opts || {};
23052
+
23053
+ // verify the required parameter 'knowledgeBaseId' is set
23054
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23055
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
23056
+ }
23057
+ // verify the required parameter 'documentId' is set
23058
+ if (documentId === undefined || documentId === null) {
23059
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
23060
+ }
23061
+
23062
+ return this.apiClient.callApi(
23063
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
23064
+ 'GET',
23065
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
23066
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
23067
+ { },
23068
+ { },
23069
+ null,
23070
+ ['PureCloud OAuth'],
23071
+ ['application/json'],
23072
+ ['application/json']
23073
+ );
23074
+ }
23075
+
23076
+ /**
23077
+ * Get a variation for a document.
23078
+ *
23079
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
23080
+ * @param {String} documentId Globally unique identifier for a document.
23081
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
23082
+ * @param {Object} opts Optional parameters
23083
+ * @param {Object} opts.documentState The state of the document.
23084
+ */
23085
+ getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
23086
+ opts = opts || {};
23087
+
23088
+ // verify the required parameter 'documentVariationId' is set
23089
+ if (documentVariationId === undefined || documentVariationId === null) {
23090
+ throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
23091
+ }
23092
+ // verify the required parameter 'documentId' is set
23093
+ if (documentId === undefined || documentId === null) {
23094
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
23095
+ }
23096
+ // verify the required parameter 'knowledgeBaseId' is set
23097
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23098
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
23099
+ }
23100
+
23101
+ return this.apiClient.callApi(
23102
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
23103
+ 'GET',
23104
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
23105
+ { 'documentState': opts['documentState'] },
23106
+ { },
23107
+ { },
23108
+ null,
23109
+ ['PureCloud OAuth'],
23110
+ ['application/json'],
23111
+ ['application/json']
23112
+ );
23113
+ }
23114
+
23115
+ /**
23116
+ * Get variations for a document.
23117
+ *
23118
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23119
+ * @param {String} documentId Globally unique identifier for the document.
23120
+ * @param {Object} opts Optional parameters
23121
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23122
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23123
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23124
+ * @param {Object} opts.documentState The state of the document.
23125
+ */
23126
+ getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
23127
+ opts = opts || {};
23128
+
23129
+ // verify the required parameter 'knowledgeBaseId' is set
23130
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23131
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
23132
+ }
23133
+ // verify the required parameter 'documentId' is set
23134
+ if (documentId === undefined || documentId === null) {
23135
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
23136
+ }
23137
+
23138
+ return this.apiClient.callApi(
23139
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
23140
+ 'GET',
23141
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
23142
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
23143
+ { },
23144
+ { },
23145
+ null,
23146
+ ['PureCloud OAuth'],
23147
+ ['application/json'],
23148
+ ['application/json']
23149
+ );
23150
+ }
23151
+
23152
+ /**
23153
+ * Get document version.
23154
+ *
23155
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23156
+ * @param {String} documentId Globally unique identifier for the document.
23157
+ * @param {String} versionId Globally unique identifier for the document version.
23158
+ * @param {Object} opts Optional parameters
23159
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
23160
+ */
23161
+ getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
23162
+ opts = opts || {};
23163
+
23164
+ // verify the required parameter 'knowledgeBaseId' is set
23165
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23166
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
23167
+ }
23168
+ // verify the required parameter 'documentId' is set
23169
+ if (documentId === undefined || documentId === null) {
23170
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
23171
+ }
23172
+ // verify the required parameter 'versionId' is set
23173
+ if (versionId === undefined || versionId === null) {
23174
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
23175
+ }
23176
+
23177
+ return this.apiClient.callApi(
23178
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
23179
+ 'GET',
23180
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
23181
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
23182
+ { },
23183
+ { },
23184
+ null,
23185
+ ['PureCloud OAuth'],
23186
+ ['application/json'],
23187
+ ['application/json']
23188
+ );
23189
+ }
23190
+
23191
+ /**
23192
+ * Get variation for the given document version.
23193
+ *
23194
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23195
+ * @param {String} documentId Globally unique identifier for the document.
23196
+ * @param {String} versionId Globally unique identifier for the document version.
23197
+ * @param {String} variationId Globally unique identifier for the document version variation.
23198
+ */
23199
+ getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
23200
+ // verify the required parameter 'knowledgeBaseId' is set
23201
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23202
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
23203
+ }
23204
+ // verify the required parameter 'documentId' is set
23205
+ if (documentId === undefined || documentId === null) {
23206
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
23207
+ }
23208
+ // verify the required parameter 'versionId' is set
23209
+ if (versionId === undefined || versionId === null) {
23210
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
23211
+ }
23212
+ // verify the required parameter 'variationId' is set
23213
+ if (variationId === undefined || variationId === null) {
23214
+ throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
23215
+ }
23216
+
23217
+ return this.apiClient.callApi(
23218
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
23219
+ 'GET',
23220
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
23221
+ { },
23222
+ { },
23223
+ { },
23224
+ null,
23225
+ ['PureCloud OAuth'],
23226
+ ['application/json'],
23227
+ ['application/json']
23228
+ );
23229
+ }
23230
+
23231
+ /**
23232
+ * Get variations for the given document version.
23233
+ *
23234
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23235
+ * @param {String} documentId Globally unique identifier for the document.
23236
+ * @param {String} versionId Globally unique identifier for the document version.
23237
+ * @param {Object} opts Optional parameters
23238
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23239
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23240
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23241
+ */
23242
+ getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
23243
+ opts = opts || {};
23244
+
23245
+ // verify the required parameter 'knowledgeBaseId' is set
23246
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23247
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
23248
+ }
23249
+ // verify the required parameter 'documentId' is set
23250
+ if (documentId === undefined || documentId === null) {
23251
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
23252
+ }
23253
+ // verify the required parameter 'versionId' is set
23254
+ if (versionId === undefined || versionId === null) {
23255
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
23256
+ }
23257
+
23258
+ return this.apiClient.callApi(
23259
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
23260
+ 'GET',
23261
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
23262
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
23263
+ { },
23264
+ { },
23265
+ null,
23266
+ ['PureCloud OAuth'],
23267
+ ['application/json'],
23268
+ ['application/json']
23269
+ );
23270
+ }
23271
+
23272
+ /**
23273
+ * Get document versions.
23274
+ *
23275
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23276
+ * @param {String} documentId Globally unique identifier for the document.
23277
+ * @param {Object} opts Optional parameters
23278
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23279
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23280
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23281
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
23282
+ */
23283
+ getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
23284
+ opts = opts || {};
23285
+
23286
+ // verify the required parameter 'knowledgeBaseId' is set
23287
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23288
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
23289
+ }
23290
+ // verify the required parameter 'documentId' is set
23291
+ if (documentId === undefined || documentId === null) {
23292
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
23293
+ }
23294
+
23295
+ return this.apiClient.callApi(
23296
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
23297
+ 'GET',
23298
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
23299
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
23300
+ { },
23301
+ { },
23302
+ null,
23303
+ ['PureCloud OAuth'],
23304
+ ['application/json'],
23305
+ ['application/json']
23306
+ );
23307
+ }
23308
+
23309
+ /**
23310
+ * Get documents.
23311
+ *
23312
+ * @param {String} knowledgeBaseId Knowledge base ID
23313
+ * @param {Object} opts Optional parameters
23314
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23315
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23316
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23317
+ * @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
23318
+ * @param {Array.<String>} opts.documentId Retrieves the specified documents, comma separated values expected.
23319
+ * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
23320
+ * @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
23321
+ * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
23322
+ * @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
23323
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
23324
+ */
23325
+ getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
23326
+ opts = opts || {};
23327
+
23328
+ // verify the required parameter 'knowledgeBaseId' is set
23329
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23330
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
23331
+ }
23332
+
23333
+ return this.apiClient.callApi(
23334
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
23335
+ 'GET',
23336
+ { 'knowledgeBaseId': knowledgeBaseId },
23337
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'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') },
23338
+ { },
23339
+ { },
23340
+ null,
23341
+ ['PureCloud OAuth'],
23342
+ ['application/json'],
23343
+ ['application/json']
23344
+ );
23345
+ }
23346
+
23347
+ /**
23348
+ * Get export job report
23349
+ *
23350
+ * @param {String} knowledgeBaseId Knowledge base ID
23351
+ * @param {String} exportJobId Export job ID
23352
+ */
23353
+ getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
23354
+ // verify the required parameter 'knowledgeBaseId' is set
23355
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23356
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
23357
+ }
23358
+ // verify the required parameter 'exportJobId' is set
23359
+ if (exportJobId === undefined || exportJobId === null) {
23360
+ throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
23361
+ }
23362
+
23363
+ return this.apiClient.callApi(
23364
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
23365
+ 'GET',
23366
+ { 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
23367
+ { },
23368
+ { },
23369
+ { },
23370
+ null,
23371
+ ['PureCloud OAuth'],
23372
+ ['application/json'],
23373
+ ['application/json']
23374
+ );
23375
+ }
23376
+
23377
+ /**
23378
+ * Get import job report
23379
+ *
23380
+ * @param {String} knowledgeBaseId Knowledge base ID
23381
+ * @param {String} importJobId Import job ID
23382
+ */
23383
+ getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
23384
+ // verify the required parameter 'knowledgeBaseId' is set
23385
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23386
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
23387
+ }
23388
+ // verify the required parameter 'importJobId' is set
23389
+ if (importJobId === undefined || importJobId === null) {
23390
+ throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
23391
+ }
23392
+
23393
+ return this.apiClient.callApi(
23394
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
23395
+ 'GET',
23396
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
23397
+ { },
23398
+ { },
23399
+ { },
23400
+ null,
23401
+ ['PureCloud OAuth'],
23402
+ ['application/json'],
23403
+ ['application/json']
23404
+ );
23405
+ }
23406
+
23407
+ /**
23408
+ * Get label
23409
+ *
23410
+ * @param {String} knowledgeBaseId Knowledge base ID
23411
+ * @param {String} labelId Label ID
23412
+ */
23413
+ getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
23414
+ // verify the required parameter 'knowledgeBaseId' is set
23415
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23416
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
23417
+ }
23418
+ // verify the required parameter 'labelId' is set
23419
+ if (labelId === undefined || labelId === null) {
23420
+ throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
23421
+ }
23422
+
23423
+ return this.apiClient.callApi(
23424
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
23425
+ 'GET',
23426
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
23427
+ { },
23428
+ { },
23429
+ { },
23430
+ null,
23431
+ ['PureCloud OAuth'],
23432
+ ['application/json'],
23433
+ ['application/json']
23434
+ );
23435
+ }
23436
+
23437
+ /**
23438
+ * Get labels
23439
+ *
23440
+ * @param {String} knowledgeBaseId Knowledge base ID
23441
+ * @param {Object} opts Optional parameters
23442
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23443
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23444
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23445
+ * @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
23446
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
23447
+ */
23448
+ getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
23449
+ opts = opts || {};
23450
+
23451
+ // verify the required parameter 'knowledgeBaseId' is set
23452
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23453
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
23454
+ }
23455
+
23456
+ return this.apiClient.callApi(
23457
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
23458
+ 'GET',
23459
+ { 'knowledgeBaseId': knowledgeBaseId },
23460
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
23461
+ { },
23462
+ { },
23463
+ null,
23464
+ ['PureCloud OAuth'],
23465
+ ['application/json'],
23466
+ ['application/json']
23467
+ );
23468
+ }
23469
+
22435
23470
  /**
22436
23471
  * Get categories
22437
23472
  *
@@ -22690,6 +23725,108 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22690
23725
  );
22691
23726
  }
22692
23727
 
23728
+ /**
23729
+ * Get knowledge base unanswered group for a particular groupId
23730
+ *
23731
+ * @param {String} knowledgeBaseId Knowledge base ID
23732
+ * @param {String} groupId The ID of the group to be retrieved.
23733
+ * @param {Object} opts Optional parameters
23734
+ * @param {Object} opts.app The app value to be used for filtering phrases.
23735
+ */
23736
+ getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
23737
+ opts = opts || {};
23738
+
23739
+ // verify the required parameter 'knowledgeBaseId' is set
23740
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23741
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
23742
+ }
23743
+ // verify the required parameter 'groupId' is set
23744
+ if (groupId === undefined || groupId === null) {
23745
+ throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
23746
+ }
23747
+
23748
+ return this.apiClient.callApi(
23749
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
23750
+ 'GET',
23751
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
23752
+ { 'app': opts['app'] },
23753
+ { },
23754
+ { },
23755
+ null,
23756
+ ['PureCloud OAuth'],
23757
+ ['application/json'],
23758
+ ['application/json']
23759
+ );
23760
+ }
23761
+
23762
+ /**
23763
+ * Get knowledge base unanswered phrase group for a particular phraseGroupId
23764
+ *
23765
+ * @param {String} knowledgeBaseId Knowledge base ID
23766
+ * @param {String} groupId The ID of the group to be retrieved.
23767
+ * @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
23768
+ * @param {Object} opts Optional parameters
23769
+ * @param {Object} opts.app The app value to be used for filtering phrases.
23770
+ */
23771
+ getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
23772
+ opts = opts || {};
23773
+
23774
+ // verify the required parameter 'knowledgeBaseId' is set
23775
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23776
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
23777
+ }
23778
+ // verify the required parameter 'groupId' is set
23779
+ if (groupId === undefined || groupId === null) {
23780
+ throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
23781
+ }
23782
+ // verify the required parameter 'phraseGroupId' is set
23783
+ if (phraseGroupId === undefined || phraseGroupId === null) {
23784
+ throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
23785
+ }
23786
+
23787
+ return this.apiClient.callApi(
23788
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
23789
+ 'GET',
23790
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
23791
+ { 'app': opts['app'] },
23792
+ { },
23793
+ { },
23794
+ null,
23795
+ ['PureCloud OAuth'],
23796
+ ['application/json'],
23797
+ ['application/json']
23798
+ );
23799
+ }
23800
+
23801
+ /**
23802
+ * Get knowledge base unanswered groups
23803
+ *
23804
+ * @param {String} knowledgeBaseId Knowledge base ID
23805
+ * @param {Object} opts Optional parameters
23806
+ * @param {Object} opts.app The app value to be used for filtering phrases.
23807
+ */
23808
+ getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
23809
+ opts = opts || {};
23810
+
23811
+ // verify the required parameter 'knowledgeBaseId' is set
23812
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23813
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
23814
+ }
23815
+
23816
+ return this.apiClient.callApi(
23817
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
23818
+ 'GET',
23819
+ { 'knowledgeBaseId': knowledgeBaseId },
23820
+ { 'app': opts['app'] },
23821
+ { },
23822
+ { },
23823
+ null,
23824
+ ['PureCloud OAuth'],
23825
+ ['application/json'],
23826
+ ['application/json']
23827
+ );
23828
+ }
23829
+
22693
23830
  /**
22694
23831
  * Get knowledge bases
22695
23832
  *
@@ -22722,6 +23859,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22722
23859
  );
22723
23860
  }
22724
23861
 
23862
+ /**
23863
+ * Update search result.
23864
+ *
23865
+ * @param {String} sessionId Knowledge guest session ID.
23866
+ * @param {String} searchId Search Result ID
23867
+ * @param {Object} body
23868
+ */
23869
+ patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
23870
+ // verify the required parameter 'sessionId' is set
23871
+ if (sessionId === undefined || sessionId === null) {
23872
+ throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
23873
+ }
23874
+ // verify the required parameter 'searchId' is set
23875
+ if (searchId === undefined || searchId === null) {
23876
+ throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
23877
+ }
23878
+ // verify the required parameter 'body' is set
23879
+ if (body === undefined || body === null) {
23880
+ throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
23881
+ }
23882
+
23883
+ return this.apiClient.callApi(
23884
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
23885
+ 'PATCH',
23886
+ { 'sessionId': sessionId,'searchId': searchId },
23887
+ { },
23888
+ { },
23889
+ { },
23890
+ body,
23891
+ ['PureCloud OAuth'],
23892
+ ['application/json'],
23893
+ ['application/json']
23894
+ );
23895
+ }
23896
+
22725
23897
  /**
22726
23898
  * Update knowledge base
22727
23899
  *
@@ -22752,6 +23924,220 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22752
23924
  );
22753
23925
  }
22754
23926
 
23927
+ /**
23928
+ * Update category
23929
+ *
23930
+ * @param {String} knowledgeBaseId Knowledge base ID
23931
+ * @param {String} categoryId Category ID
23932
+ * @param {Object} body
23933
+ */
23934
+ patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
23935
+ // verify the required parameter 'knowledgeBaseId' is set
23936
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23937
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
23938
+ }
23939
+ // verify the required parameter 'categoryId' is set
23940
+ if (categoryId === undefined || categoryId === null) {
23941
+ throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
23942
+ }
23943
+ // verify the required parameter 'body' is set
23944
+ if (body === undefined || body === null) {
23945
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
23946
+ }
23947
+
23948
+ return this.apiClient.callApi(
23949
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
23950
+ 'PATCH',
23951
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
23952
+ { },
23953
+ { },
23954
+ { },
23955
+ body,
23956
+ ['PureCloud OAuth'],
23957
+ ['application/json'],
23958
+ ['application/json']
23959
+ );
23960
+ }
23961
+
23962
+ /**
23963
+ * Update document.
23964
+ *
23965
+ * @param {String} knowledgeBaseId Knowledge base ID.
23966
+ * @param {String} documentId Document ID.
23967
+ * @param {Object} body
23968
+ */
23969
+ patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
23970
+ // verify the required parameter 'knowledgeBaseId' is set
23971
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23972
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
23973
+ }
23974
+ // verify the required parameter 'documentId' is set
23975
+ if (documentId === undefined || documentId === null) {
23976
+ throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
23977
+ }
23978
+ // verify the required parameter 'body' is set
23979
+ if (body === undefined || body === null) {
23980
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
23981
+ }
23982
+
23983
+ return this.apiClient.callApi(
23984
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
23985
+ 'PATCH',
23986
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
23987
+ { },
23988
+ { },
23989
+ { },
23990
+ body,
23991
+ ['PureCloud OAuth'],
23992
+ ['application/json'],
23993
+ ['application/json']
23994
+ );
23995
+ }
23996
+
23997
+ /**
23998
+ * Update a variation for a document.
23999
+ *
24000
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
24001
+ * @param {String} documentId Globally unique identifier for a document.
24002
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
24003
+ * @param {Object} body
24004
+ */
24005
+ patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
24006
+ // verify the required parameter 'documentVariationId' is set
24007
+ if (documentVariationId === undefined || documentVariationId === null) {
24008
+ throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
24009
+ }
24010
+ // verify the required parameter 'documentId' is set
24011
+ if (documentId === undefined || documentId === null) {
24012
+ throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
24013
+ }
24014
+ // verify the required parameter 'knowledgeBaseId' is set
24015
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24016
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
24017
+ }
24018
+ // verify the required parameter 'body' is set
24019
+ if (body === undefined || body === null) {
24020
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
24021
+ }
24022
+
24023
+ return this.apiClient.callApi(
24024
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
24025
+ 'PATCH',
24026
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
24027
+ { },
24028
+ { },
24029
+ { },
24030
+ body,
24031
+ ['PureCloud OAuth'],
24032
+ ['application/json'],
24033
+ ['application/json']
24034
+ );
24035
+ }
24036
+
24037
+ /**
24038
+ * Update search result.
24039
+ *
24040
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
24041
+ * @param {String} searchId Search Result ID
24042
+ * @param {Object} opts Optional parameters
24043
+ * @param {Object} opts.body
24044
+ */
24045
+ patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
24046
+ opts = opts || {};
24047
+
24048
+ // verify the required parameter 'knowledgeBaseId' is set
24049
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24050
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
24051
+ }
24052
+ // verify the required parameter 'searchId' is set
24053
+ if (searchId === undefined || searchId === null) {
24054
+ throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
24055
+ }
24056
+
24057
+ return this.apiClient.callApi(
24058
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
24059
+ 'PATCH',
24060
+ { 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
24061
+ { },
24062
+ { },
24063
+ { },
24064
+ opts['body'],
24065
+ ['PureCloud OAuth'],
24066
+ ['application/json'],
24067
+ ['application/json']
24068
+ );
24069
+ }
24070
+
24071
+ /**
24072
+ * Start import job
24073
+ *
24074
+ * @param {String} knowledgeBaseId Knowledge base ID
24075
+ * @param {String} importJobId Import job ID
24076
+ * @param {Object} body
24077
+ */
24078
+ patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
24079
+ // verify the required parameter 'knowledgeBaseId' is set
24080
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24081
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
24082
+ }
24083
+ // verify the required parameter 'importJobId' is set
24084
+ if (importJobId === undefined || importJobId === null) {
24085
+ throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
24086
+ }
24087
+ // verify the required parameter 'body' is set
24088
+ if (body === undefined || body === null) {
24089
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
24090
+ }
24091
+
24092
+ return this.apiClient.callApi(
24093
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
24094
+ 'PATCH',
24095
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
24096
+ { },
24097
+ { },
24098
+ { },
24099
+ body,
24100
+ ['PureCloud OAuth'],
24101
+ ['application/json'],
24102
+ ['application/json']
24103
+ );
24104
+ }
24105
+
24106
+ /**
24107
+ * Update label
24108
+ *
24109
+ * @param {String} knowledgeBaseId Knowledge base ID
24110
+ * @param {String} labelId Label ID
24111
+ * @param {Object} body
24112
+ */
24113
+ patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
24114
+ // verify the required parameter 'knowledgeBaseId' is set
24115
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24116
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
24117
+ }
24118
+ // verify the required parameter 'labelId' is set
24119
+ if (labelId === undefined || labelId === null) {
24120
+ throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
24121
+ }
24122
+ // verify the required parameter 'body' is set
24123
+ if (body === undefined || body === null) {
24124
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
24125
+ }
24126
+
24127
+ return this.apiClient.callApi(
24128
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
24129
+ 'PATCH',
24130
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
24131
+ { },
24132
+ { },
24133
+ { },
24134
+ body,
24135
+ ['PureCloud OAuth'],
24136
+ ['application/json'],
24137
+ ['application/json']
24138
+ );
24139
+ }
24140
+
22755
24141
  /**
22756
24142
  * Update category
22757
24143
  *
@@ -22907,6 +24293,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22907
24293
  );
22908
24294
  }
22909
24295
 
24296
+ /**
24297
+ * Update a Knowledge base unanswered phrase group
24298
+ *
24299
+ * @param {String} knowledgeBaseId Knowledge base ID
24300
+ * @param {String} groupId The ID of the group to be updated.
24301
+ * @param {String} phraseGroupId The ID of the phraseGroup to be updated.
24302
+ * @param {Object} body Request body of the update unanswered group endpoint.
24303
+ */
24304
+ patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
24305
+ // verify the required parameter 'knowledgeBaseId' is set
24306
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24307
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
24308
+ }
24309
+ // verify the required parameter 'groupId' is set
24310
+ if (groupId === undefined || groupId === null) {
24311
+ throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
24312
+ }
24313
+ // verify the required parameter 'phraseGroupId' is set
24314
+ if (phraseGroupId === undefined || phraseGroupId === null) {
24315
+ throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
24316
+ }
24317
+ // verify the required parameter 'body' is set
24318
+ if (body === undefined || body === null) {
24319
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
24320
+ }
24321
+
24322
+ return this.apiClient.callApi(
24323
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
24324
+ 'PATCH',
24325
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
24326
+ { },
24327
+ { },
24328
+ { },
24329
+ body,
24330
+ ['PureCloud OAuth'],
24331
+ ['application/json'],
24332
+ ['application/json']
24333
+ );
24334
+ }
24335
+
22910
24336
  /**
22911
24337
  * Creates a presigned URL for uploading a knowledge import file with a set of documents
22912
24338
  *
@@ -22932,6 +24358,369 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22932
24358
  );
22933
24359
  }
22934
24360
 
24361
+ /**
24362
+ * Search the documents in a guest session.
24363
+ *
24364
+ * @param {String} sessionId Knowledge guest session ID.
24365
+ * @param {Object} opts Optional parameters
24366
+ * @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
24367
+ * @param {Object} opts.body
24368
+ */
24369
+ postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
24370
+ opts = opts || {};
24371
+
24372
+ // verify the required parameter 'sessionId' is set
24373
+ if (sessionId === undefined || sessionId === null) {
24374
+ throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
24375
+ }
24376
+
24377
+ return this.apiClient.callApi(
24378
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
24379
+ 'POST',
24380
+ { 'sessionId': sessionId },
24381
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
24382
+ { },
24383
+ { },
24384
+ opts['body'],
24385
+ ['PureCloud OAuth'],
24386
+ ['application/json'],
24387
+ ['application/json']
24388
+ );
24389
+ }
24390
+
24391
+ /**
24392
+ * Query the knowledge documents to provide suggestions for auto completion.
24393
+ *
24394
+ * @param {String} sessionId Knowledge guest session ID.
24395
+ * @param {Object} opts Optional parameters
24396
+ * @param {Object} opts.body
24397
+ */
24398
+ postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
24399
+ opts = opts || {};
24400
+
24401
+ // verify the required parameter 'sessionId' is set
24402
+ if (sessionId === undefined || sessionId === null) {
24403
+ throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
24404
+ }
24405
+
24406
+ return this.apiClient.callApi(
24407
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
24408
+ 'POST',
24409
+ { 'sessionId': sessionId },
24410
+ { },
24411
+ { },
24412
+ { },
24413
+ opts['body'],
24414
+ ['PureCloud OAuth'],
24415
+ ['application/json'],
24416
+ ['application/json']
24417
+ );
24418
+ }
24419
+
24420
+ /**
24421
+ * Create guest session
24422
+ *
24423
+ * @param {Object} body
24424
+ */
24425
+ postKnowledgeGuestSessions(body) {
24426
+ // verify the required parameter 'body' is set
24427
+ if (body === undefined || body === null) {
24428
+ throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
24429
+ }
24430
+
24431
+ return this.apiClient.callApi(
24432
+ '/api/v2/knowledge/guest/sessions',
24433
+ 'POST',
24434
+ { },
24435
+ { },
24436
+ { },
24437
+ { },
24438
+ body,
24439
+ ['PureCloud OAuth'],
24440
+ ['application/json'],
24441
+ ['application/json']
24442
+ );
24443
+ }
24444
+
24445
+ /**
24446
+ * Create new category
24447
+ *
24448
+ * @param {String} knowledgeBaseId Knowledge base ID
24449
+ * @param {Object} body
24450
+ */
24451
+ postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
24452
+ // verify the required parameter 'knowledgeBaseId' is set
24453
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24454
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
24455
+ }
24456
+ // verify the required parameter 'body' is set
24457
+ if (body === undefined || body === null) {
24458
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
24459
+ }
24460
+
24461
+ return this.apiClient.callApi(
24462
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
24463
+ 'POST',
24464
+ { 'knowledgeBaseId': knowledgeBaseId },
24465
+ { },
24466
+ { },
24467
+ { },
24468
+ body,
24469
+ ['PureCloud OAuth'],
24470
+ ['application/json'],
24471
+ ['application/json']
24472
+ );
24473
+ }
24474
+
24475
+ /**
24476
+ * Create a variation for a document.
24477
+ *
24478
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
24479
+ * @param {String} documentId Globally unique identifier for the document.
24480
+ * @param {Object} body
24481
+ */
24482
+ postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
24483
+ // verify the required parameter 'knowledgeBaseId' is set
24484
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24485
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
24486
+ }
24487
+ // verify the required parameter 'documentId' is set
24488
+ if (documentId === undefined || documentId === null) {
24489
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
24490
+ }
24491
+ // verify the required parameter 'body' is set
24492
+ if (body === undefined || body === null) {
24493
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
24494
+ }
24495
+
24496
+ return this.apiClient.callApi(
24497
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
24498
+ 'POST',
24499
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
24500
+ { },
24501
+ { },
24502
+ { },
24503
+ body,
24504
+ ['PureCloud OAuth'],
24505
+ ['application/json'],
24506
+ ['application/json']
24507
+ );
24508
+ }
24509
+
24510
+ /**
24511
+ * Creates or restores a document version.
24512
+ *
24513
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
24514
+ * @param {String} documentId Globally unique identifier for the document.
24515
+ * @param {Object} body
24516
+ */
24517
+ postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
24518
+ // verify the required parameter 'knowledgeBaseId' is set
24519
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24520
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
24521
+ }
24522
+ // verify the required parameter 'documentId' is set
24523
+ if (documentId === undefined || documentId === null) {
24524
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
24525
+ }
24526
+ // verify the required parameter 'body' is set
24527
+ if (body === undefined || body === null) {
24528
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
24529
+ }
24530
+
24531
+ return this.apiClient.callApi(
24532
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
24533
+ 'POST',
24534
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
24535
+ { },
24536
+ { },
24537
+ { },
24538
+ body,
24539
+ ['PureCloud OAuth'],
24540
+ ['application/json'],
24541
+ ['application/json']
24542
+ );
24543
+ }
24544
+
24545
+ /**
24546
+ * Create document.
24547
+ *
24548
+ * @param {String} knowledgeBaseId Knowledge base ID
24549
+ * @param {Object} body
24550
+ */
24551
+ postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
24552
+ // verify the required parameter 'knowledgeBaseId' is set
24553
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24554
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
24555
+ }
24556
+ // verify the required parameter 'body' is set
24557
+ if (body === undefined || body === null) {
24558
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
24559
+ }
24560
+
24561
+ return this.apiClient.callApi(
24562
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
24563
+ 'POST',
24564
+ { 'knowledgeBaseId': knowledgeBaseId },
24565
+ { },
24566
+ { },
24567
+ { },
24568
+ body,
24569
+ ['PureCloud OAuth'],
24570
+ ['application/json'],
24571
+ ['application/json']
24572
+ );
24573
+ }
24574
+
24575
+ /**
24576
+ * Search the documents in a knowledge base.
24577
+ *
24578
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
24579
+ * @param {Object} opts Optional parameters
24580
+ * @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
24581
+ * @param {Object} opts.body
24582
+ */
24583
+ postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
24584
+ opts = opts || {};
24585
+
24586
+ // verify the required parameter 'knowledgeBaseId' is set
24587
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24588
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
24589
+ }
24590
+
24591
+ return this.apiClient.callApi(
24592
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
24593
+ 'POST',
24594
+ { 'knowledgeBaseId': knowledgeBaseId },
24595
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
24596
+ { },
24597
+ { },
24598
+ opts['body'],
24599
+ ['PureCloud OAuth'],
24600
+ ['application/json'],
24601
+ ['application/json']
24602
+ );
24603
+ }
24604
+
24605
+ /**
24606
+ * Query the knowledge documents to provide suggestions for auto completion.
24607
+ *
24608
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
24609
+ * @param {Object} opts Optional parameters
24610
+ * @param {Object} opts.body
24611
+ */
24612
+ postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
24613
+ opts = opts || {};
24614
+
24615
+ // verify the required parameter 'knowledgeBaseId' is set
24616
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24617
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
24618
+ }
24619
+
24620
+ return this.apiClient.callApi(
24621
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
24622
+ 'POST',
24623
+ { 'knowledgeBaseId': knowledgeBaseId },
24624
+ { },
24625
+ { },
24626
+ { },
24627
+ opts['body'],
24628
+ ['PureCloud OAuth'],
24629
+ ['application/json'],
24630
+ ['application/json']
24631
+ );
24632
+ }
24633
+
24634
+ /**
24635
+ * Create export job
24636
+ *
24637
+ * @param {String} knowledgeBaseId Knowledge base ID
24638
+ * @param {Object} body
24639
+ */
24640
+ postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
24641
+ // verify the required parameter 'knowledgeBaseId' is set
24642
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24643
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
24644
+ }
24645
+ // verify the required parameter 'body' is set
24646
+ if (body === undefined || body === null) {
24647
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
24648
+ }
24649
+
24650
+ return this.apiClient.callApi(
24651
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
24652
+ 'POST',
24653
+ { 'knowledgeBaseId': knowledgeBaseId },
24654
+ { },
24655
+ { },
24656
+ { },
24657
+ body,
24658
+ ['PureCloud OAuth'],
24659
+ ['application/json'],
24660
+ ['application/json']
24661
+ );
24662
+ }
24663
+
24664
+ /**
24665
+ * Create import job
24666
+ *
24667
+ * @param {String} knowledgeBaseId Knowledge base ID
24668
+ * @param {Object} body
24669
+ */
24670
+ postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
24671
+ // verify the required parameter 'knowledgeBaseId' is set
24672
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24673
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
24674
+ }
24675
+ // verify the required parameter 'body' is set
24676
+ if (body === undefined || body === null) {
24677
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
24678
+ }
24679
+
24680
+ return this.apiClient.callApi(
24681
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
24682
+ 'POST',
24683
+ { 'knowledgeBaseId': knowledgeBaseId },
24684
+ { },
24685
+ { },
24686
+ { },
24687
+ body,
24688
+ ['PureCloud OAuth'],
24689
+ ['application/json'],
24690
+ ['application/json']
24691
+ );
24692
+ }
24693
+
24694
+ /**
24695
+ * Create new label
24696
+ *
24697
+ * @param {String} knowledgeBaseId Knowledge base ID
24698
+ * @param {Object} body
24699
+ */
24700
+ postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
24701
+ // verify the required parameter 'knowledgeBaseId' is set
24702
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24703
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
24704
+ }
24705
+ // verify the required parameter 'body' is set
24706
+ if (body === undefined || body === null) {
24707
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
24708
+ }
24709
+
24710
+ return this.apiClient.callApi(
24711
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
24712
+ 'POST',
24713
+ { 'knowledgeBaseId': knowledgeBaseId },
24714
+ { },
24715
+ { },
24716
+ { },
24717
+ body,
24718
+ ['PureCloud OAuth'],
24719
+ ['application/json'],
24720
+ ['application/json']
24721
+ );
24722
+ }
24723
+
22935
24724
  /**
22936
24725
  * Create new category
22937
24726
  *
@@ -23162,7 +24951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23162
24951
  /**
23163
24952
  * LanguageUnderstanding service.
23164
24953
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
23165
- * @version 144.0.0
24954
+ * @version 147.0.0
23166
24955
  */
23167
24956
 
23168
24957
  /**
@@ -24066,7 +25855,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24066
25855
  /**
24067
25856
  * Languages service.
24068
25857
  * @module purecloud-platform-client-v2/api/LanguagesApi
24069
- * @version 144.0.0
25858
+ * @version 147.0.0
24070
25859
  */
24071
25860
 
24072
25861
  /**
@@ -24334,7 +26123,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24334
26123
  /**
24335
26124
  * Learning service.
24336
26125
  * @module purecloud-platform-client-v2/api/LearningApi
24337
- * @version 144.0.0
26126
+ * @version 147.0.0
24338
26127
  */
24339
26128
 
24340
26129
  /**
@@ -25094,7 +26883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25094
26883
  /**
25095
26884
  * License service.
25096
26885
  * @module purecloud-platform-client-v2/api/LicenseApi
25097
- * @version 144.0.0
26886
+ * @version 147.0.0
25098
26887
  */
25099
26888
 
25100
26889
  /**
@@ -25332,7 +27121,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25332
27121
  /**
25333
27122
  * Locations service.
25334
27123
  * @module purecloud-platform-client-v2/api/LocationsApi
25335
- * @version 144.0.0
27124
+ * @version 147.0.0
25336
27125
  */
25337
27126
 
25338
27127
  /**
@@ -25568,7 +27357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25568
27357
  /**
25569
27358
  * Messaging service.
25570
27359
  * @module purecloud-platform-client-v2/api/MessagingApi
25571
- * @version 144.0.0
27360
+ * @version 147.0.0
25572
27361
  */
25573
27362
 
25574
27363
  /**
@@ -25719,7 +27508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25719
27508
  /**
25720
27509
  * MobileDevices service.
25721
27510
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
25722
- * @version 144.0.0
27511
+ * @version 147.0.0
25723
27512
  */
25724
27513
 
25725
27514
  /**
@@ -25870,7 +27659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25870
27659
  /**
25871
27660
  * Notifications service.
25872
27661
  * @module purecloud-platform-client-v2/api/NotificationsApi
25873
- * @version 144.0.0
27662
+ * @version 147.0.0
25874
27663
  */
25875
27664
 
25876
27665
  /**
@@ -26095,7 +27884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26095
27884
  /**
26096
27885
  * OAuth service.
26097
27886
  * @module purecloud-platform-client-v2/api/OAuthApi
26098
- * @version 144.0.0
27887
+ * @version 147.0.0
26099
27888
  */
26100
27889
 
26101
27890
  /**
@@ -26461,7 +28250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26461
28250
  /**
26462
28251
  * Objects service.
26463
28252
  * @module purecloud-platform-client-v2/api/ObjectsApi
26464
- * @version 144.0.0
28253
+ * @version 147.0.0
26465
28254
  */
26466
28255
 
26467
28256
  /**
@@ -26732,7 +28521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26732
28521
  /**
26733
28522
  * Organization service.
26734
28523
  * @module purecloud-platform-client-v2/api/OrganizationApi
26735
- * @version 144.0.0
28524
+ * @version 147.0.0
26736
28525
  */
26737
28526
 
26738
28527
  /**
@@ -27135,7 +28924,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27135
28924
  /**
27136
28925
  * OrganizationAuthorization service.
27137
28926
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
27138
- * @version 144.0.0
28927
+ * @version 147.0.0
27139
28928
  */
27140
28929
 
27141
28930
  /**
@@ -28060,7 +29849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28060
29849
  /**
28061
29850
  * Outbound service.
28062
29851
  * @module purecloud-platform-client-v2/api/OutboundApi
28063
- * @version 144.0.0
29852
+ * @version 147.0.0
28064
29853
  */
28065
29854
 
28066
29855
  /**
@@ -28360,6 +30149,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28360
30149
  );
28361
30150
  }
28362
30151
 
30152
+ /**
30153
+ * Delete an Outbound Digital Rule Set
30154
+ *
30155
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
30156
+ */
30157
+ deleteOutboundDigitalruleset(digitalRuleSetId) {
30158
+ // verify the required parameter 'digitalRuleSetId' is set
30159
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
30160
+ throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
30161
+ }
30162
+
30163
+ return this.apiClient.callApi(
30164
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
30165
+ 'DELETE',
30166
+ { 'digitalRuleSetId': digitalRuleSetId },
30167
+ { },
30168
+ { },
30169
+ { },
30170
+ null,
30171
+ ['PureCloud OAuth'],
30172
+ ['application/json'],
30173
+ ['application/json']
30174
+ );
30175
+ }
30176
+
28363
30177
  /**
28364
30178
  * Delete dialer DNC list
28365
30179
  *
@@ -29397,6 +31211,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29397
31211
  );
29398
31212
  }
29399
31213
 
31214
+ /**
31215
+ * Get an Outbound Digital Rule Set
31216
+ *
31217
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
31218
+ */
31219
+ getOutboundDigitalruleset(digitalRuleSetId) {
31220
+ // verify the required parameter 'digitalRuleSetId' is set
31221
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
31222
+ throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
31223
+ }
31224
+
31225
+ return this.apiClient.callApi(
31226
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
31227
+ 'GET',
31228
+ { 'digitalRuleSetId': digitalRuleSetId },
31229
+ { },
31230
+ { },
31231
+ { },
31232
+ null,
31233
+ ['PureCloud OAuth'],
31234
+ ['application/json'],
31235
+ ['application/json']
31236
+ );
31237
+ }
31238
+
31239
+ /**
31240
+ * Query a list of Outbound Digital Rule Sets
31241
+ *
31242
+ * @param {Object} opts Optional parameters
31243
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
31244
+ * @param {Number} opts.pageNumber Page number (default to 1)
31245
+ * @param {Object} opts.sortBy The field to sort by (default to name)
31246
+ * @param {Object} opts.sortOrder The direction to sort (default to ascending)
31247
+ * @param {String} opts.name Name
31248
+ * @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
31249
+ */
31250
+ getOutboundDigitalrulesets(opts) {
31251
+ opts = opts || {};
31252
+
31253
+
31254
+ return this.apiClient.callApi(
31255
+ '/api/v2/outbound/digitalrulesets',
31256
+ 'GET',
31257
+ { },
31258
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
31259
+ { },
31260
+ { },
31261
+ null,
31262
+ ['PureCloud OAuth'],
31263
+ ['application/json'],
31264
+ ['application/json']
31265
+ );
31266
+ }
31267
+
29400
31268
  /**
29401
31269
  * Get dialer DNC list
29402
31270
  *
@@ -30580,6 +32448,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30580
32448
  );
30581
32449
  }
30582
32450
 
32451
+ /**
32452
+ * Create an Outbound Digital Rule Set
32453
+ *
32454
+ * @param {Object} body Digital Rule Set
32455
+ */
32456
+ postOutboundDigitalrulesets(body) {
32457
+ // verify the required parameter 'body' is set
32458
+ if (body === undefined || body === null) {
32459
+ throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
32460
+ }
32461
+
32462
+ return this.apiClient.callApi(
32463
+ '/api/v2/outbound/digitalrulesets',
32464
+ 'POST',
32465
+ { },
32466
+ { },
32467
+ { },
32468
+ { },
32469
+ body,
32470
+ ['PureCloud OAuth'],
32471
+ ['application/json'],
32472
+ ['application/json']
32473
+ );
32474
+ }
32475
+
30583
32476
  /**
30584
32477
  * Initiate the export of a dnc list.
30585
32478
  * Returns 200 if received OK.
@@ -31044,6 +32937,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31044
32937
  );
31045
32938
  }
31046
32939
 
32940
+ /**
32941
+ * Update an Outbound Digital Rule Set
32942
+ *
32943
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
32944
+ * @param {Object} body Digital Rule Set
32945
+ */
32946
+ putOutboundDigitalruleset(digitalRuleSetId, body) {
32947
+ // verify the required parameter 'digitalRuleSetId' is set
32948
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
32949
+ throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
32950
+ }
32951
+ // verify the required parameter 'body' is set
32952
+ if (body === undefined || body === null) {
32953
+ throw 'Missing the required parameter "body" when calling putOutboundDigitalruleset';
32954
+ }
32955
+
32956
+ return this.apiClient.callApi(
32957
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
32958
+ 'PUT',
32959
+ { 'digitalRuleSetId': digitalRuleSetId },
32960
+ { },
32961
+ { },
32962
+ { },
32963
+ body,
32964
+ ['PureCloud OAuth'],
32965
+ ['application/json'],
32966
+ ['application/json']
32967
+ );
32968
+ }
32969
+
31047
32970
  /**
31048
32971
  * Update dialer DNC list
31049
32972
  *
@@ -31315,7 +33238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31315
33238
  /**
31316
33239
  * Presence service.
31317
33240
  * @module purecloud-platform-client-v2/api/PresenceApi
31318
- * @version 144.0.0
33241
+ * @version 147.0.0
31319
33242
  */
31320
33243
 
31321
33244
  /**
@@ -31637,7 +33560,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31637
33560
  /**
31638
33561
  * Quality service.
31639
33562
  * @module purecloud-platform-client-v2/api/QualityApi
31640
- * @version 144.0.0
33563
+ * @version 147.0.0
31641
33564
  */
31642
33565
 
31643
33566
  /**
@@ -32147,7 +34070,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32147
34070
  * @param {String} opts.sortBy variable name requested to sort by
32148
34071
  * @param {String} opts.nextPage next page token
32149
34072
  * @param {String} opts.previousPage Previous page token
32150
- * @param {String} opts.expand Expand
34073
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
32151
34074
  * @param {String} opts.name Name
32152
34075
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
32153
34076
  */
@@ -32234,7 +34157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32234
34157
  * @param {String} opts.sortBy variable name requested to sort by
32235
34158
  * @param {String} opts.nextPage next page token
32236
34159
  * @param {String} opts.previousPage Previous page token
32237
- * @param {String} opts.expand Expand
34160
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
32238
34161
  * @param {String} opts.name Name
32239
34162
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
32240
34163
  */
@@ -32345,7 +34268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32345
34268
  * @param {String} opts.sortBy variable name requested to sort by
32346
34269
  * @param {String} opts.nextPage next page token
32347
34270
  * @param {String} opts.previousPage Previous page token
32348
- * @param {String} opts.expand Expand
34271
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
32349
34272
  * @param {String} opts.name Name
32350
34273
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
32351
34274
  */
@@ -33215,7 +35138,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33215
35138
  /**
33216
35139
  * Recording service.
33217
35140
  * @module purecloud-platform-client-v2/api/RecordingApi
33218
- * @version 144.0.0
35141
+ * @version 147.0.0
33219
35142
  */
33220
35143
 
33221
35144
  /**
@@ -33740,12 +35663,249 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33740
35663
  * @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
33741
35664
  * @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
33742
35665
  */
33743
- getRecordingCrossplatformMediaretentionpolicies(opts) {
35666
+ getRecordingCrossplatformMediaretentionpolicies(opts) {
35667
+ opts = opts || {};
35668
+
35669
+
35670
+ return this.apiClient.callApi(
35671
+ '/api/v2/recording/crossplatform/mediaretentionpolicies',
35672
+ 'GET',
35673
+ { },
35674
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
35675
+ { },
35676
+ { },
35677
+ null,
35678
+ ['PureCloud OAuth'],
35679
+ ['application/json'],
35680
+ ['application/json']
35681
+ );
35682
+ }
35683
+
35684
+ /**
35685
+ * Get a media retention policy
35686
+ *
35687
+ * @param {String} policyId Policy ID
35688
+ */
35689
+ getRecordingCrossplatformMediaretentionpolicy(policyId) {
35690
+ // verify the required parameter 'policyId' is set
35691
+ if (policyId === undefined || policyId === null) {
35692
+ throw 'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';
35693
+ }
35694
+
35695
+ return this.apiClient.callApi(
35696
+ '/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}',
35697
+ 'GET',
35698
+ { 'policyId': policyId },
35699
+ { },
35700
+ { },
35701
+ { },
35702
+ null,
35703
+ ['PureCloud OAuth'],
35704
+ ['application/json'],
35705
+ ['application/json']
35706
+ );
35707
+ }
35708
+
35709
+ /**
35710
+ * Get the status of the job associated with the job id.
35711
+ *
35712
+ * @param {String} jobId jobId
35713
+ */
35714
+ getRecordingJob(jobId) {
35715
+ // verify the required parameter 'jobId' is set
35716
+ if (jobId === undefined || jobId === null) {
35717
+ throw 'Missing the required parameter "jobId" when calling getRecordingJob';
35718
+ }
35719
+
35720
+ return this.apiClient.callApi(
35721
+ '/api/v2/recording/jobs/{jobId}',
35722
+ 'GET',
35723
+ { 'jobId': jobId },
35724
+ { },
35725
+ { },
35726
+ { },
35727
+ null,
35728
+ ['PureCloud OAuth'],
35729
+ ['application/json'],
35730
+ ['application/json']
35731
+ );
35732
+ }
35733
+
35734
+ /**
35735
+ * Get IDs of recordings that the bulk job failed for
35736
+ *
35737
+ * @param {String} jobId jobId
35738
+ * @param {Object} opts Optional parameters
35739
+ * @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
35740
+ * @param {Number} opts.pageNumber Page number (default to 1)
35741
+ * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
35742
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
35743
+ */
35744
+ getRecordingJobFailedrecordings(jobId, opts) {
35745
+ opts = opts || {};
35746
+
35747
+ // verify the required parameter 'jobId' is set
35748
+ if (jobId === undefined || jobId === null) {
35749
+ throw 'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';
35750
+ }
35751
+
35752
+ return this.apiClient.callApi(
35753
+ '/api/v2/recording/jobs/{jobId}/failedrecordings',
35754
+ 'GET',
35755
+ { 'jobId': jobId },
35756
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
35757
+ { },
35758
+ { },
35759
+ null,
35760
+ ['PureCloud OAuth'],
35761
+ ['application/json'],
35762
+ ['application/json']
35763
+ );
35764
+ }
35765
+
35766
+ /**
35767
+ * Get the status of all jobs within the user's organization
35768
+ *
35769
+ * @param {Object} opts Optional parameters
35770
+ * @param {Number} opts.pageSize Page size (default to 25)
35771
+ * @param {Number} opts.pageNumber Page number (default to 1)
35772
+ * @param {Object} opts.sortBy Sort by (default to userId)
35773
+ * @param {Object} opts.state Filter by state
35774
+ * @param {Boolean} opts.showOnlyMyJobs Show only my jobs
35775
+ * @param {Object} opts.jobType Job Type (Can be left empty for both)
35776
+ * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
35777
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
35778
+ */
35779
+ getRecordingJobs(opts) {
35780
+ opts = opts || {};
35781
+
35782
+
35783
+ return this.apiClient.callApi(
35784
+ '/api/v2/recording/jobs',
35785
+ 'GET',
35786
+ { },
35787
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
35788
+ { },
35789
+ { },
35790
+ null,
35791
+ ['PureCloud OAuth'],
35792
+ ['application/json'],
35793
+ ['application/json']
35794
+ );
35795
+ }
35796
+
35797
+ /**
35798
+ * Get the encryption key configurations
35799
+ *
35800
+ * @param {String} keyConfigurationId Key Configurations Id
35801
+ */
35802
+ getRecordingKeyconfiguration(keyConfigurationId) {
35803
+ // verify the required parameter 'keyConfigurationId' is set
35804
+ if (keyConfigurationId === undefined || keyConfigurationId === null) {
35805
+ throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
35806
+ }
35807
+
35808
+ return this.apiClient.callApi(
35809
+ '/api/v2/recording/keyconfigurations/{keyConfigurationId}',
35810
+ 'GET',
35811
+ { 'keyConfigurationId': keyConfigurationId },
35812
+ { },
35813
+ { },
35814
+ { },
35815
+ null,
35816
+ ['PureCloud OAuth'],
35817
+ ['application/json'],
35818
+ ['application/json']
35819
+ );
35820
+ }
35821
+
35822
+ /**
35823
+ * Get a list of key configurations data
35824
+ *
35825
+ */
35826
+ getRecordingKeyconfigurations() {
35827
+
35828
+ return this.apiClient.callApi(
35829
+ '/api/v2/recording/keyconfigurations',
35830
+ 'GET',
35831
+ { },
35832
+ { },
35833
+ { },
35834
+ { },
35835
+ null,
35836
+ ['PureCloud OAuth'],
35837
+ ['application/json'],
35838
+ ['application/json']
35839
+ );
35840
+ }
35841
+
35842
+ /**
35843
+ * Get the local encryption settings
35844
+ *
35845
+ * @param {String} settingsId Settings Id
35846
+ */
35847
+ getRecordingLocalkeysSetting(settingsId) {
35848
+ // verify the required parameter 'settingsId' is set
35849
+ if (settingsId === undefined || settingsId === null) {
35850
+ throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
35851
+ }
35852
+
35853
+ return this.apiClient.callApi(
35854
+ '/api/v2/recording/localkeys/settings/{settingsId}',
35855
+ 'GET',
35856
+ { 'settingsId': settingsId },
35857
+ { },
35858
+ { },
35859
+ { },
35860
+ null,
35861
+ ['PureCloud OAuth'],
35862
+ ['application/json'],
35863
+ ['application/json']
35864
+ );
35865
+ }
35866
+
35867
+ /**
35868
+ * gets a list local key settings data
35869
+ *
35870
+ */
35871
+ getRecordingLocalkeysSettings() {
35872
+
35873
+ return this.apiClient.callApi(
35874
+ '/api/v2/recording/localkeys/settings',
35875
+ 'GET',
35876
+ { },
35877
+ { },
35878
+ { },
35879
+ { },
35880
+ null,
35881
+ ['PureCloud OAuth'],
35882
+ ['application/json'],
35883
+ ['application/json']
35884
+ );
35885
+ }
35886
+
35887
+ /**
35888
+ * Gets media retention policy list with query options to filter on name and enabled.
35889
+ * for a less verbose response, add summary=true to this endpoint
35890
+ * @param {Object} opts Optional parameters
35891
+ * @param {Number} opts.pageSize The total page size requested (default to 25)
35892
+ * @param {Number} opts.pageNumber The page number requested (default to 1)
35893
+ * @param {String} opts.sortBy variable name requested to sort by
35894
+ * @param {Array.<String>} opts.expand variable name requested by expand list
35895
+ * @param {String} opts.nextPage next page token
35896
+ * @param {String} opts.previousPage Previous page token
35897
+ * @param {String} opts.name the policy name - used for filtering results in searches.
35898
+ * @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
35899
+ * @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
35900
+ * @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
35901
+ * @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
35902
+ */
35903
+ getRecordingMediaretentionpolicies(opts) {
33744
35904
  opts = opts || {};
33745
35905
 
33746
35906
 
33747
35907
  return this.apiClient.callApi(
33748
- '/api/v2/recording/crossplatform/mediaretentionpolicies',
35908
+ '/api/v2/recording/mediaretentionpolicies',
33749
35909
  'GET',
33750
35910
  { },
33751
35911
  { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
@@ -33763,14 +35923,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33763
35923
  *
33764
35924
  * @param {String} policyId Policy ID
33765
35925
  */
33766
- getRecordingCrossplatformMediaretentionpolicy(policyId) {
35926
+ getRecordingMediaretentionpolicy(policyId) {
33767
35927
  // verify the required parameter 'policyId' is set
33768
35928
  if (policyId === undefined || policyId === null) {
33769
- throw 'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';
35929
+ throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
33770
35930
  }
33771
35931
 
33772
35932
  return this.apiClient.callApi(
33773
- '/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}',
35933
+ '/api/v2/recording/mediaretentionpolicies/{policyId}',
33774
35934
  'GET',
33775
35935
  { 'policyId': policyId },
33776
35936
  { },
@@ -33784,154 +35944,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33784
35944
  }
33785
35945
 
33786
35946
  /**
33787
- * Get the status of the job associated with the job id.
33788
- *
33789
- * @param {String} jobId jobId
33790
- */
33791
- getRecordingJob(jobId) {
33792
- // verify the required parameter 'jobId' is set
33793
- if (jobId === undefined || jobId === null) {
33794
- throw 'Missing the required parameter "jobId" when calling getRecordingJob';
33795
- }
33796
-
33797
- return this.apiClient.callApi(
33798
- '/api/v2/recording/jobs/{jobId}',
33799
- 'GET',
33800
- { 'jobId': jobId },
33801
- { },
33802
- { },
33803
- { },
33804
- null,
33805
- ['PureCloud OAuth'],
33806
- ['application/json'],
33807
- ['application/json']
33808
- );
33809
- }
33810
-
33811
- /**
33812
- * Get IDs of recordings that the bulk job failed for
33813
- *
33814
- * @param {String} jobId jobId
33815
- * @param {Object} opts Optional parameters
33816
- * @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
33817
- * @param {Number} opts.pageNumber Page number (default to 1)
33818
- * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
33819
- * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
33820
- */
33821
- getRecordingJobFailedrecordings(jobId, opts) {
33822
- opts = opts || {};
33823
-
33824
- // verify the required parameter 'jobId' is set
33825
- if (jobId === undefined || jobId === null) {
33826
- throw 'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';
33827
- }
33828
-
33829
- return this.apiClient.callApi(
33830
- '/api/v2/recording/jobs/{jobId}/failedrecordings',
33831
- 'GET',
33832
- { 'jobId': jobId },
33833
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
33834
- { },
33835
- { },
33836
- null,
33837
- ['PureCloud OAuth'],
33838
- ['application/json'],
33839
- ['application/json']
33840
- );
33841
- }
33842
-
33843
- /**
33844
- * Get the status of all jobs within the user's organization
35947
+ * Get encryption key list
33845
35948
  *
33846
35949
  * @param {Object} opts Optional parameters
33847
35950
  * @param {Number} opts.pageSize Page size (default to 25)
33848
35951
  * @param {Number} opts.pageNumber Page number (default to 1)
33849
- * @param {Object} opts.sortBy Sort by (default to userId)
33850
- * @param {Object} opts.state Filter by state
33851
- * @param {Boolean} opts.showOnlyMyJobs Show only my jobs
33852
- * @param {Object} opts.jobType Job Type (Can be left empty for both)
33853
- * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
33854
- * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
33855
35952
  */
33856
- getRecordingJobs(opts) {
35953
+ getRecordingRecordingkeys(opts) {
33857
35954
  opts = opts || {};
33858
35955
 
33859
35956
 
33860
35957
  return this.apiClient.callApi(
33861
- '/api/v2/recording/jobs',
33862
- 'GET',
33863
- { },
33864
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
33865
- { },
33866
- { },
33867
- null,
33868
- ['PureCloud OAuth'],
33869
- ['application/json'],
33870
- ['application/json']
33871
- );
33872
- }
33873
-
33874
- /**
33875
- * Get the encryption key configurations
33876
- *
33877
- * @param {String} keyConfigurationId Key Configurations Id
33878
- */
33879
- getRecordingKeyconfiguration(keyConfigurationId) {
33880
- // verify the required parameter 'keyConfigurationId' is set
33881
- if (keyConfigurationId === undefined || keyConfigurationId === null) {
33882
- throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
33883
- }
33884
-
33885
- return this.apiClient.callApi(
33886
- '/api/v2/recording/keyconfigurations/{keyConfigurationId}',
33887
- 'GET',
33888
- { 'keyConfigurationId': keyConfigurationId },
33889
- { },
33890
- { },
33891
- { },
33892
- null,
33893
- ['PureCloud OAuth'],
33894
- ['application/json'],
33895
- ['application/json']
33896
- );
33897
- }
33898
-
33899
- /**
33900
- * Get a list of key configurations data
33901
- *
33902
- */
33903
- getRecordingKeyconfigurations() {
33904
-
33905
- return this.apiClient.callApi(
33906
- '/api/v2/recording/keyconfigurations',
33907
- 'GET',
33908
- { },
33909
- { },
33910
- { },
33911
- { },
33912
- null,
33913
- ['PureCloud OAuth'],
33914
- ['application/json'],
33915
- ['application/json']
33916
- );
33917
- }
33918
-
33919
- /**
33920
- * Get the local encryption settings
33921
- *
33922
- * @param {String} settingsId Settings Id
33923
- */
33924
- getRecordingLocalkeysSetting(settingsId) {
33925
- // verify the required parameter 'settingsId' is set
33926
- if (settingsId === undefined || settingsId === null) {
33927
- throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
33928
- }
33929
-
33930
- return this.apiClient.callApi(
33931
- '/api/v2/recording/localkeys/settings/{settingsId}',
35958
+ '/api/v2/recording/recordingkeys',
33932
35959
  'GET',
33933
- { 'settingsId': settingsId },
33934
35960
  { },
35961
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
33935
35962
  { },
33936
35963
  { },
33937
35964
  null,
@@ -33942,74 +35969,15 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33942
35969
  }
33943
35970
 
33944
35971
  /**
33945
- * gets a list local key settings data
35972
+ * Get key rotation schedule
33946
35973
  *
33947
35974
  */
33948
- getRecordingLocalkeysSettings() {
33949
-
33950
- return this.apiClient.callApi(
33951
- '/api/v2/recording/localkeys/settings',
33952
- 'GET',
33953
- { },
33954
- { },
33955
- { },
33956
- { },
33957
- null,
33958
- ['PureCloud OAuth'],
33959
- ['application/json'],
33960
- ['application/json']
33961
- );
33962
- }
33963
-
33964
- /**
33965
- * Gets media retention policy list with query options to filter on name and enabled.
33966
- * for a less verbose response, add summary=true to this endpoint
33967
- * @param {Object} opts Optional parameters
33968
- * @param {Number} opts.pageSize The total page size requested (default to 25)
33969
- * @param {Number} opts.pageNumber The page number requested (default to 1)
33970
- * @param {String} opts.sortBy variable name requested to sort by
33971
- * @param {Array.<String>} opts.expand variable name requested by expand list
33972
- * @param {String} opts.nextPage next page token
33973
- * @param {String} opts.previousPage Previous page token
33974
- * @param {String} opts.name the policy name - used for filtering results in searches.
33975
- * @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
33976
- * @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
33977
- * @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
33978
- * @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
33979
- */
33980
- getRecordingMediaretentionpolicies(opts) {
33981
- opts = opts || {};
33982
-
35975
+ getRecordingRecordingkeysRotationschedule() {
33983
35976
 
33984
35977
  return this.apiClient.callApi(
33985
- '/api/v2/recording/mediaretentionpolicies',
35978
+ '/api/v2/recording/recordingkeys/rotationschedule',
33986
35979
  'GET',
33987
35980
  { },
33988
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
33989
- { },
33990
- { },
33991
- null,
33992
- ['PureCloud OAuth'],
33993
- ['application/json'],
33994
- ['application/json']
33995
- );
33996
- }
33997
-
33998
- /**
33999
- * Get a media retention policy
34000
- *
34001
- * @param {String} policyId Policy ID
34002
- */
34003
- getRecordingMediaretentionpolicy(policyId) {
34004
- // verify the required parameter 'policyId' is set
34005
- if (policyId === undefined || policyId === null) {
34006
- throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
34007
- }
34008
-
34009
- return this.apiClient.callApi(
34010
- '/api/v2/recording/mediaretentionpolicies/{policyId}',
34011
- 'GET',
34012
- { 'policyId': policyId },
34013
35981
  { },
34014
35982
  { },
34015
35983
  { },
@@ -34021,41 +35989,20 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34021
35989
  }
34022
35990
 
34023
35991
  /**
34024
- * Get encryption key list
35992
+ * Get the Recording Settings for the Organization
34025
35993
  *
34026
35994
  * @param {Object} opts Optional parameters
34027
- * @param {Number} opts.pageSize Page size (default to 25)
34028
- * @param {Number} opts.pageNumber Page number (default to 1)
35995
+ * @param {Boolean} opts.createDefault If no settings are found, a new one is created with default values (default to false)
34029
35996
  */
34030
- getRecordingRecordingkeys(opts) {
35997
+ getRecordingSettings(opts) {
34031
35998
  opts = opts || {};
34032
35999
 
34033
36000
 
34034
36001
  return this.apiClient.callApi(
34035
- '/api/v2/recording/recordingkeys',
34036
- 'GET',
34037
- { },
34038
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
34039
- { },
34040
- { },
34041
- null,
34042
- ['PureCloud OAuth'],
34043
- ['application/json'],
34044
- ['application/json']
34045
- );
34046
- }
34047
-
34048
- /**
34049
- * Get key rotation schedule
34050
- *
34051
- */
34052
- getRecordingRecordingkeysRotationschedule() {
34053
-
34054
- return this.apiClient.callApi(
34055
- '/api/v2/recording/recordingkeys/rotationschedule',
36002
+ '/api/v2/recording/settings',
34056
36003
  'GET',
34057
36004
  { },
34058
- { },
36005
+ { 'createDefault': opts['createDefault'] },
34059
36006
  { },
34060
36007
  { },
34061
36008
  null,
@@ -34066,20 +36013,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34066
36013
  }
34067
36014
 
34068
36015
  /**
34069
- * Get the Recording Settings for the Organization
36016
+ * Query for recording retention data
34070
36017
  *
36018
+ * @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
34071
36019
  * @param {Object} opts Optional parameters
34072
- * @param {Boolean} opts.createDefault If no settings are found, a new one is created with default values (default to false)
36020
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
36021
+ * @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
34073
36022
  */
34074
- getRecordingSettings(opts) {
36023
+ getRecordingsRetentionQuery(retentionThresholdDays, opts) {
34075
36024
  opts = opts || {};
34076
36025
 
36026
+ // verify the required parameter 'retentionThresholdDays' is set
36027
+ if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
36028
+ throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
36029
+ }
34077
36030
 
34078
36031
  return this.apiClient.callApi(
34079
- '/api/v2/recording/settings',
36032
+ '/api/v2/recordings/retention/query',
34080
36033
  'GET',
34081
36034
  { },
34082
- { 'createDefault': opts['createDefault'] },
36035
+ { 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
34083
36036
  { },
34084
36037
  { },
34085
36038
  null,
@@ -34868,7 +36821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34868
36821
  /**
34869
36822
  * ResponseManagement service.
34870
36823
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
34871
- * @version 144.0.0
36824
+ * @version 147.0.0
34872
36825
  */
34873
36826
 
34874
36827
  /**
@@ -35352,7 +37305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35352
37305
  /**
35353
37306
  * Routing service.
35354
37307
  * @module purecloud-platform-client-v2/api/RoutingApi
35355
- * @version 144.0.0
37308
+ * @version 147.0.0
35356
37309
  */
35357
37310
 
35358
37311
  /**
@@ -35918,6 +37871,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35918
37871
  );
35919
37872
  }
35920
37873
 
37874
+ /**
37875
+ * Get available media types
37876
+ *
37877
+ */
37878
+ getRoutingAvailablemediatypes() {
37879
+
37880
+ return this.apiClient.callApi(
37881
+ '/api/v2/routing/availablemediatypes',
37882
+ 'GET',
37883
+ { },
37884
+ { },
37885
+ { },
37886
+ { },
37887
+ null,
37888
+ ['PureCloud OAuth'],
37889
+ ['application/json'],
37890
+ ['application/json']
37891
+ );
37892
+ }
37893
+
35921
37894
  /**
35922
37895
  * Get domain
35923
37896
  *
@@ -38273,7 +40246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38273
40246
  /**
38274
40247
  * SCIM service.
38275
40248
  * @module purecloud-platform-client-v2/api/SCIMApi
38276
- * @version 144.0.0
40249
+ * @version 147.0.0
38277
40250
  */
38278
40251
 
38279
40252
  /**
@@ -39150,7 +41123,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39150
41123
  /**
39151
41124
  * Scripts service.
39152
41125
  * @module purecloud-platform-client-v2/api/ScriptsApi
39153
- * @version 144.0.0
41126
+ * @version 147.0.0
39154
41127
  */
39155
41128
 
39156
41129
  /**
@@ -39569,7 +41542,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39569
41542
  /**
39570
41543
  * Search service.
39571
41544
  * @module purecloud-platform-client-v2/api/SearchApi
39572
- * @version 144.0.0
41545
+ * @version 147.0.0
39573
41546
  */
39574
41547
 
39575
41548
  /**
@@ -40129,7 +42102,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40129
42102
  /**
40130
42103
  * SpeechTextAnalytics service.
40131
42104
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
40132
- * @version 144.0.0
42105
+ * @version 147.0.0
40133
42106
  */
40134
42107
 
40135
42108
  /**
@@ -40983,7 +42956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40983
42956
  /**
40984
42957
  * Stations service.
40985
42958
  * @module purecloud-platform-client-v2/api/StationsApi
40986
- * @version 144.0.0
42959
+ * @version 147.0.0
40987
42960
  */
40988
42961
 
40989
42962
  /**
@@ -41130,7 +43103,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41130
43103
  /**
41131
43104
  * Suggest service.
41132
43105
  * @module purecloud-platform-client-v2/api/SuggestApi
41133
- * @version 144.0.0
43106
+ * @version 147.0.0
41134
43107
  */
41135
43108
 
41136
43109
  /**
@@ -41269,7 +43242,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41269
43242
  /**
41270
43243
  * Teams service.
41271
43244
  * @module purecloud-platform-client-v2/api/TeamsApi
41272
- * @version 144.0.0
43245
+ * @version 147.0.0
41273
43246
  */
41274
43247
 
41275
43248
  /**
@@ -41448,7 +43421,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41448
43421
  /**
41449
43422
  * Telephony service.
41450
43423
  * @module purecloud-platform-client-v2/api/TelephonyApi
41451
- * @version 144.0.0
43424
+ * @version 147.0.0
41452
43425
  */
41453
43426
 
41454
43427
  /**
@@ -41556,7 +43529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41556
43529
  /**
41557
43530
  * TelephonyProvidersEdge service.
41558
43531
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
41559
- * @version 144.0.0
43532
+ * @version 147.0.0
41560
43533
  */
41561
43534
 
41562
43535
  /**
@@ -45189,7 +47162,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45189
47162
  /**
45190
47163
  * Textbots service.
45191
47164
  * @module purecloud-platform-client-v2/api/TextbotsApi
45192
- * @version 144.0.0
47165
+ * @version 147.0.0
45193
47166
  */
45194
47167
 
45195
47168
  /**
@@ -45317,7 +47290,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45317
47290
  /**
45318
47291
  * Tokens service.
45319
47292
  * @module purecloud-platform-client-v2/api/TokensApi
45320
- * @version 144.0.0
47293
+ * @version 147.0.0
45321
47294
  */
45322
47295
 
45323
47296
  /**
@@ -45423,7 +47396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45423
47396
  /**
45424
47397
  * Uploads service.
45425
47398
  * @module purecloud-platform-client-v2/api/UploadsApi
45426
- * @version 144.0.0
47399
+ * @version 147.0.0
45427
47400
  */
45428
47401
 
45429
47402
  /**
@@ -45599,7 +47572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45599
47572
  /**
45600
47573
  * Usage service.
45601
47574
  * @module purecloud-platform-client-v2/api/UsageApi
45602
- * @version 144.0.0
47575
+ * @version 147.0.0
45603
47576
  */
45604
47577
 
45605
47578
  /**
@@ -45670,7 +47643,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45670
47643
  /**
45671
47644
  * UserRecordings service.
45672
47645
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
45673
- * @version 144.0.0
47646
+ * @version 147.0.0
45674
47647
  */
45675
47648
 
45676
47649
  /**
@@ -45854,7 +47827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45854
47827
  /**
45855
47828
  * Users service.
45856
47829
  * @module purecloud-platform-client-v2/api/UsersApi
45857
- * @version 144.0.0
47830
+ * @version 147.0.0
45858
47831
  */
45859
47832
 
45860
47833
  /**
@@ -47596,6 +49569,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47596
49569
  );
47597
49570
  }
47598
49571
 
49572
+ /**
49573
+ * Create mapping between external identifier and user. Limit 100 per entity.
49574
+ * Authority Name and External key are case sensitive.
49575
+ * @param {String} userId User ID
49576
+ * @param {Object} body
49577
+ */
49578
+ postUserExternalid(userId, body) {
49579
+ // verify the required parameter 'userId' is set
49580
+ if (userId === undefined || userId === null) {
49581
+ throw 'Missing the required parameter "userId" when calling postUserExternalid';
49582
+ }
49583
+ // verify the required parameter 'body' is set
49584
+ if (body === undefined || body === null) {
49585
+ throw 'Missing the required parameter "body" when calling postUserExternalid';
49586
+ }
49587
+
49588
+ return this.apiClient.callApi(
49589
+ '/api/v2/users/{userId}/externalid',
49590
+ 'POST',
49591
+ { 'userId': userId },
49592
+ { },
49593
+ { },
49594
+ { },
49595
+ body,
49596
+ ['PureCloud OAuth'],
49597
+ ['application/json'],
49598
+ ['application/json']
49599
+ );
49600
+ }
49601
+
47599
49602
  /**
47600
49603
  * Send an activation email to the user
47601
49604
  *
@@ -47717,7 +49720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47717
49720
 
47718
49721
  /**
47719
49722
  * Create user
47720
- *
49723
+ * 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.
47721
49724
  * @param {Object} body User
47722
49725
  */
47723
49726
  postUsers(body) {
@@ -48156,7 +50159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48156
50159
  /**
48157
50160
  * Utilities service.
48158
50161
  * @module purecloud-platform-client-v2/api/UtilitiesApi
48159
- * @version 144.0.0
50162
+ * @version 147.0.0
48160
50163
  */
48161
50164
 
48162
50165
  /**
@@ -48267,7 +50270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48267
50270
  /**
48268
50271
  * Voicemail service.
48269
50272
  * @module purecloud-platform-client-v2/api/VoicemailApi
48270
- * @version 144.0.0
50273
+ * @version 147.0.0
48271
50274
  */
48272
50275
 
48273
50276
  /**
@@ -48934,7 +50937,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48934
50937
  /**
48935
50938
  * WebChat service.
48936
50939
  * @module purecloud-platform-client-v2/api/WebChatApi
48937
- * @version 144.0.0
50940
+ * @version 147.0.0
48938
50941
  */
48939
50942
 
48940
50943
  /**
@@ -49478,7 +51481,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49478
51481
  /**
49479
51482
  * WebDeployments service.
49480
51483
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
49481
- * @version 144.0.0
51484
+ * @version 147.0.0
49482
51485
  */
49483
51486
 
49484
51487
  /**
@@ -49672,6 +51675,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49672
51675
  );
49673
51676
  }
49674
51677
 
51678
+ /**
51679
+ * Get active configuration for a given deployment
51680
+ *
51681
+ * @param {String} deploymentId The deployment ID
51682
+ * @param {Object} opts Optional parameters
51683
+ * @param {String} opts.type Get active configuration on a deployment
51684
+ */
51685
+ getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
51686
+ opts = opts || {};
51687
+
51688
+ // verify the required parameter 'deploymentId' is set
51689
+ if (deploymentId === undefined || deploymentId === null) {
51690
+ throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';
51691
+ }
51692
+
51693
+ return this.apiClient.callApi(
51694
+ '/api/v2/webdeployments/deployments/{deploymentId}/configurations',
51695
+ 'GET',
51696
+ { 'deploymentId': deploymentId },
51697
+ { 'type': opts['type'] },
51698
+ { },
51699
+ { },
51700
+ null,
51701
+ ['PureCloud OAuth'],
51702
+ ['application/json'],
51703
+ ['application/json']
51704
+ );
51705
+ }
51706
+
49675
51707
  /**
49676
51708
  * Get deployments
49677
51709
  *
@@ -49833,7 +51865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49833
51865
  /**
49834
51866
  * WebMessaging service.
49835
51867
  * @module purecloud-platform-client-v2/api/WebMessagingApi
49836
- * @version 144.0.0
51868
+ * @version 147.0.0
49837
51869
  */
49838
51870
 
49839
51871
  /**
@@ -49879,7 +51911,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49879
51911
  /**
49880
51912
  * Widgets service.
49881
51913
  * @module purecloud-platform-client-v2/api/WidgetsApi
49882
- * @version 144.0.0
51914
+ * @version 147.0.0
49883
51915
  */
49884
51916
 
49885
51917
  /**
@@ -50025,7 +52057,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50025
52057
  /**
50026
52058
  * WorkforceManagement service.
50027
52059
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
50028
- * @version 144.0.0
52060
+ * @version 147.0.0
50029
52061
  */
50030
52062
 
50031
52063
  /**
@@ -54301,7 +56333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54301
56333
  * </pre>
54302
56334
  * </p>
54303
56335
  * @module purecloud-platform-client-v2/index
54304
- * @version 144.0.0
56336
+ * @version 147.0.0
54305
56337
  */
54306
56338
  class platformClient {
54307
56339
  constructor() {