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.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1069 -209
- package/dist/web-amd/purecloud-platform-client-v2.js +1069 -209
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +342 -169
- package/dist/web-cjs/purecloud-platform-client-v2.js +342 -169
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +822 -79
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +61 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -4
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +249 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +65 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +77 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -6
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -70
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -11
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +4 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +65 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +403 -20
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +19 -10
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -687,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
687
|
|
|
688
688
|
/**
|
|
689
689
|
* @module purecloud-platform-client-v2/ApiClient
|
|
690
|
-
* @version
|
|
690
|
+
* @version 218.1.0
|
|
691
691
|
*/
|
|
692
692
|
class ApiClient {
|
|
693
693
|
/**
|
|
@@ -2231,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2231
2231
|
/**
|
|
2232
2232
|
* AgentAssistants service.
|
|
2233
2233
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2234
|
-
* @version
|
|
2234
|
+
* @version 218.1.0
|
|
2235
2235
|
*/
|
|
2236
2236
|
|
|
2237
2237
|
/**
|
|
@@ -2607,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2607
2607
|
/**
|
|
2608
2608
|
* AgentCopilot service.
|
|
2609
2609
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2610
|
-
* @version
|
|
2610
|
+
* @version 218.1.0
|
|
2611
2611
|
*/
|
|
2612
2612
|
|
|
2613
2613
|
/**
|
|
@@ -2683,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2683
2683
|
/**
|
|
2684
2684
|
* AgentUI service.
|
|
2685
2685
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2686
|
-
* @version
|
|
2686
|
+
* @version 218.1.0
|
|
2687
2687
|
*/
|
|
2688
2688
|
|
|
2689
2689
|
/**
|
|
@@ -2814,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2814
2814
|
/**
|
|
2815
2815
|
* Alerting service.
|
|
2816
2816
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2817
|
-
* @version
|
|
2817
|
+
* @version 218.1.0
|
|
2818
2818
|
*/
|
|
2819
2819
|
|
|
2820
2820
|
/**
|
|
@@ -3215,7 +3215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3215
3215
|
/**
|
|
3216
3216
|
* Analytics service.
|
|
3217
3217
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3218
|
-
* @version
|
|
3218
|
+
* @version 218.1.0
|
|
3219
3219
|
*/
|
|
3220
3220
|
|
|
3221
3221
|
/**
|
|
@@ -3340,7 +3340,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3340
3340
|
* Get an agent and their active sessions by user ID
|
|
3341
3341
|
*
|
|
3342
3342
|
* @param {String} userId userId
|
|
3343
|
-
* getAnalyticsAgentStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3344
3343
|
*/
|
|
3345
3344
|
getAnalyticsAgentStatus(userId) {
|
|
3346
3345
|
// verify the required parameter 'userId' is set
|
|
@@ -4792,7 +4791,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4792
4791
|
* Count agents by segment type
|
|
4793
4792
|
*
|
|
4794
4793
|
* @param {Object} body query
|
|
4795
|
-
* postAnalyticsAgentsStatusCounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4796
4794
|
*/
|
|
4797
4795
|
postAnalyticsAgentsStatusCounts(body) {
|
|
4798
4796
|
// verify the required parameter 'body' is set
|
|
@@ -4818,7 +4816,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4818
4816
|
* Retrieve the top 50 agents matching the query filters
|
|
4819
4817
|
*
|
|
4820
4818
|
* @param {Object} body query
|
|
4821
|
-
* postAnalyticsAgentsStatusQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4822
4819
|
*/
|
|
4823
4820
|
postAnalyticsAgentsStatusQuery(body) {
|
|
4824
4821
|
// verify the required parameter 'body' is set
|
|
@@ -6039,7 +6036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6039
6036
|
/**
|
|
6040
6037
|
* Architect service.
|
|
6041
6038
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6042
|
-
* @version
|
|
6039
|
+
* @version 218.1.0
|
|
6043
6040
|
*/
|
|
6044
6041
|
|
|
6045
6042
|
/**
|
|
@@ -9077,6 +9074,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9077
9074
|
);
|
|
9078
9075
|
}
|
|
9079
9076
|
|
|
9077
|
+
/**
|
|
9078
|
+
* Creates a presigned URL for uploading a user prompt file
|
|
9079
|
+
*
|
|
9080
|
+
* @param {String} promptId Prompt ID
|
|
9081
|
+
* @param {String} languageCode Language
|
|
9082
|
+
*/
|
|
9083
|
+
postArchitectPromptResourceUploads(promptId, languageCode) {
|
|
9084
|
+
// verify the required parameter 'promptId' is set
|
|
9085
|
+
if (promptId === undefined || promptId === null) {
|
|
9086
|
+
throw 'Missing the required parameter "promptId" when calling postArchitectPromptResourceUploads';
|
|
9087
|
+
}
|
|
9088
|
+
// verify the required parameter 'languageCode' is set
|
|
9089
|
+
if (languageCode === undefined || languageCode === null) {
|
|
9090
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectPromptResourceUploads';
|
|
9091
|
+
}
|
|
9092
|
+
|
|
9093
|
+
return this.apiClient.callApi(
|
|
9094
|
+
'/api/v2/architect/prompts/{promptId}/resources/{languageCode}/uploads',
|
|
9095
|
+
'POST',
|
|
9096
|
+
{ 'promptId': promptId,'languageCode': languageCode },
|
|
9097
|
+
{ },
|
|
9098
|
+
{ },
|
|
9099
|
+
{ },
|
|
9100
|
+
null,
|
|
9101
|
+
['PureCloud OAuth'],
|
|
9102
|
+
['application/json'],
|
|
9103
|
+
['application/json']
|
|
9104
|
+
);
|
|
9105
|
+
}
|
|
9106
|
+
|
|
9080
9107
|
/**
|
|
9081
9108
|
* Create a new user prompt resource
|
|
9082
9109
|
*
|
|
@@ -9207,6 +9234,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9207
9234
|
);
|
|
9208
9235
|
}
|
|
9209
9236
|
|
|
9237
|
+
/**
|
|
9238
|
+
* Creates a presigned URL for uploading a system prompt file
|
|
9239
|
+
*
|
|
9240
|
+
* @param {String} promptId Prompt ID
|
|
9241
|
+
* @param {String} languageCode Language
|
|
9242
|
+
*/
|
|
9243
|
+
postArchitectSystempromptResourceUploads(promptId, languageCode) {
|
|
9244
|
+
// verify the required parameter 'promptId' is set
|
|
9245
|
+
if (promptId === undefined || promptId === null) {
|
|
9246
|
+
throw 'Missing the required parameter "promptId" when calling postArchitectSystempromptResourceUploads';
|
|
9247
|
+
}
|
|
9248
|
+
// verify the required parameter 'languageCode' is set
|
|
9249
|
+
if (languageCode === undefined || languageCode === null) {
|
|
9250
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectSystempromptResourceUploads';
|
|
9251
|
+
}
|
|
9252
|
+
|
|
9253
|
+
return this.apiClient.callApi(
|
|
9254
|
+
'/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}/uploads',
|
|
9255
|
+
'POST',
|
|
9256
|
+
{ 'promptId': promptId,'languageCode': languageCode },
|
|
9257
|
+
{ },
|
|
9258
|
+
{ },
|
|
9259
|
+
{ },
|
|
9260
|
+
null,
|
|
9261
|
+
['PureCloud OAuth'],
|
|
9262
|
+
['application/json'],
|
|
9263
|
+
['application/json']
|
|
9264
|
+
);
|
|
9265
|
+
}
|
|
9266
|
+
|
|
9210
9267
|
/**
|
|
9211
9268
|
* Create system prompt resource override.
|
|
9212
9269
|
*
|
|
@@ -10272,7 +10329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10272
10329
|
/**
|
|
10273
10330
|
* Audit service.
|
|
10274
10331
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10275
|
-
* @version
|
|
10332
|
+
* @version 218.1.0
|
|
10276
10333
|
*/
|
|
10277
10334
|
|
|
10278
10335
|
/**
|
|
@@ -10473,7 +10530,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10473
10530
|
/**
|
|
10474
10531
|
* Authorization service.
|
|
10475
10532
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10476
|
-
* @version
|
|
10533
|
+
* @version 218.1.0
|
|
10477
10534
|
*/
|
|
10478
10535
|
|
|
10479
10536
|
/**
|
|
@@ -12135,7 +12192,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12135
12192
|
/**
|
|
12136
12193
|
* Billing service.
|
|
12137
12194
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12138
|
-
* @version
|
|
12195
|
+
* @version 218.1.0
|
|
12139
12196
|
*/
|
|
12140
12197
|
|
|
12141
12198
|
/**
|
|
@@ -12215,7 +12272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12215
12272
|
/**
|
|
12216
12273
|
* CarrierServices service.
|
|
12217
12274
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12218
|
-
* @version
|
|
12275
|
+
* @version 218.1.0
|
|
12219
12276
|
*/
|
|
12220
12277
|
|
|
12221
12278
|
/**
|
|
@@ -12285,7 +12342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12285
12342
|
/**
|
|
12286
12343
|
* Chat service.
|
|
12287
12344
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12288
|
-
* @version
|
|
12345
|
+
* @version 218.1.0
|
|
12289
12346
|
*/
|
|
12290
12347
|
|
|
12291
12348
|
/**
|
|
@@ -12425,7 +12482,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12425
12482
|
*
|
|
12426
12483
|
* @param {String} userId userId
|
|
12427
12484
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
12428
|
-
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12429
12485
|
*/
|
|
12430
12486
|
deleteChatsUserMessagesPin(userId, pinnedMessageId) {
|
|
12431
12487
|
// verify the required parameter 'userId' is set
|
|
@@ -12672,7 +12728,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12672
12728
|
* Get information for a 1on1
|
|
12673
12729
|
*
|
|
12674
12730
|
* @param {String} userId userId
|
|
12675
|
-
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12676
12731
|
*/
|
|
12677
12732
|
getChatsUser(userId) {
|
|
12678
12733
|
// verify the required parameter 'userId' is set
|
|
@@ -13130,7 +13185,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13130
13185
|
*
|
|
13131
13186
|
* @param {String} userId userId
|
|
13132
13187
|
* @param {Object} body Pinned Message Ids
|
|
13133
|
-
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13134
13188
|
*/
|
|
13135
13189
|
postChatsUserMessagesPins(userId, body) {
|
|
13136
13190
|
// verify the required parameter 'userId' is set
|
|
@@ -13217,7 +13271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13217
13271
|
/**
|
|
13218
13272
|
* Coaching service.
|
|
13219
13273
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13220
|
-
* @version
|
|
13274
|
+
* @version 218.1.0
|
|
13221
13275
|
*/
|
|
13222
13276
|
|
|
13223
13277
|
/**
|
|
@@ -13794,7 +13848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13794
13848
|
/**
|
|
13795
13849
|
* ContentManagement service.
|
|
13796
13850
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13797
|
-
* @version
|
|
13851
|
+
* @version 218.1.0
|
|
13798
13852
|
*/
|
|
13799
13853
|
|
|
13800
13854
|
/**
|
|
@@ -14875,7 +14929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14875
14929
|
/**
|
|
14876
14930
|
* Conversations service.
|
|
14877
14931
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14878
|
-
* @version
|
|
14932
|
+
* @version 218.1.0
|
|
14879
14933
|
*/
|
|
14880
14934
|
|
|
14881
14935
|
/**
|
|
@@ -15140,6 +15194,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15140
15194
|
);
|
|
15141
15195
|
}
|
|
15142
15196
|
|
|
15197
|
+
/**
|
|
15198
|
+
* Delete Twitter messaging integration
|
|
15199
|
+
*
|
|
15200
|
+
* @param {String} integrationId Integration ID
|
|
15201
|
+
*/
|
|
15202
|
+
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
15203
|
+
// verify the required parameter 'integrationId' is set
|
|
15204
|
+
if (integrationId === undefined || integrationId === null) {
|
|
15205
|
+
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
15206
|
+
}
|
|
15207
|
+
|
|
15208
|
+
return this.apiClient.callApi(
|
|
15209
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
15210
|
+
'DELETE',
|
|
15211
|
+
{ 'integrationId': integrationId },
|
|
15212
|
+
{ },
|
|
15213
|
+
{ },
|
|
15214
|
+
{ },
|
|
15215
|
+
null,
|
|
15216
|
+
['PureCloud OAuth'],
|
|
15217
|
+
['application/json'],
|
|
15218
|
+
['application/json']
|
|
15219
|
+
);
|
|
15220
|
+
}
|
|
15221
|
+
|
|
15143
15222
|
/**
|
|
15144
15223
|
* Delete a WhatsApp messaging integration
|
|
15145
15224
|
*
|
|
@@ -17130,6 +17209,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17130
17209
|
);
|
|
17131
17210
|
}
|
|
17132
17211
|
|
|
17212
|
+
/**
|
|
17213
|
+
* Get twitter oauth settings to patch an integration
|
|
17214
|
+
*
|
|
17215
|
+
* @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
|
|
17216
|
+
*/
|
|
17217
|
+
getConversationsMessagingIntegrationTwitterOauthSettings(integrationId) {
|
|
17218
|
+
// verify the required parameter 'integrationId' is set
|
|
17219
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17220
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationTwitterOauthSettings';
|
|
17221
|
+
}
|
|
17222
|
+
|
|
17223
|
+
return this.apiClient.callApi(
|
|
17224
|
+
'/api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings',
|
|
17225
|
+
'GET',
|
|
17226
|
+
{ 'integrationId': integrationId },
|
|
17227
|
+
{ },
|
|
17228
|
+
{ },
|
|
17229
|
+
{ },
|
|
17230
|
+
null,
|
|
17231
|
+
['PureCloud OAuth'],
|
|
17232
|
+
['application/json'],
|
|
17233
|
+
['application/json']
|
|
17234
|
+
);
|
|
17235
|
+
}
|
|
17236
|
+
|
|
17133
17237
|
/**
|
|
17134
17238
|
* Get a list of Integrations
|
|
17135
17239
|
*
|
|
@@ -17329,6 +17433,83 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17329
17433
|
);
|
|
17330
17434
|
}
|
|
17331
17435
|
|
|
17436
|
+
/**
|
|
17437
|
+
* Get a list of Twitter Integrations
|
|
17438
|
+
*
|
|
17439
|
+
* @param {Object} opts Optional parameters
|
|
17440
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
17441
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17442
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
17443
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
17444
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
17445
|
+
*/
|
|
17446
|
+
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
17447
|
+
opts = opts || {};
|
|
17448
|
+
|
|
17449
|
+
|
|
17450
|
+
return this.apiClient.callApi(
|
|
17451
|
+
'/api/v2/conversations/messaging/integrations/twitter',
|
|
17452
|
+
'GET',
|
|
17453
|
+
{ },
|
|
17454
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
17455
|
+
{ },
|
|
17456
|
+
{ },
|
|
17457
|
+
null,
|
|
17458
|
+
['PureCloud OAuth'],
|
|
17459
|
+
['application/json'],
|
|
17460
|
+
['application/json']
|
|
17461
|
+
);
|
|
17462
|
+
}
|
|
17463
|
+
|
|
17464
|
+
/**
|
|
17465
|
+
* Get Twitter messaging integration
|
|
17466
|
+
*
|
|
17467
|
+
* @param {String} integrationId Integration ID
|
|
17468
|
+
* @param {Object} opts Optional parameters
|
|
17469
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
17470
|
+
*/
|
|
17471
|
+
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
17472
|
+
opts = opts || {};
|
|
17473
|
+
|
|
17474
|
+
// verify the required parameter 'integrationId' is set
|
|
17475
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17476
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
17477
|
+
}
|
|
17478
|
+
|
|
17479
|
+
return this.apiClient.callApi(
|
|
17480
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
17481
|
+
'GET',
|
|
17482
|
+
{ 'integrationId': integrationId },
|
|
17483
|
+
{ 'expand': opts['expand'] },
|
|
17484
|
+
{ },
|
|
17485
|
+
{ },
|
|
17486
|
+
null,
|
|
17487
|
+
['PureCloud OAuth'],
|
|
17488
|
+
['application/json'],
|
|
17489
|
+
['application/json']
|
|
17490
|
+
);
|
|
17491
|
+
}
|
|
17492
|
+
|
|
17493
|
+
/**
|
|
17494
|
+
* Get twitter oauth settings
|
|
17495
|
+
*
|
|
17496
|
+
*/
|
|
17497
|
+
getConversationsMessagingIntegrationsTwitterOauthSettings() {
|
|
17498
|
+
|
|
17499
|
+
return this.apiClient.callApi(
|
|
17500
|
+
'/api/v2/conversations/messaging/integrations/twitter/oauth/settings',
|
|
17501
|
+
'GET',
|
|
17502
|
+
{ },
|
|
17503
|
+
{ },
|
|
17504
|
+
{ },
|
|
17505
|
+
{ },
|
|
17506
|
+
null,
|
|
17507
|
+
['PureCloud OAuth'],
|
|
17508
|
+
['application/json'],
|
|
17509
|
+
['application/json']
|
|
17510
|
+
);
|
|
17511
|
+
}
|
|
17512
|
+
|
|
17332
17513
|
/**
|
|
17333
17514
|
* Get a list of WhatsApp Integrations
|
|
17334
17515
|
*
|
|
@@ -17836,6 +18017,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17836
18017
|
);
|
|
17837
18018
|
}
|
|
17838
18019
|
|
|
18020
|
+
/**
|
|
18021
|
+
* Update the feedback for the summary.
|
|
18022
|
+
*
|
|
18023
|
+
* @param {String} conversationId Conversation ID
|
|
18024
|
+
* @param {String} summaryId Summary ID
|
|
18025
|
+
* @param {Object} opts Optional parameters
|
|
18026
|
+
* @param {Object} opts.body
|
|
18027
|
+
* patchConversationSummaryFeedback is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18028
|
+
*/
|
|
18029
|
+
patchConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
18030
|
+
opts = opts || {};
|
|
18031
|
+
|
|
18032
|
+
// verify the required parameter 'conversationId' is set
|
|
18033
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18034
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSummaryFeedback';
|
|
18035
|
+
}
|
|
18036
|
+
// verify the required parameter 'summaryId' is set
|
|
18037
|
+
if (summaryId === undefined || summaryId === null) {
|
|
18038
|
+
throw 'Missing the required parameter "summaryId" when calling patchConversationSummaryFeedback';
|
|
18039
|
+
}
|
|
18040
|
+
|
|
18041
|
+
return this.apiClient.callApi(
|
|
18042
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback',
|
|
18043
|
+
'PATCH',
|
|
18044
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
18045
|
+
{ },
|
|
18046
|
+
{ },
|
|
18047
|
+
{ },
|
|
18048
|
+
opts['body'],
|
|
18049
|
+
['PureCloud OAuth'],
|
|
18050
|
+
['application/json'],
|
|
18051
|
+
['application/json']
|
|
18052
|
+
);
|
|
18053
|
+
}
|
|
18054
|
+
|
|
17839
18055
|
/**
|
|
17840
18056
|
* Update the utilization label on a conversation. When there is no value provided, the system default label is applied
|
|
17841
18057
|
*
|
|
@@ -18966,6 +19182,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18966
19182
|
);
|
|
18967
19183
|
}
|
|
18968
19184
|
|
|
19185
|
+
/**
|
|
19186
|
+
* Update a Twitter messaging integration
|
|
19187
|
+
*
|
|
19188
|
+
* @param {String} integrationId Integration ID
|
|
19189
|
+
* @param {Object} body TwitterIntegrationUpdateRequest
|
|
19190
|
+
*/
|
|
19191
|
+
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
19192
|
+
// verify the required parameter 'integrationId' is set
|
|
19193
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19194
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
19195
|
+
}
|
|
19196
|
+
// verify the required parameter 'body' is set
|
|
19197
|
+
if (body === undefined || body === null) {
|
|
19198
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
19199
|
+
}
|
|
19200
|
+
|
|
19201
|
+
return this.apiClient.callApi(
|
|
19202
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
19203
|
+
'PATCH',
|
|
19204
|
+
{ 'integrationId': integrationId },
|
|
19205
|
+
{ },
|
|
19206
|
+
{ },
|
|
19207
|
+
{ },
|
|
19208
|
+
body,
|
|
19209
|
+
['PureCloud OAuth'],
|
|
19210
|
+
['application/json'],
|
|
19211
|
+
['application/json']
|
|
19212
|
+
);
|
|
19213
|
+
}
|
|
19214
|
+
|
|
18969
19215
|
/**
|
|
18970
19216
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
18971
19217
|
* 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
|
|
@@ -21302,6 +21548,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21302
21548
|
);
|
|
21303
21549
|
}
|
|
21304
21550
|
|
|
21551
|
+
/**
|
|
21552
|
+
* Create Twitter Integration
|
|
21553
|
+
*
|
|
21554
|
+
* @param {Object} body TwitterIntegrationRequest
|
|
21555
|
+
*/
|
|
21556
|
+
postConversationsMessagingIntegrationsTwitter(body) {
|
|
21557
|
+
// verify the required parameter 'body' is set
|
|
21558
|
+
if (body === undefined || body === null) {
|
|
21559
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
21560
|
+
}
|
|
21561
|
+
|
|
21562
|
+
return this.apiClient.callApi(
|
|
21563
|
+
'/api/v2/conversations/messaging/integrations/twitter',
|
|
21564
|
+
'POST',
|
|
21565
|
+
{ },
|
|
21566
|
+
{ },
|
|
21567
|
+
{ },
|
|
21568
|
+
{ },
|
|
21569
|
+
body,
|
|
21570
|
+
['PureCloud OAuth'],
|
|
21571
|
+
['application/json'],
|
|
21572
|
+
['application/json']
|
|
21573
|
+
);
|
|
21574
|
+
}
|
|
21575
|
+
|
|
21305
21576
|
/**
|
|
21306
21577
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
21307
21578
|
* [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.
|
|
@@ -21507,6 +21778,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21507
21778
|
);
|
|
21508
21779
|
}
|
|
21509
21780
|
|
|
21781
|
+
/**
|
|
21782
|
+
* Create an Agent-Type video conference and assign an agent to it
|
|
21783
|
+
*
|
|
21784
|
+
* @param {String} conversationId conversationId
|
|
21785
|
+
* @param {String} communicationId communicationId
|
|
21786
|
+
* postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21787
|
+
*/
|
|
21788
|
+
postConversationsVideoAgentconferenceCommunication(conversationId, communicationId) {
|
|
21789
|
+
// verify the required parameter 'conversationId' is set
|
|
21790
|
+
if (conversationId === undefined || conversationId === null) {
|
|
21791
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';
|
|
21792
|
+
}
|
|
21793
|
+
// verify the required parameter 'communicationId' is set
|
|
21794
|
+
if (communicationId === undefined || communicationId === null) {
|
|
21795
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoAgentconferenceCommunication';
|
|
21796
|
+
}
|
|
21797
|
+
|
|
21798
|
+
return this.apiClient.callApi(
|
|
21799
|
+
'/api/v2/conversations/videos/{conversationId}/agentconference/communications/{communicationId}',
|
|
21800
|
+
'POST',
|
|
21801
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
21802
|
+
{ },
|
|
21803
|
+
{ },
|
|
21804
|
+
{ },
|
|
21805
|
+
null,
|
|
21806
|
+
['PureCloud OAuth'],
|
|
21807
|
+
['application/json'],
|
|
21808
|
+
['application/json']
|
|
21809
|
+
);
|
|
21810
|
+
}
|
|
21811
|
+
|
|
21510
21812
|
/**
|
|
21511
21813
|
* Apply wrap-up for this conversation communication
|
|
21512
21814
|
*
|
|
@@ -22209,7 +22511,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22209
22511
|
/**
|
|
22210
22512
|
* DataExtensions service.
|
|
22211
22513
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22212
|
-
* @version
|
|
22514
|
+
* @version 218.1.0
|
|
22213
22515
|
*/
|
|
22214
22516
|
|
|
22215
22517
|
/**
|
|
@@ -22295,7 +22597,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22295
22597
|
/**
|
|
22296
22598
|
* DataPrivacy service.
|
|
22297
22599
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22298
|
-
* @version
|
|
22600
|
+
* @version 218.1.0
|
|
22299
22601
|
*/
|
|
22300
22602
|
|
|
22301
22603
|
/**
|
|
@@ -22465,7 +22767,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22465
22767
|
/**
|
|
22466
22768
|
* Downloads service.
|
|
22467
22769
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22468
|
-
* @version
|
|
22770
|
+
* @version 218.1.0
|
|
22469
22771
|
*/
|
|
22470
22772
|
|
|
22471
22773
|
/**
|
|
@@ -22517,7 +22819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22517
22819
|
/**
|
|
22518
22820
|
* Emails service.
|
|
22519
22821
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22520
|
-
* @version
|
|
22822
|
+
* @version 218.1.0
|
|
22521
22823
|
*/
|
|
22522
22824
|
|
|
22523
22825
|
/**
|
|
@@ -22532,6 +22834,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22532
22834
|
}
|
|
22533
22835
|
|
|
22534
22836
|
|
|
22837
|
+
/**
|
|
22838
|
+
* Reset email threading settings to default
|
|
22839
|
+
*
|
|
22840
|
+
*/
|
|
22841
|
+
deleteEmailsSettingsThreading() {
|
|
22842
|
+
|
|
22843
|
+
return this.apiClient.callApi(
|
|
22844
|
+
'/api/v2/emails/settings/threading',
|
|
22845
|
+
'DELETE',
|
|
22846
|
+
{ },
|
|
22847
|
+
{ },
|
|
22848
|
+
{ },
|
|
22849
|
+
{ },
|
|
22850
|
+
null,
|
|
22851
|
+
['PureCloud OAuth'],
|
|
22852
|
+
['application/json'],
|
|
22853
|
+
['application/json']
|
|
22854
|
+
);
|
|
22855
|
+
}
|
|
22856
|
+
|
|
22535
22857
|
/**
|
|
22536
22858
|
* Get email Contact Center settings
|
|
22537
22859
|
*
|
|
@@ -22552,6 +22874,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22552
22874
|
);
|
|
22553
22875
|
}
|
|
22554
22876
|
|
|
22877
|
+
/**
|
|
22878
|
+
* Get email threading settings
|
|
22879
|
+
*
|
|
22880
|
+
*/
|
|
22881
|
+
getEmailsSettingsThreading() {
|
|
22882
|
+
|
|
22883
|
+
return this.apiClient.callApi(
|
|
22884
|
+
'/api/v2/emails/settings/threading',
|
|
22885
|
+
'GET',
|
|
22886
|
+
{ },
|
|
22887
|
+
{ },
|
|
22888
|
+
{ },
|
|
22889
|
+
{ },
|
|
22890
|
+
null,
|
|
22891
|
+
['PureCloud OAuth'],
|
|
22892
|
+
['application/json'],
|
|
22893
|
+
['application/json']
|
|
22894
|
+
);
|
|
22895
|
+
}
|
|
22896
|
+
|
|
22555
22897
|
/**
|
|
22556
22898
|
* Patch email Contact Center settings
|
|
22557
22899
|
*
|
|
@@ -22576,13 +22918,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22576
22918
|
);
|
|
22577
22919
|
}
|
|
22578
22920
|
|
|
22921
|
+
/**
|
|
22922
|
+
* Patch email threading settings
|
|
22923
|
+
*
|
|
22924
|
+
* @param {Object} opts Optional parameters
|
|
22925
|
+
* @param {Object} opts.body
|
|
22926
|
+
*/
|
|
22927
|
+
patchEmailsSettingsThreading(opts) {
|
|
22928
|
+
opts = opts || {};
|
|
22929
|
+
|
|
22930
|
+
|
|
22931
|
+
return this.apiClient.callApi(
|
|
22932
|
+
'/api/v2/emails/settings/threading',
|
|
22933
|
+
'PATCH',
|
|
22934
|
+
{ },
|
|
22935
|
+
{ },
|
|
22936
|
+
{ },
|
|
22937
|
+
{ },
|
|
22938
|
+
opts['body'],
|
|
22939
|
+
['PureCloud OAuth'],
|
|
22940
|
+
['application/json'],
|
|
22941
|
+
['application/json']
|
|
22942
|
+
);
|
|
22943
|
+
}
|
|
22944
|
+
|
|
22579
22945
|
}
|
|
22580
22946
|
|
|
22581
22947
|
class EmployeeEngagementApi {
|
|
22582
22948
|
/**
|
|
22583
22949
|
* EmployeeEngagement service.
|
|
22584
22950
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22585
|
-
* @version
|
|
22951
|
+
* @version 218.1.0
|
|
22586
22952
|
*/
|
|
22587
22953
|
|
|
22588
22954
|
/**
|
|
@@ -22733,7 +23099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22733
23099
|
/**
|
|
22734
23100
|
* Events service.
|
|
22735
23101
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22736
|
-
* @version
|
|
23102
|
+
* @version 218.1.0
|
|
22737
23103
|
*/
|
|
22738
23104
|
|
|
22739
23105
|
/**
|
|
@@ -22829,7 +23195,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22829
23195
|
/**
|
|
22830
23196
|
* ExternalContacts service.
|
|
22831
23197
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22832
|
-
* @version
|
|
23198
|
+
* @version 218.1.0
|
|
22833
23199
|
*/
|
|
22834
23200
|
|
|
22835
23201
|
/**
|
|
@@ -23313,6 +23679,57 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23313
23679
|
);
|
|
23314
23680
|
}
|
|
23315
23681
|
|
|
23682
|
+
/**
|
|
23683
|
+
* Get export for exportId
|
|
23684
|
+
*
|
|
23685
|
+
* @param {String} exportId Export id
|
|
23686
|
+
*/
|
|
23687
|
+
getExternalcontactsContactsExport(exportId) {
|
|
23688
|
+
// verify the required parameter 'exportId' is set
|
|
23689
|
+
if (exportId === undefined || exportId === null) {
|
|
23690
|
+
throw 'Missing the required parameter "exportId" when calling getExternalcontactsContactsExport';
|
|
23691
|
+
}
|
|
23692
|
+
|
|
23693
|
+
return this.apiClient.callApi(
|
|
23694
|
+
'/api/v2/externalcontacts/contacts/exports/{exportId}',
|
|
23695
|
+
'GET',
|
|
23696
|
+
{ 'exportId': exportId },
|
|
23697
|
+
{ },
|
|
23698
|
+
{ },
|
|
23699
|
+
{ },
|
|
23700
|
+
null,
|
|
23701
|
+
['PureCloud OAuth'],
|
|
23702
|
+
['application/json'],
|
|
23703
|
+
['application/json']
|
|
23704
|
+
);
|
|
23705
|
+
}
|
|
23706
|
+
|
|
23707
|
+
/**
|
|
23708
|
+
* List exports for organization
|
|
23709
|
+
*
|
|
23710
|
+
* @param {Object} opts Optional parameters
|
|
23711
|
+
* @param {Array.<String>} opts.divisionIds Division IDs of entities
|
|
23712
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities
|
|
23713
|
+
* @param {Number} opts.pageSize Number of entities to return
|
|
23714
|
+
*/
|
|
23715
|
+
getExternalcontactsContactsExports(opts) {
|
|
23716
|
+
opts = opts || {};
|
|
23717
|
+
|
|
23718
|
+
|
|
23719
|
+
return this.apiClient.callApi(
|
|
23720
|
+
'/api/v2/externalcontacts/contacts/exports',
|
|
23721
|
+
'GET',
|
|
23722
|
+
{ },
|
|
23723
|
+
{ 'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
23724
|
+
{ },
|
|
23725
|
+
{ },
|
|
23726
|
+
null,
|
|
23727
|
+
['PureCloud OAuth'],
|
|
23728
|
+
['application/json'],
|
|
23729
|
+
['application/json']
|
|
23730
|
+
);
|
|
23731
|
+
}
|
|
23732
|
+
|
|
23316
23733
|
/**
|
|
23317
23734
|
* Get a schema
|
|
23318
23735
|
*
|
|
@@ -24821,6 +25238,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24821
25238
|
);
|
|
24822
25239
|
}
|
|
24823
25240
|
|
|
25241
|
+
/**
|
|
25242
|
+
* Create bulk export
|
|
25243
|
+
*
|
|
25244
|
+
* @param {Object} body Export
|
|
25245
|
+
*/
|
|
25246
|
+
postExternalcontactsContactsExports(body) {
|
|
25247
|
+
// verify the required parameter 'body' is set
|
|
25248
|
+
if (body === undefined || body === null) {
|
|
25249
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsExports';
|
|
25250
|
+
}
|
|
25251
|
+
|
|
25252
|
+
return this.apiClient.callApi(
|
|
25253
|
+
'/api/v2/externalcontacts/contacts/exports',
|
|
25254
|
+
'POST',
|
|
25255
|
+
{ },
|
|
25256
|
+
{ },
|
|
25257
|
+
{ },
|
|
25258
|
+
{ },
|
|
25259
|
+
body,
|
|
25260
|
+
['PureCloud OAuth'],
|
|
25261
|
+
['application/json'],
|
|
25262
|
+
['application/json']
|
|
25263
|
+
);
|
|
25264
|
+
}
|
|
25265
|
+
|
|
24824
25266
|
/**
|
|
24825
25267
|
* Create a schema
|
|
24826
25268
|
*
|
|
@@ -25562,7 +26004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25562
26004
|
/**
|
|
25563
26005
|
* Fax service.
|
|
25564
26006
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25565
|
-
* @version
|
|
26007
|
+
* @version 218.1.0
|
|
25566
26008
|
*/
|
|
25567
26009
|
|
|
25568
26010
|
/**
|
|
@@ -25777,7 +26219,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25777
26219
|
/**
|
|
25778
26220
|
* Flows service.
|
|
25779
26221
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25780
|
-
* @version
|
|
26222
|
+
* @version 218.1.0
|
|
25781
26223
|
*/
|
|
25782
26224
|
|
|
25783
26225
|
/**
|
|
@@ -25960,7 +26402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25960
26402
|
/**
|
|
25961
26403
|
* Gamification service.
|
|
25962
26404
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25963
|
-
* @version
|
|
26405
|
+
* @version 218.1.0
|
|
25964
26406
|
*/
|
|
25965
26407
|
|
|
25966
26408
|
/**
|
|
@@ -28102,7 +28544,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28102
28544
|
/**
|
|
28103
28545
|
* GeneralDataProtectionRegulation service.
|
|
28104
28546
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
28105
|
-
* @version
|
|
28547
|
+
* @version 218.1.0
|
|
28106
28548
|
*/
|
|
28107
28549
|
|
|
28108
28550
|
/**
|
|
@@ -28232,7 +28674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28232
28674
|
/**
|
|
28233
28675
|
* Geolocation service.
|
|
28234
28676
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
28235
|
-
* @version
|
|
28677
|
+
* @version 218.1.0
|
|
28236
28678
|
*/
|
|
28237
28679
|
|
|
28238
28680
|
/**
|
|
@@ -28363,7 +28805,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28363
28805
|
/**
|
|
28364
28806
|
* Greetings service.
|
|
28365
28807
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
28366
|
-
* @version
|
|
28808
|
+
* @version 218.1.0
|
|
28367
28809
|
*/
|
|
28368
28810
|
|
|
28369
28811
|
/**
|
|
@@ -28818,7 +29260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28818
29260
|
/**
|
|
28819
29261
|
* Groups service.
|
|
28820
29262
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28821
|
-
* @version
|
|
29263
|
+
* @version 218.1.0
|
|
28822
29264
|
*/
|
|
28823
29265
|
|
|
28824
29266
|
/**
|
|
@@ -29337,7 +29779,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29337
29779
|
/**
|
|
29338
29780
|
* IdentityProvider service.
|
|
29339
29781
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
29340
|
-
* @version
|
|
29782
|
+
* @version 218.1.0
|
|
29341
29783
|
*/
|
|
29342
29784
|
|
|
29343
29785
|
/**
|
|
@@ -30198,7 +30640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30198
30640
|
/**
|
|
30199
30641
|
* InfrastructureAsCode service.
|
|
30200
30642
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
30201
|
-
* @version
|
|
30643
|
+
* @version 218.1.0
|
|
30202
30644
|
*/
|
|
30203
30645
|
|
|
30204
30646
|
/**
|
|
@@ -30365,7 +30807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30365
30807
|
/**
|
|
30366
30808
|
* Integrations service.
|
|
30367
30809
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
30368
|
-
* @version
|
|
30810
|
+
* @version 218.1.0
|
|
30369
30811
|
*/
|
|
30370
30812
|
|
|
30371
30813
|
/**
|
|
@@ -32595,6 +33037,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32595
33037
|
);
|
|
32596
33038
|
}
|
|
32597
33039
|
|
|
33040
|
+
/**
|
|
33041
|
+
* Invoke Webhook
|
|
33042
|
+
*
|
|
33043
|
+
* @param {String} tokenId The token of the webhook to be invoked
|
|
33044
|
+
* @param {Object.<String, {String: Object}>} body Webhook Invocation Payload
|
|
33045
|
+
*/
|
|
33046
|
+
postIntegrationsWebhookEvents(tokenId, body) {
|
|
33047
|
+
// verify the required parameter 'tokenId' is set
|
|
33048
|
+
if (tokenId === undefined || tokenId === null) {
|
|
33049
|
+
throw 'Missing the required parameter "tokenId" when calling postIntegrationsWebhookEvents';
|
|
33050
|
+
}
|
|
33051
|
+
// verify the required parameter 'body' is set
|
|
33052
|
+
if (body === undefined || body === null) {
|
|
33053
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsWebhookEvents';
|
|
33054
|
+
}
|
|
33055
|
+
|
|
33056
|
+
return this.apiClient.callApi(
|
|
33057
|
+
'/api/v2/integrations/webhooks/{tokenId}/events',
|
|
33058
|
+
'POST',
|
|
33059
|
+
{ 'tokenId': tokenId },
|
|
33060
|
+
{ },
|
|
33061
|
+
{ },
|
|
33062
|
+
{ },
|
|
33063
|
+
body,
|
|
33064
|
+
['PureCloud OAuth'],
|
|
33065
|
+
['application/json'],
|
|
33066
|
+
['application/json']
|
|
33067
|
+
);
|
|
33068
|
+
}
|
|
33069
|
+
|
|
32598
33070
|
/**
|
|
32599
33071
|
* Update integration configuration.
|
|
32600
33072
|
*
|
|
@@ -32804,7 +33276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32804
33276
|
/**
|
|
32805
33277
|
* Journey service.
|
|
32806
33278
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
32807
|
-
* @version
|
|
33279
|
+
* @version 218.1.0
|
|
32808
33280
|
*/
|
|
32809
33281
|
|
|
32810
33282
|
/**
|
|
@@ -34789,7 +35261,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34789
35261
|
/**
|
|
34790
35262
|
* Knowledge service.
|
|
34791
35263
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
34792
|
-
* @version
|
|
35264
|
+
* @version 218.1.0
|
|
34793
35265
|
*/
|
|
34794
35266
|
|
|
34795
35267
|
/**
|
|
@@ -36064,7 +36536,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36064
36536
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
36065
36537
|
* @param {String} uploadId UploadId
|
|
36066
36538
|
* @deprecated
|
|
36067
|
-
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36068
36539
|
*/
|
|
36069
36540
|
getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
|
|
36070
36541
|
// verify the required parameter 'documentId' is set
|
|
@@ -37770,7 +38241,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37770
38241
|
*
|
|
37771
38242
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37772
38243
|
* @param {Object} body
|
|
37773
|
-
* postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37774
38244
|
*/
|
|
37775
38245
|
postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
|
|
37776
38246
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37801,7 +38271,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37801
38271
|
*
|
|
37802
38272
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37803
38273
|
* @param {Object} body
|
|
37804
|
-
* postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37805
38274
|
*/
|
|
37806
38275
|
postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
|
|
37807
38276
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37950,7 +38419,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37950
38419
|
*
|
|
37951
38420
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37952
38421
|
* @param {Object} body
|
|
37953
|
-
* postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37954
38422
|
*/
|
|
37955
38423
|
postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
|
|
37956
38424
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38110,7 +38578,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38110
38578
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
38111
38579
|
* @param {Object} body
|
|
38112
38580
|
* @deprecated
|
|
38113
|
-
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38114
38581
|
*/
|
|
38115
38582
|
postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
|
|
38116
38583
|
// verify the required parameter 'documentId' is set
|
|
@@ -38667,7 +39134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38667
39134
|
/**
|
|
38668
39135
|
* LanguageUnderstanding service.
|
|
38669
39136
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38670
|
-
* @version
|
|
39137
|
+
* @version 218.1.0
|
|
38671
39138
|
*/
|
|
38672
39139
|
|
|
38673
39140
|
/**
|
|
@@ -39700,7 +40167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39700
40167
|
/**
|
|
39701
40168
|
* Languages service.
|
|
39702
40169
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39703
|
-
* @version
|
|
40170
|
+
* @version 218.1.0
|
|
39704
40171
|
*/
|
|
39705
40172
|
|
|
39706
40173
|
/**
|
|
@@ -39922,7 +40389,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39922
40389
|
/**
|
|
39923
40390
|
* Learning service.
|
|
39924
40391
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39925
|
-
* @version
|
|
40392
|
+
* @version 218.1.0
|
|
39926
40393
|
*/
|
|
39927
40394
|
|
|
39928
40395
|
/**
|
|
@@ -40951,7 +41418,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40951
41418
|
/**
|
|
40952
41419
|
* License service.
|
|
40953
41420
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40954
|
-
* @version
|
|
41421
|
+
* @version 218.1.0
|
|
40955
41422
|
*/
|
|
40956
41423
|
|
|
40957
41424
|
/**
|
|
@@ -41189,7 +41656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41189
41656
|
/**
|
|
41190
41657
|
* Locations service.
|
|
41191
41658
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41192
|
-
* @version
|
|
41659
|
+
* @version 218.1.0
|
|
41193
41660
|
*/
|
|
41194
41661
|
|
|
41195
41662
|
/**
|
|
@@ -41425,7 +41892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41425
41892
|
/**
|
|
41426
41893
|
* LogCapture service.
|
|
41427
41894
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
41428
|
-
* @version
|
|
41895
|
+
* @version 218.1.0
|
|
41429
41896
|
*/
|
|
41430
41897
|
|
|
41431
41898
|
/**
|
|
@@ -41625,7 +42092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41625
42092
|
/**
|
|
41626
42093
|
* Messaging service.
|
|
41627
42094
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
41628
|
-
* @version
|
|
42095
|
+
* @version 218.1.0
|
|
41629
42096
|
*/
|
|
41630
42097
|
|
|
41631
42098
|
/**
|
|
@@ -41984,7 +42451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41984
42451
|
/**
|
|
41985
42452
|
* MobileDevices service.
|
|
41986
42453
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41987
|
-
* @version
|
|
42454
|
+
* @version 218.1.0
|
|
41988
42455
|
*/
|
|
41989
42456
|
|
|
41990
42457
|
/**
|
|
@@ -42135,7 +42602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42135
42602
|
/**
|
|
42136
42603
|
* Notifications service.
|
|
42137
42604
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
42138
|
-
* @version
|
|
42605
|
+
* @version 218.1.0
|
|
42139
42606
|
*/
|
|
42140
42607
|
|
|
42141
42608
|
/**
|
|
@@ -42368,7 +42835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42368
42835
|
/**
|
|
42369
42836
|
* OAuth service.
|
|
42370
42837
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42371
|
-
* @version
|
|
42838
|
+
* @version 218.1.0
|
|
42372
42839
|
*/
|
|
42373
42840
|
|
|
42374
42841
|
/**
|
|
@@ -42734,7 +43201,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42734
43201
|
/**
|
|
42735
43202
|
* Objects service.
|
|
42736
43203
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
42737
|
-
* @version
|
|
43204
|
+
* @version 218.1.0
|
|
42738
43205
|
*/
|
|
42739
43206
|
|
|
42740
43207
|
/**
|
|
@@ -43005,7 +43472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43005
43472
|
/**
|
|
43006
43473
|
* OperationalEvents service.
|
|
43007
43474
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
43008
|
-
* @version
|
|
43475
|
+
* @version 218.1.0
|
|
43009
43476
|
*/
|
|
43010
43477
|
|
|
43011
43478
|
/**
|
|
@@ -43122,7 +43589,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43122
43589
|
/**
|
|
43123
43590
|
* Organization service.
|
|
43124
43591
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
43125
|
-
* @version
|
|
43592
|
+
* @version 218.1.0
|
|
43126
43593
|
*/
|
|
43127
43594
|
|
|
43128
43595
|
/**
|
|
@@ -43343,38 +43810,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43343
43810
|
);
|
|
43344
43811
|
}
|
|
43345
43812
|
|
|
43346
|
-
/**
|
|
43347
|
-
* 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.
|
|
43348
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
43349
|
-
* @param {String} namespaceName The namespace to get
|
|
43350
|
-
* @param {Object} opts Optional parameters
|
|
43351
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
43352
|
-
* @param {String} opts.entityId entity id of the count
|
|
43353
|
-
* @param {String} opts.userId userid of the count
|
|
43354
|
-
* @deprecated
|
|
43355
|
-
*/
|
|
43356
|
-
getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
|
|
43357
|
-
opts = opts || {};
|
|
43358
|
-
|
|
43359
|
-
// verify the required parameter 'namespaceName' is set
|
|
43360
|
-
if (namespaceName === undefined || namespaceName === null) {
|
|
43361
|
-
throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';
|
|
43362
|
-
}
|
|
43363
|
-
|
|
43364
|
-
return this.apiClient.callApi(
|
|
43365
|
-
'/api/v2/organizations/limits/namespaces/{namespaceName}/counts',
|
|
43366
|
-
'GET',
|
|
43367
|
-
{ 'namespaceName': namespaceName },
|
|
43368
|
-
{ 'cursor': opts['cursor'],'entityId': opts['entityId'],'userId': opts['userId'] },
|
|
43369
|
-
{ },
|
|
43370
|
-
{ },
|
|
43371
|
-
null,
|
|
43372
|
-
['PureCloud OAuth'],
|
|
43373
|
-
['application/json'],
|
|
43374
|
-
['application/json']
|
|
43375
|
-
);
|
|
43376
|
-
}
|
|
43377
|
-
|
|
43378
43813
|
/**
|
|
43379
43814
|
* Get the default limits in a namespace for an organization
|
|
43380
43815
|
*
|
|
@@ -43400,43 +43835,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43400
43835
|
);
|
|
43401
43836
|
}
|
|
43402
43837
|
|
|
43403
|
-
/**
|
|
43404
|
-
* 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.
|
|
43405
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
43406
|
-
* @param {String} namespaceName The namespace to get
|
|
43407
|
-
* @param {String} limitName The limit to get
|
|
43408
|
-
* @param {Object} opts Optional parameters
|
|
43409
|
-
* @param {String} opts.entityId entity id of the count
|
|
43410
|
-
* @param {String} opts.userId userid of the count
|
|
43411
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
43412
|
-
* @deprecated
|
|
43413
|
-
*/
|
|
43414
|
-
getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
|
|
43415
|
-
opts = opts || {};
|
|
43416
|
-
|
|
43417
|
-
// verify the required parameter 'namespaceName' is set
|
|
43418
|
-
if (namespaceName === undefined || namespaceName === null) {
|
|
43419
|
-
throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';
|
|
43420
|
-
}
|
|
43421
|
-
// verify the required parameter 'limitName' is set
|
|
43422
|
-
if (limitName === undefined || limitName === null) {
|
|
43423
|
-
throw 'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';
|
|
43424
|
-
}
|
|
43425
|
-
|
|
43426
|
-
return this.apiClient.callApi(
|
|
43427
|
-
'/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts',
|
|
43428
|
-
'GET',
|
|
43429
|
-
{ 'namespaceName': namespaceName,'limitName': limitName },
|
|
43430
|
-
{ 'entityId': opts['entityId'],'userId': opts['userId'],'cursor': opts['cursor'] },
|
|
43431
|
-
{ },
|
|
43432
|
-
{ },
|
|
43433
|
-
null,
|
|
43434
|
-
['PureCloud OAuth'],
|
|
43435
|
-
['application/json'],
|
|
43436
|
-
['application/json']
|
|
43437
|
-
);
|
|
43438
|
-
}
|
|
43439
|
-
|
|
43440
43838
|
/**
|
|
43441
43839
|
* Get the available limit namespaces
|
|
43442
43840
|
*
|
|
@@ -43666,7 +44064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43666
44064
|
/**
|
|
43667
44065
|
* OrganizationAuthorization service.
|
|
43668
44066
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43669
|
-
* @version
|
|
44067
|
+
* @version 218.1.0
|
|
43670
44068
|
*/
|
|
43671
44069
|
|
|
43672
44070
|
/**
|
|
@@ -45060,7 +45458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45060
45458
|
/**
|
|
45061
45459
|
* Outbound service.
|
|
45062
45460
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
45063
|
-
* @version
|
|
45461
|
+
* @version 218.1.0
|
|
45064
45462
|
*/
|
|
45065
45463
|
|
|
45066
45464
|
/**
|
|
@@ -49623,7 +50021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49623
50021
|
/**
|
|
49624
50022
|
* Presence service.
|
|
49625
50023
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
49626
|
-
* @version
|
|
50024
|
+
* @version 218.1.0
|
|
49627
50025
|
*/
|
|
49628
50026
|
|
|
49629
50027
|
/**
|
|
@@ -49643,10 +50041,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49643
50041
|
*
|
|
49644
50042
|
* @param {String} definitionId Presence Definition ID
|
|
49645
50043
|
*/
|
|
49646
|
-
|
|
50044
|
+
deleteDivisionBasedPresenceDefinition(definitionId) {
|
|
49647
50045
|
// verify the required parameter 'definitionId' is set
|
|
49648
50046
|
if (definitionId === undefined || definitionId === null) {
|
|
49649
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
50047
|
+
throw 'Missing the required parameter "definitionId" when calling deleteDivisionBasedPresenceDefinition';
|
|
49650
50048
|
}
|
|
49651
50049
|
|
|
49652
50050
|
return this.apiClient.callApi(
|
|
@@ -49721,12 +50119,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49721
50119
|
* @param {Object} opts Optional parameters
|
|
49722
50120
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
49723
50121
|
*/
|
|
49724
|
-
|
|
50122
|
+
getDivisionBasedPresenceDefinition(definitionId, opts) {
|
|
49725
50123
|
opts = opts || {};
|
|
49726
50124
|
|
|
49727
50125
|
// verify the required parameter 'definitionId' is set
|
|
49728
50126
|
if (definitionId === undefined || definitionId === null) {
|
|
49729
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
50127
|
+
throw 'Missing the required parameter "definitionId" when calling getDivisionBasedPresenceDefinition';
|
|
49730
50128
|
}
|
|
49731
50129
|
|
|
49732
50130
|
return this.apiClient.callApi(
|
|
@@ -49751,7 +50149,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49751
50149
|
* @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.
|
|
49752
50150
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
49753
50151
|
*/
|
|
49754
|
-
|
|
50152
|
+
getDivisionBasedPresenceDefinitions(opts) {
|
|
49755
50153
|
opts = opts || {};
|
|
49756
50154
|
|
|
49757
50155
|
|
|
@@ -50119,10 +50517,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50119
50517
|
*
|
|
50120
50518
|
* @param {Object} body The Presence Definition to create
|
|
50121
50519
|
*/
|
|
50122
|
-
|
|
50520
|
+
postDivisionBasedPresenceDefinitions(body) {
|
|
50123
50521
|
// verify the required parameter 'body' is set
|
|
50124
50522
|
if (body === undefined || body === null) {
|
|
50125
|
-
throw 'Missing the required parameter "body" when calling
|
|
50523
|
+
throw 'Missing the required parameter "body" when calling postDivisionBasedPresenceDefinitions';
|
|
50126
50524
|
}
|
|
50127
50525
|
|
|
50128
50526
|
return this.apiClient.callApi(
|
|
@@ -50196,14 +50594,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50196
50594
|
* @param {String} definitionId Presence Definition ID
|
|
50197
50595
|
* @param {Object} body The updated Presence Definition
|
|
50198
50596
|
*/
|
|
50199
|
-
|
|
50597
|
+
putDivisionBasedPresenceDefinition(definitionId, body) {
|
|
50200
50598
|
// verify the required parameter 'definitionId' is set
|
|
50201
50599
|
if (definitionId === undefined || definitionId === null) {
|
|
50202
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
50600
|
+
throw 'Missing the required parameter "definitionId" when calling putDivisionBasedPresenceDefinition';
|
|
50203
50601
|
}
|
|
50204
50602
|
// verify the required parameter 'body' is set
|
|
50205
50603
|
if (body === undefined || body === null) {
|
|
50206
|
-
throw 'Missing the required parameter "body" when calling
|
|
50604
|
+
throw 'Missing the required parameter "body" when calling putDivisionBasedPresenceDefinition';
|
|
50207
50605
|
}
|
|
50208
50606
|
|
|
50209
50607
|
return this.apiClient.callApi(
|
|
@@ -50367,7 +50765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50367
50765
|
/**
|
|
50368
50766
|
* ProcessAutomation service.
|
|
50369
50767
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
50370
|
-
* @version
|
|
50768
|
+
* @version 218.1.0
|
|
50371
50769
|
*/
|
|
50372
50770
|
|
|
50373
50771
|
/**
|
|
@@ -50606,7 +51004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50606
51004
|
/**
|
|
50607
51005
|
* Quality service.
|
|
50608
51006
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
50609
|
-
* @version
|
|
51007
|
+
* @version 218.1.0
|
|
50610
51008
|
*/
|
|
50611
51009
|
|
|
50612
51010
|
/**
|
|
@@ -52302,7 +52700,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52302
52700
|
*
|
|
52303
52701
|
* @param {String} formId Form ID
|
|
52304
52702
|
* @param {Object} body AI Scoring Settings
|
|
52305
|
-
* putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
52306
52703
|
*/
|
|
52307
52704
|
putQualityFormsEvaluationAiscoringSettings(formId, body) {
|
|
52308
52705
|
// verify the required parameter 'formId' is set
|
|
@@ -52394,7 +52791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52394
52791
|
/**
|
|
52395
52792
|
* Recording service.
|
|
52396
52793
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
52397
|
-
* @version
|
|
52794
|
+
* @version 218.1.0
|
|
52398
52795
|
*/
|
|
52399
52796
|
|
|
52400
52797
|
/**
|
|
@@ -52701,7 +53098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52701
53098
|
}
|
|
52702
53099
|
|
|
52703
53100
|
/**
|
|
52704
|
-
* Get recording metadata for a conversation. Does not return playable media
|
|
53101
|
+
* 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.
|
|
52705
53102
|
*
|
|
52706
53103
|
* @param {String} conversationId Conversation ID
|
|
52707
53104
|
*/
|
|
@@ -52764,6 +53161,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52764
53161
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
52765
53162
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
52766
53163
|
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
53164
|
+
* @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
|
|
52767
53165
|
*/
|
|
52768
53166
|
getConversationRecordings(conversationId, opts) {
|
|
52769
53167
|
opts = opts || {};
|
|
@@ -52777,7 +53175,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52777
53175
|
'/api/v2/conversations/{conversationId}/recordings',
|
|
52778
53176
|
'GET',
|
|
52779
53177
|
{ 'conversationId': conversationId },
|
|
52780
|
-
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'] },
|
|
53178
|
+
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'],'includePauseAnnotationsForScreenRecordings': opts['includePauseAnnotationsForScreenRecordings'] },
|
|
52781
53179
|
{ },
|
|
52782
53180
|
{ },
|
|
52783
53181
|
null,
|
|
@@ -53998,7 +54396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53998
54396
|
/**
|
|
53999
54397
|
* ResponseManagement service.
|
|
54000
54398
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
54001
|
-
* @version
|
|
54399
|
+
* @version 218.1.0
|
|
54002
54400
|
*/
|
|
54003
54401
|
|
|
54004
54402
|
/**
|
|
@@ -54508,7 +54906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54508
54906
|
/**
|
|
54509
54907
|
* Routing service.
|
|
54510
54908
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54511
|
-
* @version
|
|
54909
|
+
* @version 218.1.0
|
|
54512
54910
|
*/
|
|
54513
54911
|
|
|
54514
54912
|
/**
|
|
@@ -58811,7 +59209,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58811
59209
|
/**
|
|
58812
59210
|
* SCIM service.
|
|
58813
59211
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
58814
|
-
* @version
|
|
59212
|
+
* @version 218.1.0
|
|
58815
59213
|
*/
|
|
58816
59214
|
|
|
58817
59215
|
/**
|
|
@@ -59688,7 +60086,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59688
60086
|
/**
|
|
59689
60087
|
* ScreenRecording service.
|
|
59690
60088
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
59691
|
-
* @version
|
|
60089
|
+
* @version 218.1.0
|
|
59692
60090
|
*/
|
|
59693
60091
|
|
|
59694
60092
|
/**
|
|
@@ -59733,7 +60131,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59733
60131
|
/**
|
|
59734
60132
|
* Scripts service.
|
|
59735
60133
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
59736
|
-
* @version
|
|
60134
|
+
* @version 218.1.0
|
|
59737
60135
|
*/
|
|
59738
60136
|
|
|
59739
60137
|
/**
|
|
@@ -60177,7 +60575,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60177
60575
|
/**
|
|
60178
60576
|
* Search service.
|
|
60179
60577
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
60180
|
-
* @version
|
|
60578
|
+
* @version 218.1.0
|
|
60181
60579
|
*/
|
|
60182
60580
|
|
|
60183
60581
|
/**
|
|
@@ -60920,7 +61318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60920
61318
|
/**
|
|
60921
61319
|
* Settings service.
|
|
60922
61320
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
60923
|
-
* @version
|
|
61321
|
+
* @version 218.1.0
|
|
60924
61322
|
*/
|
|
60925
61323
|
|
|
60926
61324
|
/**
|
|
@@ -60935,6 +61333,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60935
61333
|
}
|
|
60936
61334
|
|
|
60937
61335
|
|
|
61336
|
+
/**
|
|
61337
|
+
* Reset email threading settings to default
|
|
61338
|
+
*
|
|
61339
|
+
*/
|
|
61340
|
+
deleteEmailsSettingsThreading() {
|
|
61341
|
+
|
|
61342
|
+
return this.apiClient.callApi(
|
|
61343
|
+
'/api/v2/emails/settings/threading',
|
|
61344
|
+
'DELETE',
|
|
61345
|
+
{ },
|
|
61346
|
+
{ },
|
|
61347
|
+
{ },
|
|
61348
|
+
{ },
|
|
61349
|
+
null,
|
|
61350
|
+
['PureCloud OAuth'],
|
|
61351
|
+
['application/json'],
|
|
61352
|
+
['application/json']
|
|
61353
|
+
);
|
|
61354
|
+
}
|
|
61355
|
+
|
|
60938
61356
|
/**
|
|
60939
61357
|
* Delete agent auto answer settings
|
|
60940
61358
|
*
|
|
@@ -60980,6 +61398,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60980
61398
|
);
|
|
60981
61399
|
}
|
|
60982
61400
|
|
|
61401
|
+
/**
|
|
61402
|
+
* Get email threading settings
|
|
61403
|
+
*
|
|
61404
|
+
*/
|
|
61405
|
+
getEmailsSettingsThreading() {
|
|
61406
|
+
|
|
61407
|
+
return this.apiClient.callApi(
|
|
61408
|
+
'/api/v2/emails/settings/threading',
|
|
61409
|
+
'GET',
|
|
61410
|
+
{ },
|
|
61411
|
+
{ },
|
|
61412
|
+
{ },
|
|
61413
|
+
{ },
|
|
61414
|
+
null,
|
|
61415
|
+
['PureCloud OAuth'],
|
|
61416
|
+
['application/json'],
|
|
61417
|
+
['application/json']
|
|
61418
|
+
);
|
|
61419
|
+
}
|
|
61420
|
+
|
|
60983
61421
|
/**
|
|
60984
61422
|
* Get the execution history enabled setting.
|
|
60985
61423
|
* Get the execution history enabled setting.
|
|
@@ -61049,6 +61487,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61049
61487
|
);
|
|
61050
61488
|
}
|
|
61051
61489
|
|
|
61490
|
+
/**
|
|
61491
|
+
* Patch email threading settings
|
|
61492
|
+
*
|
|
61493
|
+
* @param {Object} opts Optional parameters
|
|
61494
|
+
* @param {Object} opts.body
|
|
61495
|
+
*/
|
|
61496
|
+
patchEmailsSettingsThreading(opts) {
|
|
61497
|
+
opts = opts || {};
|
|
61498
|
+
|
|
61499
|
+
|
|
61500
|
+
return this.apiClient.callApi(
|
|
61501
|
+
'/api/v2/emails/settings/threading',
|
|
61502
|
+
'PATCH',
|
|
61503
|
+
{ },
|
|
61504
|
+
{ },
|
|
61505
|
+
{ },
|
|
61506
|
+
{ },
|
|
61507
|
+
opts['body'],
|
|
61508
|
+
['PureCloud OAuth'],
|
|
61509
|
+
['application/json'],
|
|
61510
|
+
['application/json']
|
|
61511
|
+
);
|
|
61512
|
+
}
|
|
61513
|
+
|
|
61052
61514
|
/**
|
|
61053
61515
|
* Edit the execution history on off setting.
|
|
61054
61516
|
* Edit the execution history on off setting.
|
|
@@ -61140,7 +61602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61140
61602
|
/**
|
|
61141
61603
|
* SocialMedia service.
|
|
61142
61604
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
61143
|
-
* @version
|
|
61605
|
+
* @version 218.1.0
|
|
61144
61606
|
*/
|
|
61145
61607
|
|
|
61146
61608
|
/**
|
|
@@ -61155,13 +61617,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61155
61617
|
}
|
|
61156
61618
|
|
|
61157
61619
|
|
|
61620
|
+
/**
|
|
61621
|
+
* Delete an escalation rule.
|
|
61622
|
+
*
|
|
61623
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
61624
|
+
*/
|
|
61625
|
+
deleteSocialmediaEscalationrule(escalationRuleId) {
|
|
61626
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
61627
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
61628
|
+
throw 'Missing the required parameter "escalationRuleId" when calling deleteSocialmediaEscalationrule';
|
|
61629
|
+
}
|
|
61630
|
+
|
|
61631
|
+
return this.apiClient.callApi(
|
|
61632
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
61633
|
+
'DELETE',
|
|
61634
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
61635
|
+
{ },
|
|
61636
|
+
{ },
|
|
61637
|
+
{ },
|
|
61638
|
+
null,
|
|
61639
|
+
['PureCloud OAuth'],
|
|
61640
|
+
['application/json'],
|
|
61641
|
+
['application/json']
|
|
61642
|
+
);
|
|
61643
|
+
}
|
|
61644
|
+
|
|
61645
|
+
/**
|
|
61646
|
+
* Delete a social media message.
|
|
61647
|
+
*
|
|
61648
|
+
* @param {String} messageId messageId
|
|
61649
|
+
* deleteSocialmediaMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61650
|
+
*/
|
|
61651
|
+
deleteSocialmediaMessage(messageId) {
|
|
61652
|
+
// verify the required parameter 'messageId' is set
|
|
61653
|
+
if (messageId === undefined || messageId === null) {
|
|
61654
|
+
throw 'Missing the required parameter "messageId" when calling deleteSocialmediaMessage';
|
|
61655
|
+
}
|
|
61656
|
+
|
|
61657
|
+
return this.apiClient.callApi(
|
|
61658
|
+
'/api/v2/socialmedia/messages/{messageId}',
|
|
61659
|
+
'DELETE',
|
|
61660
|
+
{ 'messageId': messageId },
|
|
61661
|
+
{ },
|
|
61662
|
+
{ },
|
|
61663
|
+
{ },
|
|
61664
|
+
null,
|
|
61665
|
+
['PureCloud OAuth'],
|
|
61666
|
+
['application/json'],
|
|
61667
|
+
['application/json']
|
|
61668
|
+
);
|
|
61669
|
+
}
|
|
61670
|
+
|
|
61158
61671
|
/**
|
|
61159
61672
|
* Delete a social topic.
|
|
61160
61673
|
*
|
|
61161
61674
|
* @param {String} topicId topicId
|
|
61162
61675
|
* @param {Object} opts Optional parameters
|
|
61163
61676
|
* @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.
|
|
61164
|
-
* deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61165
61677
|
*/
|
|
61166
61678
|
deleteSocialmediaTopic(topicId, opts) {
|
|
61167
61679
|
opts = opts || {};
|
|
@@ -61192,7 +61704,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61192
61704
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61193
61705
|
* @param {Object} opts Optional parameters
|
|
61194
61706
|
* @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)
|
|
61195
|
-
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61196
61707
|
*/
|
|
61197
61708
|
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61198
61709
|
opts = opts || {};
|
|
@@ -61262,7 +61773,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61262
61773
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61263
61774
|
* @param {Object} opts Optional parameters
|
|
61264
61775
|
* @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)
|
|
61265
|
-
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61266
61776
|
*/
|
|
61267
61777
|
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61268
61778
|
opts = opts || {};
|
|
@@ -61290,13 +61800,175 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61290
61800
|
);
|
|
61291
61801
|
}
|
|
61292
61802
|
|
|
61803
|
+
/**
|
|
61804
|
+
* Get status for async query for social media aggregates
|
|
61805
|
+
*
|
|
61806
|
+
* @param {String} jobId jobId
|
|
61807
|
+
*/
|
|
61808
|
+
getSocialmediaAnalyticsAggregatesJob(jobId) {
|
|
61809
|
+
// verify the required parameter 'jobId' is set
|
|
61810
|
+
if (jobId === undefined || jobId === null) {
|
|
61811
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJob';
|
|
61812
|
+
}
|
|
61813
|
+
|
|
61814
|
+
return this.apiClient.callApi(
|
|
61815
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}',
|
|
61816
|
+
'GET',
|
|
61817
|
+
{ 'jobId': jobId },
|
|
61818
|
+
{ },
|
|
61819
|
+
{ },
|
|
61820
|
+
{ },
|
|
61821
|
+
null,
|
|
61822
|
+
['PureCloud OAuth'],
|
|
61823
|
+
['application/json'],
|
|
61824
|
+
['application/json']
|
|
61825
|
+
);
|
|
61826
|
+
}
|
|
61827
|
+
|
|
61828
|
+
/**
|
|
61829
|
+
* Fetch a page of results for an async social media query
|
|
61830
|
+
*
|
|
61831
|
+
* @param {String} jobId jobId
|
|
61832
|
+
* @param {Object} opts Optional parameters
|
|
61833
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
61834
|
+
*/
|
|
61835
|
+
getSocialmediaAnalyticsAggregatesJobResults(jobId, opts) {
|
|
61836
|
+
opts = opts || {};
|
|
61837
|
+
|
|
61838
|
+
// verify the required parameter 'jobId' is set
|
|
61839
|
+
if (jobId === undefined || jobId === null) {
|
|
61840
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJobResults';
|
|
61841
|
+
}
|
|
61842
|
+
|
|
61843
|
+
return this.apiClient.callApi(
|
|
61844
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results',
|
|
61845
|
+
'GET',
|
|
61846
|
+
{ 'jobId': jobId },
|
|
61847
|
+
{ 'cursor': opts['cursor'] },
|
|
61848
|
+
{ },
|
|
61849
|
+
{ },
|
|
61850
|
+
null,
|
|
61851
|
+
['PureCloud OAuth'],
|
|
61852
|
+
['application/json'],
|
|
61853
|
+
['application/json']
|
|
61854
|
+
);
|
|
61855
|
+
}
|
|
61856
|
+
|
|
61857
|
+
/**
|
|
61858
|
+
* Get status for async query for social media messages job
|
|
61859
|
+
*
|
|
61860
|
+
* @param {String} jobId jobId
|
|
61861
|
+
*/
|
|
61862
|
+
getSocialmediaAnalyticsMessagesJob(jobId) {
|
|
61863
|
+
// verify the required parameter 'jobId' is set
|
|
61864
|
+
if (jobId === undefined || jobId === null) {
|
|
61865
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJob';
|
|
61866
|
+
}
|
|
61867
|
+
|
|
61868
|
+
return this.apiClient.callApi(
|
|
61869
|
+
'/api/v2/socialmedia/analytics/messages/jobs/{jobId}',
|
|
61870
|
+
'GET',
|
|
61871
|
+
{ 'jobId': jobId },
|
|
61872
|
+
{ },
|
|
61873
|
+
{ },
|
|
61874
|
+
{ },
|
|
61875
|
+
null,
|
|
61876
|
+
['PureCloud OAuth'],
|
|
61877
|
+
['application/json'],
|
|
61878
|
+
['application/json']
|
|
61879
|
+
);
|
|
61880
|
+
}
|
|
61881
|
+
|
|
61882
|
+
/**
|
|
61883
|
+
* Fetch a page of results for an async social media messages query
|
|
61884
|
+
*
|
|
61885
|
+
* @param {String} jobId jobId
|
|
61886
|
+
* @param {Object} opts Optional parameters
|
|
61887
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
61888
|
+
*/
|
|
61889
|
+
getSocialmediaAnalyticsMessagesJobResults(jobId, opts) {
|
|
61890
|
+
opts = opts || {};
|
|
61891
|
+
|
|
61892
|
+
// verify the required parameter 'jobId' is set
|
|
61893
|
+
if (jobId === undefined || jobId === null) {
|
|
61894
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJobResults';
|
|
61895
|
+
}
|
|
61896
|
+
|
|
61897
|
+
return this.apiClient.callApi(
|
|
61898
|
+
'/api/v2/socialmedia/analytics/messages/jobs/{jobId}/results',
|
|
61899
|
+
'GET',
|
|
61900
|
+
{ 'jobId': jobId },
|
|
61901
|
+
{ 'cursor': opts['cursor'] },
|
|
61902
|
+
{ },
|
|
61903
|
+
{ },
|
|
61904
|
+
null,
|
|
61905
|
+
['PureCloud OAuth'],
|
|
61906
|
+
['application/json'],
|
|
61907
|
+
['application/json']
|
|
61908
|
+
);
|
|
61909
|
+
}
|
|
61910
|
+
|
|
61911
|
+
/**
|
|
61912
|
+
* Get a single escalation rule.
|
|
61913
|
+
*
|
|
61914
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
61915
|
+
*/
|
|
61916
|
+
getSocialmediaEscalationrule(escalationRuleId) {
|
|
61917
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
61918
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
61919
|
+
throw 'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';
|
|
61920
|
+
}
|
|
61921
|
+
|
|
61922
|
+
return this.apiClient.callApi(
|
|
61923
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
61924
|
+
'GET',
|
|
61925
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
61926
|
+
{ },
|
|
61927
|
+
{ },
|
|
61928
|
+
{ },
|
|
61929
|
+
null,
|
|
61930
|
+
['PureCloud OAuth'],
|
|
61931
|
+
['application/json'],
|
|
61932
|
+
['application/json']
|
|
61933
|
+
);
|
|
61934
|
+
}
|
|
61935
|
+
|
|
61936
|
+
/**
|
|
61937
|
+
* Retrieve all escalation rules for a division.
|
|
61938
|
+
*
|
|
61939
|
+
* @param {String} divisionId One division ID
|
|
61940
|
+
* @param {Object} opts Optional parameters
|
|
61941
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61942
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61943
|
+
*/
|
|
61944
|
+
getSocialmediaEscalationrules(divisionId, opts) {
|
|
61945
|
+
opts = opts || {};
|
|
61946
|
+
|
|
61947
|
+
// verify the required parameter 'divisionId' is set
|
|
61948
|
+
if (divisionId === undefined || divisionId === null) {
|
|
61949
|
+
throw 'Missing the required parameter "divisionId" when calling getSocialmediaEscalationrules';
|
|
61950
|
+
}
|
|
61951
|
+
|
|
61952
|
+
return this.apiClient.callApi(
|
|
61953
|
+
'/api/v2/socialmedia/escalationrules',
|
|
61954
|
+
'GET',
|
|
61955
|
+
{ },
|
|
61956
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionId': divisionId },
|
|
61957
|
+
{ },
|
|
61958
|
+
{ },
|
|
61959
|
+
null,
|
|
61960
|
+
['PureCloud OAuth'],
|
|
61961
|
+
['application/json'],
|
|
61962
|
+
['application/json']
|
|
61963
|
+
);
|
|
61964
|
+
}
|
|
61965
|
+
|
|
61293
61966
|
/**
|
|
61294
61967
|
* Get a single social topic.
|
|
61295
61968
|
*
|
|
61296
61969
|
* @param {String} topicId topicId
|
|
61297
61970
|
* @param {Object} opts Optional parameters
|
|
61298
61971
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61299
|
-
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61300
61972
|
*/
|
|
61301
61973
|
getSocialmediaTopic(topicId, opts) {
|
|
61302
61974
|
opts = opts || {};
|
|
@@ -61320,6 +61992,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61320
61992
|
);
|
|
61321
61993
|
}
|
|
61322
61994
|
|
|
61995
|
+
/**
|
|
61996
|
+
* Retrieve all social topic data ingestion rules with pagination.
|
|
61997
|
+
*
|
|
61998
|
+
* @param {String} topicId topicId
|
|
61999
|
+
* @param {Object} opts Optional parameters
|
|
62000
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
62001
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
62002
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
62003
|
+
*/
|
|
62004
|
+
getSocialmediaTopicDataingestionrules(topicId, opts) {
|
|
62005
|
+
opts = opts || {};
|
|
62006
|
+
|
|
62007
|
+
// verify the required parameter 'topicId' is set
|
|
62008
|
+
if (topicId === undefined || topicId === null) {
|
|
62009
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrules';
|
|
62010
|
+
}
|
|
62011
|
+
|
|
62012
|
+
return this.apiClient.callApi(
|
|
62013
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules',
|
|
62014
|
+
'GET',
|
|
62015
|
+
{ 'topicId': topicId },
|
|
62016
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
62017
|
+
{ },
|
|
62018
|
+
{ },
|
|
62019
|
+
null,
|
|
62020
|
+
['PureCloud OAuth'],
|
|
62021
|
+
['application/json'],
|
|
62022
|
+
['application/json']
|
|
62023
|
+
);
|
|
62024
|
+
}
|
|
62025
|
+
|
|
61323
62026
|
/**
|
|
61324
62027
|
* Get a single Facebook data ingestion rule.
|
|
61325
62028
|
*
|
|
@@ -61327,7 +62030,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61327
62030
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61328
62031
|
* @param {Object} opts Optional parameters
|
|
61329
62032
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61330
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61331
62033
|
*/
|
|
61332
62034
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61333
62035
|
opts = opts || {};
|
|
@@ -61363,7 +62065,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61363
62065
|
* @param {String} dataIngestionRuleVersion version
|
|
61364
62066
|
* @param {Object} opts Optional parameters
|
|
61365
62067
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
61366
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61367
62068
|
*/
|
|
61368
62069
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
61369
62070
|
opts = opts || {};
|
|
@@ -61404,7 +62105,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61404
62105
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61405
62106
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61406
62107
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61407
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61408
62108
|
*/
|
|
61409
62109
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
|
|
61410
62110
|
opts = opts || {};
|
|
@@ -61551,7 +62251,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61551
62251
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61552
62252
|
* @param {Object} opts Optional parameters
|
|
61553
62253
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61554
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61555
62254
|
*/
|
|
61556
62255
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61557
62256
|
opts = opts || {};
|
|
@@ -61587,7 +62286,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61587
62286
|
* @param {String} dataIngestionRuleVersion version
|
|
61588
62287
|
* @param {Object} opts Optional parameters
|
|
61589
62288
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
61590
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61591
62289
|
*/
|
|
61592
62290
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
61593
62291
|
opts = opts || {};
|
|
@@ -61628,7 +62326,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61628
62326
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61629
62327
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61630
62328
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61631
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61632
62329
|
*/
|
|
61633
62330
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
|
|
61634
62331
|
opts = opts || {};
|
|
@@ -61664,7 +62361,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61664
62361
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61665
62362
|
* @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.
|
|
61666
62363
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61667
|
-
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61668
62364
|
*/
|
|
61669
62365
|
getSocialmediaTopics(opts) {
|
|
61670
62366
|
opts = opts || {};
|
|
@@ -61690,7 +62386,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61690
62386
|
* @param {String} topicId topicId
|
|
61691
62387
|
* @param {Object} opts Optional parameters
|
|
61692
62388
|
* @param {Object} opts.body
|
|
61693
|
-
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61694
62389
|
*/
|
|
61695
62390
|
patchSocialmediaTopic(topicId, opts) {
|
|
61696
62391
|
opts = opts || {};
|
|
@@ -61721,7 +62416,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61721
62416
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61722
62417
|
* @param {Object} opts Optional parameters
|
|
61723
62418
|
* @param {Object} opts.body
|
|
61724
|
-
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61725
62419
|
*/
|
|
61726
62420
|
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61727
62421
|
opts = opts || {};
|
|
@@ -61791,7 +62485,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61791
62485
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61792
62486
|
* @param {Object} opts Optional parameters
|
|
61793
62487
|
* @param {Object} opts.body
|
|
61794
|
-
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61795
62488
|
*/
|
|
61796
62489
|
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61797
62490
|
opts = opts || {};
|
|
@@ -61819,13 +62512,115 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61819
62512
|
);
|
|
61820
62513
|
}
|
|
61821
62514
|
|
|
62515
|
+
/**
|
|
62516
|
+
* Query for social media aggregates asynchronously
|
|
62517
|
+
*
|
|
62518
|
+
* @param {Object} body query
|
|
62519
|
+
*/
|
|
62520
|
+
postSocialmediaAnalyticsAggregatesJobs(body) {
|
|
62521
|
+
// verify the required parameter 'body' is set
|
|
62522
|
+
if (body === undefined || body === null) {
|
|
62523
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsAggregatesJobs';
|
|
62524
|
+
}
|
|
62525
|
+
|
|
62526
|
+
return this.apiClient.callApi(
|
|
62527
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs',
|
|
62528
|
+
'POST',
|
|
62529
|
+
{ },
|
|
62530
|
+
{ },
|
|
62531
|
+
{ },
|
|
62532
|
+
{ },
|
|
62533
|
+
body,
|
|
62534
|
+
['PureCloud OAuth'],
|
|
62535
|
+
['application/json'],
|
|
62536
|
+
['application/json']
|
|
62537
|
+
);
|
|
62538
|
+
}
|
|
62539
|
+
|
|
62540
|
+
/**
|
|
62541
|
+
* Query for social media messages asynchronously
|
|
62542
|
+
*
|
|
62543
|
+
* @param {Object} body query
|
|
62544
|
+
*/
|
|
62545
|
+
postSocialmediaAnalyticsMessagesJobs(body) {
|
|
62546
|
+
// verify the required parameter 'body' is set
|
|
62547
|
+
if (body === undefined || body === null) {
|
|
62548
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsMessagesJobs';
|
|
62549
|
+
}
|
|
62550
|
+
|
|
62551
|
+
return this.apiClient.callApi(
|
|
62552
|
+
'/api/v2/socialmedia/analytics/messages/jobs',
|
|
62553
|
+
'POST',
|
|
62554
|
+
{ },
|
|
62555
|
+
{ },
|
|
62556
|
+
{ },
|
|
62557
|
+
{ },
|
|
62558
|
+
body,
|
|
62559
|
+
['PureCloud OAuth'],
|
|
62560
|
+
['application/json'],
|
|
62561
|
+
['application/json']
|
|
62562
|
+
);
|
|
62563
|
+
}
|
|
62564
|
+
|
|
62565
|
+
/**
|
|
62566
|
+
* Create an escalation rule.
|
|
62567
|
+
*
|
|
62568
|
+
* @param {Object} opts Optional parameters
|
|
62569
|
+
* @param {Object} opts.body
|
|
62570
|
+
*/
|
|
62571
|
+
postSocialmediaEscalationrules(opts) {
|
|
62572
|
+
opts = opts || {};
|
|
62573
|
+
|
|
62574
|
+
|
|
62575
|
+
return this.apiClient.callApi(
|
|
62576
|
+
'/api/v2/socialmedia/escalationrules',
|
|
62577
|
+
'POST',
|
|
62578
|
+
{ },
|
|
62579
|
+
{ },
|
|
62580
|
+
{ },
|
|
62581
|
+
{ },
|
|
62582
|
+
opts['body'],
|
|
62583
|
+
['PureCloud OAuth'],
|
|
62584
|
+
['application/json'],
|
|
62585
|
+
['application/json']
|
|
62586
|
+
);
|
|
62587
|
+
}
|
|
62588
|
+
|
|
62589
|
+
/**
|
|
62590
|
+
* Escalate message to a conversation manually
|
|
62591
|
+
*
|
|
62592
|
+
* @param {String} divisionId One division ID
|
|
62593
|
+
* @param {Object} opts Optional parameters
|
|
62594
|
+
* @param {Object} opts.body
|
|
62595
|
+
*/
|
|
62596
|
+
postSocialmediaEscalationsMessages(divisionId, opts) {
|
|
62597
|
+
opts = opts || {};
|
|
62598
|
+
|
|
62599
|
+
// verify the required parameter 'divisionId' is set
|
|
62600
|
+
if (divisionId === undefined || divisionId === null) {
|
|
62601
|
+
throw 'Missing the required parameter "divisionId" when calling postSocialmediaEscalationsMessages';
|
|
62602
|
+
}
|
|
62603
|
+
|
|
62604
|
+
return this.apiClient.callApi(
|
|
62605
|
+
'/api/v2/socialmedia/escalations/messages',
|
|
62606
|
+
'POST',
|
|
62607
|
+
{ },
|
|
62608
|
+
{ 'divisionId': divisionId },
|
|
62609
|
+
{ },
|
|
62610
|
+
{ },
|
|
62611
|
+
opts['body'],
|
|
62612
|
+
['PureCloud OAuth'],
|
|
62613
|
+
['application/json'],
|
|
62614
|
+
['application/json']
|
|
62615
|
+
);
|
|
62616
|
+
}
|
|
62617
|
+
|
|
61822
62618
|
/**
|
|
61823
62619
|
* Create an Facebook data ingestion rule.
|
|
61824
62620
|
*
|
|
61825
62621
|
* @param {String} topicId topicId
|
|
61826
62622
|
* @param {Object} opts Optional parameters
|
|
61827
62623
|
* @param {Object} opts.body
|
|
61828
|
-
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61829
62624
|
*/
|
|
61830
62625
|
postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
|
|
61831
62626
|
opts = opts || {};
|
|
@@ -61885,7 +62680,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61885
62680
|
* @param {String} topicId topicId
|
|
61886
62681
|
* @param {Object} opts Optional parameters
|
|
61887
62682
|
* @param {Object} opts.body
|
|
61888
|
-
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61889
62683
|
*/
|
|
61890
62684
|
postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
|
|
61891
62685
|
opts = opts || {};
|
|
@@ -61914,7 +62708,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61914
62708
|
*
|
|
61915
62709
|
* @param {Object} opts Optional parameters
|
|
61916
62710
|
* @param {Object} opts.body
|
|
61917
|
-
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61918
62711
|
*/
|
|
61919
62712
|
postSocialmediaTopics(opts) {
|
|
61920
62713
|
opts = opts || {};
|
|
@@ -61934,6 +62727,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61934
62727
|
);
|
|
61935
62728
|
}
|
|
61936
62729
|
|
|
62730
|
+
/**
|
|
62731
|
+
* Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
|
|
62732
|
+
*
|
|
62733
|
+
* @param {Object} body TwitterDataHistoricalTweetRequest
|
|
62734
|
+
*/
|
|
62735
|
+
postSocialmediaTwitterHistoricalTweets(body) {
|
|
62736
|
+
// verify the required parameter 'body' is set
|
|
62737
|
+
if (body === undefined || body === null) {
|
|
62738
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTwitterHistoricalTweets';
|
|
62739
|
+
}
|
|
62740
|
+
|
|
62741
|
+
return this.apiClient.callApi(
|
|
62742
|
+
'/api/v2/socialmedia/twitter/historical/tweets',
|
|
62743
|
+
'POST',
|
|
62744
|
+
{ },
|
|
62745
|
+
{ },
|
|
62746
|
+
{ },
|
|
62747
|
+
{ },
|
|
62748
|
+
body,
|
|
62749
|
+
['PureCloud OAuth'],
|
|
62750
|
+
['application/json'],
|
|
62751
|
+
['application/json']
|
|
62752
|
+
);
|
|
62753
|
+
}
|
|
62754
|
+
|
|
62755
|
+
/**
|
|
62756
|
+
* Update the escalation rule.
|
|
62757
|
+
*
|
|
62758
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
62759
|
+
* @param {Object} opts Optional parameters
|
|
62760
|
+
* @param {Object} opts.body
|
|
62761
|
+
*/
|
|
62762
|
+
putSocialmediaEscalationrule(escalationRuleId, opts) {
|
|
62763
|
+
opts = opts || {};
|
|
62764
|
+
|
|
62765
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
62766
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
62767
|
+
throw 'Missing the required parameter "escalationRuleId" when calling putSocialmediaEscalationrule';
|
|
62768
|
+
}
|
|
62769
|
+
|
|
62770
|
+
return this.apiClient.callApi(
|
|
62771
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
62772
|
+
'PUT',
|
|
62773
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
62774
|
+
{ },
|
|
62775
|
+
{ },
|
|
62776
|
+
{ },
|
|
62777
|
+
opts['body'],
|
|
62778
|
+
['PureCloud OAuth'],
|
|
62779
|
+
['application/json'],
|
|
62780
|
+
['application/json']
|
|
62781
|
+
);
|
|
62782
|
+
}
|
|
62783
|
+
|
|
61937
62784
|
/**
|
|
61938
62785
|
* Update the Facebook data ingestion rule.
|
|
61939
62786
|
*
|
|
@@ -61941,7 +62788,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61941
62788
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61942
62789
|
* @param {Object} opts Optional parameters
|
|
61943
62790
|
* @param {Object} opts.body
|
|
61944
|
-
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61945
62791
|
*/
|
|
61946
62792
|
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61947
62793
|
opts = opts || {};
|
|
@@ -62011,7 +62857,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62011
62857
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
62012
62858
|
* @param {Object} opts Optional parameters
|
|
62013
62859
|
* @param {Object} opts.body
|
|
62014
|
-
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
62015
62860
|
*/
|
|
62016
62861
|
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
62017
62862
|
opts = opts || {};
|
|
@@ -62045,7 +62890,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62045
62890
|
/**
|
|
62046
62891
|
* SpeechTextAnalytics service.
|
|
62047
62892
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
62048
|
-
* @version
|
|
62893
|
+
* @version 218.1.0
|
|
62049
62894
|
*/
|
|
62050
62895
|
|
|
62051
62896
|
/**
|
|
@@ -63486,7 +64331,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63486
64331
|
/**
|
|
63487
64332
|
* Stations service.
|
|
63488
64333
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
63489
|
-
* @version
|
|
64334
|
+
* @version 218.1.0
|
|
63490
64335
|
*/
|
|
63491
64336
|
|
|
63492
64337
|
/**
|
|
@@ -63588,7 +64433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63588
64433
|
/**
|
|
63589
64434
|
* Suggest service.
|
|
63590
64435
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
63591
|
-
* @version
|
|
64436
|
+
* @version 218.1.0
|
|
63592
64437
|
*/
|
|
63593
64438
|
|
|
63594
64439
|
/**
|
|
@@ -63727,7 +64572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63727
64572
|
/**
|
|
63728
64573
|
* TaskManagement service.
|
|
63729
64574
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
63730
|
-
* @version
|
|
64575
|
+
* @version 218.1.0
|
|
63731
64576
|
*/
|
|
63732
64577
|
|
|
63733
64578
|
/**
|
|
@@ -65833,7 +66678,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65833
66678
|
/**
|
|
65834
66679
|
* Teams service.
|
|
65835
66680
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
65836
|
-
* @version
|
|
66681
|
+
* @version 218.1.0
|
|
65837
66682
|
*/
|
|
65838
66683
|
|
|
65839
66684
|
/**
|
|
@@ -66138,7 +66983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66138
66983
|
/**
|
|
66139
66984
|
* Telephony service.
|
|
66140
66985
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
66141
|
-
* @version
|
|
66986
|
+
* @version 218.1.0
|
|
66142
66987
|
*/
|
|
66143
66988
|
|
|
66144
66989
|
/**
|
|
@@ -66320,7 +67165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66320
67165
|
/**
|
|
66321
67166
|
* TelephonyProvidersEdge service.
|
|
66322
67167
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
66323
|
-
* @version
|
|
67168
|
+
* @version 218.1.0
|
|
66324
67169
|
*/
|
|
66325
67170
|
|
|
66326
67171
|
/**
|
|
@@ -67502,6 +68347,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67502
68347
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
67503
68348
|
* @param {String} opts.sortBy Sort by
|
|
67504
68349
|
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
68350
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
67505
68351
|
*/
|
|
67506
68352
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
67507
68353
|
opts = opts || {};
|
|
@@ -67511,7 +68357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67511
68357
|
'/api/v2/telephony/providers/edges/extensionpools',
|
|
67512
68358
|
'GET',
|
|
67513
68359
|
{ },
|
|
67514
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'number': opts['_number'] },
|
|
68360
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'number': opts['_number'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
67515
68361
|
{ },
|
|
67516
68362
|
{ },
|
|
67517
68363
|
null,
|
|
@@ -69771,7 +70617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69771
70617
|
/**
|
|
69772
70618
|
* Textbots service.
|
|
69773
70619
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
69774
|
-
* @version
|
|
70620
|
+
* @version 218.1.0
|
|
69775
70621
|
*/
|
|
69776
70622
|
|
|
69777
70623
|
/**
|
|
@@ -69899,7 +70745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69899
70745
|
/**
|
|
69900
70746
|
* Tokens service.
|
|
69901
70747
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
69902
|
-
* @version
|
|
70748
|
+
* @version 218.1.0
|
|
69903
70749
|
*/
|
|
69904
70750
|
|
|
69905
70751
|
/**
|
|
@@ -70053,7 +70899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70053
70899
|
/**
|
|
70054
70900
|
* Uploads service.
|
|
70055
70901
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
70056
|
-
* @version
|
|
70902
|
+
* @version 218.1.0
|
|
70057
70903
|
*/
|
|
70058
70904
|
|
|
70059
70905
|
/**
|
|
@@ -70319,7 +71165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70319
71165
|
/**
|
|
70320
71166
|
* Usage service.
|
|
70321
71167
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
70322
|
-
* @version
|
|
71168
|
+
* @version 218.1.0
|
|
70323
71169
|
*/
|
|
70324
71170
|
|
|
70325
71171
|
/**
|
|
@@ -70534,7 +71380,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70534
71380
|
/**
|
|
70535
71381
|
* UserRecordings service.
|
|
70536
71382
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
70537
|
-
* @version
|
|
71383
|
+
* @version 218.1.0
|
|
70538
71384
|
*/
|
|
70539
71385
|
|
|
70540
71386
|
/**
|
|
@@ -70749,7 +71595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70749
71595
|
/**
|
|
70750
71596
|
* Users service.
|
|
70751
71597
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
70752
|
-
* @version
|
|
71598
|
+
* @version 218.1.0
|
|
70753
71599
|
*/
|
|
70754
71600
|
|
|
70755
71601
|
/**
|
|
@@ -73702,7 +74548,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73702
74548
|
/**
|
|
73703
74549
|
* Utilities service.
|
|
73704
74550
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
73705
|
-
* @version
|
|
74551
|
+
* @version 218.1.0
|
|
73706
74552
|
*/
|
|
73707
74553
|
|
|
73708
74554
|
/**
|
|
@@ -73813,7 +74659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73813
74659
|
/**
|
|
73814
74660
|
* Voicemail service.
|
|
73815
74661
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
73816
|
-
* @version
|
|
74662
|
+
* @version 218.1.0
|
|
73817
74663
|
*/
|
|
73818
74664
|
|
|
73819
74665
|
/**
|
|
@@ -74535,7 +75381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74535
75381
|
/**
|
|
74536
75382
|
* WebChat service.
|
|
74537
75383
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
74538
|
-
* @version
|
|
75384
|
+
* @version 218.1.0
|
|
74539
75385
|
*/
|
|
74540
75386
|
|
|
74541
75387
|
/**
|
|
@@ -74578,9 +75424,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74578
75424
|
|
|
74579
75425
|
/**
|
|
74580
75426
|
* Remove a member from a chat conversation
|
|
74581
|
-
*
|
|
75427
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74582
75428
|
* @param {String} conversationId conversationId
|
|
74583
75429
|
* @param {String} memberId memberId
|
|
75430
|
+
* @deprecated
|
|
74584
75431
|
*/
|
|
74585
75432
|
deleteWebchatGuestConversationMember(conversationId, memberId) {
|
|
74586
75433
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74706,8 +75553,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74706
75553
|
|
|
74707
75554
|
/**
|
|
74708
75555
|
* Get all media requests to the guest in the conversation
|
|
74709
|
-
*
|
|
75556
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74710
75557
|
* @param {String} conversationId conversationId
|
|
75558
|
+
* @deprecated
|
|
74711
75559
|
*/
|
|
74712
75560
|
getWebchatGuestConversationMediarequests(conversationId) {
|
|
74713
75561
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74731,9 +75579,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74731
75579
|
|
|
74732
75580
|
/**
|
|
74733
75581
|
* Get a web chat conversation member
|
|
74734
|
-
*
|
|
75582
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74735
75583
|
* @param {String} conversationId conversationId
|
|
74736
75584
|
* @param {String} memberId memberId
|
|
75585
|
+
* @deprecated
|
|
74737
75586
|
*/
|
|
74738
75587
|
getWebchatGuestConversationMember(conversationId, memberId) {
|
|
74739
75588
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74761,12 +75610,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74761
75610
|
|
|
74762
75611
|
/**
|
|
74763
75612
|
* Get the members of a chat conversation.
|
|
74764
|
-
*
|
|
75613
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74765
75614
|
* @param {String} conversationId conversationId
|
|
74766
75615
|
* @param {Object} opts Optional parameters
|
|
74767
75616
|
* @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
|
|
74768
75617
|
* @param {Number} opts.pageNumber The page number to return, or omitted for the first page. (default to 1)
|
|
74769
75618
|
* @param {Boolean} opts.excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (default to false)
|
|
75619
|
+
* @deprecated
|
|
74770
75620
|
*/
|
|
74771
75621
|
getWebchatGuestConversationMembers(conversationId, opts) {
|
|
74772
75622
|
opts = opts || {};
|
|
@@ -74792,9 +75642,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74792
75642
|
|
|
74793
75643
|
/**
|
|
74794
75644
|
* Get a web chat conversation message
|
|
74795
|
-
*
|
|
75645
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74796
75646
|
* @param {String} conversationId conversationId
|
|
74797
75647
|
* @param {String} messageId messageId
|
|
75648
|
+
* @deprecated
|
|
74798
75649
|
*/
|
|
74799
75650
|
getWebchatGuestConversationMessage(conversationId, messageId) {
|
|
74800
75651
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74822,13 +75673,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74822
75673
|
|
|
74823
75674
|
/**
|
|
74824
75675
|
* Get the messages of a chat conversation.
|
|
74825
|
-
*
|
|
75676
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74826
75677
|
* @param {String} conversationId conversationId
|
|
74827
75678
|
* @param {Object} opts Optional parameters
|
|
74828
75679
|
* @param {String} opts.after If available, get the messages chronologically after the id of this message
|
|
74829
75680
|
* @param {String} opts.before If available, get the messages chronologically before the id of this message
|
|
74830
75681
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
74831
75682
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
75683
|
+
* @deprecated
|
|
74832
75684
|
*/
|
|
74833
75685
|
getWebchatGuestConversationMessages(conversationId, opts) {
|
|
74834
75686
|
opts = opts || {};
|
|
@@ -74936,10 +75788,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74936
75788
|
|
|
74937
75789
|
/**
|
|
74938
75790
|
* Send a message in a chat conversation.
|
|
74939
|
-
*
|
|
75791
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74940
75792
|
* @param {String} conversationId conversationId
|
|
74941
75793
|
* @param {String} memberId memberId
|
|
74942
75794
|
* @param {Object} body Message
|
|
75795
|
+
* @deprecated
|
|
74943
75796
|
*/
|
|
74944
75797
|
postWebchatGuestConversationMemberMessages(conversationId, memberId, body) {
|
|
74945
75798
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74971,9 +75824,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74971
75824
|
|
|
74972
75825
|
/**
|
|
74973
75826
|
* Send a typing-indicator in a chat conversation.
|
|
74974
|
-
*
|
|
75827
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74975
75828
|
* @param {String} conversationId conversationId
|
|
74976
75829
|
* @param {String} memberId memberId
|
|
75830
|
+
* @deprecated
|
|
74977
75831
|
*/
|
|
74978
75832
|
postWebchatGuestConversationMemberTyping(conversationId, memberId) {
|
|
74979
75833
|
// verify the required parameter 'conversationId' is set
|
|
@@ -75001,8 +75855,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75001
75855
|
|
|
75002
75856
|
/**
|
|
75003
75857
|
* Create an ACD chat conversation from an external customer.
|
|
75004
|
-
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.
|
|
75858
|
+
* 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.
|
|
75005
75859
|
* @param {Object} body CreateConversationRequest
|
|
75860
|
+
* @deprecated
|
|
75006
75861
|
*/
|
|
75007
75862
|
postWebchatGuestConversations(body) {
|
|
75008
75863
|
// verify the required parameter 'body' is set
|
|
@@ -75086,7 +75941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75086
75941
|
/**
|
|
75087
75942
|
* WebDeployments service.
|
|
75088
75943
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
75089
|
-
* @version
|
|
75944
|
+
* @version 218.1.0
|
|
75090
75945
|
*/
|
|
75091
75946
|
|
|
75092
75947
|
/**
|
|
@@ -75670,7 +76525,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75670
76525
|
/**
|
|
75671
76526
|
* WebMessaging service.
|
|
75672
76527
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
75673
|
-
* @version
|
|
76528
|
+
* @version 218.1.0
|
|
75674
76529
|
*/
|
|
75675
76530
|
|
|
75676
76531
|
/**
|
|
@@ -75716,7 +76571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75716
76571
|
/**
|
|
75717
76572
|
* Widgets service.
|
|
75718
76573
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
75719
|
-
* @version
|
|
76574
|
+
* @version 218.1.0
|
|
75720
76575
|
*/
|
|
75721
76576
|
|
|
75722
76577
|
/**
|
|
@@ -75733,8 +76588,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75733
76588
|
|
|
75734
76589
|
/**
|
|
75735
76590
|
* Delete a Widget deployment
|
|
75736
|
-
*
|
|
76591
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75737
76592
|
* @param {String} deploymentId Widget Config Id
|
|
76593
|
+
* @deprecated
|
|
75738
76594
|
*/
|
|
75739
76595
|
deleteWidgetsDeployment(deploymentId) {
|
|
75740
76596
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75758,8 +76614,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75758
76614
|
|
|
75759
76615
|
/**
|
|
75760
76616
|
* Get a Widget deployment
|
|
75761
|
-
*
|
|
76617
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75762
76618
|
* @param {String} deploymentId Widget Config Id
|
|
76619
|
+
* @deprecated
|
|
75763
76620
|
*/
|
|
75764
76621
|
getWidgetsDeployment(deploymentId) {
|
|
75765
76622
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75783,7 +76640,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75783
76640
|
|
|
75784
76641
|
/**
|
|
75785
76642
|
* List Widget deployments
|
|
75786
|
-
*
|
|
76643
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
76644
|
+
* @deprecated
|
|
75787
76645
|
*/
|
|
75788
76646
|
getWidgetsDeployments() {
|
|
75789
76647
|
|
|
@@ -75803,8 +76661,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75803
76661
|
|
|
75804
76662
|
/**
|
|
75805
76663
|
* Create Widget deployment
|
|
75806
|
-
*
|
|
76664
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75807
76665
|
* @param {Object} body Deployment
|
|
76666
|
+
* @deprecated
|
|
75808
76667
|
*/
|
|
75809
76668
|
postWidgetsDeployments(body) {
|
|
75810
76669
|
// verify the required parameter 'body' is set
|
|
@@ -75828,9 +76687,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75828
76687
|
|
|
75829
76688
|
/**
|
|
75830
76689
|
* Update a Widget deployment
|
|
75831
|
-
*
|
|
76690
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75832
76691
|
* @param {String} deploymentId Widget Config Id
|
|
75833
76692
|
* @param {Object} body Deployment
|
|
76693
|
+
* @deprecated
|
|
75834
76694
|
*/
|
|
75835
76695
|
putWidgetsDeployment(deploymentId, body) {
|
|
75836
76696
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75862,7 +76722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75862
76722
|
/**
|
|
75863
76723
|
* WorkforceManagement service.
|
|
75864
76724
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
75865
|
-
* @version
|
|
76725
|
+
* @version 218.1.0
|
|
75866
76726
|
*/
|
|
75867
76727
|
|
|
75868
76728
|
/**
|
|
@@ -83255,7 +84115,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83255
84115
|
* </pre>
|
|
83256
84116
|
* </p>
|
|
83257
84117
|
* @module purecloud-platform-client-v2/index
|
|
83258
|
-
* @version
|
|
84118
|
+
* @version 218.1.0
|
|
83259
84119
|
*/
|
|
83260
84120
|
class platformClient {
|
|
83261
84121
|
constructor() {
|