purecloud-platform-client-v2 206.0.0 → 208.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 (90) hide show
  1. package/README.md +100 -3
  2. package/dist/node/purecloud-platform-client-v2.js +979 -173
  3. package/dist/web-amd/purecloud-platform-client-v2.js +979 -173
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +341 -176
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +358 -179
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1646 -606
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
  11. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +7 -6
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -3
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -2
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +234 -8
  31. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +31 -11
  41. package/src/purecloud-platform-client-v2/api/JourneyApi.js +136 -4
  42. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +5 -21
  43. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +48 -1
  57. package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -1
  58. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/RoutingApi.js +12 -12
  64. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SearchApi.js +55 -1
  68. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +4 -4
  70. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
  74. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +55 -1
  76. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/UsersApi.js +38 -12
  82. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -1
  84. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/configuration.js +81 -0
  90. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -262,6 +262,7 @@ class Configuration {
262
262
  this.basePath;
263
263
  this.authUrl;
264
264
  this.config;
265
+ this.gateway = undefined;
265
266
  this.logger = new Logger();
266
267
  this.setEnvironment();
267
268
  this.liveLoadConfig();
@@ -359,12 +360,72 @@ class Configuration {
359
360
  : this.live_reload_config;
360
361
  this.host = this.getConfigString('general', 'host') !== undefined ? this.getConfigString('general', 'host') : this.host;
361
362
 
363
+ if (this.getConfigString('gateway', 'host') !== undefined) {
364
+ let gateway = {
365
+ host: this.getConfigString('gateway', 'host')
366
+ };
367
+ if (this.getConfigString('gateway', 'protocol') !== undefined) gateway.protocol = this.getConfigString('gateway', 'protocol');
368
+ if (this.getConfigInt('gateway', 'port') !== undefined) gateway.port = this.getConfigInt('gateway', 'port');
369
+ if (this.getConfigString('gateway', 'path_params_login') !== undefined) gateway.path_params_login = this.getConfigString('gateway', 'path_params_login');
370
+ if (this.getConfigString('gateway', 'path_params_api') !== undefined) gateway.path_params_api = this.getConfigString('gateway', 'path_params_api');
371
+ if (this.getConfigString('gateway', 'username') !== undefined) gateway.username = this.getConfigString('gateway', 'username');
372
+ if (this.getConfigString('gateway', 'password') !== undefined) gateway.password = this.getConfigString('gateway', 'password');
373
+ this.setGateway(gateway);
374
+ } else {
375
+ this.setGateway();
376
+ }
377
+
362
378
  this.setEnvironment();
363
379
 
364
380
  // Update logging configs
365
381
  this.logger.setLogger();
366
382
  }
367
383
 
384
+ /**
385
+ * @description Sets the gateway used by the session
386
+ * @param {object} gateway - Gateway Configuration interface
387
+ * @param {string} gateway.host - The address of the gateway.
388
+ * @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
389
+ * @param {number} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater or equal to 0).
390
+ * @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
391
+ * @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
392
+ * @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
393
+ * @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
394
+ */
395
+ setGateway(gateway) {
396
+ if (gateway) {
397
+ this.gateway = {
398
+ host: ''
399
+ };
400
+
401
+ if (gateway.protocol) this.gateway.protocol = gateway.protocol;
402
+ else this.gateway.protocol = 'https';
403
+
404
+ if (gateway.host) this.gateway.host = gateway.host;
405
+ else this.gateway.host = '';
406
+
407
+ if (gateway.port && gateway.port > -1) this.gateway.port = gateway.port;
408
+ else this.gateway.port = -1;
409
+
410
+ if (gateway.path_params_login) {
411
+ this.gateway.path_params_login = gateway.path_params_login;
412
+ // Strip trailing slash
413
+ this.gateway.path_params_login = this.gateway.path_params_login.replace(/\/+$/, '');
414
+ } else this.gateway.path_params_login = '';
415
+
416
+ if (gateway.path_params_api) {
417
+ this.gateway.path_params_api = gateway.path_params_api;
418
+ // Strip trailing slash
419
+ this.gateway.path_params_api = this.gateway.path_params_api.replace(/\/+$/, '');
420
+ } else this.gateway.path_params_api = '';
421
+
422
+ if (gateway.username) this.gateway.username = gateway.username;
423
+ if (gateway.password) this.gateway.password = gateway.password;
424
+ } else {
425
+ this.gateway = undefined;
426
+ }
427
+ }
428
+
368
429
  setEnvironment(env) {
369
430
  // Default value
370
431
  if (env) this.environment = env;
@@ -382,6 +443,26 @@ class Configuration {
382
443
  this.authUrl = `https://login.${this.environment}`;
383
444
  }
384
445
 
446
+ getConfUrl(pathType, regionUrl) {
447
+ if (!this.gateway) return regionUrl;
448
+ if (!this.gateway.host) return regionUrl;
449
+
450
+ var url = this.gateway.protocol + '://' + this.gateway.host;
451
+ if (this.gateway.port > -1) url = url + ':' + this.gateway.port.toString();
452
+ if (pathType === 'login') {
453
+ if (this.gateway.path_params_login) {
454
+ if (this.gateway.path_params_login.startsWith('/')) url = url + this.gateway.path_params_login;
455
+ else url = url + '/' + this.gateway.path_params_login;
456
+ }
457
+ } else {
458
+ if (this.gateway.path_params_api) {
459
+ if (this.gateway.path_params_api.startsWith('/')) url = url + this.gateway.path_params_api;
460
+ else url = url + '/' + this.gateway.path_params_api;
461
+ }
462
+ }
463
+ return url;
464
+ }
465
+
385
466
  getConfigString(section, key) {
386
467
  if (this.config._sections[section]) return this.config._sections[section][key];
387
468
  }
@@ -405,7 +486,7 @@ class Configuration {
405
486
 
406
487
  /**
407
488
  * @module purecloud-platform-client-v2/ApiClient
408
- * @version 206.0.0
489
+ * @version 208.0.0
409
490
  */
410
491
  class ApiClient {
411
492
  /**
@@ -603,6 +684,21 @@ class ApiClient {
603
684
  this.config.setEnvironment(environment);
604
685
  }
605
686
 
687
+ /**
688
+ * @description Sets the gateway used by the session
689
+ * @param {object} gateway - Gateway Configuration interface
690
+ * @param {string} gateway.host - The address of the gateway.
691
+ * @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
692
+ * @param {string} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater than 0).
693
+ * @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
694
+ * @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
695
+ * @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
696
+ * @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
697
+ */
698
+ setGateway(gateway) {
699
+ this.config.setGateway(gateway);
700
+ }
701
+
606
702
  /**
607
703
  * @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
608
704
  * @param {string} clientId - The client ID of an OAuth Implicit Grant client
@@ -667,6 +763,7 @@ class ApiClient {
667
763
  loginClientCredentialsGrant(clientId, clientSecret) {
668
764
  this.clientId = clientId;
669
765
  var authHeader = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
766
+ var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
670
767
 
671
768
  return new Promise((resolve, reject) => {
672
769
  // Block browsers from using client credentials
@@ -679,7 +776,7 @@ class ApiClient {
679
776
  };
680
777
  axios__default["default"]({
681
778
  method: `POST`,
682
- url: `https://login.${this.config.environment}/oauth/token`,
779
+ url: `${loginBasePath}/oauth/token`,
683
780
  headers: headers,
684
781
  data: 'grant_type=client_credentials',
685
782
  httpsAgent: this.proxyAgent
@@ -690,7 +787,7 @@ class ApiClient {
690
787
  'trace',
691
788
  response.status,
692
789
  'POST',
693
- `https://login.${this.config.environment}/oauth/token`,
790
+ `${loginBasePath}/oauth/token`,
694
791
  headers,
695
792
  response.headers,
696
793
  { grant_type: 'client_credentials' },
@@ -700,7 +797,7 @@ class ApiClient {
700
797
  'debug',
701
798
  response.status,
702
799
  'POST',
703
- `https://login.${this.config.environment}/oauth/token`,
800
+ `${loginBasePath}/oauth/token`,
704
801
  headers,
705
802
  undefined,
706
803
  { grant_type: 'client_credentials' },
@@ -724,7 +821,7 @@ class ApiClient {
724
821
  'error',
725
822
  error.response.status,
726
823
  'POST',
727
- `https://login.${this.config.environment}/oauth/token`,
824
+ `${loginBasePath}/oauth/token`,
728
825
  headers,
729
826
  error.response.headers,
730
827
  { grant_type: 'client_credentials' },
@@ -745,6 +842,7 @@ class ApiClient {
745
842
  */
746
843
  loginSaml2BearerGrant(clientId, clientSecret, orgName, assertion) {
747
844
  this.clientId = clientId;
845
+ var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
748
846
  return new Promise((resolve, reject) => {
749
847
  if (typeof window !== 'undefined') {
750
848
  reject(new Error('The saml2bearer grant is not supported in a browser.'));
@@ -770,7 +868,7 @@ class ApiClient {
770
868
  'trace',
771
869
  response.status,
772
870
  'POST',
773
- `https://login.${this.config.environment}/oauth/token`,
871
+ `${loginBasePath}/oauth/token`,
774
872
  request.headers,
775
873
  response.headers,
776
874
  bodyParam,
@@ -780,7 +878,7 @@ class ApiClient {
780
878
  'debug',
781
879
  response.status,
782
880
  'POST',
783
- `https://login.${this.config.environment}/oauth/token`,
881
+ `${loginBasePath}/oauth/token`,
784
882
  request.headers,
785
883
  undefined,
786
884
  bodyParam,
@@ -804,7 +902,7 @@ class ApiClient {
804
902
  'error',
805
903
  error.response.status,
806
904
  'POST',
807
- `https://login.${this.config.environment}/oauth/token`,
905
+ `${loginBasePath}/oauth/token`,
808
906
  request.headers,
809
907
  error.response.headers,
810
908
  bodyParam,
@@ -825,10 +923,11 @@ class ApiClient {
825
923
  */
826
924
  authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
827
925
  this.clientId = clientId;
926
+ var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
828
927
  return new Promise((resolve, reject) => {
829
928
  var request = axios__default["default"]({
830
929
  method: `POST`,
831
- url: `https://login.${this.config.environment}/oauth/token`,
930
+ url: `${loginBasePath}/oauth/token`,
832
931
  headers: {
833
932
  'Content-Type': 'application/x-www-form-urlencoded'
834
933
  },
@@ -855,7 +954,7 @@ class ApiClient {
855
954
  'trace',
856
955
  response.status,
857
956
  'POST',
858
- `https://login.${this.config.environment}/oauth/token`,
957
+ `${loginBasePath}/oauth/token`,
859
958
  request.headers,
860
959
  response.headers,
861
960
  bodyParam,
@@ -865,7 +964,7 @@ class ApiClient {
865
964
  'debug',
866
965
  response.status,
867
966
  'POST',
868
- `https://login.${this.config.environment}/oauth/token`,
967
+ `${loginBasePath}/oauth/token`,
869
968
  request.headers,
870
969
  undefined,
871
970
  bodyParam,
@@ -889,7 +988,7 @@ class ApiClient {
889
988
  'error',
890
989
  error.response.status,
891
990
  'POST',
892
- `https://login.${this.config.environment}/oauth/token`,
991
+ `${loginBasePath}/oauth/token`,
893
992
  request.headers,
894
993
  error.response.headers,
895
994
  bodyParam,
@@ -1213,6 +1312,8 @@ class ApiClient {
1213
1312
  * @param {function} reject - Promise reject callback
1214
1313
  */
1215
1314
  _handleCodeAuthorizationResponse(request, bodyParam, resolve, reject) {
1315
+ var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
1316
+
1216
1317
  request
1217
1318
  .then((response) => {
1218
1319
  // Logging
@@ -1220,7 +1321,7 @@ class ApiClient {
1220
1321
  'trace',
1221
1322
  response.status,
1222
1323
  'POST',
1223
- `https://login.${this.config.environment}/oauth/token`,
1324
+ `${loginBasePath}/oauth/token`,
1224
1325
  request.headers,
1225
1326
  response.headers,
1226
1327
  bodyParam,
@@ -1230,7 +1331,7 @@ class ApiClient {
1230
1331
  'debug',
1231
1332
  response.status,
1232
1333
  'POST',
1233
- `https://login.${this.config.environment}/oauth/token`,
1334
+ `${loginBasePath}/oauth/token`,
1234
1335
  request.headers,
1235
1336
  undefined,
1236
1337
  bodyParam,
@@ -1256,7 +1357,7 @@ class ApiClient {
1256
1357
  'error',
1257
1358
  error.response.status,
1258
1359
  'POST',
1259
- `https://login.${this.config.environment}/oauth/token`,
1360
+ `${loginBasePath}/oauth/token`,
1260
1361
  request.headers,
1261
1362
  error.response.headers,
1262
1363
  bodyParam,
@@ -1274,9 +1375,10 @@ class ApiClient {
1274
1375
  * @param {object} data - data to url form encode
1275
1376
  */
1276
1377
  _formAuthRequest(encodedData, data) {
1378
+ var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
1277
1379
  var request = axios__default["default"]({
1278
1380
  method: `POST`,
1279
- url: `https://login.${this.config.environment}/oauth/token`,
1381
+ url: `${loginBasePath}/oauth/token`,
1280
1382
  headers: {
1281
1383
  'Authorization': 'Basic ' + encodedData,
1282
1384
  'Content-Type': 'application/x-www-form-urlencoded'
@@ -1465,7 +1567,8 @@ class ApiClient {
1465
1567
  */
1466
1568
  _buildAuthUrl(path, query) {
1467
1569
  if (!query) query = {};
1468
- return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${this.config.authUrl}/${path}?`);
1570
+ var loginBasePath = this.config.getConfUrl('login', this.config.authUrl);
1571
+ return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
1469
1572
  }
1470
1573
 
1471
1574
  /**
@@ -1527,7 +1630,7 @@ class ApiClient {
1527
1630
  if (!path.match(/^\//)) {
1528
1631
  path = `/${path}`;
1529
1632
  }
1530
- var url = this.config.basePath + path;
1633
+ var url = this.config.getConfUrl('api', this.config.basePath) + path;
1531
1634
  url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
1532
1635
  var value;
1533
1636
  if (pathParams.hasOwnProperty(key)) {
@@ -1827,7 +1930,7 @@ class AgentAssistantsApi {
1827
1930
  /**
1828
1931
  * AgentAssistants service.
1829
1932
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
1830
- * @version 206.0.0
1933
+ * @version 208.0.0
1831
1934
  */
1832
1935
 
1833
1936
  /**
@@ -2203,7 +2306,7 @@ class AgentCopilotApi {
2203
2306
  /**
2204
2307
  * AgentCopilot service.
2205
2308
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
2206
- * @version 206.0.0
2309
+ * @version 208.0.0
2207
2310
  */
2208
2311
 
2209
2312
  /**
@@ -2279,7 +2382,7 @@ class AgentUIApi {
2279
2382
  /**
2280
2383
  * AgentUI service.
2281
2384
  * @module purecloud-platform-client-v2/api/AgentUIApi
2282
- * @version 206.0.0
2385
+ * @version 208.0.0
2283
2386
  */
2284
2387
 
2285
2388
  /**
@@ -2410,7 +2513,7 @@ class AlertingApi {
2410
2513
  /**
2411
2514
  * Alerting service.
2412
2515
  * @module purecloud-platform-client-v2/api/AlertingApi
2413
- * @version 206.0.0
2516
+ * @version 208.0.0
2414
2517
  */
2415
2518
 
2416
2519
  /**
@@ -3071,7 +3174,7 @@ class AnalyticsApi {
3071
3174
  /**
3072
3175
  * Analytics service.
3073
3176
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3074
- * @version 206.0.0
3177
+ * @version 208.0.0
3075
3178
  */
3076
3179
 
3077
3180
  /**
@@ -3922,6 +4025,7 @@ class AnalyticsApi {
3922
4025
  * @param {Number} opts.pageSize (default to 25)
3923
4026
  * @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
3924
4027
  * @param {Object} opts.state Only list users of this state
4028
+ * @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
3925
4029
  */
3926
4030
  getAnalyticsReportingDashboardsUsers(opts) {
3927
4031
  opts = opts || {};
@@ -3931,7 +4035,7 @@ class AnalyticsApi {
3931
4035
  '/api/v2/analytics/reporting/dashboards/users',
3932
4036
  'GET',
3933
4037
  { },
3934
- { 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
4038
+ { 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'],'deletedOnly': opts['deletedOnly'] },
3935
4039
  { },
3936
4040
  { },
3937
4041
  null,
@@ -4053,6 +4157,7 @@ class AnalyticsApi {
4053
4157
  * @param {Number} opts.pageSize (default to 50)
4054
4158
  * @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
4055
4159
  * @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
4160
+ * @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
4056
4161
  * @param {String} opts.name retrieve dashboards that match with given name
4057
4162
  */
4058
4163
  getAnalyticsReportingSettingsUserDashboards(userId, opts) {
@@ -4067,7 +4172,7 @@ class AnalyticsApi {
4067
4172
  '/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
4068
4173
  'GET',
4069
4174
  { 'userId': userId },
4070
- { 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
4175
+ { 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'deletedOnly': opts['deletedOnly'],'name': opts['name'] },
4071
4176
  { },
4072
4177
  { },
4073
4178
  null,
@@ -5157,7 +5262,7 @@ class AnalyticsApi {
5157
5262
  }
5158
5263
 
5159
5264
  /**
5160
- * Bulk delete dashboards owned by other user(s)
5265
+ * Bulk soft delete dashboards owned by other user(s)
5161
5266
  *
5162
5267
  * @param {Array.<String>} body List of userIds
5163
5268
  */
@@ -5207,7 +5312,7 @@ class AnalyticsApi {
5207
5312
  }
5208
5313
 
5209
5314
  /**
5210
- * Bulk remove dashboard configurations
5315
+ * Bulk soft delete dashboard configurations
5211
5316
  *
5212
5317
  * @param {Object} body
5213
5318
  */
@@ -5393,7 +5498,6 @@ class AnalyticsApi {
5393
5498
  * Query for task management aggregates
5394
5499
  *
5395
5500
  * @param {Object} body query
5396
- * postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5397
5501
  */
5398
5502
  postAnalyticsTaskmanagementAggregatesQuery(body) {
5399
5503
  // verify the required parameter 'body' is set
@@ -5683,7 +5787,7 @@ class ArchitectApi {
5683
5787
  /**
5684
5788
  * Architect service.
5685
5789
  * @module purecloud-platform-client-v2/api/ArchitectApi
5686
- * @version 206.0.0
5790
+ * @version 208.0.0
5687
5791
  */
5688
5792
 
5689
5793
  /**
@@ -7428,7 +7532,7 @@ class ArchitectApi {
7428
7532
  }
7429
7533
 
7430
7534
  /**
7431
- * Create flow version configuration
7535
+ * Get flow version configuration
7432
7536
  *
7433
7537
  * @param {String} flowId Flow ID
7434
7538
  * @param {String} versionId Version ID
@@ -9805,7 +9909,7 @@ class AuditApi {
9805
9909
  /**
9806
9910
  * Audit service.
9807
9911
  * @module purecloud-platform-client-v2/api/AuditApi
9808
- * @version 206.0.0
9912
+ * @version 208.0.0
9809
9913
  */
9810
9914
 
9811
9915
  /**
@@ -10006,7 +10110,7 @@ class AuthorizationApi {
10006
10110
  /**
10007
10111
  * Authorization service.
10008
10112
  * @module purecloud-platform-client-v2/api/AuthorizationApi
10009
- * @version 206.0.0
10113
+ * @version 208.0.0
10010
10114
  */
10011
10115
 
10012
10116
  /**
@@ -11289,7 +11393,7 @@ class BillingApi {
11289
11393
  /**
11290
11394
  * Billing service.
11291
11395
  * @module purecloud-platform-client-v2/api/BillingApi
11292
- * @version 206.0.0
11396
+ * @version 208.0.0
11293
11397
  */
11294
11398
 
11295
11399
  /**
@@ -11369,7 +11473,7 @@ class CarrierServicesApi {
11369
11473
  /**
11370
11474
  * CarrierServices service.
11371
11475
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
11372
- * @version 206.0.0
11476
+ * @version 208.0.0
11373
11477
  */
11374
11478
 
11375
11479
  /**
@@ -11439,7 +11543,7 @@ class ChatApi {
11439
11543
  /**
11440
11544
  * Chat service.
11441
11545
  * @module purecloud-platform-client-v2/api/ChatApi
11442
- * @version 206.0.0
11546
+ * @version 208.0.0
11443
11547
  */
11444
11548
 
11445
11549
  /**
@@ -12375,7 +12479,7 @@ class CoachingApi {
12375
12479
  /**
12376
12480
  * Coaching service.
12377
12481
  * @module purecloud-platform-client-v2/api/CoachingApi
12378
- * @version 206.0.0
12482
+ * @version 208.0.0
12379
12483
  */
12380
12484
 
12381
12485
  /**
@@ -12952,7 +13056,7 @@ class ContentManagementApi {
12952
13056
  /**
12953
13057
  * ContentManagement service.
12954
13058
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12955
- * @version 206.0.0
13059
+ * @version 208.0.0
12956
13060
  */
12957
13061
 
12958
13062
  /**
@@ -13341,7 +13445,6 @@ class ContentManagementApi {
13341
13445
  * This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
13342
13446
  * @param {String} sharedId Shared ID
13343
13447
  * @param {Object} opts Optional parameters
13344
- * @param {Boolean} opts.redirect Turn on or off redirect (default to true)
13345
13448
  * @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
13346
13449
  * @param {String} opts.contentType The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
13347
13450
  * @param {Object} opts.expand Expand some document fields
@@ -13358,7 +13461,7 @@ class ContentManagementApi {
13358
13461
  '/api/v2/contentmanagement/shared/{sharedId}',
13359
13462
  'GET',
13360
13463
  { 'sharedId': sharedId },
13361
- { 'redirect': opts['redirect'],'disposition': opts['disposition'],'contentType': opts['contentType'],'expand': opts['expand'] },
13464
+ { 'disposition': opts['disposition'],'contentType': opts['contentType'],'expand': opts['expand'] },
13362
13465
  { },
13363
13466
  { },
13364
13467
  null,
@@ -14034,7 +14137,7 @@ class ConversationsApi {
14034
14137
  /**
14035
14138
  * Conversations service.
14036
14139
  * @module purecloud-platform-client-v2/api/ConversationsApi
14037
- * @version 206.0.0
14140
+ * @version 208.0.0
14038
14141
  */
14039
14142
 
14040
14143
  /**
@@ -18727,9 +18830,10 @@ class ConversationsApi {
18727
18830
 
18728
18831
  /**
18729
18832
  * Suggestion feedback.
18730
- *
18833
+ * Google Agent Assist offering within Genesys will no longer be supported
18731
18834
  * @param {String} conversationId Conversation ID
18732
18835
  * @param {Object} body SuggestionFeedback
18836
+ * @deprecated
18733
18837
  */
18734
18838
  postConversationSuggestionsFeedback(conversationId, body) {
18735
18839
  // verify the required parameter 'conversationId' is set
@@ -21175,7 +21279,7 @@ class DataExtensionsApi {
21175
21279
  /**
21176
21280
  * DataExtensions service.
21177
21281
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
21178
- * @version 206.0.0
21282
+ * @version 208.0.0
21179
21283
  */
21180
21284
 
21181
21285
  /**
@@ -21261,7 +21365,7 @@ class DownloadsApi {
21261
21365
  /**
21262
21366
  * Downloads service.
21263
21367
  * @module purecloud-platform-client-v2/api/DownloadsApi
21264
- * @version 206.0.0
21368
+ * @version 208.0.0
21265
21369
  */
21266
21370
 
21267
21371
  /**
@@ -21313,7 +21417,7 @@ class EmailsApi {
21313
21417
  /**
21314
21418
  * Emails service.
21315
21419
  * @module purecloud-platform-client-v2/api/EmailsApi
21316
- * @version 206.0.0
21420
+ * @version 208.0.0
21317
21421
  */
21318
21422
 
21319
21423
  /**
@@ -21378,7 +21482,7 @@ class EmployeeEngagementApi {
21378
21482
  /**
21379
21483
  * EmployeeEngagement service.
21380
21484
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
21381
- * @version 206.0.0
21485
+ * @version 208.0.0
21382
21486
  */
21383
21487
 
21384
21488
  /**
@@ -21529,7 +21633,7 @@ class EventsApi {
21529
21633
  /**
21530
21634
  * Events service.
21531
21635
  * @module purecloud-platform-client-v2/api/EventsApi
21532
- * @version 206.0.0
21636
+ * @version 208.0.0
21533
21637
  */
21534
21638
 
21535
21639
  /**
@@ -21625,7 +21729,7 @@ class ExternalContactsApi {
21625
21729
  /**
21626
21730
  * ExternalContacts service.
21627
21731
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
21628
- * @version 206.0.0
21732
+ * @version 208.0.0
21629
21733
  */
21630
21734
 
21631
21735
  /**
@@ -21724,7 +21828,6 @@ class ExternalContactsApi {
21724
21828
  * Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
21725
21829
  *
21726
21830
  * @param {String} externalSourceId External Source ID
21727
- * deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
21728
21831
  */
21729
21832
  deleteExternalcontactsExternalsource(externalSourceId) {
21730
21833
  // verify the required parameter 'externalSourceId' is set
@@ -21746,6 +21849,31 @@ class ExternalContactsApi {
21746
21849
  );
21747
21850
  }
21748
21851
 
21852
+ /**
21853
+ * Delete settings for CSV import
21854
+ *
21855
+ * @param {String} settingsId Settings id
21856
+ */
21857
+ deleteExternalcontactsImportCsvSetting(settingsId) {
21858
+ // verify the required parameter 'settingsId' is set
21859
+ if (settingsId === undefined || settingsId === null) {
21860
+ throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';
21861
+ }
21862
+
21863
+ return this.apiClient.callApi(
21864
+ '/api/v2/externalcontacts/import/csv/settings/{settingsId}',
21865
+ 'DELETE',
21866
+ { 'settingsId': settingsId },
21867
+ { },
21868
+ { },
21869
+ { },
21870
+ null,
21871
+ ['PureCloud OAuth'],
21872
+ ['application/json'],
21873
+ ['application/json']
21874
+ );
21875
+ }
21876
+
21749
21877
  /**
21750
21878
  * Delete an external organization
21751
21879
  *
@@ -22007,7 +22135,7 @@ class ExternalContactsApi {
22007
22135
  *
22008
22136
  * @param {String} contactId ExternalContact ID
22009
22137
  * @param {Object} opts Optional parameters
22010
- * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
22138
+ * @param {Array.<String>} opts.expand which fields, if any, to expand
22011
22139
  */
22012
22140
  getExternalcontactsContactUnresolved(contactId, opts) {
22013
22141
  opts = opts || {};
@@ -22163,7 +22291,6 @@ class ExternalContactsApi {
22163
22291
  * Fetch an External Source
22164
22292
  *
22165
22293
  * @param {String} externalSourceId External Source ID
22166
- * getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22167
22294
  */
22168
22295
  getExternalcontactsExternalsource(externalSourceId) {
22169
22296
  // verify the required parameter 'externalSourceId' is set
@@ -22193,7 +22320,6 @@ class ExternalContactsApi {
22193
22320
  * @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
22194
22321
  * @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
22195
22322
  * @param {Boolean} opts.active Filter by active status of external source
22196
- * getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22197
22323
  */
22198
22324
  getExternalcontactsExternalsources(opts) {
22199
22325
  opts = opts || {};
@@ -22213,12 +22339,113 @@ class ExternalContactsApi {
22213
22339
  );
22214
22340
  }
22215
22341
 
22342
+ /**
22343
+ * Get settings for CSV import
22344
+ *
22345
+ * @param {String} settingsId Settings id
22346
+ */
22347
+ getExternalcontactsImportCsvSetting(settingsId) {
22348
+ // verify the required parameter 'settingsId' is set
22349
+ if (settingsId === undefined || settingsId === null) {
22350
+ throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';
22351
+ }
22352
+
22353
+ return this.apiClient.callApi(
22354
+ '/api/v2/externalcontacts/import/csv/settings/{settingsId}',
22355
+ 'GET',
22356
+ { 'settingsId': settingsId },
22357
+ { },
22358
+ { },
22359
+ { },
22360
+ null,
22361
+ ['PureCloud OAuth'],
22362
+ ['application/json'],
22363
+ ['application/json']
22364
+ );
22365
+ }
22366
+
22367
+ /**
22368
+ * Retrieve all settings for organization filtered by externalSettingsId if provided
22369
+ *
22370
+ * @param {Object} opts Optional parameters
22371
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22372
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22373
+ * @param {String} opts.externalSettingsId External Settings Id to filter the list.
22374
+ */
22375
+ getExternalcontactsImportCsvSettings(opts) {
22376
+ opts = opts || {};
22377
+
22378
+
22379
+ return this.apiClient.callApi(
22380
+ '/api/v2/externalcontacts/import/csv/settings',
22381
+ 'GET',
22382
+ { },
22383
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'externalSettingsId': opts['externalSettingsId'] },
22384
+ { },
22385
+ { },
22386
+ null,
22387
+ ['PureCloud OAuth'],
22388
+ ['application/json'],
22389
+ ['application/json']
22390
+ );
22391
+ }
22392
+
22393
+ /**
22394
+ * Get details for CSV upload
22395
+ *
22396
+ * @param {String} uploadId Upload id
22397
+ */
22398
+ getExternalcontactsImportCsvUploadDetails(uploadId) {
22399
+ // verify the required parameter 'uploadId' is set
22400
+ if (uploadId === undefined || uploadId === null) {
22401
+ throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';
22402
+ }
22403
+
22404
+ return this.apiClient.callApi(
22405
+ '/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details',
22406
+ 'GET',
22407
+ { 'uploadId': uploadId },
22408
+ { },
22409
+ { },
22410
+ { },
22411
+ null,
22412
+ ['PureCloud OAuth'],
22413
+ ['application/json'],
22414
+ ['application/json']
22415
+ );
22416
+ }
22417
+
22418
+ /**
22419
+ * Get preview for CSV upload
22420
+ *
22421
+ * @param {String} uploadId Upload id
22422
+ */
22423
+ getExternalcontactsImportCsvUploadPreview(uploadId) {
22424
+ // verify the required parameter 'uploadId' is set
22425
+ if (uploadId === undefined || uploadId === null) {
22426
+ throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';
22427
+ }
22428
+
22429
+ return this.apiClient.callApi(
22430
+ '/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview',
22431
+ 'GET',
22432
+ { 'uploadId': uploadId },
22433
+ { },
22434
+ { },
22435
+ { },
22436
+ null,
22437
+ ['PureCloud OAuth'],
22438
+ ['application/json'],
22439
+ ['application/json']
22440
+ );
22441
+ }
22442
+
22216
22443
  /**
22217
22444
  * Fetch an external organization
22218
22445
  *
22219
22446
  * @param {String} externalOrganizationId External Organization ID
22220
22447
  * @param {Object} opts Optional parameters
22221
- * @param {Array.<String>} opts.expand which fields, if any, to expand (externalDataSources)
22448
+ * @param {Array.<String>} opts.expand which fields, if any, to expand
22222
22449
  * @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
22223
22450
  */
22224
22451
  getExternalcontactsOrganization(externalOrganizationId, opts) {
@@ -23226,7 +23453,6 @@ class ExternalContactsApi {
23226
23453
  * Create an External Source
23227
23454
  *
23228
23455
  * @param {Object} body External Source
23229
- * postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
23230
23456
  */
23231
23457
  postExternalcontactsExternalsources(body) {
23232
23458
  // verify the required parameter 'body' is set
@@ -23277,6 +23503,81 @@ class ExternalContactsApi {
23277
23503
  );
23278
23504
  }
23279
23505
 
23506
+ /**
23507
+ * Create CSV import job
23508
+ *
23509
+ * @param {Object} body ImportRequest
23510
+ */
23511
+ postExternalcontactsImportCsvJobs(body) {
23512
+ // verify the required parameter 'body' is set
23513
+ if (body === undefined || body === null) {
23514
+ throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';
23515
+ }
23516
+
23517
+ return this.apiClient.callApi(
23518
+ '/api/v2/externalcontacts/import/csv/jobs',
23519
+ 'POST',
23520
+ { },
23521
+ { },
23522
+ { },
23523
+ { },
23524
+ body,
23525
+ ['PureCloud OAuth'],
23526
+ ['application/json'],
23527
+ ['application/json']
23528
+ );
23529
+ }
23530
+
23531
+ /**
23532
+ * Create settings for CSV import
23533
+ *
23534
+ * @param {Object} body Settings
23535
+ */
23536
+ postExternalcontactsImportCsvSettings(body) {
23537
+ // verify the required parameter 'body' is set
23538
+ if (body === undefined || body === null) {
23539
+ throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';
23540
+ }
23541
+
23542
+ return this.apiClient.callApi(
23543
+ '/api/v2/externalcontacts/import/csv/settings',
23544
+ 'POST',
23545
+ { },
23546
+ { },
23547
+ { },
23548
+ { },
23549
+ body,
23550
+ ['PureCloud OAuth'],
23551
+ ['application/json'],
23552
+ ['application/json']
23553
+ );
23554
+ }
23555
+
23556
+ /**
23557
+ * Get url for CSV upload
23558
+ *
23559
+ * @param {Object} body UploadRequest
23560
+ */
23561
+ postExternalcontactsImportCsvUploads(body) {
23562
+ // verify the required parameter 'body' is set
23563
+ if (body === undefined || body === null) {
23564
+ throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';
23565
+ }
23566
+
23567
+ return this.apiClient.callApi(
23568
+ '/api/v2/externalcontacts/import/csv/uploads',
23569
+ 'POST',
23570
+ { },
23571
+ { },
23572
+ { },
23573
+ { },
23574
+ body,
23575
+ ['PureCloud OAuth'],
23576
+ ['application/json'],
23577
+ ['application/json']
23578
+ );
23579
+ }
23580
+
23280
23581
  /**
23281
23582
  * Merge two contacts into a new contact record
23282
23583
  * Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
@@ -23537,7 +23838,6 @@ class ExternalContactsApi {
23537
23838
  *
23538
23839
  * @param {String} externalSourceId External Source ID
23539
23840
  * @param {Object} body External Source
23540
- * putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
23541
23841
  */
23542
23842
  putExternalcontactsExternalsource(externalSourceId, body) {
23543
23843
  // verify the required parameter 'externalSourceId' is set
@@ -23563,6 +23863,36 @@ class ExternalContactsApi {
23563
23863
  );
23564
23864
  }
23565
23865
 
23866
+ /**
23867
+ * Update settings for CSV import
23868
+ *
23869
+ * @param {String} settingsId Settings id
23870
+ * @param {Object} body Settings
23871
+ */
23872
+ putExternalcontactsImportCsvSetting(settingsId, body) {
23873
+ // verify the required parameter 'settingsId' is set
23874
+ if (settingsId === undefined || settingsId === null) {
23875
+ throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';
23876
+ }
23877
+ // verify the required parameter 'body' is set
23878
+ if (body === undefined || body === null) {
23879
+ throw 'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';
23880
+ }
23881
+
23882
+ return this.apiClient.callApi(
23883
+ '/api/v2/externalcontacts/import/csv/settings/{settingsId}',
23884
+ 'PUT',
23885
+ { 'settingsId': settingsId },
23886
+ { },
23887
+ { },
23888
+ { },
23889
+ body,
23890
+ ['PureCloud OAuth'],
23891
+ ['application/json'],
23892
+ ['application/json']
23893
+ );
23894
+ }
23895
+
23566
23896
  /**
23567
23897
  * Update an external organization
23568
23898
  *
@@ -23724,7 +24054,7 @@ class FaxApi {
23724
24054
  /**
23725
24055
  * Fax service.
23726
24056
  * @module purecloud-platform-client-v2/api/FaxApi
23727
- * @version 206.0.0
24057
+ * @version 208.0.0
23728
24058
  */
23729
24059
 
23730
24060
  /**
@@ -23939,7 +24269,7 @@ class FlowsApi {
23939
24269
  /**
23940
24270
  * Flows service.
23941
24271
  * @module purecloud-platform-client-v2/api/FlowsApi
23942
- * @version 206.0.0
24272
+ * @version 208.0.0
23943
24273
  */
23944
24274
 
23945
24275
  /**
@@ -24122,7 +24452,7 @@ class GamificationApi {
24122
24452
  /**
24123
24453
  * Gamification service.
24124
24454
  * @module purecloud-platform-client-v2/api/GamificationApi
24125
- * @version 206.0.0
24455
+ * @version 208.0.0
24126
24456
  */
24127
24457
 
24128
24458
  /**
@@ -26208,7 +26538,7 @@ class GeneralDataProtectionRegulationApi {
26208
26538
  /**
26209
26539
  * GeneralDataProtectionRegulation service.
26210
26540
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
26211
- * @version 206.0.0
26541
+ * @version 208.0.0
26212
26542
  */
26213
26543
 
26214
26544
  /**
@@ -26338,7 +26668,7 @@ class GeolocationApi {
26338
26668
  /**
26339
26669
  * Geolocation service.
26340
26670
  * @module purecloud-platform-client-v2/api/GeolocationApi
26341
- * @version 206.0.0
26671
+ * @version 208.0.0
26342
26672
  */
26343
26673
 
26344
26674
  /**
@@ -26469,7 +26799,7 @@ class GreetingsApi {
26469
26799
  /**
26470
26800
  * Greetings service.
26471
26801
  * @module purecloud-platform-client-v2/api/GreetingsApi
26472
- * @version 206.0.0
26802
+ * @version 208.0.0
26473
26803
  */
26474
26804
 
26475
26805
  /**
@@ -26924,7 +27254,7 @@ class GroupsApi {
26924
27254
  /**
26925
27255
  * Groups service.
26926
27256
  * @module purecloud-platform-client-v2/api/GroupsApi
26927
- * @version 206.0.0
27257
+ * @version 208.0.0
26928
27258
  */
26929
27259
 
26930
27260
  /**
@@ -27443,7 +27773,7 @@ class IdentityProviderApi {
27443
27773
  /**
27444
27774
  * IdentityProvider service.
27445
27775
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
27446
- * @version 206.0.0
27776
+ * @version 208.0.0
27447
27777
  */
27448
27778
 
27449
27779
  /**
@@ -28304,7 +28634,7 @@ class InfrastructureAsCodeApi {
28304
28634
  /**
28305
28635
  * InfrastructureAsCode service.
28306
28636
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
28307
- * @version 206.0.0
28637
+ * @version 208.0.0
28308
28638
  */
28309
28639
 
28310
28640
  /**
@@ -28471,7 +28801,7 @@ class IntegrationsApi {
28471
28801
  /**
28472
28802
  * Integrations service.
28473
28803
  * @module purecloud-platform-client-v2/api/IntegrationsApi
28474
- * @version 206.0.0
28804
+ * @version 208.0.0
28475
28805
  */
28476
28806
 
28477
28807
  /**
@@ -28765,8 +29095,12 @@ class IntegrationsApi {
28765
29095
  *
28766
29096
  * @param {String} actionId actionId
28767
29097
  * @param {String} fileName Name of schema file to be retrieved for this draft.
29098
+ * @param {Object} opts Optional parameters
29099
+ * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
28768
29100
  */
28769
- getIntegrationsActionDraftSchema(actionId, fileName) {
29101
+ getIntegrationsActionDraftSchema(actionId, fileName, opts) {
29102
+ opts = opts || {};
29103
+
28770
29104
  // verify the required parameter 'actionId' is set
28771
29105
  if (actionId === undefined || actionId === null) {
28772
29106
  throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';
@@ -28780,7 +29114,7 @@ class IntegrationsApi {
28780
29114
  '/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}',
28781
29115
  'GET',
28782
29116
  { 'actionId': actionId,'fileName': fileName },
28783
- { },
29117
+ { 'flatten': opts['flatten'] },
28784
29118
  { },
28785
29119
  { },
28786
29120
  null,
@@ -28876,8 +29210,12 @@ class IntegrationsApi {
28876
29210
  *
28877
29211
  * @param {String} actionId actionId
28878
29212
  * @param {String} fileName Name of schema file to be retrieved for this action.
29213
+ * @param {Object} opts Optional parameters
29214
+ * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
28879
29215
  */
28880
- getIntegrationsActionSchema(actionId, fileName) {
29216
+ getIntegrationsActionSchema(actionId, fileName, opts) {
29217
+ opts = opts || {};
29218
+
28881
29219
  // verify the required parameter 'actionId' is set
28882
29220
  if (actionId === undefined || actionId === null) {
28883
29221
  throw 'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';
@@ -28891,7 +29229,7 @@ class IntegrationsApi {
28891
29229
  '/api/v2/integrations/actions/{actionId}/schemas/{fileName}',
28892
29230
  'GET',
28893
29231
  { 'actionId': actionId,'fileName': fileName },
28894
- { },
29232
+ { 'flatten': opts['flatten'] },
28895
29233
  { },
28896
29234
  { },
28897
29235
  null,
@@ -30428,8 +30766,12 @@ class IntegrationsApi {
30428
30766
  *
30429
30767
  * @param {String} actionId actionId
30430
30768
  * @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
30769
+ * @param {Object} opts Optional parameters
30770
+ * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
30431
30771
  */
30432
- postIntegrationsActionDraftTest(actionId, body) {
30772
+ postIntegrationsActionDraftTest(actionId, body, opts) {
30773
+ opts = opts || {};
30774
+
30433
30775
  // verify the required parameter 'actionId' is set
30434
30776
  if (actionId === undefined || actionId === null) {
30435
30777
  throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';
@@ -30443,7 +30785,7 @@ class IntegrationsApi {
30443
30785
  '/api/v2/integrations/actions/{actionId}/draft/test',
30444
30786
  'POST',
30445
30787
  { 'actionId': actionId },
30446
- { },
30788
+ { 'flatten': opts['flatten'] },
30447
30789
  { },
30448
30790
  { },
30449
30791
  body,
@@ -30458,8 +30800,12 @@ class IntegrationsApi {
30458
30800
  *
30459
30801
  * @param {String} actionId actionId
30460
30802
  * @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
30803
+ * @param {Object} opts Optional parameters
30804
+ * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
30461
30805
  */
30462
- postIntegrationsActionExecute(actionId, body) {
30806
+ postIntegrationsActionExecute(actionId, body, opts) {
30807
+ opts = opts || {};
30808
+
30463
30809
  // verify the required parameter 'actionId' is set
30464
30810
  if (actionId === undefined || actionId === null) {
30465
30811
  throw 'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';
@@ -30473,7 +30819,7 @@ class IntegrationsApi {
30473
30819
  '/api/v2/integrations/actions/{actionId}/execute',
30474
30820
  'POST',
30475
30821
  { 'actionId': actionId },
30476
- { },
30822
+ { 'flatten': opts['flatten'] },
30477
30823
  { },
30478
30824
  { },
30479
30825
  body,
@@ -30488,8 +30834,12 @@ class IntegrationsApi {
30488
30834
  *
30489
30835
  * @param {String} actionId actionId
30490
30836
  * @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
30837
+ * @param {Object} opts Optional parameters
30838
+ * @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
30491
30839
  */
30492
- postIntegrationsActionTest(actionId, body) {
30840
+ postIntegrationsActionTest(actionId, body, opts) {
30841
+ opts = opts || {};
30842
+
30493
30843
  // verify the required parameter 'actionId' is set
30494
30844
  if (actionId === undefined || actionId === null) {
30495
30845
  throw 'Missing the required parameter "actionId" when calling postIntegrationsActionTest';
@@ -30503,7 +30853,7 @@ class IntegrationsApi {
30503
30853
  '/api/v2/integrations/actions/{actionId}/test',
30504
30854
  'POST',
30505
30855
  { 'actionId': actionId },
30506
- { },
30856
+ { 'flatten': opts['flatten'] },
30507
30857
  { },
30508
30858
  { },
30509
30859
  body,
@@ -30893,7 +31243,7 @@ class JourneyApi {
30893
31243
  /**
30894
31244
  * Journey service.
30895
31245
  * @module purecloud-platform-client-v2/api/JourneyApi
30896
- * @version 206.0.0
31246
+ * @version 208.0.0
30897
31247
  */
30898
31248
 
30899
31249
  /**
@@ -31062,6 +31412,31 @@ class JourneyApi {
31062
31412
  );
31063
31413
  }
31064
31414
 
31415
+ /**
31416
+ * Delete the Schedule of a JourneyView
31417
+ * used for long descriptions
31418
+ * @param {String} viewId Journey View Id
31419
+ */
31420
+ deleteJourneyViewSchedules(viewId) {
31421
+ // verify the required parameter 'viewId' is set
31422
+ if (viewId === undefined || viewId === null) {
31423
+ throw 'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';
31424
+ }
31425
+
31426
+ return this.apiClient.callApi(
31427
+ '/api/v2/journey/views/{viewId}/schedules',
31428
+ 'DELETE',
31429
+ { 'viewId': viewId },
31430
+ { },
31431
+ { },
31432
+ { },
31433
+ null,
31434
+ ['PureCloud OAuth'],
31435
+ ['application/json'],
31436
+ ['application/json']
31437
+ );
31438
+ }
31439
+
31065
31440
  /**
31066
31441
  * Get status for async query for journey aggregates
31067
31442
  *
@@ -31710,6 +32085,31 @@ class JourneyApi {
31710
32085
  );
31711
32086
  }
31712
32087
 
32088
+ /**
32089
+ * Get the Schedule for a JourneyView
32090
+ * used for long descriptions
32091
+ * @param {String} viewId Journey View Id
32092
+ */
32093
+ getJourneyViewSchedules(viewId) {
32094
+ // verify the required parameter 'viewId' is set
32095
+ if (viewId === undefined || viewId === null) {
32096
+ throw 'Missing the required parameter "viewId" when calling getJourneyViewSchedules';
32097
+ }
32098
+
32099
+ return this.apiClient.callApi(
32100
+ '/api/v2/journey/views/{viewId}/schedules',
32101
+ 'GET',
32102
+ { 'viewId': viewId },
32103
+ { },
32104
+ { },
32105
+ { },
32106
+ null,
32107
+ ['PureCloud OAuth'],
32108
+ ['application/json'],
32109
+ ['application/json']
32110
+ );
32111
+ }
32112
+
31713
32113
  /**
31714
32114
  * Get a Journey View by ID and version
31715
32115
  *
@@ -31987,7 +32387,6 @@ class JourneyApi {
31987
32387
  * Get an Event Definition
31988
32388
  *
31989
32389
  * @param {String} eventDefinitionId Event Definition ID
31990
- * getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31991
32390
  */
31992
32391
  getJourneyViewsEventdefinition(eventDefinitionId) {
31993
32392
  // verify the required parameter 'eventDefinitionId' is set
@@ -32012,7 +32411,6 @@ class JourneyApi {
32012
32411
  /**
32013
32412
  * Get a list of Event Definitions
32014
32413
  *
32015
- * getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
32016
32414
  */
32017
32415
  getJourneyViewsEventdefinitions() {
32018
32416
 
@@ -32057,6 +32455,31 @@ class JourneyApi {
32057
32455
  );
32058
32456
  }
32059
32457
 
32458
+ /**
32459
+ * Get the journey schedules for an organization.
32460
+ *
32461
+ * @param {Object} opts Optional parameters
32462
+ * @param {Number} opts.pageNumber The number of the page to return (default to 1)
32463
+ * @param {Number} opts.pageSize Max number of entities to return (default to 25)
32464
+ */
32465
+ getJourneyViewsSchedules(opts) {
32466
+ opts = opts || {};
32467
+
32468
+
32469
+ return this.apiClient.callApi(
32470
+ '/api/v2/journey/views/schedules',
32471
+ 'GET',
32472
+ { },
32473
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
32474
+ { },
32475
+ { },
32476
+ null,
32477
+ ['PureCloud OAuth'],
32478
+ ['application/json'],
32479
+ ['application/json']
32480
+ );
32481
+ }
32482
+
32060
32483
  /**
32061
32484
  * Update single action map.
32062
32485
  *
@@ -32575,6 +32998,36 @@ class JourneyApi {
32575
32998
  );
32576
32999
  }
32577
33000
 
33001
+ /**
33002
+ * Add a new Schedule to a JourneyView
33003
+ *
33004
+ * @param {String} viewId Journey View Id
33005
+ * @param {Object} body journeyViewSchedule
33006
+ */
33007
+ postJourneyViewSchedules(viewId, body) {
33008
+ // verify the required parameter 'viewId' is set
33009
+ if (viewId === undefined || viewId === null) {
33010
+ throw 'Missing the required parameter "viewId" when calling postJourneyViewSchedules';
33011
+ }
33012
+ // verify the required parameter 'body' is set
33013
+ if (body === undefined || body === null) {
33014
+ throw 'Missing the required parameter "body" when calling postJourneyViewSchedules';
33015
+ }
33016
+
33017
+ return this.apiClient.callApi(
33018
+ '/api/v2/journey/views/{viewId}/schedules',
33019
+ 'POST',
33020
+ { 'viewId': viewId },
33021
+ { },
33022
+ { },
33023
+ { },
33024
+ body,
33025
+ ['PureCloud OAuth'],
33026
+ ['application/json'],
33027
+ ['application/json']
33028
+ );
33029
+ }
33030
+
32578
33031
  /**
32579
33032
  * Submit a job request for a journey view version.
32580
33033
  * used for long descriptions
@@ -32665,7 +33118,6 @@ class JourneyApi {
32665
33118
  * True indicates a valid encoding
32666
33119
  * @param {Object} opts Optional parameters
32667
33120
  * @param {Array.<Object>} opts.body
32668
- * postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
32669
33121
  */
32670
33122
  postJourneyViewsEncodingsValidate(opts) {
32671
33123
  opts = opts || {};
@@ -32685,6 +33137,36 @@ class JourneyApi {
32685
33137
  );
32686
33138
  }
32687
33139
 
33140
+ /**
33141
+ * Update the Schedule for a JourneyView
33142
+ * used for long descriptions
33143
+ * @param {String} viewId Journey View Id
33144
+ * @param {Object} body journeyViewSchedule
33145
+ */
33146
+ putJourneyViewSchedules(viewId, body) {
33147
+ // verify the required parameter 'viewId' is set
33148
+ if (viewId === undefined || viewId === null) {
33149
+ throw 'Missing the required parameter "viewId" when calling putJourneyViewSchedules';
33150
+ }
33151
+ // verify the required parameter 'body' is set
33152
+ if (body === undefined || body === null) {
33153
+ throw 'Missing the required parameter "body" when calling putJourneyViewSchedules';
33154
+ }
33155
+
33156
+ return this.apiClient.callApi(
33157
+ '/api/v2/journey/views/{viewId}/schedules',
33158
+ 'PUT',
33159
+ { 'viewId': viewId },
33160
+ { },
33161
+ { },
33162
+ { },
33163
+ body,
33164
+ ['PureCloud OAuth'],
33165
+ ['application/json'],
33166
+ ['application/json']
33167
+ );
33168
+ }
33169
+
32688
33170
  /**
32689
33171
  * Update a Journey View by ID and version
32690
33172
  * does not create a new version
@@ -32726,7 +33208,7 @@ class KnowledgeApi {
32726
33208
  /**
32727
33209
  * Knowledge service.
32728
33210
  * @module purecloud-platform-client-v2/api/KnowledgeApi
32729
- * @version 206.0.0
33211
+ * @version 208.0.0
32730
33212
  */
32731
33213
 
32732
33214
  /**
@@ -33064,7 +33546,6 @@ class KnowledgeApi {
33064
33546
  *
33065
33547
  * @param {String} knowledgeBaseId Knowledge base ID
33066
33548
  * @param {String} sourceId Source ID
33067
- * deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
33068
33549
  */
33069
33550
  deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId) {
33070
33551
  // verify the required parameter 'knowledgeBaseId' is set
@@ -33095,7 +33576,6 @@ class KnowledgeApi {
33095
33576
  *
33096
33577
  * @param {String} knowledgeBaseId Knowledge base ID
33097
33578
  * @param {String} sourceId Source ID
33098
- * deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
33099
33579
  */
33100
33580
  deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId) {
33101
33581
  // verify the required parameter 'knowledgeBaseId' is set
@@ -33126,7 +33606,6 @@ class KnowledgeApi {
33126
33606
  *
33127
33607
  * @param {String} knowledgeBaseId Knowledge base ID
33128
33608
  * @param {String} syncJobId Synchronization job ID
33129
- * deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
33130
33609
  */
33131
33610
  deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
33132
33611
  // verify the required parameter 'knowledgeBaseId' is set
@@ -33253,7 +33732,6 @@ class KnowledgeApi {
33253
33732
  * Get sync options available for a knowledge-connect integration
33254
33733
  *
33255
33734
  * @param {String} integrationId Integration ID
33256
- * getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
33257
33735
  */
33258
33736
  getKnowledgeIntegrationOptions(integrationId) {
33259
33737
  // verify the required parameter 'integrationId' is set
@@ -33489,6 +33967,7 @@ class KnowledgeApi {
33489
33967
  * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
33490
33968
  * @param {Object} opts Optional parameters
33491
33969
  * @param {Object} opts.documentState The state of the document.
33970
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
33492
33971
  */
33493
33972
  getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
33494
33973
  opts = opts || {};
@@ -33510,7 +33989,7 @@ class KnowledgeApi {
33510
33989
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
33511
33990
  'GET',
33512
33991
  { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
33513
- { 'documentState': opts['documentState'] },
33992
+ { 'documentState': opts['documentState'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
33514
33993
  { },
33515
33994
  { },
33516
33995
  null,
@@ -33530,6 +34009,7 @@ class KnowledgeApi {
33530
34009
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
33531
34010
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
33532
34011
  * @param {Object} opts.documentState The state of the document.
34012
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
33533
34013
  */
33534
34014
  getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
33535
34015
  opts = opts || {};
@@ -33547,7 +34027,7 @@ class KnowledgeApi {
33547
34027
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
33548
34028
  'GET',
33549
34029
  { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
33550
- { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
34030
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
33551
34031
  { },
33552
34032
  { },
33553
34033
  null,
@@ -34200,7 +34680,6 @@ class KnowledgeApi {
34200
34680
  * @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
34201
34681
  * @param {String} opts.interval Retrieves the operations 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
34202
34682
  * @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
34203
- * getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
34204
34683
  */
34205
34684
  getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
34206
34685
  opts = opts || {};
@@ -34228,7 +34707,6 @@ class KnowledgeApi {
34228
34707
  * Get ids of operation creator users and oauth clients
34229
34708
  *
34230
34709
  * @param {String} knowledgeBaseId Knowledge base ID
34231
- * getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
34232
34710
  */
34233
34711
  getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
34234
34712
  // verify the required parameter 'knowledgeBaseId' is set
@@ -34293,7 +34771,6 @@ class KnowledgeApi {
34293
34771
  * @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
34294
34772
  * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
34295
34773
  * @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
34296
- * getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
34297
34774
  */
34298
34775
  getKnowledgeKnowledgebaseSources(knowledgeBaseId, opts) {
34299
34776
  opts = opts || {};
@@ -34324,7 +34801,6 @@ class KnowledgeApi {
34324
34801
  * @param {String} sourceId Source ID
34325
34802
  * @param {Object} opts Optional parameters
34326
34803
  * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
34327
- * getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
34328
34804
  */
34329
34805
  getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, opts) {
34330
34806
  opts = opts || {};
@@ -34359,7 +34835,6 @@ class KnowledgeApi {
34359
34835
  * @param {String} sourceId Source ID
34360
34836
  * @param {Object} opts Optional parameters
34361
34837
  * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
34362
- * getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
34363
34838
  */
34364
34839
  getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, opts) {
34365
34840
  opts = opts || {};
@@ -34392,7 +34867,6 @@ class KnowledgeApi {
34392
34867
  *
34393
34868
  * @param {String} knowledgeBaseId Knowledge base ID
34394
34869
  * @param {String} syncJobId Synchronization job ID
34395
- * getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
34396
34870
  */
34397
34871
  getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
34398
34872
  // verify the required parameter 'knowledgeBaseId' is set
@@ -35108,7 +35582,6 @@ class KnowledgeApi {
35108
35582
  * @param {String} knowledgeBaseId Knowledge base ID
35109
35583
  * @param {String} syncJobId Synchronization job ID
35110
35584
  * @param {Object} body
35111
- * patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
35112
35585
  */
35113
35586
  patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId, body) {
35114
35587
  // verify the required parameter 'knowledgeBaseId' is set
@@ -36330,7 +36803,6 @@ class KnowledgeApi {
36330
36803
  *
36331
36804
  * @param {String} knowledgeBaseId Knowledge base ID
36332
36805
  * @param {Object} body
36333
- * postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36334
36806
  */
36335
36807
  postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId, body) {
36336
36808
  // verify the required parameter 'knowledgeBaseId' is set
@@ -36361,7 +36833,6 @@ class KnowledgeApi {
36361
36833
  *
36362
36834
  * @param {String} knowledgeBaseId Knowledge base ID
36363
36835
  * @param {String} sourceId Source ID
36364
- * postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36365
36836
  */
36366
36837
  postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
36367
36838
  // verify the required parameter 'knowledgeBaseId' is set
@@ -36392,7 +36863,6 @@ class KnowledgeApi {
36392
36863
  *
36393
36864
  * @param {String} knowledgeBaseId Knowledge base ID
36394
36865
  * @param {Object} body
36395
- * postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36396
36866
  */
36397
36867
  postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId, body) {
36398
36868
  // verify the required parameter 'knowledgeBaseId' is set
@@ -36423,7 +36893,6 @@ class KnowledgeApi {
36423
36893
  *
36424
36894
  * @param {String} knowledgeBaseId Knowledge base ID
36425
36895
  * @param {String} sourceId Source ID
36426
- * postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36427
36896
  */
36428
36897
  postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
36429
36898
  // verify the required parameter 'knowledgeBaseId' is set
@@ -36454,7 +36923,6 @@ class KnowledgeApi {
36454
36923
  *
36455
36924
  * @param {String} knowledgeBaseId Knowledge base ID
36456
36925
  * @param {Object} body
36457
- * postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36458
36926
  */
36459
36927
  postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId, body) {
36460
36928
  // verify the required parameter 'knowledgeBaseId' is set
@@ -36542,7 +37010,6 @@ class KnowledgeApi {
36542
37010
  * @param {String} knowledgeBaseId Knowledge base ID
36543
37011
  * @param {String} sourceId Source ID
36544
37012
  * @param {Object} body
36545
- * putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36546
37013
  */
36547
37014
  putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, body) {
36548
37015
  // verify the required parameter 'knowledgeBaseId' is set
@@ -36578,7 +37045,6 @@ class KnowledgeApi {
36578
37045
  * @param {String} knowledgeBaseId Knowledge base ID
36579
37046
  * @param {String} sourceId Source ID
36580
37047
  * @param {Object} body
36581
- * putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36582
37048
  */
36583
37049
  putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, body) {
36584
37050
  // verify the required parameter 'knowledgeBaseId' is set
@@ -36614,7 +37080,7 @@ class LanguageUnderstandingApi {
36614
37080
  /**
36615
37081
  * LanguageUnderstanding service.
36616
37082
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
36617
- * @version 206.0.0
37083
+ * @version 208.0.0
36618
37084
  */
36619
37085
 
36620
37086
  /**
@@ -37648,7 +38114,7 @@ class LanguagesApi {
37648
38114
  /**
37649
38115
  * Languages service.
37650
38116
  * @module purecloud-platform-client-v2/api/LanguagesApi
37651
- * @version 206.0.0
38117
+ * @version 208.0.0
37652
38118
  */
37653
38119
 
37654
38120
  /**
@@ -37870,7 +38336,7 @@ class LearningApi {
37870
38336
  /**
37871
38337
  * Learning service.
37872
38338
  * @module purecloud-platform-client-v2/api/LearningApi
37873
- * @version 206.0.0
38339
+ * @version 208.0.0
37874
38340
  */
37875
38341
 
37876
38342
  /**
@@ -38899,7 +39365,7 @@ class LicenseApi {
38899
39365
  /**
38900
39366
  * License service.
38901
39367
  * @module purecloud-platform-client-v2/api/LicenseApi
38902
- * @version 206.0.0
39368
+ * @version 208.0.0
38903
39369
  */
38904
39370
 
38905
39371
  /**
@@ -39137,7 +39603,7 @@ class LocationsApi {
39137
39603
  /**
39138
39604
  * Locations service.
39139
39605
  * @module purecloud-platform-client-v2/api/LocationsApi
39140
- * @version 206.0.0
39606
+ * @version 208.0.0
39141
39607
  */
39142
39608
 
39143
39609
  /**
@@ -39373,7 +39839,7 @@ class LogCaptureApi {
39373
39839
  /**
39374
39840
  * LogCapture service.
39375
39841
  * @module purecloud-platform-client-v2/api/LogCaptureApi
39376
- * @version 206.0.0
39842
+ * @version 208.0.0
39377
39843
  */
39378
39844
 
39379
39845
  /**
@@ -39573,7 +40039,7 @@ class MessagingApi {
39573
40039
  /**
39574
40040
  * Messaging service.
39575
40041
  * @module purecloud-platform-client-v2/api/MessagingApi
39576
- * @version 206.0.0
40042
+ * @version 208.0.0
39577
40043
  */
39578
40044
 
39579
40045
  /**
@@ -39932,7 +40398,7 @@ class MobileDevicesApi {
39932
40398
  /**
39933
40399
  * MobileDevices service.
39934
40400
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
39935
- * @version 206.0.0
40401
+ * @version 208.0.0
39936
40402
  */
39937
40403
 
39938
40404
  /**
@@ -40083,7 +40549,7 @@ class NotificationsApi {
40083
40549
  /**
40084
40550
  * Notifications service.
40085
40551
  * @module purecloud-platform-client-v2/api/NotificationsApi
40086
- * @version 206.0.0
40552
+ * @version 208.0.0
40087
40553
  */
40088
40554
 
40089
40555
  /**
@@ -40316,7 +40782,7 @@ class OAuthApi {
40316
40782
  /**
40317
40783
  * OAuth service.
40318
40784
  * @module purecloud-platform-client-v2/api/OAuthApi
40319
- * @version 206.0.0
40785
+ * @version 208.0.0
40320
40786
  */
40321
40787
 
40322
40788
  /**
@@ -40682,7 +41148,7 @@ class ObjectsApi {
40682
41148
  /**
40683
41149
  * Objects service.
40684
41150
  * @module purecloud-platform-client-v2/api/ObjectsApi
40685
- * @version 206.0.0
41151
+ * @version 208.0.0
40686
41152
  */
40687
41153
 
40688
41154
  /**
@@ -40952,7 +41418,7 @@ class OperationalEventsApi {
40952
41418
  /**
40953
41419
  * OperationalEvents service.
40954
41420
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
40955
- * @version 206.0.0
41421
+ * @version 208.0.0
40956
41422
  */
40957
41423
 
40958
41424
  /**
@@ -41018,7 +41484,7 @@ class OrganizationApi {
41018
41484
  /**
41019
41485
  * Organization service.
41020
41486
  * @module purecloud-platform-client-v2/api/OrganizationApi
41021
- * @version 206.0.0
41487
+ * @version 208.0.0
41022
41488
  */
41023
41489
 
41024
41490
  /**
@@ -41560,7 +42026,7 @@ class OrganizationAuthorizationApi {
41560
42026
  /**
41561
42027
  * OrganizationAuthorization service.
41562
42028
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
41563
- * @version 206.0.0
42029
+ * @version 208.0.0
41564
42030
  */
41565
42031
 
41566
42032
  /**
@@ -42197,6 +42663,26 @@ class OrganizationAuthorizationApi {
42197
42663
  );
42198
42664
  }
42199
42665
 
42666
+ /**
42667
+ * Get Customer Care organization ids.
42668
+ *
42669
+ */
42670
+ getOrgauthorizationTrusteesCare() {
42671
+
42672
+ return this.apiClient.callApi(
42673
+ '/api/v2/orgauthorization/trustees/care',
42674
+ 'GET',
42675
+ { },
42676
+ { },
42677
+ { },
42678
+ { },
42679
+ null,
42680
+ ['PureCloud OAuth'],
42681
+ ['application/json'],
42682
+ ['application/json']
42683
+ );
42684
+ }
42685
+
42200
42686
  /**
42201
42687
  * Get organization authorization trust with Customer Care, if one exists.
42202
42688
  *
@@ -42584,6 +43070,33 @@ class OrganizationAuthorizationApi {
42584
43070
  );
42585
43071
  }
42586
43072
 
43073
+ /**
43074
+ * Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
43075
+ *
43076
+ * @param {Object} opts Optional parameters
43077
+ * @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
43078
+ * @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
43079
+ * @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
43080
+ * @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
43081
+ */
43082
+ postOrgauthorizationTrusteesCare(opts) {
43083
+ opts = opts || {};
43084
+
43085
+
43086
+ return this.apiClient.callApi(
43087
+ '/api/v2/orgauthorization/trustees/care',
43088
+ 'POST',
43089
+ { },
43090
+ { 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'],'assignFullAccess': opts['assignFullAccess'],'allowTrustedUserAccess': opts['allowTrustedUserAccess'] },
43091
+ { },
43092
+ { },
43093
+ null,
43094
+ ['PureCloud OAuth'],
43095
+ ['application/json'],
43096
+ ['application/json']
43097
+ );
43098
+ }
43099
+
42587
43100
  /**
42588
43101
  * Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
42589
43102
  *
@@ -42907,7 +43420,7 @@ class OutboundApi {
42907
43420
  /**
42908
43421
  * Outbound service.
42909
43422
  * @module purecloud-platform-client-v2/api/OutboundApi
42910
- * @version 206.0.0
43423
+ * @version 208.0.0
42911
43424
  */
42912
43425
 
42913
43426
  /**
@@ -45884,6 +46397,56 @@ class OutboundApi {
45884
46397
  );
45885
46398
  }
45886
46399
 
46400
+ /**
46401
+ * Start the campaign
46402
+ *
46403
+ * @param {String} campaignId Campaign ID
46404
+ */
46405
+ postOutboundCampaignStart(campaignId) {
46406
+ // verify the required parameter 'campaignId' is set
46407
+ if (campaignId === undefined || campaignId === null) {
46408
+ throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';
46409
+ }
46410
+
46411
+ return this.apiClient.callApi(
46412
+ '/api/v2/outbound/campaigns/{campaignId}/start',
46413
+ 'POST',
46414
+ { 'campaignId': campaignId },
46415
+ { },
46416
+ { },
46417
+ { },
46418
+ null,
46419
+ ['PureCloud OAuth'],
46420
+ ['application/json'],
46421
+ ['application/json']
46422
+ );
46423
+ }
46424
+
46425
+ /**
46426
+ * Stop the campaign
46427
+ *
46428
+ * @param {String} campaignId Campaign ID
46429
+ */
46430
+ postOutboundCampaignStop(campaignId) {
46431
+ // verify the required parameter 'campaignId' is set
46432
+ if (campaignId === undefined || campaignId === null) {
46433
+ throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';
46434
+ }
46435
+
46436
+ return this.apiClient.callApi(
46437
+ '/api/v2/outbound/campaigns/{campaignId}/stop',
46438
+ 'POST',
46439
+ { 'campaignId': campaignId },
46440
+ { },
46441
+ { },
46442
+ { },
46443
+ null,
46444
+ ['PureCloud OAuth'],
46445
+ ['application/json'],
46446
+ ['application/json']
46447
+ );
46448
+ }
46449
+
45887
46450
  /**
45888
46451
  * Create Campaign Rule
45889
46452
  *
@@ -46583,6 +47146,56 @@ class OutboundApi {
46583
47146
  );
46584
47147
  }
46585
47148
 
47149
+ /**
47150
+ * Start the campaign
47151
+ * Documented permissions are applicable based on campaign type.
47152
+ * @param {String} messagingCampaignId The Messaging Campaign ID
47153
+ */
47154
+ postOutboundMessagingcampaignStart(messagingCampaignId) {
47155
+ // verify the required parameter 'messagingCampaignId' is set
47156
+ if (messagingCampaignId === undefined || messagingCampaignId === null) {
47157
+ throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';
47158
+ }
47159
+
47160
+ return this.apiClient.callApi(
47161
+ '/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start',
47162
+ 'POST',
47163
+ { 'messagingCampaignId': messagingCampaignId },
47164
+ { },
47165
+ { },
47166
+ { },
47167
+ null,
47168
+ ['PureCloud OAuth'],
47169
+ ['application/json'],
47170
+ ['application/json']
47171
+ );
47172
+ }
47173
+
47174
+ /**
47175
+ * Stop the campaign
47176
+ * Documented permissions are applicable based on campaign type.
47177
+ * @param {String} messagingCampaignId The Messaging Campaign ID
47178
+ */
47179
+ postOutboundMessagingcampaignStop(messagingCampaignId) {
47180
+ // verify the required parameter 'messagingCampaignId' is set
47181
+ if (messagingCampaignId === undefined || messagingCampaignId === null) {
47182
+ throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';
47183
+ }
47184
+
47185
+ return this.apiClient.callApi(
47186
+ '/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop',
47187
+ 'POST',
47188
+ { 'messagingCampaignId': messagingCampaignId },
47189
+ { },
47190
+ { },
47191
+ { },
47192
+ null,
47193
+ ['PureCloud OAuth'],
47194
+ ['application/json'],
47195
+ ['application/json']
47196
+ );
47197
+ }
47198
+
46586
47199
  /**
46587
47200
  * Create a Messaging Campaign
46588
47201
  *
@@ -47354,7 +47967,7 @@ class PresenceApi {
47354
47967
  /**
47355
47968
  * Presence service.
47356
47969
  * @module purecloud-platform-client-v2/api/PresenceApi
47357
- * @version 206.0.0
47970
+ * @version 208.0.0
47358
47971
  */
47359
47972
 
47360
47973
  /**
@@ -48098,7 +48711,7 @@ class ProcessAutomationApi {
48098
48711
  /**
48099
48712
  * ProcessAutomation service.
48100
48713
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
48101
- * @version 206.0.0
48714
+ * @version 208.0.0
48102
48715
  */
48103
48716
 
48104
48717
  /**
@@ -48337,7 +48950,7 @@ class QualityApi {
48337
48950
  /**
48338
48951
  * Quality service.
48339
48952
  * @module purecloud-platform-client-v2/api/QualityApi
48340
- * @version 206.0.0
48953
+ * @version 208.0.0
48341
48954
  */
48342
48955
 
48343
48956
  /**
@@ -50123,7 +50736,7 @@ class RecordingApi {
50123
50736
  /**
50124
50737
  * Recording service.
50125
50738
  * @module purecloud-platform-client-v2/api/RecordingApi
50126
- * @version 206.0.0
50739
+ * @version 208.0.0
50127
50740
  */
50128
50741
 
50129
50742
  /**
@@ -51782,7 +52395,7 @@ class ResponseManagementApi {
51782
52395
  /**
51783
52396
  * ResponseManagement service.
51784
52397
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
51785
- * @version 206.0.0
52398
+ * @version 208.0.0
51786
52399
  */
51787
52400
 
51788
52401
  /**
@@ -52292,7 +52905,7 @@ class RoutingApi {
52292
52905
  /**
52293
52906
  * Routing service.
52294
52907
  * @module purecloud-platform-client-v2/api/RoutingApi
52295
- * @version 206.0.0
52908
+ * @version 208.0.0
52296
52909
  */
52297
52910
 
52298
52911
  /**
@@ -52877,7 +53490,7 @@ class RoutingApi {
52877
53490
  }
52878
53491
 
52879
53492
  /**
52880
- * Remove routing language from user
53493
+ * Remove a routing language from a user
52881
53494
  *
52882
53495
  * @param {String} userId User ID
52883
53496
  * @param {String} languageId languageId
@@ -52907,7 +53520,7 @@ class RoutingApi {
52907
53520
  }
52908
53521
 
52909
53522
  /**
52910
- * Remove routing skill from user
53523
+ * Remove a routing skill from a user
52911
53524
  *
52912
53525
  * @param {String} userId User ID
52913
53526
  * @param {String} skillId skillId
@@ -54686,7 +55299,7 @@ class RoutingApi {
54686
55299
  }
54687
55300
 
54688
55301
  /**
54689
- * List routing language for user
55302
+ * List routing languages assigned to a user
54690
55303
  *
54691
55304
  * @param {String} userId User ID
54692
55305
  * @param {Object} opts Optional parameters
@@ -54717,7 +55330,7 @@ class RoutingApi {
54717
55330
  }
54718
55331
 
54719
55332
  /**
54720
- * List routing skills for user
55333
+ * List routing skills assigned to a user
54721
55334
  *
54722
55335
  * @param {String} userId User ID
54723
55336
  * @param {Object} opts Optional parameters
@@ -55179,7 +55792,7 @@ class RoutingApi {
55179
55792
  }
55180
55793
 
55181
55794
  /**
55182
- * Update routing language proficiency or state.
55795
+ * Update an assigned routing language's proficiency
55183
55796
  *
55184
55797
  * @param {String} userId User ID
55185
55798
  * @param {String} languageId languageId
@@ -55214,7 +55827,7 @@ class RoutingApi {
55214
55827
  }
55215
55828
 
55216
55829
  /**
55217
- * Add bulk routing language to user. Max limit 50 languages
55830
+ * Assign multiple routing languages to a user. Max 50 routing languages in request body
55218
55831
  *
55219
55832
  * @param {String} userId User ID
55220
55833
  * @param {Array.<Object>} body Language
@@ -55244,7 +55857,7 @@ class RoutingApi {
55244
55857
  }
55245
55858
 
55246
55859
  /**
55247
- * Bulk add routing skills to user
55860
+ * Assign multiple routing skills to a user
55248
55861
  *
55249
55862
  * @param {String} userId User ID
55250
55863
  * @param {Array.<Object>} body Skill
@@ -55940,7 +56553,7 @@ class RoutingApi {
55940
56553
  }
55941
56554
 
55942
56555
  /**
55943
- * Add routing language to user
56556
+ * Assign a routing language to a user
55944
56557
  *
55945
56558
  * @param {String} userId User ID
55946
56559
  * @param {Object} body Language
@@ -55970,7 +56583,7 @@ class RoutingApi {
55970
56583
  }
55971
56584
 
55972
56585
  /**
55973
- * Add routing skill to user
56586
+ * Assign a routing skill to a user
55974
56587
  *
55975
56588
  * @param {String} userId User ID
55976
56589
  * @param {Object} body Skill
@@ -56370,7 +56983,7 @@ class RoutingApi {
56370
56983
  }
56371
56984
 
56372
56985
  /**
56373
- * Update routing skill proficiency or state.
56986
+ * Update an assigned routing skill's proficiency
56374
56987
  *
56375
56988
  * @param {String} userId User ID
56376
56989
  * @param {String} skillId skillId
@@ -56405,7 +57018,7 @@ class RoutingApi {
56405
57018
  }
56406
57019
 
56407
57020
  /**
56408
- * Replace all routing skills assigned to a user
57021
+ * Assign multiple routing skills to a user, replacing any current assignments
56409
57022
  *
56410
57023
  * @param {String} userId User ID
56411
57024
  * @param {Array.<Object>} body Skill
@@ -56440,7 +57053,7 @@ class SCIMApi {
56440
57053
  /**
56441
57054
  * SCIM service.
56442
57055
  * @module purecloud-platform-client-v2/api/SCIMApi
56443
- * @version 206.0.0
57056
+ * @version 208.0.0
56444
57057
  */
56445
57058
 
56446
57059
  /**
@@ -57317,7 +57930,7 @@ class ScreenRecordingApi {
57317
57930
  /**
57318
57931
  * ScreenRecording service.
57319
57932
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
57320
- * @version 206.0.0
57933
+ * @version 208.0.0
57321
57934
  */
57322
57935
 
57323
57936
  /**
@@ -57362,7 +57975,7 @@ class ScriptsApi {
57362
57975
  /**
57363
57976
  * Scripts service.
57364
57977
  * @module purecloud-platform-client-v2/api/ScriptsApi
57365
- * @version 206.0.0
57978
+ * @version 208.0.0
57366
57979
  */
57367
57980
 
57368
57981
  /**
@@ -57806,7 +58419,7 @@ class SearchApi {
57806
58419
  /**
57807
58420
  * Search service.
57808
58421
  * @module purecloud-platform-client-v2/api/SearchApi
57809
- * @version 206.0.0
58422
+ * @version 208.0.0
57810
58423
  */
57811
58424
 
57812
58425
  /**
@@ -57989,6 +58602,35 @@ class SearchApi {
57989
58602
  );
57990
58603
  }
57991
58604
 
58605
+ /**
58606
+ * Search sites using the q64 value returned from a previous search
58607
+ *
58608
+ * @param {String} q64 q64
58609
+ * @param {Object} opts Optional parameters
58610
+ * @param {Array.<String>} opts.expand expand
58611
+ */
58612
+ getTelephonyProvidersEdgesSitesSearch(q64, opts) {
58613
+ opts = opts || {};
58614
+
58615
+ // verify the required parameter 'q64' is set
58616
+ if (q64 === undefined || q64 === null) {
58617
+ throw 'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';
58618
+ }
58619
+
58620
+ return this.apiClient.callApi(
58621
+ '/api/v2/telephony/providers/edges/sites/search',
58622
+ 'GET',
58623
+ { },
58624
+ { 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
58625
+ { },
58626
+ { },
58627
+ null,
58628
+ ['PureCloud OAuth'],
58629
+ ['application/json'],
58630
+ ['application/json']
58631
+ );
58632
+ }
58633
+
57992
58634
  /**
57993
58635
  * Search users using the q64 value returned from a previous search
57994
58636
  *
@@ -58362,6 +59004,31 @@ class SearchApi {
58362
59004
  );
58363
59005
  }
58364
59006
 
59007
+ /**
59008
+ * Search sites
59009
+ *
59010
+ * @param {Object} body Search request options
59011
+ */
59012
+ postTelephonyProvidersEdgesSitesSearch(body) {
59013
+ // verify the required parameter 'body' is set
59014
+ if (body === undefined || body === null) {
59015
+ throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';
59016
+ }
59017
+
59018
+ return this.apiClient.callApi(
59019
+ '/api/v2/telephony/providers/edges/sites/search',
59020
+ 'POST',
59021
+ { },
59022
+ { },
59023
+ { },
59024
+ { },
59025
+ body,
59026
+ ['PureCloud OAuth'],
59027
+ ['application/json'],
59028
+ ['application/json']
59029
+ );
59030
+ }
59031
+
58365
59032
  /**
58366
59033
  * Search users
58367
59034
  *
@@ -58495,7 +59162,7 @@ class SettingsApi {
58495
59162
  /**
58496
59163
  * Settings service.
58497
59164
  * @module purecloud-platform-client-v2/api/SettingsApi
58498
- * @version 206.0.0
59165
+ * @version 208.0.0
58499
59166
  */
58500
59167
 
58501
59168
  /**
@@ -58715,7 +59382,7 @@ class SpeechTextAnalyticsApi {
58715
59382
  /**
58716
59383
  * SpeechTextAnalytics service.
58717
59384
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
58718
- * @version 206.0.0
59385
+ * @version 208.0.0
58719
59386
  */
58720
59387
 
58721
59388
  /**
@@ -59534,13 +60201,13 @@ class SpeechTextAnalyticsApi {
59534
60201
  }
59535
60202
 
59536
60203
  /**
59537
- * Translate all communication(s) for an interaction.
60204
+ * Translate a single interaction recording (or an email conversation)
59538
60205
  *
59539
60206
  * @param {String} languageId Target translation language
59540
60207
  * @param {String} conversationId Conversation id
59541
60208
  * @param {Object} opts Optional parameters
59542
- * @param {String} opts.communicationId Communication id associated with the conversation
59543
- * @param {String} opts.recordingId Recording id associated with the communication
60209
+ * @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
60210
+ * @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
59544
60211
  * getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
59545
60212
  */
59546
60213
  getSpeechandtextanalyticsTranslationsLanguageConversation(languageId, conversationId, opts) {
@@ -60050,7 +60717,7 @@ class StationsApi {
60050
60717
  /**
60051
60718
  * Stations service.
60052
60719
  * @module purecloud-platform-client-v2/api/StationsApi
60053
- * @version 206.0.0
60720
+ * @version 208.0.0
60054
60721
  */
60055
60722
 
60056
60723
  /**
@@ -60152,7 +60819,7 @@ class SuggestApi {
60152
60819
  /**
60153
60820
  * Suggest service.
60154
60821
  * @module purecloud-platform-client-v2/api/SuggestApi
60155
- * @version 206.0.0
60822
+ * @version 208.0.0
60156
60823
  */
60157
60824
 
60158
60825
  /**
@@ -60291,7 +60958,7 @@ class TaskManagementApi {
60291
60958
  /**
60292
60959
  * TaskManagement service.
60293
60960
  * @module purecloud-platform-client-v2/api/TaskManagementApi
60294
- * @version 206.0.0
60961
+ * @version 208.0.0
60295
60962
  */
60296
60963
 
60297
60964
  /**
@@ -61955,7 +62622,7 @@ class TeamsApi {
61955
62622
  /**
61956
62623
  * Teams service.
61957
62624
  * @module purecloud-platform-client-v2/api/TeamsApi
61958
- * @version 206.0.0
62625
+ * @version 208.0.0
61959
62626
  */
61960
62627
 
61961
62628
  /**
@@ -62029,8 +62696,12 @@ class TeamsApi {
62029
62696
  * Get team
62030
62697
  *
62031
62698
  * @param {String} teamId Team ID
62699
+ * @param {Object} opts Optional parameters
62700
+ * @param {Object} opts.expand Expand the division name
62032
62701
  */
62033
- getTeam(teamId) {
62702
+ getTeam(teamId, opts) {
62703
+ opts = opts || {};
62704
+
62034
62705
  // verify the required parameter 'teamId' is set
62035
62706
  if (teamId === undefined || teamId === null) {
62036
62707
  throw 'Missing the required parameter "teamId" when calling getTeam';
@@ -62040,7 +62711,7 @@ class TeamsApi {
62040
62711
  '/api/v2/teams/{teamId}',
62041
62712
  'GET',
62042
62713
  { 'teamId': teamId },
62043
- { },
62714
+ { 'expand': opts['expand'] },
62044
62715
  { },
62045
62716
  { },
62046
62717
  null,
@@ -62256,7 +62927,7 @@ class TelephonyApi {
62256
62927
  /**
62257
62928
  * Telephony service.
62258
62929
  * @module purecloud-platform-client-v2/api/TelephonyApi
62259
- * @version 206.0.0
62930
+ * @version 208.0.0
62260
62931
  */
62261
62932
 
62262
62933
  /**
@@ -62438,7 +63109,7 @@ class TelephonyProvidersEdgeApi {
62438
63109
  /**
62439
63110
  * TelephonyProvidersEdge service.
62440
63111
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
62441
- * @version 206.0.0
63112
+ * @version 208.0.0
62442
63113
  */
62443
63114
 
62444
63115
  /**
@@ -64415,6 +65086,35 @@ class TelephonyProvidersEdgeApi {
64415
65086
  );
64416
65087
  }
64417
65088
 
65089
+ /**
65090
+ * Search sites using the q64 value returned from a previous search
65091
+ *
65092
+ * @param {String} q64 q64
65093
+ * @param {Object} opts Optional parameters
65094
+ * @param {Array.<String>} opts.expand expand
65095
+ */
65096
+ getTelephonyProvidersEdgesSitesSearch(q64, opts) {
65097
+ opts = opts || {};
65098
+
65099
+ // verify the required parameter 'q64' is set
65100
+ if (q64 === undefined || q64 === null) {
65101
+ throw 'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';
65102
+ }
65103
+
65104
+ return this.apiClient.callApi(
65105
+ '/api/v2/telephony/providers/edges/sites/search',
65106
+ 'GET',
65107
+ { },
65108
+ { 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
65109
+ { },
65110
+ { },
65111
+ null,
65112
+ ['PureCloud OAuth'],
65113
+ ['application/json'],
65114
+ ['application/json']
65115
+ );
65116
+ }
65117
+
64418
65118
  /**
64419
65119
  * Get a list of Edge-compatible time zones
64420
65120
  *
@@ -65344,6 +66044,31 @@ class TelephonyProvidersEdgeApi {
65344
66044
  );
65345
66045
  }
65346
66046
 
66047
+ /**
66048
+ * Search sites
66049
+ *
66050
+ * @param {Object} body Search request options
66051
+ */
66052
+ postTelephonyProvidersEdgesSitesSearch(body) {
66053
+ // verify the required parameter 'body' is set
66054
+ if (body === undefined || body === null) {
66055
+ throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';
66056
+ }
66057
+
66058
+ return this.apiClient.callApi(
66059
+ '/api/v2/telephony/providers/edges/sites/search',
66060
+ 'POST',
66061
+ { },
66062
+ { },
66063
+ { },
66064
+ { },
66065
+ body,
66066
+ ['PureCloud OAuth'],
66067
+ ['application/json'],
66068
+ ['application/json']
66069
+ );
66070
+ }
66071
+
65347
66072
  /**
65348
66073
  * Create a Trunk Base Settings object
65349
66074
  *
@@ -65835,7 +66560,7 @@ class TextbotsApi {
65835
66560
  /**
65836
66561
  * Textbots service.
65837
66562
  * @module purecloud-platform-client-v2/api/TextbotsApi
65838
- * @version 206.0.0
66563
+ * @version 208.0.0
65839
66564
  */
65840
66565
 
65841
66566
  /**
@@ -65963,7 +66688,7 @@ class TokensApi {
65963
66688
  /**
65964
66689
  * Tokens service.
65965
66690
  * @module purecloud-platform-client-v2/api/TokensApi
65966
- * @version 206.0.0
66691
+ * @version 208.0.0
65967
66692
  */
65968
66693
 
65969
66694
  /**
@@ -66117,7 +66842,7 @@ class UploadsApi {
66117
66842
  /**
66118
66843
  * Uploads service.
66119
66844
  * @module purecloud-platform-client-v2/api/UploadsApi
66120
- * @version 206.0.0
66845
+ * @version 208.0.0
66121
66846
  */
66122
66847
 
66123
66848
  /**
@@ -66386,7 +67111,7 @@ class UsageApi {
66386
67111
  /**
66387
67112
  * Usage service.
66388
67113
  * @module purecloud-platform-client-v2/api/UsageApi
66389
- * @version 206.0.0
67114
+ * @version 208.0.0
66390
67115
  */
66391
67116
 
66392
67117
  /**
@@ -66601,7 +67326,7 @@ class UserRecordingsApi {
66601
67326
  /**
66602
67327
  * UserRecordings service.
66603
67328
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
66604
- * @version 206.0.0
67329
+ * @version 208.0.0
66605
67330
  */
66606
67331
 
66607
67332
  /**
@@ -66816,7 +67541,7 @@ class UsersApi {
66816
67541
  /**
66817
67542
  * Users service.
66818
67543
  * @module purecloud-platform-client-v2/api/UsersApi
66819
- * @version 206.0.0
67544
+ * @version 208.0.0
66820
67545
  */
66821
67546
 
66822
67547
  /**
@@ -66987,7 +67712,7 @@ class UsersApi {
66987
67712
  }
66988
67713
 
66989
67714
  /**
66990
- * Remove routing language from user
67715
+ * Remove a routing language from a user
66991
67716
  *
66992
67717
  * @param {String} userId User ID
66993
67718
  * @param {String} languageId languageId
@@ -67017,7 +67742,7 @@ class UsersApi {
67017
67742
  }
67018
67743
 
67019
67744
  /**
67020
- * Remove routing skill from user
67745
+ * Remove a routing skill from a user
67021
67746
  *
67022
67747
  * @param {String} userId User ID
67023
67748
  * @param {String} skillId skillId
@@ -67849,7 +68574,7 @@ class UsersApi {
67849
68574
  }
67850
68575
 
67851
68576
  /**
67852
- * List routing language for user
68577
+ * List routing languages assigned to a user
67853
68578
  *
67854
68579
  * @param {String} userId User ID
67855
68580
  * @param {Object} opts Optional parameters
@@ -67880,7 +68605,7 @@ class UsersApi {
67880
68605
  }
67881
68606
 
67882
68607
  /**
67883
- * List routing skills for user
68608
+ * List routing skills assigned to a user
67884
68609
  *
67885
68610
  * @param {String} userId User ID
67886
68611
  * @param {Object} opts Optional parameters
@@ -68131,6 +68856,32 @@ class UsersApi {
68131
68856
  );
68132
68857
  }
68133
68858
 
68859
+ /**
68860
+ * Get chats for a user
68861
+ *
68862
+ * @param {Object} opts Optional parameters
68863
+ * @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
68864
+ * @param {Boolean} opts.includePresence Whether or not to include user presence
68865
+ * @param {String} opts.after The key to start after
68866
+ */
68867
+ getUsersChatsMe(opts) {
68868
+ opts = opts || {};
68869
+
68870
+
68871
+ return this.apiClient.callApi(
68872
+ '/api/v2/users/chats/me',
68873
+ 'GET',
68874
+ { },
68875
+ { 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
68876
+ { },
68877
+ { },
68878
+ null,
68879
+ ['PureCloud OAuth'],
68880
+ ['application/json'],
68881
+ ['application/json']
68882
+ );
68883
+ }
68884
+
68134
68885
  /**
68135
68886
  * Get list of Development Activities
68136
68887
  * Either moduleId or userId is required. Results are filtered based on the applicable permissions.
@@ -68450,7 +69201,7 @@ class UsersApi {
68450
69201
  }
68451
69202
 
68452
69203
  /**
68453
- * Update routing language proficiency or state.
69204
+ * Update an assigned routing language's proficiency
68454
69205
  *
68455
69206
  * @param {String} userId User ID
68456
69207
  * @param {String} languageId languageId
@@ -68485,7 +69236,7 @@ class UsersApi {
68485
69236
  }
68486
69237
 
68487
69238
  /**
68488
- * Add bulk routing language to user. Max limit 50 languages
69239
+ * Assign multiple routing languages to a user. Max 50 routing languages in request body
68489
69240
  *
68490
69241
  * @param {String} userId User ID
68491
69242
  * @param {Array.<Object>} body Language
@@ -68515,7 +69266,7 @@ class UsersApi {
68515
69266
  }
68516
69267
 
68517
69268
  /**
68518
- * Bulk add routing skills to user
69269
+ * Assign multiple routing skills to a user
68519
69270
  *
68520
69271
  * @param {String} userId User ID
68521
69272
  * @param {Array.<Object>} body Skill
@@ -68952,7 +69703,7 @@ class UsersApi {
68952
69703
  }
68953
69704
 
68954
69705
  /**
68955
- * Add routing language to user
69706
+ * Assign a routing language to a user
68956
69707
  *
68957
69708
  * @param {String} userId User ID
68958
69709
  * @param {Object} body Language
@@ -68982,7 +69733,7 @@ class UsersApi {
68982
69733
  }
68983
69734
 
68984
69735
  /**
68985
- * Add routing skill to user
69736
+ * Assign a routing skill to a user
68986
69737
  *
68987
69738
  * @param {String} userId User ID
68988
69739
  * @param {Object} body Skill
@@ -69394,7 +70145,7 @@ class UsersApi {
69394
70145
  }
69395
70146
 
69396
70147
  /**
69397
- * Update routing skill proficiency or state.
70148
+ * Update an assigned routing skill's proficiency
69398
70149
  *
69399
70150
  * @param {String} userId User ID
69400
70151
  * @param {String} skillId skillId
@@ -69429,7 +70180,7 @@ class UsersApi {
69429
70180
  }
69430
70181
 
69431
70182
  /**
69432
- * Replace all routing skills assigned to a user
70183
+ * Assign multiple routing skills to a user, replacing any current assignments
69433
70184
  *
69434
70185
  * @param {String} userId User ID
69435
70186
  * @param {Array.<Object>} body Skill
@@ -69619,7 +70370,7 @@ class UtilitiesApi {
69619
70370
  /**
69620
70371
  * Utilities service.
69621
70372
  * @module purecloud-platform-client-v2/api/UtilitiesApi
69622
- * @version 206.0.0
70373
+ * @version 208.0.0
69623
70374
  */
69624
70375
 
69625
70376
  /**
@@ -69730,7 +70481,7 @@ class VoicemailApi {
69730
70481
  /**
69731
70482
  * Voicemail service.
69732
70483
  * @module purecloud-platform-client-v2/api/VoicemailApi
69733
- * @version 206.0.0
70484
+ * @version 208.0.0
69734
70485
  */
69735
70486
 
69736
70487
  /**
@@ -70117,6 +70868,61 @@ class VoicemailApi {
70117
70868
  );
70118
70869
  }
70119
70870
 
70871
+ /**
70872
+ * Get a user's mailbox information
70873
+ *
70874
+ * @param {String} userId userId
70875
+ */
70876
+ getVoicemailUserMailbox(userId) {
70877
+ // verify the required parameter 'userId' is set
70878
+ if (userId === undefined || userId === null) {
70879
+ throw 'Missing the required parameter "userId" when calling getVoicemailUserMailbox';
70880
+ }
70881
+
70882
+ return this.apiClient.callApi(
70883
+ '/api/v2/voicemail/users/{userId}/mailbox',
70884
+ 'GET',
70885
+ { 'userId': userId },
70886
+ { },
70887
+ { },
70888
+ { },
70889
+ null,
70890
+ ['PureCloud OAuth'],
70891
+ ['application/json'],
70892
+ ['application/json']
70893
+ );
70894
+ }
70895
+
70896
+ /**
70897
+ * List voicemail messages
70898
+ *
70899
+ * @param {String} userId User ID
70900
+ * @param {Object} opts Optional parameters
70901
+ * @param {Number} opts.pageSize Page size (default to 25)
70902
+ * @param {Number} opts.pageNumber Page number (default to 1)
70903
+ */
70904
+ getVoicemailUserMessages(userId, opts) {
70905
+ opts = opts || {};
70906
+
70907
+ // verify the required parameter 'userId' is set
70908
+ if (userId === undefined || userId === null) {
70909
+ throw 'Missing the required parameter "userId" when calling getVoicemailUserMessages';
70910
+ }
70911
+
70912
+ return this.apiClient.callApi(
70913
+ '/api/v2/voicemail/users/{userId}/messages',
70914
+ 'GET',
70915
+ { 'userId': userId },
70916
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
70917
+ { },
70918
+ { },
70919
+ null,
70920
+ ['PureCloud OAuth'],
70921
+ ['application/json'],
70922
+ ['application/json']
70923
+ );
70924
+ }
70925
+
70120
70926
  /**
70121
70927
  * Get a user's voicemail policy
70122
70928
  *
@@ -70397,7 +71203,7 @@ class WebChatApi {
70397
71203
  /**
70398
71204
  * WebChat service.
70399
71205
  * @module purecloud-platform-client-v2/api/WebChatApi
70400
- * @version 206.0.0
71206
+ * @version 208.0.0
70401
71207
  */
70402
71208
 
70403
71209
  /**
@@ -70948,7 +71754,7 @@ class WebDeploymentsApi {
70948
71754
  /**
70949
71755
  * WebDeployments service.
70950
71756
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
70951
- * @version 206.0.0
71757
+ * @version 208.0.0
70952
71758
  */
70953
71759
 
70954
71760
  /**
@@ -71475,7 +72281,7 @@ class WebMessagingApi {
71475
72281
  /**
71476
72282
  * WebMessaging service.
71477
72283
  * @module purecloud-platform-client-v2/api/WebMessagingApi
71478
- * @version 206.0.0
72284
+ * @version 208.0.0
71479
72285
  */
71480
72286
 
71481
72287
  /**
@@ -71521,7 +72327,7 @@ class WidgetsApi {
71521
72327
  /**
71522
72328
  * Widgets service.
71523
72329
  * @module purecloud-platform-client-v2/api/WidgetsApi
71524
- * @version 206.0.0
72330
+ * @version 208.0.0
71525
72331
  */
71526
72332
 
71527
72333
  /**
@@ -71667,7 +72473,7 @@ class WorkforceManagementApi {
71667
72473
  /**
71668
72474
  * WorkforceManagement service.
71669
72475
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
71670
- * @version 206.0.0
72476
+ * @version 208.0.0
71671
72477
  */
71672
72478
 
71673
72479
  /**
@@ -78881,7 +79687,7 @@ class WorkforceManagementApi {
78881
79687
  * </pre>
78882
79688
  * </p>
78883
79689
  * @module purecloud-platform-client-v2/index
78884
- * @version 206.0.0
79690
+ * @version 208.0.0
78885
79691
  */
78886
79692
  class platformClient {
78887
79693
  constructor() {