purecloud-platform-client-v2 196.0.0 → 197.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 (87) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +649 -116
  3. package/dist/web-amd/purecloud-platform-client-v2.js +649 -116
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +234 -98
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +235 -98
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +271 -92
  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/AgentUIApi.js +136 -0
  12. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +129 -1
  23. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +156 -0
  27. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +8 -4
  29. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/JourneyApi.js +3 -2
  40. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -2
  44. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OutboundApi.js +31 -35
  56. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
  62. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SettingsApi.js +111 -1
  67. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/index.js +13 -1
@@ -405,7 +405,7 @@ class Configuration {
405
405
 
406
406
  /**
407
407
  * @module purecloud-platform-client-v2/ApiClient
408
- * @version 196.0.0
408
+ * @version 197.0.0
409
409
  */
410
410
  class ApiClient {
411
411
  /**
@@ -1823,11 +1823,142 @@ class ApiClient {
1823
1823
  }
1824
1824
  }
1825
1825
 
1826
+ class AgentUIApi {
1827
+ /**
1828
+ * AgentUI service.
1829
+ * @module purecloud-platform-client-v2/api/AgentUIApi
1830
+ * @version 197.0.0
1831
+ */
1832
+
1833
+ /**
1834
+ * Constructs a new AgentUIApi.
1835
+ * @alias module:purecloud-platform-client-v2/api/AgentUIApi
1836
+ * @class
1837
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
1838
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
1839
+ */
1840
+ constructor(apiClient) {
1841
+ this.apiClient = apiClient || ApiClient.instance;
1842
+ }
1843
+
1844
+
1845
+ /**
1846
+ * Delete agent auto answer settings
1847
+ *
1848
+ * @param {String} agentId The agent to apply the auto answer settings to
1849
+ */
1850
+ deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
1851
+ // verify the required parameter 'agentId' is set
1852
+ if (agentId === undefined || agentId === null) {
1853
+ throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
1854
+ }
1855
+
1856
+ return this.apiClient.callApi(
1857
+ '/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
1858
+ 'DELETE',
1859
+ { 'agentId': agentId },
1860
+ { },
1861
+ { },
1862
+ { },
1863
+ null,
1864
+ ['PureCloud OAuth'],
1865
+ ['application/json'],
1866
+ ['application/json']
1867
+ );
1868
+ }
1869
+
1870
+ /**
1871
+ * Get agent auto answer settings
1872
+ *
1873
+ * @param {String} agentId The agent to apply the auto answer settings to
1874
+ */
1875
+ getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
1876
+ // verify the required parameter 'agentId' is set
1877
+ if (agentId === undefined || agentId === null) {
1878
+ throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
1879
+ }
1880
+
1881
+ return this.apiClient.callApi(
1882
+ '/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
1883
+ 'GET',
1884
+ { 'agentId': agentId },
1885
+ { },
1886
+ { },
1887
+ { },
1888
+ null,
1889
+ ['PureCloud OAuth'],
1890
+ ['application/json'],
1891
+ ['application/json']
1892
+ );
1893
+ }
1894
+
1895
+ /**
1896
+ * Update agent auto answer settings
1897
+ *
1898
+ * @param {String} agentId The agent to apply the auto answer settings to
1899
+ * @param {Object} body AutoAnswerSettings
1900
+ */
1901
+ patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
1902
+ // verify the required parameter 'agentId' is set
1903
+ if (agentId === undefined || agentId === null) {
1904
+ throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
1905
+ }
1906
+ // verify the required parameter 'body' is set
1907
+ if (body === undefined || body === null) {
1908
+ throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
1909
+ }
1910
+
1911
+ return this.apiClient.callApi(
1912
+ '/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
1913
+ 'PATCH',
1914
+ { 'agentId': agentId },
1915
+ { },
1916
+ { },
1917
+ { },
1918
+ body,
1919
+ ['PureCloud OAuth'],
1920
+ ['application/json'],
1921
+ ['application/json']
1922
+ );
1923
+ }
1924
+
1925
+ /**
1926
+ * Set agent auto answer settings
1927
+ *
1928
+ * @param {String} agentId The agent to apply the auto answer settings to
1929
+ * @param {Object} body AutoAnswerSettings
1930
+ */
1931
+ putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
1932
+ // verify the required parameter 'agentId' is set
1933
+ if (agentId === undefined || agentId === null) {
1934
+ throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
1935
+ }
1936
+ // verify the required parameter 'body' is set
1937
+ if (body === undefined || body === null) {
1938
+ throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
1939
+ }
1940
+
1941
+ return this.apiClient.callApi(
1942
+ '/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
1943
+ 'PUT',
1944
+ { 'agentId': agentId },
1945
+ { },
1946
+ { },
1947
+ { },
1948
+ body,
1949
+ ['PureCloud OAuth'],
1950
+ ['application/json'],
1951
+ ['application/json']
1952
+ );
1953
+ }
1954
+
1955
+ }
1956
+
1826
1957
  class AlertingApi {
1827
1958
  /**
1828
1959
  * Alerting service.
1829
1960
  * @module purecloud-platform-client-v2/api/AlertingApi
1830
- * @version 196.0.0
1961
+ * @version 197.0.0
1831
1962
  */
1832
1963
 
1833
1964
  /**
@@ -2488,7 +2619,7 @@ class AnalyticsApi {
2488
2619
  /**
2489
2620
  * Analytics service.
2490
2621
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2491
- * @version 196.0.0
2622
+ * @version 197.0.0
2492
2623
  */
2493
2624
 
2494
2625
  /**
@@ -5100,7 +5231,7 @@ class ArchitectApi {
5100
5231
  /**
5101
5232
  * Architect service.
5102
5233
  * @module purecloud-platform-client-v2/api/ArchitectApi
5103
- * @version 196.0.0
5234
+ * @version 197.0.0
5104
5235
  */
5105
5236
 
5106
5237
  /**
@@ -9246,7 +9377,7 @@ class AuditApi {
9246
9377
  /**
9247
9378
  * Audit service.
9248
9379
  * @module purecloud-platform-client-v2/api/AuditApi
9249
- * @version 196.0.0
9380
+ * @version 197.0.0
9250
9381
  */
9251
9382
 
9252
9383
  /**
@@ -9446,7 +9577,7 @@ class AuthorizationApi {
9446
9577
  /**
9447
9578
  * Authorization service.
9448
9579
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9449
- * @version 196.0.0
9580
+ * @version 197.0.0
9450
9581
  */
9451
9582
 
9452
9583
  /**
@@ -10684,7 +10815,7 @@ class BillingApi {
10684
10815
  /**
10685
10816
  * Billing service.
10686
10817
  * @module purecloud-platform-client-v2/api/BillingApi
10687
- * @version 196.0.0
10818
+ * @version 197.0.0
10688
10819
  */
10689
10820
 
10690
10821
  /**
@@ -10764,7 +10895,7 @@ class CarrierServicesApi {
10764
10895
  /**
10765
10896
  * CarrierServices service.
10766
10897
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10767
- * @version 196.0.0
10898
+ * @version 197.0.0
10768
10899
  */
10769
10900
 
10770
10901
  /**
@@ -10834,7 +10965,7 @@ class ChatApi {
10834
10965
  /**
10835
10966
  * Chat service.
10836
10967
  * @module purecloud-platform-client-v2/api/ChatApi
10837
- * @version 196.0.0
10968
+ * @version 197.0.0
10838
10969
  */
10839
10970
 
10840
10971
  /**
@@ -11770,7 +11901,7 @@ class CoachingApi {
11770
11901
  /**
11771
11902
  * Coaching service.
11772
11903
  * @module purecloud-platform-client-v2/api/CoachingApi
11773
- * @version 196.0.0
11904
+ * @version 197.0.0
11774
11905
  */
11775
11906
 
11776
11907
  /**
@@ -12347,7 +12478,7 @@ class ContentManagementApi {
12347
12478
  /**
12348
12479
  * ContentManagement service.
12349
12480
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12350
- * @version 196.0.0
12481
+ * @version 197.0.0
12351
12482
  */
12352
12483
 
12353
12484
  /**
@@ -13429,7 +13560,7 @@ class ConversationsApi {
13429
13560
  /**
13430
13561
  * Conversations service.
13431
13562
  * @module purecloud-platform-client-v2/api/ConversationsApi
13432
- * @version 196.0.0
13563
+ * @version 197.0.0
13433
13564
  */
13434
13565
 
13435
13566
  /**
@@ -14148,6 +14279,69 @@ class ConversationsApi {
14148
14279
  );
14149
14280
  }
14150
14281
 
14282
+ /**
14283
+ * Get Suggestion.
14284
+ *
14285
+ * @param {String} conversationId Conversation ID
14286
+ * @param {String} suggestionId Suggestion ID
14287
+ */
14288
+ getConversationSuggestion(conversationId, suggestionId) {
14289
+ // verify the required parameter 'conversationId' is set
14290
+ if (conversationId === undefined || conversationId === null) {
14291
+ throw 'Missing the required parameter "conversationId" when calling getConversationSuggestion';
14292
+ }
14293
+ // verify the required parameter 'suggestionId' is set
14294
+ if (suggestionId === undefined || suggestionId === null) {
14295
+ throw 'Missing the required parameter "suggestionId" when calling getConversationSuggestion';
14296
+ }
14297
+
14298
+ return this.apiClient.callApi(
14299
+ '/api/v2/conversations/{conversationId}/suggestions/{suggestionId}',
14300
+ 'GET',
14301
+ { 'conversationId': conversationId,'suggestionId': suggestionId },
14302
+ { },
14303
+ { },
14304
+ { },
14305
+ null,
14306
+ ['PureCloud OAuth'],
14307
+ ['application/json'],
14308
+ ['application/json']
14309
+ );
14310
+ }
14311
+
14312
+ /**
14313
+ * Get all suggestions for a conversation.
14314
+ *
14315
+ * @param {String} conversationId Conversation ID
14316
+ * @param {Object} opts Optional parameters
14317
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
14318
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
14319
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
14320
+ * @param {Object} opts.type Suggestion type to filter by.
14321
+ * @param {Object} opts.state Suggestion state to filter Copilot suggestions.
14322
+ */
14323
+ getConversationSuggestions(conversationId, opts) {
14324
+ opts = opts || {};
14325
+
14326
+ // verify the required parameter 'conversationId' is set
14327
+ if (conversationId === undefined || conversationId === null) {
14328
+ throw 'Missing the required parameter "conversationId" when calling getConversationSuggestions';
14329
+ }
14330
+
14331
+ return this.apiClient.callApi(
14332
+ '/api/v2/conversations/{conversationId}/suggestions',
14333
+ 'GET',
14334
+ { 'conversationId': conversationId },
14335
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'type': opts['type'],'state': opts['state'] },
14336
+ { },
14337
+ { },
14338
+ null,
14339
+ ['PureCloud OAuth'],
14340
+ ['application/json'],
14341
+ ['application/json']
14342
+ );
14343
+ }
14344
+
14151
14345
  /**
14152
14346
  * Get active conversations for the logged in user
14153
14347
  *
@@ -17963,6 +18157,71 @@ class ConversationsApi {
17963
18157
  );
17964
18158
  }
17965
18159
 
18160
+ /**
18161
+ * Save an engagement on the suggestion.
18162
+ *
18163
+ * @param {String} conversationId Conversation ID
18164
+ * @param {String} suggestionId Suggestion ID
18165
+ * @param {Object} body
18166
+ */
18167
+ postConversationSuggestionEngagement(conversationId, suggestionId, body) {
18168
+ // verify the required parameter 'conversationId' is set
18169
+ if (conversationId === undefined || conversationId === null) {
18170
+ throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionEngagement';
18171
+ }
18172
+ // verify the required parameter 'suggestionId' is set
18173
+ if (suggestionId === undefined || suggestionId === null) {
18174
+ throw 'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';
18175
+ }
18176
+ // verify the required parameter 'body' is set
18177
+ if (body === undefined || body === null) {
18178
+ throw 'Missing the required parameter "body" when calling postConversationSuggestionEngagement';
18179
+ }
18180
+
18181
+ return this.apiClient.callApi(
18182
+ '/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement',
18183
+ 'POST',
18184
+ { 'conversationId': conversationId,'suggestionId': suggestionId },
18185
+ { },
18186
+ { },
18187
+ { },
18188
+ body,
18189
+ ['PureCloud OAuth'],
18190
+ ['application/json'],
18191
+ ['application/json']
18192
+ );
18193
+ }
18194
+
18195
+ /**
18196
+ * Suggestion feedback.
18197
+ *
18198
+ * @param {String} conversationId Conversation ID
18199
+ * @param {Object} body SuggestionFeedback
18200
+ */
18201
+ postConversationSuggestionsFeedback(conversationId, body) {
18202
+ // verify the required parameter 'conversationId' is set
18203
+ if (conversationId === undefined || conversationId === null) {
18204
+ throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';
18205
+ }
18206
+ // verify the required parameter 'body' is set
18207
+ if (body === undefined || body === null) {
18208
+ throw 'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';
18209
+ }
18210
+
18211
+ return this.apiClient.callApi(
18212
+ '/api/v2/conversations/{conversationId}/suggestions/feedback',
18213
+ 'POST',
18214
+ { 'conversationId': conversationId },
18215
+ { },
18216
+ { },
18217
+ { },
18218
+ body,
18219
+ ['PureCloud OAuth'],
18220
+ ['application/json'],
18221
+ ['application/json']
18222
+ );
18223
+ }
18224
+
17966
18225
  /**
17967
18226
  * Submit feedback for the summary.
17968
18227
  *
@@ -20380,7 +20639,7 @@ class DataExtensionsApi {
20380
20639
  /**
20381
20640
  * DataExtensions service.
20382
20641
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20383
- * @version 196.0.0
20642
+ * @version 197.0.0
20384
20643
  */
20385
20644
 
20386
20645
  /**
@@ -20466,7 +20725,7 @@ class DownloadsApi {
20466
20725
  /**
20467
20726
  * Downloads service.
20468
20727
  * @module purecloud-platform-client-v2/api/DownloadsApi
20469
- * @version 196.0.0
20728
+ * @version 197.0.0
20470
20729
  */
20471
20730
 
20472
20731
  /**
@@ -20518,7 +20777,7 @@ class EmailsApi {
20518
20777
  /**
20519
20778
  * Emails service.
20520
20779
  * @module purecloud-platform-client-v2/api/EmailsApi
20521
- * @version 196.0.0
20780
+ * @version 197.0.0
20522
20781
  */
20523
20782
 
20524
20783
  /**
@@ -20579,11 +20838,162 @@ class EmailsApi {
20579
20838
 
20580
20839
  }
20581
20840
 
20841
+ class EmployeeEngagementApi {
20842
+ /**
20843
+ * EmployeeEngagement service.
20844
+ * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
20845
+ * @version 197.0.0
20846
+ */
20847
+
20848
+ /**
20849
+ * Constructs a new EmployeeEngagementApi.
20850
+ * @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
20851
+ * @class
20852
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
20853
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
20854
+ */
20855
+ constructor(apiClient) {
20856
+ this.apiClient = apiClient || ApiClient.instance;
20857
+ }
20858
+
20859
+
20860
+ /**
20861
+ * Deletes a celebration
20862
+ *
20863
+ * @param {String} celebrationId The ID of the celebration
20864
+ */
20865
+ deleteEmployeeengagementCelebration(celebrationId) {
20866
+ // verify the required parameter 'celebrationId' is set
20867
+ if (celebrationId === undefined || celebrationId === null) {
20868
+ throw 'Missing the required parameter "celebrationId" when calling deleteEmployeeengagementCelebration';
20869
+ }
20870
+
20871
+ return this.apiClient.callApi(
20872
+ '/api/v2/employeeengagement/celebrations/{celebrationId}',
20873
+ 'DELETE',
20874
+ { 'celebrationId': celebrationId },
20875
+ { },
20876
+ { },
20877
+ { },
20878
+ null,
20879
+ ['PureCloud OAuth'],
20880
+ ['application/json'],
20881
+ ['application/json']
20882
+ );
20883
+ }
20884
+
20885
+ /**
20886
+ * Get all celebrations
20887
+ *
20888
+ * @param {Object} opts Optional parameters
20889
+ * @param {Number} opts.pageNumber (default to 1)
20890
+ * @param {Number} opts.pageSize (default to 25)
20891
+ */
20892
+ getEmployeeengagementCelebrations(opts) {
20893
+ opts = opts || {};
20894
+
20895
+
20896
+ return this.apiClient.callApi(
20897
+ '/api/v2/employeeengagement/celebrations',
20898
+ 'GET',
20899
+ { },
20900
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
20901
+ { },
20902
+ { },
20903
+ null,
20904
+ ['PureCloud OAuth'],
20905
+ ['application/json'],
20906
+ ['application/json']
20907
+ );
20908
+ }
20909
+
20910
+ /**
20911
+ * Gets a single recognition
20912
+ *
20913
+ * @param {String} recognitionId The Recognition ID
20914
+ */
20915
+ getEmployeeengagementRecognition(recognitionId) {
20916
+ // verify the required parameter 'recognitionId' is set
20917
+ if (recognitionId === undefined || recognitionId === null) {
20918
+ throw 'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';
20919
+ }
20920
+
20921
+ return this.apiClient.callApi(
20922
+ '/api/v2/employeeengagement/recognitions/{recognitionId}',
20923
+ 'GET',
20924
+ { 'recognitionId': recognitionId },
20925
+ { },
20926
+ { },
20927
+ { },
20928
+ null,
20929
+ ['PureCloud OAuth'],
20930
+ ['application/json'],
20931
+ ['application/json']
20932
+ );
20933
+ }
20934
+
20935
+ /**
20936
+ * Set a state for a celebration
20937
+ *
20938
+ * @param {String} celebrationId The ID of the celebration
20939
+ * @param {Object} body Patch Celebration state
20940
+ */
20941
+ patchEmployeeengagementCelebration(celebrationId, body) {
20942
+ // verify the required parameter 'celebrationId' is set
20943
+ if (celebrationId === undefined || celebrationId === null) {
20944
+ throw 'Missing the required parameter "celebrationId" when calling patchEmployeeengagementCelebration';
20945
+ }
20946
+ // verify the required parameter 'body' is set
20947
+ if (body === undefined || body === null) {
20948
+ throw 'Missing the required parameter "body" when calling patchEmployeeengagementCelebration';
20949
+ }
20950
+
20951
+ return this.apiClient.callApi(
20952
+ '/api/v2/employeeengagement/celebrations/{celebrationId}',
20953
+ 'PATCH',
20954
+ { 'celebrationId': celebrationId },
20955
+ { },
20956
+ { },
20957
+ { },
20958
+ body,
20959
+ ['PureCloud OAuth'],
20960
+ ['application/json'],
20961
+ ['application/json']
20962
+ );
20963
+ }
20964
+
20965
+ /**
20966
+ * Creates a recognition
20967
+ *
20968
+ * @param {Object} body Create Recognition
20969
+ */
20970
+ postEmployeeengagementRecognitions(body) {
20971
+ // verify the required parameter 'body' is set
20972
+ if (body === undefined || body === null) {
20973
+ throw 'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';
20974
+ }
20975
+
20976
+ return this.apiClient.callApi(
20977
+ '/api/v2/employeeengagement/recognitions',
20978
+ 'POST',
20979
+ { },
20980
+ { },
20981
+ { },
20982
+ { },
20983
+ body,
20984
+ ['PureCloud OAuth'],
20985
+ ['application/json'],
20986
+ ['application/json']
20987
+ );
20988
+ }
20989
+
20990
+ }
20991
+
20582
20992
  class EventsApi {
20583
20993
  /**
20584
20994
  * Events service.
20585
20995
  * @module purecloud-platform-client-v2/api/EventsApi
20586
- * @version 196.0.0
20996
+ * @version 197.0.0
20587
20997
  */
20588
20998
 
20589
20999
  /**
@@ -20679,7 +21089,7 @@ class ExternalContactsApi {
20679
21089
  /**
20680
21090
  * ExternalContacts service.
20681
21091
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
20682
- * @version 196.0.0
21092
+ * @version 197.0.0
20683
21093
  */
20684
21094
 
20685
21095
  /**
@@ -20884,7 +21294,7 @@ class ExternalContactsApi {
20884
21294
  *
20885
21295
  * @param {String} contactId ExternalContact ID
20886
21296
  * @param {Object} opts Optional parameters
20887
- * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
21297
+ * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
20888
21298
  */
20889
21299
  getExternalcontactsContact(contactId, opts) {
20890
21300
  opts = opts || {};
@@ -22200,8 +22610,12 @@ class ExternalContactsApi {
22200
22610
  * Fetch a contact using an identifier type and value.
22201
22611
  * Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
22202
22612
  * @param {Object} identifier
22613
+ * @param {Object} opts Optional parameters
22614
+ * @param {Array.<String>} opts.expand which field, if any, to expand
22203
22615
  */
22204
- postExternalcontactsIdentifierlookup(identifier) {
22616
+ postExternalcontactsIdentifierlookup(identifier, opts) {
22617
+ opts = opts || {};
22618
+
22205
22619
  // verify the required parameter 'identifier' is set
22206
22620
  if (identifier === undefined || identifier === null) {
22207
22621
  throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
@@ -22211,7 +22625,7 @@ class ExternalContactsApi {
22211
22625
  '/api/v2/externalcontacts/identifierlookup',
22212
22626
  'POST',
22213
22627
  { },
22214
- { },
22628
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
22215
22629
  { },
22216
22630
  { },
22217
22631
  identifier,
@@ -22637,7 +23051,7 @@ class FaxApi {
22637
23051
  /**
22638
23052
  * Fax service.
22639
23053
  * @module purecloud-platform-client-v2/api/FaxApi
22640
- * @version 196.0.0
23054
+ * @version 197.0.0
22641
23055
  */
22642
23056
 
22643
23057
  /**
@@ -22852,7 +23266,7 @@ class FlowsApi {
22852
23266
  /**
22853
23267
  * Flows service.
22854
23268
  * @module purecloud-platform-client-v2/api/FlowsApi
22855
- * @version 196.0.0
23269
+ * @version 197.0.0
22856
23270
  */
22857
23271
 
22858
23272
  /**
@@ -23035,7 +23449,7 @@ class GamificationApi {
23035
23449
  /**
23036
23450
  * Gamification service.
23037
23451
  * @module purecloud-platform-client-v2/api/GamificationApi
23038
- * @version 196.0.0
23452
+ * @version 197.0.0
23039
23453
  */
23040
23454
 
23041
23455
  /**
@@ -25121,7 +25535,7 @@ class GeneralDataProtectionRegulationApi {
25121
25535
  /**
25122
25536
  * GeneralDataProtectionRegulation service.
25123
25537
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25124
- * @version 196.0.0
25538
+ * @version 197.0.0
25125
25539
  */
25126
25540
 
25127
25541
  /**
@@ -25251,7 +25665,7 @@ class GeolocationApi {
25251
25665
  /**
25252
25666
  * Geolocation service.
25253
25667
  * @module purecloud-platform-client-v2/api/GeolocationApi
25254
- * @version 196.0.0
25668
+ * @version 197.0.0
25255
25669
  */
25256
25670
 
25257
25671
  /**
@@ -25382,7 +25796,7 @@ class GreetingsApi {
25382
25796
  /**
25383
25797
  * Greetings service.
25384
25798
  * @module purecloud-platform-client-v2/api/GreetingsApi
25385
- * @version 196.0.0
25799
+ * @version 197.0.0
25386
25800
  */
25387
25801
 
25388
25802
  /**
@@ -25837,7 +26251,7 @@ class GroupsApi {
25837
26251
  /**
25838
26252
  * Groups service.
25839
26253
  * @module purecloud-platform-client-v2/api/GroupsApi
25840
- * @version 196.0.0
26254
+ * @version 197.0.0
25841
26255
  */
25842
26256
 
25843
26257
  /**
@@ -26356,7 +26770,7 @@ class IdentityProviderApi {
26356
26770
  /**
26357
26771
  * IdentityProvider service.
26358
26772
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26359
- * @version 196.0.0
26773
+ * @version 197.0.0
26360
26774
  */
26361
26775
 
26362
26776
  /**
@@ -27217,7 +27631,7 @@ class InfrastructureAsCodeApi {
27217
27631
  /**
27218
27632
  * InfrastructureAsCode service.
27219
27633
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27220
- * @version 196.0.0
27634
+ * @version 197.0.0
27221
27635
  */
27222
27636
 
27223
27637
  /**
@@ -27384,7 +27798,7 @@ class IntegrationsApi {
27384
27798
  /**
27385
27799
  * Integrations service.
27386
27800
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27387
- * @version 196.0.0
27801
+ * @version 197.0.0
27388
27802
  */
27389
27803
 
27390
27804
  /**
@@ -29736,7 +30150,7 @@ class JourneyApi {
29736
30150
  /**
29737
30151
  * Journey service.
29738
30152
  * @module purecloud-platform-client-v2/api/JourneyApi
29739
- * @version 196.0.0
30153
+ * @version 197.0.0
29740
30154
  */
29741
30155
 
29742
30156
  /**
@@ -30480,6 +30894,7 @@ class JourneyApi {
30480
30894
  * @param {Object} opts Optional parameters
30481
30895
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
30482
30896
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
30897
+ * @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
30483
30898
  * getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30484
30899
  */
30485
30900
  getJourneySessionEvents(sessionId, opts) {
@@ -30494,7 +30909,7 @@ class JourneyApi {
30494
30909
  '/api/v2/journey/sessions/{sessionId}/events',
30495
30910
  'GET',
30496
30911
  { 'sessionId': sessionId },
30497
- { 'pageSize': opts['pageSize'],'after': opts['after'] },
30912
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'eventType': opts['eventType'] },
30498
30913
  { },
30499
30914
  { },
30500
30915
  null,
@@ -31353,7 +31768,7 @@ class KnowledgeApi {
31353
31768
  /**
31354
31769
  * Knowledge service.
31355
31770
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31356
- * @version 196.0.0
31771
+ * @version 197.0.0
31357
31772
  */
31358
31773
 
31359
31774
  /**
@@ -34597,7 +35012,7 @@ class LanguageUnderstandingApi {
34597
35012
  /**
34598
35013
  * LanguageUnderstanding service.
34599
35014
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
34600
- * @version 196.0.0
35015
+ * @version 197.0.0
34601
35016
  */
34602
35017
 
34603
35018
  /**
@@ -35631,7 +36046,7 @@ class LanguagesApi {
35631
36046
  /**
35632
36047
  * Languages service.
35633
36048
  * @module purecloud-platform-client-v2/api/LanguagesApi
35634
- * @version 196.0.0
36049
+ * @version 197.0.0
35635
36050
  */
35636
36051
 
35637
36052
  /**
@@ -35853,7 +36268,7 @@ class LearningApi {
35853
36268
  /**
35854
36269
  * Learning service.
35855
36270
  * @module purecloud-platform-client-v2/api/LearningApi
35856
- * @version 196.0.0
36271
+ * @version 197.0.0
35857
36272
  */
35858
36273
 
35859
36274
  /**
@@ -35954,6 +36369,7 @@ class LearningApi {
35954
36369
  * @param {String} stepId The ID of Learning Assignment Step
35955
36370
  * @param {Object} opts Optional parameters
35956
36371
  * @param {String} opts.shareableContentObjectId The ID of SCO to load
36372
+ * @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
35957
36373
  * @param {Array.<String>} opts.expand Fields to expand in response
35958
36374
  */
35959
36375
  getLearningAssignmentStep(assignmentId, stepId, opts) {
@@ -35972,7 +36388,7 @@ class LearningApi {
35972
36388
  '/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
35973
36389
  'GET',
35974
36390
  { 'assignmentId': assignmentId,'stepId': stepId },
35975
- { 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
36391
+ { 'shareableContentObjectId': opts['shareableContentObjectId'],'defaultShareableContentObject': opts['defaultShareableContentObject'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
35976
36392
  { },
35977
36393
  { },
35978
36394
  null,
@@ -36881,7 +37297,7 @@ class LicenseApi {
36881
37297
  /**
36882
37298
  * License service.
36883
37299
  * @module purecloud-platform-client-v2/api/LicenseApi
36884
- * @version 196.0.0
37300
+ * @version 197.0.0
36885
37301
  */
36886
37302
 
36887
37303
  /**
@@ -37119,7 +37535,7 @@ class LocationsApi {
37119
37535
  /**
37120
37536
  * Locations service.
37121
37537
  * @module purecloud-platform-client-v2/api/LocationsApi
37122
- * @version 196.0.0
37538
+ * @version 197.0.0
37123
37539
  */
37124
37540
 
37125
37541
  /**
@@ -37355,7 +37771,7 @@ class LogCaptureApi {
37355
37771
  /**
37356
37772
  * LogCapture service.
37357
37773
  * @module purecloud-platform-client-v2/api/LogCaptureApi
37358
- * @version 196.0.0
37774
+ * @version 197.0.0
37359
37775
  */
37360
37776
 
37361
37777
  /**
@@ -37555,7 +37971,7 @@ class MessagingApi {
37555
37971
  /**
37556
37972
  * Messaging service.
37557
37973
  * @module purecloud-platform-client-v2/api/MessagingApi
37558
- * @version 196.0.0
37974
+ * @version 197.0.0
37559
37975
  */
37560
37976
 
37561
37977
  /**
@@ -37914,7 +38330,7 @@ class MobileDevicesApi {
37914
38330
  /**
37915
38331
  * MobileDevices service.
37916
38332
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
37917
- * @version 196.0.0
38333
+ * @version 197.0.0
37918
38334
  */
37919
38335
 
37920
38336
  /**
@@ -38065,7 +38481,7 @@ class NotificationsApi {
38065
38481
  /**
38066
38482
  * Notifications service.
38067
38483
  * @module purecloud-platform-client-v2/api/NotificationsApi
38068
- * @version 196.0.0
38484
+ * @version 197.0.0
38069
38485
  */
38070
38486
 
38071
38487
  /**
@@ -38298,7 +38714,7 @@ class OAuthApi {
38298
38714
  /**
38299
38715
  * OAuth service.
38300
38716
  * @module purecloud-platform-client-v2/api/OAuthApi
38301
- * @version 196.0.0
38717
+ * @version 197.0.0
38302
38718
  */
38303
38719
 
38304
38720
  /**
@@ -38664,7 +39080,7 @@ class ObjectsApi {
38664
39080
  /**
38665
39081
  * Objects service.
38666
39082
  * @module purecloud-platform-client-v2/api/ObjectsApi
38667
- * @version 196.0.0
39083
+ * @version 197.0.0
38668
39084
  */
38669
39085
 
38670
39086
  /**
@@ -38934,7 +39350,7 @@ class OperationalEventsApi {
38934
39350
  /**
38935
39351
  * OperationalEvents service.
38936
39352
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
38937
- * @version 196.0.0
39353
+ * @version 197.0.0
38938
39354
  */
38939
39355
 
38940
39356
  /**
@@ -39000,7 +39416,7 @@ class OrganizationApi {
39000
39416
  /**
39001
39417
  * Organization service.
39002
39418
  * @module purecloud-platform-client-v2/api/OrganizationApi
39003
- * @version 196.0.0
39419
+ * @version 197.0.0
39004
39420
  */
39005
39421
 
39006
39422
  /**
@@ -39475,7 +39891,7 @@ class OrganizationAuthorizationApi {
39475
39891
  /**
39476
39892
  * OrganizationAuthorization service.
39477
39893
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39478
- * @version 196.0.0
39894
+ * @version 197.0.0
39479
39895
  */
39480
39896
 
39481
39897
  /**
@@ -40822,7 +41238,7 @@ class OutboundApi {
40822
41238
  /**
40823
41239
  * Outbound service.
40824
41240
  * @module purecloud-platform-client-v2/api/OutboundApi
40825
- * @version 196.0.0
41241
+ * @version 197.0.0
40826
41242
  */
40827
41243
 
40828
41244
  /**
@@ -43438,6 +43854,36 @@ class OutboundApi {
43438
43854
  );
43439
43855
  }
43440
43856
 
43857
+ /**
43858
+ * Update a campaign.
43859
+ *
43860
+ * @param {String} campaignId Campaign ID
43861
+ * @param {Object} body CampaignPatchRequest
43862
+ */
43863
+ patchOutboundCampaign(campaignId, body) {
43864
+ // verify the required parameter 'campaignId' is set
43865
+ if (campaignId === undefined || campaignId === null) {
43866
+ throw 'Missing the required parameter "campaignId" when calling patchOutboundCampaign';
43867
+ }
43868
+ // verify the required parameter 'body' is set
43869
+ if (body === undefined || body === null) {
43870
+ throw 'Missing the required parameter "body" when calling patchOutboundCampaign';
43871
+ }
43872
+
43873
+ return this.apiClient.callApi(
43874
+ '/api/v2/outbound/campaigns/{campaignId}',
43875
+ 'PATCH',
43876
+ { 'campaignId': campaignId },
43877
+ { },
43878
+ { },
43879
+ { },
43880
+ body,
43881
+ ['PureCloud OAuth'],
43882
+ ['application/json'],
43883
+ ['application/json']
43884
+ );
43885
+ }
43886
+
43441
43887
  /**
43442
43888
  * Add entries to or delete entries from a DNC list.
43443
43889
  * Only Internal DNC lists may be deleted from
@@ -43578,40 +44024,6 @@ class OutboundApi {
43578
44024
  );
43579
44025
  }
43580
44026
 
43581
- /**
43582
- * Retrieves audits for dialer. (Deprecated)
43583
- * This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
43584
- * @param {Object} body AuditSearch
43585
- * @param {Object} opts Optional parameters
43586
- * @param {Number} opts.pageSize Page size (default to 25)
43587
- * @param {Number} opts.pageNumber Page number (default to 1)
43588
- * @param {String} opts.sortBy Sort by (default to entity.name)
43589
- * @param {String} opts.sortOrder Sort order (default to ascending)
43590
- * @param {Boolean} opts.facetsOnly Facets only (default to false)
43591
- * @deprecated
43592
- */
43593
- postOutboundAudits(body, opts) {
43594
- opts = opts || {};
43595
-
43596
- // verify the required parameter 'body' is set
43597
- if (body === undefined || body === null) {
43598
- throw 'Missing the required parameter "body" when calling postOutboundAudits';
43599
- }
43600
-
43601
- return this.apiClient.callApi(
43602
- '/api/v2/outbound/audits',
43603
- 'POST',
43604
- { },
43605
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'facetsOnly': opts['facetsOnly'] },
43606
- { },
43607
- { },
43608
- body,
43609
- ['PureCloud OAuth'],
43610
- ['application/json'],
43611
- ['application/json']
43612
- );
43613
- }
43614
-
43615
44027
  /**
43616
44028
  * Create callable time set
43617
44029
  *
@@ -45188,7 +45600,7 @@ class PresenceApi {
45188
45600
  /**
45189
45601
  * Presence service.
45190
45602
  * @module purecloud-platform-client-v2/api/PresenceApi
45191
- * @version 196.0.0
45603
+ * @version 197.0.0
45192
45604
  */
45193
45605
 
45194
45606
  /**
@@ -45932,7 +46344,7 @@ class ProcessAutomationApi {
45932
46344
  /**
45933
46345
  * ProcessAutomation service.
45934
46346
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
45935
- * @version 196.0.0
46347
+ * @version 197.0.0
45936
46348
  */
45937
46349
 
45938
46350
  /**
@@ -46171,7 +46583,7 @@ class QualityApi {
46171
46583
  /**
46172
46584
  * Quality service.
46173
46585
  * @module purecloud-platform-client-v2/api/QualityApi
46174
- * @version 196.0.0
46586
+ * @version 197.0.0
46175
46587
  */
46176
46588
 
46177
46589
  /**
@@ -47926,7 +48338,7 @@ class RecordingApi {
47926
48338
  /**
47927
48339
  * Recording service.
47928
48340
  * @module purecloud-platform-client-v2/api/RecordingApi
47929
- * @version 196.0.0
48341
+ * @version 197.0.0
47930
48342
  */
47931
48343
 
47932
48344
  /**
@@ -49584,7 +49996,7 @@ class ResponseManagementApi {
49584
49996
  /**
49585
49997
  * ResponseManagement service.
49586
49998
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
49587
- * @version 196.0.0
49999
+ * @version 197.0.0
49588
50000
  */
49589
50001
 
49590
50002
  /**
@@ -50094,7 +50506,7 @@ class RoutingApi {
50094
50506
  /**
50095
50507
  * Routing service.
50096
50508
  * @module purecloud-platform-client-v2/api/RoutingApi
50097
- * @version 196.0.0
50509
+ * @version 197.0.0
50098
50510
  */
50099
50511
 
50100
50512
  /**
@@ -52005,6 +52417,7 @@ class RoutingApi {
52005
52417
  * @param {Object} opts.sortOrder Sort order
52006
52418
  * @param {String} opts.language A language tag (which is sometimes referred to as a locale identifier) to use to localize country field and sort operations (default to en-US)
52007
52419
  * @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
52420
+ * @param {String} opts.supportedContentId Filter based on the supported content ID
52008
52421
  */
52009
52422
  getRoutingSmsPhonenumbers(opts) {
52010
52423
  opts = opts || {};
@@ -52014,7 +52427,7 @@ class RoutingApi {
52014
52427
  '/api/v2/routing/sms/phonenumbers',
52015
52428
  'GET',
52016
52429
  { },
52017
- { 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'] },
52430
+ { 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'],'supportedContent.id': opts['supportedContentId'] },
52018
52431
  { },
52019
52432
  { },
52020
52433
  null,
@@ -54067,7 +54480,7 @@ class SCIMApi {
54067
54480
  /**
54068
54481
  * SCIM service.
54069
54482
  * @module purecloud-platform-client-v2/api/SCIMApi
54070
- * @version 196.0.0
54483
+ * @version 197.0.0
54071
54484
  */
54072
54485
 
54073
54486
  /**
@@ -54944,7 +55357,7 @@ class ScreenRecordingApi {
54944
55357
  /**
54945
55358
  * ScreenRecording service.
54946
55359
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
54947
- * @version 196.0.0
55360
+ * @version 197.0.0
54948
55361
  */
54949
55362
 
54950
55363
  /**
@@ -54989,7 +55402,7 @@ class ScriptsApi {
54989
55402
  /**
54990
55403
  * Scripts service.
54991
55404
  * @module purecloud-platform-client-v2/api/ScriptsApi
54992
- * @version 196.0.0
55405
+ * @version 197.0.0
54993
55406
  */
54994
55407
 
54995
55408
  /**
@@ -55433,7 +55846,7 @@ class SearchApi {
55433
55846
  /**
55434
55847
  * Search service.
55435
55848
  * @module purecloud-platform-client-v2/api/SearchApi
55436
- * @version 196.0.0
55849
+ * @version 197.0.0
55437
55850
  */
55438
55851
 
55439
55852
  /**
@@ -56122,7 +56535,7 @@ class SettingsApi {
56122
56535
  /**
56123
56536
  * Settings service.
56124
56537
  * @module purecloud-platform-client-v2/api/SettingsApi
56125
- * @version 196.0.0
56538
+ * @version 197.0.0
56126
56539
  */
56127
56540
 
56128
56541
  /**
@@ -56137,6 +56550,31 @@ class SettingsApi {
56137
56550
  }
56138
56551
 
56139
56552
 
56553
+ /**
56554
+ * Delete agent auto answer settings
56555
+ *
56556
+ * @param {String} agentId The agent to apply the auto answer settings to
56557
+ */
56558
+ deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
56559
+ // verify the required parameter 'agentId' is set
56560
+ if (agentId === undefined || agentId === null) {
56561
+ throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
56562
+ }
56563
+
56564
+ return this.apiClient.callApi(
56565
+ '/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
56566
+ 'DELETE',
56567
+ { 'agentId': agentId },
56568
+ { },
56569
+ { },
56570
+ { },
56571
+ null,
56572
+ ['PureCloud OAuth'],
56573
+ ['application/json'],
56574
+ ['application/json']
56575
+ );
56576
+ }
56577
+
56140
56578
  /**
56141
56579
  * Get email Contact Center settings
56142
56580
  *
@@ -56178,6 +56616,31 @@ class SettingsApi {
56178
56616
  );
56179
56617
  }
56180
56618
 
56619
+ /**
56620
+ * Get agent auto answer settings
56621
+ *
56622
+ * @param {String} agentId The agent to apply the auto answer settings to
56623
+ */
56624
+ getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
56625
+ // verify the required parameter 'agentId' is set
56626
+ if (agentId === undefined || agentId === null) {
56627
+ throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
56628
+ }
56629
+
56630
+ return this.apiClient.callApi(
56631
+ '/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
56632
+ 'GET',
56633
+ { 'agentId': agentId },
56634
+ { },
56635
+ { },
56636
+ { },
56637
+ null,
56638
+ ['PureCloud OAuth'],
56639
+ ['application/json'],
56640
+ ['application/json']
56641
+ );
56642
+ }
56643
+
56181
56644
  /**
56182
56645
  * Patch email Contact Center settings
56183
56646
  *
@@ -56228,13 +56691,73 @@ class SettingsApi {
56228
56691
  );
56229
56692
  }
56230
56693
 
56694
+ /**
56695
+ * Update agent auto answer settings
56696
+ *
56697
+ * @param {String} agentId The agent to apply the auto answer settings to
56698
+ * @param {Object} body AutoAnswerSettings
56699
+ */
56700
+ patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
56701
+ // verify the required parameter 'agentId' is set
56702
+ if (agentId === undefined || agentId === null) {
56703
+ throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
56704
+ }
56705
+ // verify the required parameter 'body' is set
56706
+ if (body === undefined || body === null) {
56707
+ throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
56708
+ }
56709
+
56710
+ return this.apiClient.callApi(
56711
+ '/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
56712
+ 'PATCH',
56713
+ { 'agentId': agentId },
56714
+ { },
56715
+ { },
56716
+ { },
56717
+ body,
56718
+ ['PureCloud OAuth'],
56719
+ ['application/json'],
56720
+ ['application/json']
56721
+ );
56722
+ }
56723
+
56724
+ /**
56725
+ * Set agent auto answer settings
56726
+ *
56727
+ * @param {String} agentId The agent to apply the auto answer settings to
56728
+ * @param {Object} body AutoAnswerSettings
56729
+ */
56730
+ putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
56731
+ // verify the required parameter 'agentId' is set
56732
+ if (agentId === undefined || agentId === null) {
56733
+ throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
56734
+ }
56735
+ // verify the required parameter 'body' is set
56736
+ if (body === undefined || body === null) {
56737
+ throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
56738
+ }
56739
+
56740
+ return this.apiClient.callApi(
56741
+ '/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
56742
+ 'PUT',
56743
+ { 'agentId': agentId },
56744
+ { },
56745
+ { },
56746
+ { },
56747
+ body,
56748
+ ['PureCloud OAuth'],
56749
+ ['application/json'],
56750
+ ['application/json']
56751
+ );
56752
+ }
56753
+
56231
56754
  }
56232
56755
 
56233
56756
  class SpeechTextAnalyticsApi {
56234
56757
  /**
56235
56758
  * SpeechTextAnalytics service.
56236
56759
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
56237
- * @version 196.0.0
56760
+ * @version 197.0.0
56238
56761
  */
56239
56762
 
56240
56763
  /**
@@ -57512,7 +58035,7 @@ class StationsApi {
57512
58035
  /**
57513
58036
  * Stations service.
57514
58037
  * @module purecloud-platform-client-v2/api/StationsApi
57515
- * @version 196.0.0
58038
+ * @version 197.0.0
57516
58039
  */
57517
58040
 
57518
58041
  /**
@@ -57614,7 +58137,7 @@ class SuggestApi {
57614
58137
  /**
57615
58138
  * Suggest service.
57616
58139
  * @module purecloud-platform-client-v2/api/SuggestApi
57617
- * @version 196.0.0
58140
+ * @version 197.0.0
57618
58141
  */
57619
58142
 
57620
58143
  /**
@@ -57753,7 +58276,7 @@ class TaskManagementApi {
57753
58276
  /**
57754
58277
  * TaskManagement service.
57755
58278
  * @module purecloud-platform-client-v2/api/TaskManagementApi
57756
- * @version 196.0.0
58279
+ * @version 197.0.0
57757
58280
  */
57758
58281
 
57759
58282
  /**
@@ -59101,7 +59624,7 @@ class TeamsApi {
59101
59624
  /**
59102
59625
  * Teams service.
59103
59626
  * @module purecloud-platform-client-v2/api/TeamsApi
59104
- * @version 196.0.0
59627
+ * @version 197.0.0
59105
59628
  */
59106
59629
 
59107
59630
  /**
@@ -59402,7 +59925,7 @@ class TelephonyApi {
59402
59925
  /**
59403
59926
  * Telephony service.
59404
59927
  * @module purecloud-platform-client-v2/api/TelephonyApi
59405
- * @version 196.0.0
59928
+ * @version 197.0.0
59406
59929
  */
59407
59930
 
59408
59931
  /**
@@ -59584,7 +60107,7 @@ class TelephonyProvidersEdgeApi {
59584
60107
  /**
59585
60108
  * TelephonyProvidersEdge service.
59586
60109
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
59587
- * @version 196.0.0
60110
+ * @version 197.0.0
59588
60111
  */
59589
60112
 
59590
60113
  /**
@@ -62912,7 +63435,7 @@ class TextbotsApi {
62912
63435
  /**
62913
63436
  * Textbots service.
62914
63437
  * @module purecloud-platform-client-v2/api/TextbotsApi
62915
- * @version 196.0.0
63438
+ * @version 197.0.0
62916
63439
  */
62917
63440
 
62918
63441
  /**
@@ -63040,7 +63563,7 @@ class TokensApi {
63040
63563
  /**
63041
63564
  * Tokens service.
63042
63565
  * @module purecloud-platform-client-v2/api/TokensApi
63043
- * @version 196.0.0
63566
+ * @version 197.0.0
63044
63567
  */
63045
63568
 
63046
63569
  /**
@@ -63194,7 +63717,7 @@ class UploadsApi {
63194
63717
  /**
63195
63718
  * Uploads service.
63196
63719
  * @module purecloud-platform-client-v2/api/UploadsApi
63197
- * @version 196.0.0
63720
+ * @version 197.0.0
63198
63721
  */
63199
63722
 
63200
63723
  /**
@@ -63463,7 +63986,7 @@ class UsageApi {
63463
63986
  /**
63464
63987
  * Usage service.
63465
63988
  * @module purecloud-platform-client-v2/api/UsageApi
63466
- * @version 196.0.0
63989
+ * @version 197.0.0
63467
63990
  */
63468
63991
 
63469
63992
  /**
@@ -63678,7 +64201,7 @@ class UserRecordingsApi {
63678
64201
  /**
63679
64202
  * UserRecordings service.
63680
64203
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
63681
- * @version 196.0.0
64204
+ * @version 197.0.0
63682
64205
  */
63683
64206
 
63684
64207
  /**
@@ -63863,7 +64386,7 @@ class UsersApi {
63863
64386
  /**
63864
64387
  * Users service.
63865
64388
  * @module purecloud-platform-client-v2/api/UsersApi
63866
- * @version 196.0.0
64389
+ * @version 197.0.0
63867
64390
  */
63868
64391
 
63869
64392
  /**
@@ -66521,7 +67044,7 @@ class UtilitiesApi {
66521
67044
  /**
66522
67045
  * Utilities service.
66523
67046
  * @module purecloud-platform-client-v2/api/UtilitiesApi
66524
- * @version 196.0.0
67047
+ * @version 197.0.0
66525
67048
  */
66526
67049
 
66527
67050
  /**
@@ -66632,7 +67155,7 @@ class VoicemailApi {
66632
67155
  /**
66633
67156
  * Voicemail service.
66634
67157
  * @module purecloud-platform-client-v2/api/VoicemailApi
66635
- * @version 196.0.0
67158
+ * @version 197.0.0
66636
67159
  */
66637
67160
 
66638
67161
  /**
@@ -67299,7 +67822,7 @@ class WebChatApi {
67299
67822
  /**
67300
67823
  * WebChat service.
67301
67824
  * @module purecloud-platform-client-v2/api/WebChatApi
67302
- * @version 196.0.0
67825
+ * @version 197.0.0
67303
67826
  */
67304
67827
 
67305
67828
  /**
@@ -67850,7 +68373,7 @@ class WebDeploymentsApi {
67850
68373
  /**
67851
68374
  * WebDeployments service.
67852
68375
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
67853
- * @version 196.0.0
68376
+ * @version 197.0.0
67854
68377
  */
67855
68378
 
67856
68379
  /**
@@ -68377,7 +68900,7 @@ class WebMessagingApi {
68377
68900
  /**
68378
68901
  * WebMessaging service.
68379
68902
  * @module purecloud-platform-client-v2/api/WebMessagingApi
68380
- * @version 196.0.0
68903
+ * @version 197.0.0
68381
68904
  */
68382
68905
 
68383
68906
  /**
@@ -68423,7 +68946,7 @@ class WidgetsApi {
68423
68946
  /**
68424
68947
  * Widgets service.
68425
68948
  * @module purecloud-platform-client-v2/api/WidgetsApi
68426
- * @version 196.0.0
68949
+ * @version 197.0.0
68427
68950
  */
68428
68951
 
68429
68952
  /**
@@ -68569,7 +69092,7 @@ class WorkforceManagementApi {
68569
69092
  /**
68570
69093
  * WorkforceManagement service.
68571
69094
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
68572
- * @version 196.0.0
69095
+ * @version 197.0.0
68573
69096
  */
68574
69097
 
68575
69098
  /**
@@ -74482,7 +75005,7 @@ class WorkforceManagementApi {
74482
75005
  * </pre>
74483
75006
  * </p>
74484
75007
  * @module purecloud-platform-client-v2/index
74485
- * @version 196.0.0
75008
+ * @version 197.0.0
74486
75009
  */
74487
75010
  class platformClient {
74488
75011
  constructor() {
@@ -74496,6 +75019,11 @@ class platformClient {
74496
75019
  * @property {module:purecloud-platform-client-v2/ApiClient}
74497
75020
  */
74498
75021
  this.ApiClientClass = ApiClient;
75022
+ /**
75023
+ * The AgentUIApi service constructor.
75024
+ * @property {module:purecloud-platform-client-v2/api/AgentUIApi}
75025
+ */
75026
+ this.AgentUIApi = AgentUIApi;
74499
75027
  /**
74500
75028
  * The AlertingApi service constructor.
74501
75029
  * @property {module:purecloud-platform-client-v2/api/AlertingApi}
@@ -74566,6 +75094,11 @@ class platformClient {
74566
75094
  * @property {module:purecloud-platform-client-v2/api/EmailsApi}
74567
75095
  */
74568
75096
  this.EmailsApi = EmailsApi;
75097
+ /**
75098
+ * The EmployeeEngagementApi service constructor.
75099
+ * @property {module:purecloud-platform-client-v2/api/EmployeeEngagementApi}
75100
+ */
75101
+ this.EmployeeEngagementApi = EmployeeEngagementApi;
74569
75102
  /**
74570
75103
  * The EventsApi service constructor.
74571
75104
  * @property {module:purecloud-platform-client-v2/api/EventsApi}