purecloud-platform-client-v2 217.0.0 → 218.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +805 -195
- package/dist/web-amd/purecloud-platform-client-v2.js +805 -195
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +275 -152
- package/dist/web-cjs/purecloud-platform-client-v2.js +275 -152
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +606 -72
- 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 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -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 +214 -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 +1 -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 +1 -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 +1 -1
- 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 +3 -2
- 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 +1 -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.0.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.0.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.0.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.0.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.0.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.0.0
|
|
3219
3219
|
*/
|
|
3220
3220
|
|
|
3221
3221
|
/**
|
|
@@ -6039,7 +6039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6039
6039
|
/**
|
|
6040
6040
|
* Architect service.
|
|
6041
6041
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6042
|
-
* @version
|
|
6042
|
+
* @version 218.0.0
|
|
6043
6043
|
*/
|
|
6044
6044
|
|
|
6045
6045
|
/**
|
|
@@ -10272,7 +10272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10272
10272
|
/**
|
|
10273
10273
|
* Audit service.
|
|
10274
10274
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10275
|
-
* @version
|
|
10275
|
+
* @version 218.0.0
|
|
10276
10276
|
*/
|
|
10277
10277
|
|
|
10278
10278
|
/**
|
|
@@ -10473,7 +10473,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10473
10473
|
/**
|
|
10474
10474
|
* Authorization service.
|
|
10475
10475
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10476
|
-
* @version
|
|
10476
|
+
* @version 218.0.0
|
|
10477
10477
|
*/
|
|
10478
10478
|
|
|
10479
10479
|
/**
|
|
@@ -12135,7 +12135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12135
12135
|
/**
|
|
12136
12136
|
* Billing service.
|
|
12137
12137
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12138
|
-
* @version
|
|
12138
|
+
* @version 218.0.0
|
|
12139
12139
|
*/
|
|
12140
12140
|
|
|
12141
12141
|
/**
|
|
@@ -12215,7 +12215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12215
12215
|
/**
|
|
12216
12216
|
* CarrierServices service.
|
|
12217
12217
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12218
|
-
* @version
|
|
12218
|
+
* @version 218.0.0
|
|
12219
12219
|
*/
|
|
12220
12220
|
|
|
12221
12221
|
/**
|
|
@@ -12285,7 +12285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12285
12285
|
/**
|
|
12286
12286
|
* Chat service.
|
|
12287
12287
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12288
|
-
* @version
|
|
12288
|
+
* @version 218.0.0
|
|
12289
12289
|
*/
|
|
12290
12290
|
|
|
12291
12291
|
/**
|
|
@@ -12425,7 +12425,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12425
12425
|
*
|
|
12426
12426
|
* @param {String} userId userId
|
|
12427
12427
|
* @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
12428
|
*/
|
|
12430
12429
|
deleteChatsUserMessagesPin(userId, pinnedMessageId) {
|
|
12431
12430
|
// verify the required parameter 'userId' is set
|
|
@@ -12672,7 +12671,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12672
12671
|
* Get information for a 1on1
|
|
12673
12672
|
*
|
|
12674
12673
|
* @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
12674
|
*/
|
|
12677
12675
|
getChatsUser(userId) {
|
|
12678
12676
|
// verify the required parameter 'userId' is set
|
|
@@ -13130,7 +13128,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13130
13128
|
*
|
|
13131
13129
|
* @param {String} userId userId
|
|
13132
13130
|
* @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
13131
|
*/
|
|
13135
13132
|
postChatsUserMessagesPins(userId, body) {
|
|
13136
13133
|
// verify the required parameter 'userId' is set
|
|
@@ -13217,7 +13214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13217
13214
|
/**
|
|
13218
13215
|
* Coaching service.
|
|
13219
13216
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13220
|
-
* @version
|
|
13217
|
+
* @version 218.0.0
|
|
13221
13218
|
*/
|
|
13222
13219
|
|
|
13223
13220
|
/**
|
|
@@ -13794,7 +13791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13794
13791
|
/**
|
|
13795
13792
|
* ContentManagement service.
|
|
13796
13793
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13797
|
-
* @version
|
|
13794
|
+
* @version 218.0.0
|
|
13798
13795
|
*/
|
|
13799
13796
|
|
|
13800
13797
|
/**
|
|
@@ -14875,7 +14872,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14875
14872
|
/**
|
|
14876
14873
|
* Conversations service.
|
|
14877
14874
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14878
|
-
* @version
|
|
14875
|
+
* @version 218.0.0
|
|
14879
14876
|
*/
|
|
14880
14877
|
|
|
14881
14878
|
/**
|
|
@@ -15140,6 +15137,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15140
15137
|
);
|
|
15141
15138
|
}
|
|
15142
15139
|
|
|
15140
|
+
/**
|
|
15141
|
+
* Delete Twitter messaging integration
|
|
15142
|
+
*
|
|
15143
|
+
* @param {String} integrationId Integration ID
|
|
15144
|
+
*/
|
|
15145
|
+
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
15146
|
+
// verify the required parameter 'integrationId' is set
|
|
15147
|
+
if (integrationId === undefined || integrationId === null) {
|
|
15148
|
+
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
15149
|
+
}
|
|
15150
|
+
|
|
15151
|
+
return this.apiClient.callApi(
|
|
15152
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
15153
|
+
'DELETE',
|
|
15154
|
+
{ 'integrationId': integrationId },
|
|
15155
|
+
{ },
|
|
15156
|
+
{ },
|
|
15157
|
+
{ },
|
|
15158
|
+
null,
|
|
15159
|
+
['PureCloud OAuth'],
|
|
15160
|
+
['application/json'],
|
|
15161
|
+
['application/json']
|
|
15162
|
+
);
|
|
15163
|
+
}
|
|
15164
|
+
|
|
15143
15165
|
/**
|
|
15144
15166
|
* Delete a WhatsApp messaging integration
|
|
15145
15167
|
*
|
|
@@ -17130,6 +17152,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17130
17152
|
);
|
|
17131
17153
|
}
|
|
17132
17154
|
|
|
17155
|
+
/**
|
|
17156
|
+
* Get twitter oauth settings to patch an integration
|
|
17157
|
+
*
|
|
17158
|
+
* @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
|
|
17159
|
+
*/
|
|
17160
|
+
getConversationsMessagingIntegrationTwitterOauthSettings(integrationId) {
|
|
17161
|
+
// verify the required parameter 'integrationId' is set
|
|
17162
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17163
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationTwitterOauthSettings';
|
|
17164
|
+
}
|
|
17165
|
+
|
|
17166
|
+
return this.apiClient.callApi(
|
|
17167
|
+
'/api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings',
|
|
17168
|
+
'GET',
|
|
17169
|
+
{ 'integrationId': integrationId },
|
|
17170
|
+
{ },
|
|
17171
|
+
{ },
|
|
17172
|
+
{ },
|
|
17173
|
+
null,
|
|
17174
|
+
['PureCloud OAuth'],
|
|
17175
|
+
['application/json'],
|
|
17176
|
+
['application/json']
|
|
17177
|
+
);
|
|
17178
|
+
}
|
|
17179
|
+
|
|
17133
17180
|
/**
|
|
17134
17181
|
* Get a list of Integrations
|
|
17135
17182
|
*
|
|
@@ -17329,6 +17376,83 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17329
17376
|
);
|
|
17330
17377
|
}
|
|
17331
17378
|
|
|
17379
|
+
/**
|
|
17380
|
+
* Get a list of Twitter Integrations
|
|
17381
|
+
*
|
|
17382
|
+
* @param {Object} opts Optional parameters
|
|
17383
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
17384
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17385
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
17386
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
17387
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
17388
|
+
*/
|
|
17389
|
+
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
17390
|
+
opts = opts || {};
|
|
17391
|
+
|
|
17392
|
+
|
|
17393
|
+
return this.apiClient.callApi(
|
|
17394
|
+
'/api/v2/conversations/messaging/integrations/twitter',
|
|
17395
|
+
'GET',
|
|
17396
|
+
{ },
|
|
17397
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
17398
|
+
{ },
|
|
17399
|
+
{ },
|
|
17400
|
+
null,
|
|
17401
|
+
['PureCloud OAuth'],
|
|
17402
|
+
['application/json'],
|
|
17403
|
+
['application/json']
|
|
17404
|
+
);
|
|
17405
|
+
}
|
|
17406
|
+
|
|
17407
|
+
/**
|
|
17408
|
+
* Get Twitter messaging integration
|
|
17409
|
+
*
|
|
17410
|
+
* @param {String} integrationId Integration ID
|
|
17411
|
+
* @param {Object} opts Optional parameters
|
|
17412
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
17413
|
+
*/
|
|
17414
|
+
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
17415
|
+
opts = opts || {};
|
|
17416
|
+
|
|
17417
|
+
// verify the required parameter 'integrationId' is set
|
|
17418
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17419
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
17420
|
+
}
|
|
17421
|
+
|
|
17422
|
+
return this.apiClient.callApi(
|
|
17423
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
17424
|
+
'GET',
|
|
17425
|
+
{ 'integrationId': integrationId },
|
|
17426
|
+
{ 'expand': opts['expand'] },
|
|
17427
|
+
{ },
|
|
17428
|
+
{ },
|
|
17429
|
+
null,
|
|
17430
|
+
['PureCloud OAuth'],
|
|
17431
|
+
['application/json'],
|
|
17432
|
+
['application/json']
|
|
17433
|
+
);
|
|
17434
|
+
}
|
|
17435
|
+
|
|
17436
|
+
/**
|
|
17437
|
+
* Get twitter oauth settings
|
|
17438
|
+
*
|
|
17439
|
+
*/
|
|
17440
|
+
getConversationsMessagingIntegrationsTwitterOauthSettings() {
|
|
17441
|
+
|
|
17442
|
+
return this.apiClient.callApi(
|
|
17443
|
+
'/api/v2/conversations/messaging/integrations/twitter/oauth/settings',
|
|
17444
|
+
'GET',
|
|
17445
|
+
{ },
|
|
17446
|
+
{ },
|
|
17447
|
+
{ },
|
|
17448
|
+
{ },
|
|
17449
|
+
null,
|
|
17450
|
+
['PureCloud OAuth'],
|
|
17451
|
+
['application/json'],
|
|
17452
|
+
['application/json']
|
|
17453
|
+
);
|
|
17454
|
+
}
|
|
17455
|
+
|
|
17332
17456
|
/**
|
|
17333
17457
|
* Get a list of WhatsApp Integrations
|
|
17334
17458
|
*
|
|
@@ -18966,6 +19090,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18966
19090
|
);
|
|
18967
19091
|
}
|
|
18968
19092
|
|
|
19093
|
+
/**
|
|
19094
|
+
* Update a Twitter messaging integration
|
|
19095
|
+
*
|
|
19096
|
+
* @param {String} integrationId Integration ID
|
|
19097
|
+
* @param {Object} body TwitterIntegrationUpdateRequest
|
|
19098
|
+
*/
|
|
19099
|
+
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
19100
|
+
// verify the required parameter 'integrationId' is set
|
|
19101
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19102
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
19103
|
+
}
|
|
19104
|
+
// verify the required parameter 'body' is set
|
|
19105
|
+
if (body === undefined || body === null) {
|
|
19106
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
19107
|
+
}
|
|
19108
|
+
|
|
19109
|
+
return this.apiClient.callApi(
|
|
19110
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
19111
|
+
'PATCH',
|
|
19112
|
+
{ 'integrationId': integrationId },
|
|
19113
|
+
{ },
|
|
19114
|
+
{ },
|
|
19115
|
+
{ },
|
|
19116
|
+
body,
|
|
19117
|
+
['PureCloud OAuth'],
|
|
19118
|
+
['application/json'],
|
|
19119
|
+
['application/json']
|
|
19120
|
+
);
|
|
19121
|
+
}
|
|
19122
|
+
|
|
18969
19123
|
/**
|
|
18970
19124
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
18971
19125
|
* 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 +21456,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21302
21456
|
);
|
|
21303
21457
|
}
|
|
21304
21458
|
|
|
21459
|
+
/**
|
|
21460
|
+
* Create Twitter Integration
|
|
21461
|
+
*
|
|
21462
|
+
* @param {Object} body TwitterIntegrationRequest
|
|
21463
|
+
*/
|
|
21464
|
+
postConversationsMessagingIntegrationsTwitter(body) {
|
|
21465
|
+
// verify the required parameter 'body' is set
|
|
21466
|
+
if (body === undefined || body === null) {
|
|
21467
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
21468
|
+
}
|
|
21469
|
+
|
|
21470
|
+
return this.apiClient.callApi(
|
|
21471
|
+
'/api/v2/conversations/messaging/integrations/twitter',
|
|
21472
|
+
'POST',
|
|
21473
|
+
{ },
|
|
21474
|
+
{ },
|
|
21475
|
+
{ },
|
|
21476
|
+
{ },
|
|
21477
|
+
body,
|
|
21478
|
+
['PureCloud OAuth'],
|
|
21479
|
+
['application/json'],
|
|
21480
|
+
['application/json']
|
|
21481
|
+
);
|
|
21482
|
+
}
|
|
21483
|
+
|
|
21305
21484
|
/**
|
|
21306
21485
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
21307
21486
|
* [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 +21686,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21507
21686
|
);
|
|
21508
21687
|
}
|
|
21509
21688
|
|
|
21689
|
+
/**
|
|
21690
|
+
* Create an Agent-Type video conference and assign an agent to it
|
|
21691
|
+
*
|
|
21692
|
+
* @param {String} conversationId conversationId
|
|
21693
|
+
* @param {String} communicationId communicationId
|
|
21694
|
+
* postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21695
|
+
*/
|
|
21696
|
+
postConversationsVideoAgentconferenceCommunication(conversationId, communicationId) {
|
|
21697
|
+
// verify the required parameter 'conversationId' is set
|
|
21698
|
+
if (conversationId === undefined || conversationId === null) {
|
|
21699
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';
|
|
21700
|
+
}
|
|
21701
|
+
// verify the required parameter 'communicationId' is set
|
|
21702
|
+
if (communicationId === undefined || communicationId === null) {
|
|
21703
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoAgentconferenceCommunication';
|
|
21704
|
+
}
|
|
21705
|
+
|
|
21706
|
+
return this.apiClient.callApi(
|
|
21707
|
+
'/api/v2/conversations/videos/{conversationId}/agentconference/communications/{communicationId}',
|
|
21708
|
+
'POST',
|
|
21709
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
21710
|
+
{ },
|
|
21711
|
+
{ },
|
|
21712
|
+
{ },
|
|
21713
|
+
null,
|
|
21714
|
+
['PureCloud OAuth'],
|
|
21715
|
+
['application/json'],
|
|
21716
|
+
['application/json']
|
|
21717
|
+
);
|
|
21718
|
+
}
|
|
21719
|
+
|
|
21510
21720
|
/**
|
|
21511
21721
|
* Apply wrap-up for this conversation communication
|
|
21512
21722
|
*
|
|
@@ -22209,7 +22419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22209
22419
|
/**
|
|
22210
22420
|
* DataExtensions service.
|
|
22211
22421
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22212
|
-
* @version
|
|
22422
|
+
* @version 218.0.0
|
|
22213
22423
|
*/
|
|
22214
22424
|
|
|
22215
22425
|
/**
|
|
@@ -22295,7 +22505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22295
22505
|
/**
|
|
22296
22506
|
* DataPrivacy service.
|
|
22297
22507
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22298
|
-
* @version
|
|
22508
|
+
* @version 218.0.0
|
|
22299
22509
|
*/
|
|
22300
22510
|
|
|
22301
22511
|
/**
|
|
@@ -22465,7 +22675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22465
22675
|
/**
|
|
22466
22676
|
* Downloads service.
|
|
22467
22677
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22468
|
-
* @version
|
|
22678
|
+
* @version 218.0.0
|
|
22469
22679
|
*/
|
|
22470
22680
|
|
|
22471
22681
|
/**
|
|
@@ -22517,7 +22727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22517
22727
|
/**
|
|
22518
22728
|
* Emails service.
|
|
22519
22729
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22520
|
-
* @version
|
|
22730
|
+
* @version 218.0.0
|
|
22521
22731
|
*/
|
|
22522
22732
|
|
|
22523
22733
|
/**
|
|
@@ -22582,7 +22792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22582
22792
|
/**
|
|
22583
22793
|
* EmployeeEngagement service.
|
|
22584
22794
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22585
|
-
* @version
|
|
22795
|
+
* @version 218.0.0
|
|
22586
22796
|
*/
|
|
22587
22797
|
|
|
22588
22798
|
/**
|
|
@@ -22733,7 +22943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22733
22943
|
/**
|
|
22734
22944
|
* Events service.
|
|
22735
22945
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22736
|
-
* @version
|
|
22946
|
+
* @version 218.0.0
|
|
22737
22947
|
*/
|
|
22738
22948
|
|
|
22739
22949
|
/**
|
|
@@ -22829,7 +23039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22829
23039
|
/**
|
|
22830
23040
|
* ExternalContacts service.
|
|
22831
23041
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22832
|
-
* @version
|
|
23042
|
+
* @version 218.0.0
|
|
22833
23043
|
*/
|
|
22834
23044
|
|
|
22835
23045
|
/**
|
|
@@ -23313,6 +23523,57 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23313
23523
|
);
|
|
23314
23524
|
}
|
|
23315
23525
|
|
|
23526
|
+
/**
|
|
23527
|
+
* Get export for exportId
|
|
23528
|
+
*
|
|
23529
|
+
* @param {String} exportId Export id
|
|
23530
|
+
*/
|
|
23531
|
+
getExternalcontactsContactsExport(exportId) {
|
|
23532
|
+
// verify the required parameter 'exportId' is set
|
|
23533
|
+
if (exportId === undefined || exportId === null) {
|
|
23534
|
+
throw 'Missing the required parameter "exportId" when calling getExternalcontactsContactsExport';
|
|
23535
|
+
}
|
|
23536
|
+
|
|
23537
|
+
return this.apiClient.callApi(
|
|
23538
|
+
'/api/v2/externalcontacts/contacts/exports/{exportId}',
|
|
23539
|
+
'GET',
|
|
23540
|
+
{ 'exportId': exportId },
|
|
23541
|
+
{ },
|
|
23542
|
+
{ },
|
|
23543
|
+
{ },
|
|
23544
|
+
null,
|
|
23545
|
+
['PureCloud OAuth'],
|
|
23546
|
+
['application/json'],
|
|
23547
|
+
['application/json']
|
|
23548
|
+
);
|
|
23549
|
+
}
|
|
23550
|
+
|
|
23551
|
+
/**
|
|
23552
|
+
* List exports for organization
|
|
23553
|
+
*
|
|
23554
|
+
* @param {Object} opts Optional parameters
|
|
23555
|
+
* @param {Array.<String>} opts.divisionIds Division IDs of entities
|
|
23556
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities
|
|
23557
|
+
* @param {Number} opts.pageSize Number of entities to return
|
|
23558
|
+
*/
|
|
23559
|
+
getExternalcontactsContactsExports(opts) {
|
|
23560
|
+
opts = opts || {};
|
|
23561
|
+
|
|
23562
|
+
|
|
23563
|
+
return this.apiClient.callApi(
|
|
23564
|
+
'/api/v2/externalcontacts/contacts/exports',
|
|
23565
|
+
'GET',
|
|
23566
|
+
{ },
|
|
23567
|
+
{ 'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
23568
|
+
{ },
|
|
23569
|
+
{ },
|
|
23570
|
+
null,
|
|
23571
|
+
['PureCloud OAuth'],
|
|
23572
|
+
['application/json'],
|
|
23573
|
+
['application/json']
|
|
23574
|
+
);
|
|
23575
|
+
}
|
|
23576
|
+
|
|
23316
23577
|
/**
|
|
23317
23578
|
* Get a schema
|
|
23318
23579
|
*
|
|
@@ -24821,6 +25082,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24821
25082
|
);
|
|
24822
25083
|
}
|
|
24823
25084
|
|
|
25085
|
+
/**
|
|
25086
|
+
* Create bulk export
|
|
25087
|
+
*
|
|
25088
|
+
* @param {Object} body Export
|
|
25089
|
+
*/
|
|
25090
|
+
postExternalcontactsContactsExports(body) {
|
|
25091
|
+
// verify the required parameter 'body' is set
|
|
25092
|
+
if (body === undefined || body === null) {
|
|
25093
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsExports';
|
|
25094
|
+
}
|
|
25095
|
+
|
|
25096
|
+
return this.apiClient.callApi(
|
|
25097
|
+
'/api/v2/externalcontacts/contacts/exports',
|
|
25098
|
+
'POST',
|
|
25099
|
+
{ },
|
|
25100
|
+
{ },
|
|
25101
|
+
{ },
|
|
25102
|
+
{ },
|
|
25103
|
+
body,
|
|
25104
|
+
['PureCloud OAuth'],
|
|
25105
|
+
['application/json'],
|
|
25106
|
+
['application/json']
|
|
25107
|
+
);
|
|
25108
|
+
}
|
|
25109
|
+
|
|
24824
25110
|
/**
|
|
24825
25111
|
* Create a schema
|
|
24826
25112
|
*
|
|
@@ -25562,7 +25848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25562
25848
|
/**
|
|
25563
25849
|
* Fax service.
|
|
25564
25850
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25565
|
-
* @version
|
|
25851
|
+
* @version 218.0.0
|
|
25566
25852
|
*/
|
|
25567
25853
|
|
|
25568
25854
|
/**
|
|
@@ -25777,7 +26063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25777
26063
|
/**
|
|
25778
26064
|
* Flows service.
|
|
25779
26065
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25780
|
-
* @version
|
|
26066
|
+
* @version 218.0.0
|
|
25781
26067
|
*/
|
|
25782
26068
|
|
|
25783
26069
|
/**
|
|
@@ -25960,7 +26246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25960
26246
|
/**
|
|
25961
26247
|
* Gamification service.
|
|
25962
26248
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25963
|
-
* @version
|
|
26249
|
+
* @version 218.0.0
|
|
25964
26250
|
*/
|
|
25965
26251
|
|
|
25966
26252
|
/**
|
|
@@ -28102,7 +28388,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28102
28388
|
/**
|
|
28103
28389
|
* GeneralDataProtectionRegulation service.
|
|
28104
28390
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
28105
|
-
* @version
|
|
28391
|
+
* @version 218.0.0
|
|
28106
28392
|
*/
|
|
28107
28393
|
|
|
28108
28394
|
/**
|
|
@@ -28232,7 +28518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28232
28518
|
/**
|
|
28233
28519
|
* Geolocation service.
|
|
28234
28520
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
28235
|
-
* @version
|
|
28521
|
+
* @version 218.0.0
|
|
28236
28522
|
*/
|
|
28237
28523
|
|
|
28238
28524
|
/**
|
|
@@ -28363,7 +28649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28363
28649
|
/**
|
|
28364
28650
|
* Greetings service.
|
|
28365
28651
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
28366
|
-
* @version
|
|
28652
|
+
* @version 218.0.0
|
|
28367
28653
|
*/
|
|
28368
28654
|
|
|
28369
28655
|
/**
|
|
@@ -28818,7 +29104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28818
29104
|
/**
|
|
28819
29105
|
* Groups service.
|
|
28820
29106
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28821
|
-
* @version
|
|
29107
|
+
* @version 218.0.0
|
|
28822
29108
|
*/
|
|
28823
29109
|
|
|
28824
29110
|
/**
|
|
@@ -29337,7 +29623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29337
29623
|
/**
|
|
29338
29624
|
* IdentityProvider service.
|
|
29339
29625
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
29340
|
-
* @version
|
|
29626
|
+
* @version 218.0.0
|
|
29341
29627
|
*/
|
|
29342
29628
|
|
|
29343
29629
|
/**
|
|
@@ -30198,7 +30484,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30198
30484
|
/**
|
|
30199
30485
|
* InfrastructureAsCode service.
|
|
30200
30486
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
30201
|
-
* @version
|
|
30487
|
+
* @version 218.0.0
|
|
30202
30488
|
*/
|
|
30203
30489
|
|
|
30204
30490
|
/**
|
|
@@ -30365,7 +30651,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30365
30651
|
/**
|
|
30366
30652
|
* Integrations service.
|
|
30367
30653
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
30368
|
-
* @version
|
|
30654
|
+
* @version 218.0.0
|
|
30369
30655
|
*/
|
|
30370
30656
|
|
|
30371
30657
|
/**
|
|
@@ -32804,7 +33090,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32804
33090
|
/**
|
|
32805
33091
|
* Journey service.
|
|
32806
33092
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
32807
|
-
* @version
|
|
33093
|
+
* @version 218.0.0
|
|
32808
33094
|
*/
|
|
32809
33095
|
|
|
32810
33096
|
/**
|
|
@@ -34789,7 +35075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34789
35075
|
/**
|
|
34790
35076
|
* Knowledge service.
|
|
34791
35077
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
34792
|
-
* @version
|
|
35078
|
+
* @version 218.0.0
|
|
34793
35079
|
*/
|
|
34794
35080
|
|
|
34795
35081
|
/**
|
|
@@ -36064,7 +36350,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36064
36350
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
36065
36351
|
* @param {String} uploadId UploadId
|
|
36066
36352
|
* @deprecated
|
|
36067
|
-
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36068
36353
|
*/
|
|
36069
36354
|
getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
|
|
36070
36355
|
// verify the required parameter 'documentId' is set
|
|
@@ -37770,7 +38055,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37770
38055
|
*
|
|
37771
38056
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37772
38057
|
* @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
38058
|
*/
|
|
37775
38059
|
postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
|
|
37776
38060
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37801,7 +38085,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37801
38085
|
*
|
|
37802
38086
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37803
38087
|
* @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
38088
|
*/
|
|
37806
38089
|
postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
|
|
37807
38090
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37950,7 +38233,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37950
38233
|
*
|
|
37951
38234
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37952
38235
|
* @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
38236
|
*/
|
|
37955
38237
|
postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
|
|
37956
38238
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38110,7 +38392,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38110
38392
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
38111
38393
|
* @param {Object} body
|
|
38112
38394
|
* @deprecated
|
|
38113
|
-
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38114
38395
|
*/
|
|
38115
38396
|
postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
|
|
38116
38397
|
// verify the required parameter 'documentId' is set
|
|
@@ -38667,7 +38948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38667
38948
|
/**
|
|
38668
38949
|
* LanguageUnderstanding service.
|
|
38669
38950
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38670
|
-
* @version
|
|
38951
|
+
* @version 218.0.0
|
|
38671
38952
|
*/
|
|
38672
38953
|
|
|
38673
38954
|
/**
|
|
@@ -39700,7 +39981,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39700
39981
|
/**
|
|
39701
39982
|
* Languages service.
|
|
39702
39983
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39703
|
-
* @version
|
|
39984
|
+
* @version 218.0.0
|
|
39704
39985
|
*/
|
|
39705
39986
|
|
|
39706
39987
|
/**
|
|
@@ -39922,7 +40203,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39922
40203
|
/**
|
|
39923
40204
|
* Learning service.
|
|
39924
40205
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39925
|
-
* @version
|
|
40206
|
+
* @version 218.0.0
|
|
39926
40207
|
*/
|
|
39927
40208
|
|
|
39928
40209
|
/**
|
|
@@ -40951,7 +41232,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40951
41232
|
/**
|
|
40952
41233
|
* License service.
|
|
40953
41234
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40954
|
-
* @version
|
|
41235
|
+
* @version 218.0.0
|
|
40955
41236
|
*/
|
|
40956
41237
|
|
|
40957
41238
|
/**
|
|
@@ -41189,7 +41470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41189
41470
|
/**
|
|
41190
41471
|
* Locations service.
|
|
41191
41472
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41192
|
-
* @version
|
|
41473
|
+
* @version 218.0.0
|
|
41193
41474
|
*/
|
|
41194
41475
|
|
|
41195
41476
|
/**
|
|
@@ -41425,7 +41706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41425
41706
|
/**
|
|
41426
41707
|
* LogCapture service.
|
|
41427
41708
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
41428
|
-
* @version
|
|
41709
|
+
* @version 218.0.0
|
|
41429
41710
|
*/
|
|
41430
41711
|
|
|
41431
41712
|
/**
|
|
@@ -41625,7 +41906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41625
41906
|
/**
|
|
41626
41907
|
* Messaging service.
|
|
41627
41908
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
41628
|
-
* @version
|
|
41909
|
+
* @version 218.0.0
|
|
41629
41910
|
*/
|
|
41630
41911
|
|
|
41631
41912
|
/**
|
|
@@ -41984,7 +42265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41984
42265
|
/**
|
|
41985
42266
|
* MobileDevices service.
|
|
41986
42267
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41987
|
-
* @version
|
|
42268
|
+
* @version 218.0.0
|
|
41988
42269
|
*/
|
|
41989
42270
|
|
|
41990
42271
|
/**
|
|
@@ -42135,7 +42416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42135
42416
|
/**
|
|
42136
42417
|
* Notifications service.
|
|
42137
42418
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
42138
|
-
* @version
|
|
42419
|
+
* @version 218.0.0
|
|
42139
42420
|
*/
|
|
42140
42421
|
|
|
42141
42422
|
/**
|
|
@@ -42368,7 +42649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42368
42649
|
/**
|
|
42369
42650
|
* OAuth service.
|
|
42370
42651
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42371
|
-
* @version
|
|
42652
|
+
* @version 218.0.0
|
|
42372
42653
|
*/
|
|
42373
42654
|
|
|
42374
42655
|
/**
|
|
@@ -42734,7 +43015,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42734
43015
|
/**
|
|
42735
43016
|
* Objects service.
|
|
42736
43017
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
42737
|
-
* @version
|
|
43018
|
+
* @version 218.0.0
|
|
42738
43019
|
*/
|
|
42739
43020
|
|
|
42740
43021
|
/**
|
|
@@ -43005,7 +43286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43005
43286
|
/**
|
|
43006
43287
|
* OperationalEvents service.
|
|
43007
43288
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
43008
|
-
* @version
|
|
43289
|
+
* @version 218.0.0
|
|
43009
43290
|
*/
|
|
43010
43291
|
|
|
43011
43292
|
/**
|
|
@@ -43122,7 +43403,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43122
43403
|
/**
|
|
43123
43404
|
* Organization service.
|
|
43124
43405
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
43125
|
-
* @version
|
|
43406
|
+
* @version 218.0.0
|
|
43126
43407
|
*/
|
|
43127
43408
|
|
|
43128
43409
|
/**
|
|
@@ -43343,38 +43624,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43343
43624
|
);
|
|
43344
43625
|
}
|
|
43345
43626
|
|
|
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
43627
|
/**
|
|
43379
43628
|
* Get the default limits in a namespace for an organization
|
|
43380
43629
|
*
|
|
@@ -43400,43 +43649,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43400
43649
|
);
|
|
43401
43650
|
}
|
|
43402
43651
|
|
|
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
43652
|
/**
|
|
43441
43653
|
* Get the available limit namespaces
|
|
43442
43654
|
*
|
|
@@ -43666,7 +43878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43666
43878
|
/**
|
|
43667
43879
|
* OrganizationAuthorization service.
|
|
43668
43880
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43669
|
-
* @version
|
|
43881
|
+
* @version 218.0.0
|
|
43670
43882
|
*/
|
|
43671
43883
|
|
|
43672
43884
|
/**
|
|
@@ -45060,7 +45272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45060
45272
|
/**
|
|
45061
45273
|
* Outbound service.
|
|
45062
45274
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
45063
|
-
* @version
|
|
45275
|
+
* @version 218.0.0
|
|
45064
45276
|
*/
|
|
45065
45277
|
|
|
45066
45278
|
/**
|
|
@@ -49623,7 +49835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49623
49835
|
/**
|
|
49624
49836
|
* Presence service.
|
|
49625
49837
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
49626
|
-
* @version
|
|
49838
|
+
* @version 218.0.0
|
|
49627
49839
|
*/
|
|
49628
49840
|
|
|
49629
49841
|
/**
|
|
@@ -50367,7 +50579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50367
50579
|
/**
|
|
50368
50580
|
* ProcessAutomation service.
|
|
50369
50581
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
50370
|
-
* @version
|
|
50582
|
+
* @version 218.0.0
|
|
50371
50583
|
*/
|
|
50372
50584
|
|
|
50373
50585
|
/**
|
|
@@ -50606,7 +50818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50606
50818
|
/**
|
|
50607
50819
|
* Quality service.
|
|
50608
50820
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
50609
|
-
* @version
|
|
50821
|
+
* @version 218.0.0
|
|
50610
50822
|
*/
|
|
50611
50823
|
|
|
50612
50824
|
/**
|
|
@@ -52302,7 +52514,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52302
52514
|
*
|
|
52303
52515
|
* @param {String} formId Form ID
|
|
52304
52516
|
* @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
52517
|
*/
|
|
52307
52518
|
putQualityFormsEvaluationAiscoringSettings(formId, body) {
|
|
52308
52519
|
// verify the required parameter 'formId' is set
|
|
@@ -52394,7 +52605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52394
52605
|
/**
|
|
52395
52606
|
* Recording service.
|
|
52396
52607
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
52397
|
-
* @version
|
|
52608
|
+
* @version 218.0.0
|
|
52398
52609
|
*/
|
|
52399
52610
|
|
|
52400
52611
|
/**
|
|
@@ -52764,6 +52975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52764
52975
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
52765
52976
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
52766
52977
|
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
52978
|
+
* @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
|
|
52767
52979
|
*/
|
|
52768
52980
|
getConversationRecordings(conversationId, opts) {
|
|
52769
52981
|
opts = opts || {};
|
|
@@ -52777,7 +52989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52777
52989
|
'/api/v2/conversations/{conversationId}/recordings',
|
|
52778
52990
|
'GET',
|
|
52779
52991
|
{ 'conversationId': conversationId },
|
|
52780
|
-
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'] },
|
|
52992
|
+
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'],'includePauseAnnotationsForScreenRecordings': opts['includePauseAnnotationsForScreenRecordings'] },
|
|
52781
52993
|
{ },
|
|
52782
52994
|
{ },
|
|
52783
52995
|
null,
|
|
@@ -53998,7 +54210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53998
54210
|
/**
|
|
53999
54211
|
* ResponseManagement service.
|
|
54000
54212
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
54001
|
-
* @version
|
|
54213
|
+
* @version 218.0.0
|
|
54002
54214
|
*/
|
|
54003
54215
|
|
|
54004
54216
|
/**
|
|
@@ -54508,7 +54720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54508
54720
|
/**
|
|
54509
54721
|
* Routing service.
|
|
54510
54722
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54511
|
-
* @version
|
|
54723
|
+
* @version 218.0.0
|
|
54512
54724
|
*/
|
|
54513
54725
|
|
|
54514
54726
|
/**
|
|
@@ -58811,7 +59023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58811
59023
|
/**
|
|
58812
59024
|
* SCIM service.
|
|
58813
59025
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
58814
|
-
* @version
|
|
59026
|
+
* @version 218.0.0
|
|
58815
59027
|
*/
|
|
58816
59028
|
|
|
58817
59029
|
/**
|
|
@@ -59688,7 +59900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59688
59900
|
/**
|
|
59689
59901
|
* ScreenRecording service.
|
|
59690
59902
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
59691
|
-
* @version
|
|
59903
|
+
* @version 218.0.0
|
|
59692
59904
|
*/
|
|
59693
59905
|
|
|
59694
59906
|
/**
|
|
@@ -59733,7 +59945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59733
59945
|
/**
|
|
59734
59946
|
* Scripts service.
|
|
59735
59947
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
59736
|
-
* @version
|
|
59948
|
+
* @version 218.0.0
|
|
59737
59949
|
*/
|
|
59738
59950
|
|
|
59739
59951
|
/**
|
|
@@ -60177,7 +60389,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60177
60389
|
/**
|
|
60178
60390
|
* Search service.
|
|
60179
60391
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
60180
|
-
* @version
|
|
60392
|
+
* @version 218.0.0
|
|
60181
60393
|
*/
|
|
60182
60394
|
|
|
60183
60395
|
/**
|
|
@@ -60920,7 +61132,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60920
61132
|
/**
|
|
60921
61133
|
* Settings service.
|
|
60922
61134
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
60923
|
-
* @version
|
|
61135
|
+
* @version 218.0.0
|
|
60924
61136
|
*/
|
|
60925
61137
|
|
|
60926
61138
|
/**
|
|
@@ -61140,7 +61352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61140
61352
|
/**
|
|
61141
61353
|
* SocialMedia service.
|
|
61142
61354
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
61143
|
-
* @version
|
|
61355
|
+
* @version 218.0.0
|
|
61144
61356
|
*/
|
|
61145
61357
|
|
|
61146
61358
|
/**
|
|
@@ -61155,13 +61367,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61155
61367
|
}
|
|
61156
61368
|
|
|
61157
61369
|
|
|
61370
|
+
/**
|
|
61371
|
+
* Delete an escalation rule.
|
|
61372
|
+
*
|
|
61373
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
61374
|
+
*/
|
|
61375
|
+
deleteSocialmediaEscalationrule(escalationRuleId) {
|
|
61376
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
61377
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
61378
|
+
throw 'Missing the required parameter "escalationRuleId" when calling deleteSocialmediaEscalationrule';
|
|
61379
|
+
}
|
|
61380
|
+
|
|
61381
|
+
return this.apiClient.callApi(
|
|
61382
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
61383
|
+
'DELETE',
|
|
61384
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
61385
|
+
{ },
|
|
61386
|
+
{ },
|
|
61387
|
+
{ },
|
|
61388
|
+
null,
|
|
61389
|
+
['PureCloud OAuth'],
|
|
61390
|
+
['application/json'],
|
|
61391
|
+
['application/json']
|
|
61392
|
+
);
|
|
61393
|
+
}
|
|
61394
|
+
|
|
61395
|
+
/**
|
|
61396
|
+
* Delete a social media message.
|
|
61397
|
+
*
|
|
61398
|
+
* @param {String} messageId messageId
|
|
61399
|
+
* deleteSocialmediaMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61400
|
+
*/
|
|
61401
|
+
deleteSocialmediaMessage(messageId) {
|
|
61402
|
+
// verify the required parameter 'messageId' is set
|
|
61403
|
+
if (messageId === undefined || messageId === null) {
|
|
61404
|
+
throw 'Missing the required parameter "messageId" when calling deleteSocialmediaMessage';
|
|
61405
|
+
}
|
|
61406
|
+
|
|
61407
|
+
return this.apiClient.callApi(
|
|
61408
|
+
'/api/v2/socialmedia/messages/{messageId}',
|
|
61409
|
+
'DELETE',
|
|
61410
|
+
{ 'messageId': messageId },
|
|
61411
|
+
{ },
|
|
61412
|
+
{ },
|
|
61413
|
+
{ },
|
|
61414
|
+
null,
|
|
61415
|
+
['PureCloud OAuth'],
|
|
61416
|
+
['application/json'],
|
|
61417
|
+
['application/json']
|
|
61418
|
+
);
|
|
61419
|
+
}
|
|
61420
|
+
|
|
61158
61421
|
/**
|
|
61159
61422
|
* Delete a social topic.
|
|
61160
61423
|
*
|
|
61161
61424
|
* @param {String} topicId topicId
|
|
61162
61425
|
* @param {Object} opts Optional parameters
|
|
61163
61426
|
* @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
61427
|
*/
|
|
61166
61428
|
deleteSocialmediaTopic(topicId, opts) {
|
|
61167
61429
|
opts = opts || {};
|
|
@@ -61192,7 +61454,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61192
61454
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61193
61455
|
* @param {Object} opts Optional parameters
|
|
61194
61456
|
* @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
61457
|
*/
|
|
61197
61458
|
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61198
61459
|
opts = opts || {};
|
|
@@ -61262,7 +61523,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61262
61523
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61263
61524
|
* @param {Object} opts Optional parameters
|
|
61264
61525
|
* @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
61526
|
*/
|
|
61267
61527
|
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61268
61528
|
opts = opts || {};
|
|
@@ -61290,13 +61550,175 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61290
61550
|
);
|
|
61291
61551
|
}
|
|
61292
61552
|
|
|
61553
|
+
/**
|
|
61554
|
+
* Get status for async query for social media aggregates
|
|
61555
|
+
*
|
|
61556
|
+
* @param {String} jobId jobId
|
|
61557
|
+
*/
|
|
61558
|
+
getSocialmediaAnalyticsAggregatesJob(jobId) {
|
|
61559
|
+
// verify the required parameter 'jobId' is set
|
|
61560
|
+
if (jobId === undefined || jobId === null) {
|
|
61561
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJob';
|
|
61562
|
+
}
|
|
61563
|
+
|
|
61564
|
+
return this.apiClient.callApi(
|
|
61565
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}',
|
|
61566
|
+
'GET',
|
|
61567
|
+
{ 'jobId': jobId },
|
|
61568
|
+
{ },
|
|
61569
|
+
{ },
|
|
61570
|
+
{ },
|
|
61571
|
+
null,
|
|
61572
|
+
['PureCloud OAuth'],
|
|
61573
|
+
['application/json'],
|
|
61574
|
+
['application/json']
|
|
61575
|
+
);
|
|
61576
|
+
}
|
|
61577
|
+
|
|
61578
|
+
/**
|
|
61579
|
+
* Fetch a page of results for an async social media query
|
|
61580
|
+
*
|
|
61581
|
+
* @param {String} jobId jobId
|
|
61582
|
+
* @param {Object} opts Optional parameters
|
|
61583
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
61584
|
+
*/
|
|
61585
|
+
getSocialmediaAnalyticsAggregatesJobResults(jobId, opts) {
|
|
61586
|
+
opts = opts || {};
|
|
61587
|
+
|
|
61588
|
+
// verify the required parameter 'jobId' is set
|
|
61589
|
+
if (jobId === undefined || jobId === null) {
|
|
61590
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJobResults';
|
|
61591
|
+
}
|
|
61592
|
+
|
|
61593
|
+
return this.apiClient.callApi(
|
|
61594
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results',
|
|
61595
|
+
'GET',
|
|
61596
|
+
{ 'jobId': jobId },
|
|
61597
|
+
{ 'cursor': opts['cursor'] },
|
|
61598
|
+
{ },
|
|
61599
|
+
{ },
|
|
61600
|
+
null,
|
|
61601
|
+
['PureCloud OAuth'],
|
|
61602
|
+
['application/json'],
|
|
61603
|
+
['application/json']
|
|
61604
|
+
);
|
|
61605
|
+
}
|
|
61606
|
+
|
|
61607
|
+
/**
|
|
61608
|
+
* Get status for async query for social media messages job
|
|
61609
|
+
*
|
|
61610
|
+
* @param {String} jobId jobId
|
|
61611
|
+
*/
|
|
61612
|
+
getSocialmediaAnalyticsMessagesJob(jobId) {
|
|
61613
|
+
// verify the required parameter 'jobId' is set
|
|
61614
|
+
if (jobId === undefined || jobId === null) {
|
|
61615
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJob';
|
|
61616
|
+
}
|
|
61617
|
+
|
|
61618
|
+
return this.apiClient.callApi(
|
|
61619
|
+
'/api/v2/socialmedia/analytics/messages/jobs/{jobId}',
|
|
61620
|
+
'GET',
|
|
61621
|
+
{ 'jobId': jobId },
|
|
61622
|
+
{ },
|
|
61623
|
+
{ },
|
|
61624
|
+
{ },
|
|
61625
|
+
null,
|
|
61626
|
+
['PureCloud OAuth'],
|
|
61627
|
+
['application/json'],
|
|
61628
|
+
['application/json']
|
|
61629
|
+
);
|
|
61630
|
+
}
|
|
61631
|
+
|
|
61632
|
+
/**
|
|
61633
|
+
* Fetch a page of results for an async social media messages query
|
|
61634
|
+
*
|
|
61635
|
+
* @param {String} jobId jobId
|
|
61636
|
+
* @param {Object} opts Optional parameters
|
|
61637
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
61638
|
+
*/
|
|
61639
|
+
getSocialmediaAnalyticsMessagesJobResults(jobId, opts) {
|
|
61640
|
+
opts = opts || {};
|
|
61641
|
+
|
|
61642
|
+
// verify the required parameter 'jobId' is set
|
|
61643
|
+
if (jobId === undefined || jobId === null) {
|
|
61644
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJobResults';
|
|
61645
|
+
}
|
|
61646
|
+
|
|
61647
|
+
return this.apiClient.callApi(
|
|
61648
|
+
'/api/v2/socialmedia/analytics/messages/jobs/{jobId}/results',
|
|
61649
|
+
'GET',
|
|
61650
|
+
{ 'jobId': jobId },
|
|
61651
|
+
{ 'cursor': opts['cursor'] },
|
|
61652
|
+
{ },
|
|
61653
|
+
{ },
|
|
61654
|
+
null,
|
|
61655
|
+
['PureCloud OAuth'],
|
|
61656
|
+
['application/json'],
|
|
61657
|
+
['application/json']
|
|
61658
|
+
);
|
|
61659
|
+
}
|
|
61660
|
+
|
|
61661
|
+
/**
|
|
61662
|
+
* Get a single escalation rule.
|
|
61663
|
+
*
|
|
61664
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
61665
|
+
*/
|
|
61666
|
+
getSocialmediaEscalationrule(escalationRuleId) {
|
|
61667
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
61668
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
61669
|
+
throw 'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';
|
|
61670
|
+
}
|
|
61671
|
+
|
|
61672
|
+
return this.apiClient.callApi(
|
|
61673
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
61674
|
+
'GET',
|
|
61675
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
61676
|
+
{ },
|
|
61677
|
+
{ },
|
|
61678
|
+
{ },
|
|
61679
|
+
null,
|
|
61680
|
+
['PureCloud OAuth'],
|
|
61681
|
+
['application/json'],
|
|
61682
|
+
['application/json']
|
|
61683
|
+
);
|
|
61684
|
+
}
|
|
61685
|
+
|
|
61686
|
+
/**
|
|
61687
|
+
* Retrieve all escalation rules for a division.
|
|
61688
|
+
*
|
|
61689
|
+
* @param {String} divisionId One division ID
|
|
61690
|
+
* @param {Object} opts Optional parameters
|
|
61691
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61692
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61693
|
+
*/
|
|
61694
|
+
getSocialmediaEscalationrules(divisionId, opts) {
|
|
61695
|
+
opts = opts || {};
|
|
61696
|
+
|
|
61697
|
+
// verify the required parameter 'divisionId' is set
|
|
61698
|
+
if (divisionId === undefined || divisionId === null) {
|
|
61699
|
+
throw 'Missing the required parameter "divisionId" when calling getSocialmediaEscalationrules';
|
|
61700
|
+
}
|
|
61701
|
+
|
|
61702
|
+
return this.apiClient.callApi(
|
|
61703
|
+
'/api/v2/socialmedia/escalationrules',
|
|
61704
|
+
'GET',
|
|
61705
|
+
{ },
|
|
61706
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionId': divisionId },
|
|
61707
|
+
{ },
|
|
61708
|
+
{ },
|
|
61709
|
+
null,
|
|
61710
|
+
['PureCloud OAuth'],
|
|
61711
|
+
['application/json'],
|
|
61712
|
+
['application/json']
|
|
61713
|
+
);
|
|
61714
|
+
}
|
|
61715
|
+
|
|
61293
61716
|
/**
|
|
61294
61717
|
* Get a single social topic.
|
|
61295
61718
|
*
|
|
61296
61719
|
* @param {String} topicId topicId
|
|
61297
61720
|
* @param {Object} opts Optional parameters
|
|
61298
61721
|
* @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
61722
|
*/
|
|
61301
61723
|
getSocialmediaTopic(topicId, opts) {
|
|
61302
61724
|
opts = opts || {};
|
|
@@ -61320,6 +61742,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61320
61742
|
);
|
|
61321
61743
|
}
|
|
61322
61744
|
|
|
61745
|
+
/**
|
|
61746
|
+
* Retrieve all social topic data ingestion rules with pagination.
|
|
61747
|
+
*
|
|
61748
|
+
* @param {String} topicId topicId
|
|
61749
|
+
* @param {Object} opts Optional parameters
|
|
61750
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61751
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61752
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61753
|
+
*/
|
|
61754
|
+
getSocialmediaTopicDataingestionrules(topicId, opts) {
|
|
61755
|
+
opts = opts || {};
|
|
61756
|
+
|
|
61757
|
+
// verify the required parameter 'topicId' is set
|
|
61758
|
+
if (topicId === undefined || topicId === null) {
|
|
61759
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrules';
|
|
61760
|
+
}
|
|
61761
|
+
|
|
61762
|
+
return this.apiClient.callApi(
|
|
61763
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules',
|
|
61764
|
+
'GET',
|
|
61765
|
+
{ 'topicId': topicId },
|
|
61766
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
61767
|
+
{ },
|
|
61768
|
+
{ },
|
|
61769
|
+
null,
|
|
61770
|
+
['PureCloud OAuth'],
|
|
61771
|
+
['application/json'],
|
|
61772
|
+
['application/json']
|
|
61773
|
+
);
|
|
61774
|
+
}
|
|
61775
|
+
|
|
61323
61776
|
/**
|
|
61324
61777
|
* Get a single Facebook data ingestion rule.
|
|
61325
61778
|
*
|
|
@@ -61327,7 +61780,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61327
61780
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61328
61781
|
* @param {Object} opts Optional parameters
|
|
61329
61782
|
* @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
61783
|
*/
|
|
61332
61784
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61333
61785
|
opts = opts || {};
|
|
@@ -61363,7 +61815,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61363
61815
|
* @param {String} dataIngestionRuleVersion version
|
|
61364
61816
|
* @param {Object} opts Optional parameters
|
|
61365
61817
|
* @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
61818
|
*/
|
|
61368
61819
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
61369
61820
|
opts = opts || {};
|
|
@@ -61404,7 +61855,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61404
61855
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61405
61856
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61406
61857
|
* @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
61858
|
*/
|
|
61409
61859
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
|
|
61410
61860
|
opts = opts || {};
|
|
@@ -61551,7 +62001,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61551
62001
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61552
62002
|
* @param {Object} opts Optional parameters
|
|
61553
62003
|
* @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
62004
|
*/
|
|
61556
62005
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61557
62006
|
opts = opts || {};
|
|
@@ -61587,7 +62036,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61587
62036
|
* @param {String} dataIngestionRuleVersion version
|
|
61588
62037
|
* @param {Object} opts Optional parameters
|
|
61589
62038
|
* @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
62039
|
*/
|
|
61592
62040
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
61593
62041
|
opts = opts || {};
|
|
@@ -61628,7 +62076,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61628
62076
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61629
62077
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61630
62078
|
* @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
62079
|
*/
|
|
61633
62080
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
|
|
61634
62081
|
opts = opts || {};
|
|
@@ -61664,7 +62111,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61664
62111
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61665
62112
|
* @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
62113
|
* @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
62114
|
*/
|
|
61669
62115
|
getSocialmediaTopics(opts) {
|
|
61670
62116
|
opts = opts || {};
|
|
@@ -61690,7 +62136,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61690
62136
|
* @param {String} topicId topicId
|
|
61691
62137
|
* @param {Object} opts Optional parameters
|
|
61692
62138
|
* @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
62139
|
*/
|
|
61695
62140
|
patchSocialmediaTopic(topicId, opts) {
|
|
61696
62141
|
opts = opts || {};
|
|
@@ -61721,7 +62166,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61721
62166
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61722
62167
|
* @param {Object} opts Optional parameters
|
|
61723
62168
|
* @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
62169
|
*/
|
|
61726
62170
|
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61727
62171
|
opts = opts || {};
|
|
@@ -61791,7 +62235,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61791
62235
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61792
62236
|
* @param {Object} opts Optional parameters
|
|
61793
62237
|
* @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
62238
|
*/
|
|
61796
62239
|
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61797
62240
|
opts = opts || {};
|
|
@@ -61819,13 +62262,115 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61819
62262
|
);
|
|
61820
62263
|
}
|
|
61821
62264
|
|
|
62265
|
+
/**
|
|
62266
|
+
* Query for social media aggregates asynchronously
|
|
62267
|
+
*
|
|
62268
|
+
* @param {Object} body query
|
|
62269
|
+
*/
|
|
62270
|
+
postSocialmediaAnalyticsAggregatesJobs(body) {
|
|
62271
|
+
// verify the required parameter 'body' is set
|
|
62272
|
+
if (body === undefined || body === null) {
|
|
62273
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsAggregatesJobs';
|
|
62274
|
+
}
|
|
62275
|
+
|
|
62276
|
+
return this.apiClient.callApi(
|
|
62277
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs',
|
|
62278
|
+
'POST',
|
|
62279
|
+
{ },
|
|
62280
|
+
{ },
|
|
62281
|
+
{ },
|
|
62282
|
+
{ },
|
|
62283
|
+
body,
|
|
62284
|
+
['PureCloud OAuth'],
|
|
62285
|
+
['application/json'],
|
|
62286
|
+
['application/json']
|
|
62287
|
+
);
|
|
62288
|
+
}
|
|
62289
|
+
|
|
62290
|
+
/**
|
|
62291
|
+
* Query for social media messages asynchronously
|
|
62292
|
+
*
|
|
62293
|
+
* @param {Object} body query
|
|
62294
|
+
*/
|
|
62295
|
+
postSocialmediaAnalyticsMessagesJobs(body) {
|
|
62296
|
+
// verify the required parameter 'body' is set
|
|
62297
|
+
if (body === undefined || body === null) {
|
|
62298
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsMessagesJobs';
|
|
62299
|
+
}
|
|
62300
|
+
|
|
62301
|
+
return this.apiClient.callApi(
|
|
62302
|
+
'/api/v2/socialmedia/analytics/messages/jobs',
|
|
62303
|
+
'POST',
|
|
62304
|
+
{ },
|
|
62305
|
+
{ },
|
|
62306
|
+
{ },
|
|
62307
|
+
{ },
|
|
62308
|
+
body,
|
|
62309
|
+
['PureCloud OAuth'],
|
|
62310
|
+
['application/json'],
|
|
62311
|
+
['application/json']
|
|
62312
|
+
);
|
|
62313
|
+
}
|
|
62314
|
+
|
|
62315
|
+
/**
|
|
62316
|
+
* Create an escalation rule.
|
|
62317
|
+
*
|
|
62318
|
+
* @param {Object} opts Optional parameters
|
|
62319
|
+
* @param {Object} opts.body
|
|
62320
|
+
*/
|
|
62321
|
+
postSocialmediaEscalationrules(opts) {
|
|
62322
|
+
opts = opts || {};
|
|
62323
|
+
|
|
62324
|
+
|
|
62325
|
+
return this.apiClient.callApi(
|
|
62326
|
+
'/api/v2/socialmedia/escalationrules',
|
|
62327
|
+
'POST',
|
|
62328
|
+
{ },
|
|
62329
|
+
{ },
|
|
62330
|
+
{ },
|
|
62331
|
+
{ },
|
|
62332
|
+
opts['body'],
|
|
62333
|
+
['PureCloud OAuth'],
|
|
62334
|
+
['application/json'],
|
|
62335
|
+
['application/json']
|
|
62336
|
+
);
|
|
62337
|
+
}
|
|
62338
|
+
|
|
62339
|
+
/**
|
|
62340
|
+
* Escalate message to a conversation manually
|
|
62341
|
+
*
|
|
62342
|
+
* @param {String} divisionId One division ID
|
|
62343
|
+
* @param {Object} opts Optional parameters
|
|
62344
|
+
* @param {Object} opts.body
|
|
62345
|
+
*/
|
|
62346
|
+
postSocialmediaEscalationsMessages(divisionId, opts) {
|
|
62347
|
+
opts = opts || {};
|
|
62348
|
+
|
|
62349
|
+
// verify the required parameter 'divisionId' is set
|
|
62350
|
+
if (divisionId === undefined || divisionId === null) {
|
|
62351
|
+
throw 'Missing the required parameter "divisionId" when calling postSocialmediaEscalationsMessages';
|
|
62352
|
+
}
|
|
62353
|
+
|
|
62354
|
+
return this.apiClient.callApi(
|
|
62355
|
+
'/api/v2/socialmedia/escalations/messages',
|
|
62356
|
+
'POST',
|
|
62357
|
+
{ },
|
|
62358
|
+
{ 'divisionId': divisionId },
|
|
62359
|
+
{ },
|
|
62360
|
+
{ },
|
|
62361
|
+
opts['body'],
|
|
62362
|
+
['PureCloud OAuth'],
|
|
62363
|
+
['application/json'],
|
|
62364
|
+
['application/json']
|
|
62365
|
+
);
|
|
62366
|
+
}
|
|
62367
|
+
|
|
61822
62368
|
/**
|
|
61823
62369
|
* Create an Facebook data ingestion rule.
|
|
61824
62370
|
*
|
|
61825
62371
|
* @param {String} topicId topicId
|
|
61826
62372
|
* @param {Object} opts Optional parameters
|
|
61827
62373
|
* @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
62374
|
*/
|
|
61830
62375
|
postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
|
|
61831
62376
|
opts = opts || {};
|
|
@@ -61885,7 +62430,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61885
62430
|
* @param {String} topicId topicId
|
|
61886
62431
|
* @param {Object} opts Optional parameters
|
|
61887
62432
|
* @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
62433
|
*/
|
|
61890
62434
|
postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
|
|
61891
62435
|
opts = opts || {};
|
|
@@ -61914,7 +62458,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61914
62458
|
*
|
|
61915
62459
|
* @param {Object} opts Optional parameters
|
|
61916
62460
|
* @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
62461
|
*/
|
|
61919
62462
|
postSocialmediaTopics(opts) {
|
|
61920
62463
|
opts = opts || {};
|
|
@@ -61934,6 +62477,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61934
62477
|
);
|
|
61935
62478
|
}
|
|
61936
62479
|
|
|
62480
|
+
/**
|
|
62481
|
+
* Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
|
|
62482
|
+
*
|
|
62483
|
+
* @param {Object} body TwitterDataHistoricalTweetRequest
|
|
62484
|
+
*/
|
|
62485
|
+
postSocialmediaTwitterHistoricalTweets(body) {
|
|
62486
|
+
// verify the required parameter 'body' is set
|
|
62487
|
+
if (body === undefined || body === null) {
|
|
62488
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTwitterHistoricalTweets';
|
|
62489
|
+
}
|
|
62490
|
+
|
|
62491
|
+
return this.apiClient.callApi(
|
|
62492
|
+
'/api/v2/socialmedia/twitter/historical/tweets',
|
|
62493
|
+
'POST',
|
|
62494
|
+
{ },
|
|
62495
|
+
{ },
|
|
62496
|
+
{ },
|
|
62497
|
+
{ },
|
|
62498
|
+
body,
|
|
62499
|
+
['PureCloud OAuth'],
|
|
62500
|
+
['application/json'],
|
|
62501
|
+
['application/json']
|
|
62502
|
+
);
|
|
62503
|
+
}
|
|
62504
|
+
|
|
62505
|
+
/**
|
|
62506
|
+
* Update the escalation rule.
|
|
62507
|
+
*
|
|
62508
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
62509
|
+
* @param {Object} opts Optional parameters
|
|
62510
|
+
* @param {Object} opts.body
|
|
62511
|
+
*/
|
|
62512
|
+
putSocialmediaEscalationrule(escalationRuleId, opts) {
|
|
62513
|
+
opts = opts || {};
|
|
62514
|
+
|
|
62515
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
62516
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
62517
|
+
throw 'Missing the required parameter "escalationRuleId" when calling putSocialmediaEscalationrule';
|
|
62518
|
+
}
|
|
62519
|
+
|
|
62520
|
+
return this.apiClient.callApi(
|
|
62521
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
62522
|
+
'PUT',
|
|
62523
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
62524
|
+
{ },
|
|
62525
|
+
{ },
|
|
62526
|
+
{ },
|
|
62527
|
+
opts['body'],
|
|
62528
|
+
['PureCloud OAuth'],
|
|
62529
|
+
['application/json'],
|
|
62530
|
+
['application/json']
|
|
62531
|
+
);
|
|
62532
|
+
}
|
|
62533
|
+
|
|
61937
62534
|
/**
|
|
61938
62535
|
* Update the Facebook data ingestion rule.
|
|
61939
62536
|
*
|
|
@@ -61941,7 +62538,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61941
62538
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61942
62539
|
* @param {Object} opts Optional parameters
|
|
61943
62540
|
* @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
62541
|
*/
|
|
61946
62542
|
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61947
62543
|
opts = opts || {};
|
|
@@ -62011,7 +62607,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62011
62607
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
62012
62608
|
* @param {Object} opts Optional parameters
|
|
62013
62609
|
* @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
62610
|
*/
|
|
62016
62611
|
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
62017
62612
|
opts = opts || {};
|
|
@@ -62045,7 +62640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62045
62640
|
/**
|
|
62046
62641
|
* SpeechTextAnalytics service.
|
|
62047
62642
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
62048
|
-
* @version
|
|
62643
|
+
* @version 218.0.0
|
|
62049
62644
|
*/
|
|
62050
62645
|
|
|
62051
62646
|
/**
|
|
@@ -63486,7 +64081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63486
64081
|
/**
|
|
63487
64082
|
* Stations service.
|
|
63488
64083
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
63489
|
-
* @version
|
|
64084
|
+
* @version 218.0.0
|
|
63490
64085
|
*/
|
|
63491
64086
|
|
|
63492
64087
|
/**
|
|
@@ -63588,7 +64183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63588
64183
|
/**
|
|
63589
64184
|
* Suggest service.
|
|
63590
64185
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
63591
|
-
* @version
|
|
64186
|
+
* @version 218.0.0
|
|
63592
64187
|
*/
|
|
63593
64188
|
|
|
63594
64189
|
/**
|
|
@@ -63727,7 +64322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63727
64322
|
/**
|
|
63728
64323
|
* TaskManagement service.
|
|
63729
64324
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
63730
|
-
* @version
|
|
64325
|
+
* @version 218.0.0
|
|
63731
64326
|
*/
|
|
63732
64327
|
|
|
63733
64328
|
/**
|
|
@@ -65833,7 +66428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65833
66428
|
/**
|
|
65834
66429
|
* Teams service.
|
|
65835
66430
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
65836
|
-
* @version
|
|
66431
|
+
* @version 218.0.0
|
|
65837
66432
|
*/
|
|
65838
66433
|
|
|
65839
66434
|
/**
|
|
@@ -66138,7 +66733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66138
66733
|
/**
|
|
66139
66734
|
* Telephony service.
|
|
66140
66735
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
66141
|
-
* @version
|
|
66736
|
+
* @version 218.0.0
|
|
66142
66737
|
*/
|
|
66143
66738
|
|
|
66144
66739
|
/**
|
|
@@ -66320,7 +66915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66320
66915
|
/**
|
|
66321
66916
|
* TelephonyProvidersEdge service.
|
|
66322
66917
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
66323
|
-
* @version
|
|
66918
|
+
* @version 218.0.0
|
|
66324
66919
|
*/
|
|
66325
66920
|
|
|
66326
66921
|
/**
|
|
@@ -67502,6 +68097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67502
68097
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
67503
68098
|
* @param {String} opts.sortBy Sort by
|
|
67504
68099
|
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
68100
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
67505
68101
|
*/
|
|
67506
68102
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
67507
68103
|
opts = opts || {};
|
|
@@ -67511,7 +68107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67511
68107
|
'/api/v2/telephony/providers/edges/extensionpools',
|
|
67512
68108
|
'GET',
|
|
67513
68109
|
{ },
|
|
67514
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'number': opts['_number'] },
|
|
68110
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'number': opts['_number'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
67515
68111
|
{ },
|
|
67516
68112
|
{ },
|
|
67517
68113
|
null,
|
|
@@ -69771,7 +70367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69771
70367
|
/**
|
|
69772
70368
|
* Textbots service.
|
|
69773
70369
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
69774
|
-
* @version
|
|
70370
|
+
* @version 218.0.0
|
|
69775
70371
|
*/
|
|
69776
70372
|
|
|
69777
70373
|
/**
|
|
@@ -69899,7 +70495,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69899
70495
|
/**
|
|
69900
70496
|
* Tokens service.
|
|
69901
70497
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
69902
|
-
* @version
|
|
70498
|
+
* @version 218.0.0
|
|
69903
70499
|
*/
|
|
69904
70500
|
|
|
69905
70501
|
/**
|
|
@@ -70053,7 +70649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70053
70649
|
/**
|
|
70054
70650
|
* Uploads service.
|
|
70055
70651
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
70056
|
-
* @version
|
|
70652
|
+
* @version 218.0.0
|
|
70057
70653
|
*/
|
|
70058
70654
|
|
|
70059
70655
|
/**
|
|
@@ -70319,7 +70915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70319
70915
|
/**
|
|
70320
70916
|
* Usage service.
|
|
70321
70917
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
70322
|
-
* @version
|
|
70918
|
+
* @version 218.0.0
|
|
70323
70919
|
*/
|
|
70324
70920
|
|
|
70325
70921
|
/**
|
|
@@ -70534,7 +71130,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70534
71130
|
/**
|
|
70535
71131
|
* UserRecordings service.
|
|
70536
71132
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
70537
|
-
* @version
|
|
71133
|
+
* @version 218.0.0
|
|
70538
71134
|
*/
|
|
70539
71135
|
|
|
70540
71136
|
/**
|
|
@@ -70749,7 +71345,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70749
71345
|
/**
|
|
70750
71346
|
* Users service.
|
|
70751
71347
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
70752
|
-
* @version
|
|
71348
|
+
* @version 218.0.0
|
|
70753
71349
|
*/
|
|
70754
71350
|
|
|
70755
71351
|
/**
|
|
@@ -73702,7 +74298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73702
74298
|
/**
|
|
73703
74299
|
* Utilities service.
|
|
73704
74300
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
73705
|
-
* @version
|
|
74301
|
+
* @version 218.0.0
|
|
73706
74302
|
*/
|
|
73707
74303
|
|
|
73708
74304
|
/**
|
|
@@ -73813,7 +74409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73813
74409
|
/**
|
|
73814
74410
|
* Voicemail service.
|
|
73815
74411
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
73816
|
-
* @version
|
|
74412
|
+
* @version 218.0.0
|
|
73817
74413
|
*/
|
|
73818
74414
|
|
|
73819
74415
|
/**
|
|
@@ -74535,7 +75131,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74535
75131
|
/**
|
|
74536
75132
|
* WebChat service.
|
|
74537
75133
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
74538
|
-
* @version
|
|
75134
|
+
* @version 218.0.0
|
|
74539
75135
|
*/
|
|
74540
75136
|
|
|
74541
75137
|
/**
|
|
@@ -74578,9 +75174,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74578
75174
|
|
|
74579
75175
|
/**
|
|
74580
75176
|
* Remove a member from a chat conversation
|
|
74581
|
-
*
|
|
75177
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74582
75178
|
* @param {String} conversationId conversationId
|
|
74583
75179
|
* @param {String} memberId memberId
|
|
75180
|
+
* @deprecated
|
|
74584
75181
|
*/
|
|
74585
75182
|
deleteWebchatGuestConversationMember(conversationId, memberId) {
|
|
74586
75183
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74706,8 +75303,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74706
75303
|
|
|
74707
75304
|
/**
|
|
74708
75305
|
* Get all media requests to the guest in the conversation
|
|
74709
|
-
*
|
|
75306
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74710
75307
|
* @param {String} conversationId conversationId
|
|
75308
|
+
* @deprecated
|
|
74711
75309
|
*/
|
|
74712
75310
|
getWebchatGuestConversationMediarequests(conversationId) {
|
|
74713
75311
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74731,9 +75329,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74731
75329
|
|
|
74732
75330
|
/**
|
|
74733
75331
|
* Get a web chat conversation member
|
|
74734
|
-
*
|
|
75332
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74735
75333
|
* @param {String} conversationId conversationId
|
|
74736
75334
|
* @param {String} memberId memberId
|
|
75335
|
+
* @deprecated
|
|
74737
75336
|
*/
|
|
74738
75337
|
getWebchatGuestConversationMember(conversationId, memberId) {
|
|
74739
75338
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74761,12 +75360,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74761
75360
|
|
|
74762
75361
|
/**
|
|
74763
75362
|
* Get the members of a chat conversation.
|
|
74764
|
-
*
|
|
75363
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74765
75364
|
* @param {String} conversationId conversationId
|
|
74766
75365
|
* @param {Object} opts Optional parameters
|
|
74767
75366
|
* @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
|
|
74768
75367
|
* @param {Number} opts.pageNumber The page number to return, or omitted for the first page. (default to 1)
|
|
74769
75368
|
* @param {Boolean} opts.excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (default to false)
|
|
75369
|
+
* @deprecated
|
|
74770
75370
|
*/
|
|
74771
75371
|
getWebchatGuestConversationMembers(conversationId, opts) {
|
|
74772
75372
|
opts = opts || {};
|
|
@@ -74792,9 +75392,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74792
75392
|
|
|
74793
75393
|
/**
|
|
74794
75394
|
* Get a web chat conversation message
|
|
74795
|
-
*
|
|
75395
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74796
75396
|
* @param {String} conversationId conversationId
|
|
74797
75397
|
* @param {String} messageId messageId
|
|
75398
|
+
* @deprecated
|
|
74798
75399
|
*/
|
|
74799
75400
|
getWebchatGuestConversationMessage(conversationId, messageId) {
|
|
74800
75401
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74822,13 +75423,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74822
75423
|
|
|
74823
75424
|
/**
|
|
74824
75425
|
* Get the messages of a chat conversation.
|
|
74825
|
-
*
|
|
75426
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74826
75427
|
* @param {String} conversationId conversationId
|
|
74827
75428
|
* @param {Object} opts Optional parameters
|
|
74828
75429
|
* @param {String} opts.after If available, get the messages chronologically after the id of this message
|
|
74829
75430
|
* @param {String} opts.before If available, get the messages chronologically before the id of this message
|
|
74830
75431
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
74831
75432
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
75433
|
+
* @deprecated
|
|
74832
75434
|
*/
|
|
74833
75435
|
getWebchatGuestConversationMessages(conversationId, opts) {
|
|
74834
75436
|
opts = opts || {};
|
|
@@ -74936,10 +75538,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74936
75538
|
|
|
74937
75539
|
/**
|
|
74938
75540
|
* Send a message in a chat conversation.
|
|
74939
|
-
*
|
|
75541
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74940
75542
|
* @param {String} conversationId conversationId
|
|
74941
75543
|
* @param {String} memberId memberId
|
|
74942
75544
|
* @param {Object} body Message
|
|
75545
|
+
* @deprecated
|
|
74943
75546
|
*/
|
|
74944
75547
|
postWebchatGuestConversationMemberMessages(conversationId, memberId, body) {
|
|
74945
75548
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74971,9 +75574,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74971
75574
|
|
|
74972
75575
|
/**
|
|
74973
75576
|
* Send a typing-indicator in a chat conversation.
|
|
74974
|
-
*
|
|
75577
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74975
75578
|
* @param {String} conversationId conversationId
|
|
74976
75579
|
* @param {String} memberId memberId
|
|
75580
|
+
* @deprecated
|
|
74977
75581
|
*/
|
|
74978
75582
|
postWebchatGuestConversationMemberTyping(conversationId, memberId) {
|
|
74979
75583
|
// verify the required parameter 'conversationId' is set
|
|
@@ -75001,8 +75605,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75001
75605
|
|
|
75002
75606
|
/**
|
|
75003
75607
|
* Create an ACD chat conversation from an external customer.
|
|
75004
|
-
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.
|
|
75608
|
+
* 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
75609
|
* @param {Object} body CreateConversationRequest
|
|
75610
|
+
* @deprecated
|
|
75006
75611
|
*/
|
|
75007
75612
|
postWebchatGuestConversations(body) {
|
|
75008
75613
|
// verify the required parameter 'body' is set
|
|
@@ -75086,7 +75691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75086
75691
|
/**
|
|
75087
75692
|
* WebDeployments service.
|
|
75088
75693
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
75089
|
-
* @version
|
|
75694
|
+
* @version 218.0.0
|
|
75090
75695
|
*/
|
|
75091
75696
|
|
|
75092
75697
|
/**
|
|
@@ -75670,7 +76275,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75670
76275
|
/**
|
|
75671
76276
|
* WebMessaging service.
|
|
75672
76277
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
75673
|
-
* @version
|
|
76278
|
+
* @version 218.0.0
|
|
75674
76279
|
*/
|
|
75675
76280
|
|
|
75676
76281
|
/**
|
|
@@ -75716,7 +76321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75716
76321
|
/**
|
|
75717
76322
|
* Widgets service.
|
|
75718
76323
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
75719
|
-
* @version
|
|
76324
|
+
* @version 218.0.0
|
|
75720
76325
|
*/
|
|
75721
76326
|
|
|
75722
76327
|
/**
|
|
@@ -75733,8 +76338,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75733
76338
|
|
|
75734
76339
|
/**
|
|
75735
76340
|
* Delete a Widget deployment
|
|
75736
|
-
*
|
|
76341
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75737
76342
|
* @param {String} deploymentId Widget Config Id
|
|
76343
|
+
* @deprecated
|
|
75738
76344
|
*/
|
|
75739
76345
|
deleteWidgetsDeployment(deploymentId) {
|
|
75740
76346
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75758,8 +76364,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75758
76364
|
|
|
75759
76365
|
/**
|
|
75760
76366
|
* Get a Widget deployment
|
|
75761
|
-
*
|
|
76367
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75762
76368
|
* @param {String} deploymentId Widget Config Id
|
|
76369
|
+
* @deprecated
|
|
75763
76370
|
*/
|
|
75764
76371
|
getWidgetsDeployment(deploymentId) {
|
|
75765
76372
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75783,7 +76390,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75783
76390
|
|
|
75784
76391
|
/**
|
|
75785
76392
|
* List Widget deployments
|
|
75786
|
-
*
|
|
76393
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
76394
|
+
* @deprecated
|
|
75787
76395
|
*/
|
|
75788
76396
|
getWidgetsDeployments() {
|
|
75789
76397
|
|
|
@@ -75803,8 +76411,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75803
76411
|
|
|
75804
76412
|
/**
|
|
75805
76413
|
* Create Widget deployment
|
|
75806
|
-
*
|
|
76414
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75807
76415
|
* @param {Object} body Deployment
|
|
76416
|
+
* @deprecated
|
|
75808
76417
|
*/
|
|
75809
76418
|
postWidgetsDeployments(body) {
|
|
75810
76419
|
// verify the required parameter 'body' is set
|
|
@@ -75828,9 +76437,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75828
76437
|
|
|
75829
76438
|
/**
|
|
75830
76439
|
* Update a Widget deployment
|
|
75831
|
-
*
|
|
76440
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75832
76441
|
* @param {String} deploymentId Widget Config Id
|
|
75833
76442
|
* @param {Object} body Deployment
|
|
76443
|
+
* @deprecated
|
|
75834
76444
|
*/
|
|
75835
76445
|
putWidgetsDeployment(deploymentId, body) {
|
|
75836
76446
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75862,7 +76472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75862
76472
|
/**
|
|
75863
76473
|
* WorkforceManagement service.
|
|
75864
76474
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
75865
|
-
* @version
|
|
76475
|
+
* @version 218.0.0
|
|
75866
76476
|
*/
|
|
75867
76477
|
|
|
75868
76478
|
/**
|
|
@@ -83255,7 +83865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83255
83865
|
* </pre>
|
|
83256
83866
|
* </p>
|
|
83257
83867
|
* @module purecloud-platform-client-v2/index
|
|
83258
|
-
* @version
|
|
83868
|
+
* @version 218.0.0
|
|
83259
83869
|
*/
|
|
83260
83870
|
class platformClient {
|
|
83261
83871
|
constructor() {
|