purecloud-platform-client-v2 154.0.0 → 155.0.1

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 (77) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +323 -77
  3. package/dist/web-amd/purecloud-platform-client-v2.js +323 -77
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +323 -77
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +323 -77
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +409 -227
  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 +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +116 -8
  37. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OutboundApi.js +119 -1
  49. package/src/purecloud-platform-client-v2/api/PresenceApi.js +3 -3
  50. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +21 -1
  63. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -9307,7 +9307,7 @@ class Configuration {
9307
9307
 
9308
9308
  /**
9309
9309
  * @module purecloud-platform-client-v2/ApiClient
9310
- * @version 154.0.0
9310
+ * @version 155.0.1
9311
9311
  */
9312
9312
  class ApiClient {
9313
9313
  /**
@@ -10379,7 +10379,7 @@ class AlertingApi {
10379
10379
  /**
10380
10380
  * Alerting service.
10381
10381
  * @module purecloud-platform-client-v2/api/AlertingApi
10382
- * @version 154.0.0
10382
+ * @version 155.0.1
10383
10383
  */
10384
10384
 
10385
10385
  /**
@@ -10693,7 +10693,7 @@ class AnalyticsApi {
10693
10693
  /**
10694
10694
  * Analytics service.
10695
10695
  * @module purecloud-platform-client-v2/api/AnalyticsApi
10696
- * @version 154.0.0
10696
+ * @version 155.0.1
10697
10697
  */
10698
10698
 
10699
10699
  /**
@@ -11947,7 +11947,7 @@ class ArchitectApi {
11947
11947
  /**
11948
11948
  * Architect service.
11949
11949
  * @module purecloud-platform-client-v2/api/ArchitectApi
11950
- * @version 154.0.0
11950
+ * @version 155.0.1
11951
11951
  */
11952
11952
 
11953
11953
  /**
@@ -14995,7 +14995,7 @@ class AuditApi {
14995
14995
  /**
14996
14996
  * Audit service.
14997
14997
  * @module purecloud-platform-client-v2/api/AuditApi
14998
- * @version 154.0.0
14998
+ * @version 155.0.1
14999
14999
  */
15000
15000
 
15001
15001
  /**
@@ -15166,7 +15166,7 @@ class AuthorizationApi {
15166
15166
  /**
15167
15167
  * Authorization service.
15168
15168
  * @module purecloud-platform-client-v2/api/AuthorizationApi
15169
- * @version 154.0.0
15169
+ * @version 155.0.1
15170
15170
  */
15171
15171
 
15172
15172
  /**
@@ -16394,7 +16394,7 @@ class BillingApi {
16394
16394
  /**
16395
16395
  * Billing service.
16396
16396
  * @module purecloud-platform-client-v2/api/BillingApi
16397
- * @version 154.0.0
16397
+ * @version 155.0.1
16398
16398
  */
16399
16399
 
16400
16400
  /**
@@ -16474,7 +16474,7 @@ class ChatApi {
16474
16474
  /**
16475
16475
  * Chat service.
16476
16476
  * @module purecloud-platform-client-v2/api/ChatApi
16477
- * @version 154.0.0
16477
+ * @version 155.0.1
16478
16478
  */
16479
16479
 
16480
16480
  /**
@@ -16565,7 +16565,7 @@ class CoachingApi {
16565
16565
  /**
16566
16566
  * Coaching service.
16567
16567
  * @module purecloud-platform-client-v2/api/CoachingApi
16568
- * @version 154.0.0
16568
+ * @version 155.0.1
16569
16569
  */
16570
16570
 
16571
16571
  /**
@@ -17142,7 +17142,7 @@ class ContentManagementApi {
17142
17142
  /**
17143
17143
  * ContentManagement service.
17144
17144
  * @module purecloud-platform-client-v2/api/ContentManagementApi
17145
- * @version 154.0.0
17145
+ * @version 155.0.1
17146
17146
  */
17147
17147
 
17148
17148
  /**
@@ -18282,7 +18282,7 @@ class ConversationsApi {
18282
18282
  /**
18283
18283
  * Conversations service.
18284
18284
  * @module purecloud-platform-client-v2/api/ConversationsApi
18285
- * @version 154.0.0
18285
+ * @version 155.0.1
18286
18286
  */
18287
18287
 
18288
18288
  /**
@@ -23505,7 +23505,7 @@ class DataExtensionsApi {
23505
23505
  /**
23506
23506
  * DataExtensions service.
23507
23507
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
23508
- * @version 154.0.0
23508
+ * @version 155.0.1
23509
23509
  */
23510
23510
 
23511
23511
  /**
@@ -23591,7 +23591,7 @@ class DownloadsApi {
23591
23591
  /**
23592
23592
  * Downloads service.
23593
23593
  * @module purecloud-platform-client-v2/api/DownloadsApi
23594
- * @version 154.0.0
23594
+ * @version 155.0.1
23595
23595
  */
23596
23596
 
23597
23597
  /**
@@ -23643,7 +23643,7 @@ class EventsApi {
23643
23643
  /**
23644
23644
  * Events service.
23645
23645
  * @module purecloud-platform-client-v2/api/EventsApi
23646
- * @version 154.0.0
23646
+ * @version 155.0.1
23647
23647
  */
23648
23648
 
23649
23649
  /**
@@ -23739,7 +23739,7 @@ class ExternalContactsApi {
23739
23739
  /**
23740
23740
  * ExternalContacts service.
23741
23741
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
23742
- * @version 154.0.0
23742
+ * @version 155.0.1
23743
23743
  */
23744
23744
 
23745
23745
  /**
@@ -25697,7 +25697,7 @@ class FaxApi {
25697
25697
  /**
25698
25698
  * Fax service.
25699
25699
  * @module purecloud-platform-client-v2/api/FaxApi
25700
- * @version 154.0.0
25700
+ * @version 155.0.1
25701
25701
  */
25702
25702
 
25703
25703
  /**
@@ -25868,7 +25868,7 @@ class FlowsApi {
25868
25868
  /**
25869
25869
  * Flows service.
25870
25870
  * @module purecloud-platform-client-v2/api/FlowsApi
25871
- * @version 154.0.0
25871
+ * @version 155.0.1
25872
25872
  */
25873
25873
 
25874
25874
  /**
@@ -25939,7 +25939,7 @@ class GamificationApi {
25939
25939
  /**
25940
25940
  * Gamification service.
25941
25941
  * @module purecloud-platform-client-v2/api/GamificationApi
25942
- * @version 154.0.0
25942
+ * @version 155.0.1
25943
25943
  */
25944
25944
 
25945
25945
  /**
@@ -27556,7 +27556,7 @@ class GeneralDataProtectionRegulationApi {
27556
27556
  /**
27557
27557
  * GeneralDataProtectionRegulation service.
27558
27558
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
27559
- * @version 154.0.0
27559
+ * @version 155.0.1
27560
27560
  */
27561
27561
 
27562
27562
  /**
@@ -27686,7 +27686,7 @@ class GeolocationApi {
27686
27686
  /**
27687
27687
  * Geolocation service.
27688
27688
  * @module purecloud-platform-client-v2/api/GeolocationApi
27689
- * @version 154.0.0
27689
+ * @version 155.0.1
27690
27690
  */
27691
27691
 
27692
27692
  /**
@@ -27817,7 +27817,7 @@ class GreetingsApi {
27817
27817
  /**
27818
27818
  * Greetings service.
27819
27819
  * @module purecloud-platform-client-v2/api/GreetingsApi
27820
- * @version 154.0.0
27820
+ * @version 155.0.1
27821
27821
  */
27822
27822
 
27823
27823
  /**
@@ -28272,7 +28272,7 @@ class GroupsApi {
28272
28272
  /**
28273
28273
  * Groups service.
28274
28274
  * @module purecloud-platform-client-v2/api/GroupsApi
28275
- * @version 154.0.0
28275
+ * @version 155.0.1
28276
28276
  */
28277
28277
 
28278
28278
  /**
@@ -28678,7 +28678,7 @@ class IdentityProviderApi {
28678
28678
  /**
28679
28679
  * IdentityProvider service.
28680
28680
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
28681
- * @version 154.0.0
28681
+ * @version 155.0.1
28682
28682
  */
28683
28683
 
28684
28684
  /**
@@ -29434,7 +29434,7 @@ class IntegrationsApi {
29434
29434
  /**
29435
29435
  * Integrations service.
29436
29436
  * @module purecloud-platform-client-v2/api/IntegrationsApi
29437
- * @version 154.0.0
29437
+ * @version 155.0.1
29438
29438
  */
29439
29439
 
29440
29440
  /**
@@ -31034,7 +31034,7 @@ class JourneyApi {
31034
31034
  /**
31035
31035
  * Journey service.
31036
31036
  * @module purecloud-platform-client-v2/api/JourneyApi
31037
- * @version 154.0.0
31037
+ * @version 155.0.1
31038
31038
  */
31039
31039
 
31040
31040
  /**
@@ -31820,7 +31820,7 @@ class KnowledgeApi {
31820
31820
  /**
31821
31821
  * Knowledge service.
31822
31822
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31823
- * @version 154.0.0
31823
+ * @version 155.0.1
31824
31824
  */
31825
31825
 
31826
31826
  /**
@@ -34253,7 +34253,7 @@ class LanguageUnderstandingApi {
34253
34253
  /**
34254
34254
  * LanguageUnderstanding service.
34255
34255
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
34256
- * @version 154.0.0
34256
+ * @version 155.0.1
34257
34257
  */
34258
34258
 
34259
34259
  /**
@@ -34443,6 +34443,7 @@ class LanguageUnderstandingApi {
34443
34443
  * @param {String} opts.dateStart Begin of time window as ISO-8601 date.
34444
34444
  * @param {String} opts.dateEnd End of time window as ISO-8601 date.
34445
34445
  * @param {Boolean} opts.includeDeleted Whether to include soft-deleted items in the result.
34446
+ * @param {String} opts.language Whether to filter response based on the language, e.g. en-us, pt-br.
34446
34447
  * @param {Number} opts.pageNumber Page number (default to 1)
34447
34448
  * @param {Number} opts.pageSize Page size (default to 25)
34448
34449
  * @param {Boolean} opts.enableCursorPagination Enable Cursor Pagination (default to false)
@@ -34461,7 +34462,7 @@ class LanguageUnderstandingApi {
34461
34462
  '/api/v2/languageunderstanding/domains/{domainId}/feedback',
34462
34463
  'GET',
34463
34464
  { 'domainId': domainId },
34464
- { 'intentName': opts['intentName'],'assessment': opts['assessment'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'includeDeleted': opts['includeDeleted'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'enableCursorPagination': opts['enableCursorPagination'],'after': opts['after'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
34465
+ { 'intentName': opts['intentName'],'assessment': opts['assessment'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'includeDeleted': opts['includeDeleted'],'language': opts['language'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'enableCursorPagination': opts['enableCursorPagination'],'after': opts['after'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
34465
34466
  { },
34466
34467
  { },
34467
34468
  null,
@@ -34655,8 +34656,13 @@ class LanguageUnderstandingApi {
34655
34656
  *
34656
34657
  * @param {String} minerId Miner ID
34657
34658
  * @param {String} draftId Draft ID
34659
+ * @param {Object} opts Optional parameters
34660
+ * @param {String} opts.draftIntentId Parameter to filter a specific intent.
34661
+ * @param {String} opts.draftTopicId Parameter to filter a specific topic.
34658
34662
  */
34659
- getLanguageunderstandingMinerDraft(minerId, draftId) {
34663
+ getLanguageunderstandingMinerDraft(minerId, draftId, opts) {
34664
+ opts = opts || {};
34665
+
34660
34666
  // verify the required parameter 'minerId' is set
34661
34667
  if (minerId === undefined || minerId === null) {
34662
34668
  throw 'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerDraft';
@@ -34670,7 +34676,7 @@ class LanguageUnderstandingApi {
34670
34676
  '/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}',
34671
34677
  'GET',
34672
34678
  { 'minerId': minerId,'draftId': draftId },
34673
- { },
34679
+ { 'draftIntentId': opts['draftIntentId'],'draftTopicId': opts['draftTopicId'] },
34674
34680
  { },
34675
34681
  { },
34676
34682
  null,
@@ -34768,17 +34774,115 @@ class LanguageUnderstandingApi {
34768
34774
  );
34769
34775
  }
34770
34776
 
34777
+ /**
34778
+ * Retrieves details of a particular topic.
34779
+ *
34780
+ * @param {String} minerId Miner ID
34781
+ * @param {String} topicId The ID of the topic to be retrieved.
34782
+ * @param {Object} opts Optional parameters
34783
+ * @param {Object} opts.expand Option to fetch phrases
34784
+ */
34785
+ getLanguageunderstandingMinerTopic(minerId, topicId, opts) {
34786
+ opts = opts || {};
34787
+
34788
+ // verify the required parameter 'minerId' is set
34789
+ if (minerId === undefined || minerId === null) {
34790
+ throw 'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopic';
34791
+ }
34792
+ // verify the required parameter 'topicId' is set
34793
+ if (topicId === undefined || topicId === null) {
34794
+ throw 'Missing the required parameter "topicId" when calling getLanguageunderstandingMinerTopic';
34795
+ }
34796
+
34797
+ return this.apiClient.callApi(
34798
+ '/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}',
34799
+ 'GET',
34800
+ { 'minerId': minerId,'topicId': topicId },
34801
+ { 'expand': opts['expand'] },
34802
+ { },
34803
+ { },
34804
+ null,
34805
+ ['PureCloud OAuth'],
34806
+ ['application/json'],
34807
+ ['application/json']
34808
+ );
34809
+ }
34810
+
34811
+ /**
34812
+ * Retrieves utterances related to a phrase in a topic.
34813
+ *
34814
+ * @param {String} minerId Miner ID
34815
+ * @param {String} topicId The ID of the topic to be retrieved.
34816
+ * @param {String} phraseId The ID of the phrase to be retrieved.
34817
+ */
34818
+ getLanguageunderstandingMinerTopicPhrase(minerId, topicId, phraseId) {
34819
+ // verify the required parameter 'minerId' is set
34820
+ if (minerId === undefined || minerId === null) {
34821
+ throw 'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopicPhrase';
34822
+ }
34823
+ // verify the required parameter 'topicId' is set
34824
+ if (topicId === undefined || topicId === null) {
34825
+ throw 'Missing the required parameter "topicId" when calling getLanguageunderstandingMinerTopicPhrase';
34826
+ }
34827
+ // verify the required parameter 'phraseId' is set
34828
+ if (phraseId === undefined || phraseId === null) {
34829
+ throw 'Missing the required parameter "phraseId" when calling getLanguageunderstandingMinerTopicPhrase';
34830
+ }
34831
+
34832
+ return this.apiClient.callApi(
34833
+ '/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}',
34834
+ 'GET',
34835
+ { 'minerId': minerId,'topicId': topicId,'phraseId': phraseId },
34836
+ { },
34837
+ { },
34838
+ { },
34839
+ null,
34840
+ ['PureCloud OAuth'],
34841
+ ['application/json'],
34842
+ ['application/json']
34843
+ );
34844
+ }
34845
+
34846
+ /**
34847
+ * Retrieve a list of mined topics.
34848
+ *
34849
+ * @param {String} minerId Miner ID
34850
+ */
34851
+ getLanguageunderstandingMinerTopics(minerId) {
34852
+ // verify the required parameter 'minerId' is set
34853
+ if (minerId === undefined || minerId === null) {
34854
+ throw 'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopics';
34855
+ }
34856
+
34857
+ return this.apiClient.callApi(
34858
+ '/api/v2/languageunderstanding/miners/{minerId}/topics',
34859
+ 'GET',
34860
+ { 'minerId': minerId },
34861
+ { },
34862
+ { },
34863
+ { },
34864
+ null,
34865
+ ['PureCloud OAuth'],
34866
+ ['application/json'],
34867
+ ['application/json']
34868
+ );
34869
+ }
34870
+
34771
34871
  /**
34772
34872
  * Retrieve the list of miners created.
34773
34873
  *
34874
+ * @param {Object} opts Optional parameters
34875
+ * @param {String} opts.minerType Type of miner, either intent or topic
34774
34876
  */
34775
- getLanguageunderstandingMiners() {
34877
+ getLanguageunderstandingMiners(opts) {
34878
+ opts = opts || {};
34879
+
34776
34880
 
34777
34881
  return this.apiClient.callApi(
34778
34882
  '/api/v2/languageunderstanding/miners',
34779
34883
  'GET',
34780
34884
  { },
34781
- { },
34885
+ { 'minerType': opts['minerType'] },
34782
34886
  { },
34783
34887
  { },
34784
34888
  null,
@@ -34982,8 +35086,12 @@ class LanguageUnderstandingApi {
34982
35086
  *
34983
35087
  * @param {String} domainId ID of the NLU domain.
34984
35088
  * @param {Object} body The NLU Domain Version to create.
35089
+ * @param {Object} opts Optional parameters
35090
+ * @param {Boolean} opts.includeUtterances Whether utterances for intent definition should be included when marshalling response.
34985
35091
  */
34986
- postLanguageunderstandingDomainVersions(domainId, body) {
35092
+ postLanguageunderstandingDomainVersions(domainId, body, opts) {
35093
+ opts = opts || {};
35094
+
34987
35095
  // verify the required parameter 'domainId' is set
34988
35096
  if (domainId === undefined || domainId === null) {
34989
35097
  throw 'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersions';
@@ -34997,7 +35105,7 @@ class LanguageUnderstandingApi {
34997
35105
  '/api/v2/languageunderstanding/domains/{domainId}/versions',
34998
35106
  'POST',
34999
35107
  { 'domainId': domainId },
35000
- { },
35108
+ { 'includeUtterances': opts['includeUtterances'] },
35001
35109
  { },
35002
35110
  { },
35003
35111
  body,
@@ -35157,7 +35265,7 @@ class LanguagesApi {
35157
35265
  /**
35158
35266
  * Languages service.
35159
35267
  * @module purecloud-platform-client-v2/api/LanguagesApi
35160
- * @version 154.0.0
35268
+ * @version 155.0.1
35161
35269
  */
35162
35270
 
35163
35271
  /**
@@ -35425,7 +35533,7 @@ class LearningApi {
35425
35533
  /**
35426
35534
  * Learning service.
35427
35535
  * @module purecloud-platform-client-v2/api/LearningApi
35428
- * @version 154.0.0
35536
+ * @version 155.0.1
35429
35537
  */
35430
35538
 
35431
35539
  /**
@@ -36186,7 +36294,7 @@ class LicenseApi {
36186
36294
  /**
36187
36295
  * License service.
36188
36296
  * @module purecloud-platform-client-v2/api/LicenseApi
36189
- * @version 154.0.0
36297
+ * @version 155.0.1
36190
36298
  */
36191
36299
 
36192
36300
  /**
@@ -36424,7 +36532,7 @@ class LocationsApi {
36424
36532
  /**
36425
36533
  * Locations service.
36426
36534
  * @module purecloud-platform-client-v2/api/LocationsApi
36427
- * @version 154.0.0
36535
+ * @version 155.0.1
36428
36536
  */
36429
36537
 
36430
36538
  /**
@@ -36660,7 +36768,7 @@ class MessagingApi {
36660
36768
  /**
36661
36769
  * Messaging service.
36662
36770
  * @module purecloud-platform-client-v2/api/MessagingApi
36663
- * @version 154.0.0
36771
+ * @version 155.0.1
36664
36772
  */
36665
36773
 
36666
36774
  /**
@@ -36811,7 +36919,7 @@ class MobileDevicesApi {
36811
36919
  /**
36812
36920
  * MobileDevices service.
36813
36921
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
36814
- * @version 154.0.0
36922
+ * @version 155.0.1
36815
36923
  */
36816
36924
 
36817
36925
  /**
@@ -36962,7 +37070,7 @@ class NotificationsApi {
36962
37070
  /**
36963
37071
  * Notifications service.
36964
37072
  * @module purecloud-platform-client-v2/api/NotificationsApi
36965
- * @version 154.0.0
37073
+ * @version 155.0.1
36966
37074
  */
36967
37075
 
36968
37076
  /**
@@ -37187,7 +37295,7 @@ class OAuthApi {
37187
37295
  /**
37188
37296
  * OAuth service.
37189
37297
  * @module purecloud-platform-client-v2/api/OAuthApi
37190
- * @version 154.0.0
37298
+ * @version 155.0.1
37191
37299
  */
37192
37300
 
37193
37301
  /**
@@ -37553,7 +37661,7 @@ class ObjectsApi {
37553
37661
  /**
37554
37662
  * Objects service.
37555
37663
  * @module purecloud-platform-client-v2/api/ObjectsApi
37556
- * @version 154.0.0
37664
+ * @version 155.0.1
37557
37665
  */
37558
37666
 
37559
37667
  /**
@@ -37824,7 +37932,7 @@ class OrganizationApi {
37824
37932
  /**
37825
37933
  * Organization service.
37826
37934
  * @module purecloud-platform-client-v2/api/OrganizationApi
37827
- * @version 154.0.0
37935
+ * @version 155.0.1
37828
37936
  */
37829
37937
 
37830
37938
  /**
@@ -38227,7 +38335,7 @@ class OrganizationAuthorizationApi {
38227
38335
  /**
38228
38336
  * OrganizationAuthorization service.
38229
38337
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
38230
- * @version 154.0.0
38338
+ * @version 155.0.1
38231
38339
  */
38232
38340
 
38233
38341
  /**
@@ -39152,7 +39260,7 @@ class OutboundApi {
39152
39260
  /**
39153
39261
  * Outbound service.
39154
39262
  * @module purecloud-platform-client-v2/api/OutboundApi
39155
- * @version 154.0.0
39263
+ * @version 155.0.1
39156
39264
  */
39157
39265
 
39158
39266
  /**
@@ -39502,6 +39610,64 @@ class OutboundApi {
39502
39610
  );
39503
39611
  }
39504
39612
 
39613
+ /**
39614
+ * Deletes all or expired email addresses from a DNC list.
39615
+ * This operation is Only for Internal DNC lists of email addresses
39616
+ * @param {String} dncListId DncList ID
39617
+ * @param {Object} opts Optional parameters
39618
+ * @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
39619
+ */
39620
+ deleteOutboundDnclistEmailaddresses(dncListId, opts) {
39621
+ opts = opts || {};
39622
+
39623
+ // verify the required parameter 'dncListId' is set
39624
+ if (dncListId === undefined || dncListId === null) {
39625
+ throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistEmailaddresses';
39626
+ }
39627
+
39628
+ return this.apiClient.callApi(
39629
+ '/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
39630
+ 'DELETE',
39631
+ { 'dncListId': dncListId },
39632
+ { 'expiredOnly': opts['expiredOnly'] },
39633
+ { },
39634
+ { },
39635
+ null,
39636
+ ['PureCloud OAuth'],
39637
+ ['application/json'],
39638
+ ['application/json']
39639
+ );
39640
+ }
39641
+
39642
+ /**
39643
+ * Deletes all or expired phone numbers from a DNC list.
39644
+ * This operation is Only for Internal DNC lists of phone numbers
39645
+ * @param {String} dncListId DncList ID
39646
+ * @param {Object} opts Optional parameters
39647
+ * @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
39648
+ */
39649
+ deleteOutboundDnclistPhonenumbers(dncListId, opts) {
39650
+ opts = opts || {};
39651
+
39652
+ // verify the required parameter 'dncListId' is set
39653
+ if (dncListId === undefined || dncListId === null) {
39654
+ throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistPhonenumbers';
39655
+ }
39656
+
39657
+ return this.apiClient.callApi(
39658
+ '/api/v2/outbound/dnclists/{dncListId}/phonenumbers',
39659
+ 'DELETE',
39660
+ { 'dncListId': dncListId },
39661
+ { 'expiredOnly': opts['expiredOnly'] },
39662
+ { },
39663
+ { },
39664
+ null,
39665
+ ['PureCloud OAuth'],
39666
+ ['application/json'],
39667
+ ['application/json']
39668
+ );
39669
+ }
39670
+
39505
39671
  /**
39506
39672
  * Delete an Outbound Messaging Campaign
39507
39673
  *
@@ -41272,6 +41438,66 @@ class OutboundApi {
41272
41438
  );
41273
41439
  }
41274
41440
 
41441
+ /**
41442
+ * Add emails to or Delete emails from a DNC list.
41443
+ * Only Internal DNC lists may be added to or deleted from
41444
+ * @param {String} dncListId DncList ID
41445
+ * @param {Object} body DNC Emails
41446
+ */
41447
+ patchOutboundDnclistEmailaddresses(dncListId, body) {
41448
+ // verify the required parameter 'dncListId' is set
41449
+ if (dncListId === undefined || dncListId === null) {
41450
+ throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistEmailaddresses';
41451
+ }
41452
+ // verify the required parameter 'body' is set
41453
+ if (body === undefined || body === null) {
41454
+ throw 'Missing the required parameter "body" when calling patchOutboundDnclistEmailaddresses';
41455
+ }
41456
+
41457
+ return this.apiClient.callApi(
41458
+ '/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
41459
+ 'PATCH',
41460
+ { 'dncListId': dncListId },
41461
+ { },
41462
+ { },
41463
+ { },
41464
+ body,
41465
+ ['PureCloud OAuth'],
41466
+ ['application/json'],
41467
+ ['application/json']
41468
+ );
41469
+ }
41470
+
41471
+ /**
41472
+ * Add numbers to or delete numbers from a DNC list.
41473
+ * Only Internal DNC lists may be added to deleted from
41474
+ * @param {String} dncListId DncList ID
41475
+ * @param {Object} body DNC Phone Numbers
41476
+ */
41477
+ patchOutboundDnclistPhonenumbers(dncListId, body) {
41478
+ // verify the required parameter 'dncListId' is set
41479
+ if (dncListId === undefined || dncListId === null) {
41480
+ throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistPhonenumbers';
41481
+ }
41482
+ // verify the required parameter 'body' is set
41483
+ if (body === undefined || body === null) {
41484
+ throw 'Missing the required parameter "body" when calling patchOutboundDnclistPhonenumbers';
41485
+ }
41486
+
41487
+ return this.apiClient.callApi(
41488
+ '/api/v2/outbound/dnclists/{dncListId}/phonenumbers',
41489
+ 'PATCH',
41490
+ { 'dncListId': dncListId },
41491
+ { },
41492
+ { },
41493
+ { },
41494
+ body,
41495
+ ['PureCloud OAuth'],
41496
+ ['application/json'],
41497
+ ['application/json']
41498
+ );
41499
+ }
41500
+
41275
41501
  /**
41276
41502
  * Update the outbound settings for this organization
41277
41503
  *
@@ -42571,7 +42797,7 @@ class PresenceApi {
42571
42797
  /**
42572
42798
  * Presence service.
42573
42799
  * @module purecloud-platform-client-v2/api/PresenceApi
42574
- * @version 154.0.0
42800
+ * @version 155.0.1
42575
42801
  */
42576
42802
 
42577
42803
  /**
@@ -42788,7 +43014,7 @@ class PresenceApi {
42788
43014
 
42789
43015
  /**
42790
43016
  * Get a user's Presence
42791
- * Get a users presence for the specified source that is not specifically listed. Used to support custom presence sources.
43017
+ * Get a users presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.
42792
43018
  * @param {String} userId user Id
42793
43019
  * @param {String} sourceId Presence source ID
42794
43020
  */
@@ -42843,7 +43069,7 @@ class PresenceApi {
42843
43069
 
42844
43070
  /**
42845
43071
  * Patch a user's Presence
42846
- * Patch a users presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
43072
+ * Patch a users presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
42847
43073
  * @param {String} userId user Id
42848
43074
  * @param {String} sourceId Presence source ID
42849
43075
  * @param {Object} body User presence
@@ -43077,7 +43303,7 @@ class ProcessAutomationApi {
43077
43303
  /**
43078
43304
  * ProcessAutomation service.
43079
43305
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
43080
- * @version 154.0.0
43306
+ * @version 155.0.1
43081
43307
  */
43082
43308
 
43083
43309
  /**
@@ -43315,7 +43541,7 @@ class QualityApi {
43315
43541
  /**
43316
43542
  * Quality service.
43317
43543
  * @module purecloud-platform-client-v2/api/QualityApi
43318
- * @version 154.0.0
43544
+ * @version 155.0.1
43319
43545
  */
43320
43546
 
43321
43547
  /**
@@ -44893,7 +45119,7 @@ class RecordingApi {
44893
45119
  /**
44894
45120
  * Recording service.
44895
45121
  * @module purecloud-platform-client-v2/api/RecordingApi
44896
- * @version 154.0.0
45122
+ * @version 155.0.1
44897
45123
  */
44898
45124
 
44899
45125
  /**
@@ -46580,7 +46806,7 @@ class ResponseManagementApi {
46580
46806
  /**
46581
46807
  * ResponseManagement service.
46582
46808
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
46583
- * @version 154.0.0
46809
+ * @version 155.0.1
46584
46810
  */
46585
46811
 
46586
46812
  /**
@@ -47064,7 +47290,7 @@ class RoutingApi {
47064
47290
  /**
47065
47291
  * Routing service.
47066
47292
  * @module purecloud-platform-client-v2/api/RoutingApi
47067
- * @version 154.0.0
47293
+ * @version 155.0.1
47068
47294
  */
47069
47295
 
47070
47296
  /**
@@ -50479,7 +50705,7 @@ class SCIMApi {
50479
50705
  /**
50480
50706
  * SCIM service.
50481
50707
  * @module purecloud-platform-client-v2/api/SCIMApi
50482
- * @version 154.0.0
50708
+ * @version 155.0.1
50483
50709
  */
50484
50710
 
50485
50711
  /**
@@ -51356,7 +51582,7 @@ class ScriptsApi {
51356
51582
  /**
51357
51583
  * Scripts service.
51358
51584
  * @module purecloud-platform-client-v2/api/ScriptsApi
51359
- * @version 154.0.0
51585
+ * @version 155.0.1
51360
51586
  */
51361
51587
 
51362
51588
  /**
@@ -51775,7 +52001,7 @@ class SearchApi {
51775
52001
  /**
51776
52002
  * Search service.
51777
52003
  * @module purecloud-platform-client-v2/api/SearchApi
51778
- * @version 154.0.0
52004
+ * @version 155.0.1
51779
52005
  */
51780
52006
 
51781
52007
  /**
@@ -52360,7 +52586,7 @@ class SpeechTextAnalyticsApi {
52360
52586
  /**
52361
52587
  * SpeechTextAnalytics service.
52362
52588
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
52363
- * @version 154.0.0
52589
+ * @version 155.0.1
52364
52590
  */
52365
52591
 
52366
52592
  /**
@@ -53214,7 +53440,7 @@ class StationsApi {
53214
53440
  /**
53215
53441
  * Stations service.
53216
53442
  * @module purecloud-platform-client-v2/api/StationsApi
53217
- * @version 154.0.0
53443
+ * @version 155.0.1
53218
53444
  */
53219
53445
 
53220
53446
  /**
@@ -53361,7 +53587,7 @@ class SuggestApi {
53361
53587
  /**
53362
53588
  * Suggest service.
53363
53589
  * @module purecloud-platform-client-v2/api/SuggestApi
53364
- * @version 154.0.0
53590
+ * @version 155.0.1
53365
53591
  */
53366
53592
 
53367
53593
  /**
@@ -53500,7 +53726,7 @@ class TeamsApi {
53500
53726
  /**
53501
53727
  * Teams service.
53502
53728
  * @module purecloud-platform-client-v2/api/TeamsApi
53503
- * @version 154.0.0
53729
+ * @version 155.0.1
53504
53730
  */
53505
53731
 
53506
53732
  /**
@@ -53771,7 +53997,7 @@ class TelephonyApi {
53771
53997
  /**
53772
53998
  * Telephony service.
53773
53999
  * @module purecloud-platform-client-v2/api/TelephonyApi
53774
- * @version 154.0.0
54000
+ * @version 155.0.1
53775
54001
  */
53776
54002
 
53777
54003
  /**
@@ -53786,6 +54012,26 @@ class TelephonyApi {
53786
54012
  }
53787
54013
 
53788
54014
 
54015
+ /**
54016
+ * Retrieve the list of AWS regions media can stream through.
54017
+ *
54018
+ */
54019
+ getTelephonyMediaregions() {
54020
+
54021
+ return this.apiClient.callApi(
54022
+ '/api/v2/telephony/mediaregions',
54023
+ 'GET',
54024
+ { },
54025
+ { },
54026
+ { },
54027
+ { },
54028
+ null,
54029
+ ['PureCloud OAuth'],
54030
+ ['application/json'],
54031
+ ['application/json']
54032
+ );
54033
+ }
54034
+
53789
54035
  /**
53790
54036
  * Fetch SIP metadata
53791
54037
  * Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
@@ -53879,7 +54125,7 @@ class TelephonyProvidersEdgeApi {
53879
54125
  /**
53880
54126
  * TelephonyProvidersEdge service.
53881
54127
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
53882
- * @version 154.0.0
54128
+ * @version 155.0.1
53883
54129
  */
53884
54130
 
53885
54131
  /**
@@ -57512,7 +57758,7 @@ class TextbotsApi {
57512
57758
  /**
57513
57759
  * Textbots service.
57514
57760
  * @module purecloud-platform-client-v2/api/TextbotsApi
57515
- * @version 154.0.0
57761
+ * @version 155.0.1
57516
57762
  */
57517
57763
 
57518
57764
  /**
@@ -57640,7 +57886,7 @@ class TokensApi {
57640
57886
  /**
57641
57887
  * Tokens service.
57642
57888
  * @module purecloud-platform-client-v2/api/TokensApi
57643
- * @version 154.0.0
57889
+ * @version 155.0.1
57644
57890
  */
57645
57891
 
57646
57892
  /**
@@ -57746,7 +57992,7 @@ class UploadsApi {
57746
57992
  /**
57747
57993
  * Uploads service.
57748
57994
  * @module purecloud-platform-client-v2/api/UploadsApi
57749
- * @version 154.0.0
57995
+ * @version 155.0.1
57750
57996
  */
57751
57997
 
57752
57998
  /**
@@ -57922,7 +58168,7 @@ class UsageApi {
57922
58168
  /**
57923
58169
  * Usage service.
57924
58170
  * @module purecloud-platform-client-v2/api/UsageApi
57925
- * @version 154.0.0
58171
+ * @version 155.0.1
57926
58172
  */
57927
58173
 
57928
58174
  /**
@@ -57993,7 +58239,7 @@ class UserRecordingsApi {
57993
58239
  /**
57994
58240
  * UserRecordings service.
57995
58241
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
57996
- * @version 154.0.0
58242
+ * @version 155.0.1
57997
58243
  */
57998
58244
 
57999
58245
  /**
@@ -58178,7 +58424,7 @@ class UsersApi {
58178
58424
  /**
58179
58425
  * Users service.
58180
58426
  * @module purecloud-platform-client-v2/api/UsersApi
58181
- * @version 154.0.0
58427
+ * @version 155.0.1
58182
58428
  */
58183
58429
 
58184
58430
  /**
@@ -60535,7 +60781,7 @@ class UtilitiesApi {
60535
60781
  /**
60536
60782
  * Utilities service.
60537
60783
  * @module purecloud-platform-client-v2/api/UtilitiesApi
60538
- * @version 154.0.0
60784
+ * @version 155.0.1
60539
60785
  */
60540
60786
 
60541
60787
  /**
@@ -60646,7 +60892,7 @@ class VoicemailApi {
60646
60892
  /**
60647
60893
  * Voicemail service.
60648
60894
  * @module purecloud-platform-client-v2/api/VoicemailApi
60649
- * @version 154.0.0
60895
+ * @version 155.0.1
60650
60896
  */
60651
60897
 
60652
60898
  /**
@@ -61313,7 +61559,7 @@ class WebChatApi {
61313
61559
  /**
61314
61560
  * WebChat service.
61315
61561
  * @module purecloud-platform-client-v2/api/WebChatApi
61316
- * @version 154.0.0
61562
+ * @version 155.0.1
61317
61563
  */
61318
61564
 
61319
61565
  /**
@@ -61857,7 +62103,7 @@ class WebDeploymentsApi {
61857
62103
  /**
61858
62104
  * WebDeployments service.
61859
62105
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
61860
- * @version 154.0.0
62106
+ * @version 155.0.1
61861
62107
  */
61862
62108
 
61863
62109
  /**
@@ -62245,7 +62491,7 @@ class WebMessagingApi {
62245
62491
  /**
62246
62492
  * WebMessaging service.
62247
62493
  * @module purecloud-platform-client-v2/api/WebMessagingApi
62248
- * @version 154.0.0
62494
+ * @version 155.0.1
62249
62495
  */
62250
62496
 
62251
62497
  /**
@@ -62291,7 +62537,7 @@ class WidgetsApi {
62291
62537
  /**
62292
62538
  * Widgets service.
62293
62539
  * @module purecloud-platform-client-v2/api/WidgetsApi
62294
- * @version 154.0.0
62540
+ * @version 155.0.1
62295
62541
  */
62296
62542
 
62297
62543
  /**
@@ -62437,7 +62683,7 @@ class WorkforceManagementApi {
62437
62683
  /**
62438
62684
  * WorkforceManagement service.
62439
62685
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
62440
- * @version 154.0.0
62686
+ * @version 155.0.1
62441
62687
  */
62442
62688
 
62443
62689
  /**
@@ -67107,7 +67353,7 @@ class WorkforceManagementApi {
67107
67353
  * </pre>
67108
67354
  * </p>
67109
67355
  * @module purecloud-platform-client-v2/index
67110
- * @version 154.0.0
67356
+ * @version 155.0.1
67111
67357
  */
67112
67358
  class platformClient {
67113
67359
  constructor() {