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
@@ -402,7 +402,7 @@ class Configuration {
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 144.0.0
405
+ * @version 147.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1481,7 +1481,7 @@ class AlertingApi {
1481
1481
  /**
1482
1482
  * Alerting service.
1483
1483
  * @module purecloud-platform-client-v2/api/AlertingApi
1484
- * @version 144.0.0
1484
+ * @version 147.0.0
1485
1485
  */
1486
1486
 
1487
1487
  /**
@@ -1795,7 +1795,7 @@ class AnalyticsApi {
1795
1795
  /**
1796
1796
  * Analytics service.
1797
1797
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1798
- * @version 144.0.0
1798
+ * @version 147.0.0
1799
1799
  */
1800
1800
 
1801
1801
  /**
@@ -2041,6 +2041,26 @@ class AnalyticsApi {
2041
2041
  );
2042
2042
  }
2043
2043
 
2044
+ /**
2045
+ * Get analytics data retention setting
2046
+ *
2047
+ */
2048
+ getAnalyticsDataretentionSettings() {
2049
+
2050
+ return this.apiClient.callApi(
2051
+ '/api/v2/analytics/dataretention/settings',
2052
+ 'GET',
2053
+ { },
2054
+ { },
2055
+ { },
2056
+ { },
2057
+ null,
2058
+ ['PureCloud OAuth'],
2059
+ ['application/json'],
2060
+ ['application/json']
2061
+ );
2062
+ }
2063
+
2044
2064
  /**
2045
2065
  * Get all view export requests for a user
2046
2066
  *
@@ -2941,6 +2961,31 @@ class AnalyticsApi {
2941
2961
  );
2942
2962
  }
2943
2963
 
2964
+ /**
2965
+ * Update analytics data retention setting
2966
+ *
2967
+ * @param {Object} body retentionDays
2968
+ */
2969
+ putAnalyticsDataretentionSettings(body) {
2970
+ // verify the required parameter 'body' is set
2971
+ if (body === undefined || body === null) {
2972
+ throw 'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';
2973
+ }
2974
+
2975
+ return this.apiClient.callApi(
2976
+ '/api/v2/analytics/dataretention/settings',
2977
+ 'PUT',
2978
+ { },
2979
+ { },
2980
+ { },
2981
+ { },
2982
+ body,
2983
+ ['PureCloud OAuth'],
2984
+ ['application/json'],
2985
+ ['application/json']
2986
+ );
2987
+ }
2988
+
2944
2989
  /**
2945
2990
  * Update a scheduled report job.
2946
2991
  *
@@ -2977,7 +3022,7 @@ class ArchitectApi {
2977
3022
  /**
2978
3023
  * Architect service.
2979
3024
  * @module purecloud-platform-client-v2/api/ArchitectApi
2980
- * @version 144.0.0
3025
+ * @version 147.0.0
2981
3026
  */
2982
3027
 
2983
3028
  /**
@@ -3735,6 +3780,7 @@ class ArchitectApi {
3735
3780
  * @param {String} opts.sortBy Sort by (default to name)
3736
3781
  * @param {String} opts.sortOrder Sort order (default to ASC)
3737
3782
  * @param {String} opts.name Name of the IVR to filter by.
3783
+ * @param {String} opts.dnis The phone number of the IVR to filter by.
3738
3784
  */
3739
3785
  getArchitectIvrs(opts) {
3740
3786
  opts = opts || {};
@@ -3744,7 +3790,7 @@ class ArchitectApi {
3744
3790
  '/api/v2/architect/ivrs',
3745
3791
  'GET',
3746
3792
  { },
3747
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
3793
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
3748
3794
  { },
3749
3795
  { },
3750
3796
  null,
@@ -6022,7 +6068,7 @@ class AuditApi {
6022
6068
  /**
6023
6069
  * Audit service.
6024
6070
  * @module purecloud-platform-client-v2/api/AuditApi
6025
- * @version 144.0.0
6071
+ * @version 147.0.0
6026
6072
  */
6027
6073
 
6028
6074
  /**
@@ -6193,7 +6239,7 @@ class AuthorizationApi {
6193
6239
  /**
6194
6240
  * Authorization service.
6195
6241
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6196
- * @version 144.0.0
6242
+ * @version 147.0.0
6197
6243
  */
6198
6244
 
6199
6245
  /**
@@ -7376,7 +7422,7 @@ class BillingApi {
7376
7422
  /**
7377
7423
  * Billing service.
7378
7424
  * @module purecloud-platform-client-v2/api/BillingApi
7379
- * @version 144.0.0
7425
+ * @version 147.0.0
7380
7426
  */
7381
7427
 
7382
7428
  /**
@@ -7456,7 +7502,7 @@ class ChatApi {
7456
7502
  /**
7457
7503
  * Chat service.
7458
7504
  * @module purecloud-platform-client-v2/api/ChatApi
7459
- * @version 144.0.0
7505
+ * @version 147.0.0
7460
7506
  */
7461
7507
 
7462
7508
  /**
@@ -7547,7 +7593,7 @@ class CoachingApi {
7547
7593
  /**
7548
7594
  * Coaching service.
7549
7595
  * @module purecloud-platform-client-v2/api/CoachingApi
7550
- * @version 144.0.0
7596
+ * @version 147.0.0
7551
7597
  */
7552
7598
 
7553
7599
  /**
@@ -8124,7 +8170,7 @@ class ContentManagementApi {
8124
8170
  /**
8125
8171
  * ContentManagement service.
8126
8172
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8127
- * @version 144.0.0
8173
+ * @version 147.0.0
8128
8174
  */
8129
8175
 
8130
8176
  /**
@@ -9264,7 +9310,7 @@ class ConversationsApi {
9264
9310
  /**
9265
9311
  * Conversations service.
9266
9312
  * @module purecloud-platform-client-v2/api/ConversationsApi
9267
- * @version 144.0.0
9313
+ * @version 147.0.0
9268
9314
  */
9269
9315
 
9270
9316
  /**
@@ -9857,6 +9903,31 @@ class ConversationsApi {
9857
9903
  );
9858
9904
  }
9859
9905
 
9906
+ /**
9907
+ * Get the secure attributes on a conversation.
9908
+ *
9909
+ * @param {String} conversationId conversation ID
9910
+ */
9911
+ getConversationSecureattributes(conversationId) {
9912
+ // verify the required parameter 'conversationId' is set
9913
+ if (conversationId === undefined || conversationId === null) {
9914
+ throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
9915
+ }
9916
+
9917
+ return this.apiClient.callApi(
9918
+ '/api/v2/conversations/{conversationId}/secureattributes',
9919
+ 'GET',
9920
+ { 'conversationId': conversationId },
9921
+ { },
9922
+ { },
9923
+ { },
9924
+ null,
9925
+ ['PureCloud OAuth'],
9926
+ ['application/json'],
9927
+ ['application/json']
9928
+ );
9929
+ }
9930
+
9860
9931
  /**
9861
9932
  * Get active conversations for the logged in user
9862
9933
  *
@@ -10640,6 +10711,51 @@ class ConversationsApi {
10640
10711
  );
10641
10712
  }
10642
10713
 
10714
+ /**
10715
+ * Get the encryption key configurations
10716
+ *
10717
+ * @param {String} keyconfigurationsId Key Configurations Id
10718
+ */
10719
+ getConversationsKeyconfiguration(keyconfigurationsId) {
10720
+ // verify the required parameter 'keyconfigurationsId' is set
10721
+ if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
10722
+ throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
10723
+ }
10724
+
10725
+ return this.apiClient.callApi(
10726
+ '/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
10727
+ 'GET',
10728
+ { 'keyconfigurationsId': keyconfigurationsId },
10729
+ { },
10730
+ { },
10731
+ { },
10732
+ null,
10733
+ ['PureCloud OAuth'],
10734
+ ['application/json'],
10735
+ ['application/json']
10736
+ );
10737
+ }
10738
+
10739
+ /**
10740
+ * Get a list of key configurations data
10741
+ *
10742
+ */
10743
+ getConversationsKeyconfigurations() {
10744
+
10745
+ return this.apiClient.callApi(
10746
+ '/api/v2/conversations/keyconfigurations',
10747
+ 'GET',
10748
+ { },
10749
+ { },
10750
+ { },
10751
+ { },
10752
+ null,
10753
+ ['PureCloud OAuth'],
10754
+ ['application/json'],
10755
+ ['application/json']
10756
+ );
10757
+ }
10758
+
10643
10759
  /**
10644
10760
  * Get message conversation
10645
10761
  *
@@ -11356,6 +11472,36 @@ class ConversationsApi {
11356
11472
  );
11357
11473
  }
11358
11474
 
11475
+ /**
11476
+ * Update the secure attributes on a conversation.
11477
+ *
11478
+ * @param {String} conversationId conversation ID
11479
+ * @param {Object} body Conversation Secure Attributes
11480
+ */
11481
+ patchConversationSecureattributes(conversationId, body) {
11482
+ // verify the required parameter 'conversationId' is set
11483
+ if (conversationId === undefined || conversationId === null) {
11484
+ throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
11485
+ }
11486
+ // verify the required parameter 'body' is set
11487
+ if (body === undefined || body === null) {
11488
+ throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
11489
+ }
11490
+
11491
+ return this.apiClient.callApi(
11492
+ '/api/v2/conversations/{conversationId}/secureattributes',
11493
+ 'PATCH',
11494
+ { 'conversationId': conversationId },
11495
+ { },
11496
+ { },
11497
+ { },
11498
+ body,
11499
+ ['PureCloud OAuth'],
11500
+ ['application/json'],
11501
+ ['application/json']
11502
+ );
11503
+ }
11504
+
11359
11505
  /**
11360
11506
  * Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
11361
11507
  *
@@ -13358,6 +13504,56 @@ class ConversationsApi {
13358
13504
  );
13359
13505
  }
13360
13506
 
13507
+ /**
13508
+ * Setup configurations for encryption key creation
13509
+ *
13510
+ * @param {Object} body Encryption Configuration
13511
+ */
13512
+ postConversationsKeyconfigurations(body) {
13513
+ // verify the required parameter 'body' is set
13514
+ if (body === undefined || body === null) {
13515
+ throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
13516
+ }
13517
+
13518
+ return this.apiClient.callApi(
13519
+ '/api/v2/conversations/keyconfigurations',
13520
+ 'POST',
13521
+ { },
13522
+ { },
13523
+ { },
13524
+ { },
13525
+ body,
13526
+ ['PureCloud OAuth'],
13527
+ ['application/json'],
13528
+ ['application/json']
13529
+ );
13530
+ }
13531
+
13532
+ /**
13533
+ * Validate encryption key configurations without saving it
13534
+ *
13535
+ * @param {Object} body Encryption Configuration
13536
+ */
13537
+ postConversationsKeyconfigurationsValidate(body) {
13538
+ // verify the required parameter 'body' is set
13539
+ if (body === undefined || body === null) {
13540
+ throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
13541
+ }
13542
+
13543
+ return this.apiClient.callApi(
13544
+ '/api/v2/conversations/keyconfigurations/validate',
13545
+ 'POST',
13546
+ { },
13547
+ { },
13548
+ { },
13549
+ { },
13550
+ body,
13551
+ ['PureCloud OAuth'],
13552
+ ['application/json'],
13553
+ ['application/json']
13554
+ );
13555
+ }
13556
+
13361
13557
  /**
13362
13558
  * Send message
13363
13559
  * 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.
@@ -13742,6 +13938,36 @@ class ConversationsApi {
13742
13938
  );
13743
13939
  }
13744
13940
 
13941
+ /**
13942
+ * Set the secure attributes on a conversation.
13943
+ *
13944
+ * @param {String} conversationId conversation ID
13945
+ * @param {Object} body Conversation Secure Attributes
13946
+ */
13947
+ putConversationSecureattributes(conversationId, body) {
13948
+ // verify the required parameter 'conversationId' is set
13949
+ if (conversationId === undefined || conversationId === null) {
13950
+ throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
13951
+ }
13952
+ // verify the required parameter 'body' is set
13953
+ if (body === undefined || body === null) {
13954
+ throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
13955
+ }
13956
+
13957
+ return this.apiClient.callApi(
13958
+ '/api/v2/conversations/{conversationId}/secureattributes',
13959
+ 'PUT',
13960
+ { 'conversationId': conversationId },
13961
+ { },
13962
+ { },
13963
+ { },
13964
+ body,
13965
+ ['PureCloud OAuth'],
13966
+ ['application/json'],
13967
+ ['application/json']
13968
+ );
13969
+ }
13970
+
13745
13971
  /**
13746
13972
  * Update the tags on a conversation.
13747
13973
  *
@@ -13992,6 +14218,36 @@ class ConversationsApi {
13992
14218
  );
13993
14219
  }
13994
14220
 
14221
+ /**
14222
+ * Update the encryption key configurations
14223
+ *
14224
+ * @param {String} keyconfigurationsId Key Configurations Id
14225
+ * @param {Object} body Encryption key configuration metadata
14226
+ */
14227
+ putConversationsKeyconfiguration(keyconfigurationsId, body) {
14228
+ // verify the required parameter 'keyconfigurationsId' is set
14229
+ if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
14230
+ throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
14231
+ }
14232
+ // verify the required parameter 'body' is set
14233
+ if (body === undefined || body === null) {
14234
+ throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
14235
+ }
14236
+
14237
+ return this.apiClient.callApi(
14238
+ '/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
14239
+ 'PUT',
14240
+ { 'keyconfigurationsId': keyconfigurationsId },
14241
+ { },
14242
+ { },
14243
+ { },
14244
+ body,
14245
+ ['PureCloud OAuth'],
14246
+ ['application/json'],
14247
+ ['application/json']
14248
+ );
14249
+ }
14250
+
13995
14251
  /**
13996
14252
  * Update a conversation by setting its recording state
13997
14253
  *
@@ -14198,7 +14454,7 @@ class DataExtensionsApi {
14198
14454
  /**
14199
14455
  * DataExtensions service.
14200
14456
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
14201
- * @version 144.0.0
14457
+ * @version 147.0.0
14202
14458
  */
14203
14459
 
14204
14460
  /**
@@ -14284,7 +14540,7 @@ class ExternalContactsApi {
14284
14540
  /**
14285
14541
  * ExternalContacts service.
14286
14542
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
14287
- * @version 144.0.0
14543
+ * @version 147.0.0
14288
14544
  */
14289
14545
 
14290
14546
  /**
@@ -16027,7 +16283,7 @@ class FaxApi {
16027
16283
  /**
16028
16284
  * Fax service.
16029
16285
  * @module purecloud-platform-client-v2/api/FaxApi
16030
- * @version 144.0.0
16286
+ * @version 147.0.0
16031
16287
  */
16032
16288
 
16033
16289
  /**
@@ -16198,7 +16454,7 @@ class FlowsApi {
16198
16454
  /**
16199
16455
  * Flows service.
16200
16456
  * @module purecloud-platform-client-v2/api/FlowsApi
16201
- * @version 144.0.0
16457
+ * @version 147.0.0
16202
16458
  */
16203
16459
 
16204
16460
  /**
@@ -16269,7 +16525,7 @@ class GamificationApi {
16269
16525
  /**
16270
16526
  * Gamification service.
16271
16527
  * @module purecloud-platform-client-v2/api/GamificationApi
16272
- * @version 144.0.0
16528
+ * @version 147.0.0
16273
16529
  */
16274
16530
 
16275
16531
  /**
@@ -18000,7 +18256,7 @@ class GeneralDataProtectionRegulationApi {
18000
18256
  /**
18001
18257
  * GeneralDataProtectionRegulation service.
18002
18258
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
18003
- * @version 144.0.0
18259
+ * @version 147.0.0
18004
18260
  */
18005
18261
 
18006
18262
  /**
@@ -18130,7 +18386,7 @@ class GeolocationApi {
18130
18386
  /**
18131
18387
  * Geolocation service.
18132
18388
  * @module purecloud-platform-client-v2/api/GeolocationApi
18133
- * @version 144.0.0
18389
+ * @version 147.0.0
18134
18390
  */
18135
18391
 
18136
18392
  /**
@@ -18261,7 +18517,7 @@ class GreetingsApi {
18261
18517
  /**
18262
18518
  * Greetings service.
18263
18519
  * @module purecloud-platform-client-v2/api/GreetingsApi
18264
- * @version 144.0.0
18520
+ * @version 147.0.0
18265
18521
  */
18266
18522
 
18267
18523
  /**
@@ -18716,7 +18972,7 @@ class GroupsApi {
18716
18972
  /**
18717
18973
  * Groups service.
18718
18974
  * @module purecloud-platform-client-v2/api/GroupsApi
18719
- * @version 144.0.0
18975
+ * @version 147.0.0
18720
18976
  */
18721
18977
 
18722
18978
  /**
@@ -19121,7 +19377,7 @@ class IdentityProviderApi {
19121
19377
  /**
19122
19378
  * IdentityProvider service.
19123
19379
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
19124
- * @version 144.0.0
19380
+ * @version 147.0.0
19125
19381
  */
19126
19382
 
19127
19383
  /**
@@ -19877,7 +20133,7 @@ class IntegrationsApi {
19877
20133
  /**
19878
20134
  * Integrations service.
19879
20135
  * @module purecloud-platform-client-v2/api/IntegrationsApi
19880
- * @version 144.0.0
20136
+ * @version 147.0.0
19881
20137
  */
19882
20138
 
19883
20139
  /**
@@ -21554,7 +21810,7 @@ class JourneyApi {
21554
21810
  /**
21555
21811
  * Journey service.
21556
21812
  * @module purecloud-platform-client-v2/api/JourneyApi
21557
- * @version 144.0.0
21813
+ * @version 147.0.0
21558
21814
  */
21559
21815
 
21560
21816
  /**
@@ -22265,7 +22521,7 @@ class KnowledgeApi {
22265
22521
  /**
22266
22522
  * Knowledge service.
22267
22523
  * @module purecloud-platform-client-v2/api/KnowledgeApi
22268
- * @version 144.0.0
22524
+ * @version 147.0.0
22269
22525
  */
22270
22526
 
22271
22527
  /**
@@ -22305,6 +22561,191 @@ class KnowledgeApi {
22305
22561
  );
22306
22562
  }
22307
22563
 
22564
+ /**
22565
+ * Delete category
22566
+ *
22567
+ * @param {String} knowledgeBaseId Knowledge base ID
22568
+ * @param {String} categoryId Category ID
22569
+ */
22570
+ deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
22571
+ // verify the required parameter 'knowledgeBaseId' is set
22572
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22573
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
22574
+ }
22575
+ // verify the required parameter 'categoryId' is set
22576
+ if (categoryId === undefined || categoryId === null) {
22577
+ throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
22578
+ }
22579
+
22580
+ return this.apiClient.callApi(
22581
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
22582
+ 'DELETE',
22583
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
22584
+ { },
22585
+ { },
22586
+ { },
22587
+ null,
22588
+ ['PureCloud OAuth'],
22589
+ ['application/json'],
22590
+ ['application/json']
22591
+ );
22592
+ }
22593
+
22594
+ /**
22595
+ * Delete document.
22596
+ *
22597
+ * @param {String} knowledgeBaseId Knowledge base ID.
22598
+ * @param {String} documentId Document ID.
22599
+ */
22600
+ deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
22601
+ // verify the required parameter 'knowledgeBaseId' is set
22602
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22603
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
22604
+ }
22605
+ // verify the required parameter 'documentId' is set
22606
+ if (documentId === undefined || documentId === null) {
22607
+ throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
22608
+ }
22609
+
22610
+ return this.apiClient.callApi(
22611
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
22612
+ 'DELETE',
22613
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
22614
+ { },
22615
+ { },
22616
+ { },
22617
+ null,
22618
+ ['PureCloud OAuth'],
22619
+ ['application/json'],
22620
+ ['application/json']
22621
+ );
22622
+ }
22623
+
22624
+ /**
22625
+ * Delete a variation for a document.
22626
+ *
22627
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
22628
+ * @param {String} documentId Globally unique identifier for a document.
22629
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
22630
+ */
22631
+ deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
22632
+ // verify the required parameter 'documentVariationId' is set
22633
+ if (documentVariationId === undefined || documentVariationId === null) {
22634
+ throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
22635
+ }
22636
+ // verify the required parameter 'documentId' is set
22637
+ if (documentId === undefined || documentId === null) {
22638
+ throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
22639
+ }
22640
+ // verify the required parameter 'knowledgeBaseId' is set
22641
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22642
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
22643
+ }
22644
+
22645
+ return this.apiClient.callApi(
22646
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
22647
+ 'DELETE',
22648
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
22649
+ { },
22650
+ { },
22651
+ { },
22652
+ null,
22653
+ ['PureCloud OAuth'],
22654
+ ['application/json'],
22655
+ ['application/json']
22656
+ );
22657
+ }
22658
+
22659
+ /**
22660
+ * Delete export job
22661
+ *
22662
+ * @param {String} knowledgeBaseId Knowledge base ID
22663
+ * @param {String} exportJobId Export job ID
22664
+ */
22665
+ deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
22666
+ // verify the required parameter 'knowledgeBaseId' is set
22667
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22668
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
22669
+ }
22670
+ // verify the required parameter 'exportJobId' is set
22671
+ if (exportJobId === undefined || exportJobId === null) {
22672
+ throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
22673
+ }
22674
+
22675
+ return this.apiClient.callApi(
22676
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
22677
+ 'DELETE',
22678
+ { 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
22679
+ { },
22680
+ { },
22681
+ { },
22682
+ null,
22683
+ ['PureCloud OAuth'],
22684
+ ['application/json'],
22685
+ ['application/json']
22686
+ );
22687
+ }
22688
+
22689
+ /**
22690
+ * Delete import job
22691
+ *
22692
+ * @param {String} knowledgeBaseId Knowledge base ID
22693
+ * @param {String} importJobId Import job ID
22694
+ */
22695
+ deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
22696
+ // verify the required parameter 'knowledgeBaseId' is set
22697
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22698
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
22699
+ }
22700
+ // verify the required parameter 'importJobId' is set
22701
+ if (importJobId === undefined || importJobId === null) {
22702
+ throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
22703
+ }
22704
+
22705
+ return this.apiClient.callApi(
22706
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
22707
+ 'DELETE',
22708
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
22709
+ { },
22710
+ { },
22711
+ { },
22712
+ null,
22713
+ ['PureCloud OAuth'],
22714
+ ['application/json'],
22715
+ ['application/json']
22716
+ );
22717
+ }
22718
+
22719
+ /**
22720
+ * Delete label
22721
+ *
22722
+ * @param {String} knowledgeBaseId Knowledge base ID
22723
+ * @param {String} labelId Label ID
22724
+ */
22725
+ deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
22726
+ // verify the required parameter 'knowledgeBaseId' is set
22727
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22728
+ throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
22729
+ }
22730
+ // verify the required parameter 'labelId' is set
22731
+ if (labelId === undefined || labelId === null) {
22732
+ throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
22733
+ }
22734
+
22735
+ return this.apiClient.callApi(
22736
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
22737
+ 'DELETE',
22738
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
22739
+ { },
22740
+ { },
22741
+ { },
22742
+ null,
22743
+ ['PureCloud OAuth'],
22744
+ ['application/json'],
22745
+ ['application/json']
22746
+ );
22747
+ }
22748
+
22308
22749
  /**
22309
22750
  * Delete category
22310
22751
  *
@@ -22410,6 +22851,104 @@ class KnowledgeApi {
22410
22851
  );
22411
22852
  }
22412
22853
 
22854
+ /**
22855
+ * Get categories
22856
+ *
22857
+ * @param {String} sessionId Knowledge guest session ID.
22858
+ * @param {Object} opts Optional parameters
22859
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
22860
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22861
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22862
+ * @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
22863
+ * @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
22864
+ * @param {String} opts.name Filter to return the categories that starts with the given category name.
22865
+ * @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
22866
+ * @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.
22867
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
22868
+ */
22869
+ getKnowledgeGuestSessionCategories(sessionId, opts) {
22870
+ opts = opts || {};
22871
+
22872
+ // verify the required parameter 'sessionId' is set
22873
+ if (sessionId === undefined || sessionId === null) {
22874
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
22875
+ }
22876
+
22877
+ return this.apiClient.callApi(
22878
+ '/api/v2/knowledge/guest/sessions/{sessionId}/categories',
22879
+ 'GET',
22880
+ { 'sessionId': sessionId },
22881
+ { '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'] },
22882
+ { },
22883
+ { },
22884
+ null,
22885
+ ['PureCloud OAuth'],
22886
+ ['application/json'],
22887
+ ['application/json']
22888
+ );
22889
+ }
22890
+
22891
+ /**
22892
+ * Get a knowledge document by ID.
22893
+ *
22894
+ * @param {String} sessionId Knowledge guest session ID.
22895
+ * @param {String} documentId Document ID
22896
+ */
22897
+ getKnowledgeGuestSessionDocument(sessionId, documentId) {
22898
+ // verify the required parameter 'sessionId' is set
22899
+ if (sessionId === undefined || sessionId === null) {
22900
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
22901
+ }
22902
+ // verify the required parameter 'documentId' is set
22903
+ if (documentId === undefined || documentId === null) {
22904
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
22905
+ }
22906
+
22907
+ return this.apiClient.callApi(
22908
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
22909
+ 'GET',
22910
+ { 'sessionId': sessionId,'documentId': documentId },
22911
+ { },
22912
+ { },
22913
+ { },
22914
+ null,
22915
+ ['PureCloud OAuth'],
22916
+ ['application/json'],
22917
+ ['application/json']
22918
+ );
22919
+ }
22920
+
22921
+ /**
22922
+ * Get documents.
22923
+ *
22924
+ * @param {String} sessionId Knowledge guest session ID.
22925
+ * @param {Object} opts Optional parameters
22926
+ * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
22927
+ * @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
22928
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22929
+ */
22930
+ getKnowledgeGuestSessionDocuments(sessionId, opts) {
22931
+ opts = opts || {};
22932
+
22933
+ // verify the required parameter 'sessionId' is set
22934
+ if (sessionId === undefined || sessionId === null) {
22935
+ throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
22936
+ }
22937
+
22938
+ return this.apiClient.callApi(
22939
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents',
22940
+ 'GET',
22941
+ { 'sessionId': sessionId },
22942
+ { 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
22943
+ { },
22944
+ { },
22945
+ null,
22946
+ ['PureCloud OAuth'],
22947
+ ['application/json'],
22948
+ ['application/json']
22949
+ );
22950
+ }
22951
+
22413
22952
  /**
22414
22953
  * Get knowledge base
22415
22954
  *
@@ -22435,6 +22974,502 @@ class KnowledgeApi {
22435
22974
  );
22436
22975
  }
22437
22976
 
22977
+ /**
22978
+ * Get categories
22979
+ *
22980
+ * @param {String} knowledgeBaseId Knowledge base ID
22981
+ * @param {Object} opts Optional parameters
22982
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
22983
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22984
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22985
+ * @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
22986
+ * @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
22987
+ * @param {String} opts.name Filter to return the categories that starts with the given category name.
22988
+ * @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
22989
+ * @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.
22990
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
22991
+ */
22992
+ getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
22993
+ opts = opts || {};
22994
+
22995
+ // verify the required parameter 'knowledgeBaseId' is set
22996
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
22997
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
22998
+ }
22999
+
23000
+ return this.apiClient.callApi(
23001
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
23002
+ 'GET',
23003
+ { 'knowledgeBaseId': knowledgeBaseId },
23004
+ { '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'] },
23005
+ { },
23006
+ { },
23007
+ null,
23008
+ ['PureCloud OAuth'],
23009
+ ['application/json'],
23010
+ ['application/json']
23011
+ );
23012
+ }
23013
+
23014
+ /**
23015
+ * Get category
23016
+ *
23017
+ * @param {String} knowledgeBaseId Knowledge base ID
23018
+ * @param {String} categoryId Category ID
23019
+ */
23020
+ getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
23021
+ // verify the required parameter 'knowledgeBaseId' is set
23022
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23023
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
23024
+ }
23025
+ // verify the required parameter 'categoryId' is set
23026
+ if (categoryId === undefined || categoryId === null) {
23027
+ throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
23028
+ }
23029
+
23030
+ return this.apiClient.callApi(
23031
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
23032
+ 'GET',
23033
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
23034
+ { },
23035
+ { },
23036
+ { },
23037
+ null,
23038
+ ['PureCloud OAuth'],
23039
+ ['application/json'],
23040
+ ['application/json']
23041
+ );
23042
+ }
23043
+
23044
+ /**
23045
+ * Get document.
23046
+ *
23047
+ * @param {String} knowledgeBaseId Knowledge base ID.
23048
+ * @param {String} documentId Document ID.
23049
+ * @param {Object} opts Optional parameters
23050
+ * @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.
23051
+ * @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.
23052
+ */
23053
+ getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
23054
+ opts = opts || {};
23055
+
23056
+ // verify the required parameter 'knowledgeBaseId' is set
23057
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23058
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
23059
+ }
23060
+ // verify the required parameter 'documentId' is set
23061
+ if (documentId === undefined || documentId === null) {
23062
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
23063
+ }
23064
+
23065
+ return this.apiClient.callApi(
23066
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
23067
+ 'GET',
23068
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
23069
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
23070
+ { },
23071
+ { },
23072
+ null,
23073
+ ['PureCloud OAuth'],
23074
+ ['application/json'],
23075
+ ['application/json']
23076
+ );
23077
+ }
23078
+
23079
+ /**
23080
+ * Get a variation for a document.
23081
+ *
23082
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
23083
+ * @param {String} documentId Globally unique identifier for a document.
23084
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
23085
+ * @param {Object} opts Optional parameters
23086
+ * @param {Object} opts.documentState The state of the document.
23087
+ */
23088
+ getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
23089
+ opts = opts || {};
23090
+
23091
+ // verify the required parameter 'documentVariationId' is set
23092
+ if (documentVariationId === undefined || documentVariationId === null) {
23093
+ throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
23094
+ }
23095
+ // verify the required parameter 'documentId' is set
23096
+ if (documentId === undefined || documentId === null) {
23097
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
23098
+ }
23099
+ // verify the required parameter 'knowledgeBaseId' is set
23100
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23101
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
23102
+ }
23103
+
23104
+ return this.apiClient.callApi(
23105
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
23106
+ 'GET',
23107
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
23108
+ { 'documentState': opts['documentState'] },
23109
+ { },
23110
+ { },
23111
+ null,
23112
+ ['PureCloud OAuth'],
23113
+ ['application/json'],
23114
+ ['application/json']
23115
+ );
23116
+ }
23117
+
23118
+ /**
23119
+ * Get variations for a document.
23120
+ *
23121
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23122
+ * @param {String} documentId Globally unique identifier for the document.
23123
+ * @param {Object} opts Optional parameters
23124
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23125
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23126
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23127
+ * @param {Object} opts.documentState The state of the document.
23128
+ */
23129
+ getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
23130
+ opts = opts || {};
23131
+
23132
+ // verify the required parameter 'knowledgeBaseId' is set
23133
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23134
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
23135
+ }
23136
+ // verify the required parameter 'documentId' is set
23137
+ if (documentId === undefined || documentId === null) {
23138
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
23139
+ }
23140
+
23141
+ return this.apiClient.callApi(
23142
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
23143
+ 'GET',
23144
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
23145
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
23146
+ { },
23147
+ { },
23148
+ null,
23149
+ ['PureCloud OAuth'],
23150
+ ['application/json'],
23151
+ ['application/json']
23152
+ );
23153
+ }
23154
+
23155
+ /**
23156
+ * Get document version.
23157
+ *
23158
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23159
+ * @param {String} documentId Globally unique identifier for the document.
23160
+ * @param {String} versionId Globally unique identifier for the document version.
23161
+ * @param {Object} opts Optional parameters
23162
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
23163
+ */
23164
+ getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
23165
+ opts = opts || {};
23166
+
23167
+ // verify the required parameter 'knowledgeBaseId' is set
23168
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23169
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
23170
+ }
23171
+ // verify the required parameter 'documentId' is set
23172
+ if (documentId === undefined || documentId === null) {
23173
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
23174
+ }
23175
+ // verify the required parameter 'versionId' is set
23176
+ if (versionId === undefined || versionId === null) {
23177
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
23178
+ }
23179
+
23180
+ return this.apiClient.callApi(
23181
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
23182
+ 'GET',
23183
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
23184
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
23185
+ { },
23186
+ { },
23187
+ null,
23188
+ ['PureCloud OAuth'],
23189
+ ['application/json'],
23190
+ ['application/json']
23191
+ );
23192
+ }
23193
+
23194
+ /**
23195
+ * Get variation for the given document version.
23196
+ *
23197
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23198
+ * @param {String} documentId Globally unique identifier for the document.
23199
+ * @param {String} versionId Globally unique identifier for the document version.
23200
+ * @param {String} variationId Globally unique identifier for the document version variation.
23201
+ */
23202
+ getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
23203
+ // verify the required parameter 'knowledgeBaseId' is set
23204
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23205
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
23206
+ }
23207
+ // verify the required parameter 'documentId' is set
23208
+ if (documentId === undefined || documentId === null) {
23209
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
23210
+ }
23211
+ // verify the required parameter 'versionId' is set
23212
+ if (versionId === undefined || versionId === null) {
23213
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
23214
+ }
23215
+ // verify the required parameter 'variationId' is set
23216
+ if (variationId === undefined || variationId === null) {
23217
+ throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
23218
+ }
23219
+
23220
+ return this.apiClient.callApi(
23221
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
23222
+ 'GET',
23223
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
23224
+ { },
23225
+ { },
23226
+ { },
23227
+ null,
23228
+ ['PureCloud OAuth'],
23229
+ ['application/json'],
23230
+ ['application/json']
23231
+ );
23232
+ }
23233
+
23234
+ /**
23235
+ * Get variations for the given document version.
23236
+ *
23237
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23238
+ * @param {String} documentId Globally unique identifier for the document.
23239
+ * @param {String} versionId Globally unique identifier for the document version.
23240
+ * @param {Object} opts Optional parameters
23241
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23242
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23243
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23244
+ */
23245
+ getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
23246
+ opts = opts || {};
23247
+
23248
+ // verify the required parameter 'knowledgeBaseId' is set
23249
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23250
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
23251
+ }
23252
+ // verify the required parameter 'documentId' is set
23253
+ if (documentId === undefined || documentId === null) {
23254
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
23255
+ }
23256
+ // verify the required parameter 'versionId' is set
23257
+ if (versionId === undefined || versionId === null) {
23258
+ throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
23259
+ }
23260
+
23261
+ return this.apiClient.callApi(
23262
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
23263
+ 'GET',
23264
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
23265
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
23266
+ { },
23267
+ { },
23268
+ null,
23269
+ ['PureCloud OAuth'],
23270
+ ['application/json'],
23271
+ ['application/json']
23272
+ );
23273
+ }
23274
+
23275
+ /**
23276
+ * Get document versions.
23277
+ *
23278
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
23279
+ * @param {String} documentId Globally unique identifier for the document.
23280
+ * @param {Object} opts Optional parameters
23281
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23282
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23283
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23284
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
23285
+ */
23286
+ getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
23287
+ opts = opts || {};
23288
+
23289
+ // verify the required parameter 'knowledgeBaseId' is set
23290
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23291
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
23292
+ }
23293
+ // verify the required parameter 'documentId' is set
23294
+ if (documentId === undefined || documentId === null) {
23295
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
23296
+ }
23297
+
23298
+ return this.apiClient.callApi(
23299
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
23300
+ 'GET',
23301
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
23302
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
23303
+ { },
23304
+ { },
23305
+ null,
23306
+ ['PureCloud OAuth'],
23307
+ ['application/json'],
23308
+ ['application/json']
23309
+ );
23310
+ }
23311
+
23312
+ /**
23313
+ * Get documents.
23314
+ *
23315
+ * @param {String} knowledgeBaseId Knowledge base ID
23316
+ * @param {Object} opts Optional parameters
23317
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23318
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23319
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23320
+ * @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
23321
+ * @param {Array.<String>} opts.documentId Retrieves the specified documents, comma separated values expected.
23322
+ * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
23323
+ * @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
23324
+ * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
23325
+ * @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
23326
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
23327
+ */
23328
+ getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
23329
+ opts = opts || {};
23330
+
23331
+ // verify the required parameter 'knowledgeBaseId' is set
23332
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23333
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
23334
+ }
23335
+
23336
+ return this.apiClient.callApi(
23337
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
23338
+ 'GET',
23339
+ { 'knowledgeBaseId': knowledgeBaseId },
23340
+ { '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') },
23341
+ { },
23342
+ { },
23343
+ null,
23344
+ ['PureCloud OAuth'],
23345
+ ['application/json'],
23346
+ ['application/json']
23347
+ );
23348
+ }
23349
+
23350
+ /**
23351
+ * Get export job report
23352
+ *
23353
+ * @param {String} knowledgeBaseId Knowledge base ID
23354
+ * @param {String} exportJobId Export job ID
23355
+ */
23356
+ getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
23357
+ // verify the required parameter 'knowledgeBaseId' is set
23358
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23359
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
23360
+ }
23361
+ // verify the required parameter 'exportJobId' is set
23362
+ if (exportJobId === undefined || exportJobId === null) {
23363
+ throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
23364
+ }
23365
+
23366
+ return this.apiClient.callApi(
23367
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
23368
+ 'GET',
23369
+ { 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
23370
+ { },
23371
+ { },
23372
+ { },
23373
+ null,
23374
+ ['PureCloud OAuth'],
23375
+ ['application/json'],
23376
+ ['application/json']
23377
+ );
23378
+ }
23379
+
23380
+ /**
23381
+ * Get import job report
23382
+ *
23383
+ * @param {String} knowledgeBaseId Knowledge base ID
23384
+ * @param {String} importJobId Import job ID
23385
+ */
23386
+ getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
23387
+ // verify the required parameter 'knowledgeBaseId' is set
23388
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23389
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
23390
+ }
23391
+ // verify the required parameter 'importJobId' is set
23392
+ if (importJobId === undefined || importJobId === null) {
23393
+ throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
23394
+ }
23395
+
23396
+ return this.apiClient.callApi(
23397
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
23398
+ 'GET',
23399
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
23400
+ { },
23401
+ { },
23402
+ { },
23403
+ null,
23404
+ ['PureCloud OAuth'],
23405
+ ['application/json'],
23406
+ ['application/json']
23407
+ );
23408
+ }
23409
+
23410
+ /**
23411
+ * Get label
23412
+ *
23413
+ * @param {String} knowledgeBaseId Knowledge base ID
23414
+ * @param {String} labelId Label ID
23415
+ */
23416
+ getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
23417
+ // verify the required parameter 'knowledgeBaseId' is set
23418
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23419
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
23420
+ }
23421
+ // verify the required parameter 'labelId' is set
23422
+ if (labelId === undefined || labelId === null) {
23423
+ throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
23424
+ }
23425
+
23426
+ return this.apiClient.callApi(
23427
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
23428
+ 'GET',
23429
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
23430
+ { },
23431
+ { },
23432
+ { },
23433
+ null,
23434
+ ['PureCloud OAuth'],
23435
+ ['application/json'],
23436
+ ['application/json']
23437
+ );
23438
+ }
23439
+
23440
+ /**
23441
+ * Get labels
23442
+ *
23443
+ * @param {String} knowledgeBaseId Knowledge base ID
23444
+ * @param {Object} opts Optional parameters
23445
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23446
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23447
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23448
+ * @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
23449
+ * @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
23450
+ */
23451
+ getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
23452
+ opts = opts || {};
23453
+
23454
+ // verify the required parameter 'knowledgeBaseId' is set
23455
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23456
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
23457
+ }
23458
+
23459
+ return this.apiClient.callApi(
23460
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
23461
+ 'GET',
23462
+ { 'knowledgeBaseId': knowledgeBaseId },
23463
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
23464
+ { },
23465
+ { },
23466
+ null,
23467
+ ['PureCloud OAuth'],
23468
+ ['application/json'],
23469
+ ['application/json']
23470
+ );
23471
+ }
23472
+
22438
23473
  /**
22439
23474
  * Get categories
22440
23475
  *
@@ -22693,6 +23728,108 @@ class KnowledgeApi {
22693
23728
  );
22694
23729
  }
22695
23730
 
23731
+ /**
23732
+ * Get knowledge base unanswered group for a particular groupId
23733
+ *
23734
+ * @param {String} knowledgeBaseId Knowledge base ID
23735
+ * @param {String} groupId The ID of the group to be retrieved.
23736
+ * @param {Object} opts Optional parameters
23737
+ * @param {Object} opts.app The app value to be used for filtering phrases.
23738
+ */
23739
+ getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
23740
+ opts = opts || {};
23741
+
23742
+ // verify the required parameter 'knowledgeBaseId' is set
23743
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23744
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
23745
+ }
23746
+ // verify the required parameter 'groupId' is set
23747
+ if (groupId === undefined || groupId === null) {
23748
+ throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
23749
+ }
23750
+
23751
+ return this.apiClient.callApi(
23752
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
23753
+ 'GET',
23754
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
23755
+ { 'app': opts['app'] },
23756
+ { },
23757
+ { },
23758
+ null,
23759
+ ['PureCloud OAuth'],
23760
+ ['application/json'],
23761
+ ['application/json']
23762
+ );
23763
+ }
23764
+
23765
+ /**
23766
+ * Get knowledge base unanswered phrase group for a particular phraseGroupId
23767
+ *
23768
+ * @param {String} knowledgeBaseId Knowledge base ID
23769
+ * @param {String} groupId The ID of the group to be retrieved.
23770
+ * @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
23771
+ * @param {Object} opts Optional parameters
23772
+ * @param {Object} opts.app The app value to be used for filtering phrases.
23773
+ */
23774
+ getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
23775
+ opts = opts || {};
23776
+
23777
+ // verify the required parameter 'knowledgeBaseId' is set
23778
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23779
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
23780
+ }
23781
+ // verify the required parameter 'groupId' is set
23782
+ if (groupId === undefined || groupId === null) {
23783
+ throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
23784
+ }
23785
+ // verify the required parameter 'phraseGroupId' is set
23786
+ if (phraseGroupId === undefined || phraseGroupId === null) {
23787
+ throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
23788
+ }
23789
+
23790
+ return this.apiClient.callApi(
23791
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
23792
+ 'GET',
23793
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
23794
+ { 'app': opts['app'] },
23795
+ { },
23796
+ { },
23797
+ null,
23798
+ ['PureCloud OAuth'],
23799
+ ['application/json'],
23800
+ ['application/json']
23801
+ );
23802
+ }
23803
+
23804
+ /**
23805
+ * Get knowledge base unanswered groups
23806
+ *
23807
+ * @param {String} knowledgeBaseId Knowledge base ID
23808
+ * @param {Object} opts Optional parameters
23809
+ * @param {Object} opts.app The app value to be used for filtering phrases.
23810
+ */
23811
+ getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
23812
+ opts = opts || {};
23813
+
23814
+ // verify the required parameter 'knowledgeBaseId' is set
23815
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23816
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
23817
+ }
23818
+
23819
+ return this.apiClient.callApi(
23820
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
23821
+ 'GET',
23822
+ { 'knowledgeBaseId': knowledgeBaseId },
23823
+ { 'app': opts['app'] },
23824
+ { },
23825
+ { },
23826
+ null,
23827
+ ['PureCloud OAuth'],
23828
+ ['application/json'],
23829
+ ['application/json']
23830
+ );
23831
+ }
23832
+
22696
23833
  /**
22697
23834
  * Get knowledge bases
22698
23835
  *
@@ -22725,6 +23862,41 @@ class KnowledgeApi {
22725
23862
  );
22726
23863
  }
22727
23864
 
23865
+ /**
23866
+ * Update search result.
23867
+ *
23868
+ * @param {String} sessionId Knowledge guest session ID.
23869
+ * @param {String} searchId Search Result ID
23870
+ * @param {Object} body
23871
+ */
23872
+ patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
23873
+ // verify the required parameter 'sessionId' is set
23874
+ if (sessionId === undefined || sessionId === null) {
23875
+ throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
23876
+ }
23877
+ // verify the required parameter 'searchId' is set
23878
+ if (searchId === undefined || searchId === null) {
23879
+ throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
23880
+ }
23881
+ // verify the required parameter 'body' is set
23882
+ if (body === undefined || body === null) {
23883
+ throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
23884
+ }
23885
+
23886
+ return this.apiClient.callApi(
23887
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
23888
+ 'PATCH',
23889
+ { 'sessionId': sessionId,'searchId': searchId },
23890
+ { },
23891
+ { },
23892
+ { },
23893
+ body,
23894
+ ['PureCloud OAuth'],
23895
+ ['application/json'],
23896
+ ['application/json']
23897
+ );
23898
+ }
23899
+
22728
23900
  /**
22729
23901
  * Update knowledge base
22730
23902
  *
@@ -22755,6 +23927,220 @@ class KnowledgeApi {
22755
23927
  );
22756
23928
  }
22757
23929
 
23930
+ /**
23931
+ * Update category
23932
+ *
23933
+ * @param {String} knowledgeBaseId Knowledge base ID
23934
+ * @param {String} categoryId Category ID
23935
+ * @param {Object} body
23936
+ */
23937
+ patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
23938
+ // verify the required parameter 'knowledgeBaseId' is set
23939
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23940
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
23941
+ }
23942
+ // verify the required parameter 'categoryId' is set
23943
+ if (categoryId === undefined || categoryId === null) {
23944
+ throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
23945
+ }
23946
+ // verify the required parameter 'body' is set
23947
+ if (body === undefined || body === null) {
23948
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
23949
+ }
23950
+
23951
+ return this.apiClient.callApi(
23952
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
23953
+ 'PATCH',
23954
+ { 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
23955
+ { },
23956
+ { },
23957
+ { },
23958
+ body,
23959
+ ['PureCloud OAuth'],
23960
+ ['application/json'],
23961
+ ['application/json']
23962
+ );
23963
+ }
23964
+
23965
+ /**
23966
+ * Update document.
23967
+ *
23968
+ * @param {String} knowledgeBaseId Knowledge base ID.
23969
+ * @param {String} documentId Document ID.
23970
+ * @param {Object} body
23971
+ */
23972
+ patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
23973
+ // verify the required parameter 'knowledgeBaseId' is set
23974
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
23975
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
23976
+ }
23977
+ // verify the required parameter 'documentId' is set
23978
+ if (documentId === undefined || documentId === null) {
23979
+ throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
23980
+ }
23981
+ // verify the required parameter 'body' is set
23982
+ if (body === undefined || body === null) {
23983
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
23984
+ }
23985
+
23986
+ return this.apiClient.callApi(
23987
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
23988
+ 'PATCH',
23989
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
23990
+ { },
23991
+ { },
23992
+ { },
23993
+ body,
23994
+ ['PureCloud OAuth'],
23995
+ ['application/json'],
23996
+ ['application/json']
23997
+ );
23998
+ }
23999
+
24000
+ /**
24001
+ * Update a variation for a document.
24002
+ *
24003
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
24004
+ * @param {String} documentId Globally unique identifier for a document.
24005
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
24006
+ * @param {Object} body
24007
+ */
24008
+ patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
24009
+ // verify the required parameter 'documentVariationId' is set
24010
+ if (documentVariationId === undefined || documentVariationId === null) {
24011
+ throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
24012
+ }
24013
+ // verify the required parameter 'documentId' is set
24014
+ if (documentId === undefined || documentId === null) {
24015
+ throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
24016
+ }
24017
+ // verify the required parameter 'knowledgeBaseId' is set
24018
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24019
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
24020
+ }
24021
+ // verify the required parameter 'body' is set
24022
+ if (body === undefined || body === null) {
24023
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
24024
+ }
24025
+
24026
+ return this.apiClient.callApi(
24027
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
24028
+ 'PATCH',
24029
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
24030
+ { },
24031
+ { },
24032
+ { },
24033
+ body,
24034
+ ['PureCloud OAuth'],
24035
+ ['application/json'],
24036
+ ['application/json']
24037
+ );
24038
+ }
24039
+
24040
+ /**
24041
+ * Update search result.
24042
+ *
24043
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
24044
+ * @param {String} searchId Search Result ID
24045
+ * @param {Object} opts Optional parameters
24046
+ * @param {Object} opts.body
24047
+ */
24048
+ patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
24049
+ opts = opts || {};
24050
+
24051
+ // verify the required parameter 'knowledgeBaseId' is set
24052
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24053
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
24054
+ }
24055
+ // verify the required parameter 'searchId' is set
24056
+ if (searchId === undefined || searchId === null) {
24057
+ throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
24058
+ }
24059
+
24060
+ return this.apiClient.callApi(
24061
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
24062
+ 'PATCH',
24063
+ { 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
24064
+ { },
24065
+ { },
24066
+ { },
24067
+ opts['body'],
24068
+ ['PureCloud OAuth'],
24069
+ ['application/json'],
24070
+ ['application/json']
24071
+ );
24072
+ }
24073
+
24074
+ /**
24075
+ * Start import job
24076
+ *
24077
+ * @param {String} knowledgeBaseId Knowledge base ID
24078
+ * @param {String} importJobId Import job ID
24079
+ * @param {Object} body
24080
+ */
24081
+ patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
24082
+ // verify the required parameter 'knowledgeBaseId' is set
24083
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24084
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
24085
+ }
24086
+ // verify the required parameter 'importJobId' is set
24087
+ if (importJobId === undefined || importJobId === null) {
24088
+ throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
24089
+ }
24090
+ // verify the required parameter 'body' is set
24091
+ if (body === undefined || body === null) {
24092
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
24093
+ }
24094
+
24095
+ return this.apiClient.callApi(
24096
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
24097
+ 'PATCH',
24098
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
24099
+ { },
24100
+ { },
24101
+ { },
24102
+ body,
24103
+ ['PureCloud OAuth'],
24104
+ ['application/json'],
24105
+ ['application/json']
24106
+ );
24107
+ }
24108
+
24109
+ /**
24110
+ * Update label
24111
+ *
24112
+ * @param {String} knowledgeBaseId Knowledge base ID
24113
+ * @param {String} labelId Label ID
24114
+ * @param {Object} body
24115
+ */
24116
+ patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
24117
+ // verify the required parameter 'knowledgeBaseId' is set
24118
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24119
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
24120
+ }
24121
+ // verify the required parameter 'labelId' is set
24122
+ if (labelId === undefined || labelId === null) {
24123
+ throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
24124
+ }
24125
+ // verify the required parameter 'body' is set
24126
+ if (body === undefined || body === null) {
24127
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
24128
+ }
24129
+
24130
+ return this.apiClient.callApi(
24131
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
24132
+ 'PATCH',
24133
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
24134
+ { },
24135
+ { },
24136
+ { },
24137
+ body,
24138
+ ['PureCloud OAuth'],
24139
+ ['application/json'],
24140
+ ['application/json']
24141
+ );
24142
+ }
24143
+
22758
24144
  /**
22759
24145
  * Update category
22760
24146
  *
@@ -22910,6 +24296,46 @@ class KnowledgeApi {
22910
24296
  );
22911
24297
  }
22912
24298
 
24299
+ /**
24300
+ * Update a Knowledge base unanswered phrase group
24301
+ *
24302
+ * @param {String} knowledgeBaseId Knowledge base ID
24303
+ * @param {String} groupId The ID of the group to be updated.
24304
+ * @param {String} phraseGroupId The ID of the phraseGroup to be updated.
24305
+ * @param {Object} body Request body of the update unanswered group endpoint.
24306
+ */
24307
+ patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
24308
+ // verify the required parameter 'knowledgeBaseId' is set
24309
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24310
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
24311
+ }
24312
+ // verify the required parameter 'groupId' is set
24313
+ if (groupId === undefined || groupId === null) {
24314
+ throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
24315
+ }
24316
+ // verify the required parameter 'phraseGroupId' is set
24317
+ if (phraseGroupId === undefined || phraseGroupId === null) {
24318
+ throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
24319
+ }
24320
+ // verify the required parameter 'body' is set
24321
+ if (body === undefined || body === null) {
24322
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
24323
+ }
24324
+
24325
+ return this.apiClient.callApi(
24326
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
24327
+ 'PATCH',
24328
+ { 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
24329
+ { },
24330
+ { },
24331
+ { },
24332
+ body,
24333
+ ['PureCloud OAuth'],
24334
+ ['application/json'],
24335
+ ['application/json']
24336
+ );
24337
+ }
24338
+
22913
24339
  /**
22914
24340
  * Creates a presigned URL for uploading a knowledge import file with a set of documents
22915
24341
  *
@@ -22935,6 +24361,369 @@ class KnowledgeApi {
22935
24361
  );
22936
24362
  }
22937
24363
 
24364
+ /**
24365
+ * Search the documents in a guest session.
24366
+ *
24367
+ * @param {String} sessionId Knowledge guest session ID.
24368
+ * @param {Object} opts Optional parameters
24369
+ * @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
24370
+ * @param {Object} opts.body
24371
+ */
24372
+ postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
24373
+ opts = opts || {};
24374
+
24375
+ // verify the required parameter 'sessionId' is set
24376
+ if (sessionId === undefined || sessionId === null) {
24377
+ throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
24378
+ }
24379
+
24380
+ return this.apiClient.callApi(
24381
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
24382
+ 'POST',
24383
+ { 'sessionId': sessionId },
24384
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
24385
+ { },
24386
+ { },
24387
+ opts['body'],
24388
+ ['PureCloud OAuth'],
24389
+ ['application/json'],
24390
+ ['application/json']
24391
+ );
24392
+ }
24393
+
24394
+ /**
24395
+ * Query the knowledge documents to provide suggestions for auto completion.
24396
+ *
24397
+ * @param {String} sessionId Knowledge guest session ID.
24398
+ * @param {Object} opts Optional parameters
24399
+ * @param {Object} opts.body
24400
+ */
24401
+ postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
24402
+ opts = opts || {};
24403
+
24404
+ // verify the required parameter 'sessionId' is set
24405
+ if (sessionId === undefined || sessionId === null) {
24406
+ throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
24407
+ }
24408
+
24409
+ return this.apiClient.callApi(
24410
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
24411
+ 'POST',
24412
+ { 'sessionId': sessionId },
24413
+ { },
24414
+ { },
24415
+ { },
24416
+ opts['body'],
24417
+ ['PureCloud OAuth'],
24418
+ ['application/json'],
24419
+ ['application/json']
24420
+ );
24421
+ }
24422
+
24423
+ /**
24424
+ * Create guest session
24425
+ *
24426
+ * @param {Object} body
24427
+ */
24428
+ postKnowledgeGuestSessions(body) {
24429
+ // verify the required parameter 'body' is set
24430
+ if (body === undefined || body === null) {
24431
+ throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
24432
+ }
24433
+
24434
+ return this.apiClient.callApi(
24435
+ '/api/v2/knowledge/guest/sessions',
24436
+ 'POST',
24437
+ { },
24438
+ { },
24439
+ { },
24440
+ { },
24441
+ body,
24442
+ ['PureCloud OAuth'],
24443
+ ['application/json'],
24444
+ ['application/json']
24445
+ );
24446
+ }
24447
+
24448
+ /**
24449
+ * Create new category
24450
+ *
24451
+ * @param {String} knowledgeBaseId Knowledge base ID
24452
+ * @param {Object} body
24453
+ */
24454
+ postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
24455
+ // verify the required parameter 'knowledgeBaseId' is set
24456
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24457
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
24458
+ }
24459
+ // verify the required parameter 'body' is set
24460
+ if (body === undefined || body === null) {
24461
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
24462
+ }
24463
+
24464
+ return this.apiClient.callApi(
24465
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
24466
+ 'POST',
24467
+ { 'knowledgeBaseId': knowledgeBaseId },
24468
+ { },
24469
+ { },
24470
+ { },
24471
+ body,
24472
+ ['PureCloud OAuth'],
24473
+ ['application/json'],
24474
+ ['application/json']
24475
+ );
24476
+ }
24477
+
24478
+ /**
24479
+ * Create a variation for a document.
24480
+ *
24481
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
24482
+ * @param {String} documentId Globally unique identifier for the document.
24483
+ * @param {Object} body
24484
+ */
24485
+ postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
24486
+ // verify the required parameter 'knowledgeBaseId' is set
24487
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24488
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
24489
+ }
24490
+ // verify the required parameter 'documentId' is set
24491
+ if (documentId === undefined || documentId === null) {
24492
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
24493
+ }
24494
+ // verify the required parameter 'body' is set
24495
+ if (body === undefined || body === null) {
24496
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
24497
+ }
24498
+
24499
+ return this.apiClient.callApi(
24500
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
24501
+ 'POST',
24502
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
24503
+ { },
24504
+ { },
24505
+ { },
24506
+ body,
24507
+ ['PureCloud OAuth'],
24508
+ ['application/json'],
24509
+ ['application/json']
24510
+ );
24511
+ }
24512
+
24513
+ /**
24514
+ * Creates or restores a document version.
24515
+ *
24516
+ * @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
24517
+ * @param {String} documentId Globally unique identifier for the document.
24518
+ * @param {Object} body
24519
+ */
24520
+ postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
24521
+ // verify the required parameter 'knowledgeBaseId' is set
24522
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24523
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
24524
+ }
24525
+ // verify the required parameter 'documentId' is set
24526
+ if (documentId === undefined || documentId === null) {
24527
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
24528
+ }
24529
+ // verify the required parameter 'body' is set
24530
+ if (body === undefined || body === null) {
24531
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
24532
+ }
24533
+
24534
+ return this.apiClient.callApi(
24535
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
24536
+ 'POST',
24537
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
24538
+ { },
24539
+ { },
24540
+ { },
24541
+ body,
24542
+ ['PureCloud OAuth'],
24543
+ ['application/json'],
24544
+ ['application/json']
24545
+ );
24546
+ }
24547
+
24548
+ /**
24549
+ * Create document.
24550
+ *
24551
+ * @param {String} knowledgeBaseId Knowledge base ID
24552
+ * @param {Object} body
24553
+ */
24554
+ postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
24555
+ // verify the required parameter 'knowledgeBaseId' is set
24556
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24557
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
24558
+ }
24559
+ // verify the required parameter 'body' is set
24560
+ if (body === undefined || body === null) {
24561
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
24562
+ }
24563
+
24564
+ return this.apiClient.callApi(
24565
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
24566
+ 'POST',
24567
+ { 'knowledgeBaseId': knowledgeBaseId },
24568
+ { },
24569
+ { },
24570
+ { },
24571
+ body,
24572
+ ['PureCloud OAuth'],
24573
+ ['application/json'],
24574
+ ['application/json']
24575
+ );
24576
+ }
24577
+
24578
+ /**
24579
+ * Search the documents in a knowledge base.
24580
+ *
24581
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
24582
+ * @param {Object} opts Optional parameters
24583
+ * @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
24584
+ * @param {Object} opts.body
24585
+ */
24586
+ postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
24587
+ opts = opts || {};
24588
+
24589
+ // verify the required parameter 'knowledgeBaseId' is set
24590
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24591
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
24592
+ }
24593
+
24594
+ return this.apiClient.callApi(
24595
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
24596
+ 'POST',
24597
+ { 'knowledgeBaseId': knowledgeBaseId },
24598
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
24599
+ { },
24600
+ { },
24601
+ opts['body'],
24602
+ ['PureCloud OAuth'],
24603
+ ['application/json'],
24604
+ ['application/json']
24605
+ );
24606
+ }
24607
+
24608
+ /**
24609
+ * Query the knowledge documents to provide suggestions for auto completion.
24610
+ *
24611
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
24612
+ * @param {Object} opts Optional parameters
24613
+ * @param {Object} opts.body
24614
+ */
24615
+ postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
24616
+ opts = opts || {};
24617
+
24618
+ // verify the required parameter 'knowledgeBaseId' is set
24619
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24620
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
24621
+ }
24622
+
24623
+ return this.apiClient.callApi(
24624
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
24625
+ 'POST',
24626
+ { 'knowledgeBaseId': knowledgeBaseId },
24627
+ { },
24628
+ { },
24629
+ { },
24630
+ opts['body'],
24631
+ ['PureCloud OAuth'],
24632
+ ['application/json'],
24633
+ ['application/json']
24634
+ );
24635
+ }
24636
+
24637
+ /**
24638
+ * Create export job
24639
+ *
24640
+ * @param {String} knowledgeBaseId Knowledge base ID
24641
+ * @param {Object} body
24642
+ */
24643
+ postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
24644
+ // verify the required parameter 'knowledgeBaseId' is set
24645
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24646
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
24647
+ }
24648
+ // verify the required parameter 'body' is set
24649
+ if (body === undefined || body === null) {
24650
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
24651
+ }
24652
+
24653
+ return this.apiClient.callApi(
24654
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
24655
+ 'POST',
24656
+ { 'knowledgeBaseId': knowledgeBaseId },
24657
+ { },
24658
+ { },
24659
+ { },
24660
+ body,
24661
+ ['PureCloud OAuth'],
24662
+ ['application/json'],
24663
+ ['application/json']
24664
+ );
24665
+ }
24666
+
24667
+ /**
24668
+ * Create import job
24669
+ *
24670
+ * @param {String} knowledgeBaseId Knowledge base ID
24671
+ * @param {Object} body
24672
+ */
24673
+ postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
24674
+ // verify the required parameter 'knowledgeBaseId' is set
24675
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24676
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
24677
+ }
24678
+ // verify the required parameter 'body' is set
24679
+ if (body === undefined || body === null) {
24680
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
24681
+ }
24682
+
24683
+ return this.apiClient.callApi(
24684
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
24685
+ 'POST',
24686
+ { 'knowledgeBaseId': knowledgeBaseId },
24687
+ { },
24688
+ { },
24689
+ { },
24690
+ body,
24691
+ ['PureCloud OAuth'],
24692
+ ['application/json'],
24693
+ ['application/json']
24694
+ );
24695
+ }
24696
+
24697
+ /**
24698
+ * Create new label
24699
+ *
24700
+ * @param {String} knowledgeBaseId Knowledge base ID
24701
+ * @param {Object} body
24702
+ */
24703
+ postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
24704
+ // verify the required parameter 'knowledgeBaseId' is set
24705
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
24706
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
24707
+ }
24708
+ // verify the required parameter 'body' is set
24709
+ if (body === undefined || body === null) {
24710
+ throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
24711
+ }
24712
+
24713
+ return this.apiClient.callApi(
24714
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
24715
+ 'POST',
24716
+ { 'knowledgeBaseId': knowledgeBaseId },
24717
+ { },
24718
+ { },
24719
+ { },
24720
+ body,
24721
+ ['PureCloud OAuth'],
24722
+ ['application/json'],
24723
+ ['application/json']
24724
+ );
24725
+ }
24726
+
22938
24727
  /**
22939
24728
  * Create new category
22940
24729
  *
@@ -23165,7 +24954,7 @@ class LanguageUnderstandingApi {
23165
24954
  /**
23166
24955
  * LanguageUnderstanding service.
23167
24956
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
23168
- * @version 144.0.0
24957
+ * @version 147.0.0
23169
24958
  */
23170
24959
 
23171
24960
  /**
@@ -24069,7 +25858,7 @@ class LanguagesApi {
24069
25858
  /**
24070
25859
  * Languages service.
24071
25860
  * @module purecloud-platform-client-v2/api/LanguagesApi
24072
- * @version 144.0.0
25861
+ * @version 147.0.0
24073
25862
  */
24074
25863
 
24075
25864
  /**
@@ -24337,7 +26126,7 @@ class LearningApi {
24337
26126
  /**
24338
26127
  * Learning service.
24339
26128
  * @module purecloud-platform-client-v2/api/LearningApi
24340
- * @version 144.0.0
26129
+ * @version 147.0.0
24341
26130
  */
24342
26131
 
24343
26132
  /**
@@ -25097,7 +26886,7 @@ class LicenseApi {
25097
26886
  /**
25098
26887
  * License service.
25099
26888
  * @module purecloud-platform-client-v2/api/LicenseApi
25100
- * @version 144.0.0
26889
+ * @version 147.0.0
25101
26890
  */
25102
26891
 
25103
26892
  /**
@@ -25335,7 +27124,7 @@ class LocationsApi {
25335
27124
  /**
25336
27125
  * Locations service.
25337
27126
  * @module purecloud-platform-client-v2/api/LocationsApi
25338
- * @version 144.0.0
27127
+ * @version 147.0.0
25339
27128
  */
25340
27129
 
25341
27130
  /**
@@ -25571,7 +27360,7 @@ class MessagingApi {
25571
27360
  /**
25572
27361
  * Messaging service.
25573
27362
  * @module purecloud-platform-client-v2/api/MessagingApi
25574
- * @version 144.0.0
27363
+ * @version 147.0.0
25575
27364
  */
25576
27365
 
25577
27366
  /**
@@ -25722,7 +27511,7 @@ class MobileDevicesApi {
25722
27511
  /**
25723
27512
  * MobileDevices service.
25724
27513
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
25725
- * @version 144.0.0
27514
+ * @version 147.0.0
25726
27515
  */
25727
27516
 
25728
27517
  /**
@@ -25873,7 +27662,7 @@ class NotificationsApi {
25873
27662
  /**
25874
27663
  * Notifications service.
25875
27664
  * @module purecloud-platform-client-v2/api/NotificationsApi
25876
- * @version 144.0.0
27665
+ * @version 147.0.0
25877
27666
  */
25878
27667
 
25879
27668
  /**
@@ -26098,7 +27887,7 @@ class OAuthApi {
26098
27887
  /**
26099
27888
  * OAuth service.
26100
27889
  * @module purecloud-platform-client-v2/api/OAuthApi
26101
- * @version 144.0.0
27890
+ * @version 147.0.0
26102
27891
  */
26103
27892
 
26104
27893
  /**
@@ -26464,7 +28253,7 @@ class ObjectsApi {
26464
28253
  /**
26465
28254
  * Objects service.
26466
28255
  * @module purecloud-platform-client-v2/api/ObjectsApi
26467
- * @version 144.0.0
28256
+ * @version 147.0.0
26468
28257
  */
26469
28258
 
26470
28259
  /**
@@ -26735,7 +28524,7 @@ class OrganizationApi {
26735
28524
  /**
26736
28525
  * Organization service.
26737
28526
  * @module purecloud-platform-client-v2/api/OrganizationApi
26738
- * @version 144.0.0
28527
+ * @version 147.0.0
26739
28528
  */
26740
28529
 
26741
28530
  /**
@@ -27138,7 +28927,7 @@ class OrganizationAuthorizationApi {
27138
28927
  /**
27139
28928
  * OrganizationAuthorization service.
27140
28929
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
27141
- * @version 144.0.0
28930
+ * @version 147.0.0
27142
28931
  */
27143
28932
 
27144
28933
  /**
@@ -28063,7 +29852,7 @@ class OutboundApi {
28063
29852
  /**
28064
29853
  * Outbound service.
28065
29854
  * @module purecloud-platform-client-v2/api/OutboundApi
28066
- * @version 144.0.0
29855
+ * @version 147.0.0
28067
29856
  */
28068
29857
 
28069
29858
  /**
@@ -28363,6 +30152,31 @@ class OutboundApi {
28363
30152
  );
28364
30153
  }
28365
30154
 
30155
+ /**
30156
+ * Delete an Outbound Digital Rule Set
30157
+ *
30158
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
30159
+ */
30160
+ deleteOutboundDigitalruleset(digitalRuleSetId) {
30161
+ // verify the required parameter 'digitalRuleSetId' is set
30162
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
30163
+ throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
30164
+ }
30165
+
30166
+ return this.apiClient.callApi(
30167
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
30168
+ 'DELETE',
30169
+ { 'digitalRuleSetId': digitalRuleSetId },
30170
+ { },
30171
+ { },
30172
+ { },
30173
+ null,
30174
+ ['PureCloud OAuth'],
30175
+ ['application/json'],
30176
+ ['application/json']
30177
+ );
30178
+ }
30179
+
28366
30180
  /**
28367
30181
  * Delete dialer DNC list
28368
30182
  *
@@ -29400,6 +31214,60 @@ class OutboundApi {
29400
31214
  );
29401
31215
  }
29402
31216
 
31217
+ /**
31218
+ * Get an Outbound Digital Rule Set
31219
+ *
31220
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
31221
+ */
31222
+ getOutboundDigitalruleset(digitalRuleSetId) {
31223
+ // verify the required parameter 'digitalRuleSetId' is set
31224
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
31225
+ throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
31226
+ }
31227
+
31228
+ return this.apiClient.callApi(
31229
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
31230
+ 'GET',
31231
+ { 'digitalRuleSetId': digitalRuleSetId },
31232
+ { },
31233
+ { },
31234
+ { },
31235
+ null,
31236
+ ['PureCloud OAuth'],
31237
+ ['application/json'],
31238
+ ['application/json']
31239
+ );
31240
+ }
31241
+
31242
+ /**
31243
+ * Query a list of Outbound Digital Rule Sets
31244
+ *
31245
+ * @param {Object} opts Optional parameters
31246
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
31247
+ * @param {Number} opts.pageNumber Page number (default to 1)
31248
+ * @param {Object} opts.sortBy The field to sort by (default to name)
31249
+ * @param {Object} opts.sortOrder The direction to sort (default to ascending)
31250
+ * @param {String} opts.name Name
31251
+ * @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
31252
+ */
31253
+ getOutboundDigitalrulesets(opts) {
31254
+ opts = opts || {};
31255
+
31256
+
31257
+ return this.apiClient.callApi(
31258
+ '/api/v2/outbound/digitalrulesets',
31259
+ 'GET',
31260
+ { },
31261
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
31262
+ { },
31263
+ { },
31264
+ null,
31265
+ ['PureCloud OAuth'],
31266
+ ['application/json'],
31267
+ ['application/json']
31268
+ );
31269
+ }
31270
+
29403
31271
  /**
29404
31272
  * Get dialer DNC list
29405
31273
  *
@@ -30583,6 +32451,31 @@ class OutboundApi {
30583
32451
  );
30584
32452
  }
30585
32453
 
32454
+ /**
32455
+ * Create an Outbound Digital Rule Set
32456
+ *
32457
+ * @param {Object} body Digital Rule Set
32458
+ */
32459
+ postOutboundDigitalrulesets(body) {
32460
+ // verify the required parameter 'body' is set
32461
+ if (body === undefined || body === null) {
32462
+ throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
32463
+ }
32464
+
32465
+ return this.apiClient.callApi(
32466
+ '/api/v2/outbound/digitalrulesets',
32467
+ 'POST',
32468
+ { },
32469
+ { },
32470
+ { },
32471
+ { },
32472
+ body,
32473
+ ['PureCloud OAuth'],
32474
+ ['application/json'],
32475
+ ['application/json']
32476
+ );
32477
+ }
32478
+
30586
32479
  /**
30587
32480
  * Initiate the export of a dnc list.
30588
32481
  * Returns 200 if received OK.
@@ -31047,6 +32940,36 @@ class OutboundApi {
31047
32940
  );
31048
32941
  }
31049
32942
 
32943
+ /**
32944
+ * Update an Outbound Digital Rule Set
32945
+ *
32946
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
32947
+ * @param {Object} body Digital Rule Set
32948
+ */
32949
+ putOutboundDigitalruleset(digitalRuleSetId, body) {
32950
+ // verify the required parameter 'digitalRuleSetId' is set
32951
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
32952
+ throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
32953
+ }
32954
+ // verify the required parameter 'body' is set
32955
+ if (body === undefined || body === null) {
32956
+ throw 'Missing the required parameter "body" when calling putOutboundDigitalruleset';
32957
+ }
32958
+
32959
+ return this.apiClient.callApi(
32960
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
32961
+ 'PUT',
32962
+ { 'digitalRuleSetId': digitalRuleSetId },
32963
+ { },
32964
+ { },
32965
+ { },
32966
+ body,
32967
+ ['PureCloud OAuth'],
32968
+ ['application/json'],
32969
+ ['application/json']
32970
+ );
32971
+ }
32972
+
31050
32973
  /**
31051
32974
  * Update dialer DNC list
31052
32975
  *
@@ -31318,7 +33241,7 @@ class PresenceApi {
31318
33241
  /**
31319
33242
  * Presence service.
31320
33243
  * @module purecloud-platform-client-v2/api/PresenceApi
31321
- * @version 144.0.0
33244
+ * @version 147.0.0
31322
33245
  */
31323
33246
 
31324
33247
  /**
@@ -31640,7 +33563,7 @@ class QualityApi {
31640
33563
  /**
31641
33564
  * Quality service.
31642
33565
  * @module purecloud-platform-client-v2/api/QualityApi
31643
- * @version 144.0.0
33566
+ * @version 147.0.0
31644
33567
  */
31645
33568
 
31646
33569
  /**
@@ -32150,7 +34073,7 @@ class QualityApi {
32150
34073
  * @param {String} opts.sortBy variable name requested to sort by
32151
34074
  * @param {String} opts.nextPage next page token
32152
34075
  * @param {String} opts.previousPage Previous page token
32153
- * @param {String} opts.expand Expand
34076
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
32154
34077
  * @param {String} opts.name Name
32155
34078
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
32156
34079
  */
@@ -32237,7 +34160,7 @@ class QualityApi {
32237
34160
  * @param {String} opts.sortBy variable name requested to sort by
32238
34161
  * @param {String} opts.nextPage next page token
32239
34162
  * @param {String} opts.previousPage Previous page token
32240
- * @param {String} opts.expand Expand
34163
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
32241
34164
  * @param {String} opts.name Name
32242
34165
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
32243
34166
  */
@@ -32348,7 +34271,7 @@ class QualityApi {
32348
34271
  * @param {String} opts.sortBy variable name requested to sort by
32349
34272
  * @param {String} opts.nextPage next page token
32350
34273
  * @param {String} opts.previousPage Previous page token
32351
- * @param {String} opts.expand Expand
34274
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
32352
34275
  * @param {String} opts.name Name
32353
34276
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
32354
34277
  */
@@ -33218,7 +35141,7 @@ class RecordingApi {
33218
35141
  /**
33219
35142
  * Recording service.
33220
35143
  * @module purecloud-platform-client-v2/api/RecordingApi
33221
- * @version 144.0.0
35144
+ * @version 147.0.0
33222
35145
  */
33223
35146
 
33224
35147
  /**
@@ -33743,12 +35666,249 @@ class RecordingApi {
33743
35666
  * @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
33744
35667
  * @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
33745
35668
  */
33746
- getRecordingCrossplatformMediaretentionpolicies(opts) {
35669
+ getRecordingCrossplatformMediaretentionpolicies(opts) {
35670
+ opts = opts || {};
35671
+
35672
+
35673
+ return this.apiClient.callApi(
35674
+ '/api/v2/recording/crossplatform/mediaretentionpolicies',
35675
+ 'GET',
35676
+ { },
35677
+ { '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'] },
35678
+ { },
35679
+ { },
35680
+ null,
35681
+ ['PureCloud OAuth'],
35682
+ ['application/json'],
35683
+ ['application/json']
35684
+ );
35685
+ }
35686
+
35687
+ /**
35688
+ * Get a media retention policy
35689
+ *
35690
+ * @param {String} policyId Policy ID
35691
+ */
35692
+ getRecordingCrossplatformMediaretentionpolicy(policyId) {
35693
+ // verify the required parameter 'policyId' is set
35694
+ if (policyId === undefined || policyId === null) {
35695
+ throw 'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';
35696
+ }
35697
+
35698
+ return this.apiClient.callApi(
35699
+ '/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}',
35700
+ 'GET',
35701
+ { 'policyId': policyId },
35702
+ { },
35703
+ { },
35704
+ { },
35705
+ null,
35706
+ ['PureCloud OAuth'],
35707
+ ['application/json'],
35708
+ ['application/json']
35709
+ );
35710
+ }
35711
+
35712
+ /**
35713
+ * Get the status of the job associated with the job id.
35714
+ *
35715
+ * @param {String} jobId jobId
35716
+ */
35717
+ getRecordingJob(jobId) {
35718
+ // verify the required parameter 'jobId' is set
35719
+ if (jobId === undefined || jobId === null) {
35720
+ throw 'Missing the required parameter "jobId" when calling getRecordingJob';
35721
+ }
35722
+
35723
+ return this.apiClient.callApi(
35724
+ '/api/v2/recording/jobs/{jobId}',
35725
+ 'GET',
35726
+ { 'jobId': jobId },
35727
+ { },
35728
+ { },
35729
+ { },
35730
+ null,
35731
+ ['PureCloud OAuth'],
35732
+ ['application/json'],
35733
+ ['application/json']
35734
+ );
35735
+ }
35736
+
35737
+ /**
35738
+ * Get IDs of recordings that the bulk job failed for
35739
+ *
35740
+ * @param {String} jobId jobId
35741
+ * @param {Object} opts Optional parameters
35742
+ * @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
35743
+ * @param {Number} opts.pageNumber Page number (default to 1)
35744
+ * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
35745
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
35746
+ */
35747
+ getRecordingJobFailedrecordings(jobId, opts) {
35748
+ opts = opts || {};
35749
+
35750
+ // verify the required parameter 'jobId' is set
35751
+ if (jobId === undefined || jobId === null) {
35752
+ throw 'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';
35753
+ }
35754
+
35755
+ return this.apiClient.callApi(
35756
+ '/api/v2/recording/jobs/{jobId}/failedrecordings',
35757
+ 'GET',
35758
+ { 'jobId': jobId },
35759
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
35760
+ { },
35761
+ { },
35762
+ null,
35763
+ ['PureCloud OAuth'],
35764
+ ['application/json'],
35765
+ ['application/json']
35766
+ );
35767
+ }
35768
+
35769
+ /**
35770
+ * Get the status of all jobs within the user's organization
35771
+ *
35772
+ * @param {Object} opts Optional parameters
35773
+ * @param {Number} opts.pageSize Page size (default to 25)
35774
+ * @param {Number} opts.pageNumber Page number (default to 1)
35775
+ * @param {Object} opts.sortBy Sort by (default to userId)
35776
+ * @param {Object} opts.state Filter by state
35777
+ * @param {Boolean} opts.showOnlyMyJobs Show only my jobs
35778
+ * @param {Object} opts.jobType Job Type (Can be left empty for both)
35779
+ * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
35780
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
35781
+ */
35782
+ getRecordingJobs(opts) {
35783
+ opts = opts || {};
35784
+
35785
+
35786
+ return this.apiClient.callApi(
35787
+ '/api/v2/recording/jobs',
35788
+ 'GET',
35789
+ { },
35790
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
35791
+ { },
35792
+ { },
35793
+ null,
35794
+ ['PureCloud OAuth'],
35795
+ ['application/json'],
35796
+ ['application/json']
35797
+ );
35798
+ }
35799
+
35800
+ /**
35801
+ * Get the encryption key configurations
35802
+ *
35803
+ * @param {String} keyConfigurationId Key Configurations Id
35804
+ */
35805
+ getRecordingKeyconfiguration(keyConfigurationId) {
35806
+ // verify the required parameter 'keyConfigurationId' is set
35807
+ if (keyConfigurationId === undefined || keyConfigurationId === null) {
35808
+ throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
35809
+ }
35810
+
35811
+ return this.apiClient.callApi(
35812
+ '/api/v2/recording/keyconfigurations/{keyConfigurationId}',
35813
+ 'GET',
35814
+ { 'keyConfigurationId': keyConfigurationId },
35815
+ { },
35816
+ { },
35817
+ { },
35818
+ null,
35819
+ ['PureCloud OAuth'],
35820
+ ['application/json'],
35821
+ ['application/json']
35822
+ );
35823
+ }
35824
+
35825
+ /**
35826
+ * Get a list of key configurations data
35827
+ *
35828
+ */
35829
+ getRecordingKeyconfigurations() {
35830
+
35831
+ return this.apiClient.callApi(
35832
+ '/api/v2/recording/keyconfigurations',
35833
+ 'GET',
35834
+ { },
35835
+ { },
35836
+ { },
35837
+ { },
35838
+ null,
35839
+ ['PureCloud OAuth'],
35840
+ ['application/json'],
35841
+ ['application/json']
35842
+ );
35843
+ }
35844
+
35845
+ /**
35846
+ * Get the local encryption settings
35847
+ *
35848
+ * @param {String} settingsId Settings Id
35849
+ */
35850
+ getRecordingLocalkeysSetting(settingsId) {
35851
+ // verify the required parameter 'settingsId' is set
35852
+ if (settingsId === undefined || settingsId === null) {
35853
+ throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
35854
+ }
35855
+
35856
+ return this.apiClient.callApi(
35857
+ '/api/v2/recording/localkeys/settings/{settingsId}',
35858
+ 'GET',
35859
+ { 'settingsId': settingsId },
35860
+ { },
35861
+ { },
35862
+ { },
35863
+ null,
35864
+ ['PureCloud OAuth'],
35865
+ ['application/json'],
35866
+ ['application/json']
35867
+ );
35868
+ }
35869
+
35870
+ /**
35871
+ * gets a list local key settings data
35872
+ *
35873
+ */
35874
+ getRecordingLocalkeysSettings() {
35875
+
35876
+ return this.apiClient.callApi(
35877
+ '/api/v2/recording/localkeys/settings',
35878
+ 'GET',
35879
+ { },
35880
+ { },
35881
+ { },
35882
+ { },
35883
+ null,
35884
+ ['PureCloud OAuth'],
35885
+ ['application/json'],
35886
+ ['application/json']
35887
+ );
35888
+ }
35889
+
35890
+ /**
35891
+ * Gets media retention policy list with query options to filter on name and enabled.
35892
+ * for a less verbose response, add summary=true to this endpoint
35893
+ * @param {Object} opts Optional parameters
35894
+ * @param {Number} opts.pageSize The total page size requested (default to 25)
35895
+ * @param {Number} opts.pageNumber The page number requested (default to 1)
35896
+ * @param {String} opts.sortBy variable name requested to sort by
35897
+ * @param {Array.<String>} opts.expand variable name requested by expand list
35898
+ * @param {String} opts.nextPage next page token
35899
+ * @param {String} opts.previousPage Previous page token
35900
+ * @param {String} opts.name the policy name - used for filtering results in searches.
35901
+ * @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
35902
+ * @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
35903
+ * @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
35904
+ * @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
35905
+ */
35906
+ getRecordingMediaretentionpolicies(opts) {
33747
35907
  opts = opts || {};
33748
35908
 
33749
35909
 
33750
35910
  return this.apiClient.callApi(
33751
- '/api/v2/recording/crossplatform/mediaretentionpolicies',
35911
+ '/api/v2/recording/mediaretentionpolicies',
33752
35912
  'GET',
33753
35913
  { },
33754
35914
  { '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'] },
@@ -33766,14 +35926,14 @@ class RecordingApi {
33766
35926
  *
33767
35927
  * @param {String} policyId Policy ID
33768
35928
  */
33769
- getRecordingCrossplatformMediaretentionpolicy(policyId) {
35929
+ getRecordingMediaretentionpolicy(policyId) {
33770
35930
  // verify the required parameter 'policyId' is set
33771
35931
  if (policyId === undefined || policyId === null) {
33772
- throw 'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';
35932
+ throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
33773
35933
  }
33774
35934
 
33775
35935
  return this.apiClient.callApi(
33776
- '/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}',
35936
+ '/api/v2/recording/mediaretentionpolicies/{policyId}',
33777
35937
  'GET',
33778
35938
  { 'policyId': policyId },
33779
35939
  { },
@@ -33787,154 +35947,21 @@ class RecordingApi {
33787
35947
  }
33788
35948
 
33789
35949
  /**
33790
- * Get the status of the job associated with the job id.
33791
- *
33792
- * @param {String} jobId jobId
33793
- */
33794
- getRecordingJob(jobId) {
33795
- // verify the required parameter 'jobId' is set
33796
- if (jobId === undefined || jobId === null) {
33797
- throw 'Missing the required parameter "jobId" when calling getRecordingJob';
33798
- }
33799
-
33800
- return this.apiClient.callApi(
33801
- '/api/v2/recording/jobs/{jobId}',
33802
- 'GET',
33803
- { 'jobId': jobId },
33804
- { },
33805
- { },
33806
- { },
33807
- null,
33808
- ['PureCloud OAuth'],
33809
- ['application/json'],
33810
- ['application/json']
33811
- );
33812
- }
33813
-
33814
- /**
33815
- * Get IDs of recordings that the bulk job failed for
33816
- *
33817
- * @param {String} jobId jobId
33818
- * @param {Object} opts Optional parameters
33819
- * @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
33820
- * @param {Number} opts.pageNumber Page number (default to 1)
33821
- * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
33822
- * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
33823
- */
33824
- getRecordingJobFailedrecordings(jobId, opts) {
33825
- opts = opts || {};
33826
-
33827
- // verify the required parameter 'jobId' is set
33828
- if (jobId === undefined || jobId === null) {
33829
- throw 'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';
33830
- }
33831
-
33832
- return this.apiClient.callApi(
33833
- '/api/v2/recording/jobs/{jobId}/failedrecordings',
33834
- 'GET',
33835
- { 'jobId': jobId },
33836
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
33837
- { },
33838
- { },
33839
- null,
33840
- ['PureCloud OAuth'],
33841
- ['application/json'],
33842
- ['application/json']
33843
- );
33844
- }
33845
-
33846
- /**
33847
- * Get the status of all jobs within the user's organization
35950
+ * Get encryption key list
33848
35951
  *
33849
35952
  * @param {Object} opts Optional parameters
33850
35953
  * @param {Number} opts.pageSize Page size (default to 25)
33851
35954
  * @param {Number} opts.pageNumber Page number (default to 1)
33852
- * @param {Object} opts.sortBy Sort by (default to userId)
33853
- * @param {Object} opts.state Filter by state
33854
- * @param {Boolean} opts.showOnlyMyJobs Show only my jobs
33855
- * @param {Object} opts.jobType Job Type (Can be left empty for both)
33856
- * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
33857
- * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
33858
35955
  */
33859
- getRecordingJobs(opts) {
35956
+ getRecordingRecordingkeys(opts) {
33860
35957
  opts = opts || {};
33861
35958
 
33862
35959
 
33863
35960
  return this.apiClient.callApi(
33864
- '/api/v2/recording/jobs',
33865
- 'GET',
33866
- { },
33867
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
33868
- { },
33869
- { },
33870
- null,
33871
- ['PureCloud OAuth'],
33872
- ['application/json'],
33873
- ['application/json']
33874
- );
33875
- }
33876
-
33877
- /**
33878
- * Get the encryption key configurations
33879
- *
33880
- * @param {String} keyConfigurationId Key Configurations Id
33881
- */
33882
- getRecordingKeyconfiguration(keyConfigurationId) {
33883
- // verify the required parameter 'keyConfigurationId' is set
33884
- if (keyConfigurationId === undefined || keyConfigurationId === null) {
33885
- throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
33886
- }
33887
-
33888
- return this.apiClient.callApi(
33889
- '/api/v2/recording/keyconfigurations/{keyConfigurationId}',
33890
- 'GET',
33891
- { 'keyConfigurationId': keyConfigurationId },
33892
- { },
33893
- { },
33894
- { },
33895
- null,
33896
- ['PureCloud OAuth'],
33897
- ['application/json'],
33898
- ['application/json']
33899
- );
33900
- }
33901
-
33902
- /**
33903
- * Get a list of key configurations data
33904
- *
33905
- */
33906
- getRecordingKeyconfigurations() {
33907
-
33908
- return this.apiClient.callApi(
33909
- '/api/v2/recording/keyconfigurations',
33910
- 'GET',
33911
- { },
33912
- { },
33913
- { },
33914
- { },
33915
- null,
33916
- ['PureCloud OAuth'],
33917
- ['application/json'],
33918
- ['application/json']
33919
- );
33920
- }
33921
-
33922
- /**
33923
- * Get the local encryption settings
33924
- *
33925
- * @param {String} settingsId Settings Id
33926
- */
33927
- getRecordingLocalkeysSetting(settingsId) {
33928
- // verify the required parameter 'settingsId' is set
33929
- if (settingsId === undefined || settingsId === null) {
33930
- throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
33931
- }
33932
-
33933
- return this.apiClient.callApi(
33934
- '/api/v2/recording/localkeys/settings/{settingsId}',
35961
+ '/api/v2/recording/recordingkeys',
33935
35962
  'GET',
33936
- { 'settingsId': settingsId },
33937
35963
  { },
35964
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
33938
35965
  { },
33939
35966
  { },
33940
35967
  null,
@@ -33945,74 +35972,15 @@ class RecordingApi {
33945
35972
  }
33946
35973
 
33947
35974
  /**
33948
- * gets a list local key settings data
35975
+ * Get key rotation schedule
33949
35976
  *
33950
35977
  */
33951
- getRecordingLocalkeysSettings() {
33952
-
33953
- return this.apiClient.callApi(
33954
- '/api/v2/recording/localkeys/settings',
33955
- 'GET',
33956
- { },
33957
- { },
33958
- { },
33959
- { },
33960
- null,
33961
- ['PureCloud OAuth'],
33962
- ['application/json'],
33963
- ['application/json']
33964
- );
33965
- }
33966
-
33967
- /**
33968
- * Gets media retention policy list with query options to filter on name and enabled.
33969
- * for a less verbose response, add summary=true to this endpoint
33970
- * @param {Object} opts Optional parameters
33971
- * @param {Number} opts.pageSize The total page size requested (default to 25)
33972
- * @param {Number} opts.pageNumber The page number requested (default to 1)
33973
- * @param {String} opts.sortBy variable name requested to sort by
33974
- * @param {Array.<String>} opts.expand variable name requested by expand list
33975
- * @param {String} opts.nextPage next page token
33976
- * @param {String} opts.previousPage Previous page token
33977
- * @param {String} opts.name the policy name - used for filtering results in searches.
33978
- * @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
33979
- * @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
33980
- * @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
33981
- * @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
33982
- */
33983
- getRecordingMediaretentionpolicies(opts) {
33984
- opts = opts || {};
33985
-
35978
+ getRecordingRecordingkeysRotationschedule() {
33986
35979
 
33987
35980
  return this.apiClient.callApi(
33988
- '/api/v2/recording/mediaretentionpolicies',
35981
+ '/api/v2/recording/recordingkeys/rotationschedule',
33989
35982
  'GET',
33990
35983
  { },
33991
- { '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'] },
33992
- { },
33993
- { },
33994
- null,
33995
- ['PureCloud OAuth'],
33996
- ['application/json'],
33997
- ['application/json']
33998
- );
33999
- }
34000
-
34001
- /**
34002
- * Get a media retention policy
34003
- *
34004
- * @param {String} policyId Policy ID
34005
- */
34006
- getRecordingMediaretentionpolicy(policyId) {
34007
- // verify the required parameter 'policyId' is set
34008
- if (policyId === undefined || policyId === null) {
34009
- throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
34010
- }
34011
-
34012
- return this.apiClient.callApi(
34013
- '/api/v2/recording/mediaretentionpolicies/{policyId}',
34014
- 'GET',
34015
- { 'policyId': policyId },
34016
35984
  { },
34017
35985
  { },
34018
35986
  { },
@@ -34024,41 +35992,20 @@ class RecordingApi {
34024
35992
  }
34025
35993
 
34026
35994
  /**
34027
- * Get encryption key list
35995
+ * Get the Recording Settings for the Organization
34028
35996
  *
34029
35997
  * @param {Object} opts Optional parameters
34030
- * @param {Number} opts.pageSize Page size (default to 25)
34031
- * @param {Number} opts.pageNumber Page number (default to 1)
35998
+ * @param {Boolean} opts.createDefault If no settings are found, a new one is created with default values (default to false)
34032
35999
  */
34033
- getRecordingRecordingkeys(opts) {
36000
+ getRecordingSettings(opts) {
34034
36001
  opts = opts || {};
34035
36002
 
34036
36003
 
34037
36004
  return this.apiClient.callApi(
34038
- '/api/v2/recording/recordingkeys',
34039
- 'GET',
34040
- { },
34041
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
34042
- { },
34043
- { },
34044
- null,
34045
- ['PureCloud OAuth'],
34046
- ['application/json'],
34047
- ['application/json']
34048
- );
34049
- }
34050
-
34051
- /**
34052
- * Get key rotation schedule
34053
- *
34054
- */
34055
- getRecordingRecordingkeysRotationschedule() {
34056
-
34057
- return this.apiClient.callApi(
34058
- '/api/v2/recording/recordingkeys/rotationschedule',
36005
+ '/api/v2/recording/settings',
34059
36006
  'GET',
34060
36007
  { },
34061
- { },
36008
+ { 'createDefault': opts['createDefault'] },
34062
36009
  { },
34063
36010
  { },
34064
36011
  null,
@@ -34069,20 +36016,26 @@ class RecordingApi {
34069
36016
  }
34070
36017
 
34071
36018
  /**
34072
- * Get the Recording Settings for the Organization
36019
+ * Query for recording retention data
34073
36020
  *
36021
+ * @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
34074
36022
  * @param {Object} opts Optional parameters
34075
- * @param {Boolean} opts.createDefault If no settings are found, a new one is created with default values (default to false)
36023
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
36024
+ * @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
34076
36025
  */
34077
- getRecordingSettings(opts) {
36026
+ getRecordingsRetentionQuery(retentionThresholdDays, opts) {
34078
36027
  opts = opts || {};
34079
36028
 
36029
+ // verify the required parameter 'retentionThresholdDays' is set
36030
+ if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
36031
+ throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
36032
+ }
34080
36033
 
34081
36034
  return this.apiClient.callApi(
34082
- '/api/v2/recording/settings',
36035
+ '/api/v2/recordings/retention/query',
34083
36036
  'GET',
34084
36037
  { },
34085
- { 'createDefault': opts['createDefault'] },
36038
+ { 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
34086
36039
  { },
34087
36040
  { },
34088
36041
  null,
@@ -34871,7 +36824,7 @@ class ResponseManagementApi {
34871
36824
  /**
34872
36825
  * ResponseManagement service.
34873
36826
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
34874
- * @version 144.0.0
36827
+ * @version 147.0.0
34875
36828
  */
34876
36829
 
34877
36830
  /**
@@ -35355,7 +37308,7 @@ class RoutingApi {
35355
37308
  /**
35356
37309
  * Routing service.
35357
37310
  * @module purecloud-platform-client-v2/api/RoutingApi
35358
- * @version 144.0.0
37311
+ * @version 147.0.0
35359
37312
  */
35360
37313
 
35361
37314
  /**
@@ -35921,6 +37874,26 @@ class RoutingApi {
35921
37874
  );
35922
37875
  }
35923
37876
 
37877
+ /**
37878
+ * Get available media types
37879
+ *
37880
+ */
37881
+ getRoutingAvailablemediatypes() {
37882
+
37883
+ return this.apiClient.callApi(
37884
+ '/api/v2/routing/availablemediatypes',
37885
+ 'GET',
37886
+ { },
37887
+ { },
37888
+ { },
37889
+ { },
37890
+ null,
37891
+ ['PureCloud OAuth'],
37892
+ ['application/json'],
37893
+ ['application/json']
37894
+ );
37895
+ }
37896
+
35924
37897
  /**
35925
37898
  * Get domain
35926
37899
  *
@@ -38276,7 +40249,7 @@ class SCIMApi {
38276
40249
  /**
38277
40250
  * SCIM service.
38278
40251
  * @module purecloud-platform-client-v2/api/SCIMApi
38279
- * @version 144.0.0
40252
+ * @version 147.0.0
38280
40253
  */
38281
40254
 
38282
40255
  /**
@@ -39153,7 +41126,7 @@ class ScriptsApi {
39153
41126
  /**
39154
41127
  * Scripts service.
39155
41128
  * @module purecloud-platform-client-v2/api/ScriptsApi
39156
- * @version 144.0.0
41129
+ * @version 147.0.0
39157
41130
  */
39158
41131
 
39159
41132
  /**
@@ -39572,7 +41545,7 @@ class SearchApi {
39572
41545
  /**
39573
41546
  * Search service.
39574
41547
  * @module purecloud-platform-client-v2/api/SearchApi
39575
- * @version 144.0.0
41548
+ * @version 147.0.0
39576
41549
  */
39577
41550
 
39578
41551
  /**
@@ -40132,7 +42105,7 @@ class SpeechTextAnalyticsApi {
40132
42105
  /**
40133
42106
  * SpeechTextAnalytics service.
40134
42107
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
40135
- * @version 144.0.0
42108
+ * @version 147.0.0
40136
42109
  */
40137
42110
 
40138
42111
  /**
@@ -40986,7 +42959,7 @@ class StationsApi {
40986
42959
  /**
40987
42960
  * Stations service.
40988
42961
  * @module purecloud-platform-client-v2/api/StationsApi
40989
- * @version 144.0.0
42962
+ * @version 147.0.0
40990
42963
  */
40991
42964
 
40992
42965
  /**
@@ -41133,7 +43106,7 @@ class SuggestApi {
41133
43106
  /**
41134
43107
  * Suggest service.
41135
43108
  * @module purecloud-platform-client-v2/api/SuggestApi
41136
- * @version 144.0.0
43109
+ * @version 147.0.0
41137
43110
  */
41138
43111
 
41139
43112
  /**
@@ -41272,7 +43245,7 @@ class TeamsApi {
41272
43245
  /**
41273
43246
  * Teams service.
41274
43247
  * @module purecloud-platform-client-v2/api/TeamsApi
41275
- * @version 144.0.0
43248
+ * @version 147.0.0
41276
43249
  */
41277
43250
 
41278
43251
  /**
@@ -41451,7 +43424,7 @@ class TelephonyApi {
41451
43424
  /**
41452
43425
  * Telephony service.
41453
43426
  * @module purecloud-platform-client-v2/api/TelephonyApi
41454
- * @version 144.0.0
43427
+ * @version 147.0.0
41455
43428
  */
41456
43429
 
41457
43430
  /**
@@ -41559,7 +43532,7 @@ class TelephonyProvidersEdgeApi {
41559
43532
  /**
41560
43533
  * TelephonyProvidersEdge service.
41561
43534
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
41562
- * @version 144.0.0
43535
+ * @version 147.0.0
41563
43536
  */
41564
43537
 
41565
43538
  /**
@@ -45192,7 +47165,7 @@ class TextbotsApi {
45192
47165
  /**
45193
47166
  * Textbots service.
45194
47167
  * @module purecloud-platform-client-v2/api/TextbotsApi
45195
- * @version 144.0.0
47168
+ * @version 147.0.0
45196
47169
  */
45197
47170
 
45198
47171
  /**
@@ -45320,7 +47293,7 @@ class TokensApi {
45320
47293
  /**
45321
47294
  * Tokens service.
45322
47295
  * @module purecloud-platform-client-v2/api/TokensApi
45323
- * @version 144.0.0
47296
+ * @version 147.0.0
45324
47297
  */
45325
47298
 
45326
47299
  /**
@@ -45426,7 +47399,7 @@ class UploadsApi {
45426
47399
  /**
45427
47400
  * Uploads service.
45428
47401
  * @module purecloud-platform-client-v2/api/UploadsApi
45429
- * @version 144.0.0
47402
+ * @version 147.0.0
45430
47403
  */
45431
47404
 
45432
47405
  /**
@@ -45602,7 +47575,7 @@ class UsageApi {
45602
47575
  /**
45603
47576
  * Usage service.
45604
47577
  * @module purecloud-platform-client-v2/api/UsageApi
45605
- * @version 144.0.0
47578
+ * @version 147.0.0
45606
47579
  */
45607
47580
 
45608
47581
  /**
@@ -45673,7 +47646,7 @@ class UserRecordingsApi {
45673
47646
  /**
45674
47647
  * UserRecordings service.
45675
47648
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
45676
- * @version 144.0.0
47649
+ * @version 147.0.0
45677
47650
  */
45678
47651
 
45679
47652
  /**
@@ -45857,7 +47830,7 @@ class UsersApi {
45857
47830
  /**
45858
47831
  * Users service.
45859
47832
  * @module purecloud-platform-client-v2/api/UsersApi
45860
- * @version 144.0.0
47833
+ * @version 147.0.0
45861
47834
  */
45862
47835
 
45863
47836
  /**
@@ -47599,6 +49572,36 @@ class UsersApi {
47599
49572
  );
47600
49573
  }
47601
49574
 
49575
+ /**
49576
+ * Create mapping between external identifier and user. Limit 100 per entity.
49577
+ * Authority Name and External key are case sensitive.
49578
+ * @param {String} userId User ID
49579
+ * @param {Object} body
49580
+ */
49581
+ postUserExternalid(userId, body) {
49582
+ // verify the required parameter 'userId' is set
49583
+ if (userId === undefined || userId === null) {
49584
+ throw 'Missing the required parameter "userId" when calling postUserExternalid';
49585
+ }
49586
+ // verify the required parameter 'body' is set
49587
+ if (body === undefined || body === null) {
49588
+ throw 'Missing the required parameter "body" when calling postUserExternalid';
49589
+ }
49590
+
49591
+ return this.apiClient.callApi(
49592
+ '/api/v2/users/{userId}/externalid',
49593
+ 'POST',
49594
+ { 'userId': userId },
49595
+ { },
49596
+ { },
49597
+ { },
49598
+ body,
49599
+ ['PureCloud OAuth'],
49600
+ ['application/json'],
49601
+ ['application/json']
49602
+ );
49603
+ }
49604
+
47602
49605
  /**
47603
49606
  * Send an activation email to the user
47604
49607
  *
@@ -47720,7 +49723,7 @@ class UsersApi {
47720
49723
 
47721
49724
  /**
47722
49725
  * Create user
47723
- *
49726
+ * 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.
47724
49727
  * @param {Object} body User
47725
49728
  */
47726
49729
  postUsers(body) {
@@ -48159,7 +50162,7 @@ class UtilitiesApi {
48159
50162
  /**
48160
50163
  * Utilities service.
48161
50164
  * @module purecloud-platform-client-v2/api/UtilitiesApi
48162
- * @version 144.0.0
50165
+ * @version 147.0.0
48163
50166
  */
48164
50167
 
48165
50168
  /**
@@ -48270,7 +50273,7 @@ class VoicemailApi {
48270
50273
  /**
48271
50274
  * Voicemail service.
48272
50275
  * @module purecloud-platform-client-v2/api/VoicemailApi
48273
- * @version 144.0.0
50276
+ * @version 147.0.0
48274
50277
  */
48275
50278
 
48276
50279
  /**
@@ -48937,7 +50940,7 @@ class WebChatApi {
48937
50940
  /**
48938
50941
  * WebChat service.
48939
50942
  * @module purecloud-platform-client-v2/api/WebChatApi
48940
- * @version 144.0.0
50943
+ * @version 147.0.0
48941
50944
  */
48942
50945
 
48943
50946
  /**
@@ -49481,7 +51484,7 @@ class WebDeploymentsApi {
49481
51484
  /**
49482
51485
  * WebDeployments service.
49483
51486
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
49484
- * @version 144.0.0
51487
+ * @version 147.0.0
49485
51488
  */
49486
51489
 
49487
51490
  /**
@@ -49675,6 +51678,35 @@ class WebDeploymentsApi {
49675
51678
  );
49676
51679
  }
49677
51680
 
51681
+ /**
51682
+ * Get active configuration for a given deployment
51683
+ *
51684
+ * @param {String} deploymentId The deployment ID
51685
+ * @param {Object} opts Optional parameters
51686
+ * @param {String} opts.type Get active configuration on a deployment
51687
+ */
51688
+ getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
51689
+ opts = opts || {};
51690
+
51691
+ // verify the required parameter 'deploymentId' is set
51692
+ if (deploymentId === undefined || deploymentId === null) {
51693
+ throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';
51694
+ }
51695
+
51696
+ return this.apiClient.callApi(
51697
+ '/api/v2/webdeployments/deployments/{deploymentId}/configurations',
51698
+ 'GET',
51699
+ { 'deploymentId': deploymentId },
51700
+ { 'type': opts['type'] },
51701
+ { },
51702
+ { },
51703
+ null,
51704
+ ['PureCloud OAuth'],
51705
+ ['application/json'],
51706
+ ['application/json']
51707
+ );
51708
+ }
51709
+
49678
51710
  /**
49679
51711
  * Get deployments
49680
51712
  *
@@ -49836,7 +51868,7 @@ class WebMessagingApi {
49836
51868
  /**
49837
51869
  * WebMessaging service.
49838
51870
  * @module purecloud-platform-client-v2/api/WebMessagingApi
49839
- * @version 144.0.0
51871
+ * @version 147.0.0
49840
51872
  */
49841
51873
 
49842
51874
  /**
@@ -49882,7 +51914,7 @@ class WidgetsApi {
49882
51914
  /**
49883
51915
  * Widgets service.
49884
51916
  * @module purecloud-platform-client-v2/api/WidgetsApi
49885
- * @version 144.0.0
51917
+ * @version 147.0.0
49886
51918
  */
49887
51919
 
49888
51920
  /**
@@ -50028,7 +52060,7 @@ class WorkforceManagementApi {
50028
52060
  /**
50029
52061
  * WorkforceManagement service.
50030
52062
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
50031
- * @version 144.0.0
52063
+ * @version 147.0.0
50032
52064
  */
50033
52065
 
50034
52066
  /**
@@ -54304,7 +56336,7 @@ class WorkforceManagementApi {
54304
56336
  * </pre>
54305
56337
  * </p>
54306
56338
  * @module purecloud-platform-client-v2/index
54307
- * @version 144.0.0
56339
+ * @version 147.0.0
54308
56340
  */
54309
56341
  class platformClient {
54310
56342
  constructor() {