purecloud-platform-client-v2 169.1.0 → 170.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 (80) hide show
  1. package/README.md +6 -4
  2. package/dist/node/purecloud-platform-client-v2.js +774 -365
  3. package/dist/web-amd/purecloud-platform-client-v2.js +774 -365
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +774 -365
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +774 -365
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +211 -35
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +44 -44
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +6 -6
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +362 -7
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +5 -5
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +9 -9
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +41 -11
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -45
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -29
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +3 -3
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +69 -16
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +16 -16
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +13 -13
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +5 -5
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +50 -46
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +4 -4
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +3 -3
  69. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -13
  73. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
  76. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
  80. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class GroupsApi {
5
5
  /**
6
6
  * Groups service.
7
7
  * @module purecloud-platform-client-v2/api/GroupsApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -49,7 +49,7 @@ class GroupsApi {
49
49
  * Remove dynamic group definition
50
50
  *
51
51
  * @param {String} groupId Group ID
52
- * Preview Endpoint
52
+ * deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53
53
  */
54
54
  deleteGroupDynamicsettings(groupId) {
55
55
  // verify the required parameter 'groupId' is set
@@ -105,7 +105,7 @@ class GroupsApi {
105
105
  * Fetch field config for an entity type
106
106
  *
107
107
  * @param {Object} type Field type
108
- * @deprecated
108
+ * @deprecated
109
109
  */
110
110
  getFieldconfig(type) {
111
111
  // verify the required parameter 'type' is set
@@ -156,7 +156,7 @@ class GroupsApi {
156
156
  * Get dynamic group definition
157
157
  *
158
158
  * @param {String} groupId Group ID
159
- * Preview Endpoint
159
+ * getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
160
160
  */
161
161
  getGroupDynamicsettings(groupId) {
162
162
  // verify the required parameter 'groupId' is set
@@ -241,7 +241,7 @@ class GroupsApi {
241
241
  * @param {String} groupId groupId
242
242
  * @param {Object} opts Optional parameters
243
243
  * @param {String} opts.fields Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
244
- * @deprecated
244
+ * @deprecated
245
245
  */
246
246
  getGroupProfile(groupId, opts) {
247
247
  opts = opts || {};
@@ -331,7 +331,7 @@ class GroupsApi {
331
331
  * @param {Array.<String>} opts.id id
332
332
  * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
333
333
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
334
- * @deprecated
334
+ * @deprecated
335
335
  */
336
336
  getProfilesGroups(opts) {
337
337
  opts = opts || {};
@@ -410,8 +410,8 @@ class GroupsApi {
410
410
  * Preview the number of users selected for a dynamic group definition query
411
411
  *
412
412
  * @param {Object} body Group query to preview
413
- * @deprecated
414
- * Preview Endpoint
413
+ * @deprecated
414
+ * postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
415
415
  */
416
416
  postGroupsDynamicsettingsPreview(body) {
417
417
  // verify the required parameter 'body' is set
@@ -492,7 +492,7 @@ class GroupsApi {
492
492
  *
493
493
  * @param {String} groupId Group ID
494
494
  * @param {Object} body Create/Update dynamic groups
495
- * Preview Endpoint
495
+ * putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
496
496
  */
497
497
  putGroupDynamicsettings(groupId, body) {
498
498
  // verify the required parameter 'groupId' is set
@@ -5,7 +5,7 @@ class IdentityProviderApi {
5
5
  /**
6
6
  * IdentityProvider service.
7
7
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
5
5
  /**
6
6
  * InfrastructureAsCode service.
7
7
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class IntegrationsApi {
5
5
  /**
6
6
  * Integrations service.
7
7
  * @module purecloud-platform-client-v2/api/IntegrationsApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -905,7 +905,7 @@ class IntegrationsApi {
905
905
  * @param {Object} opts Optional parameters
906
906
  * @param {Array.<String>} opts.expand expand
907
907
  * @param {Object} opts.targetChannel targetChannel
908
- * Preview Endpoint
908
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
909
909
  */
910
910
  getIntegrationsSpeechNuanceNuanceIntegrationIdBot(nuanceIntegrationId, botId, opts) {
911
911
  opts = opts || {};
@@ -939,7 +939,7 @@ class IntegrationsApi {
939
939
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
940
940
  * @param {String} botId The Nuance bot ID
941
941
  * @param {String} jobId The asynchronous job ID
942
- * Preview Endpoint
942
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
943
943
  */
944
944
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(nuanceIntegrationId, botId, jobId) {
945
945
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -975,7 +975,7 @@ class IntegrationsApi {
975
975
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
976
976
  * @param {String} botId The Nuance bot ID
977
977
  * @param {String} jobId The asynchronous job ID
978
- * Preview Endpoint
978
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
979
979
  */
980
980
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(nuanceIntegrationId, botId, jobId) {
981
981
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -1013,7 +1013,7 @@ class IntegrationsApi {
1013
1013
  * @param {Number} opts.pageNumber Page number (default to 1)
1014
1014
  * @param {Number} opts.pageSize Page size (default to 25)
1015
1015
  * @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
1016
- * Preview Endpoint
1016
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1017
1017
  */
1018
1018
  getIntegrationsSpeechNuanceNuanceIntegrationIdBots(nuanceIntegrationId, opts) {
1019
1019
  opts = opts || {};
@@ -1042,7 +1042,7 @@ class IntegrationsApi {
1042
1042
  *
1043
1043
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
1044
1044
  * @param {String} jobId The asynchronous job ID
1045
- * Preview Endpoint
1045
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1046
1046
  */
1047
1047
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(nuanceIntegrationId, jobId) {
1048
1048
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -1073,7 +1073,7 @@ class IntegrationsApi {
1073
1073
  *
1074
1074
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
1075
1075
  * @param {String} jobId The asynchronous job ID
1076
- * Preview Endpoint
1076
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1077
1077
  */
1078
1078
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(nuanceIntegrationId, jobId) {
1079
1079
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -1696,7 +1696,7 @@ class IntegrationsApi {
1696
1696
  * @param {Object} opts Optional parameters
1697
1697
  * @param {Array.<String>} opts.expand expand
1698
1698
  * @param {String} opts.body targetChannel
1699
- * Preview Endpoint
1699
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1700
1700
  */
1701
1701
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(nuanceIntegrationId, botId, opts) {
1702
1702
  opts = opts || {};
@@ -1732,7 +1732,7 @@ class IntegrationsApi {
1732
1732
  * @param {Number} opts.pageNumber Page number (default to 1)
1733
1733
  * @param {Number} opts.pageSize Page size (default to 25)
1734
1734
  * @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
1735
- * Preview Endpoint
1735
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1736
1736
  */
1737
1737
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(nuanceIntegrationId, opts) {
1738
1738
  opts = opts || {};
@@ -1761,7 +1761,7 @@ class IntegrationsApi {
1761
1761
  *
1762
1762
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
1763
1763
  * @param {Object} settings
1764
- * Preview Endpoint
1764
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1765
1765
  */
1766
1766
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId, settings) {
1767
1767
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -1880,7 +1880,7 @@ class IntegrationsApi {
1880
1880
  *
1881
1881
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
1882
1882
  * @param {Object} settings
1883
- * Preview Endpoint
1883
+ * putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1884
1884
  */
1885
1885
  putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId, settings) {
1886
1886
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -1931,6 +1931,36 @@ class IntegrationsApi {
1931
1931
  );
1932
1932
  }
1933
1933
 
1934
+ /**
1935
+ * Bulk integration presence ingestion
1936
+ * This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.
1937
+ * @param {String} ucIntegrationId UC Integration ID
1938
+ * @param {Array.<Object>} body List of User presences
1939
+ */
1940
+ putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId, body) {
1941
+ // verify the required parameter 'ucIntegrationId' is set
1942
+ if (ucIntegrationId === undefined || ucIntegrationId === null) {
1943
+ throw 'Missing the required parameter "ucIntegrationId" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
1944
+ }
1945
+ // verify the required parameter 'body' is set
1946
+ if (body === undefined || body === null) {
1947
+ throw 'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
1948
+ }
1949
+
1950
+ return this.apiClient.callApi(
1951
+ '/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences',
1952
+ 'PUT',
1953
+ { 'ucIntegrationId': ucIntegrationId },
1954
+ { },
1955
+ { },
1956
+ { },
1957
+ body,
1958
+ ['PureCloud OAuth'],
1959
+ ['application/json'],
1960
+ ['application/json']
1961
+ );
1962
+ }
1963
+
1934
1964
  }
1935
1965
 
1936
1966
 
@@ -5,7 +5,7 @@ class JourneyApi {
5
5
  /**
6
6
  * Journey service.
7
7
  * @module purecloud-platform-client-v2/api/JourneyApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -153,7 +153,7 @@ class JourneyApi {
153
153
  * Get status for async query for journey aggregates
154
154
  *
155
155
  * @param {String} jobId jobId
156
- * Preview Endpoint
156
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
157
157
  */
158
158
  getAnalyticsJourneysAggregatesJob(jobId) {
159
159
  // verify the required parameter 'jobId' is set
@@ -181,7 +181,7 @@ class JourneyApi {
181
181
  * @param {String} jobId jobId
182
182
  * @param {Object} opts Optional parameters
183
183
  * @param {String} opts.cursor Cursor token to retrieve next page
184
- * Preview Endpoint
184
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
185
185
  */
186
186
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
187
187
  opts = opts || {};
@@ -416,42 +416,6 @@ class JourneyApi {
416
416
  );
417
417
  }
418
418
 
419
- /**
420
- * Retrieve all sessions for a given customer.
421
- *
422
- * @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
423
- * @param {String} customerId Primary identifier of the customer in the source of the session.
424
- * @param {Object} opts Optional parameters
425
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
426
- * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
427
- * Preview Endpoint
428
- */
429
- getJourneyCustomerCustomerIdSessions(customerIdType, customerId, opts) {
430
- opts = opts || {};
431
-
432
- // verify the required parameter 'customerIdType' is set
433
- if (customerIdType === undefined || customerIdType === null) {
434
- throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSessions';
435
- }
436
- // verify the required parameter 'customerId' is set
437
- if (customerId === undefined || customerId === null) {
438
- throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSessions';
439
- }
440
-
441
- return this.apiClient.callApi(
442
- '/api/v2/journey/customers/{customerIdType}/{customerId}/sessions',
443
- 'GET',
444
- { 'customerIdType': customerIdType,'customerId': customerId },
445
- { 'pageSize': opts['pageSize'],'after': opts['after'] },
446
- { },
447
- { },
448
- null,
449
- ['PureCloud OAuth'],
450
- ['application/json'],
451
- ['application/json']
452
- );
453
- }
454
-
455
419
  /**
456
420
  * Retrieve a single outcome.
457
421
  *
@@ -510,7 +474,7 @@ class JourneyApi {
510
474
  * Get job status.
511
475
  *
512
476
  * @param {String} jobId ID of the job.
513
- * Preview Endpoint
477
+ * getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
514
478
  */
515
479
  getJourneyOutcomesAttributionsJob(jobId) {
516
480
  // verify the required parameter 'jobId' is set
@@ -536,7 +500,7 @@ class JourneyApi {
536
500
  * Get outcome attribution entities from completed job.
537
501
  *
538
502
  * @param {String} jobId ID of the job.
539
- * Preview Endpoint
503
+ * getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
540
504
  */
541
505
  getJourneyOutcomesAttributionsJobResults(jobId) {
542
506
  // verify the required parameter 'jobId' is set
@@ -690,7 +654,7 @@ class JourneyApi {
690
654
  * @param {Object} opts Optional parameters
691
655
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
692
656
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
693
- * Preview Endpoint
657
+ * getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
694
658
  */
695
659
  getJourneySessionEvents(sessionId, opts) {
696
660
  opts = opts || {};
@@ -748,7 +712,7 @@ class JourneyApi {
748
712
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
749
713
  * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
750
714
  * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
751
- * Preview Endpoint
715
+ * getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
752
716
  */
753
717
  getJourneySessionSegments(sessionId, opts) {
754
718
  opts = opts || {};
@@ -921,7 +885,7 @@ class JourneyApi {
921
885
  * Query for journey aggregates asynchronously
922
886
  *
923
887
  * @param {Object} body query
924
- * Preview Endpoint
888
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
925
889
  */
926
890
  postAnalyticsJourneysAggregatesJobs(body) {
927
891
  // verify the required parameter 'body' is set
@@ -1070,7 +1034,7 @@ class JourneyApi {
1070
1034
  *
1071
1035
  * @param {Object} opts Optional parameters
1072
1036
  * @param {Object} opts.body outcome attribution request
1073
- * Preview Endpoint
1037
+ * postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1074
1038
  */
1075
1039
  postJourneyOutcomesAttributionsJobs(opts) {
1076
1040
  opts = opts || {};
@@ -5,7 +5,7 @@ class KnowledgeApi {
5
5
  /**
6
6
  * Knowledge service.
7
7
  * @module purecloud-platform-client-v2/api/KnowledgeApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -236,7 +236,7 @@ class KnowledgeApi {
236
236
  * @param {String} categoryId Category ID
237
237
  * @param {String} knowledgeBaseId Knowledge base ID
238
238
  * @param {Object} languageCode Language code, format: iso2-LOCALE
239
- * @deprecated
239
+ * @deprecated
240
240
  */
241
241
  deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
242
242
  // verify the required parameter 'categoryId' is set
@@ -272,7 +272,7 @@ class KnowledgeApi {
272
272
  * @param {String} documentId Document ID
273
273
  * @param {String} knowledgeBaseId Knowledge base ID
274
274
  * @param {Object} languageCode Language code, format: iso2-LOCALE
275
- * @deprecated
275
+ * @deprecated
276
276
  */
277
277
  deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
278
278
  // verify the required parameter 'documentId' is set
@@ -308,7 +308,7 @@ class KnowledgeApi {
308
308
  * @param {String} knowledgeBaseId Knowledge base ID
309
309
  * @param {Object} languageCode Language code, format: iso2-LOCALE
310
310
  * @param {String} importId Import ID
311
- * @deprecated
311
+ * @deprecated
312
312
  */
313
313
  deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
314
314
  // verify the required parameter 'knowledgeBaseId' is set
@@ -810,6 +810,7 @@ class KnowledgeApi {
810
810
  * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
811
811
  * @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
812
812
  * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
813
+ * @param {Array.<String>} opts.externalIds If specified, retrieves documents associated with external ids, comma separated values expected.
813
814
  */
814
815
  getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
815
816
  opts = opts || {};
@@ -823,7 +824,7 @@ class KnowledgeApi {
823
824
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
824
825
  'GET',
825
826
  { 'knowledgeBaseId': knowledgeBaseId },
826
- { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
827
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
827
828
  { },
828
829
  { },
829
830
  null,
@@ -967,7 +968,7 @@ class KnowledgeApi {
967
968
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
968
969
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
969
970
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
970
- * @deprecated
971
+ * @deprecated
971
972
  */
972
973
  getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
973
974
  opts = opts || {};
@@ -1001,7 +1002,7 @@ class KnowledgeApi {
1001
1002
  * @param {String} categoryId Category ID
1002
1003
  * @param {String} knowledgeBaseId Knowledge base ID
1003
1004
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1004
- * @deprecated
1005
+ * @deprecated
1005
1006
  */
1006
1007
  getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
1007
1008
  // verify the required parameter 'categoryId' is set
@@ -1037,7 +1038,7 @@ class KnowledgeApi {
1037
1038
  * @param {String} documentId Document ID
1038
1039
  * @param {String} knowledgeBaseId Knowledge base ID
1039
1040
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1040
- * @deprecated
1041
+ * @deprecated
1041
1042
  */
1042
1043
  getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
1043
1044
  // verify the required parameter 'documentId' is set
@@ -1074,8 +1075,8 @@ class KnowledgeApi {
1074
1075
  * @param {String} knowledgeBaseId Knowledge base ID
1075
1076
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1076
1077
  * @param {String} uploadId UploadId
1077
- * @deprecated
1078
- * Preview Endpoint
1078
+ * @deprecated
1079
+ * getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1079
1080
  */
1080
1081
  getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
1081
1082
  // verify the required parameter 'documentId' is set
@@ -1124,7 +1125,7 @@ class KnowledgeApi {
1124
1125
  * @param {Object} opts.sortBy Sort by.
1125
1126
  * @param {Object} opts.sortOrder Sort Order.
1126
1127
  * @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
1127
- * @deprecated
1128
+ * @deprecated
1128
1129
  */
1129
1130
  getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
1130
1131
  opts = opts || {};
@@ -1158,7 +1159,7 @@ class KnowledgeApi {
1158
1159
  * @param {String} knowledgeBaseId Knowledge base ID
1159
1160
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1160
1161
  * @param {String} importId Import ID
1161
- * @deprecated
1162
+ * @deprecated
1162
1163
  */
1163
1164
  getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
1164
1165
  // verify the required parameter 'knowledgeBaseId' is set
@@ -1194,7 +1195,7 @@ class KnowledgeApi {
1194
1195
  * @param {String} knowledgeBaseId Knowledge base ID
1195
1196
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1196
1197
  * @param {String} trainingId Training ID
1197
- * @deprecated
1198
+ * @deprecated
1198
1199
  */
1199
1200
  getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
1200
1201
  // verify the required parameter 'knowledgeBaseId' is set
@@ -1235,7 +1236,7 @@ class KnowledgeApi {
1235
1236
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
1236
1237
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
1237
1238
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
1238
- * @deprecated
1239
+ * @deprecated
1239
1240
  */
1240
1241
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
1241
1242
  opts = opts || {};
@@ -1683,7 +1684,7 @@ class KnowledgeApi {
1683
1684
  * @param {String} knowledgeBaseId Knowledge base ID
1684
1685
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1685
1686
  * @param {Object} body
1686
- * @deprecated
1687
+ * @deprecated
1687
1688
  */
1688
1689
  patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
1689
1690
  // verify the required parameter 'categoryId' is set
@@ -1724,7 +1725,7 @@ class KnowledgeApi {
1724
1725
  * @param {String} knowledgeBaseId Knowledge base ID
1725
1726
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1726
1727
  * @param {Object} body
1727
- * @deprecated
1728
+ * @deprecated
1728
1729
  */
1729
1730
  patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
1730
1731
  // verify the required parameter 'documentId' is set
@@ -1764,7 +1765,7 @@ class KnowledgeApi {
1764
1765
  * @param {String} knowledgeBaseId Knowledge base ID
1765
1766
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1766
1767
  * @param {Array.<Object>} body
1767
- * @deprecated
1768
+ * @deprecated
1768
1769
  */
1769
1770
  patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
1770
1771
  // verify the required parameter 'knowledgeBaseId' is set
@@ -1801,7 +1802,7 @@ class KnowledgeApi {
1801
1802
  * @param {Object} languageCode Language code, format: iso2-LOCALE
1802
1803
  * @param {String} importId Import ID
1803
1804
  * @param {Object} body
1804
- * @deprecated
1805
+ * @deprecated
1805
1806
  */
1806
1807
  patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
1807
1808
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2119,7 +2120,7 @@ class KnowledgeApi {
2119
2120
  *
2120
2121
  * @param {String} knowledgeBaseId Knowledge base ID
2121
2122
  * @param {Object} body
2122
- * Preview Endpoint
2123
+ * postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2123
2124
  */
2124
2125
  postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
2125
2126
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2150,7 +2151,7 @@ class KnowledgeApi {
2150
2151
  *
2151
2152
  * @param {String} knowledgeBaseId Knowledge base ID
2152
2153
  * @param {Object} body
2153
- * Preview Endpoint
2154
+ * postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2154
2155
  */
2155
2156
  postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
2156
2157
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2240,7 +2241,7 @@ class KnowledgeApi {
2240
2241
  *
2241
2242
  * @param {String} knowledgeBaseId Knowledge base ID
2242
2243
  * @param {Object} body
2243
- * Preview Endpoint
2244
+ * postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2244
2245
  */
2245
2246
  postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
2246
2247
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2362,7 +2363,7 @@ class KnowledgeApi {
2362
2363
  * @param {String} knowledgeBaseId Knowledge base ID
2363
2364
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2364
2365
  * @param {Object} body
2365
- * @deprecated
2366
+ * @deprecated
2366
2367
  */
2367
2368
  postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
2368
2369
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2399,8 +2400,8 @@ class KnowledgeApi {
2399
2400
  * @param {String} knowledgeBaseId Knowledge base ID
2400
2401
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2401
2402
  * @param {Object} body
2402
- * @deprecated
2403
- * Preview Endpoint
2403
+ * @deprecated
2404
+ * postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2404
2405
  */
2405
2406
  postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
2406
2407
  // verify the required parameter 'documentId' is set
@@ -2440,7 +2441,7 @@ class KnowledgeApi {
2440
2441
  * @param {String} knowledgeBaseId Knowledge base ID
2441
2442
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2442
2443
  * @param {Object} body
2443
- * @deprecated
2444
+ * @deprecated
2444
2445
  */
2445
2446
  postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
2446
2447
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2476,7 +2477,7 @@ class KnowledgeApi {
2476
2477
  * @param {String} knowledgeBaseId Knowledge base ID
2477
2478
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2478
2479
  * @param {Object} body
2479
- * @deprecated
2480
+ * @deprecated
2480
2481
  */
2481
2482
  postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
2482
2483
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2512,7 +2513,7 @@ class KnowledgeApi {
2512
2513
  * @param {String} knowledgeBaseId Knowledge base ID
2513
2514
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2514
2515
  * @param {String} trainingId Training ID
2515
- * @deprecated
2516
+ * @deprecated
2516
2517
  */
2517
2518
  postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
2518
2519
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2547,7 +2548,7 @@ class KnowledgeApi {
2547
2548
  *
2548
2549
  * @param {String} knowledgeBaseId Knowledge base ID
2549
2550
  * @param {Object} languageCode Language code, format: iso2-LOCALE
2550
- * @deprecated
2551
+ * @deprecated
2551
2552
  */
2552
2553
  postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
2553
2554
  // verify the required parameter 'knowledgeBaseId' is set
@@ -2579,7 +2580,7 @@ class KnowledgeApi {
2579
2580
  * @param {String} knowledgeBaseId Knowledge base ID
2580
2581
  * @param {Object} opts Optional parameters
2581
2582
  * @param {Object} opts.body
2582
- * @deprecated
2583
+ * @deprecated
2583
2584
  */
2584
2585
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
2585
2586
  opts = opts || {};
@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
5
5
  /**
6
6
  * LanguageUnderstanding service.
7
7
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LanguagesApi {
5
5
  /**
6
6
  * Languages service.
7
7
  * @module purecloud-platform-client-v2/api/LanguagesApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,7 +24,7 @@ class LanguagesApi {
24
24
  * Delete Language (Deprecated)
25
25
  * This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
26
26
  * @param {String} languageId Language ID
27
- * @deprecated
27
+ * @deprecated
28
28
  */
29
29
  deleteLanguage(languageId) {
30
30
  // verify the required parameter 'languageId' is set
@@ -50,7 +50,7 @@ class LanguagesApi {
50
50
  * Get Language (Deprecated)
51
51
  * This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
52
52
  * @param {String} languageId Language ID
53
- * @deprecated
53
+ * @deprecated
54
54
  */
55
55
  getLanguage(languageId) {
56
56
  // verify the required parameter 'languageId' is set
@@ -80,7 +80,7 @@ class LanguagesApi {
80
80
  * @param {Number} opts.pageNumber Page number (default to 1)
81
81
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
82
82
  * @param {String} opts.name Name
83
- * @deprecated
83
+ * @deprecated
84
84
  */
85
85
  getLanguages(opts) {
86
86
  opts = opts || {};
@@ -199,7 +199,7 @@ class LanguagesApi {
199
199
  * Create Language (Deprecated)
200
200
  * This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
201
201
  * @param {Object} body Language
202
- * @deprecated
202
+ * @deprecated
203
203
  */
204
204
  postLanguages(body) {
205
205
  // verify the required parameter 'body' is set
@@ -5,7 +5,7 @@ class LearningApi {
5
5
  /**
6
6
  * Learning service.
7
7
  * @module purecloud-platform-client-v2/api/LearningApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class LicenseApi {
5
5
  /**
6
6
  * License service.
7
7
  * @module purecloud-platform-client-v2/api/LicenseApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**