purecloud-platform-client-v2 208.0.0 → 210.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 +1514 -138
- package/dist/web-amd/purecloud-platform-client-v2.js +1514 -138
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +516 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +697 -259
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +3829 -3147
- 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 +4 -4
- 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 -1
- 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 +1 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +175 -0
- 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 +240 -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 +9 -9
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +7 -3
- 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 +52 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- 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 +5 -3
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +29 -25
- 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 +910 -0
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +11 -19
- package/src/purecloud-platform-client-v2/index.js +13 -1
|
@@ -486,7 +486,7 @@ class Configuration {
|
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
488
|
* @module purecloud-platform-client-v2/ApiClient
|
|
489
|
-
* @version
|
|
489
|
+
* @version 210.0.0
|
|
490
490
|
*/
|
|
491
491
|
class ApiClient {
|
|
492
492
|
/**
|
|
@@ -1930,7 +1930,7 @@ class AgentAssistantsApi {
|
|
|
1930
1930
|
/**
|
|
1931
1931
|
* AgentAssistants service.
|
|
1932
1932
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1933
|
-
* @version
|
|
1933
|
+
* @version 210.0.0
|
|
1934
1934
|
*/
|
|
1935
1935
|
|
|
1936
1936
|
/**
|
|
@@ -2306,7 +2306,7 @@ class AgentCopilotApi {
|
|
|
2306
2306
|
/**
|
|
2307
2307
|
* AgentCopilot service.
|
|
2308
2308
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2309
|
-
* @version
|
|
2309
|
+
* @version 210.0.0
|
|
2310
2310
|
*/
|
|
2311
2311
|
|
|
2312
2312
|
/**
|
|
@@ -2382,7 +2382,7 @@ class AgentUIApi {
|
|
|
2382
2382
|
/**
|
|
2383
2383
|
* AgentUI service.
|
|
2384
2384
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2385
|
-
* @version
|
|
2385
|
+
* @version 210.0.0
|
|
2386
2386
|
*/
|
|
2387
2387
|
|
|
2388
2388
|
/**
|
|
@@ -2513,7 +2513,7 @@ class AlertingApi {
|
|
|
2513
2513
|
/**
|
|
2514
2514
|
* Alerting service.
|
|
2515
2515
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2516
|
-
* @version
|
|
2516
|
+
* @version 210.0.0
|
|
2517
2517
|
*/
|
|
2518
2518
|
|
|
2519
2519
|
/**
|
|
@@ -3174,7 +3174,7 @@ class AnalyticsApi {
|
|
|
3174
3174
|
/**
|
|
3175
3175
|
* Analytics service.
|
|
3176
3176
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3177
|
-
* @version
|
|
3177
|
+
* @version 210.0.0
|
|
3178
3178
|
*/
|
|
3179
3179
|
|
|
3180
3180
|
/**
|
|
@@ -3353,7 +3353,7 @@ class AnalyticsApi {
|
|
|
3353
3353
|
|
|
3354
3354
|
/**
|
|
3355
3355
|
* Get Reporting Turns (division aware).
|
|
3356
|
-
* Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3356
|
+
* Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3357
3357
|
* @param {String} botFlowId ID of the bot flow.
|
|
3358
3358
|
* @param {Object} opts Optional parameters
|
|
3359
3359
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -3388,7 +3388,7 @@ class AnalyticsApi {
|
|
|
3388
3388
|
|
|
3389
3389
|
/**
|
|
3390
3390
|
* Get Reporting Turns.
|
|
3391
|
-
* Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3391
|
+
* Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3392
3392
|
* @param {String} botFlowId ID of the bot flow.
|
|
3393
3393
|
* @param {Object} opts Optional parameters
|
|
3394
3394
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -3424,7 +3424,7 @@ class AnalyticsApi {
|
|
|
3424
3424
|
|
|
3425
3425
|
/**
|
|
3426
3426
|
* Get Bot Flow Sessions.
|
|
3427
|
-
* Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3427
|
+
* Returns the bot flow sessions in reverse chronological order from the date they were created. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3428
3428
|
* @param {String} botFlowId ID of the bot flow.
|
|
3429
3429
|
* @param {Object} opts Optional parameters
|
|
3430
3430
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -5787,7 +5787,7 @@ class ArchitectApi {
|
|
|
5787
5787
|
/**
|
|
5788
5788
|
* Architect service.
|
|
5789
5789
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5790
|
-
* @version
|
|
5790
|
+
* @version 210.0.0
|
|
5791
5791
|
*/
|
|
5792
5792
|
|
|
5793
5793
|
/**
|
|
@@ -9909,7 +9909,7 @@ class AuditApi {
|
|
|
9909
9909
|
/**
|
|
9910
9910
|
* Audit service.
|
|
9911
9911
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9912
|
-
* @version
|
|
9912
|
+
* @version 210.0.0
|
|
9913
9913
|
*/
|
|
9914
9914
|
|
|
9915
9915
|
/**
|
|
@@ -10110,7 +10110,7 @@ class AuthorizationApi {
|
|
|
10110
10110
|
/**
|
|
10111
10111
|
* Authorization service.
|
|
10112
10112
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10113
|
-
* @version
|
|
10113
|
+
* @version 210.0.0
|
|
10114
10114
|
*/
|
|
10115
10115
|
|
|
10116
10116
|
/**
|
|
@@ -11393,7 +11393,7 @@ class BillingApi {
|
|
|
11393
11393
|
/**
|
|
11394
11394
|
* Billing service.
|
|
11395
11395
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11396
|
-
* @version
|
|
11396
|
+
* @version 210.0.0
|
|
11397
11397
|
*/
|
|
11398
11398
|
|
|
11399
11399
|
/**
|
|
@@ -11473,7 +11473,7 @@ class CarrierServicesApi {
|
|
|
11473
11473
|
/**
|
|
11474
11474
|
* CarrierServices service.
|
|
11475
11475
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11476
|
-
* @version
|
|
11476
|
+
* @version 210.0.0
|
|
11477
11477
|
*/
|
|
11478
11478
|
|
|
11479
11479
|
/**
|
|
@@ -11543,7 +11543,7 @@ class ChatApi {
|
|
|
11543
11543
|
/**
|
|
11544
11544
|
* Chat service.
|
|
11545
11545
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11546
|
-
* @version
|
|
11546
|
+
* @version 210.0.0
|
|
11547
11547
|
*/
|
|
11548
11548
|
|
|
11549
11549
|
/**
|
|
@@ -12479,7 +12479,7 @@ class CoachingApi {
|
|
|
12479
12479
|
/**
|
|
12480
12480
|
* Coaching service.
|
|
12481
12481
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12482
|
-
* @version
|
|
12482
|
+
* @version 210.0.0
|
|
12483
12483
|
*/
|
|
12484
12484
|
|
|
12485
12485
|
/**
|
|
@@ -13056,7 +13056,7 @@ class ContentManagementApi {
|
|
|
13056
13056
|
/**
|
|
13057
13057
|
* ContentManagement service.
|
|
13058
13058
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13059
|
-
* @version
|
|
13059
|
+
* @version 210.0.0
|
|
13060
13060
|
*/
|
|
13061
13061
|
|
|
13062
13062
|
/**
|
|
@@ -14137,7 +14137,7 @@ class ConversationsApi {
|
|
|
14137
14137
|
/**
|
|
14138
14138
|
* Conversations service.
|
|
14139
14139
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14140
|
-
* @version
|
|
14140
|
+
* @version 210.0.0
|
|
14141
14141
|
*/
|
|
14142
14142
|
|
|
14143
14143
|
/**
|
|
@@ -14923,7 +14923,6 @@ class ConversationsApi {
|
|
|
14923
14923
|
* Get the summaries of the conversation.
|
|
14924
14924
|
*
|
|
14925
14925
|
* @param {String} conversationId Conversation ID
|
|
14926
|
-
* getConversationSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14927
14926
|
*/
|
|
14928
14927
|
getConversationSummaries(conversationId) {
|
|
14929
14928
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21279,7 +21278,7 @@ class DataExtensionsApi {
|
|
|
21279
21278
|
/**
|
|
21280
21279
|
* DataExtensions service.
|
|
21281
21280
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21282
|
-
* @version
|
|
21281
|
+
* @version 210.0.0
|
|
21283
21282
|
*/
|
|
21284
21283
|
|
|
21285
21284
|
/**
|
|
@@ -21361,11 +21360,181 @@ class DataExtensionsApi {
|
|
|
21361
21360
|
|
|
21362
21361
|
}
|
|
21363
21362
|
|
|
21363
|
+
class DataPrivacyApi {
|
|
21364
|
+
/**
|
|
21365
|
+
* DataPrivacy service.
|
|
21366
|
+
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21367
|
+
* @version 210.0.0
|
|
21368
|
+
*/
|
|
21369
|
+
|
|
21370
|
+
/**
|
|
21371
|
+
* Constructs a new DataPrivacyApi.
|
|
21372
|
+
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21373
|
+
* @class
|
|
21374
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
21375
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
21376
|
+
*/
|
|
21377
|
+
constructor(apiClient) {
|
|
21378
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
21379
|
+
}
|
|
21380
|
+
|
|
21381
|
+
|
|
21382
|
+
/**
|
|
21383
|
+
* Delete a masking rule.
|
|
21384
|
+
*
|
|
21385
|
+
* @param {String} ruleId ruleId
|
|
21386
|
+
*/
|
|
21387
|
+
deleteDataprivacyMaskingrule(ruleId) {
|
|
21388
|
+
// verify the required parameter 'ruleId' is set
|
|
21389
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21390
|
+
throw 'Missing the required parameter "ruleId" when calling deleteDataprivacyMaskingrule';
|
|
21391
|
+
}
|
|
21392
|
+
|
|
21393
|
+
return this.apiClient.callApi(
|
|
21394
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21395
|
+
'DELETE',
|
|
21396
|
+
{ 'ruleId': ruleId },
|
|
21397
|
+
{ },
|
|
21398
|
+
{ },
|
|
21399
|
+
{ },
|
|
21400
|
+
null,
|
|
21401
|
+
['PureCloud OAuth'],
|
|
21402
|
+
['application/json'],
|
|
21403
|
+
['application/json']
|
|
21404
|
+
);
|
|
21405
|
+
}
|
|
21406
|
+
|
|
21407
|
+
/**
|
|
21408
|
+
* Fetch details about a masking rule.
|
|
21409
|
+
*
|
|
21410
|
+
* @param {String} ruleId ruleId
|
|
21411
|
+
*/
|
|
21412
|
+
getDataprivacyMaskingrule(ruleId) {
|
|
21413
|
+
// verify the required parameter 'ruleId' is set
|
|
21414
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21415
|
+
throw 'Missing the required parameter "ruleId" when calling getDataprivacyMaskingrule';
|
|
21416
|
+
}
|
|
21417
|
+
|
|
21418
|
+
return this.apiClient.callApi(
|
|
21419
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21420
|
+
'GET',
|
|
21421
|
+
{ 'ruleId': ruleId },
|
|
21422
|
+
{ },
|
|
21423
|
+
{ },
|
|
21424
|
+
{ },
|
|
21425
|
+
null,
|
|
21426
|
+
['PureCloud OAuth'],
|
|
21427
|
+
['application/json'],
|
|
21428
|
+
['application/json']
|
|
21429
|
+
);
|
|
21430
|
+
}
|
|
21431
|
+
|
|
21432
|
+
/**
|
|
21433
|
+
* Retrieve the list of masking rules.
|
|
21434
|
+
*
|
|
21435
|
+
*/
|
|
21436
|
+
getDataprivacyMaskingrules() {
|
|
21437
|
+
|
|
21438
|
+
return this.apiClient.callApi(
|
|
21439
|
+
'/api/v2/dataprivacy/maskingrules',
|
|
21440
|
+
'GET',
|
|
21441
|
+
{ },
|
|
21442
|
+
{ },
|
|
21443
|
+
{ },
|
|
21444
|
+
{ },
|
|
21445
|
+
null,
|
|
21446
|
+
['PureCloud OAuth'],
|
|
21447
|
+
['application/json'],
|
|
21448
|
+
['application/json']
|
|
21449
|
+
);
|
|
21450
|
+
}
|
|
21451
|
+
|
|
21452
|
+
/**
|
|
21453
|
+
* Update information about a masking rule.
|
|
21454
|
+
*
|
|
21455
|
+
* @param {String} ruleId ruleId
|
|
21456
|
+
* @param {Object} opts Optional parameters
|
|
21457
|
+
* @param {Object} opts.body
|
|
21458
|
+
*/
|
|
21459
|
+
patchDataprivacyMaskingrule(ruleId, opts) {
|
|
21460
|
+
opts = opts || {};
|
|
21461
|
+
|
|
21462
|
+
// verify the required parameter 'ruleId' is set
|
|
21463
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21464
|
+
throw 'Missing the required parameter "ruleId" when calling patchDataprivacyMaskingrule';
|
|
21465
|
+
}
|
|
21466
|
+
|
|
21467
|
+
return this.apiClient.callApi(
|
|
21468
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21469
|
+
'PATCH',
|
|
21470
|
+
{ 'ruleId': ruleId },
|
|
21471
|
+
{ },
|
|
21472
|
+
{ },
|
|
21473
|
+
{ },
|
|
21474
|
+
opts['body'],
|
|
21475
|
+
['PureCloud OAuth'],
|
|
21476
|
+
['application/json'],
|
|
21477
|
+
['application/json']
|
|
21478
|
+
);
|
|
21479
|
+
}
|
|
21480
|
+
|
|
21481
|
+
/**
|
|
21482
|
+
* Create a new masking rule resource.
|
|
21483
|
+
*
|
|
21484
|
+
* @param {Object} body Details for creating masking rule resource
|
|
21485
|
+
*/
|
|
21486
|
+
postDataprivacyMaskingrules(body) {
|
|
21487
|
+
// verify the required parameter 'body' is set
|
|
21488
|
+
if (body === undefined || body === null) {
|
|
21489
|
+
throw 'Missing the required parameter "body" when calling postDataprivacyMaskingrules';
|
|
21490
|
+
}
|
|
21491
|
+
|
|
21492
|
+
return this.apiClient.callApi(
|
|
21493
|
+
'/api/v2/dataprivacy/maskingrules',
|
|
21494
|
+
'POST',
|
|
21495
|
+
{ },
|
|
21496
|
+
{ },
|
|
21497
|
+
{ },
|
|
21498
|
+
{ },
|
|
21499
|
+
body,
|
|
21500
|
+
['PureCloud OAuth'],
|
|
21501
|
+
['application/json'],
|
|
21502
|
+
['application/json']
|
|
21503
|
+
);
|
|
21504
|
+
}
|
|
21505
|
+
|
|
21506
|
+
/**
|
|
21507
|
+
* Validate masking before creating.
|
|
21508
|
+
*
|
|
21509
|
+
* @param {Object} body Text to be masked
|
|
21510
|
+
*/
|
|
21511
|
+
postDataprivacyMaskingrulesValidate(body) {
|
|
21512
|
+
// verify the required parameter 'body' is set
|
|
21513
|
+
if (body === undefined || body === null) {
|
|
21514
|
+
throw 'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';
|
|
21515
|
+
}
|
|
21516
|
+
|
|
21517
|
+
return this.apiClient.callApi(
|
|
21518
|
+
'/api/v2/dataprivacy/maskingrules/validate',
|
|
21519
|
+
'POST',
|
|
21520
|
+
{ },
|
|
21521
|
+
{ },
|
|
21522
|
+
{ },
|
|
21523
|
+
{ },
|
|
21524
|
+
body,
|
|
21525
|
+
['PureCloud OAuth'],
|
|
21526
|
+
['application/json'],
|
|
21527
|
+
['application/json']
|
|
21528
|
+
);
|
|
21529
|
+
}
|
|
21530
|
+
|
|
21531
|
+
}
|
|
21532
|
+
|
|
21364
21533
|
class DownloadsApi {
|
|
21365
21534
|
/**
|
|
21366
21535
|
* Downloads service.
|
|
21367
21536
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21368
|
-
* @version
|
|
21537
|
+
* @version 210.0.0
|
|
21369
21538
|
*/
|
|
21370
21539
|
|
|
21371
21540
|
/**
|
|
@@ -21417,7 +21586,7 @@ class EmailsApi {
|
|
|
21417
21586
|
/**
|
|
21418
21587
|
* Emails service.
|
|
21419
21588
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21420
|
-
* @version
|
|
21589
|
+
* @version 210.0.0
|
|
21421
21590
|
*/
|
|
21422
21591
|
|
|
21423
21592
|
/**
|
|
@@ -21482,7 +21651,7 @@ class EmployeeEngagementApi {
|
|
|
21482
21651
|
/**
|
|
21483
21652
|
* EmployeeEngagement service.
|
|
21484
21653
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21485
|
-
* @version
|
|
21654
|
+
* @version 210.0.0
|
|
21486
21655
|
*/
|
|
21487
21656
|
|
|
21488
21657
|
/**
|
|
@@ -21633,7 +21802,7 @@ class EventsApi {
|
|
|
21633
21802
|
/**
|
|
21634
21803
|
* Events service.
|
|
21635
21804
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21636
|
-
* @version
|
|
21805
|
+
* @version 210.0.0
|
|
21637
21806
|
*/
|
|
21638
21807
|
|
|
21639
21808
|
/**
|
|
@@ -21729,7 +21898,7 @@ class ExternalContactsApi {
|
|
|
21729
21898
|
/**
|
|
21730
21899
|
* ExternalContacts service.
|
|
21731
21900
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21732
|
-
* @version
|
|
21901
|
+
* @version 210.0.0
|
|
21733
21902
|
*/
|
|
21734
21903
|
|
|
21735
21904
|
/**
|
|
@@ -21874,6 +22043,31 @@ class ExternalContactsApi {
|
|
|
21874
22043
|
);
|
|
21875
22044
|
}
|
|
21876
22045
|
|
|
22046
|
+
/**
|
|
22047
|
+
* Delete Settings
|
|
22048
|
+
*
|
|
22049
|
+
* @param {String} settingsId Settings id
|
|
22050
|
+
*/
|
|
22051
|
+
deleteExternalcontactsImportSetting(settingsId) {
|
|
22052
|
+
// verify the required parameter 'settingsId' is set
|
|
22053
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22054
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportSetting';
|
|
22055
|
+
}
|
|
22056
|
+
|
|
22057
|
+
return this.apiClient.callApi(
|
|
22058
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
22059
|
+
'DELETE',
|
|
22060
|
+
{ 'settingsId': settingsId },
|
|
22061
|
+
{ },
|
|
22062
|
+
{ },
|
|
22063
|
+
{ },
|
|
22064
|
+
null,
|
|
22065
|
+
['PureCloud OAuth'],
|
|
22066
|
+
['application/json'],
|
|
22067
|
+
['application/json']
|
|
22068
|
+
);
|
|
22069
|
+
}
|
|
22070
|
+
|
|
21877
22071
|
/**
|
|
21878
22072
|
* Delete an external organization
|
|
21879
22073
|
*
|
|
@@ -22440,6 +22634,110 @@ class ExternalContactsApi {
|
|
|
22440
22634
|
);
|
|
22441
22635
|
}
|
|
22442
22636
|
|
|
22637
|
+
/**
|
|
22638
|
+
* Get job based on id
|
|
22639
|
+
*
|
|
22640
|
+
* @param {String} jobId Job id
|
|
22641
|
+
*/
|
|
22642
|
+
getExternalcontactsImportJob(jobId) {
|
|
22643
|
+
// verify the required parameter 'jobId' is set
|
|
22644
|
+
if (jobId === undefined || jobId === null) {
|
|
22645
|
+
throw 'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';
|
|
22646
|
+
}
|
|
22647
|
+
|
|
22648
|
+
return this.apiClient.callApi(
|
|
22649
|
+
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
22650
|
+
'GET',
|
|
22651
|
+
{ 'jobId': jobId },
|
|
22652
|
+
{ },
|
|
22653
|
+
{ },
|
|
22654
|
+
{ },
|
|
22655
|
+
null,
|
|
22656
|
+
['PureCloud OAuth'],
|
|
22657
|
+
['application/json'],
|
|
22658
|
+
['application/json']
|
|
22659
|
+
);
|
|
22660
|
+
}
|
|
22661
|
+
|
|
22662
|
+
/**
|
|
22663
|
+
* List jobs for organization
|
|
22664
|
+
*
|
|
22665
|
+
* @param {Object} opts Optional parameters
|
|
22666
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22667
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
22668
|
+
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
22669
|
+
* @param {Object} opts.jobStatus Search term to filter by jobStatus
|
|
22670
|
+
*/
|
|
22671
|
+
getExternalcontactsImportJobs(opts) {
|
|
22672
|
+
opts = opts || {};
|
|
22673
|
+
|
|
22674
|
+
|
|
22675
|
+
return this.apiClient.callApi(
|
|
22676
|
+
'/api/v2/externalcontacts/import/jobs',
|
|
22677
|
+
'GET',
|
|
22678
|
+
{ },
|
|
22679
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
22680
|
+
{ },
|
|
22681
|
+
{ },
|
|
22682
|
+
null,
|
|
22683
|
+
['PureCloud OAuth'],
|
|
22684
|
+
['application/json'],
|
|
22685
|
+
['application/json']
|
|
22686
|
+
);
|
|
22687
|
+
}
|
|
22688
|
+
|
|
22689
|
+
/**
|
|
22690
|
+
* Get setting based on id
|
|
22691
|
+
*
|
|
22692
|
+
* @param {String} settingsId Settings id
|
|
22693
|
+
*/
|
|
22694
|
+
getExternalcontactsImportSetting(settingsId) {
|
|
22695
|
+
// verify the required parameter 'settingsId' is set
|
|
22696
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22697
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportSetting';
|
|
22698
|
+
}
|
|
22699
|
+
|
|
22700
|
+
return this.apiClient.callApi(
|
|
22701
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
22702
|
+
'GET',
|
|
22703
|
+
{ 'settingsId': settingsId },
|
|
22704
|
+
{ },
|
|
22705
|
+
{ },
|
|
22706
|
+
{ },
|
|
22707
|
+
null,
|
|
22708
|
+
['PureCloud OAuth'],
|
|
22709
|
+
['application/json'],
|
|
22710
|
+
['application/json']
|
|
22711
|
+
);
|
|
22712
|
+
}
|
|
22713
|
+
|
|
22714
|
+
/**
|
|
22715
|
+
* List settings for organization
|
|
22716
|
+
*
|
|
22717
|
+
* @param {Object} opts Optional parameters
|
|
22718
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22719
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
22720
|
+
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
22721
|
+
* @param {String} opts.name Search term to filter by settings name
|
|
22722
|
+
*/
|
|
22723
|
+
getExternalcontactsImportSettings(opts) {
|
|
22724
|
+
opts = opts || {};
|
|
22725
|
+
|
|
22726
|
+
|
|
22727
|
+
return this.apiClient.callApi(
|
|
22728
|
+
'/api/v2/externalcontacts/import/settings',
|
|
22729
|
+
'GET',
|
|
22730
|
+
{ },
|
|
22731
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
22732
|
+
{ },
|
|
22733
|
+
{ },
|
|
22734
|
+
null,
|
|
22735
|
+
['PureCloud OAuth'],
|
|
22736
|
+
['application/json'],
|
|
22737
|
+
['application/json']
|
|
22738
|
+
);
|
|
22739
|
+
}
|
|
22740
|
+
|
|
22443
22741
|
/**
|
|
22444
22742
|
* Fetch an external organization
|
|
22445
22743
|
*
|
|
@@ -23578,6 +23876,56 @@ class ExternalContactsApi {
|
|
|
23578
23876
|
);
|
|
23579
23877
|
}
|
|
23580
23878
|
|
|
23879
|
+
/**
|
|
23880
|
+
* Create a new job
|
|
23881
|
+
*
|
|
23882
|
+
* @param {Object} body Job
|
|
23883
|
+
*/
|
|
23884
|
+
postExternalcontactsImportJobs(body) {
|
|
23885
|
+
// verify the required parameter 'body' is set
|
|
23886
|
+
if (body === undefined || body === null) {
|
|
23887
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportJobs';
|
|
23888
|
+
}
|
|
23889
|
+
|
|
23890
|
+
return this.apiClient.callApi(
|
|
23891
|
+
'/api/v2/externalcontacts/import/jobs',
|
|
23892
|
+
'POST',
|
|
23893
|
+
{ },
|
|
23894
|
+
{ },
|
|
23895
|
+
{ },
|
|
23896
|
+
{ },
|
|
23897
|
+
body,
|
|
23898
|
+
['PureCloud OAuth'],
|
|
23899
|
+
['application/json'],
|
|
23900
|
+
['application/json']
|
|
23901
|
+
);
|
|
23902
|
+
}
|
|
23903
|
+
|
|
23904
|
+
/**
|
|
23905
|
+
* Create a new settings
|
|
23906
|
+
*
|
|
23907
|
+
* @param {Object} body Setting
|
|
23908
|
+
*/
|
|
23909
|
+
postExternalcontactsImportSettings(body) {
|
|
23910
|
+
// verify the required parameter 'body' is set
|
|
23911
|
+
if (body === undefined || body === null) {
|
|
23912
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportSettings';
|
|
23913
|
+
}
|
|
23914
|
+
|
|
23915
|
+
return this.apiClient.callApi(
|
|
23916
|
+
'/api/v2/externalcontacts/import/settings',
|
|
23917
|
+
'POST',
|
|
23918
|
+
{ },
|
|
23919
|
+
{ },
|
|
23920
|
+
{ },
|
|
23921
|
+
{ },
|
|
23922
|
+
body,
|
|
23923
|
+
['PureCloud OAuth'],
|
|
23924
|
+
['application/json'],
|
|
23925
|
+
['application/json']
|
|
23926
|
+
);
|
|
23927
|
+
}
|
|
23928
|
+
|
|
23581
23929
|
/**
|
|
23582
23930
|
* Merge two contacts into a new contact record
|
|
23583
23931
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -23893,6 +24241,66 @@ class ExternalContactsApi {
|
|
|
23893
24241
|
);
|
|
23894
24242
|
}
|
|
23895
24243
|
|
|
24244
|
+
/**
|
|
24245
|
+
* Update Job's workflow status
|
|
24246
|
+
*
|
|
24247
|
+
* @param {String} jobId Job id
|
|
24248
|
+
* @param {Object} body Status of the Job's workflow
|
|
24249
|
+
*/
|
|
24250
|
+
putExternalcontactsImportJob(jobId, body) {
|
|
24251
|
+
// verify the required parameter 'jobId' is set
|
|
24252
|
+
if (jobId === undefined || jobId === null) {
|
|
24253
|
+
throw 'Missing the required parameter "jobId" when calling putExternalcontactsImportJob';
|
|
24254
|
+
}
|
|
24255
|
+
// verify the required parameter 'body' is set
|
|
24256
|
+
if (body === undefined || body === null) {
|
|
24257
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportJob';
|
|
24258
|
+
}
|
|
24259
|
+
|
|
24260
|
+
return this.apiClient.callApi(
|
|
24261
|
+
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
24262
|
+
'PUT',
|
|
24263
|
+
{ 'jobId': jobId },
|
|
24264
|
+
{ },
|
|
24265
|
+
{ },
|
|
24266
|
+
{ },
|
|
24267
|
+
body,
|
|
24268
|
+
['PureCloud OAuth'],
|
|
24269
|
+
['application/json'],
|
|
24270
|
+
['application/json']
|
|
24271
|
+
);
|
|
24272
|
+
}
|
|
24273
|
+
|
|
24274
|
+
/**
|
|
24275
|
+
* Update settings
|
|
24276
|
+
*
|
|
24277
|
+
* @param {String} settingsId Settings id
|
|
24278
|
+
* @param {Object} body Setting
|
|
24279
|
+
*/
|
|
24280
|
+
putExternalcontactsImportSetting(settingsId, body) {
|
|
24281
|
+
// verify the required parameter 'settingsId' is set
|
|
24282
|
+
if (settingsId === undefined || settingsId === null) {
|
|
24283
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportSetting';
|
|
24284
|
+
}
|
|
24285
|
+
// verify the required parameter 'body' is set
|
|
24286
|
+
if (body === undefined || body === null) {
|
|
24287
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportSetting';
|
|
24288
|
+
}
|
|
24289
|
+
|
|
24290
|
+
return this.apiClient.callApi(
|
|
24291
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
24292
|
+
'PUT',
|
|
24293
|
+
{ 'settingsId': settingsId },
|
|
24294
|
+
{ },
|
|
24295
|
+
{ },
|
|
24296
|
+
{ },
|
|
24297
|
+
body,
|
|
24298
|
+
['PureCloud OAuth'],
|
|
24299
|
+
['application/json'],
|
|
24300
|
+
['application/json']
|
|
24301
|
+
);
|
|
24302
|
+
}
|
|
24303
|
+
|
|
23896
24304
|
/**
|
|
23897
24305
|
* Update an external organization
|
|
23898
24306
|
*
|
|
@@ -24054,7 +24462,7 @@ class FaxApi {
|
|
|
24054
24462
|
/**
|
|
24055
24463
|
* Fax service.
|
|
24056
24464
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24057
|
-
* @version
|
|
24465
|
+
* @version 210.0.0
|
|
24058
24466
|
*/
|
|
24059
24467
|
|
|
24060
24468
|
/**
|
|
@@ -24269,7 +24677,7 @@ class FlowsApi {
|
|
|
24269
24677
|
/**
|
|
24270
24678
|
* Flows service.
|
|
24271
24679
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
24272
|
-
* @version
|
|
24680
|
+
* @version 210.0.0
|
|
24273
24681
|
*/
|
|
24274
24682
|
|
|
24275
24683
|
/**
|
|
@@ -24452,7 +24860,7 @@ class GamificationApi {
|
|
|
24452
24860
|
/**
|
|
24453
24861
|
* Gamification service.
|
|
24454
24862
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24455
|
-
* @version
|
|
24863
|
+
* @version 210.0.0
|
|
24456
24864
|
*/
|
|
24457
24865
|
|
|
24458
24866
|
/**
|
|
@@ -26538,7 +26946,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26538
26946
|
/**
|
|
26539
26947
|
* GeneralDataProtectionRegulation service.
|
|
26540
26948
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26541
|
-
* @version
|
|
26949
|
+
* @version 210.0.0
|
|
26542
26950
|
*/
|
|
26543
26951
|
|
|
26544
26952
|
/**
|
|
@@ -26668,7 +27076,7 @@ class GeolocationApi {
|
|
|
26668
27076
|
/**
|
|
26669
27077
|
* Geolocation service.
|
|
26670
27078
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26671
|
-
* @version
|
|
27079
|
+
* @version 210.0.0
|
|
26672
27080
|
*/
|
|
26673
27081
|
|
|
26674
27082
|
/**
|
|
@@ -26799,7 +27207,7 @@ class GreetingsApi {
|
|
|
26799
27207
|
/**
|
|
26800
27208
|
* Greetings service.
|
|
26801
27209
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26802
|
-
* @version
|
|
27210
|
+
* @version 210.0.0
|
|
26803
27211
|
*/
|
|
26804
27212
|
|
|
26805
27213
|
/**
|
|
@@ -27254,7 +27662,7 @@ class GroupsApi {
|
|
|
27254
27662
|
/**
|
|
27255
27663
|
* Groups service.
|
|
27256
27664
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27257
|
-
* @version
|
|
27665
|
+
* @version 210.0.0
|
|
27258
27666
|
*/
|
|
27259
27667
|
|
|
27260
27668
|
/**
|
|
@@ -27773,7 +28181,7 @@ class IdentityProviderApi {
|
|
|
27773
28181
|
/**
|
|
27774
28182
|
* IdentityProvider service.
|
|
27775
28183
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27776
|
-
* @version
|
|
28184
|
+
* @version 210.0.0
|
|
27777
28185
|
*/
|
|
27778
28186
|
|
|
27779
28187
|
/**
|
|
@@ -28634,7 +29042,7 @@ class InfrastructureAsCodeApi {
|
|
|
28634
29042
|
/**
|
|
28635
29043
|
* InfrastructureAsCode service.
|
|
28636
29044
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28637
|
-
* @version
|
|
29045
|
+
* @version 210.0.0
|
|
28638
29046
|
*/
|
|
28639
29047
|
|
|
28640
29048
|
/**
|
|
@@ -28801,7 +29209,7 @@ class IntegrationsApi {
|
|
|
28801
29209
|
/**
|
|
28802
29210
|
* Integrations service.
|
|
28803
29211
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28804
|
-
* @version
|
|
29212
|
+
* @version 210.0.0
|
|
28805
29213
|
*/
|
|
28806
29214
|
|
|
28807
29215
|
/**
|
|
@@ -31243,7 +31651,7 @@ class JourneyApi {
|
|
|
31243
31651
|
/**
|
|
31244
31652
|
* Journey service.
|
|
31245
31653
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31246
|
-
* @version
|
|
31654
|
+
* @version 210.0.0
|
|
31247
31655
|
*/
|
|
31248
31656
|
|
|
31249
31657
|
/**
|
|
@@ -31414,7 +31822,7 @@ class JourneyApi {
|
|
|
31414
31822
|
|
|
31415
31823
|
/**
|
|
31416
31824
|
* Delete the Schedule of a JourneyView
|
|
31417
|
-
*
|
|
31825
|
+
*
|
|
31418
31826
|
* @param {String} viewId Journey View Id
|
|
31419
31827
|
*/
|
|
31420
31828
|
deleteJourneyViewSchedules(viewId) {
|
|
@@ -32087,7 +32495,7 @@ class JourneyApi {
|
|
|
32087
32495
|
|
|
32088
32496
|
/**
|
|
32089
32497
|
* Get the Schedule for a JourneyView
|
|
32090
|
-
*
|
|
32498
|
+
*
|
|
32091
32499
|
* @param {String} viewId Journey View Id
|
|
32092
32500
|
*/
|
|
32093
32501
|
getJourneyViewSchedules(viewId) {
|
|
@@ -32217,7 +32625,7 @@ class JourneyApi {
|
|
|
32217
32625
|
|
|
32218
32626
|
/**
|
|
32219
32627
|
* Get the job for a journey view version.
|
|
32220
|
-
*
|
|
32628
|
+
*
|
|
32221
32629
|
* @param {String} viewId Journey View Id
|
|
32222
32630
|
* @param {String} journeyVersionId Journey View Version
|
|
32223
32631
|
* @param {String} jobId JobId
|
|
@@ -32252,7 +32660,7 @@ class JourneyApi {
|
|
|
32252
32660
|
|
|
32253
32661
|
/**
|
|
32254
32662
|
* Get the result of a job for a journey view version.
|
|
32255
|
-
*
|
|
32663
|
+
*
|
|
32256
32664
|
* @param {String} viewId JourneyViewResult id
|
|
32257
32665
|
* @param {String} journeyViewVersion Journey View Version
|
|
32258
32666
|
* @param {String} jobId Id of the executing job
|
|
@@ -32327,7 +32735,7 @@ class JourneyApi {
|
|
|
32327
32735
|
|
|
32328
32736
|
/**
|
|
32329
32737
|
* Get the latest job of a journey view version.
|
|
32330
|
-
*
|
|
32738
|
+
*
|
|
32331
32739
|
* @param {String} viewId Journey View Id
|
|
32332
32740
|
* @param {String} journeyVersionId Journey View Version
|
|
32333
32741
|
*/
|
|
@@ -32627,7 +33035,7 @@ class JourneyApi {
|
|
|
32627
33035
|
|
|
32628
33036
|
/**
|
|
32629
33037
|
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
32630
|
-
*
|
|
33038
|
+
*
|
|
32631
33039
|
* @param {String} viewId Journey View Id
|
|
32632
33040
|
* @param {String} journeyVersionId Journey View Version
|
|
32633
33041
|
* @param {String} jobId JobId
|
|
@@ -33030,7 +33438,7 @@ class JourneyApi {
|
|
|
33030
33438
|
|
|
33031
33439
|
/**
|
|
33032
33440
|
* Submit a job request for a journey view version.
|
|
33033
|
-
*
|
|
33441
|
+
*
|
|
33034
33442
|
* @param {String} viewId Journey View Id
|
|
33035
33443
|
* @param {String} journeyVersionId Journey View Version
|
|
33036
33444
|
*/
|
|
@@ -33139,7 +33547,7 @@ class JourneyApi {
|
|
|
33139
33547
|
|
|
33140
33548
|
/**
|
|
33141
33549
|
* Update the Schedule for a JourneyView
|
|
33142
|
-
*
|
|
33550
|
+
*
|
|
33143
33551
|
* @param {String} viewId Journey View Id
|
|
33144
33552
|
* @param {Object} body journeyViewSchedule
|
|
33145
33553
|
*/
|
|
@@ -33208,7 +33616,7 @@ class KnowledgeApi {
|
|
|
33208
33616
|
/**
|
|
33209
33617
|
* Knowledge service.
|
|
33210
33618
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
33211
|
-
* @version
|
|
33619
|
+
* @version 210.0.0
|
|
33212
33620
|
*/
|
|
33213
33621
|
|
|
33214
33622
|
/**
|
|
@@ -33732,8 +34140,12 @@ class KnowledgeApi {
|
|
|
33732
34140
|
* Get sync options available for a knowledge-connect integration
|
|
33733
34141
|
*
|
|
33734
34142
|
* @param {String} integrationId Integration ID
|
|
34143
|
+
* @param {Object} opts Optional parameters
|
|
34144
|
+
* @param {Array.<String>} opts.knowledgeBaseIds Narrowing down filtering option results by knowledge base.
|
|
33735
34145
|
*/
|
|
33736
|
-
getKnowledgeIntegrationOptions(integrationId) {
|
|
34146
|
+
getKnowledgeIntegrationOptions(integrationId, opts) {
|
|
34147
|
+
opts = opts || {};
|
|
34148
|
+
|
|
33737
34149
|
// verify the required parameter 'integrationId' is set
|
|
33738
34150
|
if (integrationId === undefined || integrationId === null) {
|
|
33739
34151
|
throw 'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';
|
|
@@ -33743,7 +34155,7 @@ class KnowledgeApi {
|
|
|
33743
34155
|
'/api/v2/knowledge/integrations/{integrationId}/options',
|
|
33744
34156
|
'GET',
|
|
33745
34157
|
{ 'integrationId': integrationId },
|
|
33746
|
-
{
|
|
34158
|
+
{ 'knowledgeBaseIds': this.apiClient.buildCollectionParam(opts['knowledgeBaseIds'], 'multi') },
|
|
33747
34159
|
{ },
|
|
33748
34160
|
{ },
|
|
33749
34161
|
null,
|
|
@@ -37080,7 +37492,7 @@ class LanguageUnderstandingApi {
|
|
|
37080
37492
|
/**
|
|
37081
37493
|
* LanguageUnderstanding service.
|
|
37082
37494
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
37083
|
-
* @version
|
|
37495
|
+
* @version 210.0.0
|
|
37084
37496
|
*/
|
|
37085
37497
|
|
|
37086
37498
|
/**
|
|
@@ -38114,7 +38526,7 @@ class LanguagesApi {
|
|
|
38114
38526
|
/**
|
|
38115
38527
|
* Languages service.
|
|
38116
38528
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
38117
|
-
* @version
|
|
38529
|
+
* @version 210.0.0
|
|
38118
38530
|
*/
|
|
38119
38531
|
|
|
38120
38532
|
/**
|
|
@@ -38336,7 +38748,7 @@ class LearningApi {
|
|
|
38336
38748
|
/**
|
|
38337
38749
|
* Learning service.
|
|
38338
38750
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
38339
|
-
* @version
|
|
38751
|
+
* @version 210.0.0
|
|
38340
38752
|
*/
|
|
38341
38753
|
|
|
38342
38754
|
/**
|
|
@@ -39365,7 +39777,7 @@ class LicenseApi {
|
|
|
39365
39777
|
/**
|
|
39366
39778
|
* License service.
|
|
39367
39779
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
39368
|
-
* @version
|
|
39780
|
+
* @version 210.0.0
|
|
39369
39781
|
*/
|
|
39370
39782
|
|
|
39371
39783
|
/**
|
|
@@ -39603,7 +40015,7 @@ class LocationsApi {
|
|
|
39603
40015
|
/**
|
|
39604
40016
|
* Locations service.
|
|
39605
40017
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39606
|
-
* @version
|
|
40018
|
+
* @version 210.0.0
|
|
39607
40019
|
*/
|
|
39608
40020
|
|
|
39609
40021
|
/**
|
|
@@ -39839,7 +40251,7 @@ class LogCaptureApi {
|
|
|
39839
40251
|
/**
|
|
39840
40252
|
* LogCapture service.
|
|
39841
40253
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39842
|
-
* @version
|
|
40254
|
+
* @version 210.0.0
|
|
39843
40255
|
*/
|
|
39844
40256
|
|
|
39845
40257
|
/**
|
|
@@ -40039,7 +40451,7 @@ class MessagingApi {
|
|
|
40039
40451
|
/**
|
|
40040
40452
|
* Messaging service.
|
|
40041
40453
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40042
|
-
* @version
|
|
40454
|
+
* @version 210.0.0
|
|
40043
40455
|
*/
|
|
40044
40456
|
|
|
40045
40457
|
/**
|
|
@@ -40398,7 +40810,7 @@ class MobileDevicesApi {
|
|
|
40398
40810
|
/**
|
|
40399
40811
|
* MobileDevices service.
|
|
40400
40812
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
40401
|
-
* @version
|
|
40813
|
+
* @version 210.0.0
|
|
40402
40814
|
*/
|
|
40403
40815
|
|
|
40404
40816
|
/**
|
|
@@ -40549,7 +40961,7 @@ class NotificationsApi {
|
|
|
40549
40961
|
/**
|
|
40550
40962
|
* Notifications service.
|
|
40551
40963
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40552
|
-
* @version
|
|
40964
|
+
* @version 210.0.0
|
|
40553
40965
|
*/
|
|
40554
40966
|
|
|
40555
40967
|
/**
|
|
@@ -40782,7 +41194,7 @@ class OAuthApi {
|
|
|
40782
41194
|
/**
|
|
40783
41195
|
* OAuth service.
|
|
40784
41196
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40785
|
-
* @version
|
|
41197
|
+
* @version 210.0.0
|
|
40786
41198
|
*/
|
|
40787
41199
|
|
|
40788
41200
|
/**
|
|
@@ -41148,7 +41560,7 @@ class ObjectsApi {
|
|
|
41148
41560
|
/**
|
|
41149
41561
|
* Objects service.
|
|
41150
41562
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
41151
|
-
* @version
|
|
41563
|
+
* @version 210.0.0
|
|
41152
41564
|
*/
|
|
41153
41565
|
|
|
41154
41566
|
/**
|
|
@@ -41418,7 +41830,7 @@ class OperationalEventsApi {
|
|
|
41418
41830
|
/**
|
|
41419
41831
|
* OperationalEvents service.
|
|
41420
41832
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
41421
|
-
* @version
|
|
41833
|
+
* @version 210.0.0
|
|
41422
41834
|
*/
|
|
41423
41835
|
|
|
41424
41836
|
/**
|
|
@@ -41478,13 +41890,64 @@ class OperationalEventsApi {
|
|
|
41478
41890
|
);
|
|
41479
41891
|
}
|
|
41480
41892
|
|
|
41893
|
+
/**
|
|
41894
|
+
* Get aggregates for operational events in a timeframe.
|
|
41895
|
+
*
|
|
41896
|
+
* @param {Object} opts Optional parameters
|
|
41897
|
+
* @param {Object} opts.body
|
|
41898
|
+
*/
|
|
41899
|
+
postUsageEventsAggregatesQuery(opts) {
|
|
41900
|
+
opts = opts || {};
|
|
41901
|
+
|
|
41902
|
+
|
|
41903
|
+
return this.apiClient.callApi(
|
|
41904
|
+
'/api/v2/usage/events/aggregates/query',
|
|
41905
|
+
'POST',
|
|
41906
|
+
{ },
|
|
41907
|
+
{ },
|
|
41908
|
+
{ },
|
|
41909
|
+
{ },
|
|
41910
|
+
opts['body'],
|
|
41911
|
+
['PureCloud OAuth'],
|
|
41912
|
+
['application/json'],
|
|
41913
|
+
['application/json']
|
|
41914
|
+
);
|
|
41915
|
+
}
|
|
41916
|
+
|
|
41917
|
+
/**
|
|
41918
|
+
* Query operational events in a timeframe.
|
|
41919
|
+
*
|
|
41920
|
+
* @param {Object} opts Optional parameters
|
|
41921
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41922
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41923
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41924
|
+
* @param {Object} opts.body
|
|
41925
|
+
*/
|
|
41926
|
+
postUsageEventsQuery(opts) {
|
|
41927
|
+
opts = opts || {};
|
|
41928
|
+
|
|
41929
|
+
|
|
41930
|
+
return this.apiClient.callApi(
|
|
41931
|
+
'/api/v2/usage/events/query',
|
|
41932
|
+
'POST',
|
|
41933
|
+
{ },
|
|
41934
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
41935
|
+
{ },
|
|
41936
|
+
{ },
|
|
41937
|
+
opts['body'],
|
|
41938
|
+
['PureCloud OAuth'],
|
|
41939
|
+
['application/json'],
|
|
41940
|
+
['application/json']
|
|
41941
|
+
);
|
|
41942
|
+
}
|
|
41943
|
+
|
|
41481
41944
|
}
|
|
41482
41945
|
|
|
41483
41946
|
class OrganizationApi {
|
|
41484
41947
|
/**
|
|
41485
41948
|
* Organization service.
|
|
41486
41949
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41487
|
-
* @version
|
|
41950
|
+
* @version 210.0.0
|
|
41488
41951
|
*/
|
|
41489
41952
|
|
|
41490
41953
|
/**
|
|
@@ -42026,7 +42489,7 @@ class OrganizationAuthorizationApi {
|
|
|
42026
42489
|
/**
|
|
42027
42490
|
* OrganizationAuthorization service.
|
|
42028
42491
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42029
|
-
* @version
|
|
42492
|
+
* @version 210.0.0
|
|
42030
42493
|
*/
|
|
42031
42494
|
|
|
42032
42495
|
/**
|
|
@@ -43420,7 +43883,7 @@ class OutboundApi {
|
|
|
43420
43883
|
/**
|
|
43421
43884
|
* Outbound service.
|
|
43422
43885
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
43423
|
-
* @version
|
|
43886
|
+
* @version 210.0.0
|
|
43424
43887
|
*/
|
|
43425
43888
|
|
|
43426
43889
|
/**
|
|
@@ -47967,7 +48430,7 @@ class PresenceApi {
|
|
|
47967
48430
|
/**
|
|
47968
48431
|
* Presence service.
|
|
47969
48432
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47970
|
-
* @version
|
|
48433
|
+
* @version 210.0.0
|
|
47971
48434
|
*/
|
|
47972
48435
|
|
|
47973
48436
|
/**
|
|
@@ -48711,7 +49174,7 @@ class ProcessAutomationApi {
|
|
|
48711
49174
|
/**
|
|
48712
49175
|
* ProcessAutomation service.
|
|
48713
49176
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48714
|
-
* @version
|
|
49177
|
+
* @version 210.0.0
|
|
48715
49178
|
*/
|
|
48716
49179
|
|
|
48717
49180
|
/**
|
|
@@ -48950,7 +49413,7 @@ class QualityApi {
|
|
|
48950
49413
|
/**
|
|
48951
49414
|
* Quality service.
|
|
48952
49415
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48953
|
-
* @version
|
|
49416
|
+
* @version 210.0.0
|
|
48954
49417
|
*/
|
|
48955
49418
|
|
|
48956
49419
|
/**
|
|
@@ -49235,6 +49698,7 @@ class QualityApi {
|
|
|
49235
49698
|
* @param {String} opts.group group id
|
|
49236
49699
|
* @param {String} opts.agentTeamId team id of agents requested
|
|
49237
49700
|
* @param {String} opts.formContextId shared id between form versions
|
|
49701
|
+
* @param {Object} opts.userState 'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. 'Any' fetches users of 'active', 'inactive' and 'deleted' states. (default to Legacy)
|
|
49238
49702
|
*/
|
|
49239
49703
|
getQualityAgentsActivity(opts) {
|
|
49240
49704
|
opts = opts || {};
|
|
@@ -49244,7 +49708,7 @@ class QualityApi {
|
|
|
49244
49708
|
'/api/v2/quality/agents/activity',
|
|
49245
49709
|
'GET',
|
|
49246
49710
|
{ },
|
|
49247
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'agentTeamId': opts['agentTeamId'],'formContextId': opts['formContextId'] },
|
|
49711
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'agentTeamId': opts['agentTeamId'],'formContextId': opts['formContextId'],'userState': opts['userState'] },
|
|
49248
49712
|
{ },
|
|
49249
49713
|
{ },
|
|
49250
49714
|
null,
|
|
@@ -49459,6 +49923,7 @@ class QualityApi {
|
|
|
49459
49923
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.
|
|
49460
49924
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
49461
49925
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
49926
|
+
* @param {Boolean} opts.includeDeletedUsers Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (default to false)
|
|
49462
49927
|
*/
|
|
49463
49928
|
getQualityEvaluationsQuery(opts) {
|
|
49464
49929
|
opts = opts || {};
|
|
@@ -49468,7 +49933,7 @@ class QualityApi {
|
|
|
49468
49933
|
'/api/v2/quality/evaluations/query',
|
|
49469
49934
|
'GET',
|
|
49470
49935
|
{ },
|
|
49471
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
49936
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'],'includeDeletedUsers': opts['includeDeletedUsers'] },
|
|
49472
49937
|
{ },
|
|
49473
49938
|
{ },
|
|
49474
49939
|
null,
|
|
@@ -50736,7 +51201,7 @@ class RecordingApi {
|
|
|
50736
51201
|
/**
|
|
50737
51202
|
* Recording service.
|
|
50738
51203
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50739
|
-
* @version
|
|
51204
|
+
* @version 210.0.0
|
|
50740
51205
|
*/
|
|
50741
51206
|
|
|
50742
51207
|
/**
|
|
@@ -52395,7 +52860,7 @@ class ResponseManagementApi {
|
|
|
52395
52860
|
/**
|
|
52396
52861
|
* ResponseManagement service.
|
|
52397
52862
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
52398
|
-
* @version
|
|
52863
|
+
* @version 210.0.0
|
|
52399
52864
|
*/
|
|
52400
52865
|
|
|
52401
52866
|
/**
|
|
@@ -52905,7 +53370,7 @@ class RoutingApi {
|
|
|
52905
53370
|
/**
|
|
52906
53371
|
* Routing service.
|
|
52907
53372
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52908
|
-
* @version
|
|
53373
|
+
* @version 210.0.0
|
|
52909
53374
|
*/
|
|
52910
53375
|
|
|
52911
53376
|
/**
|
|
@@ -53313,18 +53778,18 @@ class RoutingApi {
|
|
|
53313
53778
|
/**
|
|
53314
53779
|
* Delete a phone number provisioned for SMS.
|
|
53315
53780
|
*
|
|
53316
|
-
* @param {String}
|
|
53781
|
+
* @param {String} phoneNumberId phone number
|
|
53317
53782
|
*/
|
|
53318
|
-
deleteRoutingSmsPhonenumber(
|
|
53319
|
-
// verify the required parameter '
|
|
53320
|
-
if (
|
|
53321
|
-
throw 'Missing the required parameter "
|
|
53783
|
+
deleteRoutingSmsPhonenumber(phoneNumberId) {
|
|
53784
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
53785
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
53786
|
+
throw 'Missing the required parameter "phoneNumberId" when calling deleteRoutingSmsPhonenumber';
|
|
53322
53787
|
}
|
|
53323
53788
|
|
|
53324
53789
|
return this.apiClient.callApi(
|
|
53325
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
53790
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
53326
53791
|
'DELETE',
|
|
53327
|
-
{ '
|
|
53792
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
53328
53793
|
{ },
|
|
53329
53794
|
{ },
|
|
53330
53795
|
{ },
|
|
@@ -54303,9 +54768,13 @@ class RoutingApi {
|
|
|
54303
54768
|
* Get Estimated Wait Time
|
|
54304
54769
|
*
|
|
54305
54770
|
* @param {String} queueId queueId
|
|
54306
|
-
* @param {
|
|
54771
|
+
* @param {Object} mediaType mediaType
|
|
54772
|
+
* @param {Object} opts Optional parameters
|
|
54773
|
+
* @param {String} opts.labelId Unique id that represents the interaction label used with media type for EWT calculation
|
|
54307
54774
|
*/
|
|
54308
|
-
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType) {
|
|
54775
|
+
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType, opts) {
|
|
54776
|
+
opts = opts || {};
|
|
54777
|
+
|
|
54309
54778
|
// verify the required parameter 'queueId' is set
|
|
54310
54779
|
if (queueId === undefined || queueId === null) {
|
|
54311
54780
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';
|
|
@@ -54319,7 +54788,7 @@ class RoutingApi {
|
|
|
54319
54788
|
'/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime',
|
|
54320
54789
|
'GET',
|
|
54321
54790
|
{ 'queueId': queueId,'mediaType': mediaType },
|
|
54322
|
-
{
|
|
54791
|
+
{ 'labelId': opts['labelId'] },
|
|
54323
54792
|
{ },
|
|
54324
54793
|
{ },
|
|
54325
54794
|
null,
|
|
@@ -54870,22 +55339,22 @@ class RoutingApi {
|
|
|
54870
55339
|
/**
|
|
54871
55340
|
* Get a phone number provisioned for SMS.
|
|
54872
55341
|
*
|
|
54873
|
-
* @param {String}
|
|
55342
|
+
* @param {String} phoneNumberId phone number
|
|
54874
55343
|
* @param {Object} opts Optional parameters
|
|
54875
55344
|
* @param {Object} opts.expand Expand response with additional information
|
|
54876
55345
|
*/
|
|
54877
|
-
getRoutingSmsPhonenumber(
|
|
55346
|
+
getRoutingSmsPhonenumber(phoneNumberId, opts) {
|
|
54878
55347
|
opts = opts || {};
|
|
54879
55348
|
|
|
54880
|
-
// verify the required parameter '
|
|
54881
|
-
if (
|
|
54882
|
-
throw 'Missing the required parameter "
|
|
55349
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
55350
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
55351
|
+
throw 'Missing the required parameter "phoneNumberId" when calling getRoutingSmsPhonenumber';
|
|
54883
55352
|
}
|
|
54884
55353
|
|
|
54885
55354
|
return this.apiClient.callApi(
|
|
54886
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
55355
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
54887
55356
|
'GET',
|
|
54888
|
-
{ '
|
|
55357
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
54889
55358
|
{ 'expand': opts['expand'] },
|
|
54890
55359
|
{ },
|
|
54891
55360
|
{ },
|
|
@@ -56810,13 +57279,13 @@ class RoutingApi {
|
|
|
56810
57279
|
/**
|
|
56811
57280
|
* Update a phone number provisioned for SMS.
|
|
56812
57281
|
*
|
|
56813
|
-
* @param {String}
|
|
57282
|
+
* @param {String} phoneNumberId phone number
|
|
56814
57283
|
* @param {Object} body SmsPhoneNumber
|
|
56815
57284
|
*/
|
|
56816
|
-
putRoutingSmsPhonenumber(
|
|
56817
|
-
// verify the required parameter '
|
|
56818
|
-
if (
|
|
56819
|
-
throw 'Missing the required parameter "
|
|
57285
|
+
putRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
57286
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
57287
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
57288
|
+
throw 'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';
|
|
56820
57289
|
}
|
|
56821
57290
|
// verify the required parameter 'body' is set
|
|
56822
57291
|
if (body === undefined || body === null) {
|
|
@@ -56824,9 +57293,9 @@ class RoutingApi {
|
|
|
56824
57293
|
}
|
|
56825
57294
|
|
|
56826
57295
|
return this.apiClient.callApi(
|
|
56827
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
57296
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
56828
57297
|
'PUT',
|
|
56829
|
-
{ '
|
|
57298
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
56830
57299
|
{ },
|
|
56831
57300
|
{ },
|
|
56832
57301
|
{ },
|
|
@@ -57053,7 +57522,7 @@ class SCIMApi {
|
|
|
57053
57522
|
/**
|
|
57054
57523
|
* SCIM service.
|
|
57055
57524
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
57056
|
-
* @version
|
|
57525
|
+
* @version 210.0.0
|
|
57057
57526
|
*/
|
|
57058
57527
|
|
|
57059
57528
|
/**
|
|
@@ -57930,7 +58399,7 @@ class ScreenRecordingApi {
|
|
|
57930
58399
|
/**
|
|
57931
58400
|
* ScreenRecording service.
|
|
57932
58401
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57933
|
-
* @version
|
|
58402
|
+
* @version 210.0.0
|
|
57934
58403
|
*/
|
|
57935
58404
|
|
|
57936
58405
|
/**
|
|
@@ -57975,7 +58444,7 @@ class ScriptsApi {
|
|
|
57975
58444
|
/**
|
|
57976
58445
|
* Scripts service.
|
|
57977
58446
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57978
|
-
* @version
|
|
58447
|
+
* @version 210.0.0
|
|
57979
58448
|
*/
|
|
57980
58449
|
|
|
57981
58450
|
/**
|
|
@@ -58419,7 +58888,7 @@ class SearchApi {
|
|
|
58419
58888
|
/**
|
|
58420
58889
|
* Search service.
|
|
58421
58890
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
58422
|
-
* @version
|
|
58891
|
+
* @version 210.0.0
|
|
58423
58892
|
*/
|
|
58424
58893
|
|
|
58425
58894
|
/**
|
|
@@ -59162,7 +59631,7 @@ class SettingsApi {
|
|
|
59162
59631
|
/**
|
|
59163
59632
|
* Settings service.
|
|
59164
59633
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
59165
|
-
* @version
|
|
59634
|
+
* @version 210.0.0
|
|
59166
59635
|
*/
|
|
59167
59636
|
|
|
59168
59637
|
/**
|
|
@@ -59378,11 +59847,916 @@ class SettingsApi {
|
|
|
59378
59847
|
|
|
59379
59848
|
}
|
|
59380
59849
|
|
|
59850
|
+
class SocialMediaApi {
|
|
59851
|
+
/**
|
|
59852
|
+
* SocialMedia service.
|
|
59853
|
+
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
59854
|
+
* @version 210.0.0
|
|
59855
|
+
*/
|
|
59856
|
+
|
|
59857
|
+
/**
|
|
59858
|
+
* Constructs a new SocialMediaApi.
|
|
59859
|
+
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
59860
|
+
* @class
|
|
59861
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
59862
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
59863
|
+
*/
|
|
59864
|
+
constructor(apiClient) {
|
|
59865
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
59866
|
+
}
|
|
59867
|
+
|
|
59868
|
+
|
|
59869
|
+
/**
|
|
59870
|
+
* Delete a social topic.
|
|
59871
|
+
*
|
|
59872
|
+
* @param {String} topicId topicId
|
|
59873
|
+
* @param {Object} opts Optional parameters
|
|
59874
|
+
* @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.
|
|
59875
|
+
* deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59876
|
+
*/
|
|
59877
|
+
deleteSocialmediaTopic(topicId, opts) {
|
|
59878
|
+
opts = opts || {};
|
|
59879
|
+
|
|
59880
|
+
// verify the required parameter 'topicId' is set
|
|
59881
|
+
if (topicId === undefined || topicId === null) {
|
|
59882
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopic';
|
|
59883
|
+
}
|
|
59884
|
+
|
|
59885
|
+
return this.apiClient.callApi(
|
|
59886
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
59887
|
+
'DELETE',
|
|
59888
|
+
{ 'topicId': topicId },
|
|
59889
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59890
|
+
{ },
|
|
59891
|
+
{ },
|
|
59892
|
+
null,
|
|
59893
|
+
['PureCloud OAuth'],
|
|
59894
|
+
['application/json'],
|
|
59895
|
+
['application/json']
|
|
59896
|
+
);
|
|
59897
|
+
}
|
|
59898
|
+
|
|
59899
|
+
/**
|
|
59900
|
+
* Delete a Facebook data ingestion rule.
|
|
59901
|
+
*
|
|
59902
|
+
* @param {String} topicId topicId
|
|
59903
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59904
|
+
* @param {Object} opts Optional parameters
|
|
59905
|
+
* @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)
|
|
59906
|
+
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59907
|
+
*/
|
|
59908
|
+
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
59909
|
+
opts = opts || {};
|
|
59910
|
+
|
|
59911
|
+
// verify the required parameter 'topicId' is set
|
|
59912
|
+
if (topicId === undefined || topicId === null) {
|
|
59913
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59914
|
+
}
|
|
59915
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59916
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59917
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59918
|
+
}
|
|
59919
|
+
|
|
59920
|
+
return this.apiClient.callApi(
|
|
59921
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
59922
|
+
'DELETE',
|
|
59923
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59924
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59925
|
+
{ },
|
|
59926
|
+
{ },
|
|
59927
|
+
null,
|
|
59928
|
+
['PureCloud OAuth'],
|
|
59929
|
+
['application/json'],
|
|
59930
|
+
['application/json']
|
|
59931
|
+
);
|
|
59932
|
+
}
|
|
59933
|
+
|
|
59934
|
+
/**
|
|
59935
|
+
* Delete a open data ingestion rule.
|
|
59936
|
+
*
|
|
59937
|
+
* @param {String} topicId topicId
|
|
59938
|
+
* @param {String} openId openId
|
|
59939
|
+
* @param {Object} opts Optional parameters
|
|
59940
|
+
* @param {Boolean} opts.hardDelete Determines whether a open 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)
|
|
59941
|
+
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59942
|
+
*/
|
|
59943
|
+
deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
59944
|
+
opts = opts || {};
|
|
59945
|
+
|
|
59946
|
+
// verify the required parameter 'topicId' is set
|
|
59947
|
+
if (topicId === undefined || topicId === null) {
|
|
59948
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59949
|
+
}
|
|
59950
|
+
// verify the required parameter 'openId' is set
|
|
59951
|
+
if (openId === undefined || openId === null) {
|
|
59952
|
+
throw 'Missing the required parameter "openId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59953
|
+
}
|
|
59954
|
+
|
|
59955
|
+
return this.apiClient.callApi(
|
|
59956
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
59957
|
+
'DELETE',
|
|
59958
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59959
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59960
|
+
{ },
|
|
59961
|
+
{ },
|
|
59962
|
+
null,
|
|
59963
|
+
['PureCloud OAuth'],
|
|
59964
|
+
['application/json'],
|
|
59965
|
+
['application/json']
|
|
59966
|
+
);
|
|
59967
|
+
}
|
|
59968
|
+
|
|
59969
|
+
/**
|
|
59970
|
+
* Delete a X (formally Twitter) data ingestion rule.
|
|
59971
|
+
*
|
|
59972
|
+
* @param {String} topicId topicId
|
|
59973
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59974
|
+
* @param {Object} opts Optional parameters
|
|
59975
|
+
* @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)
|
|
59976
|
+
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59977
|
+
*/
|
|
59978
|
+
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
59979
|
+
opts = opts || {};
|
|
59980
|
+
|
|
59981
|
+
// verify the required parameter 'topicId' is set
|
|
59982
|
+
if (topicId === undefined || topicId === null) {
|
|
59983
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59984
|
+
}
|
|
59985
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59986
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59987
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59988
|
+
}
|
|
59989
|
+
|
|
59990
|
+
return this.apiClient.callApi(
|
|
59991
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
59992
|
+
'DELETE',
|
|
59993
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59994
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59995
|
+
{ },
|
|
59996
|
+
{ },
|
|
59997
|
+
null,
|
|
59998
|
+
['PureCloud OAuth'],
|
|
59999
|
+
['application/json'],
|
|
60000
|
+
['application/json']
|
|
60001
|
+
);
|
|
60002
|
+
}
|
|
60003
|
+
|
|
60004
|
+
/**
|
|
60005
|
+
* Get a single social topic.
|
|
60006
|
+
*
|
|
60007
|
+
* @param {String} topicId topicId
|
|
60008
|
+
* @param {Object} opts Optional parameters
|
|
60009
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60010
|
+
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60011
|
+
*/
|
|
60012
|
+
getSocialmediaTopic(topicId, opts) {
|
|
60013
|
+
opts = opts || {};
|
|
60014
|
+
|
|
60015
|
+
// verify the required parameter 'topicId' is set
|
|
60016
|
+
if (topicId === undefined || topicId === null) {
|
|
60017
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopic';
|
|
60018
|
+
}
|
|
60019
|
+
|
|
60020
|
+
return this.apiClient.callApi(
|
|
60021
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
60022
|
+
'GET',
|
|
60023
|
+
{ 'topicId': topicId },
|
|
60024
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60025
|
+
{ },
|
|
60026
|
+
{ },
|
|
60027
|
+
null,
|
|
60028
|
+
['PureCloud OAuth'],
|
|
60029
|
+
['application/json'],
|
|
60030
|
+
['application/json']
|
|
60031
|
+
);
|
|
60032
|
+
}
|
|
60033
|
+
|
|
60034
|
+
/**
|
|
60035
|
+
* Get a single Facebook data ingestion rule.
|
|
60036
|
+
*
|
|
60037
|
+
* @param {String} topicId topicId
|
|
60038
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60039
|
+
* @param {Object} opts Optional parameters
|
|
60040
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60041
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60042
|
+
*/
|
|
60043
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60044
|
+
opts = opts || {};
|
|
60045
|
+
|
|
60046
|
+
// verify the required parameter 'topicId' is set
|
|
60047
|
+
if (topicId === undefined || topicId === null) {
|
|
60048
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60049
|
+
}
|
|
60050
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60051
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60052
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60053
|
+
}
|
|
60054
|
+
|
|
60055
|
+
return this.apiClient.callApi(
|
|
60056
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60057
|
+
'GET',
|
|
60058
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60059
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60060
|
+
{ },
|
|
60061
|
+
{ },
|
|
60062
|
+
null,
|
|
60063
|
+
['PureCloud OAuth'],
|
|
60064
|
+
['application/json'],
|
|
60065
|
+
['application/json']
|
|
60066
|
+
);
|
|
60067
|
+
}
|
|
60068
|
+
|
|
60069
|
+
/**
|
|
60070
|
+
* Get a single Facebook data ingestion rule version.
|
|
60071
|
+
*
|
|
60072
|
+
* @param {String} topicId topicId
|
|
60073
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60074
|
+
* @param {String} dataIngestionRuleVersion version
|
|
60075
|
+
* @param {Object} opts Optional parameters
|
|
60076
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
60077
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60078
|
+
*/
|
|
60079
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
60080
|
+
opts = opts || {};
|
|
60081
|
+
|
|
60082
|
+
// verify the required parameter 'topicId' is set
|
|
60083
|
+
if (topicId === undefined || topicId === null) {
|
|
60084
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
60085
|
+
}
|
|
60086
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60087
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60088
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
60089
|
+
}
|
|
60090
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
60091
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
60092
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
60093
|
+
}
|
|
60094
|
+
|
|
60095
|
+
return this.apiClient.callApi(
|
|
60096
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
60097
|
+
'GET',
|
|
60098
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
60099
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60100
|
+
{ },
|
|
60101
|
+
{ },
|
|
60102
|
+
null,
|
|
60103
|
+
['PureCloud OAuth'],
|
|
60104
|
+
['application/json'],
|
|
60105
|
+
['application/json']
|
|
60106
|
+
);
|
|
60107
|
+
}
|
|
60108
|
+
|
|
60109
|
+
/**
|
|
60110
|
+
* Get the Facebook data ingestion rule versions.
|
|
60111
|
+
*
|
|
60112
|
+
* @param {String} topicId topicId
|
|
60113
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60114
|
+
* @param {Object} opts Optional parameters
|
|
60115
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60116
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60117
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60118
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60119
|
+
*/
|
|
60120
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
|
|
60121
|
+
opts = opts || {};
|
|
60122
|
+
|
|
60123
|
+
// verify the required parameter 'topicId' is set
|
|
60124
|
+
if (topicId === undefined || topicId === null) {
|
|
60125
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
60126
|
+
}
|
|
60127
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60128
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60129
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
60130
|
+
}
|
|
60131
|
+
|
|
60132
|
+
return this.apiClient.callApi(
|
|
60133
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions',
|
|
60134
|
+
'GET',
|
|
60135
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60136
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
60137
|
+
{ },
|
|
60138
|
+
{ },
|
|
60139
|
+
null,
|
|
60140
|
+
['PureCloud OAuth'],
|
|
60141
|
+
['application/json'],
|
|
60142
|
+
['application/json']
|
|
60143
|
+
);
|
|
60144
|
+
}
|
|
60145
|
+
|
|
60146
|
+
/**
|
|
60147
|
+
* Get a single open data ingestion rule.
|
|
60148
|
+
*
|
|
60149
|
+
* @param {String} topicId topicId
|
|
60150
|
+
* @param {String} openId openId
|
|
60151
|
+
* @param {Object} opts Optional parameters
|
|
60152
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60153
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60154
|
+
*/
|
|
60155
|
+
getSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60156
|
+
opts = opts || {};
|
|
60157
|
+
|
|
60158
|
+
// verify the required parameter 'topicId' is set
|
|
60159
|
+
if (topicId === undefined || topicId === null) {
|
|
60160
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60161
|
+
}
|
|
60162
|
+
// verify the required parameter 'openId' is set
|
|
60163
|
+
if (openId === undefined || openId === null) {
|
|
60164
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60165
|
+
}
|
|
60166
|
+
|
|
60167
|
+
return this.apiClient.callApi(
|
|
60168
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60169
|
+
'GET',
|
|
60170
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60171
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60172
|
+
{ },
|
|
60173
|
+
{ },
|
|
60174
|
+
null,
|
|
60175
|
+
['PureCloud OAuth'],
|
|
60176
|
+
['application/json'],
|
|
60177
|
+
['application/json']
|
|
60178
|
+
);
|
|
60179
|
+
}
|
|
60180
|
+
|
|
60181
|
+
/**
|
|
60182
|
+
* Get a single Open data ingestion rule version.
|
|
60183
|
+
*
|
|
60184
|
+
* @param {String} topicId topicId
|
|
60185
|
+
* @param {String} openId openId
|
|
60186
|
+
* @param {String} dataIngestionRuleVersion version
|
|
60187
|
+
* @param {Object} opts Optional parameters
|
|
60188
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
60189
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60190
|
+
*/
|
|
60191
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId, openId, dataIngestionRuleVersion, opts) {
|
|
60192
|
+
opts = opts || {};
|
|
60193
|
+
|
|
60194
|
+
// verify the required parameter 'topicId' is set
|
|
60195
|
+
if (topicId === undefined || topicId === null) {
|
|
60196
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
60197
|
+
}
|
|
60198
|
+
// verify the required parameter 'openId' is set
|
|
60199
|
+
if (openId === undefined || openId === null) {
|
|
60200
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
60201
|
+
}
|
|
60202
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
60203
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
60204
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
60205
|
+
}
|
|
60206
|
+
|
|
60207
|
+
return this.apiClient.callApi(
|
|
60208
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}',
|
|
60209
|
+
'GET',
|
|
60210
|
+
{ 'topicId': topicId,'openId': openId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
60211
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60212
|
+
{ },
|
|
60213
|
+
{ },
|
|
60214
|
+
null,
|
|
60215
|
+
['PureCloud OAuth'],
|
|
60216
|
+
['application/json'],
|
|
60217
|
+
['application/json']
|
|
60218
|
+
);
|
|
60219
|
+
}
|
|
60220
|
+
|
|
60221
|
+
/**
|
|
60222
|
+
* Get the Open data ingestion rule versions.
|
|
60223
|
+
*
|
|
60224
|
+
* @param {String} topicId topicId
|
|
60225
|
+
* @param {String} openId openId
|
|
60226
|
+
* @param {Object} opts Optional parameters
|
|
60227
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60228
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60229
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60230
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60231
|
+
*/
|
|
60232
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId, openId, opts) {
|
|
60233
|
+
opts = opts || {};
|
|
60234
|
+
|
|
60235
|
+
// verify the required parameter 'topicId' is set
|
|
60236
|
+
if (topicId === undefined || topicId === null) {
|
|
60237
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
60238
|
+
}
|
|
60239
|
+
// verify the required parameter 'openId' is set
|
|
60240
|
+
if (openId === undefined || openId === null) {
|
|
60241
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
60242
|
+
}
|
|
60243
|
+
|
|
60244
|
+
return this.apiClient.callApi(
|
|
60245
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions',
|
|
60246
|
+
'GET',
|
|
60247
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60248
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
60249
|
+
{ },
|
|
60250
|
+
{ },
|
|
60251
|
+
null,
|
|
60252
|
+
['PureCloud OAuth'],
|
|
60253
|
+
['application/json'],
|
|
60254
|
+
['application/json']
|
|
60255
|
+
);
|
|
60256
|
+
}
|
|
60257
|
+
|
|
60258
|
+
/**
|
|
60259
|
+
* Get a single X (formally Twitter) data ingestion rule.
|
|
60260
|
+
*
|
|
60261
|
+
* @param {String} topicId topicId
|
|
60262
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60263
|
+
* @param {Object} opts Optional parameters
|
|
60264
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60265
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60266
|
+
*/
|
|
60267
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60268
|
+
opts = opts || {};
|
|
60269
|
+
|
|
60270
|
+
// verify the required parameter 'topicId' is set
|
|
60271
|
+
if (topicId === undefined || topicId === null) {
|
|
60272
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60273
|
+
}
|
|
60274
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60275
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60276
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60277
|
+
}
|
|
60278
|
+
|
|
60279
|
+
return this.apiClient.callApi(
|
|
60280
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60281
|
+
'GET',
|
|
60282
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60283
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60284
|
+
{ },
|
|
60285
|
+
{ },
|
|
60286
|
+
null,
|
|
60287
|
+
['PureCloud OAuth'],
|
|
60288
|
+
['application/json'],
|
|
60289
|
+
['application/json']
|
|
60290
|
+
);
|
|
60291
|
+
}
|
|
60292
|
+
|
|
60293
|
+
/**
|
|
60294
|
+
* Get a single X (formally Twitter) data ingestion rule version.
|
|
60295
|
+
*
|
|
60296
|
+
* @param {String} topicId topicId
|
|
60297
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60298
|
+
* @param {String} dataIngestionRuleVersion version
|
|
60299
|
+
* @param {Object} opts Optional parameters
|
|
60300
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
60301
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60302
|
+
*/
|
|
60303
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
60304
|
+
opts = opts || {};
|
|
60305
|
+
|
|
60306
|
+
// verify the required parameter 'topicId' is set
|
|
60307
|
+
if (topicId === undefined || topicId === null) {
|
|
60308
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
60309
|
+
}
|
|
60310
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60311
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60312
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
60313
|
+
}
|
|
60314
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
60315
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
60316
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
60317
|
+
}
|
|
60318
|
+
|
|
60319
|
+
return this.apiClient.callApi(
|
|
60320
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
60321
|
+
'GET',
|
|
60322
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
60323
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60324
|
+
{ },
|
|
60325
|
+
{ },
|
|
60326
|
+
null,
|
|
60327
|
+
['PureCloud OAuth'],
|
|
60328
|
+
['application/json'],
|
|
60329
|
+
['application/json']
|
|
60330
|
+
);
|
|
60331
|
+
}
|
|
60332
|
+
|
|
60333
|
+
/**
|
|
60334
|
+
* Get the Open data ingestion rule versions.
|
|
60335
|
+
*
|
|
60336
|
+
* @param {String} topicId topicId
|
|
60337
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60338
|
+
* @param {Object} opts Optional parameters
|
|
60339
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60340
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60341
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60342
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60343
|
+
*/
|
|
60344
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
|
|
60345
|
+
opts = opts || {};
|
|
60346
|
+
|
|
60347
|
+
// verify the required parameter 'topicId' is set
|
|
60348
|
+
if (topicId === undefined || topicId === null) {
|
|
60349
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
60350
|
+
}
|
|
60351
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60352
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60353
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
60354
|
+
}
|
|
60355
|
+
|
|
60356
|
+
return this.apiClient.callApi(
|
|
60357
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions',
|
|
60358
|
+
'GET',
|
|
60359
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60360
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
60361
|
+
{ },
|
|
60362
|
+
{ },
|
|
60363
|
+
null,
|
|
60364
|
+
['PureCloud OAuth'],
|
|
60365
|
+
['application/json'],
|
|
60366
|
+
['application/json']
|
|
60367
|
+
);
|
|
60368
|
+
}
|
|
60369
|
+
|
|
60370
|
+
/**
|
|
60371
|
+
* Retrieve all social topics.
|
|
60372
|
+
*
|
|
60373
|
+
* @param {Object} opts Optional parameters
|
|
60374
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60375
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60376
|
+
* @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.
|
|
60377
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60378
|
+
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60379
|
+
*/
|
|
60380
|
+
getSocialmediaTopics(opts) {
|
|
60381
|
+
opts = opts || {};
|
|
60382
|
+
|
|
60383
|
+
|
|
60384
|
+
return this.apiClient.callApi(
|
|
60385
|
+
'/api/v2/socialmedia/topics',
|
|
60386
|
+
'GET',
|
|
60387
|
+
{ },
|
|
60388
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
|
|
60389
|
+
{ },
|
|
60390
|
+
{ },
|
|
60391
|
+
null,
|
|
60392
|
+
['PureCloud OAuth'],
|
|
60393
|
+
['application/json'],
|
|
60394
|
+
['application/json']
|
|
60395
|
+
);
|
|
60396
|
+
}
|
|
60397
|
+
|
|
60398
|
+
/**
|
|
60399
|
+
* Update a social topic.
|
|
60400
|
+
*
|
|
60401
|
+
* @param {String} topicId topicId
|
|
60402
|
+
* @param {Object} opts Optional parameters
|
|
60403
|
+
* @param {Object} opts.body
|
|
60404
|
+
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60405
|
+
*/
|
|
60406
|
+
patchSocialmediaTopic(topicId, opts) {
|
|
60407
|
+
opts = opts || {};
|
|
60408
|
+
|
|
60409
|
+
// verify the required parameter 'topicId' is set
|
|
60410
|
+
if (topicId === undefined || topicId === null) {
|
|
60411
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopic';
|
|
60412
|
+
}
|
|
60413
|
+
|
|
60414
|
+
return this.apiClient.callApi(
|
|
60415
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
60416
|
+
'PATCH',
|
|
60417
|
+
{ 'topicId': topicId },
|
|
60418
|
+
{ },
|
|
60419
|
+
{ },
|
|
60420
|
+
{ },
|
|
60421
|
+
opts['body'],
|
|
60422
|
+
['PureCloud OAuth'],
|
|
60423
|
+
['application/json'],
|
|
60424
|
+
['application/json']
|
|
60425
|
+
);
|
|
60426
|
+
}
|
|
60427
|
+
|
|
60428
|
+
/**
|
|
60429
|
+
* Update the status of a Facebook data ingestion rule.
|
|
60430
|
+
*
|
|
60431
|
+
* @param {String} topicId topicId
|
|
60432
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60433
|
+
* @param {Object} opts Optional parameters
|
|
60434
|
+
* @param {Object} opts.body
|
|
60435
|
+
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60436
|
+
*/
|
|
60437
|
+
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60438
|
+
opts = opts || {};
|
|
60439
|
+
|
|
60440
|
+
// verify the required parameter 'topicId' is set
|
|
60441
|
+
if (topicId === undefined || topicId === null) {
|
|
60442
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60443
|
+
}
|
|
60444
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60445
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60446
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60447
|
+
}
|
|
60448
|
+
|
|
60449
|
+
return this.apiClient.callApi(
|
|
60450
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60451
|
+
'PATCH',
|
|
60452
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60453
|
+
{ },
|
|
60454
|
+
{ },
|
|
60455
|
+
{ },
|
|
60456
|
+
opts['body'],
|
|
60457
|
+
['PureCloud OAuth'],
|
|
60458
|
+
['application/json'],
|
|
60459
|
+
['application/json']
|
|
60460
|
+
);
|
|
60461
|
+
}
|
|
60462
|
+
|
|
60463
|
+
/**
|
|
60464
|
+
* Update the status of a open data ingestion rule.
|
|
60465
|
+
*
|
|
60466
|
+
* @param {String} topicId topicId
|
|
60467
|
+
* @param {String} openId openId
|
|
60468
|
+
* @param {Object} opts Optional parameters
|
|
60469
|
+
* @param {Object} opts.body
|
|
60470
|
+
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60471
|
+
*/
|
|
60472
|
+
patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60473
|
+
opts = opts || {};
|
|
60474
|
+
|
|
60475
|
+
// verify the required parameter 'topicId' is set
|
|
60476
|
+
if (topicId === undefined || topicId === null) {
|
|
60477
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60478
|
+
}
|
|
60479
|
+
// verify the required parameter 'openId' is set
|
|
60480
|
+
if (openId === undefined || openId === null) {
|
|
60481
|
+
throw 'Missing the required parameter "openId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60482
|
+
}
|
|
60483
|
+
|
|
60484
|
+
return this.apiClient.callApi(
|
|
60485
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60486
|
+
'PATCH',
|
|
60487
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60488
|
+
{ },
|
|
60489
|
+
{ },
|
|
60490
|
+
{ },
|
|
60491
|
+
opts['body'],
|
|
60492
|
+
['PureCloud OAuth'],
|
|
60493
|
+
['application/json'],
|
|
60494
|
+
['application/json']
|
|
60495
|
+
);
|
|
60496
|
+
}
|
|
60497
|
+
|
|
60498
|
+
/**
|
|
60499
|
+
* Update the status of a X (formally Twitter) data ingestion rule.
|
|
60500
|
+
*
|
|
60501
|
+
* @param {String} topicId topicId
|
|
60502
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60503
|
+
* @param {Object} opts Optional parameters
|
|
60504
|
+
* @param {Object} opts.body
|
|
60505
|
+
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60506
|
+
*/
|
|
60507
|
+
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60508
|
+
opts = opts || {};
|
|
60509
|
+
|
|
60510
|
+
// verify the required parameter 'topicId' is set
|
|
60511
|
+
if (topicId === undefined || topicId === null) {
|
|
60512
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60513
|
+
}
|
|
60514
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60515
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60516
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60517
|
+
}
|
|
60518
|
+
|
|
60519
|
+
return this.apiClient.callApi(
|
|
60520
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60521
|
+
'PATCH',
|
|
60522
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60523
|
+
{ },
|
|
60524
|
+
{ },
|
|
60525
|
+
{ },
|
|
60526
|
+
opts['body'],
|
|
60527
|
+
['PureCloud OAuth'],
|
|
60528
|
+
['application/json'],
|
|
60529
|
+
['application/json']
|
|
60530
|
+
);
|
|
60531
|
+
}
|
|
60532
|
+
|
|
60533
|
+
/**
|
|
60534
|
+
* Create an Facebook data ingestion rule.
|
|
60535
|
+
*
|
|
60536
|
+
* @param {String} topicId topicId
|
|
60537
|
+
* @param {Object} opts Optional parameters
|
|
60538
|
+
* @param {Object} opts.body
|
|
60539
|
+
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60540
|
+
*/
|
|
60541
|
+
postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
|
|
60542
|
+
opts = opts || {};
|
|
60543
|
+
|
|
60544
|
+
// verify the required parameter 'topicId' is set
|
|
60545
|
+
if (topicId === undefined || topicId === null) {
|
|
60546
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesFacebook';
|
|
60547
|
+
}
|
|
60548
|
+
|
|
60549
|
+
return this.apiClient.callApi(
|
|
60550
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook',
|
|
60551
|
+
'POST',
|
|
60552
|
+
{ 'topicId': topicId },
|
|
60553
|
+
{ },
|
|
60554
|
+
{ },
|
|
60555
|
+
{ },
|
|
60556
|
+
opts['body'],
|
|
60557
|
+
['PureCloud OAuth'],
|
|
60558
|
+
['application/json'],
|
|
60559
|
+
['application/json']
|
|
60560
|
+
);
|
|
60561
|
+
}
|
|
60562
|
+
|
|
60563
|
+
/**
|
|
60564
|
+
* Create an open data ingestion rule.
|
|
60565
|
+
*
|
|
60566
|
+
* @param {String} topicId topicId
|
|
60567
|
+
* @param {Object} opts Optional parameters
|
|
60568
|
+
* @param {Object} opts.body
|
|
60569
|
+
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60570
|
+
*/
|
|
60571
|
+
postSocialmediaTopicDataingestionrulesOpen(topicId, opts) {
|
|
60572
|
+
opts = opts || {};
|
|
60573
|
+
|
|
60574
|
+
// verify the required parameter 'topicId' is set
|
|
60575
|
+
if (topicId === undefined || topicId === null) {
|
|
60576
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpen';
|
|
60577
|
+
}
|
|
60578
|
+
|
|
60579
|
+
return this.apiClient.callApi(
|
|
60580
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open',
|
|
60581
|
+
'POST',
|
|
60582
|
+
{ 'topicId': topicId },
|
|
60583
|
+
{ },
|
|
60584
|
+
{ },
|
|
60585
|
+
{ },
|
|
60586
|
+
opts['body'],
|
|
60587
|
+
['PureCloud OAuth'],
|
|
60588
|
+
['application/json'],
|
|
60589
|
+
['application/json']
|
|
60590
|
+
);
|
|
60591
|
+
}
|
|
60592
|
+
|
|
60593
|
+
/**
|
|
60594
|
+
* Create an twitter data ingestion rule.
|
|
60595
|
+
*
|
|
60596
|
+
* @param {String} topicId topicId
|
|
60597
|
+
* @param {Object} opts Optional parameters
|
|
60598
|
+
* @param {Object} opts.body
|
|
60599
|
+
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60600
|
+
*/
|
|
60601
|
+
postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
|
|
60602
|
+
opts = opts || {};
|
|
60603
|
+
|
|
60604
|
+
// verify the required parameter 'topicId' is set
|
|
60605
|
+
if (topicId === undefined || topicId === null) {
|
|
60606
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesTwitter';
|
|
60607
|
+
}
|
|
60608
|
+
|
|
60609
|
+
return this.apiClient.callApi(
|
|
60610
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter',
|
|
60611
|
+
'POST',
|
|
60612
|
+
{ 'topicId': topicId },
|
|
60613
|
+
{ },
|
|
60614
|
+
{ },
|
|
60615
|
+
{ },
|
|
60616
|
+
opts['body'],
|
|
60617
|
+
['PureCloud OAuth'],
|
|
60618
|
+
['application/json'],
|
|
60619
|
+
['application/json']
|
|
60620
|
+
);
|
|
60621
|
+
}
|
|
60622
|
+
|
|
60623
|
+
/**
|
|
60624
|
+
* Create a social topic.
|
|
60625
|
+
*
|
|
60626
|
+
* @param {Object} opts Optional parameters
|
|
60627
|
+
* @param {Object} opts.body
|
|
60628
|
+
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60629
|
+
*/
|
|
60630
|
+
postSocialmediaTopics(opts) {
|
|
60631
|
+
opts = opts || {};
|
|
60632
|
+
|
|
60633
|
+
|
|
60634
|
+
return this.apiClient.callApi(
|
|
60635
|
+
'/api/v2/socialmedia/topics',
|
|
60636
|
+
'POST',
|
|
60637
|
+
{ },
|
|
60638
|
+
{ },
|
|
60639
|
+
{ },
|
|
60640
|
+
{ },
|
|
60641
|
+
opts['body'],
|
|
60642
|
+
['PureCloud OAuth'],
|
|
60643
|
+
['application/json'],
|
|
60644
|
+
['application/json']
|
|
60645
|
+
);
|
|
60646
|
+
}
|
|
60647
|
+
|
|
60648
|
+
/**
|
|
60649
|
+
* Update the Facebook data ingestion rule.
|
|
60650
|
+
*
|
|
60651
|
+
* @param {String} topicId topicId
|
|
60652
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60653
|
+
* @param {Object} opts Optional parameters
|
|
60654
|
+
* @param {Object} opts.body
|
|
60655
|
+
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60656
|
+
*/
|
|
60657
|
+
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60658
|
+
opts = opts || {};
|
|
60659
|
+
|
|
60660
|
+
// verify the required parameter 'topicId' is set
|
|
60661
|
+
if (topicId === undefined || topicId === null) {
|
|
60662
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60663
|
+
}
|
|
60664
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60665
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60666
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60667
|
+
}
|
|
60668
|
+
|
|
60669
|
+
return this.apiClient.callApi(
|
|
60670
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60671
|
+
'PUT',
|
|
60672
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60673
|
+
{ },
|
|
60674
|
+
{ },
|
|
60675
|
+
{ },
|
|
60676
|
+
opts['body'],
|
|
60677
|
+
['PureCloud OAuth'],
|
|
60678
|
+
['application/json'],
|
|
60679
|
+
['application/json']
|
|
60680
|
+
);
|
|
60681
|
+
}
|
|
60682
|
+
|
|
60683
|
+
/**
|
|
60684
|
+
* Update the open data ingestion rule.
|
|
60685
|
+
*
|
|
60686
|
+
* @param {String} topicId topicId
|
|
60687
|
+
* @param {String} openId openId
|
|
60688
|
+
* @param {Object} opts Optional parameters
|
|
60689
|
+
* @param {Object} opts.body
|
|
60690
|
+
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60691
|
+
*/
|
|
60692
|
+
putSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60693
|
+
opts = opts || {};
|
|
60694
|
+
|
|
60695
|
+
// verify the required parameter 'topicId' is set
|
|
60696
|
+
if (topicId === undefined || topicId === null) {
|
|
60697
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60698
|
+
}
|
|
60699
|
+
// verify the required parameter 'openId' is set
|
|
60700
|
+
if (openId === undefined || openId === null) {
|
|
60701
|
+
throw 'Missing the required parameter "openId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60702
|
+
}
|
|
60703
|
+
|
|
60704
|
+
return this.apiClient.callApi(
|
|
60705
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60706
|
+
'PUT',
|
|
60707
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60708
|
+
{ },
|
|
60709
|
+
{ },
|
|
60710
|
+
{ },
|
|
60711
|
+
opts['body'],
|
|
60712
|
+
['PureCloud OAuth'],
|
|
60713
|
+
['application/json'],
|
|
60714
|
+
['application/json']
|
|
60715
|
+
);
|
|
60716
|
+
}
|
|
60717
|
+
|
|
60718
|
+
/**
|
|
60719
|
+
* Update the X (formally Twitter) data ingestion rule.
|
|
60720
|
+
*
|
|
60721
|
+
* @param {String} topicId topicId
|
|
60722
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60723
|
+
* @param {Object} opts Optional parameters
|
|
60724
|
+
* @param {Object} opts.body
|
|
60725
|
+
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60726
|
+
*/
|
|
60727
|
+
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60728
|
+
opts = opts || {};
|
|
60729
|
+
|
|
60730
|
+
// verify the required parameter 'topicId' is set
|
|
60731
|
+
if (topicId === undefined || topicId === null) {
|
|
60732
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60733
|
+
}
|
|
60734
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60735
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60736
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60737
|
+
}
|
|
60738
|
+
|
|
60739
|
+
return this.apiClient.callApi(
|
|
60740
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60741
|
+
'PUT',
|
|
60742
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60743
|
+
{ },
|
|
60744
|
+
{ },
|
|
60745
|
+
{ },
|
|
60746
|
+
opts['body'],
|
|
60747
|
+
['PureCloud OAuth'],
|
|
60748
|
+
['application/json'],
|
|
60749
|
+
['application/json']
|
|
60750
|
+
);
|
|
60751
|
+
}
|
|
60752
|
+
|
|
60753
|
+
}
|
|
60754
|
+
|
|
59381
60755
|
class SpeechTextAnalyticsApi {
|
|
59382
60756
|
/**
|
|
59383
60757
|
* SpeechTextAnalytics service.
|
|
59384
60758
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
59385
|
-
* @version
|
|
60759
|
+
* @version 210.0.0
|
|
59386
60760
|
*/
|
|
59387
60761
|
|
|
59388
60762
|
/**
|
|
@@ -60717,7 +62091,7 @@ class StationsApi {
|
|
|
60717
62091
|
/**
|
|
60718
62092
|
* Stations service.
|
|
60719
62093
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60720
|
-
* @version
|
|
62094
|
+
* @version 210.0.0
|
|
60721
62095
|
*/
|
|
60722
62096
|
|
|
60723
62097
|
/**
|
|
@@ -60819,7 +62193,7 @@ class SuggestApi {
|
|
|
60819
62193
|
/**
|
|
60820
62194
|
* Suggest service.
|
|
60821
62195
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60822
|
-
* @version
|
|
62196
|
+
* @version 210.0.0
|
|
60823
62197
|
*/
|
|
60824
62198
|
|
|
60825
62199
|
/**
|
|
@@ -60958,7 +62332,7 @@ class TaskManagementApi {
|
|
|
60958
62332
|
/**
|
|
60959
62333
|
* TaskManagement service.
|
|
60960
62334
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60961
|
-
* @version
|
|
62335
|
+
* @version 210.0.0
|
|
60962
62336
|
*/
|
|
60963
62337
|
|
|
60964
62338
|
/**
|
|
@@ -62622,7 +63996,7 @@ class TeamsApi {
|
|
|
62622
63996
|
/**
|
|
62623
63997
|
* Teams service.
|
|
62624
63998
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
62625
|
-
* @version
|
|
63999
|
+
* @version 210.0.0
|
|
62626
64000
|
*/
|
|
62627
64001
|
|
|
62628
64002
|
/**
|
|
@@ -62927,7 +64301,7 @@ class TelephonyApi {
|
|
|
62927
64301
|
/**
|
|
62928
64302
|
* Telephony service.
|
|
62929
64303
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62930
|
-
* @version
|
|
64304
|
+
* @version 210.0.0
|
|
62931
64305
|
*/
|
|
62932
64306
|
|
|
62933
64307
|
/**
|
|
@@ -63109,7 +64483,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
63109
64483
|
/**
|
|
63110
64484
|
* TelephonyProvidersEdge service.
|
|
63111
64485
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
63112
|
-
* @version
|
|
64486
|
+
* @version 210.0.0
|
|
63113
64487
|
*/
|
|
63114
64488
|
|
|
63115
64489
|
/**
|
|
@@ -66560,7 +67934,7 @@ class TextbotsApi {
|
|
|
66560
67934
|
/**
|
|
66561
67935
|
* Textbots service.
|
|
66562
67936
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
66563
|
-
* @version
|
|
67937
|
+
* @version 210.0.0
|
|
66564
67938
|
*/
|
|
66565
67939
|
|
|
66566
67940
|
/**
|
|
@@ -66688,7 +68062,7 @@ class TokensApi {
|
|
|
66688
68062
|
/**
|
|
66689
68063
|
* Tokens service.
|
|
66690
68064
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
66691
|
-
* @version
|
|
68065
|
+
* @version 210.0.0
|
|
66692
68066
|
*/
|
|
66693
68067
|
|
|
66694
68068
|
/**
|
|
@@ -66842,7 +68216,7 @@ class UploadsApi {
|
|
|
66842
68216
|
/**
|
|
66843
68217
|
* Uploads service.
|
|
66844
68218
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66845
|
-
* @version
|
|
68219
|
+
* @version 210.0.0
|
|
66846
68220
|
*/
|
|
66847
68221
|
|
|
66848
68222
|
/**
|
|
@@ -67111,7 +68485,7 @@ class UsageApi {
|
|
|
67111
68485
|
/**
|
|
67112
68486
|
* Usage service.
|
|
67113
68487
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
67114
|
-
* @version
|
|
68488
|
+
* @version 210.0.0
|
|
67115
68489
|
*/
|
|
67116
68490
|
|
|
67117
68491
|
/**
|
|
@@ -67326,7 +68700,7 @@ class UserRecordingsApi {
|
|
|
67326
68700
|
/**
|
|
67327
68701
|
* UserRecordings service.
|
|
67328
68702
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
67329
|
-
* @version
|
|
68703
|
+
* @version 210.0.0
|
|
67330
68704
|
*/
|
|
67331
68705
|
|
|
67332
68706
|
/**
|
|
@@ -67541,7 +68915,7 @@ class UsersApi {
|
|
|
67541
68915
|
/**
|
|
67542
68916
|
* Users service.
|
|
67543
68917
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
67544
|
-
* @version
|
|
68918
|
+
* @version 210.0.0
|
|
67545
68919
|
*/
|
|
67546
68920
|
|
|
67547
68921
|
/**
|
|
@@ -70370,7 +71744,7 @@ class UtilitiesApi {
|
|
|
70370
71744
|
/**
|
|
70371
71745
|
* Utilities service.
|
|
70372
71746
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
70373
|
-
* @version
|
|
71747
|
+
* @version 210.0.0
|
|
70374
71748
|
*/
|
|
70375
71749
|
|
|
70376
71750
|
/**
|
|
@@ -70481,7 +71855,7 @@ class VoicemailApi {
|
|
|
70481
71855
|
/**
|
|
70482
71856
|
* Voicemail service.
|
|
70483
71857
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
70484
|
-
* @version
|
|
71858
|
+
* @version 210.0.0
|
|
70485
71859
|
*/
|
|
70486
71860
|
|
|
70487
71861
|
/**
|
|
@@ -71203,7 +72577,7 @@ class WebChatApi {
|
|
|
71203
72577
|
/**
|
|
71204
72578
|
* WebChat service.
|
|
71205
72579
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
71206
|
-
* @version
|
|
72580
|
+
* @version 210.0.0
|
|
71207
72581
|
*/
|
|
71208
72582
|
|
|
71209
72583
|
/**
|
|
@@ -71754,7 +73128,7 @@ class WebDeploymentsApi {
|
|
|
71754
73128
|
/**
|
|
71755
73129
|
* WebDeployments service.
|
|
71756
73130
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
71757
|
-
* @version
|
|
73131
|
+
* @version 210.0.0
|
|
71758
73132
|
*/
|
|
71759
73133
|
|
|
71760
73134
|
/**
|
|
@@ -72281,7 +73655,7 @@ class WebMessagingApi {
|
|
|
72281
73655
|
/**
|
|
72282
73656
|
* WebMessaging service.
|
|
72283
73657
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
72284
|
-
* @version
|
|
73658
|
+
* @version 210.0.0
|
|
72285
73659
|
*/
|
|
72286
73660
|
|
|
72287
73661
|
/**
|
|
@@ -72327,7 +73701,7 @@ class WidgetsApi {
|
|
|
72327
73701
|
/**
|
|
72328
73702
|
* Widgets service.
|
|
72329
73703
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
72330
|
-
* @version
|
|
73704
|
+
* @version 210.0.0
|
|
72331
73705
|
*/
|
|
72332
73706
|
|
|
72333
73707
|
/**
|
|
@@ -72473,7 +73847,7 @@ class WorkforceManagementApi {
|
|
|
72473
73847
|
/**
|
|
72474
73848
|
* WorkforceManagement service.
|
|
72475
73849
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
72476
|
-
* @version
|
|
73850
|
+
* @version 210.0.0
|
|
72477
73851
|
*/
|
|
72478
73852
|
|
|
72479
73853
|
/**
|
|
@@ -75373,12 +76747,8 @@ class WorkforceManagementApi {
|
|
|
75373
76747
|
*
|
|
75374
76748
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
75375
76749
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
75376
|
-
* @param {Object} opts Optional parameters
|
|
75377
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
75378
76750
|
*/
|
|
75379
|
-
getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId
|
|
75380
|
-
opts = opts || {};
|
|
75381
|
-
|
|
76751
|
+
getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId) {
|
|
75382
76752
|
// verify the required parameter 'managementUnitId' is set
|
|
75383
76753
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
75384
76754
|
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';
|
|
@@ -75392,7 +76762,7 @@ class WorkforceManagementApi {
|
|
|
75392
76762
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests',
|
|
75393
76763
|
'GET',
|
|
75394
76764
|
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
75395
|
-
{
|
|
76765
|
+
{ },
|
|
75396
76766
|
{ },
|
|
75397
76767
|
{ },
|
|
75398
76768
|
null,
|
|
@@ -75509,7 +76879,7 @@ class WorkforceManagementApi {
|
|
|
75509
76879
|
* Gets all the shift trades for a given week
|
|
75510
76880
|
*
|
|
75511
76881
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
75512
|
-
* @param {String} weekDateId The start date of the
|
|
76882
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
75513
76883
|
* @param {Object} opts Optional parameters
|
|
75514
76884
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
75515
76885
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -75883,18 +77253,14 @@ class WorkforceManagementApi {
|
|
|
75883
77253
|
/**
|
|
75884
77254
|
* Get a list of time off requests for the current user
|
|
75885
77255
|
*
|
|
75886
|
-
* @param {Object} opts Optional parameters
|
|
75887
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
75888
77256
|
*/
|
|
75889
|
-
getWorkforcemanagementTimeoffrequests(
|
|
75890
|
-
opts = opts || {};
|
|
75891
|
-
|
|
77257
|
+
getWorkforcemanagementTimeoffrequests() {
|
|
75892
77258
|
|
|
75893
77259
|
return this.apiClient.callApi(
|
|
75894
77260
|
'/api/v2/workforcemanagement/timeoffrequests',
|
|
75895
77261
|
'GET',
|
|
75896
77262
|
{ },
|
|
75897
|
-
{
|
|
77263
|
+
{ },
|
|
75898
77264
|
{ },
|
|
75899
77265
|
{ },
|
|
75900
77266
|
null,
|
|
@@ -76735,7 +78101,7 @@ class WorkforceManagementApi {
|
|
|
76735
78101
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
76736
78102
|
*
|
|
76737
78103
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
76738
|
-
* @param {String} weekDateId The start date of the
|
|
78104
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
76739
78105
|
* @param {String} tradeId The ID of the shift trade to update
|
|
76740
78106
|
* @param {Object} body body
|
|
76741
78107
|
*/
|
|
@@ -78995,7 +80361,7 @@ class WorkforceManagementApi {
|
|
|
78995
80361
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
78996
80362
|
*
|
|
78997
80363
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78998
|
-
* @param {String} weekDateId The start date of the
|
|
80364
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
78999
80365
|
* @param {String} tradeId The ID of the shift trade to update
|
|
79000
80366
|
* @param {Object} body body
|
|
79001
80367
|
*/
|
|
@@ -79035,7 +80401,7 @@ class WorkforceManagementApi {
|
|
|
79035
80401
|
* Adds a shift trade
|
|
79036
80402
|
*
|
|
79037
80403
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
79038
|
-
* @param {String} weekDateId The start date of the
|
|
80404
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
79039
80405
|
* @param {Object} body body
|
|
79040
80406
|
*/
|
|
79041
80407
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body) {
|
|
@@ -79070,7 +80436,7 @@ class WorkforceManagementApi {
|
|
|
79070
80436
|
* Searches for potential shift trade matches for the current agent
|
|
79071
80437
|
*
|
|
79072
80438
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
79073
|
-
* @param {String} weekDateId The start date of the
|
|
80439
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
79074
80440
|
* @param {Object} body body
|
|
79075
80441
|
* @param {Object} opts Optional parameters
|
|
79076
80442
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -79109,7 +80475,7 @@ class WorkforceManagementApi {
|
|
|
79109
80475
|
* Updates the state of a batch of shift trades
|
|
79110
80476
|
* Admin functionality is not supported with "mine".
|
|
79111
80477
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
79112
|
-
* @param {String} weekDateId The start date of the
|
|
80478
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
79113
80479
|
* @param {Object} body body
|
|
79114
80480
|
* @param {Object} opts Optional parameters
|
|
79115
80481
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -79687,7 +81053,7 @@ class WorkforceManagementApi {
|
|
|
79687
81053
|
* </pre>
|
|
79688
81054
|
* </p>
|
|
79689
81055
|
* @module purecloud-platform-client-v2/index
|
|
79690
|
-
* @version
|
|
81056
|
+
* @version 210.0.0
|
|
79691
81057
|
*/
|
|
79692
81058
|
class platformClient {
|
|
79693
81059
|
constructor() {
|
|
@@ -79776,6 +81142,11 @@ class platformClient {
|
|
|
79776
81142
|
* @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
|
|
79777
81143
|
*/
|
|
79778
81144
|
this.DataExtensionsApi = DataExtensionsApi;
|
|
81145
|
+
/**
|
|
81146
|
+
* The DataPrivacyApi service constructor.
|
|
81147
|
+
* @property {module:purecloud-platform-client-v2/api/DataPrivacyApi}
|
|
81148
|
+
*/
|
|
81149
|
+
this.DataPrivacyApi = DataPrivacyApi;
|
|
79779
81150
|
/**
|
|
79780
81151
|
* The DownloadsApi service constructor.
|
|
79781
81152
|
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
@@ -79991,6 +81362,11 @@ class platformClient {
|
|
|
79991
81362
|
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
79992
81363
|
*/
|
|
79993
81364
|
this.SettingsApi = SettingsApi;
|
|
81365
|
+
/**
|
|
81366
|
+
* The SocialMediaApi service constructor.
|
|
81367
|
+
* @property {module:purecloud-platform-client-v2/api/SocialMediaApi}
|
|
81368
|
+
*/
|
|
81369
|
+
this.SocialMediaApi = SocialMediaApi;
|
|
79994
81370
|
/**
|
|
79995
81371
|
* The SpeechTextAnalyticsApi service constructor.
|
|
79996
81372
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|