purecloud-platform-client-v2 217.0.0 → 218.1.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 (91) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1069 -209
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1069 -209
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +342 -169
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +342 -169
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +822 -79
  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/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -4
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +61 -1
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -4
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +249 -1
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmailsApi.js +65 -1
  29. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +77 -1
  32. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +31 -1
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -6
  44. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -70
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -11
  60. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -2
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +4 -3
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +65 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +403 -20
  71. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebChatApi.js +19 -10
  87. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -690,7 +690,7 @@ class Configuration {
690
690
 
691
691
  /**
692
692
  * @module purecloud-platform-client-v2/ApiClient
693
- * @version 217.0.0
693
+ * @version 218.1.0
694
694
  */
695
695
  class ApiClient {
696
696
  /**
@@ -2234,7 +2234,7 @@ class AgentAssistantsApi {
2234
2234
  /**
2235
2235
  * AgentAssistants service.
2236
2236
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
2237
- * @version 217.0.0
2237
+ * @version 218.1.0
2238
2238
  */
2239
2239
 
2240
2240
  /**
@@ -2610,7 +2610,7 @@ class AgentCopilotApi {
2610
2610
  /**
2611
2611
  * AgentCopilot service.
2612
2612
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
2613
- * @version 217.0.0
2613
+ * @version 218.1.0
2614
2614
  */
2615
2615
 
2616
2616
  /**
@@ -2686,7 +2686,7 @@ class AgentUIApi {
2686
2686
  /**
2687
2687
  * AgentUI service.
2688
2688
  * @module purecloud-platform-client-v2/api/AgentUIApi
2689
- * @version 217.0.0
2689
+ * @version 218.1.0
2690
2690
  */
2691
2691
 
2692
2692
  /**
@@ -2817,7 +2817,7 @@ class AlertingApi {
2817
2817
  /**
2818
2818
  * Alerting service.
2819
2819
  * @module purecloud-platform-client-v2/api/AlertingApi
2820
- * @version 217.0.0
2820
+ * @version 218.1.0
2821
2821
  */
2822
2822
 
2823
2823
  /**
@@ -3218,7 +3218,7 @@ class AnalyticsApi {
3218
3218
  /**
3219
3219
  * Analytics service.
3220
3220
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3221
- * @version 217.0.0
3221
+ * @version 218.1.0
3222
3222
  */
3223
3223
 
3224
3224
  /**
@@ -3343,7 +3343,6 @@ class AnalyticsApi {
3343
3343
  * Get an agent and their active sessions by user ID
3344
3344
  *
3345
3345
  * @param {String} userId userId
3346
- * getAnalyticsAgentStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3347
3346
  */
3348
3347
  getAnalyticsAgentStatus(userId) {
3349
3348
  // verify the required parameter 'userId' is set
@@ -4795,7 +4794,6 @@ class AnalyticsApi {
4795
4794
  * Count agents by segment type
4796
4795
  *
4797
4796
  * @param {Object} body query
4798
- * postAnalyticsAgentsStatusCounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4799
4797
  */
4800
4798
  postAnalyticsAgentsStatusCounts(body) {
4801
4799
  // verify the required parameter 'body' is set
@@ -4821,7 +4819,6 @@ class AnalyticsApi {
4821
4819
  * Retrieve the top 50 agents matching the query filters
4822
4820
  *
4823
4821
  * @param {Object} body query
4824
- * postAnalyticsAgentsStatusQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4825
4822
  */
4826
4823
  postAnalyticsAgentsStatusQuery(body) {
4827
4824
  // verify the required parameter 'body' is set
@@ -6042,7 +6039,7 @@ class ArchitectApi {
6042
6039
  /**
6043
6040
  * Architect service.
6044
6041
  * @module purecloud-platform-client-v2/api/ArchitectApi
6045
- * @version 217.0.0
6042
+ * @version 218.1.0
6046
6043
  */
6047
6044
 
6048
6045
  /**
@@ -9080,6 +9077,36 @@ class ArchitectApi {
9080
9077
  );
9081
9078
  }
9082
9079
 
9080
+ /**
9081
+ * Creates a presigned URL for uploading a user prompt file
9082
+ *
9083
+ * @param {String} promptId Prompt ID
9084
+ * @param {String} languageCode Language
9085
+ */
9086
+ postArchitectPromptResourceUploads(promptId, languageCode) {
9087
+ // verify the required parameter 'promptId' is set
9088
+ if (promptId === undefined || promptId === null) {
9089
+ throw 'Missing the required parameter "promptId" when calling postArchitectPromptResourceUploads';
9090
+ }
9091
+ // verify the required parameter 'languageCode' is set
9092
+ if (languageCode === undefined || languageCode === null) {
9093
+ throw 'Missing the required parameter "languageCode" when calling postArchitectPromptResourceUploads';
9094
+ }
9095
+
9096
+ return this.apiClient.callApi(
9097
+ '/api/v2/architect/prompts/{promptId}/resources/{languageCode}/uploads',
9098
+ 'POST',
9099
+ { 'promptId': promptId,'languageCode': languageCode },
9100
+ { },
9101
+ { },
9102
+ { },
9103
+ null,
9104
+ ['PureCloud OAuth'],
9105
+ ['application/json'],
9106
+ ['application/json']
9107
+ );
9108
+ }
9109
+
9083
9110
  /**
9084
9111
  * Create a new user prompt resource
9085
9112
  *
@@ -9210,6 +9237,36 @@ class ArchitectApi {
9210
9237
  );
9211
9238
  }
9212
9239
 
9240
+ /**
9241
+ * Creates a presigned URL for uploading a system prompt file
9242
+ *
9243
+ * @param {String} promptId Prompt ID
9244
+ * @param {String} languageCode Language
9245
+ */
9246
+ postArchitectSystempromptResourceUploads(promptId, languageCode) {
9247
+ // verify the required parameter 'promptId' is set
9248
+ if (promptId === undefined || promptId === null) {
9249
+ throw 'Missing the required parameter "promptId" when calling postArchitectSystempromptResourceUploads';
9250
+ }
9251
+ // verify the required parameter 'languageCode' is set
9252
+ if (languageCode === undefined || languageCode === null) {
9253
+ throw 'Missing the required parameter "languageCode" when calling postArchitectSystempromptResourceUploads';
9254
+ }
9255
+
9256
+ return this.apiClient.callApi(
9257
+ '/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}/uploads',
9258
+ 'POST',
9259
+ { 'promptId': promptId,'languageCode': languageCode },
9260
+ { },
9261
+ { },
9262
+ { },
9263
+ null,
9264
+ ['PureCloud OAuth'],
9265
+ ['application/json'],
9266
+ ['application/json']
9267
+ );
9268
+ }
9269
+
9213
9270
  /**
9214
9271
  * Create system prompt resource override.
9215
9272
  *
@@ -10275,7 +10332,7 @@ class AuditApi {
10275
10332
  /**
10276
10333
  * Audit service.
10277
10334
  * @module purecloud-platform-client-v2/api/AuditApi
10278
- * @version 217.0.0
10335
+ * @version 218.1.0
10279
10336
  */
10280
10337
 
10281
10338
  /**
@@ -10476,7 +10533,7 @@ class AuthorizationApi {
10476
10533
  /**
10477
10534
  * Authorization service.
10478
10535
  * @module purecloud-platform-client-v2/api/AuthorizationApi
10479
- * @version 217.0.0
10536
+ * @version 218.1.0
10480
10537
  */
10481
10538
 
10482
10539
  /**
@@ -12138,7 +12195,7 @@ class BillingApi {
12138
12195
  /**
12139
12196
  * Billing service.
12140
12197
  * @module purecloud-platform-client-v2/api/BillingApi
12141
- * @version 217.0.0
12198
+ * @version 218.1.0
12142
12199
  */
12143
12200
 
12144
12201
  /**
@@ -12218,7 +12275,7 @@ class CarrierServicesApi {
12218
12275
  /**
12219
12276
  * CarrierServices service.
12220
12277
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
12221
- * @version 217.0.0
12278
+ * @version 218.1.0
12222
12279
  */
12223
12280
 
12224
12281
  /**
@@ -12288,7 +12345,7 @@ class ChatApi {
12288
12345
  /**
12289
12346
  * Chat service.
12290
12347
  * @module purecloud-platform-client-v2/api/ChatApi
12291
- * @version 217.0.0
12348
+ * @version 218.1.0
12292
12349
  */
12293
12350
 
12294
12351
  /**
@@ -12428,7 +12485,6 @@ class ChatApi {
12428
12485
  *
12429
12486
  * @param {String} userId userId
12430
12487
  * @param {String} pinnedMessageId pinnedMessageId
12431
- * deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12432
12488
  */
12433
12489
  deleteChatsUserMessagesPin(userId, pinnedMessageId) {
12434
12490
  // verify the required parameter 'userId' is set
@@ -12675,7 +12731,6 @@ class ChatApi {
12675
12731
  * Get information for a 1on1
12676
12732
  *
12677
12733
  * @param {String} userId userId
12678
- * getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12679
12734
  */
12680
12735
  getChatsUser(userId) {
12681
12736
  // verify the required parameter 'userId' is set
@@ -13133,7 +13188,6 @@ class ChatApi {
13133
13188
  *
13134
13189
  * @param {String} userId userId
13135
13190
  * @param {Object} body Pinned Message Ids
13136
- * postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13137
13191
  */
13138
13192
  postChatsUserMessagesPins(userId, body) {
13139
13193
  // verify the required parameter 'userId' is set
@@ -13220,7 +13274,7 @@ class CoachingApi {
13220
13274
  /**
13221
13275
  * Coaching service.
13222
13276
  * @module purecloud-platform-client-v2/api/CoachingApi
13223
- * @version 217.0.0
13277
+ * @version 218.1.0
13224
13278
  */
13225
13279
 
13226
13280
  /**
@@ -13797,7 +13851,7 @@ class ContentManagementApi {
13797
13851
  /**
13798
13852
  * ContentManagement service.
13799
13853
  * @module purecloud-platform-client-v2/api/ContentManagementApi
13800
- * @version 217.0.0
13854
+ * @version 218.1.0
13801
13855
  */
13802
13856
 
13803
13857
  /**
@@ -14878,7 +14932,7 @@ class ConversationsApi {
14878
14932
  /**
14879
14933
  * Conversations service.
14880
14934
  * @module purecloud-platform-client-v2/api/ConversationsApi
14881
- * @version 217.0.0
14935
+ * @version 218.1.0
14882
14936
  */
14883
14937
 
14884
14938
  /**
@@ -15143,6 +15197,31 @@ class ConversationsApi {
15143
15197
  );
15144
15198
  }
15145
15199
 
15200
+ /**
15201
+ * Delete Twitter messaging integration
15202
+ *
15203
+ * @param {String} integrationId Integration ID
15204
+ */
15205
+ deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
15206
+ // verify the required parameter 'integrationId' is set
15207
+ if (integrationId === undefined || integrationId === null) {
15208
+ throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
15209
+ }
15210
+
15211
+ return this.apiClient.callApi(
15212
+ '/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
15213
+ 'DELETE',
15214
+ { 'integrationId': integrationId },
15215
+ { },
15216
+ { },
15217
+ { },
15218
+ null,
15219
+ ['PureCloud OAuth'],
15220
+ ['application/json'],
15221
+ ['application/json']
15222
+ );
15223
+ }
15224
+
15146
15225
  /**
15147
15226
  * Delete a WhatsApp messaging integration
15148
15227
  *
@@ -17133,6 +17212,31 @@ class ConversationsApi {
17133
17212
  );
17134
17213
  }
17135
17214
 
17215
+ /**
17216
+ * Get twitter oauth settings to patch an integration
17217
+ *
17218
+ * @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
17219
+ */
17220
+ getConversationsMessagingIntegrationTwitterOauthSettings(integrationId) {
17221
+ // verify the required parameter 'integrationId' is set
17222
+ if (integrationId === undefined || integrationId === null) {
17223
+ throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationTwitterOauthSettings';
17224
+ }
17225
+
17226
+ return this.apiClient.callApi(
17227
+ '/api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings',
17228
+ 'GET',
17229
+ { 'integrationId': integrationId },
17230
+ { },
17231
+ { },
17232
+ { },
17233
+ null,
17234
+ ['PureCloud OAuth'],
17235
+ ['application/json'],
17236
+ ['application/json']
17237
+ );
17238
+ }
17239
+
17136
17240
  /**
17137
17241
  * Get a list of Integrations
17138
17242
  *
@@ -17332,6 +17436,83 @@ class ConversationsApi {
17332
17436
  );
17333
17437
  }
17334
17438
 
17439
+ /**
17440
+ * Get a list of Twitter Integrations
17441
+ *
17442
+ * @param {Object} opts Optional parameters
17443
+ * @param {Number} opts.pageSize Page size (default to 25)
17444
+ * @param {Number} opts.pageNumber Page number (default to 1)
17445
+ * @param {Object} opts.expand Expand instructions for the return value.
17446
+ * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
17447
+ * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
17448
+ */
17449
+ getConversationsMessagingIntegrationsTwitter(opts) {
17450
+ opts = opts || {};
17451
+
17452
+
17453
+ return this.apiClient.callApi(
17454
+ '/api/v2/conversations/messaging/integrations/twitter',
17455
+ 'GET',
17456
+ { },
17457
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
17458
+ { },
17459
+ { },
17460
+ null,
17461
+ ['PureCloud OAuth'],
17462
+ ['application/json'],
17463
+ ['application/json']
17464
+ );
17465
+ }
17466
+
17467
+ /**
17468
+ * Get Twitter messaging integration
17469
+ *
17470
+ * @param {String} integrationId Integration ID
17471
+ * @param {Object} opts Optional parameters
17472
+ * @param {Object} opts.expand Expand instructions for the return value.
17473
+ */
17474
+ getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
17475
+ opts = opts || {};
17476
+
17477
+ // verify the required parameter 'integrationId' is set
17478
+ if (integrationId === undefined || integrationId === null) {
17479
+ throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
17480
+ }
17481
+
17482
+ return this.apiClient.callApi(
17483
+ '/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
17484
+ 'GET',
17485
+ { 'integrationId': integrationId },
17486
+ { 'expand': opts['expand'] },
17487
+ { },
17488
+ { },
17489
+ null,
17490
+ ['PureCloud OAuth'],
17491
+ ['application/json'],
17492
+ ['application/json']
17493
+ );
17494
+ }
17495
+
17496
+ /**
17497
+ * Get twitter oauth settings
17498
+ *
17499
+ */
17500
+ getConversationsMessagingIntegrationsTwitterOauthSettings() {
17501
+
17502
+ return this.apiClient.callApi(
17503
+ '/api/v2/conversations/messaging/integrations/twitter/oauth/settings',
17504
+ 'GET',
17505
+ { },
17506
+ { },
17507
+ { },
17508
+ { },
17509
+ null,
17510
+ ['PureCloud OAuth'],
17511
+ ['application/json'],
17512
+ ['application/json']
17513
+ );
17514
+ }
17515
+
17335
17516
  /**
17336
17517
  * Get a list of WhatsApp Integrations
17337
17518
  *
@@ -17839,6 +18020,41 @@ class ConversationsApi {
17839
18020
  );
17840
18021
  }
17841
18022
 
18023
+ /**
18024
+ * Update the feedback for the summary.
18025
+ *
18026
+ * @param {String} conversationId Conversation ID
18027
+ * @param {String} summaryId Summary ID
18028
+ * @param {Object} opts Optional parameters
18029
+ * @param {Object} opts.body
18030
+ * patchConversationSummaryFeedback is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18031
+ */
18032
+ patchConversationSummaryFeedback(conversationId, summaryId, opts) {
18033
+ opts = opts || {};
18034
+
18035
+ // verify the required parameter 'conversationId' is set
18036
+ if (conversationId === undefined || conversationId === null) {
18037
+ throw 'Missing the required parameter "conversationId" when calling patchConversationSummaryFeedback';
18038
+ }
18039
+ // verify the required parameter 'summaryId' is set
18040
+ if (summaryId === undefined || summaryId === null) {
18041
+ throw 'Missing the required parameter "summaryId" when calling patchConversationSummaryFeedback';
18042
+ }
18043
+
18044
+ return this.apiClient.callApi(
18045
+ '/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback',
18046
+ 'PATCH',
18047
+ { 'conversationId': conversationId,'summaryId': summaryId },
18048
+ { },
18049
+ { },
18050
+ { },
18051
+ opts['body'],
18052
+ ['PureCloud OAuth'],
18053
+ ['application/json'],
18054
+ ['application/json']
18055
+ );
18056
+ }
18057
+
17842
18058
  /**
17843
18059
  * Update the utilization label on a conversation. When there is no value provided, the system default label is applied
17844
18060
  *
@@ -18969,6 +19185,36 @@ class ConversationsApi {
18969
19185
  );
18970
19186
  }
18971
19187
 
19188
+ /**
19189
+ * Update a Twitter messaging integration
19190
+ *
19191
+ * @param {String} integrationId Integration ID
19192
+ * @param {Object} body TwitterIntegrationUpdateRequest
19193
+ */
19194
+ patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
19195
+ // verify the required parameter 'integrationId' is set
19196
+ if (integrationId === undefined || integrationId === null) {
19197
+ throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
19198
+ }
19199
+ // verify the required parameter 'body' is set
19200
+ if (body === undefined || body === null) {
19201
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
19202
+ }
19203
+
19204
+ return this.apiClient.callApi(
19205
+ '/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
19206
+ 'PATCH',
19207
+ { 'integrationId': integrationId },
19208
+ { },
19209
+ { },
19210
+ { },
19211
+ body,
19212
+ ['PureCloud OAuth'],
19213
+ ['application/json'],
19214
+ ['application/json']
19215
+ );
19216
+ }
19217
+
18972
19218
  /**
18973
19219
  * Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
18974
19220
  * Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
@@ -21305,6 +21551,31 @@ class ConversationsApi {
21305
21551
  );
21306
21552
  }
21307
21553
 
21554
+ /**
21555
+ * Create Twitter Integration
21556
+ *
21557
+ * @param {Object} body TwitterIntegrationRequest
21558
+ */
21559
+ postConversationsMessagingIntegrationsTwitter(body) {
21560
+ // verify the required parameter 'body' is set
21561
+ if (body === undefined || body === null) {
21562
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
21563
+ }
21564
+
21565
+ return this.apiClient.callApi(
21566
+ '/api/v2/conversations/messaging/integrations/twitter',
21567
+ 'POST',
21568
+ { },
21569
+ { },
21570
+ { },
21571
+ { },
21572
+ body,
21573
+ ['PureCloud OAuth'],
21574
+ ['application/json'],
21575
+ ['application/json']
21576
+ );
21577
+ }
21578
+
21308
21579
  /**
21309
21580
  * [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
21310
21581
  * [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
@@ -21510,6 +21781,37 @@ class ConversationsApi {
21510
21781
  );
21511
21782
  }
21512
21783
 
21784
+ /**
21785
+ * Create an Agent-Type video conference and assign an agent to it
21786
+ *
21787
+ * @param {String} conversationId conversationId
21788
+ * @param {String} communicationId communicationId
21789
+ * postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
21790
+ */
21791
+ postConversationsVideoAgentconferenceCommunication(conversationId, communicationId) {
21792
+ // verify the required parameter 'conversationId' is set
21793
+ if (conversationId === undefined || conversationId === null) {
21794
+ throw 'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';
21795
+ }
21796
+ // verify the required parameter 'communicationId' is set
21797
+ if (communicationId === undefined || communicationId === null) {
21798
+ throw 'Missing the required parameter "communicationId" when calling postConversationsVideoAgentconferenceCommunication';
21799
+ }
21800
+
21801
+ return this.apiClient.callApi(
21802
+ '/api/v2/conversations/videos/{conversationId}/agentconference/communications/{communicationId}',
21803
+ 'POST',
21804
+ { 'conversationId': conversationId,'communicationId': communicationId },
21805
+ { },
21806
+ { },
21807
+ { },
21808
+ null,
21809
+ ['PureCloud OAuth'],
21810
+ ['application/json'],
21811
+ ['application/json']
21812
+ );
21813
+ }
21814
+
21513
21815
  /**
21514
21816
  * Apply wrap-up for this conversation communication
21515
21817
  *
@@ -22212,7 +22514,7 @@ class DataExtensionsApi {
22212
22514
  /**
22213
22515
  * DataExtensions service.
22214
22516
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
22215
- * @version 217.0.0
22517
+ * @version 218.1.0
22216
22518
  */
22217
22519
 
22218
22520
  /**
@@ -22298,7 +22600,7 @@ class DataPrivacyApi {
22298
22600
  /**
22299
22601
  * DataPrivacy service.
22300
22602
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
22301
- * @version 217.0.0
22603
+ * @version 218.1.0
22302
22604
  */
22303
22605
 
22304
22606
  /**
@@ -22468,7 +22770,7 @@ class DownloadsApi {
22468
22770
  /**
22469
22771
  * Downloads service.
22470
22772
  * @module purecloud-platform-client-v2/api/DownloadsApi
22471
- * @version 217.0.0
22773
+ * @version 218.1.0
22472
22774
  */
22473
22775
 
22474
22776
  /**
@@ -22520,7 +22822,7 @@ class EmailsApi {
22520
22822
  /**
22521
22823
  * Emails service.
22522
22824
  * @module purecloud-platform-client-v2/api/EmailsApi
22523
- * @version 217.0.0
22825
+ * @version 218.1.0
22524
22826
  */
22525
22827
 
22526
22828
  /**
@@ -22535,6 +22837,26 @@ class EmailsApi {
22535
22837
  }
22536
22838
 
22537
22839
 
22840
+ /**
22841
+ * Reset email threading settings to default
22842
+ *
22843
+ */
22844
+ deleteEmailsSettingsThreading() {
22845
+
22846
+ return this.apiClient.callApi(
22847
+ '/api/v2/emails/settings/threading',
22848
+ 'DELETE',
22849
+ { },
22850
+ { },
22851
+ { },
22852
+ { },
22853
+ null,
22854
+ ['PureCloud OAuth'],
22855
+ ['application/json'],
22856
+ ['application/json']
22857
+ );
22858
+ }
22859
+
22538
22860
  /**
22539
22861
  * Get email Contact Center settings
22540
22862
  *
@@ -22555,6 +22877,26 @@ class EmailsApi {
22555
22877
  );
22556
22878
  }
22557
22879
 
22880
+ /**
22881
+ * Get email threading settings
22882
+ *
22883
+ */
22884
+ getEmailsSettingsThreading() {
22885
+
22886
+ return this.apiClient.callApi(
22887
+ '/api/v2/emails/settings/threading',
22888
+ 'GET',
22889
+ { },
22890
+ { },
22891
+ { },
22892
+ { },
22893
+ null,
22894
+ ['PureCloud OAuth'],
22895
+ ['application/json'],
22896
+ ['application/json']
22897
+ );
22898
+ }
22899
+
22558
22900
  /**
22559
22901
  * Patch email Contact Center settings
22560
22902
  *
@@ -22579,13 +22921,37 @@ class EmailsApi {
22579
22921
  );
22580
22922
  }
22581
22923
 
22924
+ /**
22925
+ * Patch email threading settings
22926
+ *
22927
+ * @param {Object} opts Optional parameters
22928
+ * @param {Object} opts.body
22929
+ */
22930
+ patchEmailsSettingsThreading(opts) {
22931
+ opts = opts || {};
22932
+
22933
+
22934
+ return this.apiClient.callApi(
22935
+ '/api/v2/emails/settings/threading',
22936
+ 'PATCH',
22937
+ { },
22938
+ { },
22939
+ { },
22940
+ { },
22941
+ opts['body'],
22942
+ ['PureCloud OAuth'],
22943
+ ['application/json'],
22944
+ ['application/json']
22945
+ );
22946
+ }
22947
+
22582
22948
  }
22583
22949
 
22584
22950
  class EmployeeEngagementApi {
22585
22951
  /**
22586
22952
  * EmployeeEngagement service.
22587
22953
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
22588
- * @version 217.0.0
22954
+ * @version 218.1.0
22589
22955
  */
22590
22956
 
22591
22957
  /**
@@ -22736,7 +23102,7 @@ class EventsApi {
22736
23102
  /**
22737
23103
  * Events service.
22738
23104
  * @module purecloud-platform-client-v2/api/EventsApi
22739
- * @version 217.0.0
23105
+ * @version 218.1.0
22740
23106
  */
22741
23107
 
22742
23108
  /**
@@ -22832,7 +23198,7 @@ class ExternalContactsApi {
22832
23198
  /**
22833
23199
  * ExternalContacts service.
22834
23200
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
22835
- * @version 217.0.0
23201
+ * @version 218.1.0
22836
23202
  */
22837
23203
 
22838
23204
  /**
@@ -23316,6 +23682,57 @@ class ExternalContactsApi {
23316
23682
  );
23317
23683
  }
23318
23684
 
23685
+ /**
23686
+ * Get export for exportId
23687
+ *
23688
+ * @param {String} exportId Export id
23689
+ */
23690
+ getExternalcontactsContactsExport(exportId) {
23691
+ // verify the required parameter 'exportId' is set
23692
+ if (exportId === undefined || exportId === null) {
23693
+ throw 'Missing the required parameter "exportId" when calling getExternalcontactsContactsExport';
23694
+ }
23695
+
23696
+ return this.apiClient.callApi(
23697
+ '/api/v2/externalcontacts/contacts/exports/{exportId}',
23698
+ 'GET',
23699
+ { 'exportId': exportId },
23700
+ { },
23701
+ { },
23702
+ { },
23703
+ null,
23704
+ ['PureCloud OAuth'],
23705
+ ['application/json'],
23706
+ ['application/json']
23707
+ );
23708
+ }
23709
+
23710
+ /**
23711
+ * List exports for organization
23712
+ *
23713
+ * @param {Object} opts Optional parameters
23714
+ * @param {Array.<String>} opts.divisionIds Division IDs of entities
23715
+ * @param {String} opts.after The cursor that points to the end of the set of entities
23716
+ * @param {Number} opts.pageSize Number of entities to return
23717
+ */
23718
+ getExternalcontactsContactsExports(opts) {
23719
+ opts = opts || {};
23720
+
23721
+
23722
+ return this.apiClient.callApi(
23723
+ '/api/v2/externalcontacts/contacts/exports',
23724
+ 'GET',
23725
+ { },
23726
+ { 'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'] },
23727
+ { },
23728
+ { },
23729
+ null,
23730
+ ['PureCloud OAuth'],
23731
+ ['application/json'],
23732
+ ['application/json']
23733
+ );
23734
+ }
23735
+
23319
23736
  /**
23320
23737
  * Get a schema
23321
23738
  *
@@ -24824,6 +25241,31 @@ class ExternalContactsApi {
24824
25241
  );
24825
25242
  }
24826
25243
 
25244
+ /**
25245
+ * Create bulk export
25246
+ *
25247
+ * @param {Object} body Export
25248
+ */
25249
+ postExternalcontactsContactsExports(body) {
25250
+ // verify the required parameter 'body' is set
25251
+ if (body === undefined || body === null) {
25252
+ throw 'Missing the required parameter "body" when calling postExternalcontactsContactsExports';
25253
+ }
25254
+
25255
+ return this.apiClient.callApi(
25256
+ '/api/v2/externalcontacts/contacts/exports',
25257
+ 'POST',
25258
+ { },
25259
+ { },
25260
+ { },
25261
+ { },
25262
+ body,
25263
+ ['PureCloud OAuth'],
25264
+ ['application/json'],
25265
+ ['application/json']
25266
+ );
25267
+ }
25268
+
24827
25269
  /**
24828
25270
  * Create a schema
24829
25271
  *
@@ -25565,7 +26007,7 @@ class FaxApi {
25565
26007
  /**
25566
26008
  * Fax service.
25567
26009
  * @module purecloud-platform-client-v2/api/FaxApi
25568
- * @version 217.0.0
26010
+ * @version 218.1.0
25569
26011
  */
25570
26012
 
25571
26013
  /**
@@ -25780,7 +26222,7 @@ class FlowsApi {
25780
26222
  /**
25781
26223
  * Flows service.
25782
26224
  * @module purecloud-platform-client-v2/api/FlowsApi
25783
- * @version 217.0.0
26225
+ * @version 218.1.0
25784
26226
  */
25785
26227
 
25786
26228
  /**
@@ -25963,7 +26405,7 @@ class GamificationApi {
25963
26405
  /**
25964
26406
  * Gamification service.
25965
26407
  * @module purecloud-platform-client-v2/api/GamificationApi
25966
- * @version 217.0.0
26408
+ * @version 218.1.0
25967
26409
  */
25968
26410
 
25969
26411
  /**
@@ -28105,7 +28547,7 @@ class GeneralDataProtectionRegulationApi {
28105
28547
  /**
28106
28548
  * GeneralDataProtectionRegulation service.
28107
28549
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
28108
- * @version 217.0.0
28550
+ * @version 218.1.0
28109
28551
  */
28110
28552
 
28111
28553
  /**
@@ -28235,7 +28677,7 @@ class GeolocationApi {
28235
28677
  /**
28236
28678
  * Geolocation service.
28237
28679
  * @module purecloud-platform-client-v2/api/GeolocationApi
28238
- * @version 217.0.0
28680
+ * @version 218.1.0
28239
28681
  */
28240
28682
 
28241
28683
  /**
@@ -28366,7 +28808,7 @@ class GreetingsApi {
28366
28808
  /**
28367
28809
  * Greetings service.
28368
28810
  * @module purecloud-platform-client-v2/api/GreetingsApi
28369
- * @version 217.0.0
28811
+ * @version 218.1.0
28370
28812
  */
28371
28813
 
28372
28814
  /**
@@ -28821,7 +29263,7 @@ class GroupsApi {
28821
29263
  /**
28822
29264
  * Groups service.
28823
29265
  * @module purecloud-platform-client-v2/api/GroupsApi
28824
- * @version 217.0.0
29266
+ * @version 218.1.0
28825
29267
  */
28826
29268
 
28827
29269
  /**
@@ -29340,7 +29782,7 @@ class IdentityProviderApi {
29340
29782
  /**
29341
29783
  * IdentityProvider service.
29342
29784
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
29343
- * @version 217.0.0
29785
+ * @version 218.1.0
29344
29786
  */
29345
29787
 
29346
29788
  /**
@@ -30201,7 +30643,7 @@ class InfrastructureAsCodeApi {
30201
30643
  /**
30202
30644
  * InfrastructureAsCode service.
30203
30645
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
30204
- * @version 217.0.0
30646
+ * @version 218.1.0
30205
30647
  */
30206
30648
 
30207
30649
  /**
@@ -30368,7 +30810,7 @@ class IntegrationsApi {
30368
30810
  /**
30369
30811
  * Integrations service.
30370
30812
  * @module purecloud-platform-client-v2/api/IntegrationsApi
30371
- * @version 217.0.0
30813
+ * @version 218.1.0
30372
30814
  */
30373
30815
 
30374
30816
  /**
@@ -32598,6 +33040,36 @@ class IntegrationsApi {
32598
33040
  );
32599
33041
  }
32600
33042
 
33043
+ /**
33044
+ * Invoke Webhook
33045
+ *
33046
+ * @param {String} tokenId The token of the webhook to be invoked
33047
+ * @param {Object.<String, {String: Object}>} body Webhook Invocation Payload
33048
+ */
33049
+ postIntegrationsWebhookEvents(tokenId, body) {
33050
+ // verify the required parameter 'tokenId' is set
33051
+ if (tokenId === undefined || tokenId === null) {
33052
+ throw 'Missing the required parameter "tokenId" when calling postIntegrationsWebhookEvents';
33053
+ }
33054
+ // verify the required parameter 'body' is set
33055
+ if (body === undefined || body === null) {
33056
+ throw 'Missing the required parameter "body" when calling postIntegrationsWebhookEvents';
33057
+ }
33058
+
33059
+ return this.apiClient.callApi(
33060
+ '/api/v2/integrations/webhooks/{tokenId}/events',
33061
+ 'POST',
33062
+ { 'tokenId': tokenId },
33063
+ { },
33064
+ { },
33065
+ { },
33066
+ body,
33067
+ ['PureCloud OAuth'],
33068
+ ['application/json'],
33069
+ ['application/json']
33070
+ );
33071
+ }
33072
+
32601
33073
  /**
32602
33074
  * Update integration configuration.
32603
33075
  *
@@ -32807,7 +33279,7 @@ class JourneyApi {
32807
33279
  /**
32808
33280
  * Journey service.
32809
33281
  * @module purecloud-platform-client-v2/api/JourneyApi
32810
- * @version 217.0.0
33282
+ * @version 218.1.0
32811
33283
  */
32812
33284
 
32813
33285
  /**
@@ -34792,7 +35264,7 @@ class KnowledgeApi {
34792
35264
  /**
34793
35265
  * Knowledge service.
34794
35266
  * @module purecloud-platform-client-v2/api/KnowledgeApi
34795
- * @version 217.0.0
35267
+ * @version 218.1.0
34796
35268
  */
34797
35269
 
34798
35270
  /**
@@ -36067,7 +36539,6 @@ class KnowledgeApi {
36067
36539
  * @param {Object} languageCode Language code, format: iso2-LOCALE
36068
36540
  * @param {String} uploadId UploadId
36069
36541
  * @deprecated
36070
- * getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36071
36542
  */
36072
36543
  getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
36073
36544
  // verify the required parameter 'documentId' is set
@@ -37773,7 +38244,6 @@ class KnowledgeApi {
37773
38244
  *
37774
38245
  * @param {String} knowledgeBaseId Knowledge base ID
37775
38246
  * @param {Object} body
37776
- * postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
37777
38247
  */
37778
38248
  postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
37779
38249
  // verify the required parameter 'knowledgeBaseId' is set
@@ -37804,7 +38274,6 @@ class KnowledgeApi {
37804
38274
  *
37805
38275
  * @param {String} knowledgeBaseId Knowledge base ID
37806
38276
  * @param {Object} body
37807
- * postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
37808
38277
  */
37809
38278
  postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
37810
38279
  // verify the required parameter 'knowledgeBaseId' is set
@@ -37953,7 +38422,6 @@ class KnowledgeApi {
37953
38422
  *
37954
38423
  * @param {String} knowledgeBaseId Knowledge base ID
37955
38424
  * @param {Object} body
37956
- * postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
37957
38425
  */
37958
38426
  postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
37959
38427
  // verify the required parameter 'knowledgeBaseId' is set
@@ -38113,7 +38581,6 @@ class KnowledgeApi {
38113
38581
  * @param {Object} languageCode Language code, format: iso2-LOCALE
38114
38582
  * @param {Object} body
38115
38583
  * @deprecated
38116
- * postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38117
38584
  */
38118
38585
  postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
38119
38586
  // verify the required parameter 'documentId' is set
@@ -38670,7 +39137,7 @@ class LanguageUnderstandingApi {
38670
39137
  /**
38671
39138
  * LanguageUnderstanding service.
38672
39139
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
38673
- * @version 217.0.0
39140
+ * @version 218.1.0
38674
39141
  */
38675
39142
 
38676
39143
  /**
@@ -39703,7 +40170,7 @@ class LanguagesApi {
39703
40170
  /**
39704
40171
  * Languages service.
39705
40172
  * @module purecloud-platform-client-v2/api/LanguagesApi
39706
- * @version 217.0.0
40173
+ * @version 218.1.0
39707
40174
  */
39708
40175
 
39709
40176
  /**
@@ -39925,7 +40392,7 @@ class LearningApi {
39925
40392
  /**
39926
40393
  * Learning service.
39927
40394
  * @module purecloud-platform-client-v2/api/LearningApi
39928
- * @version 217.0.0
40395
+ * @version 218.1.0
39929
40396
  */
39930
40397
 
39931
40398
  /**
@@ -40954,7 +41421,7 @@ class LicenseApi {
40954
41421
  /**
40955
41422
  * License service.
40956
41423
  * @module purecloud-platform-client-v2/api/LicenseApi
40957
- * @version 217.0.0
41424
+ * @version 218.1.0
40958
41425
  */
40959
41426
 
40960
41427
  /**
@@ -41192,7 +41659,7 @@ class LocationsApi {
41192
41659
  /**
41193
41660
  * Locations service.
41194
41661
  * @module purecloud-platform-client-v2/api/LocationsApi
41195
- * @version 217.0.0
41662
+ * @version 218.1.0
41196
41663
  */
41197
41664
 
41198
41665
  /**
@@ -41428,7 +41895,7 @@ class LogCaptureApi {
41428
41895
  /**
41429
41896
  * LogCapture service.
41430
41897
  * @module purecloud-platform-client-v2/api/LogCaptureApi
41431
- * @version 217.0.0
41898
+ * @version 218.1.0
41432
41899
  */
41433
41900
 
41434
41901
  /**
@@ -41628,7 +42095,7 @@ class MessagingApi {
41628
42095
  /**
41629
42096
  * Messaging service.
41630
42097
  * @module purecloud-platform-client-v2/api/MessagingApi
41631
- * @version 217.0.0
42098
+ * @version 218.1.0
41632
42099
  */
41633
42100
 
41634
42101
  /**
@@ -41987,7 +42454,7 @@ class MobileDevicesApi {
41987
42454
  /**
41988
42455
  * MobileDevices service.
41989
42456
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
41990
- * @version 217.0.0
42457
+ * @version 218.1.0
41991
42458
  */
41992
42459
 
41993
42460
  /**
@@ -42138,7 +42605,7 @@ class NotificationsApi {
42138
42605
  /**
42139
42606
  * Notifications service.
42140
42607
  * @module purecloud-platform-client-v2/api/NotificationsApi
42141
- * @version 217.0.0
42608
+ * @version 218.1.0
42142
42609
  */
42143
42610
 
42144
42611
  /**
@@ -42371,7 +42838,7 @@ class OAuthApi {
42371
42838
  /**
42372
42839
  * OAuth service.
42373
42840
  * @module purecloud-platform-client-v2/api/OAuthApi
42374
- * @version 217.0.0
42841
+ * @version 218.1.0
42375
42842
  */
42376
42843
 
42377
42844
  /**
@@ -42737,7 +43204,7 @@ class ObjectsApi {
42737
43204
  /**
42738
43205
  * Objects service.
42739
43206
  * @module purecloud-platform-client-v2/api/ObjectsApi
42740
- * @version 217.0.0
43207
+ * @version 218.1.0
42741
43208
  */
42742
43209
 
42743
43210
  /**
@@ -43008,7 +43475,7 @@ class OperationalEventsApi {
43008
43475
  /**
43009
43476
  * OperationalEvents service.
43010
43477
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
43011
- * @version 217.0.0
43478
+ * @version 218.1.0
43012
43479
  */
43013
43480
 
43014
43481
  /**
@@ -43125,7 +43592,7 @@ class OrganizationApi {
43125
43592
  /**
43126
43593
  * Organization service.
43127
43594
  * @module purecloud-platform-client-v2/api/OrganizationApi
43128
- * @version 217.0.0
43595
+ * @version 218.1.0
43129
43596
  */
43130
43597
 
43131
43598
  /**
@@ -43346,38 +43813,6 @@ class OrganizationApi {
43346
43813
  );
43347
43814
  }
43348
43815
 
43349
- /**
43350
- * Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
43351
- * See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
43352
- * @param {String} namespaceName The namespace to get
43353
- * @param {Object} opts Optional parameters
43354
- * @param {String} opts.cursor Cursor provided when retrieving the last page
43355
- * @param {String} opts.entityId entity id of the count
43356
- * @param {String} opts.userId userid of the count
43357
- * @deprecated
43358
- */
43359
- getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
43360
- opts = opts || {};
43361
-
43362
- // verify the required parameter 'namespaceName' is set
43363
- if (namespaceName === undefined || namespaceName === null) {
43364
- throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';
43365
- }
43366
-
43367
- return this.apiClient.callApi(
43368
- '/api/v2/organizations/limits/namespaces/{namespaceName}/counts',
43369
- 'GET',
43370
- { 'namespaceName': namespaceName },
43371
- { 'cursor': opts['cursor'],'entityId': opts['entityId'],'userId': opts['userId'] },
43372
- { },
43373
- { },
43374
- null,
43375
- ['PureCloud OAuth'],
43376
- ['application/json'],
43377
- ['application/json']
43378
- );
43379
- }
43380
-
43381
43816
  /**
43382
43817
  * Get the default limits in a namespace for an organization
43383
43818
  *
@@ -43403,43 +43838,6 @@ class OrganizationApi {
43403
43838
  );
43404
43839
  }
43405
43840
 
43406
- /**
43407
- * Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
43408
- * See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
43409
- * @param {String} namespaceName The namespace to get
43410
- * @param {String} limitName The limit to get
43411
- * @param {Object} opts Optional parameters
43412
- * @param {String} opts.entityId entity id of the count
43413
- * @param {String} opts.userId userid of the count
43414
- * @param {String} opts.cursor Cursor provided when retrieving the last page
43415
- * @deprecated
43416
- */
43417
- getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
43418
- opts = opts || {};
43419
-
43420
- // verify the required parameter 'namespaceName' is set
43421
- if (namespaceName === undefined || namespaceName === null) {
43422
- throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';
43423
- }
43424
- // verify the required parameter 'limitName' is set
43425
- if (limitName === undefined || limitName === null) {
43426
- throw 'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';
43427
- }
43428
-
43429
- return this.apiClient.callApi(
43430
- '/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts',
43431
- 'GET',
43432
- { 'namespaceName': namespaceName,'limitName': limitName },
43433
- { 'entityId': opts['entityId'],'userId': opts['userId'],'cursor': opts['cursor'] },
43434
- { },
43435
- { },
43436
- null,
43437
- ['PureCloud OAuth'],
43438
- ['application/json'],
43439
- ['application/json']
43440
- );
43441
- }
43442
-
43443
43841
  /**
43444
43842
  * Get the available limit namespaces
43445
43843
  *
@@ -43669,7 +44067,7 @@ class OrganizationAuthorizationApi {
43669
44067
  /**
43670
44068
  * OrganizationAuthorization service.
43671
44069
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
43672
- * @version 217.0.0
44070
+ * @version 218.1.0
43673
44071
  */
43674
44072
 
43675
44073
  /**
@@ -45063,7 +45461,7 @@ class OutboundApi {
45063
45461
  /**
45064
45462
  * Outbound service.
45065
45463
  * @module purecloud-platform-client-v2/api/OutboundApi
45066
- * @version 217.0.0
45464
+ * @version 218.1.0
45067
45465
  */
45068
45466
 
45069
45467
  /**
@@ -49626,7 +50024,7 @@ class PresenceApi {
49626
50024
  /**
49627
50025
  * Presence service.
49628
50026
  * @module purecloud-platform-client-v2/api/PresenceApi
49629
- * @version 217.0.0
50027
+ * @version 218.1.0
49630
50028
  */
49631
50029
 
49632
50030
  /**
@@ -49646,10 +50044,10 @@ class PresenceApi {
49646
50044
  *
49647
50045
  * @param {String} definitionId Presence Definition ID
49648
50046
  */
49649
- deletePresenceDefinition0(definitionId) {
50047
+ deleteDivisionBasedPresenceDefinition(definitionId) {
49650
50048
  // verify the required parameter 'definitionId' is set
49651
50049
  if (definitionId === undefined || definitionId === null) {
49652
- throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
50050
+ throw 'Missing the required parameter "definitionId" when calling deleteDivisionBasedPresenceDefinition';
49653
50051
  }
49654
50052
 
49655
50053
  return this.apiClient.callApi(
@@ -49724,12 +50122,12 @@ class PresenceApi {
49724
50122
  * @param {Object} opts Optional parameters
49725
50123
  * @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
49726
50124
  */
49727
- getPresenceDefinition0(definitionId, opts) {
50125
+ getDivisionBasedPresenceDefinition(definitionId, opts) {
49728
50126
  opts = opts || {};
49729
50127
 
49730
50128
  // verify the required parameter 'definitionId' is set
49731
50129
  if (definitionId === undefined || definitionId === null) {
49732
- throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
50130
+ throw 'Missing the required parameter "definitionId" when calling getDivisionBasedPresenceDefinition';
49733
50131
  }
49734
50132
 
49735
50133
  return this.apiClient.callApi(
@@ -49754,7 +50152,7 @@ class PresenceApi {
49754
50152
  * @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
49755
50153
  * @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
49756
50154
  */
49757
- getPresenceDefinitions0(opts) {
50155
+ getDivisionBasedPresenceDefinitions(opts) {
49758
50156
  opts = opts || {};
49759
50157
 
49760
50158
 
@@ -50122,10 +50520,10 @@ class PresenceApi {
50122
50520
  *
50123
50521
  * @param {Object} body The Presence Definition to create
50124
50522
  */
50125
- postPresenceDefinitions0(body) {
50523
+ postDivisionBasedPresenceDefinitions(body) {
50126
50524
  // verify the required parameter 'body' is set
50127
50525
  if (body === undefined || body === null) {
50128
- throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
50526
+ throw 'Missing the required parameter "body" when calling postDivisionBasedPresenceDefinitions';
50129
50527
  }
50130
50528
 
50131
50529
  return this.apiClient.callApi(
@@ -50199,14 +50597,14 @@ class PresenceApi {
50199
50597
  * @param {String} definitionId Presence Definition ID
50200
50598
  * @param {Object} body The updated Presence Definition
50201
50599
  */
50202
- putPresenceDefinition0(definitionId, body) {
50600
+ putDivisionBasedPresenceDefinition(definitionId, body) {
50203
50601
  // verify the required parameter 'definitionId' is set
50204
50602
  if (definitionId === undefined || definitionId === null) {
50205
- throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
50603
+ throw 'Missing the required parameter "definitionId" when calling putDivisionBasedPresenceDefinition';
50206
50604
  }
50207
50605
  // verify the required parameter 'body' is set
50208
50606
  if (body === undefined || body === null) {
50209
- throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
50607
+ throw 'Missing the required parameter "body" when calling putDivisionBasedPresenceDefinition';
50210
50608
  }
50211
50609
 
50212
50610
  return this.apiClient.callApi(
@@ -50370,7 +50768,7 @@ class ProcessAutomationApi {
50370
50768
  /**
50371
50769
  * ProcessAutomation service.
50372
50770
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
50373
- * @version 217.0.0
50771
+ * @version 218.1.0
50374
50772
  */
50375
50773
 
50376
50774
  /**
@@ -50609,7 +51007,7 @@ class QualityApi {
50609
51007
  /**
50610
51008
  * Quality service.
50611
51009
  * @module purecloud-platform-client-v2/api/QualityApi
50612
- * @version 217.0.0
51010
+ * @version 218.1.0
50613
51011
  */
50614
51012
 
50615
51013
  /**
@@ -52305,7 +52703,6 @@ class QualityApi {
52305
52703
  *
52306
52704
  * @param {String} formId Form ID
52307
52705
  * @param {Object} body AI Scoring Settings
52308
- * putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52309
52706
  */
52310
52707
  putQualityFormsEvaluationAiscoringSettings(formId, body) {
52311
52708
  // verify the required parameter 'formId' is set
@@ -52397,7 +52794,7 @@ class RecordingApi {
52397
52794
  /**
52398
52795
  * Recording service.
52399
52796
  * @module purecloud-platform-client-v2/api/RecordingApi
52400
- * @version 217.0.0
52797
+ * @version 218.1.0
52401
52798
  */
52402
52799
 
52403
52800
  /**
@@ -52704,7 +53101,7 @@ class RecordingApi {
52704
53101
  }
52705
53102
 
52706
53103
  /**
52707
- * Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.
53104
+ * Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.
52708
53105
  *
52709
53106
  * @param {String} conversationId Conversation ID
52710
53107
  */
@@ -52767,6 +53164,7 @@ class RecordingApi {
52767
53164
  * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
52768
53165
  * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
52769
53166
  * @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
53167
+ * @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
52770
53168
  */
52771
53169
  getConversationRecordings(conversationId, opts) {
52772
53170
  opts = opts || {};
@@ -52780,7 +53178,7 @@ class RecordingApi {
52780
53178
  '/api/v2/conversations/{conversationId}/recordings',
52781
53179
  'GET',
52782
53180
  { 'conversationId': conversationId },
52783
- { 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'] },
53181
+ { 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'],'includePauseAnnotationsForScreenRecordings': opts['includePauseAnnotationsForScreenRecordings'] },
52784
53182
  { },
52785
53183
  { },
52786
53184
  null,
@@ -54001,7 +54399,7 @@ class ResponseManagementApi {
54001
54399
  /**
54002
54400
  * ResponseManagement service.
54003
54401
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
54004
- * @version 217.0.0
54402
+ * @version 218.1.0
54005
54403
  */
54006
54404
 
54007
54405
  /**
@@ -54511,7 +54909,7 @@ class RoutingApi {
54511
54909
  /**
54512
54910
  * Routing service.
54513
54911
  * @module purecloud-platform-client-v2/api/RoutingApi
54514
- * @version 217.0.0
54912
+ * @version 218.1.0
54515
54913
  */
54516
54914
 
54517
54915
  /**
@@ -58814,7 +59212,7 @@ class SCIMApi {
58814
59212
  /**
58815
59213
  * SCIM service.
58816
59214
  * @module purecloud-platform-client-v2/api/SCIMApi
58817
- * @version 217.0.0
59215
+ * @version 218.1.0
58818
59216
  */
58819
59217
 
58820
59218
  /**
@@ -59691,7 +60089,7 @@ class ScreenRecordingApi {
59691
60089
  /**
59692
60090
  * ScreenRecording service.
59693
60091
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
59694
- * @version 217.0.0
60092
+ * @version 218.1.0
59695
60093
  */
59696
60094
 
59697
60095
  /**
@@ -59736,7 +60134,7 @@ class ScriptsApi {
59736
60134
  /**
59737
60135
  * Scripts service.
59738
60136
  * @module purecloud-platform-client-v2/api/ScriptsApi
59739
- * @version 217.0.0
60137
+ * @version 218.1.0
59740
60138
  */
59741
60139
 
59742
60140
  /**
@@ -60180,7 +60578,7 @@ class SearchApi {
60180
60578
  /**
60181
60579
  * Search service.
60182
60580
  * @module purecloud-platform-client-v2/api/SearchApi
60183
- * @version 217.0.0
60581
+ * @version 218.1.0
60184
60582
  */
60185
60583
 
60186
60584
  /**
@@ -60923,7 +61321,7 @@ class SettingsApi {
60923
61321
  /**
60924
61322
  * Settings service.
60925
61323
  * @module purecloud-platform-client-v2/api/SettingsApi
60926
- * @version 217.0.0
61324
+ * @version 218.1.0
60927
61325
  */
60928
61326
 
60929
61327
  /**
@@ -60938,6 +61336,26 @@ class SettingsApi {
60938
61336
  }
60939
61337
 
60940
61338
 
61339
+ /**
61340
+ * Reset email threading settings to default
61341
+ *
61342
+ */
61343
+ deleteEmailsSettingsThreading() {
61344
+
61345
+ return this.apiClient.callApi(
61346
+ '/api/v2/emails/settings/threading',
61347
+ 'DELETE',
61348
+ { },
61349
+ { },
61350
+ { },
61351
+ { },
61352
+ null,
61353
+ ['PureCloud OAuth'],
61354
+ ['application/json'],
61355
+ ['application/json']
61356
+ );
61357
+ }
61358
+
60941
61359
  /**
60942
61360
  * Delete agent auto answer settings
60943
61361
  *
@@ -60983,6 +61401,26 @@ class SettingsApi {
60983
61401
  );
60984
61402
  }
60985
61403
 
61404
+ /**
61405
+ * Get email threading settings
61406
+ *
61407
+ */
61408
+ getEmailsSettingsThreading() {
61409
+
61410
+ return this.apiClient.callApi(
61411
+ '/api/v2/emails/settings/threading',
61412
+ 'GET',
61413
+ { },
61414
+ { },
61415
+ { },
61416
+ { },
61417
+ null,
61418
+ ['PureCloud OAuth'],
61419
+ ['application/json'],
61420
+ ['application/json']
61421
+ );
61422
+ }
61423
+
60986
61424
  /**
60987
61425
  * Get the execution history enabled setting.
60988
61426
  * Get the execution history enabled setting.
@@ -61052,6 +61490,30 @@ class SettingsApi {
61052
61490
  );
61053
61491
  }
61054
61492
 
61493
+ /**
61494
+ * Patch email threading settings
61495
+ *
61496
+ * @param {Object} opts Optional parameters
61497
+ * @param {Object} opts.body
61498
+ */
61499
+ patchEmailsSettingsThreading(opts) {
61500
+ opts = opts || {};
61501
+
61502
+
61503
+ return this.apiClient.callApi(
61504
+ '/api/v2/emails/settings/threading',
61505
+ 'PATCH',
61506
+ { },
61507
+ { },
61508
+ { },
61509
+ { },
61510
+ opts['body'],
61511
+ ['PureCloud OAuth'],
61512
+ ['application/json'],
61513
+ ['application/json']
61514
+ );
61515
+ }
61516
+
61055
61517
  /**
61056
61518
  * Edit the execution history on off setting.
61057
61519
  * Edit the execution history on off setting.
@@ -61143,7 +61605,7 @@ class SocialMediaApi {
61143
61605
  /**
61144
61606
  * SocialMedia service.
61145
61607
  * @module purecloud-platform-client-v2/api/SocialMediaApi
61146
- * @version 217.0.0
61608
+ * @version 218.1.0
61147
61609
  */
61148
61610
 
61149
61611
  /**
@@ -61158,13 +61620,63 @@ class SocialMediaApi {
61158
61620
  }
61159
61621
 
61160
61622
 
61623
+ /**
61624
+ * Delete an escalation rule.
61625
+ *
61626
+ * @param {String} escalationRuleId escalationRuleId
61627
+ */
61628
+ deleteSocialmediaEscalationrule(escalationRuleId) {
61629
+ // verify the required parameter 'escalationRuleId' is set
61630
+ if (escalationRuleId === undefined || escalationRuleId === null) {
61631
+ throw 'Missing the required parameter "escalationRuleId" when calling deleteSocialmediaEscalationrule';
61632
+ }
61633
+
61634
+ return this.apiClient.callApi(
61635
+ '/api/v2/socialmedia/escalationrules/{escalationRuleId}',
61636
+ 'DELETE',
61637
+ { 'escalationRuleId': escalationRuleId },
61638
+ { },
61639
+ { },
61640
+ { },
61641
+ null,
61642
+ ['PureCloud OAuth'],
61643
+ ['application/json'],
61644
+ ['application/json']
61645
+ );
61646
+ }
61647
+
61648
+ /**
61649
+ * Delete a social media message.
61650
+ *
61651
+ * @param {String} messageId messageId
61652
+ * deleteSocialmediaMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61653
+ */
61654
+ deleteSocialmediaMessage(messageId) {
61655
+ // verify the required parameter 'messageId' is set
61656
+ if (messageId === undefined || messageId === null) {
61657
+ throw 'Missing the required parameter "messageId" when calling deleteSocialmediaMessage';
61658
+ }
61659
+
61660
+ return this.apiClient.callApi(
61661
+ '/api/v2/socialmedia/messages/{messageId}',
61662
+ 'DELETE',
61663
+ { 'messageId': messageId },
61664
+ { },
61665
+ { },
61666
+ { },
61667
+ null,
61668
+ ['PureCloud OAuth'],
61669
+ ['application/json'],
61670
+ ['application/json']
61671
+ );
61672
+ }
61673
+
61161
61674
  /**
61162
61675
  * Delete a social topic.
61163
61676
  *
61164
61677
  * @param {String} topicId topicId
61165
61678
  * @param {Object} opts Optional parameters
61166
61679
  * @param {Boolean} opts.hardDelete Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default.
61167
- * deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61168
61680
  */
61169
61681
  deleteSocialmediaTopic(topicId, opts) {
61170
61682
  opts = opts || {};
@@ -61195,7 +61707,6 @@ class SocialMediaApi {
61195
61707
  * @param {String} facebookIngestionRuleId facebookIngestionRuleId
61196
61708
  * @param {Object} opts Optional parameters
61197
61709
  * @param {Boolean} opts.hardDelete Determines whether a Facebook data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
61198
- * deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61199
61710
  */
61200
61711
  deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
61201
61712
  opts = opts || {};
@@ -61265,7 +61776,6 @@ class SocialMediaApi {
61265
61776
  * @param {String} twitterIngestionRuleId twitterIngestionRuleId
61266
61777
  * @param {Object} opts Optional parameters
61267
61778
  * @param {Boolean} opts.hardDelete Determines whether a X (formally Twitter) data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
61268
- * deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61269
61779
  */
61270
61780
  deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
61271
61781
  opts = opts || {};
@@ -61293,13 +61803,175 @@ class SocialMediaApi {
61293
61803
  );
61294
61804
  }
61295
61805
 
61806
+ /**
61807
+ * Get status for async query for social media aggregates
61808
+ *
61809
+ * @param {String} jobId jobId
61810
+ */
61811
+ getSocialmediaAnalyticsAggregatesJob(jobId) {
61812
+ // verify the required parameter 'jobId' is set
61813
+ if (jobId === undefined || jobId === null) {
61814
+ throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJob';
61815
+ }
61816
+
61817
+ return this.apiClient.callApi(
61818
+ '/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}',
61819
+ 'GET',
61820
+ { 'jobId': jobId },
61821
+ { },
61822
+ { },
61823
+ { },
61824
+ null,
61825
+ ['PureCloud OAuth'],
61826
+ ['application/json'],
61827
+ ['application/json']
61828
+ );
61829
+ }
61830
+
61831
+ /**
61832
+ * Fetch a page of results for an async social media query
61833
+ *
61834
+ * @param {String} jobId jobId
61835
+ * @param {Object} opts Optional parameters
61836
+ * @param {String} opts.cursor Cursor token to retrieve next page
61837
+ */
61838
+ getSocialmediaAnalyticsAggregatesJobResults(jobId, opts) {
61839
+ opts = opts || {};
61840
+
61841
+ // verify the required parameter 'jobId' is set
61842
+ if (jobId === undefined || jobId === null) {
61843
+ throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJobResults';
61844
+ }
61845
+
61846
+ return this.apiClient.callApi(
61847
+ '/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results',
61848
+ 'GET',
61849
+ { 'jobId': jobId },
61850
+ { 'cursor': opts['cursor'] },
61851
+ { },
61852
+ { },
61853
+ null,
61854
+ ['PureCloud OAuth'],
61855
+ ['application/json'],
61856
+ ['application/json']
61857
+ );
61858
+ }
61859
+
61860
+ /**
61861
+ * Get status for async query for social media messages job
61862
+ *
61863
+ * @param {String} jobId jobId
61864
+ */
61865
+ getSocialmediaAnalyticsMessagesJob(jobId) {
61866
+ // verify the required parameter 'jobId' is set
61867
+ if (jobId === undefined || jobId === null) {
61868
+ throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJob';
61869
+ }
61870
+
61871
+ return this.apiClient.callApi(
61872
+ '/api/v2/socialmedia/analytics/messages/jobs/{jobId}',
61873
+ 'GET',
61874
+ { 'jobId': jobId },
61875
+ { },
61876
+ { },
61877
+ { },
61878
+ null,
61879
+ ['PureCloud OAuth'],
61880
+ ['application/json'],
61881
+ ['application/json']
61882
+ );
61883
+ }
61884
+
61885
+ /**
61886
+ * Fetch a page of results for an async social media messages query
61887
+ *
61888
+ * @param {String} jobId jobId
61889
+ * @param {Object} opts Optional parameters
61890
+ * @param {String} opts.cursor Cursor token to retrieve next page
61891
+ */
61892
+ getSocialmediaAnalyticsMessagesJobResults(jobId, opts) {
61893
+ opts = opts || {};
61894
+
61895
+ // verify the required parameter 'jobId' is set
61896
+ if (jobId === undefined || jobId === null) {
61897
+ throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJobResults';
61898
+ }
61899
+
61900
+ return this.apiClient.callApi(
61901
+ '/api/v2/socialmedia/analytics/messages/jobs/{jobId}/results',
61902
+ 'GET',
61903
+ { 'jobId': jobId },
61904
+ { 'cursor': opts['cursor'] },
61905
+ { },
61906
+ { },
61907
+ null,
61908
+ ['PureCloud OAuth'],
61909
+ ['application/json'],
61910
+ ['application/json']
61911
+ );
61912
+ }
61913
+
61914
+ /**
61915
+ * Get a single escalation rule.
61916
+ *
61917
+ * @param {String} escalationRuleId escalationRuleId
61918
+ */
61919
+ getSocialmediaEscalationrule(escalationRuleId) {
61920
+ // verify the required parameter 'escalationRuleId' is set
61921
+ if (escalationRuleId === undefined || escalationRuleId === null) {
61922
+ throw 'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';
61923
+ }
61924
+
61925
+ return this.apiClient.callApi(
61926
+ '/api/v2/socialmedia/escalationrules/{escalationRuleId}',
61927
+ 'GET',
61928
+ { 'escalationRuleId': escalationRuleId },
61929
+ { },
61930
+ { },
61931
+ { },
61932
+ null,
61933
+ ['PureCloud OAuth'],
61934
+ ['application/json'],
61935
+ ['application/json']
61936
+ );
61937
+ }
61938
+
61939
+ /**
61940
+ * Retrieve all escalation rules for a division.
61941
+ *
61942
+ * @param {String} divisionId One division ID
61943
+ * @param {Object} opts Optional parameters
61944
+ * @param {Number} opts.pageNumber Page number (default to 1)
61945
+ * @param {Number} opts.pageSize Page size (default to 25)
61946
+ */
61947
+ getSocialmediaEscalationrules(divisionId, opts) {
61948
+ opts = opts || {};
61949
+
61950
+ // verify the required parameter 'divisionId' is set
61951
+ if (divisionId === undefined || divisionId === null) {
61952
+ throw 'Missing the required parameter "divisionId" when calling getSocialmediaEscalationrules';
61953
+ }
61954
+
61955
+ return this.apiClient.callApi(
61956
+ '/api/v2/socialmedia/escalationrules',
61957
+ 'GET',
61958
+ { },
61959
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionId': divisionId },
61960
+ { },
61961
+ { },
61962
+ null,
61963
+ ['PureCloud OAuth'],
61964
+ ['application/json'],
61965
+ ['application/json']
61966
+ );
61967
+ }
61968
+
61296
61969
  /**
61297
61970
  * Get a single social topic.
61298
61971
  *
61299
61972
  * @param {String} topicId topicId
61300
61973
  * @param {Object} opts Optional parameters
61301
61974
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
61302
- * getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61303
61975
  */
61304
61976
  getSocialmediaTopic(topicId, opts) {
61305
61977
  opts = opts || {};
@@ -61323,6 +61995,37 @@ class SocialMediaApi {
61323
61995
  );
61324
61996
  }
61325
61997
 
61998
+ /**
61999
+ * Retrieve all social topic data ingestion rules with pagination.
62000
+ *
62001
+ * @param {String} topicId topicId
62002
+ * @param {Object} opts Optional parameters
62003
+ * @param {Number} opts.pageNumber Page number (default to 1)
62004
+ * @param {Number} opts.pageSize Page size (default to 25)
62005
+ * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
62006
+ */
62007
+ getSocialmediaTopicDataingestionrules(topicId, opts) {
62008
+ opts = opts || {};
62009
+
62010
+ // verify the required parameter 'topicId' is set
62011
+ if (topicId === undefined || topicId === null) {
62012
+ throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrules';
62013
+ }
62014
+
62015
+ return this.apiClient.callApi(
62016
+ '/api/v2/socialmedia/topics/{topicId}/dataingestionrules',
62017
+ 'GET',
62018
+ { 'topicId': topicId },
62019
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
62020
+ { },
62021
+ { },
62022
+ null,
62023
+ ['PureCloud OAuth'],
62024
+ ['application/json'],
62025
+ ['application/json']
62026
+ );
62027
+ }
62028
+
61326
62029
  /**
61327
62030
  * Get a single Facebook data ingestion rule.
61328
62031
  *
@@ -61330,7 +62033,6 @@ class SocialMediaApi {
61330
62033
  * @param {String} facebookIngestionRuleId facebookIngestionRuleId
61331
62034
  * @param {Object} opts Optional parameters
61332
62035
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
61333
- * getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61334
62036
  */
61335
62037
  getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
61336
62038
  opts = opts || {};
@@ -61366,7 +62068,6 @@ class SocialMediaApi {
61366
62068
  * @param {String} dataIngestionRuleVersion version
61367
62069
  * @param {Object} opts Optional parameters
61368
62070
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
61369
- * getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61370
62071
  */
61371
62072
  getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
61372
62073
  opts = opts || {};
@@ -61407,7 +62108,6 @@ class SocialMediaApi {
61407
62108
  * @param {Number} opts.pageNumber Page number (default to 1)
61408
62109
  * @param {Number} opts.pageSize Page size (default to 25)
61409
62110
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
61410
- * getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61411
62111
  */
61412
62112
  getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
61413
62113
  opts = opts || {};
@@ -61554,7 +62254,6 @@ class SocialMediaApi {
61554
62254
  * @param {String} twitterIngestionRuleId twitterIngestionRuleId
61555
62255
  * @param {Object} opts Optional parameters
61556
62256
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
61557
- * getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61558
62257
  */
61559
62258
  getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
61560
62259
  opts = opts || {};
@@ -61590,7 +62289,6 @@ class SocialMediaApi {
61590
62289
  * @param {String} dataIngestionRuleVersion version
61591
62290
  * @param {Object} opts Optional parameters
61592
62291
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
61593
- * getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61594
62292
  */
61595
62293
  getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
61596
62294
  opts = opts || {};
@@ -61631,7 +62329,6 @@ class SocialMediaApi {
61631
62329
  * @param {Number} opts.pageNumber Page number (default to 1)
61632
62330
  * @param {Number} opts.pageSize Page size (default to 25)
61633
62331
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
61634
- * getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61635
62332
  */
61636
62333
  getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
61637
62334
  opts = opts || {};
@@ -61667,7 +62364,6 @@ class SocialMediaApi {
61667
62364
  * @param {Number} opts.pageSize Page size (default to 25)
61668
62365
  * @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
61669
62366
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
61670
- * getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61671
62367
  */
61672
62368
  getSocialmediaTopics(opts) {
61673
62369
  opts = opts || {};
@@ -61693,7 +62389,6 @@ class SocialMediaApi {
61693
62389
  * @param {String} topicId topicId
61694
62390
  * @param {Object} opts Optional parameters
61695
62391
  * @param {Object} opts.body
61696
- * patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61697
62392
  */
61698
62393
  patchSocialmediaTopic(topicId, opts) {
61699
62394
  opts = opts || {};
@@ -61724,7 +62419,6 @@ class SocialMediaApi {
61724
62419
  * @param {String} facebookIngestionRuleId facebookIngestionRuleId
61725
62420
  * @param {Object} opts Optional parameters
61726
62421
  * @param {Object} opts.body
61727
- * patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61728
62422
  */
61729
62423
  patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
61730
62424
  opts = opts || {};
@@ -61794,7 +62488,6 @@ class SocialMediaApi {
61794
62488
  * @param {String} twitterIngestionRuleId twitterIngestionRuleId
61795
62489
  * @param {Object} opts Optional parameters
61796
62490
  * @param {Object} opts.body
61797
- * patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61798
62491
  */
61799
62492
  patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
61800
62493
  opts = opts || {};
@@ -61822,13 +62515,115 @@ class SocialMediaApi {
61822
62515
  );
61823
62516
  }
61824
62517
 
62518
+ /**
62519
+ * Query for social media aggregates asynchronously
62520
+ *
62521
+ * @param {Object} body query
62522
+ */
62523
+ postSocialmediaAnalyticsAggregatesJobs(body) {
62524
+ // verify the required parameter 'body' is set
62525
+ if (body === undefined || body === null) {
62526
+ throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsAggregatesJobs';
62527
+ }
62528
+
62529
+ return this.apiClient.callApi(
62530
+ '/api/v2/socialmedia/analytics/aggregates/jobs',
62531
+ 'POST',
62532
+ { },
62533
+ { },
62534
+ { },
62535
+ { },
62536
+ body,
62537
+ ['PureCloud OAuth'],
62538
+ ['application/json'],
62539
+ ['application/json']
62540
+ );
62541
+ }
62542
+
62543
+ /**
62544
+ * Query for social media messages asynchronously
62545
+ *
62546
+ * @param {Object} body query
62547
+ */
62548
+ postSocialmediaAnalyticsMessagesJobs(body) {
62549
+ // verify the required parameter 'body' is set
62550
+ if (body === undefined || body === null) {
62551
+ throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsMessagesJobs';
62552
+ }
62553
+
62554
+ return this.apiClient.callApi(
62555
+ '/api/v2/socialmedia/analytics/messages/jobs',
62556
+ 'POST',
62557
+ { },
62558
+ { },
62559
+ { },
62560
+ { },
62561
+ body,
62562
+ ['PureCloud OAuth'],
62563
+ ['application/json'],
62564
+ ['application/json']
62565
+ );
62566
+ }
62567
+
62568
+ /**
62569
+ * Create an escalation rule.
62570
+ *
62571
+ * @param {Object} opts Optional parameters
62572
+ * @param {Object} opts.body
62573
+ */
62574
+ postSocialmediaEscalationrules(opts) {
62575
+ opts = opts || {};
62576
+
62577
+
62578
+ return this.apiClient.callApi(
62579
+ '/api/v2/socialmedia/escalationrules',
62580
+ 'POST',
62581
+ { },
62582
+ { },
62583
+ { },
62584
+ { },
62585
+ opts['body'],
62586
+ ['PureCloud OAuth'],
62587
+ ['application/json'],
62588
+ ['application/json']
62589
+ );
62590
+ }
62591
+
62592
+ /**
62593
+ * Escalate message to a conversation manually
62594
+ *
62595
+ * @param {String} divisionId One division ID
62596
+ * @param {Object} opts Optional parameters
62597
+ * @param {Object} opts.body
62598
+ */
62599
+ postSocialmediaEscalationsMessages(divisionId, opts) {
62600
+ opts = opts || {};
62601
+
62602
+ // verify the required parameter 'divisionId' is set
62603
+ if (divisionId === undefined || divisionId === null) {
62604
+ throw 'Missing the required parameter "divisionId" when calling postSocialmediaEscalationsMessages';
62605
+ }
62606
+
62607
+ return this.apiClient.callApi(
62608
+ '/api/v2/socialmedia/escalations/messages',
62609
+ 'POST',
62610
+ { },
62611
+ { 'divisionId': divisionId },
62612
+ { },
62613
+ { },
62614
+ opts['body'],
62615
+ ['PureCloud OAuth'],
62616
+ ['application/json'],
62617
+ ['application/json']
62618
+ );
62619
+ }
62620
+
61825
62621
  /**
61826
62622
  * Create an Facebook data ingestion rule.
61827
62623
  *
61828
62624
  * @param {String} topicId topicId
61829
62625
  * @param {Object} opts Optional parameters
61830
62626
  * @param {Object} opts.body
61831
- * postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61832
62627
  */
61833
62628
  postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
61834
62629
  opts = opts || {};
@@ -61888,7 +62683,6 @@ class SocialMediaApi {
61888
62683
  * @param {String} topicId topicId
61889
62684
  * @param {Object} opts Optional parameters
61890
62685
  * @param {Object} opts.body
61891
- * postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61892
62686
  */
61893
62687
  postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
61894
62688
  opts = opts || {};
@@ -61917,7 +62711,6 @@ class SocialMediaApi {
61917
62711
  *
61918
62712
  * @param {Object} opts Optional parameters
61919
62713
  * @param {Object} opts.body
61920
- * postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61921
62714
  */
61922
62715
  postSocialmediaTopics(opts) {
61923
62716
  opts = opts || {};
@@ -61937,6 +62730,60 @@ class SocialMediaApi {
61937
62730
  );
61938
62731
  }
61939
62732
 
62733
+ /**
62734
+ * Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
62735
+ *
62736
+ * @param {Object} body TwitterDataHistoricalTweetRequest
62737
+ */
62738
+ postSocialmediaTwitterHistoricalTweets(body) {
62739
+ // verify the required parameter 'body' is set
62740
+ if (body === undefined || body === null) {
62741
+ throw 'Missing the required parameter "body" when calling postSocialmediaTwitterHistoricalTweets';
62742
+ }
62743
+
62744
+ return this.apiClient.callApi(
62745
+ '/api/v2/socialmedia/twitter/historical/tweets',
62746
+ 'POST',
62747
+ { },
62748
+ { },
62749
+ { },
62750
+ { },
62751
+ body,
62752
+ ['PureCloud OAuth'],
62753
+ ['application/json'],
62754
+ ['application/json']
62755
+ );
62756
+ }
62757
+
62758
+ /**
62759
+ * Update the escalation rule.
62760
+ *
62761
+ * @param {String} escalationRuleId escalationRuleId
62762
+ * @param {Object} opts Optional parameters
62763
+ * @param {Object} opts.body
62764
+ */
62765
+ putSocialmediaEscalationrule(escalationRuleId, opts) {
62766
+ opts = opts || {};
62767
+
62768
+ // verify the required parameter 'escalationRuleId' is set
62769
+ if (escalationRuleId === undefined || escalationRuleId === null) {
62770
+ throw 'Missing the required parameter "escalationRuleId" when calling putSocialmediaEscalationrule';
62771
+ }
62772
+
62773
+ return this.apiClient.callApi(
62774
+ '/api/v2/socialmedia/escalationrules/{escalationRuleId}',
62775
+ 'PUT',
62776
+ { 'escalationRuleId': escalationRuleId },
62777
+ { },
62778
+ { },
62779
+ { },
62780
+ opts['body'],
62781
+ ['PureCloud OAuth'],
62782
+ ['application/json'],
62783
+ ['application/json']
62784
+ );
62785
+ }
62786
+
61940
62787
  /**
61941
62788
  * Update the Facebook data ingestion rule.
61942
62789
  *
@@ -61944,7 +62791,6 @@ class SocialMediaApi {
61944
62791
  * @param {String} facebookIngestionRuleId facebookIngestionRuleId
61945
62792
  * @param {Object} opts Optional parameters
61946
62793
  * @param {Object} opts.body
61947
- * putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61948
62794
  */
61949
62795
  putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
61950
62796
  opts = opts || {};
@@ -62014,7 +62860,6 @@ class SocialMediaApi {
62014
62860
  * @param {String} twitterIngestionRuleId twitterIngestionRuleId
62015
62861
  * @param {Object} opts Optional parameters
62016
62862
  * @param {Object} opts.body
62017
- * putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
62018
62863
  */
62019
62864
  putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
62020
62865
  opts = opts || {};
@@ -62048,7 +62893,7 @@ class SpeechTextAnalyticsApi {
62048
62893
  /**
62049
62894
  * SpeechTextAnalytics service.
62050
62895
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
62051
- * @version 217.0.0
62896
+ * @version 218.1.0
62052
62897
  */
62053
62898
 
62054
62899
  /**
@@ -63489,7 +64334,7 @@ class StationsApi {
63489
64334
  /**
63490
64335
  * Stations service.
63491
64336
  * @module purecloud-platform-client-v2/api/StationsApi
63492
- * @version 217.0.0
64337
+ * @version 218.1.0
63493
64338
  */
63494
64339
 
63495
64340
  /**
@@ -63591,7 +64436,7 @@ class SuggestApi {
63591
64436
  /**
63592
64437
  * Suggest service.
63593
64438
  * @module purecloud-platform-client-v2/api/SuggestApi
63594
- * @version 217.0.0
64439
+ * @version 218.1.0
63595
64440
  */
63596
64441
 
63597
64442
  /**
@@ -63730,7 +64575,7 @@ class TaskManagementApi {
63730
64575
  /**
63731
64576
  * TaskManagement service.
63732
64577
  * @module purecloud-platform-client-v2/api/TaskManagementApi
63733
- * @version 217.0.0
64578
+ * @version 218.1.0
63734
64579
  */
63735
64580
 
63736
64581
  /**
@@ -65836,7 +66681,7 @@ class TeamsApi {
65836
66681
  /**
65837
66682
  * Teams service.
65838
66683
  * @module purecloud-platform-client-v2/api/TeamsApi
65839
- * @version 217.0.0
66684
+ * @version 218.1.0
65840
66685
  */
65841
66686
 
65842
66687
  /**
@@ -66141,7 +66986,7 @@ class TelephonyApi {
66141
66986
  /**
66142
66987
  * Telephony service.
66143
66988
  * @module purecloud-platform-client-v2/api/TelephonyApi
66144
- * @version 217.0.0
66989
+ * @version 218.1.0
66145
66990
  */
66146
66991
 
66147
66992
  /**
@@ -66323,7 +67168,7 @@ class TelephonyProvidersEdgeApi {
66323
67168
  /**
66324
67169
  * TelephonyProvidersEdge service.
66325
67170
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
66326
- * @version 217.0.0
67171
+ * @version 218.1.0
66327
67172
  */
66328
67173
 
66329
67174
  /**
@@ -67505,6 +68350,7 @@ class TelephonyProvidersEdgeApi {
67505
68350
  * @param {Number} opts.pageNumber Page number (default to 1)
67506
68351
  * @param {String} opts.sortBy Sort by
67507
68352
  * @param {String} opts._number Deprecated, filtering by number not supported
68353
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
67508
68354
  */
67509
68355
  getTelephonyProvidersEdgesExtensionpools(opts) {
67510
68356
  opts = opts || {};
@@ -67514,7 +68360,7 @@ class TelephonyProvidersEdgeApi {
67514
68360
  '/api/v2/telephony/providers/edges/extensionpools',
67515
68361
  'GET',
67516
68362
  { },
67517
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'number': opts['_number'] },
68363
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'number': opts['_number'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
67518
68364
  { },
67519
68365
  { },
67520
68366
  null,
@@ -69774,7 +70620,7 @@ class TextbotsApi {
69774
70620
  /**
69775
70621
  * Textbots service.
69776
70622
  * @module purecloud-platform-client-v2/api/TextbotsApi
69777
- * @version 217.0.0
70623
+ * @version 218.1.0
69778
70624
  */
69779
70625
 
69780
70626
  /**
@@ -69902,7 +70748,7 @@ class TokensApi {
69902
70748
  /**
69903
70749
  * Tokens service.
69904
70750
  * @module purecloud-platform-client-v2/api/TokensApi
69905
- * @version 217.0.0
70751
+ * @version 218.1.0
69906
70752
  */
69907
70753
 
69908
70754
  /**
@@ -70056,7 +70902,7 @@ class UploadsApi {
70056
70902
  /**
70057
70903
  * Uploads service.
70058
70904
  * @module purecloud-platform-client-v2/api/UploadsApi
70059
- * @version 217.0.0
70905
+ * @version 218.1.0
70060
70906
  */
70061
70907
 
70062
70908
  /**
@@ -70322,7 +71168,7 @@ class UsageApi {
70322
71168
  /**
70323
71169
  * Usage service.
70324
71170
  * @module purecloud-platform-client-v2/api/UsageApi
70325
- * @version 217.0.0
71171
+ * @version 218.1.0
70326
71172
  */
70327
71173
 
70328
71174
  /**
@@ -70537,7 +71383,7 @@ class UserRecordingsApi {
70537
71383
  /**
70538
71384
  * UserRecordings service.
70539
71385
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
70540
- * @version 217.0.0
71386
+ * @version 218.1.0
70541
71387
  */
70542
71388
 
70543
71389
  /**
@@ -70752,7 +71598,7 @@ class UsersApi {
70752
71598
  /**
70753
71599
  * Users service.
70754
71600
  * @module purecloud-platform-client-v2/api/UsersApi
70755
- * @version 217.0.0
71601
+ * @version 218.1.0
70756
71602
  */
70757
71603
 
70758
71604
  /**
@@ -73705,7 +74551,7 @@ class UtilitiesApi {
73705
74551
  /**
73706
74552
  * Utilities service.
73707
74553
  * @module purecloud-platform-client-v2/api/UtilitiesApi
73708
- * @version 217.0.0
74554
+ * @version 218.1.0
73709
74555
  */
73710
74556
 
73711
74557
  /**
@@ -73816,7 +74662,7 @@ class VoicemailApi {
73816
74662
  /**
73817
74663
  * Voicemail service.
73818
74664
  * @module purecloud-platform-client-v2/api/VoicemailApi
73819
- * @version 217.0.0
74665
+ * @version 218.1.0
73820
74666
  */
73821
74667
 
73822
74668
  /**
@@ -74538,7 +75384,7 @@ class WebChatApi {
74538
75384
  /**
74539
75385
  * WebChat service.
74540
75386
  * @module purecloud-platform-client-v2/api/WebChatApi
74541
- * @version 217.0.0
75387
+ * @version 218.1.0
74542
75388
  */
74543
75389
 
74544
75390
  /**
@@ -74581,9 +75427,10 @@ class WebChatApi {
74581
75427
 
74582
75428
  /**
74583
75429
  * Remove a member from a chat conversation
74584
- *
75430
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
74585
75431
  * @param {String} conversationId conversationId
74586
75432
  * @param {String} memberId memberId
75433
+ * @deprecated
74587
75434
  */
74588
75435
  deleteWebchatGuestConversationMember(conversationId, memberId) {
74589
75436
  // verify the required parameter 'conversationId' is set
@@ -74709,8 +75556,9 @@ class WebChatApi {
74709
75556
 
74710
75557
  /**
74711
75558
  * Get all media requests to the guest in the conversation
74712
- *
75559
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
74713
75560
  * @param {String} conversationId conversationId
75561
+ * @deprecated
74714
75562
  */
74715
75563
  getWebchatGuestConversationMediarequests(conversationId) {
74716
75564
  // verify the required parameter 'conversationId' is set
@@ -74734,9 +75582,10 @@ class WebChatApi {
74734
75582
 
74735
75583
  /**
74736
75584
  * Get a web chat conversation member
74737
- *
75585
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
74738
75586
  * @param {String} conversationId conversationId
74739
75587
  * @param {String} memberId memberId
75588
+ * @deprecated
74740
75589
  */
74741
75590
  getWebchatGuestConversationMember(conversationId, memberId) {
74742
75591
  // verify the required parameter 'conversationId' is set
@@ -74764,12 +75613,13 @@ class WebChatApi {
74764
75613
 
74765
75614
  /**
74766
75615
  * Get the members of a chat conversation.
74767
- *
75616
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
74768
75617
  * @param {String} conversationId conversationId
74769
75618
  * @param {Object} opts Optional parameters
74770
75619
  * @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
74771
75620
  * @param {Number} opts.pageNumber The page number to return, or omitted for the first page. (default to 1)
74772
75621
  * @param {Boolean} opts.excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (default to false)
75622
+ * @deprecated
74773
75623
  */
74774
75624
  getWebchatGuestConversationMembers(conversationId, opts) {
74775
75625
  opts = opts || {};
@@ -74795,9 +75645,10 @@ class WebChatApi {
74795
75645
 
74796
75646
  /**
74797
75647
  * Get a web chat conversation message
74798
- *
75648
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
74799
75649
  * @param {String} conversationId conversationId
74800
75650
  * @param {String} messageId messageId
75651
+ * @deprecated
74801
75652
  */
74802
75653
  getWebchatGuestConversationMessage(conversationId, messageId) {
74803
75654
  // verify the required parameter 'conversationId' is set
@@ -74825,13 +75676,14 @@ class WebChatApi {
74825
75676
 
74826
75677
  /**
74827
75678
  * Get the messages of a chat conversation.
74828
- *
75679
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
74829
75680
  * @param {String} conversationId conversationId
74830
75681
  * @param {Object} opts Optional parameters
74831
75682
  * @param {String} opts.after If available, get the messages chronologically after the id of this message
74832
75683
  * @param {String} opts.before If available, get the messages chronologically before the id of this message
74833
75684
  * @param {Object} opts.sortOrder Sort order (default to ascending)
74834
75685
  * @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
75686
+ * @deprecated
74835
75687
  */
74836
75688
  getWebchatGuestConversationMessages(conversationId, opts) {
74837
75689
  opts = opts || {};
@@ -74939,10 +75791,11 @@ class WebChatApi {
74939
75791
 
74940
75792
  /**
74941
75793
  * Send a message in a chat conversation.
74942
- *
75794
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
74943
75795
  * @param {String} conversationId conversationId
74944
75796
  * @param {String} memberId memberId
74945
75797
  * @param {Object} body Message
75798
+ * @deprecated
74946
75799
  */
74947
75800
  postWebchatGuestConversationMemberMessages(conversationId, memberId, body) {
74948
75801
  // verify the required parameter 'conversationId' is set
@@ -74974,9 +75827,10 @@ class WebChatApi {
74974
75827
 
74975
75828
  /**
74976
75829
  * Send a typing-indicator in a chat conversation.
74977
- *
75830
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
74978
75831
  * @param {String} conversationId conversationId
74979
75832
  * @param {String} memberId memberId
75833
+ * @deprecated
74980
75834
  */
74981
75835
  postWebchatGuestConversationMemberTyping(conversationId, memberId) {
74982
75836
  // verify the required parameter 'conversationId' is set
@@ -75004,8 +75858,9 @@ class WebChatApi {
75004
75858
 
75005
75859
  /**
75006
75860
  * Create an ACD chat conversation from an external customer.
75007
- * This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the memberAuthToken field should include his JWT as generated by the POST /api/v2/signeddata resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the eventStreamUri field of the response; the conversation is not routed until the event stream is attached.
75861
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the memberAuthToken field should include his JWT as generated by the POST /api/v2/signeddata resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the eventStreamUri field of the response; the conversation is not routed until the event stream is attached.
75008
75862
  * @param {Object} body CreateConversationRequest
75863
+ * @deprecated
75009
75864
  */
75010
75865
  postWebchatGuestConversations(body) {
75011
75866
  // verify the required parameter 'body' is set
@@ -75089,7 +75944,7 @@ class WebDeploymentsApi {
75089
75944
  /**
75090
75945
  * WebDeployments service.
75091
75946
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
75092
- * @version 217.0.0
75947
+ * @version 218.1.0
75093
75948
  */
75094
75949
 
75095
75950
  /**
@@ -75673,7 +76528,7 @@ class WebMessagingApi {
75673
76528
  /**
75674
76529
  * WebMessaging service.
75675
76530
  * @module purecloud-platform-client-v2/api/WebMessagingApi
75676
- * @version 217.0.0
76531
+ * @version 218.1.0
75677
76532
  */
75678
76533
 
75679
76534
  /**
@@ -75719,7 +76574,7 @@ class WidgetsApi {
75719
76574
  /**
75720
76575
  * Widgets service.
75721
76576
  * @module purecloud-platform-client-v2/api/WidgetsApi
75722
- * @version 217.0.0
76577
+ * @version 218.1.0
75723
76578
  */
75724
76579
 
75725
76580
  /**
@@ -75736,8 +76591,9 @@ class WidgetsApi {
75736
76591
 
75737
76592
  /**
75738
76593
  * Delete a Widget deployment
75739
- *
76594
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
75740
76595
  * @param {String} deploymentId Widget Config Id
76596
+ * @deprecated
75741
76597
  */
75742
76598
  deleteWidgetsDeployment(deploymentId) {
75743
76599
  // verify the required parameter 'deploymentId' is set
@@ -75761,8 +76617,9 @@ class WidgetsApi {
75761
76617
 
75762
76618
  /**
75763
76619
  * Get a Widget deployment
75764
- *
76620
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
75765
76621
  * @param {String} deploymentId Widget Config Id
76622
+ * @deprecated
75766
76623
  */
75767
76624
  getWidgetsDeployment(deploymentId) {
75768
76625
  // verify the required parameter 'deploymentId' is set
@@ -75786,7 +76643,8 @@ class WidgetsApi {
75786
76643
 
75787
76644
  /**
75788
76645
  * List Widget deployments
75789
- *
76646
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
76647
+ * @deprecated
75790
76648
  */
75791
76649
  getWidgetsDeployments() {
75792
76650
 
@@ -75806,8 +76664,9 @@ class WidgetsApi {
75806
76664
 
75807
76665
  /**
75808
76666
  * Create Widget deployment
75809
- *
76667
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
75810
76668
  * @param {Object} body Deployment
76669
+ * @deprecated
75811
76670
  */
75812
76671
  postWidgetsDeployments(body) {
75813
76672
  // verify the required parameter 'body' is set
@@ -75831,9 +76690,10 @@ class WidgetsApi {
75831
76690
 
75832
76691
  /**
75833
76692
  * Update a Widget deployment
75834
- *
76693
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
75835
76694
  * @param {String} deploymentId Widget Config Id
75836
76695
  * @param {Object} body Deployment
76696
+ * @deprecated
75837
76697
  */
75838
76698
  putWidgetsDeployment(deploymentId, body) {
75839
76699
  // verify the required parameter 'deploymentId' is set
@@ -75865,7 +76725,7 @@ class WorkforceManagementApi {
75865
76725
  /**
75866
76726
  * WorkforceManagement service.
75867
76727
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
75868
- * @version 217.0.0
76728
+ * @version 218.1.0
75869
76729
  */
75870
76730
 
75871
76731
  /**
@@ -83258,7 +84118,7 @@ class WorkforceManagementApi {
83258
84118
  * </pre>
83259
84119
  * </p>
83260
84120
  * @module purecloud-platform-client-v2/index
83261
- * @version 217.0.0
84121
+ * @version 218.1.0
83262
84122
  */
83263
84123
  class platformClient {
83264
84124
  constructor() {