purecloud-platform-client-v2 208.0.0 → 209.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 +1088 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +1088 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +406 -134
- package/dist/web-cjs/purecloud-platform-client-v2.js +547 -209
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +3406 -2914
- 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/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 +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +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 +7 -7
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -486,7 +486,7 @@ class Configuration {
|
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
488
|
* @module purecloud-platform-client-v2/ApiClient
|
|
489
|
-
* @version
|
|
489
|
+
* @version 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.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 209.0.0
|
|
21283
21282
|
*/
|
|
21284
21283
|
|
|
21285
21284
|
/**
|
|
@@ -21365,7 +21364,7 @@ class DownloadsApi {
|
|
|
21365
21364
|
/**
|
|
21366
21365
|
* Downloads service.
|
|
21367
21366
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21368
|
-
* @version
|
|
21367
|
+
* @version 209.0.0
|
|
21369
21368
|
*/
|
|
21370
21369
|
|
|
21371
21370
|
/**
|
|
@@ -21417,7 +21416,7 @@ class EmailsApi {
|
|
|
21417
21416
|
/**
|
|
21418
21417
|
* Emails service.
|
|
21419
21418
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21420
|
-
* @version
|
|
21419
|
+
* @version 209.0.0
|
|
21421
21420
|
*/
|
|
21422
21421
|
|
|
21423
21422
|
/**
|
|
@@ -21482,7 +21481,7 @@ class EmployeeEngagementApi {
|
|
|
21482
21481
|
/**
|
|
21483
21482
|
* EmployeeEngagement service.
|
|
21484
21483
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21485
|
-
* @version
|
|
21484
|
+
* @version 209.0.0
|
|
21486
21485
|
*/
|
|
21487
21486
|
|
|
21488
21487
|
/**
|
|
@@ -21633,7 +21632,7 @@ class EventsApi {
|
|
|
21633
21632
|
/**
|
|
21634
21633
|
* Events service.
|
|
21635
21634
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21636
|
-
* @version
|
|
21635
|
+
* @version 209.0.0
|
|
21637
21636
|
*/
|
|
21638
21637
|
|
|
21639
21638
|
/**
|
|
@@ -21729,7 +21728,7 @@ class ExternalContactsApi {
|
|
|
21729
21728
|
/**
|
|
21730
21729
|
* ExternalContacts service.
|
|
21731
21730
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21732
|
-
* @version
|
|
21731
|
+
* @version 209.0.0
|
|
21733
21732
|
*/
|
|
21734
21733
|
|
|
21735
21734
|
/**
|
|
@@ -24054,7 +24053,7 @@ class FaxApi {
|
|
|
24054
24053
|
/**
|
|
24055
24054
|
* Fax service.
|
|
24056
24055
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24057
|
-
* @version
|
|
24056
|
+
* @version 209.0.0
|
|
24058
24057
|
*/
|
|
24059
24058
|
|
|
24060
24059
|
/**
|
|
@@ -24269,7 +24268,7 @@ class FlowsApi {
|
|
|
24269
24268
|
/**
|
|
24270
24269
|
* Flows service.
|
|
24271
24270
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
24272
|
-
* @version
|
|
24271
|
+
* @version 209.0.0
|
|
24273
24272
|
*/
|
|
24274
24273
|
|
|
24275
24274
|
/**
|
|
@@ -24452,7 +24451,7 @@ class GamificationApi {
|
|
|
24452
24451
|
/**
|
|
24453
24452
|
* Gamification service.
|
|
24454
24453
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24455
|
-
* @version
|
|
24454
|
+
* @version 209.0.0
|
|
24456
24455
|
*/
|
|
24457
24456
|
|
|
24458
24457
|
/**
|
|
@@ -26538,7 +26537,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26538
26537
|
/**
|
|
26539
26538
|
* GeneralDataProtectionRegulation service.
|
|
26540
26539
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26541
|
-
* @version
|
|
26540
|
+
* @version 209.0.0
|
|
26542
26541
|
*/
|
|
26543
26542
|
|
|
26544
26543
|
/**
|
|
@@ -26668,7 +26667,7 @@ class GeolocationApi {
|
|
|
26668
26667
|
/**
|
|
26669
26668
|
* Geolocation service.
|
|
26670
26669
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26671
|
-
* @version
|
|
26670
|
+
* @version 209.0.0
|
|
26672
26671
|
*/
|
|
26673
26672
|
|
|
26674
26673
|
/**
|
|
@@ -26799,7 +26798,7 @@ class GreetingsApi {
|
|
|
26799
26798
|
/**
|
|
26800
26799
|
* Greetings service.
|
|
26801
26800
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26802
|
-
* @version
|
|
26801
|
+
* @version 209.0.0
|
|
26803
26802
|
*/
|
|
26804
26803
|
|
|
26805
26804
|
/**
|
|
@@ -27254,7 +27253,7 @@ class GroupsApi {
|
|
|
27254
27253
|
/**
|
|
27255
27254
|
* Groups service.
|
|
27256
27255
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27257
|
-
* @version
|
|
27256
|
+
* @version 209.0.0
|
|
27258
27257
|
*/
|
|
27259
27258
|
|
|
27260
27259
|
/**
|
|
@@ -27773,7 +27772,7 @@ class IdentityProviderApi {
|
|
|
27773
27772
|
/**
|
|
27774
27773
|
* IdentityProvider service.
|
|
27775
27774
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27776
|
-
* @version
|
|
27775
|
+
* @version 209.0.0
|
|
27777
27776
|
*/
|
|
27778
27777
|
|
|
27779
27778
|
/**
|
|
@@ -28634,7 +28633,7 @@ class InfrastructureAsCodeApi {
|
|
|
28634
28633
|
/**
|
|
28635
28634
|
* InfrastructureAsCode service.
|
|
28636
28635
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28637
|
-
* @version
|
|
28636
|
+
* @version 209.0.0
|
|
28638
28637
|
*/
|
|
28639
28638
|
|
|
28640
28639
|
/**
|
|
@@ -28801,7 +28800,7 @@ class IntegrationsApi {
|
|
|
28801
28800
|
/**
|
|
28802
28801
|
* Integrations service.
|
|
28803
28802
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28804
|
-
* @version
|
|
28803
|
+
* @version 209.0.0
|
|
28805
28804
|
*/
|
|
28806
28805
|
|
|
28807
28806
|
/**
|
|
@@ -31243,7 +31242,7 @@ class JourneyApi {
|
|
|
31243
31242
|
/**
|
|
31244
31243
|
* Journey service.
|
|
31245
31244
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31246
|
-
* @version
|
|
31245
|
+
* @version 209.0.0
|
|
31247
31246
|
*/
|
|
31248
31247
|
|
|
31249
31248
|
/**
|
|
@@ -33208,7 +33207,7 @@ class KnowledgeApi {
|
|
|
33208
33207
|
/**
|
|
33209
33208
|
* Knowledge service.
|
|
33210
33209
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
33211
|
-
* @version
|
|
33210
|
+
* @version 209.0.0
|
|
33212
33211
|
*/
|
|
33213
33212
|
|
|
33214
33213
|
/**
|
|
@@ -33732,8 +33731,12 @@ class KnowledgeApi {
|
|
|
33732
33731
|
* Get sync options available for a knowledge-connect integration
|
|
33733
33732
|
*
|
|
33734
33733
|
* @param {String} integrationId Integration ID
|
|
33734
|
+
* @param {Object} opts Optional parameters
|
|
33735
|
+
* @param {Array.<String>} opts.knowledgeBaseIds Narrowing down filtering option results by knowledge base.
|
|
33735
33736
|
*/
|
|
33736
|
-
getKnowledgeIntegrationOptions(integrationId) {
|
|
33737
|
+
getKnowledgeIntegrationOptions(integrationId, opts) {
|
|
33738
|
+
opts = opts || {};
|
|
33739
|
+
|
|
33737
33740
|
// verify the required parameter 'integrationId' is set
|
|
33738
33741
|
if (integrationId === undefined || integrationId === null) {
|
|
33739
33742
|
throw 'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';
|
|
@@ -33743,7 +33746,7 @@ class KnowledgeApi {
|
|
|
33743
33746
|
'/api/v2/knowledge/integrations/{integrationId}/options',
|
|
33744
33747
|
'GET',
|
|
33745
33748
|
{ 'integrationId': integrationId },
|
|
33746
|
-
{
|
|
33749
|
+
{ 'knowledgeBaseIds': this.apiClient.buildCollectionParam(opts['knowledgeBaseIds'], 'multi') },
|
|
33747
33750
|
{ },
|
|
33748
33751
|
{ },
|
|
33749
33752
|
null,
|
|
@@ -37080,7 +37083,7 @@ class LanguageUnderstandingApi {
|
|
|
37080
37083
|
/**
|
|
37081
37084
|
* LanguageUnderstanding service.
|
|
37082
37085
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
37083
|
-
* @version
|
|
37086
|
+
* @version 209.0.0
|
|
37084
37087
|
*/
|
|
37085
37088
|
|
|
37086
37089
|
/**
|
|
@@ -38114,7 +38117,7 @@ class LanguagesApi {
|
|
|
38114
38117
|
/**
|
|
38115
38118
|
* Languages service.
|
|
38116
38119
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
38117
|
-
* @version
|
|
38120
|
+
* @version 209.0.0
|
|
38118
38121
|
*/
|
|
38119
38122
|
|
|
38120
38123
|
/**
|
|
@@ -38336,7 +38339,7 @@ class LearningApi {
|
|
|
38336
38339
|
/**
|
|
38337
38340
|
* Learning service.
|
|
38338
38341
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
38339
|
-
* @version
|
|
38342
|
+
* @version 209.0.0
|
|
38340
38343
|
*/
|
|
38341
38344
|
|
|
38342
38345
|
/**
|
|
@@ -39365,7 +39368,7 @@ class LicenseApi {
|
|
|
39365
39368
|
/**
|
|
39366
39369
|
* License service.
|
|
39367
39370
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
39368
|
-
* @version
|
|
39371
|
+
* @version 209.0.0
|
|
39369
39372
|
*/
|
|
39370
39373
|
|
|
39371
39374
|
/**
|
|
@@ -39603,7 +39606,7 @@ class LocationsApi {
|
|
|
39603
39606
|
/**
|
|
39604
39607
|
* Locations service.
|
|
39605
39608
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39606
|
-
* @version
|
|
39609
|
+
* @version 209.0.0
|
|
39607
39610
|
*/
|
|
39608
39611
|
|
|
39609
39612
|
/**
|
|
@@ -39839,7 +39842,7 @@ class LogCaptureApi {
|
|
|
39839
39842
|
/**
|
|
39840
39843
|
* LogCapture service.
|
|
39841
39844
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39842
|
-
* @version
|
|
39845
|
+
* @version 209.0.0
|
|
39843
39846
|
*/
|
|
39844
39847
|
|
|
39845
39848
|
/**
|
|
@@ -40039,7 +40042,7 @@ class MessagingApi {
|
|
|
40039
40042
|
/**
|
|
40040
40043
|
* Messaging service.
|
|
40041
40044
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40042
|
-
* @version
|
|
40045
|
+
* @version 209.0.0
|
|
40043
40046
|
*/
|
|
40044
40047
|
|
|
40045
40048
|
/**
|
|
@@ -40398,7 +40401,7 @@ class MobileDevicesApi {
|
|
|
40398
40401
|
/**
|
|
40399
40402
|
* MobileDevices service.
|
|
40400
40403
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
40401
|
-
* @version
|
|
40404
|
+
* @version 209.0.0
|
|
40402
40405
|
*/
|
|
40403
40406
|
|
|
40404
40407
|
/**
|
|
@@ -40549,7 +40552,7 @@ class NotificationsApi {
|
|
|
40549
40552
|
/**
|
|
40550
40553
|
* Notifications service.
|
|
40551
40554
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40552
|
-
* @version
|
|
40555
|
+
* @version 209.0.0
|
|
40553
40556
|
*/
|
|
40554
40557
|
|
|
40555
40558
|
/**
|
|
@@ -40782,7 +40785,7 @@ class OAuthApi {
|
|
|
40782
40785
|
/**
|
|
40783
40786
|
* OAuth service.
|
|
40784
40787
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40785
|
-
* @version
|
|
40788
|
+
* @version 209.0.0
|
|
40786
40789
|
*/
|
|
40787
40790
|
|
|
40788
40791
|
/**
|
|
@@ -41148,7 +41151,7 @@ class ObjectsApi {
|
|
|
41148
41151
|
/**
|
|
41149
41152
|
* Objects service.
|
|
41150
41153
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
41151
|
-
* @version
|
|
41154
|
+
* @version 209.0.0
|
|
41152
41155
|
*/
|
|
41153
41156
|
|
|
41154
41157
|
/**
|
|
@@ -41418,7 +41421,7 @@ class OperationalEventsApi {
|
|
|
41418
41421
|
/**
|
|
41419
41422
|
* OperationalEvents service.
|
|
41420
41423
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
41421
|
-
* @version
|
|
41424
|
+
* @version 209.0.0
|
|
41422
41425
|
*/
|
|
41423
41426
|
|
|
41424
41427
|
/**
|
|
@@ -41478,13 +41481,64 @@ class OperationalEventsApi {
|
|
|
41478
41481
|
);
|
|
41479
41482
|
}
|
|
41480
41483
|
|
|
41484
|
+
/**
|
|
41485
|
+
* Get aggregates for operational events in a timeframe.
|
|
41486
|
+
*
|
|
41487
|
+
* @param {Object} opts Optional parameters
|
|
41488
|
+
* @param {Object} opts.body
|
|
41489
|
+
*/
|
|
41490
|
+
postUsageEventsAggregatesQuery(opts) {
|
|
41491
|
+
opts = opts || {};
|
|
41492
|
+
|
|
41493
|
+
|
|
41494
|
+
return this.apiClient.callApi(
|
|
41495
|
+
'/api/v2/usage/events/aggregates/query',
|
|
41496
|
+
'POST',
|
|
41497
|
+
{ },
|
|
41498
|
+
{ },
|
|
41499
|
+
{ },
|
|
41500
|
+
{ },
|
|
41501
|
+
opts['body'],
|
|
41502
|
+
['PureCloud OAuth'],
|
|
41503
|
+
['application/json'],
|
|
41504
|
+
['application/json']
|
|
41505
|
+
);
|
|
41506
|
+
}
|
|
41507
|
+
|
|
41508
|
+
/**
|
|
41509
|
+
* Query operational events in a timeframe.
|
|
41510
|
+
*
|
|
41511
|
+
* @param {Object} opts Optional parameters
|
|
41512
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41513
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41514
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41515
|
+
* @param {Object} opts.body
|
|
41516
|
+
*/
|
|
41517
|
+
postUsageEventsQuery(opts) {
|
|
41518
|
+
opts = opts || {};
|
|
41519
|
+
|
|
41520
|
+
|
|
41521
|
+
return this.apiClient.callApi(
|
|
41522
|
+
'/api/v2/usage/events/query',
|
|
41523
|
+
'POST',
|
|
41524
|
+
{ },
|
|
41525
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
41526
|
+
{ },
|
|
41527
|
+
{ },
|
|
41528
|
+
opts['body'],
|
|
41529
|
+
['PureCloud OAuth'],
|
|
41530
|
+
['application/json'],
|
|
41531
|
+
['application/json']
|
|
41532
|
+
);
|
|
41533
|
+
}
|
|
41534
|
+
|
|
41481
41535
|
}
|
|
41482
41536
|
|
|
41483
41537
|
class OrganizationApi {
|
|
41484
41538
|
/**
|
|
41485
41539
|
* Organization service.
|
|
41486
41540
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41487
|
-
* @version
|
|
41541
|
+
* @version 209.0.0
|
|
41488
41542
|
*/
|
|
41489
41543
|
|
|
41490
41544
|
/**
|
|
@@ -42026,7 +42080,7 @@ class OrganizationAuthorizationApi {
|
|
|
42026
42080
|
/**
|
|
42027
42081
|
* OrganizationAuthorization service.
|
|
42028
42082
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42029
|
-
* @version
|
|
42083
|
+
* @version 209.0.0
|
|
42030
42084
|
*/
|
|
42031
42085
|
|
|
42032
42086
|
/**
|
|
@@ -43420,7 +43474,7 @@ class OutboundApi {
|
|
|
43420
43474
|
/**
|
|
43421
43475
|
* Outbound service.
|
|
43422
43476
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
43423
|
-
* @version
|
|
43477
|
+
* @version 209.0.0
|
|
43424
43478
|
*/
|
|
43425
43479
|
|
|
43426
43480
|
/**
|
|
@@ -47967,7 +48021,7 @@ class PresenceApi {
|
|
|
47967
48021
|
/**
|
|
47968
48022
|
* Presence service.
|
|
47969
48023
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47970
|
-
* @version
|
|
48024
|
+
* @version 209.0.0
|
|
47971
48025
|
*/
|
|
47972
48026
|
|
|
47973
48027
|
/**
|
|
@@ -48711,7 +48765,7 @@ class ProcessAutomationApi {
|
|
|
48711
48765
|
/**
|
|
48712
48766
|
* ProcessAutomation service.
|
|
48713
48767
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48714
|
-
* @version
|
|
48768
|
+
* @version 209.0.0
|
|
48715
48769
|
*/
|
|
48716
48770
|
|
|
48717
48771
|
/**
|
|
@@ -48950,7 +49004,7 @@ class QualityApi {
|
|
|
48950
49004
|
/**
|
|
48951
49005
|
* Quality service.
|
|
48952
49006
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48953
|
-
* @version
|
|
49007
|
+
* @version 209.0.0
|
|
48954
49008
|
*/
|
|
48955
49009
|
|
|
48956
49010
|
/**
|
|
@@ -49235,6 +49289,7 @@ class QualityApi {
|
|
|
49235
49289
|
* @param {String} opts.group group id
|
|
49236
49290
|
* @param {String} opts.agentTeamId team id of agents requested
|
|
49237
49291
|
* @param {String} opts.formContextId shared id between form versions
|
|
49292
|
+
* @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
49293
|
*/
|
|
49239
49294
|
getQualityAgentsActivity(opts) {
|
|
49240
49295
|
opts = opts || {};
|
|
@@ -49244,7 +49299,7 @@ class QualityApi {
|
|
|
49244
49299
|
'/api/v2/quality/agents/activity',
|
|
49245
49300
|
'GET',
|
|
49246
49301
|
{ },
|
|
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'] },
|
|
49302
|
+
{ '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
49303
|
{ },
|
|
49249
49304
|
{ },
|
|
49250
49305
|
null,
|
|
@@ -49459,6 +49514,7 @@ class QualityApi {
|
|
|
49459
49514
|
* @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
49515
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
49461
49516
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
49517
|
+
* @param {Boolean} opts.includeDeletedUsers Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (default to false)
|
|
49462
49518
|
*/
|
|
49463
49519
|
getQualityEvaluationsQuery(opts) {
|
|
49464
49520
|
opts = opts || {};
|
|
@@ -49468,7 +49524,7 @@ class QualityApi {
|
|
|
49468
49524
|
'/api/v2/quality/evaluations/query',
|
|
49469
49525
|
'GET',
|
|
49470
49526
|
{ },
|
|
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'] },
|
|
49527
|
+
{ '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
49528
|
{ },
|
|
49473
49529
|
{ },
|
|
49474
49530
|
null,
|
|
@@ -50736,7 +50792,7 @@ class RecordingApi {
|
|
|
50736
50792
|
/**
|
|
50737
50793
|
* Recording service.
|
|
50738
50794
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50739
|
-
* @version
|
|
50795
|
+
* @version 209.0.0
|
|
50740
50796
|
*/
|
|
50741
50797
|
|
|
50742
50798
|
/**
|
|
@@ -52395,7 +52451,7 @@ class ResponseManagementApi {
|
|
|
52395
52451
|
/**
|
|
52396
52452
|
* ResponseManagement service.
|
|
52397
52453
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
52398
|
-
* @version
|
|
52454
|
+
* @version 209.0.0
|
|
52399
52455
|
*/
|
|
52400
52456
|
|
|
52401
52457
|
/**
|
|
@@ -52905,7 +52961,7 @@ class RoutingApi {
|
|
|
52905
52961
|
/**
|
|
52906
52962
|
* Routing service.
|
|
52907
52963
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52908
|
-
* @version
|
|
52964
|
+
* @version 209.0.0
|
|
52909
52965
|
*/
|
|
52910
52966
|
|
|
52911
52967
|
/**
|
|
@@ -53313,18 +53369,18 @@ class RoutingApi {
|
|
|
53313
53369
|
/**
|
|
53314
53370
|
* Delete a phone number provisioned for SMS.
|
|
53315
53371
|
*
|
|
53316
|
-
* @param {String}
|
|
53372
|
+
* @param {String} phoneNumberId phone number
|
|
53317
53373
|
*/
|
|
53318
|
-
deleteRoutingSmsPhonenumber(
|
|
53319
|
-
// verify the required parameter '
|
|
53320
|
-
if (
|
|
53321
|
-
throw 'Missing the required parameter "
|
|
53374
|
+
deleteRoutingSmsPhonenumber(phoneNumberId) {
|
|
53375
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
53376
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
53377
|
+
throw 'Missing the required parameter "phoneNumberId" when calling deleteRoutingSmsPhonenumber';
|
|
53322
53378
|
}
|
|
53323
53379
|
|
|
53324
53380
|
return this.apiClient.callApi(
|
|
53325
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
53381
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
53326
53382
|
'DELETE',
|
|
53327
|
-
{ '
|
|
53383
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
53328
53384
|
{ },
|
|
53329
53385
|
{ },
|
|
53330
53386
|
{ },
|
|
@@ -54303,9 +54359,13 @@ class RoutingApi {
|
|
|
54303
54359
|
* Get Estimated Wait Time
|
|
54304
54360
|
*
|
|
54305
54361
|
* @param {String} queueId queueId
|
|
54306
|
-
* @param {
|
|
54362
|
+
* @param {Object} mediaType mediaType
|
|
54363
|
+
* @param {Object} opts Optional parameters
|
|
54364
|
+
* @param {String} opts.labelId Unique id that represents the interaction label used with media type for EWT calculation
|
|
54307
54365
|
*/
|
|
54308
|
-
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType) {
|
|
54366
|
+
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType, opts) {
|
|
54367
|
+
opts = opts || {};
|
|
54368
|
+
|
|
54309
54369
|
// verify the required parameter 'queueId' is set
|
|
54310
54370
|
if (queueId === undefined || queueId === null) {
|
|
54311
54371
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';
|
|
@@ -54319,7 +54379,7 @@ class RoutingApi {
|
|
|
54319
54379
|
'/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime',
|
|
54320
54380
|
'GET',
|
|
54321
54381
|
{ 'queueId': queueId,'mediaType': mediaType },
|
|
54322
|
-
{
|
|
54382
|
+
{ 'labelId': opts['labelId'] },
|
|
54323
54383
|
{ },
|
|
54324
54384
|
{ },
|
|
54325
54385
|
null,
|
|
@@ -54870,22 +54930,22 @@ class RoutingApi {
|
|
|
54870
54930
|
/**
|
|
54871
54931
|
* Get a phone number provisioned for SMS.
|
|
54872
54932
|
*
|
|
54873
|
-
* @param {String}
|
|
54933
|
+
* @param {String} phoneNumberId phone number
|
|
54874
54934
|
* @param {Object} opts Optional parameters
|
|
54875
54935
|
* @param {Object} opts.expand Expand response with additional information
|
|
54876
54936
|
*/
|
|
54877
|
-
getRoutingSmsPhonenumber(
|
|
54937
|
+
getRoutingSmsPhonenumber(phoneNumberId, opts) {
|
|
54878
54938
|
opts = opts || {};
|
|
54879
54939
|
|
|
54880
|
-
// verify the required parameter '
|
|
54881
|
-
if (
|
|
54882
|
-
throw 'Missing the required parameter "
|
|
54940
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
54941
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
54942
|
+
throw 'Missing the required parameter "phoneNumberId" when calling getRoutingSmsPhonenumber';
|
|
54883
54943
|
}
|
|
54884
54944
|
|
|
54885
54945
|
return this.apiClient.callApi(
|
|
54886
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
54946
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
54887
54947
|
'GET',
|
|
54888
|
-
{ '
|
|
54948
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
54889
54949
|
{ 'expand': opts['expand'] },
|
|
54890
54950
|
{ },
|
|
54891
54951
|
{ },
|
|
@@ -56810,13 +56870,13 @@ class RoutingApi {
|
|
|
56810
56870
|
/**
|
|
56811
56871
|
* Update a phone number provisioned for SMS.
|
|
56812
56872
|
*
|
|
56813
|
-
* @param {String}
|
|
56873
|
+
* @param {String} phoneNumberId phone number
|
|
56814
56874
|
* @param {Object} body SmsPhoneNumber
|
|
56815
56875
|
*/
|
|
56816
|
-
putRoutingSmsPhonenumber(
|
|
56817
|
-
// verify the required parameter '
|
|
56818
|
-
if (
|
|
56819
|
-
throw 'Missing the required parameter "
|
|
56876
|
+
putRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
56877
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
56878
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
56879
|
+
throw 'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';
|
|
56820
56880
|
}
|
|
56821
56881
|
// verify the required parameter 'body' is set
|
|
56822
56882
|
if (body === undefined || body === null) {
|
|
@@ -56824,9 +56884,9 @@ class RoutingApi {
|
|
|
56824
56884
|
}
|
|
56825
56885
|
|
|
56826
56886
|
return this.apiClient.callApi(
|
|
56827
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
56887
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
56828
56888
|
'PUT',
|
|
56829
|
-
{ '
|
|
56889
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
56830
56890
|
{ },
|
|
56831
56891
|
{ },
|
|
56832
56892
|
{ },
|
|
@@ -57053,7 +57113,7 @@ class SCIMApi {
|
|
|
57053
57113
|
/**
|
|
57054
57114
|
* SCIM service.
|
|
57055
57115
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
57056
|
-
* @version
|
|
57116
|
+
* @version 209.0.0
|
|
57057
57117
|
*/
|
|
57058
57118
|
|
|
57059
57119
|
/**
|
|
@@ -57930,7 +57990,7 @@ class ScreenRecordingApi {
|
|
|
57930
57990
|
/**
|
|
57931
57991
|
* ScreenRecording service.
|
|
57932
57992
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57933
|
-
* @version
|
|
57993
|
+
* @version 209.0.0
|
|
57934
57994
|
*/
|
|
57935
57995
|
|
|
57936
57996
|
/**
|
|
@@ -57975,7 +58035,7 @@ class ScriptsApi {
|
|
|
57975
58035
|
/**
|
|
57976
58036
|
* Scripts service.
|
|
57977
58037
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57978
|
-
* @version
|
|
58038
|
+
* @version 209.0.0
|
|
57979
58039
|
*/
|
|
57980
58040
|
|
|
57981
58041
|
/**
|
|
@@ -58419,7 +58479,7 @@ class SearchApi {
|
|
|
58419
58479
|
/**
|
|
58420
58480
|
* Search service.
|
|
58421
58481
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
58422
|
-
* @version
|
|
58482
|
+
* @version 209.0.0
|
|
58423
58483
|
*/
|
|
58424
58484
|
|
|
58425
58485
|
/**
|
|
@@ -59162,7 +59222,7 @@ class SettingsApi {
|
|
|
59162
59222
|
/**
|
|
59163
59223
|
* Settings service.
|
|
59164
59224
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
59165
|
-
* @version
|
|
59225
|
+
* @version 209.0.0
|
|
59166
59226
|
*/
|
|
59167
59227
|
|
|
59168
59228
|
/**
|
|
@@ -59378,11 +59438,916 @@ class SettingsApi {
|
|
|
59378
59438
|
|
|
59379
59439
|
}
|
|
59380
59440
|
|
|
59441
|
+
class SocialMediaApi {
|
|
59442
|
+
/**
|
|
59443
|
+
* SocialMedia service.
|
|
59444
|
+
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
59445
|
+
* @version 209.0.0
|
|
59446
|
+
*/
|
|
59447
|
+
|
|
59448
|
+
/**
|
|
59449
|
+
* Constructs a new SocialMediaApi.
|
|
59450
|
+
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
59451
|
+
* @class
|
|
59452
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
59453
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
59454
|
+
*/
|
|
59455
|
+
constructor(apiClient) {
|
|
59456
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
59457
|
+
}
|
|
59458
|
+
|
|
59459
|
+
|
|
59460
|
+
/**
|
|
59461
|
+
* Delete a social topic.
|
|
59462
|
+
*
|
|
59463
|
+
* @param {String} topicId topicId
|
|
59464
|
+
* @param {Object} opts Optional parameters
|
|
59465
|
+
* @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.
|
|
59466
|
+
* deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59467
|
+
*/
|
|
59468
|
+
deleteSocialmediaTopic(topicId, opts) {
|
|
59469
|
+
opts = opts || {};
|
|
59470
|
+
|
|
59471
|
+
// verify the required parameter 'topicId' is set
|
|
59472
|
+
if (topicId === undefined || topicId === null) {
|
|
59473
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopic';
|
|
59474
|
+
}
|
|
59475
|
+
|
|
59476
|
+
return this.apiClient.callApi(
|
|
59477
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
59478
|
+
'DELETE',
|
|
59479
|
+
{ 'topicId': topicId },
|
|
59480
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59481
|
+
{ },
|
|
59482
|
+
{ },
|
|
59483
|
+
null,
|
|
59484
|
+
['PureCloud OAuth'],
|
|
59485
|
+
['application/json'],
|
|
59486
|
+
['application/json']
|
|
59487
|
+
);
|
|
59488
|
+
}
|
|
59489
|
+
|
|
59490
|
+
/**
|
|
59491
|
+
* Delete a Facebook data ingestion rule.
|
|
59492
|
+
*
|
|
59493
|
+
* @param {String} topicId topicId
|
|
59494
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59495
|
+
* @param {Object} opts Optional parameters
|
|
59496
|
+
* @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)
|
|
59497
|
+
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59498
|
+
*/
|
|
59499
|
+
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
59500
|
+
opts = opts || {};
|
|
59501
|
+
|
|
59502
|
+
// verify the required parameter 'topicId' is set
|
|
59503
|
+
if (topicId === undefined || topicId === null) {
|
|
59504
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59505
|
+
}
|
|
59506
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59507
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59508
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59509
|
+
}
|
|
59510
|
+
|
|
59511
|
+
return this.apiClient.callApi(
|
|
59512
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
59513
|
+
'DELETE',
|
|
59514
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59515
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59516
|
+
{ },
|
|
59517
|
+
{ },
|
|
59518
|
+
null,
|
|
59519
|
+
['PureCloud OAuth'],
|
|
59520
|
+
['application/json'],
|
|
59521
|
+
['application/json']
|
|
59522
|
+
);
|
|
59523
|
+
}
|
|
59524
|
+
|
|
59525
|
+
/**
|
|
59526
|
+
* Delete a open data ingestion rule.
|
|
59527
|
+
*
|
|
59528
|
+
* @param {String} topicId topicId
|
|
59529
|
+
* @param {String} openId openId
|
|
59530
|
+
* @param {Object} opts Optional parameters
|
|
59531
|
+
* @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)
|
|
59532
|
+
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59533
|
+
*/
|
|
59534
|
+
deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
59535
|
+
opts = opts || {};
|
|
59536
|
+
|
|
59537
|
+
// verify the required parameter 'topicId' is set
|
|
59538
|
+
if (topicId === undefined || topicId === null) {
|
|
59539
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59540
|
+
}
|
|
59541
|
+
// verify the required parameter 'openId' is set
|
|
59542
|
+
if (openId === undefined || openId === null) {
|
|
59543
|
+
throw 'Missing the required parameter "openId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59544
|
+
}
|
|
59545
|
+
|
|
59546
|
+
return this.apiClient.callApi(
|
|
59547
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
59548
|
+
'DELETE',
|
|
59549
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59550
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59551
|
+
{ },
|
|
59552
|
+
{ },
|
|
59553
|
+
null,
|
|
59554
|
+
['PureCloud OAuth'],
|
|
59555
|
+
['application/json'],
|
|
59556
|
+
['application/json']
|
|
59557
|
+
);
|
|
59558
|
+
}
|
|
59559
|
+
|
|
59560
|
+
/**
|
|
59561
|
+
* Delete a X (formally Twitter) data ingestion rule.
|
|
59562
|
+
*
|
|
59563
|
+
* @param {String} topicId topicId
|
|
59564
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59565
|
+
* @param {Object} opts Optional parameters
|
|
59566
|
+
* @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)
|
|
59567
|
+
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59568
|
+
*/
|
|
59569
|
+
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
59570
|
+
opts = opts || {};
|
|
59571
|
+
|
|
59572
|
+
// verify the required parameter 'topicId' is set
|
|
59573
|
+
if (topicId === undefined || topicId === null) {
|
|
59574
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59575
|
+
}
|
|
59576
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59577
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59578
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59579
|
+
}
|
|
59580
|
+
|
|
59581
|
+
return this.apiClient.callApi(
|
|
59582
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
59583
|
+
'DELETE',
|
|
59584
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59585
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59586
|
+
{ },
|
|
59587
|
+
{ },
|
|
59588
|
+
null,
|
|
59589
|
+
['PureCloud OAuth'],
|
|
59590
|
+
['application/json'],
|
|
59591
|
+
['application/json']
|
|
59592
|
+
);
|
|
59593
|
+
}
|
|
59594
|
+
|
|
59595
|
+
/**
|
|
59596
|
+
* Get a single social topic.
|
|
59597
|
+
*
|
|
59598
|
+
* @param {String} topicId topicId
|
|
59599
|
+
* @param {Object} opts Optional parameters
|
|
59600
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59601
|
+
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59602
|
+
*/
|
|
59603
|
+
getSocialmediaTopic(topicId, opts) {
|
|
59604
|
+
opts = opts || {};
|
|
59605
|
+
|
|
59606
|
+
// verify the required parameter 'topicId' is set
|
|
59607
|
+
if (topicId === undefined || topicId === null) {
|
|
59608
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopic';
|
|
59609
|
+
}
|
|
59610
|
+
|
|
59611
|
+
return this.apiClient.callApi(
|
|
59612
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
59613
|
+
'GET',
|
|
59614
|
+
{ 'topicId': topicId },
|
|
59615
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59616
|
+
{ },
|
|
59617
|
+
{ },
|
|
59618
|
+
null,
|
|
59619
|
+
['PureCloud OAuth'],
|
|
59620
|
+
['application/json'],
|
|
59621
|
+
['application/json']
|
|
59622
|
+
);
|
|
59623
|
+
}
|
|
59624
|
+
|
|
59625
|
+
/**
|
|
59626
|
+
* Get a single Facebook data ingestion rule.
|
|
59627
|
+
*
|
|
59628
|
+
* @param {String} topicId topicId
|
|
59629
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59630
|
+
* @param {Object} opts Optional parameters
|
|
59631
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59632
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59633
|
+
*/
|
|
59634
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
59635
|
+
opts = opts || {};
|
|
59636
|
+
|
|
59637
|
+
// verify the required parameter 'topicId' is set
|
|
59638
|
+
if (topicId === undefined || topicId === null) {
|
|
59639
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59640
|
+
}
|
|
59641
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59642
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59643
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59644
|
+
}
|
|
59645
|
+
|
|
59646
|
+
return this.apiClient.callApi(
|
|
59647
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
59648
|
+
'GET',
|
|
59649
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59650
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59651
|
+
{ },
|
|
59652
|
+
{ },
|
|
59653
|
+
null,
|
|
59654
|
+
['PureCloud OAuth'],
|
|
59655
|
+
['application/json'],
|
|
59656
|
+
['application/json']
|
|
59657
|
+
);
|
|
59658
|
+
}
|
|
59659
|
+
|
|
59660
|
+
/**
|
|
59661
|
+
* Get a single Facebook data ingestion rule version.
|
|
59662
|
+
*
|
|
59663
|
+
* @param {String} topicId topicId
|
|
59664
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59665
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59666
|
+
* @param {Object} opts Optional parameters
|
|
59667
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59668
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59669
|
+
*/
|
|
59670
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
59671
|
+
opts = opts || {};
|
|
59672
|
+
|
|
59673
|
+
// verify the required parameter 'topicId' is set
|
|
59674
|
+
if (topicId === undefined || topicId === null) {
|
|
59675
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59676
|
+
}
|
|
59677
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59678
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59679
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59680
|
+
}
|
|
59681
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59682
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59683
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59684
|
+
}
|
|
59685
|
+
|
|
59686
|
+
return this.apiClient.callApi(
|
|
59687
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
59688
|
+
'GET',
|
|
59689
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59690
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59691
|
+
{ },
|
|
59692
|
+
{ },
|
|
59693
|
+
null,
|
|
59694
|
+
['PureCloud OAuth'],
|
|
59695
|
+
['application/json'],
|
|
59696
|
+
['application/json']
|
|
59697
|
+
);
|
|
59698
|
+
}
|
|
59699
|
+
|
|
59700
|
+
/**
|
|
59701
|
+
* Get the Facebook data ingestion rule versions.
|
|
59702
|
+
*
|
|
59703
|
+
* @param {String} topicId topicId
|
|
59704
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59705
|
+
* @param {Object} opts Optional parameters
|
|
59706
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59707
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59708
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59709
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59710
|
+
*/
|
|
59711
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
|
|
59712
|
+
opts = opts || {};
|
|
59713
|
+
|
|
59714
|
+
// verify the required parameter 'topicId' is set
|
|
59715
|
+
if (topicId === undefined || topicId === null) {
|
|
59716
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
59717
|
+
}
|
|
59718
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59719
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59720
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
59721
|
+
}
|
|
59722
|
+
|
|
59723
|
+
return this.apiClient.callApi(
|
|
59724
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions',
|
|
59725
|
+
'GET',
|
|
59726
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59727
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59728
|
+
{ },
|
|
59729
|
+
{ },
|
|
59730
|
+
null,
|
|
59731
|
+
['PureCloud OAuth'],
|
|
59732
|
+
['application/json'],
|
|
59733
|
+
['application/json']
|
|
59734
|
+
);
|
|
59735
|
+
}
|
|
59736
|
+
|
|
59737
|
+
/**
|
|
59738
|
+
* Get a single open data ingestion rule.
|
|
59739
|
+
*
|
|
59740
|
+
* @param {String} topicId topicId
|
|
59741
|
+
* @param {String} openId openId
|
|
59742
|
+
* @param {Object} opts Optional parameters
|
|
59743
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59744
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59745
|
+
*/
|
|
59746
|
+
getSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
59747
|
+
opts = opts || {};
|
|
59748
|
+
|
|
59749
|
+
// verify the required parameter 'topicId' is set
|
|
59750
|
+
if (topicId === undefined || topicId === null) {
|
|
59751
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59752
|
+
}
|
|
59753
|
+
// verify the required parameter 'openId' is set
|
|
59754
|
+
if (openId === undefined || openId === null) {
|
|
59755
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59756
|
+
}
|
|
59757
|
+
|
|
59758
|
+
return this.apiClient.callApi(
|
|
59759
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
59760
|
+
'GET',
|
|
59761
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59762
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59763
|
+
{ },
|
|
59764
|
+
{ },
|
|
59765
|
+
null,
|
|
59766
|
+
['PureCloud OAuth'],
|
|
59767
|
+
['application/json'],
|
|
59768
|
+
['application/json']
|
|
59769
|
+
);
|
|
59770
|
+
}
|
|
59771
|
+
|
|
59772
|
+
/**
|
|
59773
|
+
* Get a single Open data ingestion rule version.
|
|
59774
|
+
*
|
|
59775
|
+
* @param {String} topicId topicId
|
|
59776
|
+
* @param {String} openId openId
|
|
59777
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59778
|
+
* @param {Object} opts Optional parameters
|
|
59779
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59780
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59781
|
+
*/
|
|
59782
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId, openId, dataIngestionRuleVersion, opts) {
|
|
59783
|
+
opts = opts || {};
|
|
59784
|
+
|
|
59785
|
+
// verify the required parameter 'topicId' is set
|
|
59786
|
+
if (topicId === undefined || topicId === null) {
|
|
59787
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59788
|
+
}
|
|
59789
|
+
// verify the required parameter 'openId' is set
|
|
59790
|
+
if (openId === undefined || openId === null) {
|
|
59791
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59792
|
+
}
|
|
59793
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59794
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59795
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59796
|
+
}
|
|
59797
|
+
|
|
59798
|
+
return this.apiClient.callApi(
|
|
59799
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}',
|
|
59800
|
+
'GET',
|
|
59801
|
+
{ 'topicId': topicId,'openId': openId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59802
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59803
|
+
{ },
|
|
59804
|
+
{ },
|
|
59805
|
+
null,
|
|
59806
|
+
['PureCloud OAuth'],
|
|
59807
|
+
['application/json'],
|
|
59808
|
+
['application/json']
|
|
59809
|
+
);
|
|
59810
|
+
}
|
|
59811
|
+
|
|
59812
|
+
/**
|
|
59813
|
+
* Get the Open data ingestion rule versions.
|
|
59814
|
+
*
|
|
59815
|
+
* @param {String} topicId topicId
|
|
59816
|
+
* @param {String} openId openId
|
|
59817
|
+
* @param {Object} opts Optional parameters
|
|
59818
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59819
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59820
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59821
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59822
|
+
*/
|
|
59823
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId, openId, opts) {
|
|
59824
|
+
opts = opts || {};
|
|
59825
|
+
|
|
59826
|
+
// verify the required parameter 'topicId' is set
|
|
59827
|
+
if (topicId === undefined || topicId === null) {
|
|
59828
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
59829
|
+
}
|
|
59830
|
+
// verify the required parameter 'openId' is set
|
|
59831
|
+
if (openId === undefined || openId === null) {
|
|
59832
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
59833
|
+
}
|
|
59834
|
+
|
|
59835
|
+
return this.apiClient.callApi(
|
|
59836
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions',
|
|
59837
|
+
'GET',
|
|
59838
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59839
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59840
|
+
{ },
|
|
59841
|
+
{ },
|
|
59842
|
+
null,
|
|
59843
|
+
['PureCloud OAuth'],
|
|
59844
|
+
['application/json'],
|
|
59845
|
+
['application/json']
|
|
59846
|
+
);
|
|
59847
|
+
}
|
|
59848
|
+
|
|
59849
|
+
/**
|
|
59850
|
+
* Get a single X (formally Twitter) data ingestion rule.
|
|
59851
|
+
*
|
|
59852
|
+
* @param {String} topicId topicId
|
|
59853
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59854
|
+
* @param {Object} opts Optional parameters
|
|
59855
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59856
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59857
|
+
*/
|
|
59858
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
59859
|
+
opts = opts || {};
|
|
59860
|
+
|
|
59861
|
+
// verify the required parameter 'topicId' is set
|
|
59862
|
+
if (topicId === undefined || topicId === null) {
|
|
59863
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59864
|
+
}
|
|
59865
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59866
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59867
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59868
|
+
}
|
|
59869
|
+
|
|
59870
|
+
return this.apiClient.callApi(
|
|
59871
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
59872
|
+
'GET',
|
|
59873
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59874
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59875
|
+
{ },
|
|
59876
|
+
{ },
|
|
59877
|
+
null,
|
|
59878
|
+
['PureCloud OAuth'],
|
|
59879
|
+
['application/json'],
|
|
59880
|
+
['application/json']
|
|
59881
|
+
);
|
|
59882
|
+
}
|
|
59883
|
+
|
|
59884
|
+
/**
|
|
59885
|
+
* Get a single X (formally Twitter) data ingestion rule version.
|
|
59886
|
+
*
|
|
59887
|
+
* @param {String} topicId topicId
|
|
59888
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59889
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59890
|
+
* @param {Object} opts Optional parameters
|
|
59891
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59892
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59893
|
+
*/
|
|
59894
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
59895
|
+
opts = opts || {};
|
|
59896
|
+
|
|
59897
|
+
// verify the required parameter 'topicId' is set
|
|
59898
|
+
if (topicId === undefined || topicId === null) {
|
|
59899
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59900
|
+
}
|
|
59901
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59902
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59903
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59904
|
+
}
|
|
59905
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59906
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59907
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59908
|
+
}
|
|
59909
|
+
|
|
59910
|
+
return this.apiClient.callApi(
|
|
59911
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
59912
|
+
'GET',
|
|
59913
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59914
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59915
|
+
{ },
|
|
59916
|
+
{ },
|
|
59917
|
+
null,
|
|
59918
|
+
['PureCloud OAuth'],
|
|
59919
|
+
['application/json'],
|
|
59920
|
+
['application/json']
|
|
59921
|
+
);
|
|
59922
|
+
}
|
|
59923
|
+
|
|
59924
|
+
/**
|
|
59925
|
+
* Get the Open data ingestion rule versions.
|
|
59926
|
+
*
|
|
59927
|
+
* @param {String} topicId topicId
|
|
59928
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59929
|
+
* @param {Object} opts Optional parameters
|
|
59930
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59931
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59932
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59933
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59934
|
+
*/
|
|
59935
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
|
|
59936
|
+
opts = opts || {};
|
|
59937
|
+
|
|
59938
|
+
// verify the required parameter 'topicId' is set
|
|
59939
|
+
if (topicId === undefined || topicId === null) {
|
|
59940
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
59941
|
+
}
|
|
59942
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59943
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59944
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
59945
|
+
}
|
|
59946
|
+
|
|
59947
|
+
return this.apiClient.callApi(
|
|
59948
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions',
|
|
59949
|
+
'GET',
|
|
59950
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59951
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59952
|
+
{ },
|
|
59953
|
+
{ },
|
|
59954
|
+
null,
|
|
59955
|
+
['PureCloud OAuth'],
|
|
59956
|
+
['application/json'],
|
|
59957
|
+
['application/json']
|
|
59958
|
+
);
|
|
59959
|
+
}
|
|
59960
|
+
|
|
59961
|
+
/**
|
|
59962
|
+
* Retrieve all social topics.
|
|
59963
|
+
*
|
|
59964
|
+
* @param {Object} opts Optional parameters
|
|
59965
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59966
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59967
|
+
* @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.
|
|
59968
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59969
|
+
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59970
|
+
*/
|
|
59971
|
+
getSocialmediaTopics(opts) {
|
|
59972
|
+
opts = opts || {};
|
|
59973
|
+
|
|
59974
|
+
|
|
59975
|
+
return this.apiClient.callApi(
|
|
59976
|
+
'/api/v2/socialmedia/topics',
|
|
59977
|
+
'GET',
|
|
59978
|
+
{ },
|
|
59979
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
|
|
59980
|
+
{ },
|
|
59981
|
+
{ },
|
|
59982
|
+
null,
|
|
59983
|
+
['PureCloud OAuth'],
|
|
59984
|
+
['application/json'],
|
|
59985
|
+
['application/json']
|
|
59986
|
+
);
|
|
59987
|
+
}
|
|
59988
|
+
|
|
59989
|
+
/**
|
|
59990
|
+
* Update a social topic.
|
|
59991
|
+
*
|
|
59992
|
+
* @param {String} topicId topicId
|
|
59993
|
+
* @param {Object} opts Optional parameters
|
|
59994
|
+
* @param {Object} opts.body
|
|
59995
|
+
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59996
|
+
*/
|
|
59997
|
+
patchSocialmediaTopic(topicId, opts) {
|
|
59998
|
+
opts = opts || {};
|
|
59999
|
+
|
|
60000
|
+
// verify the required parameter 'topicId' is set
|
|
60001
|
+
if (topicId === undefined || topicId === null) {
|
|
60002
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopic';
|
|
60003
|
+
}
|
|
60004
|
+
|
|
60005
|
+
return this.apiClient.callApi(
|
|
60006
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
60007
|
+
'PATCH',
|
|
60008
|
+
{ 'topicId': topicId },
|
|
60009
|
+
{ },
|
|
60010
|
+
{ },
|
|
60011
|
+
{ },
|
|
60012
|
+
opts['body'],
|
|
60013
|
+
['PureCloud OAuth'],
|
|
60014
|
+
['application/json'],
|
|
60015
|
+
['application/json']
|
|
60016
|
+
);
|
|
60017
|
+
}
|
|
60018
|
+
|
|
60019
|
+
/**
|
|
60020
|
+
* Update the status of a Facebook data ingestion rule.
|
|
60021
|
+
*
|
|
60022
|
+
* @param {String} topicId topicId
|
|
60023
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60024
|
+
* @param {Object} opts Optional parameters
|
|
60025
|
+
* @param {Object} opts.body
|
|
60026
|
+
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60027
|
+
*/
|
|
60028
|
+
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60029
|
+
opts = opts || {};
|
|
60030
|
+
|
|
60031
|
+
// verify the required parameter 'topicId' is set
|
|
60032
|
+
if (topicId === undefined || topicId === null) {
|
|
60033
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60034
|
+
}
|
|
60035
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60036
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60037
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60038
|
+
}
|
|
60039
|
+
|
|
60040
|
+
return this.apiClient.callApi(
|
|
60041
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60042
|
+
'PATCH',
|
|
60043
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60044
|
+
{ },
|
|
60045
|
+
{ },
|
|
60046
|
+
{ },
|
|
60047
|
+
opts['body'],
|
|
60048
|
+
['PureCloud OAuth'],
|
|
60049
|
+
['application/json'],
|
|
60050
|
+
['application/json']
|
|
60051
|
+
);
|
|
60052
|
+
}
|
|
60053
|
+
|
|
60054
|
+
/**
|
|
60055
|
+
* Update the status of a open data ingestion rule.
|
|
60056
|
+
*
|
|
60057
|
+
* @param {String} topicId topicId
|
|
60058
|
+
* @param {String} openId openId
|
|
60059
|
+
* @param {Object} opts Optional parameters
|
|
60060
|
+
* @param {Object} opts.body
|
|
60061
|
+
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60062
|
+
*/
|
|
60063
|
+
patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60064
|
+
opts = opts || {};
|
|
60065
|
+
|
|
60066
|
+
// verify the required parameter 'topicId' is set
|
|
60067
|
+
if (topicId === undefined || topicId === null) {
|
|
60068
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60069
|
+
}
|
|
60070
|
+
// verify the required parameter 'openId' is set
|
|
60071
|
+
if (openId === undefined || openId === null) {
|
|
60072
|
+
throw 'Missing the required parameter "openId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60073
|
+
}
|
|
60074
|
+
|
|
60075
|
+
return this.apiClient.callApi(
|
|
60076
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60077
|
+
'PATCH',
|
|
60078
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60079
|
+
{ },
|
|
60080
|
+
{ },
|
|
60081
|
+
{ },
|
|
60082
|
+
opts['body'],
|
|
60083
|
+
['PureCloud OAuth'],
|
|
60084
|
+
['application/json'],
|
|
60085
|
+
['application/json']
|
|
60086
|
+
);
|
|
60087
|
+
}
|
|
60088
|
+
|
|
60089
|
+
/**
|
|
60090
|
+
* Update the status of a X (formally Twitter) data ingestion rule.
|
|
60091
|
+
*
|
|
60092
|
+
* @param {String} topicId topicId
|
|
60093
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60094
|
+
* @param {Object} opts Optional parameters
|
|
60095
|
+
* @param {Object} opts.body
|
|
60096
|
+
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60097
|
+
*/
|
|
60098
|
+
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60099
|
+
opts = opts || {};
|
|
60100
|
+
|
|
60101
|
+
// verify the required parameter 'topicId' is set
|
|
60102
|
+
if (topicId === undefined || topicId === null) {
|
|
60103
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60104
|
+
}
|
|
60105
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60106
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60107
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60108
|
+
}
|
|
60109
|
+
|
|
60110
|
+
return this.apiClient.callApi(
|
|
60111
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60112
|
+
'PATCH',
|
|
60113
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60114
|
+
{ },
|
|
60115
|
+
{ },
|
|
60116
|
+
{ },
|
|
60117
|
+
opts['body'],
|
|
60118
|
+
['PureCloud OAuth'],
|
|
60119
|
+
['application/json'],
|
|
60120
|
+
['application/json']
|
|
60121
|
+
);
|
|
60122
|
+
}
|
|
60123
|
+
|
|
60124
|
+
/**
|
|
60125
|
+
* Create an Facebook data ingestion rule.
|
|
60126
|
+
*
|
|
60127
|
+
* @param {String} topicId topicId
|
|
60128
|
+
* @param {Object} opts Optional parameters
|
|
60129
|
+
* @param {Object} opts.body
|
|
60130
|
+
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60131
|
+
*/
|
|
60132
|
+
postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
|
|
60133
|
+
opts = opts || {};
|
|
60134
|
+
|
|
60135
|
+
// verify the required parameter 'topicId' is set
|
|
60136
|
+
if (topicId === undefined || topicId === null) {
|
|
60137
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesFacebook';
|
|
60138
|
+
}
|
|
60139
|
+
|
|
60140
|
+
return this.apiClient.callApi(
|
|
60141
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook',
|
|
60142
|
+
'POST',
|
|
60143
|
+
{ 'topicId': topicId },
|
|
60144
|
+
{ },
|
|
60145
|
+
{ },
|
|
60146
|
+
{ },
|
|
60147
|
+
opts['body'],
|
|
60148
|
+
['PureCloud OAuth'],
|
|
60149
|
+
['application/json'],
|
|
60150
|
+
['application/json']
|
|
60151
|
+
);
|
|
60152
|
+
}
|
|
60153
|
+
|
|
60154
|
+
/**
|
|
60155
|
+
* Create an open data ingestion rule.
|
|
60156
|
+
*
|
|
60157
|
+
* @param {String} topicId topicId
|
|
60158
|
+
* @param {Object} opts Optional parameters
|
|
60159
|
+
* @param {Object} opts.body
|
|
60160
|
+
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60161
|
+
*/
|
|
60162
|
+
postSocialmediaTopicDataingestionrulesOpen(topicId, opts) {
|
|
60163
|
+
opts = opts || {};
|
|
60164
|
+
|
|
60165
|
+
// verify the required parameter 'topicId' is set
|
|
60166
|
+
if (topicId === undefined || topicId === null) {
|
|
60167
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpen';
|
|
60168
|
+
}
|
|
60169
|
+
|
|
60170
|
+
return this.apiClient.callApi(
|
|
60171
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open',
|
|
60172
|
+
'POST',
|
|
60173
|
+
{ 'topicId': topicId },
|
|
60174
|
+
{ },
|
|
60175
|
+
{ },
|
|
60176
|
+
{ },
|
|
60177
|
+
opts['body'],
|
|
60178
|
+
['PureCloud OAuth'],
|
|
60179
|
+
['application/json'],
|
|
60180
|
+
['application/json']
|
|
60181
|
+
);
|
|
60182
|
+
}
|
|
60183
|
+
|
|
60184
|
+
/**
|
|
60185
|
+
* Create an twitter data ingestion rule.
|
|
60186
|
+
*
|
|
60187
|
+
* @param {String} topicId topicId
|
|
60188
|
+
* @param {Object} opts Optional parameters
|
|
60189
|
+
* @param {Object} opts.body
|
|
60190
|
+
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60191
|
+
*/
|
|
60192
|
+
postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
|
|
60193
|
+
opts = opts || {};
|
|
60194
|
+
|
|
60195
|
+
// verify the required parameter 'topicId' is set
|
|
60196
|
+
if (topicId === undefined || topicId === null) {
|
|
60197
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesTwitter';
|
|
60198
|
+
}
|
|
60199
|
+
|
|
60200
|
+
return this.apiClient.callApi(
|
|
60201
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter',
|
|
60202
|
+
'POST',
|
|
60203
|
+
{ 'topicId': topicId },
|
|
60204
|
+
{ },
|
|
60205
|
+
{ },
|
|
60206
|
+
{ },
|
|
60207
|
+
opts['body'],
|
|
60208
|
+
['PureCloud OAuth'],
|
|
60209
|
+
['application/json'],
|
|
60210
|
+
['application/json']
|
|
60211
|
+
);
|
|
60212
|
+
}
|
|
60213
|
+
|
|
60214
|
+
/**
|
|
60215
|
+
* Create a social topic.
|
|
60216
|
+
*
|
|
60217
|
+
* @param {Object} opts Optional parameters
|
|
60218
|
+
* @param {Object} opts.body
|
|
60219
|
+
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60220
|
+
*/
|
|
60221
|
+
postSocialmediaTopics(opts) {
|
|
60222
|
+
opts = opts || {};
|
|
60223
|
+
|
|
60224
|
+
|
|
60225
|
+
return this.apiClient.callApi(
|
|
60226
|
+
'/api/v2/socialmedia/topics',
|
|
60227
|
+
'POST',
|
|
60228
|
+
{ },
|
|
60229
|
+
{ },
|
|
60230
|
+
{ },
|
|
60231
|
+
{ },
|
|
60232
|
+
opts['body'],
|
|
60233
|
+
['PureCloud OAuth'],
|
|
60234
|
+
['application/json'],
|
|
60235
|
+
['application/json']
|
|
60236
|
+
);
|
|
60237
|
+
}
|
|
60238
|
+
|
|
60239
|
+
/**
|
|
60240
|
+
* Update the Facebook data ingestion rule.
|
|
60241
|
+
*
|
|
60242
|
+
* @param {String} topicId topicId
|
|
60243
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60244
|
+
* @param {Object} opts Optional parameters
|
|
60245
|
+
* @param {Object} opts.body
|
|
60246
|
+
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60247
|
+
*/
|
|
60248
|
+
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60249
|
+
opts = opts || {};
|
|
60250
|
+
|
|
60251
|
+
// verify the required parameter 'topicId' is set
|
|
60252
|
+
if (topicId === undefined || topicId === null) {
|
|
60253
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60254
|
+
}
|
|
60255
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60256
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60257
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60258
|
+
}
|
|
60259
|
+
|
|
60260
|
+
return this.apiClient.callApi(
|
|
60261
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60262
|
+
'PUT',
|
|
60263
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60264
|
+
{ },
|
|
60265
|
+
{ },
|
|
60266
|
+
{ },
|
|
60267
|
+
opts['body'],
|
|
60268
|
+
['PureCloud OAuth'],
|
|
60269
|
+
['application/json'],
|
|
60270
|
+
['application/json']
|
|
60271
|
+
);
|
|
60272
|
+
}
|
|
60273
|
+
|
|
60274
|
+
/**
|
|
60275
|
+
* Update the open data ingestion rule.
|
|
60276
|
+
*
|
|
60277
|
+
* @param {String} topicId topicId
|
|
60278
|
+
* @param {String} openId openId
|
|
60279
|
+
* @param {Object} opts Optional parameters
|
|
60280
|
+
* @param {Object} opts.body
|
|
60281
|
+
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60282
|
+
*/
|
|
60283
|
+
putSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60284
|
+
opts = opts || {};
|
|
60285
|
+
|
|
60286
|
+
// verify the required parameter 'topicId' is set
|
|
60287
|
+
if (topicId === undefined || topicId === null) {
|
|
60288
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60289
|
+
}
|
|
60290
|
+
// verify the required parameter 'openId' is set
|
|
60291
|
+
if (openId === undefined || openId === null) {
|
|
60292
|
+
throw 'Missing the required parameter "openId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60293
|
+
}
|
|
60294
|
+
|
|
60295
|
+
return this.apiClient.callApi(
|
|
60296
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60297
|
+
'PUT',
|
|
60298
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60299
|
+
{ },
|
|
60300
|
+
{ },
|
|
60301
|
+
{ },
|
|
60302
|
+
opts['body'],
|
|
60303
|
+
['PureCloud OAuth'],
|
|
60304
|
+
['application/json'],
|
|
60305
|
+
['application/json']
|
|
60306
|
+
);
|
|
60307
|
+
}
|
|
60308
|
+
|
|
60309
|
+
/**
|
|
60310
|
+
* Update the X (formally Twitter) data ingestion rule.
|
|
60311
|
+
*
|
|
60312
|
+
* @param {String} topicId topicId
|
|
60313
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60314
|
+
* @param {Object} opts Optional parameters
|
|
60315
|
+
* @param {Object} opts.body
|
|
60316
|
+
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60317
|
+
*/
|
|
60318
|
+
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60319
|
+
opts = opts || {};
|
|
60320
|
+
|
|
60321
|
+
// verify the required parameter 'topicId' is set
|
|
60322
|
+
if (topicId === undefined || topicId === null) {
|
|
60323
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60324
|
+
}
|
|
60325
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60326
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60327
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60328
|
+
}
|
|
60329
|
+
|
|
60330
|
+
return this.apiClient.callApi(
|
|
60331
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60332
|
+
'PUT',
|
|
60333
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60334
|
+
{ },
|
|
60335
|
+
{ },
|
|
60336
|
+
{ },
|
|
60337
|
+
opts['body'],
|
|
60338
|
+
['PureCloud OAuth'],
|
|
60339
|
+
['application/json'],
|
|
60340
|
+
['application/json']
|
|
60341
|
+
);
|
|
60342
|
+
}
|
|
60343
|
+
|
|
60344
|
+
}
|
|
60345
|
+
|
|
59381
60346
|
class SpeechTextAnalyticsApi {
|
|
59382
60347
|
/**
|
|
59383
60348
|
* SpeechTextAnalytics service.
|
|
59384
60349
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
59385
|
-
* @version
|
|
60350
|
+
* @version 209.0.0
|
|
59386
60351
|
*/
|
|
59387
60352
|
|
|
59388
60353
|
/**
|
|
@@ -60717,7 +61682,7 @@ class StationsApi {
|
|
|
60717
61682
|
/**
|
|
60718
61683
|
* Stations service.
|
|
60719
61684
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60720
|
-
* @version
|
|
61685
|
+
* @version 209.0.0
|
|
60721
61686
|
*/
|
|
60722
61687
|
|
|
60723
61688
|
/**
|
|
@@ -60819,7 +61784,7 @@ class SuggestApi {
|
|
|
60819
61784
|
/**
|
|
60820
61785
|
* Suggest service.
|
|
60821
61786
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60822
|
-
* @version
|
|
61787
|
+
* @version 209.0.0
|
|
60823
61788
|
*/
|
|
60824
61789
|
|
|
60825
61790
|
/**
|
|
@@ -60958,7 +61923,7 @@ class TaskManagementApi {
|
|
|
60958
61923
|
/**
|
|
60959
61924
|
* TaskManagement service.
|
|
60960
61925
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60961
|
-
* @version
|
|
61926
|
+
* @version 209.0.0
|
|
60962
61927
|
*/
|
|
60963
61928
|
|
|
60964
61929
|
/**
|
|
@@ -62622,7 +63587,7 @@ class TeamsApi {
|
|
|
62622
63587
|
/**
|
|
62623
63588
|
* Teams service.
|
|
62624
63589
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
62625
|
-
* @version
|
|
63590
|
+
* @version 209.0.0
|
|
62626
63591
|
*/
|
|
62627
63592
|
|
|
62628
63593
|
/**
|
|
@@ -62927,7 +63892,7 @@ class TelephonyApi {
|
|
|
62927
63892
|
/**
|
|
62928
63893
|
* Telephony service.
|
|
62929
63894
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62930
|
-
* @version
|
|
63895
|
+
* @version 209.0.0
|
|
62931
63896
|
*/
|
|
62932
63897
|
|
|
62933
63898
|
/**
|
|
@@ -63109,7 +64074,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
63109
64074
|
/**
|
|
63110
64075
|
* TelephonyProvidersEdge service.
|
|
63111
64076
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
63112
|
-
* @version
|
|
64077
|
+
* @version 209.0.0
|
|
63113
64078
|
*/
|
|
63114
64079
|
|
|
63115
64080
|
/**
|
|
@@ -66560,7 +67525,7 @@ class TextbotsApi {
|
|
|
66560
67525
|
/**
|
|
66561
67526
|
* Textbots service.
|
|
66562
67527
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
66563
|
-
* @version
|
|
67528
|
+
* @version 209.0.0
|
|
66564
67529
|
*/
|
|
66565
67530
|
|
|
66566
67531
|
/**
|
|
@@ -66688,7 +67653,7 @@ class TokensApi {
|
|
|
66688
67653
|
/**
|
|
66689
67654
|
* Tokens service.
|
|
66690
67655
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
66691
|
-
* @version
|
|
67656
|
+
* @version 209.0.0
|
|
66692
67657
|
*/
|
|
66693
67658
|
|
|
66694
67659
|
/**
|
|
@@ -66842,7 +67807,7 @@ class UploadsApi {
|
|
|
66842
67807
|
/**
|
|
66843
67808
|
* Uploads service.
|
|
66844
67809
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66845
|
-
* @version
|
|
67810
|
+
* @version 209.0.0
|
|
66846
67811
|
*/
|
|
66847
67812
|
|
|
66848
67813
|
/**
|
|
@@ -67111,7 +68076,7 @@ class UsageApi {
|
|
|
67111
68076
|
/**
|
|
67112
68077
|
* Usage service.
|
|
67113
68078
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
67114
|
-
* @version
|
|
68079
|
+
* @version 209.0.0
|
|
67115
68080
|
*/
|
|
67116
68081
|
|
|
67117
68082
|
/**
|
|
@@ -67326,7 +68291,7 @@ class UserRecordingsApi {
|
|
|
67326
68291
|
/**
|
|
67327
68292
|
* UserRecordings service.
|
|
67328
68293
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
67329
|
-
* @version
|
|
68294
|
+
* @version 209.0.0
|
|
67330
68295
|
*/
|
|
67331
68296
|
|
|
67332
68297
|
/**
|
|
@@ -67541,7 +68506,7 @@ class UsersApi {
|
|
|
67541
68506
|
/**
|
|
67542
68507
|
* Users service.
|
|
67543
68508
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
67544
|
-
* @version
|
|
68509
|
+
* @version 209.0.0
|
|
67545
68510
|
*/
|
|
67546
68511
|
|
|
67547
68512
|
/**
|
|
@@ -70370,7 +71335,7 @@ class UtilitiesApi {
|
|
|
70370
71335
|
/**
|
|
70371
71336
|
* Utilities service.
|
|
70372
71337
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
70373
|
-
* @version
|
|
71338
|
+
* @version 209.0.0
|
|
70374
71339
|
*/
|
|
70375
71340
|
|
|
70376
71341
|
/**
|
|
@@ -70481,7 +71446,7 @@ class VoicemailApi {
|
|
|
70481
71446
|
/**
|
|
70482
71447
|
* Voicemail service.
|
|
70483
71448
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
70484
|
-
* @version
|
|
71449
|
+
* @version 209.0.0
|
|
70485
71450
|
*/
|
|
70486
71451
|
|
|
70487
71452
|
/**
|
|
@@ -71203,7 +72168,7 @@ class WebChatApi {
|
|
|
71203
72168
|
/**
|
|
71204
72169
|
* WebChat service.
|
|
71205
72170
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
71206
|
-
* @version
|
|
72171
|
+
* @version 209.0.0
|
|
71207
72172
|
*/
|
|
71208
72173
|
|
|
71209
72174
|
/**
|
|
@@ -71754,7 +72719,7 @@ class WebDeploymentsApi {
|
|
|
71754
72719
|
/**
|
|
71755
72720
|
* WebDeployments service.
|
|
71756
72721
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
71757
|
-
* @version
|
|
72722
|
+
* @version 209.0.0
|
|
71758
72723
|
*/
|
|
71759
72724
|
|
|
71760
72725
|
/**
|
|
@@ -72281,7 +73246,7 @@ class WebMessagingApi {
|
|
|
72281
73246
|
/**
|
|
72282
73247
|
* WebMessaging service.
|
|
72283
73248
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
72284
|
-
* @version
|
|
73249
|
+
* @version 209.0.0
|
|
72285
73250
|
*/
|
|
72286
73251
|
|
|
72287
73252
|
/**
|
|
@@ -72327,7 +73292,7 @@ class WidgetsApi {
|
|
|
72327
73292
|
/**
|
|
72328
73293
|
* Widgets service.
|
|
72329
73294
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
72330
|
-
* @version
|
|
73295
|
+
* @version 209.0.0
|
|
72331
73296
|
*/
|
|
72332
73297
|
|
|
72333
73298
|
/**
|
|
@@ -72473,7 +73438,7 @@ class WorkforceManagementApi {
|
|
|
72473
73438
|
/**
|
|
72474
73439
|
* WorkforceManagement service.
|
|
72475
73440
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
72476
|
-
* @version
|
|
73441
|
+
* @version 209.0.0
|
|
72477
73442
|
*/
|
|
72478
73443
|
|
|
72479
73444
|
/**
|
|
@@ -75509,7 +76474,7 @@ class WorkforceManagementApi {
|
|
|
75509
76474
|
* Gets all the shift trades for a given week
|
|
75510
76475
|
*
|
|
75511
76476
|
* @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
|
|
76477
|
+
* @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
76478
|
* @param {Object} opts Optional parameters
|
|
75514
76479
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
75515
76480
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -76735,7 +77700,7 @@ class WorkforceManagementApi {
|
|
|
76735
77700
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
76736
77701
|
*
|
|
76737
77702
|
* @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
|
|
77703
|
+
* @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
77704
|
* @param {String} tradeId The ID of the shift trade to update
|
|
76740
77705
|
* @param {Object} body body
|
|
76741
77706
|
*/
|
|
@@ -78995,7 +79960,7 @@ class WorkforceManagementApi {
|
|
|
78995
79960
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
78996
79961
|
*
|
|
78997
79962
|
* @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
|
|
79963
|
+
* @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
79964
|
* @param {String} tradeId The ID of the shift trade to update
|
|
79000
79965
|
* @param {Object} body body
|
|
79001
79966
|
*/
|
|
@@ -79035,7 +80000,7 @@ class WorkforceManagementApi {
|
|
|
79035
80000
|
* Adds a shift trade
|
|
79036
80001
|
*
|
|
79037
80002
|
* @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
|
|
80003
|
+
* @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
80004
|
* @param {Object} body body
|
|
79040
80005
|
*/
|
|
79041
80006
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body) {
|
|
@@ -79070,7 +80035,7 @@ class WorkforceManagementApi {
|
|
|
79070
80035
|
* Searches for potential shift trade matches for the current agent
|
|
79071
80036
|
*
|
|
79072
80037
|
* @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
|
|
80038
|
+
* @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
80039
|
* @param {Object} body body
|
|
79075
80040
|
* @param {Object} opts Optional parameters
|
|
79076
80041
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -79109,7 +80074,7 @@ class WorkforceManagementApi {
|
|
|
79109
80074
|
* Updates the state of a batch of shift trades
|
|
79110
80075
|
* Admin functionality is not supported with "mine".
|
|
79111
80076
|
* @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
|
|
80077
|
+
* @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
80078
|
* @param {Object} body body
|
|
79114
80079
|
* @param {Object} opts Optional parameters
|
|
79115
80080
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -79687,7 +80652,7 @@ class WorkforceManagementApi {
|
|
|
79687
80652
|
* </pre>
|
|
79688
80653
|
* </p>
|
|
79689
80654
|
* @module purecloud-platform-client-v2/index
|
|
79690
|
-
* @version
|
|
80655
|
+
* @version 209.0.0
|
|
79691
80656
|
*/
|
|
79692
80657
|
class platformClient {
|
|
79693
80658
|
constructor() {
|
|
@@ -79991,6 +80956,11 @@ class platformClient {
|
|
|
79991
80956
|
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
79992
80957
|
*/
|
|
79993
80958
|
this.SettingsApi = SettingsApi;
|
|
80959
|
+
/**
|
|
80960
|
+
* The SocialMediaApi service constructor.
|
|
80961
|
+
* @property {module:purecloud-platform-client-v2/api/SocialMediaApi}
|
|
80962
|
+
*/
|
|
80963
|
+
this.SocialMediaApi = SocialMediaApi;
|
|
79994
80964
|
/**
|
|
79995
80965
|
* The SpeechTextAnalyticsApi service constructor.
|
|
79996
80966
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|