purecloud-platform-client-v2 207.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 +1392 -162
- package/dist/web-amd/purecloud-platform-client-v2.js +1392 -162
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +511 -178
- package/dist/web-cjs/purecloud-platform-client-v2.js +669 -256
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +4261 -3234
- 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 +3 -8
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +31 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +136 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +11 -5
- 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 +40 -36
- 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 +55 -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 +4 -4
- 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 +55 -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 +12 -12
- 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
|
/**
|
|
@@ -21828,7 +21827,6 @@ class ExternalContactsApi {
|
|
|
21828
21827
|
* Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
|
|
21829
21828
|
*
|
|
21830
21829
|
* @param {String} externalSourceId External Source ID
|
|
21831
|
-
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21832
21830
|
*/
|
|
21833
21831
|
deleteExternalcontactsExternalsource(externalSourceId) {
|
|
21834
21832
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -22136,7 +22134,7 @@ class ExternalContactsApi {
|
|
|
22136
22134
|
*
|
|
22137
22135
|
* @param {String} contactId ExternalContact ID
|
|
22138
22136
|
* @param {Object} opts Optional parameters
|
|
22139
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22137
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22140
22138
|
*/
|
|
22141
22139
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
22142
22140
|
opts = opts || {};
|
|
@@ -22292,7 +22290,6 @@ class ExternalContactsApi {
|
|
|
22292
22290
|
* Fetch an External Source
|
|
22293
22291
|
*
|
|
22294
22292
|
* @param {String} externalSourceId External Source ID
|
|
22295
|
-
* getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22296
22293
|
*/
|
|
22297
22294
|
getExternalcontactsExternalsource(externalSourceId) {
|
|
22298
22295
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -22322,7 +22319,6 @@ class ExternalContactsApi {
|
|
|
22322
22319
|
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
22323
22320
|
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
22324
22321
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
22325
|
-
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22326
22322
|
*/
|
|
22327
22323
|
getExternalcontactsExternalsources(opts) {
|
|
22328
22324
|
opts = opts || {};
|
|
@@ -22448,7 +22444,7 @@ class ExternalContactsApi {
|
|
|
22448
22444
|
*
|
|
22449
22445
|
* @param {String} externalOrganizationId External Organization ID
|
|
22450
22446
|
* @param {Object} opts Optional parameters
|
|
22451
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22447
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22452
22448
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
22453
22449
|
*/
|
|
22454
22450
|
getExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
@@ -23456,7 +23452,6 @@ class ExternalContactsApi {
|
|
|
23456
23452
|
* Create an External Source
|
|
23457
23453
|
*
|
|
23458
23454
|
* @param {Object} body External Source
|
|
23459
|
-
* postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23460
23455
|
*/
|
|
23461
23456
|
postExternalcontactsExternalsources(body) {
|
|
23462
23457
|
// verify the required parameter 'body' is set
|
|
@@ -23842,7 +23837,6 @@ class ExternalContactsApi {
|
|
|
23842
23837
|
*
|
|
23843
23838
|
* @param {String} externalSourceId External Source ID
|
|
23844
23839
|
* @param {Object} body External Source
|
|
23845
|
-
* putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23846
23840
|
*/
|
|
23847
23841
|
putExternalcontactsExternalsource(externalSourceId, body) {
|
|
23848
23842
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -24059,7 +24053,7 @@ class FaxApi {
|
|
|
24059
24053
|
/**
|
|
24060
24054
|
* Fax service.
|
|
24061
24055
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24062
|
-
* @version
|
|
24056
|
+
* @version 209.0.0
|
|
24063
24057
|
*/
|
|
24064
24058
|
|
|
24065
24059
|
/**
|
|
@@ -24274,7 +24268,7 @@ class FlowsApi {
|
|
|
24274
24268
|
/**
|
|
24275
24269
|
* Flows service.
|
|
24276
24270
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
24277
|
-
* @version
|
|
24271
|
+
* @version 209.0.0
|
|
24278
24272
|
*/
|
|
24279
24273
|
|
|
24280
24274
|
/**
|
|
@@ -24457,7 +24451,7 @@ class GamificationApi {
|
|
|
24457
24451
|
/**
|
|
24458
24452
|
* Gamification service.
|
|
24459
24453
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24460
|
-
* @version
|
|
24454
|
+
* @version 209.0.0
|
|
24461
24455
|
*/
|
|
24462
24456
|
|
|
24463
24457
|
/**
|
|
@@ -26543,7 +26537,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26543
26537
|
/**
|
|
26544
26538
|
* GeneralDataProtectionRegulation service.
|
|
26545
26539
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26546
|
-
* @version
|
|
26540
|
+
* @version 209.0.0
|
|
26547
26541
|
*/
|
|
26548
26542
|
|
|
26549
26543
|
/**
|
|
@@ -26673,7 +26667,7 @@ class GeolocationApi {
|
|
|
26673
26667
|
/**
|
|
26674
26668
|
* Geolocation service.
|
|
26675
26669
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26676
|
-
* @version
|
|
26670
|
+
* @version 209.0.0
|
|
26677
26671
|
*/
|
|
26678
26672
|
|
|
26679
26673
|
/**
|
|
@@ -26804,7 +26798,7 @@ class GreetingsApi {
|
|
|
26804
26798
|
/**
|
|
26805
26799
|
* Greetings service.
|
|
26806
26800
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26807
|
-
* @version
|
|
26801
|
+
* @version 209.0.0
|
|
26808
26802
|
*/
|
|
26809
26803
|
|
|
26810
26804
|
/**
|
|
@@ -27259,7 +27253,7 @@ class GroupsApi {
|
|
|
27259
27253
|
/**
|
|
27260
27254
|
* Groups service.
|
|
27261
27255
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27262
|
-
* @version
|
|
27256
|
+
* @version 209.0.0
|
|
27263
27257
|
*/
|
|
27264
27258
|
|
|
27265
27259
|
/**
|
|
@@ -27778,7 +27772,7 @@ class IdentityProviderApi {
|
|
|
27778
27772
|
/**
|
|
27779
27773
|
* IdentityProvider service.
|
|
27780
27774
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27781
|
-
* @version
|
|
27775
|
+
* @version 209.0.0
|
|
27782
27776
|
*/
|
|
27783
27777
|
|
|
27784
27778
|
/**
|
|
@@ -28639,7 +28633,7 @@ class InfrastructureAsCodeApi {
|
|
|
28639
28633
|
/**
|
|
28640
28634
|
* InfrastructureAsCode service.
|
|
28641
28635
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28642
|
-
* @version
|
|
28636
|
+
* @version 209.0.0
|
|
28643
28637
|
*/
|
|
28644
28638
|
|
|
28645
28639
|
/**
|
|
@@ -28806,7 +28800,7 @@ class IntegrationsApi {
|
|
|
28806
28800
|
/**
|
|
28807
28801
|
* Integrations service.
|
|
28808
28802
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28809
|
-
* @version
|
|
28803
|
+
* @version 209.0.0
|
|
28810
28804
|
*/
|
|
28811
28805
|
|
|
28812
28806
|
/**
|
|
@@ -29100,8 +29094,12 @@ class IntegrationsApi {
|
|
|
29100
29094
|
*
|
|
29101
29095
|
* @param {String} actionId actionId
|
|
29102
29096
|
* @param {String} fileName Name of schema file to be retrieved for this draft.
|
|
29097
|
+
* @param {Object} opts Optional parameters
|
|
29098
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
29103
29099
|
*/
|
|
29104
|
-
getIntegrationsActionDraftSchema(actionId, fileName) {
|
|
29100
|
+
getIntegrationsActionDraftSchema(actionId, fileName, opts) {
|
|
29101
|
+
opts = opts || {};
|
|
29102
|
+
|
|
29105
29103
|
// verify the required parameter 'actionId' is set
|
|
29106
29104
|
if (actionId === undefined || actionId === null) {
|
|
29107
29105
|
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';
|
|
@@ -29115,7 +29113,7 @@ class IntegrationsApi {
|
|
|
29115
29113
|
'/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}',
|
|
29116
29114
|
'GET',
|
|
29117
29115
|
{ 'actionId': actionId,'fileName': fileName },
|
|
29118
|
-
{
|
|
29116
|
+
{ 'flatten': opts['flatten'] },
|
|
29119
29117
|
{ },
|
|
29120
29118
|
{ },
|
|
29121
29119
|
null,
|
|
@@ -29211,8 +29209,12 @@ class IntegrationsApi {
|
|
|
29211
29209
|
*
|
|
29212
29210
|
* @param {String} actionId actionId
|
|
29213
29211
|
* @param {String} fileName Name of schema file to be retrieved for this action.
|
|
29212
|
+
* @param {Object} opts Optional parameters
|
|
29213
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
29214
29214
|
*/
|
|
29215
|
-
getIntegrationsActionSchema(actionId, fileName) {
|
|
29215
|
+
getIntegrationsActionSchema(actionId, fileName, opts) {
|
|
29216
|
+
opts = opts || {};
|
|
29217
|
+
|
|
29216
29218
|
// verify the required parameter 'actionId' is set
|
|
29217
29219
|
if (actionId === undefined || actionId === null) {
|
|
29218
29220
|
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';
|
|
@@ -29226,7 +29228,7 @@ class IntegrationsApi {
|
|
|
29226
29228
|
'/api/v2/integrations/actions/{actionId}/schemas/{fileName}',
|
|
29227
29229
|
'GET',
|
|
29228
29230
|
{ 'actionId': actionId,'fileName': fileName },
|
|
29229
|
-
{
|
|
29231
|
+
{ 'flatten': opts['flatten'] },
|
|
29230
29232
|
{ },
|
|
29231
29233
|
{ },
|
|
29232
29234
|
null,
|
|
@@ -30763,8 +30765,12 @@ class IntegrationsApi {
|
|
|
30763
30765
|
*
|
|
30764
30766
|
* @param {String} actionId actionId
|
|
30765
30767
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30768
|
+
* @param {Object} opts Optional parameters
|
|
30769
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30766
30770
|
*/
|
|
30767
|
-
postIntegrationsActionDraftTest(actionId, body) {
|
|
30771
|
+
postIntegrationsActionDraftTest(actionId, body, opts) {
|
|
30772
|
+
opts = opts || {};
|
|
30773
|
+
|
|
30768
30774
|
// verify the required parameter 'actionId' is set
|
|
30769
30775
|
if (actionId === undefined || actionId === null) {
|
|
30770
30776
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';
|
|
@@ -30778,7 +30784,7 @@ class IntegrationsApi {
|
|
|
30778
30784
|
'/api/v2/integrations/actions/{actionId}/draft/test',
|
|
30779
30785
|
'POST',
|
|
30780
30786
|
{ 'actionId': actionId },
|
|
30781
|
-
{
|
|
30787
|
+
{ 'flatten': opts['flatten'] },
|
|
30782
30788
|
{ },
|
|
30783
30789
|
{ },
|
|
30784
30790
|
body,
|
|
@@ -30793,8 +30799,12 @@ class IntegrationsApi {
|
|
|
30793
30799
|
*
|
|
30794
30800
|
* @param {String} actionId actionId
|
|
30795
30801
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30802
|
+
* @param {Object} opts Optional parameters
|
|
30803
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30796
30804
|
*/
|
|
30797
|
-
postIntegrationsActionExecute(actionId, body) {
|
|
30805
|
+
postIntegrationsActionExecute(actionId, body, opts) {
|
|
30806
|
+
opts = opts || {};
|
|
30807
|
+
|
|
30798
30808
|
// verify the required parameter 'actionId' is set
|
|
30799
30809
|
if (actionId === undefined || actionId === null) {
|
|
30800
30810
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';
|
|
@@ -30808,7 +30818,7 @@ class IntegrationsApi {
|
|
|
30808
30818
|
'/api/v2/integrations/actions/{actionId}/execute',
|
|
30809
30819
|
'POST',
|
|
30810
30820
|
{ 'actionId': actionId },
|
|
30811
|
-
{
|
|
30821
|
+
{ 'flatten': opts['flatten'] },
|
|
30812
30822
|
{ },
|
|
30813
30823
|
{ },
|
|
30814
30824
|
body,
|
|
@@ -30823,8 +30833,12 @@ class IntegrationsApi {
|
|
|
30823
30833
|
*
|
|
30824
30834
|
* @param {String} actionId actionId
|
|
30825
30835
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30836
|
+
* @param {Object} opts Optional parameters
|
|
30837
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30826
30838
|
*/
|
|
30827
|
-
postIntegrationsActionTest(actionId, body) {
|
|
30839
|
+
postIntegrationsActionTest(actionId, body, opts) {
|
|
30840
|
+
opts = opts || {};
|
|
30841
|
+
|
|
30828
30842
|
// verify the required parameter 'actionId' is set
|
|
30829
30843
|
if (actionId === undefined || actionId === null) {
|
|
30830
30844
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionTest';
|
|
@@ -30838,7 +30852,7 @@ class IntegrationsApi {
|
|
|
30838
30852
|
'/api/v2/integrations/actions/{actionId}/test',
|
|
30839
30853
|
'POST',
|
|
30840
30854
|
{ 'actionId': actionId },
|
|
30841
|
-
{
|
|
30855
|
+
{ 'flatten': opts['flatten'] },
|
|
30842
30856
|
{ },
|
|
30843
30857
|
{ },
|
|
30844
30858
|
body,
|
|
@@ -31228,7 +31242,7 @@ class JourneyApi {
|
|
|
31228
31242
|
/**
|
|
31229
31243
|
* Journey service.
|
|
31230
31244
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31231
|
-
* @version
|
|
31245
|
+
* @version 209.0.0
|
|
31232
31246
|
*/
|
|
31233
31247
|
|
|
31234
31248
|
/**
|
|
@@ -31397,6 +31411,31 @@ class JourneyApi {
|
|
|
31397
31411
|
);
|
|
31398
31412
|
}
|
|
31399
31413
|
|
|
31414
|
+
/**
|
|
31415
|
+
* Delete the Schedule of a JourneyView
|
|
31416
|
+
* used for long descriptions
|
|
31417
|
+
* @param {String} viewId Journey View Id
|
|
31418
|
+
*/
|
|
31419
|
+
deleteJourneyViewSchedules(viewId) {
|
|
31420
|
+
// verify the required parameter 'viewId' is set
|
|
31421
|
+
if (viewId === undefined || viewId === null) {
|
|
31422
|
+
throw 'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';
|
|
31423
|
+
}
|
|
31424
|
+
|
|
31425
|
+
return this.apiClient.callApi(
|
|
31426
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
31427
|
+
'DELETE',
|
|
31428
|
+
{ 'viewId': viewId },
|
|
31429
|
+
{ },
|
|
31430
|
+
{ },
|
|
31431
|
+
{ },
|
|
31432
|
+
null,
|
|
31433
|
+
['PureCloud OAuth'],
|
|
31434
|
+
['application/json'],
|
|
31435
|
+
['application/json']
|
|
31436
|
+
);
|
|
31437
|
+
}
|
|
31438
|
+
|
|
31400
31439
|
/**
|
|
31401
31440
|
* Get status for async query for journey aggregates
|
|
31402
31441
|
*
|
|
@@ -32045,6 +32084,31 @@ class JourneyApi {
|
|
|
32045
32084
|
);
|
|
32046
32085
|
}
|
|
32047
32086
|
|
|
32087
|
+
/**
|
|
32088
|
+
* Get the Schedule for a JourneyView
|
|
32089
|
+
* used for long descriptions
|
|
32090
|
+
* @param {String} viewId Journey View Id
|
|
32091
|
+
*/
|
|
32092
|
+
getJourneyViewSchedules(viewId) {
|
|
32093
|
+
// verify the required parameter 'viewId' is set
|
|
32094
|
+
if (viewId === undefined || viewId === null) {
|
|
32095
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewSchedules';
|
|
32096
|
+
}
|
|
32097
|
+
|
|
32098
|
+
return this.apiClient.callApi(
|
|
32099
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
32100
|
+
'GET',
|
|
32101
|
+
{ 'viewId': viewId },
|
|
32102
|
+
{ },
|
|
32103
|
+
{ },
|
|
32104
|
+
{ },
|
|
32105
|
+
null,
|
|
32106
|
+
['PureCloud OAuth'],
|
|
32107
|
+
['application/json'],
|
|
32108
|
+
['application/json']
|
|
32109
|
+
);
|
|
32110
|
+
}
|
|
32111
|
+
|
|
32048
32112
|
/**
|
|
32049
32113
|
* Get a Journey View by ID and version
|
|
32050
32114
|
*
|
|
@@ -32390,6 +32454,31 @@ class JourneyApi {
|
|
|
32390
32454
|
);
|
|
32391
32455
|
}
|
|
32392
32456
|
|
|
32457
|
+
/**
|
|
32458
|
+
* Get the journey schedules for an organization.
|
|
32459
|
+
*
|
|
32460
|
+
* @param {Object} opts Optional parameters
|
|
32461
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
32462
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
32463
|
+
*/
|
|
32464
|
+
getJourneyViewsSchedules(opts) {
|
|
32465
|
+
opts = opts || {};
|
|
32466
|
+
|
|
32467
|
+
|
|
32468
|
+
return this.apiClient.callApi(
|
|
32469
|
+
'/api/v2/journey/views/schedules',
|
|
32470
|
+
'GET',
|
|
32471
|
+
{ },
|
|
32472
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
32473
|
+
{ },
|
|
32474
|
+
{ },
|
|
32475
|
+
null,
|
|
32476
|
+
['PureCloud OAuth'],
|
|
32477
|
+
['application/json'],
|
|
32478
|
+
['application/json']
|
|
32479
|
+
);
|
|
32480
|
+
}
|
|
32481
|
+
|
|
32393
32482
|
/**
|
|
32394
32483
|
* Update single action map.
|
|
32395
32484
|
*
|
|
@@ -32908,6 +32997,36 @@ class JourneyApi {
|
|
|
32908
32997
|
);
|
|
32909
32998
|
}
|
|
32910
32999
|
|
|
33000
|
+
/**
|
|
33001
|
+
* Add a new Schedule to a JourneyView
|
|
33002
|
+
*
|
|
33003
|
+
* @param {String} viewId Journey View Id
|
|
33004
|
+
* @param {Object} body journeyViewSchedule
|
|
33005
|
+
*/
|
|
33006
|
+
postJourneyViewSchedules(viewId, body) {
|
|
33007
|
+
// verify the required parameter 'viewId' is set
|
|
33008
|
+
if (viewId === undefined || viewId === null) {
|
|
33009
|
+
throw 'Missing the required parameter "viewId" when calling postJourneyViewSchedules';
|
|
33010
|
+
}
|
|
33011
|
+
// verify the required parameter 'body' is set
|
|
33012
|
+
if (body === undefined || body === null) {
|
|
33013
|
+
throw 'Missing the required parameter "body" when calling postJourneyViewSchedules';
|
|
33014
|
+
}
|
|
33015
|
+
|
|
33016
|
+
return this.apiClient.callApi(
|
|
33017
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
33018
|
+
'POST',
|
|
33019
|
+
{ 'viewId': viewId },
|
|
33020
|
+
{ },
|
|
33021
|
+
{ },
|
|
33022
|
+
{ },
|
|
33023
|
+
body,
|
|
33024
|
+
['PureCloud OAuth'],
|
|
33025
|
+
['application/json'],
|
|
33026
|
+
['application/json']
|
|
33027
|
+
);
|
|
33028
|
+
}
|
|
33029
|
+
|
|
32911
33030
|
/**
|
|
32912
33031
|
* Submit a job request for a journey view version.
|
|
32913
33032
|
* used for long descriptions
|
|
@@ -33017,6 +33136,36 @@ class JourneyApi {
|
|
|
33017
33136
|
);
|
|
33018
33137
|
}
|
|
33019
33138
|
|
|
33139
|
+
/**
|
|
33140
|
+
* Update the Schedule for a JourneyView
|
|
33141
|
+
* used for long descriptions
|
|
33142
|
+
* @param {String} viewId Journey View Id
|
|
33143
|
+
* @param {Object} body journeyViewSchedule
|
|
33144
|
+
*/
|
|
33145
|
+
putJourneyViewSchedules(viewId, body) {
|
|
33146
|
+
// verify the required parameter 'viewId' is set
|
|
33147
|
+
if (viewId === undefined || viewId === null) {
|
|
33148
|
+
throw 'Missing the required parameter "viewId" when calling putJourneyViewSchedules';
|
|
33149
|
+
}
|
|
33150
|
+
// verify the required parameter 'body' is set
|
|
33151
|
+
if (body === undefined || body === null) {
|
|
33152
|
+
throw 'Missing the required parameter "body" when calling putJourneyViewSchedules';
|
|
33153
|
+
}
|
|
33154
|
+
|
|
33155
|
+
return this.apiClient.callApi(
|
|
33156
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
33157
|
+
'PUT',
|
|
33158
|
+
{ 'viewId': viewId },
|
|
33159
|
+
{ },
|
|
33160
|
+
{ },
|
|
33161
|
+
{ },
|
|
33162
|
+
body,
|
|
33163
|
+
['PureCloud OAuth'],
|
|
33164
|
+
['application/json'],
|
|
33165
|
+
['application/json']
|
|
33166
|
+
);
|
|
33167
|
+
}
|
|
33168
|
+
|
|
33020
33169
|
/**
|
|
33021
33170
|
* Update a Journey View by ID and version
|
|
33022
33171
|
* does not create a new version
|
|
@@ -33058,7 +33207,7 @@ class KnowledgeApi {
|
|
|
33058
33207
|
/**
|
|
33059
33208
|
* Knowledge service.
|
|
33060
33209
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
33061
|
-
* @version
|
|
33210
|
+
* @version 209.0.0
|
|
33062
33211
|
*/
|
|
33063
33212
|
|
|
33064
33213
|
/**
|
|
@@ -33582,8 +33731,12 @@ class KnowledgeApi {
|
|
|
33582
33731
|
* Get sync options available for a knowledge-connect integration
|
|
33583
33732
|
*
|
|
33584
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.
|
|
33585
33736
|
*/
|
|
33586
|
-
getKnowledgeIntegrationOptions(integrationId) {
|
|
33737
|
+
getKnowledgeIntegrationOptions(integrationId, opts) {
|
|
33738
|
+
opts = opts || {};
|
|
33739
|
+
|
|
33587
33740
|
// verify the required parameter 'integrationId' is set
|
|
33588
33741
|
if (integrationId === undefined || integrationId === null) {
|
|
33589
33742
|
throw 'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';
|
|
@@ -33593,7 +33746,7 @@ class KnowledgeApi {
|
|
|
33593
33746
|
'/api/v2/knowledge/integrations/{integrationId}/options',
|
|
33594
33747
|
'GET',
|
|
33595
33748
|
{ 'integrationId': integrationId },
|
|
33596
|
-
{
|
|
33749
|
+
{ 'knowledgeBaseIds': this.apiClient.buildCollectionParam(opts['knowledgeBaseIds'], 'multi') },
|
|
33597
33750
|
{ },
|
|
33598
33751
|
{ },
|
|
33599
33752
|
null,
|
|
@@ -33817,6 +33970,7 @@ class KnowledgeApi {
|
|
|
33817
33970
|
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
33818
33971
|
* @param {Object} opts Optional parameters
|
|
33819
33972
|
* @param {Object} opts.documentState The state of the document.
|
|
33973
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
33820
33974
|
*/
|
|
33821
33975
|
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
33822
33976
|
opts = opts || {};
|
|
@@ -33838,7 +33992,7 @@ class KnowledgeApi {
|
|
|
33838
33992
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
33839
33993
|
'GET',
|
|
33840
33994
|
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
33841
|
-
{ 'documentState': opts['documentState'] },
|
|
33995
|
+
{ 'documentState': opts['documentState'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33842
33996
|
{ },
|
|
33843
33997
|
{ },
|
|
33844
33998
|
null,
|
|
@@ -33858,6 +34012,7 @@ class KnowledgeApi {
|
|
|
33858
34012
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
33859
34013
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
33860
34014
|
* @param {Object} opts.documentState The state of the document.
|
|
34015
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
33861
34016
|
*/
|
|
33862
34017
|
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
33863
34018
|
opts = opts || {};
|
|
@@ -33875,7 +34030,7 @@ class KnowledgeApi {
|
|
|
33875
34030
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
33876
34031
|
'GET',
|
|
33877
34032
|
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
33878
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
34033
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33879
34034
|
{ },
|
|
33880
34035
|
{ },
|
|
33881
34036
|
null,
|
|
@@ -36928,7 +37083,7 @@ class LanguageUnderstandingApi {
|
|
|
36928
37083
|
/**
|
|
36929
37084
|
* LanguageUnderstanding service.
|
|
36930
37085
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
36931
|
-
* @version
|
|
37086
|
+
* @version 209.0.0
|
|
36932
37087
|
*/
|
|
36933
37088
|
|
|
36934
37089
|
/**
|
|
@@ -37962,7 +38117,7 @@ class LanguagesApi {
|
|
|
37962
38117
|
/**
|
|
37963
38118
|
* Languages service.
|
|
37964
38119
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
37965
|
-
* @version
|
|
38120
|
+
* @version 209.0.0
|
|
37966
38121
|
*/
|
|
37967
38122
|
|
|
37968
38123
|
/**
|
|
@@ -38184,7 +38339,7 @@ class LearningApi {
|
|
|
38184
38339
|
/**
|
|
38185
38340
|
* Learning service.
|
|
38186
38341
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
38187
|
-
* @version
|
|
38342
|
+
* @version 209.0.0
|
|
38188
38343
|
*/
|
|
38189
38344
|
|
|
38190
38345
|
/**
|
|
@@ -39213,7 +39368,7 @@ class LicenseApi {
|
|
|
39213
39368
|
/**
|
|
39214
39369
|
* License service.
|
|
39215
39370
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
39216
|
-
* @version
|
|
39371
|
+
* @version 209.0.0
|
|
39217
39372
|
*/
|
|
39218
39373
|
|
|
39219
39374
|
/**
|
|
@@ -39451,7 +39606,7 @@ class LocationsApi {
|
|
|
39451
39606
|
/**
|
|
39452
39607
|
* Locations service.
|
|
39453
39608
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39454
|
-
* @version
|
|
39609
|
+
* @version 209.0.0
|
|
39455
39610
|
*/
|
|
39456
39611
|
|
|
39457
39612
|
/**
|
|
@@ -39687,7 +39842,7 @@ class LogCaptureApi {
|
|
|
39687
39842
|
/**
|
|
39688
39843
|
* LogCapture service.
|
|
39689
39844
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39690
|
-
* @version
|
|
39845
|
+
* @version 209.0.0
|
|
39691
39846
|
*/
|
|
39692
39847
|
|
|
39693
39848
|
/**
|
|
@@ -39887,7 +40042,7 @@ class MessagingApi {
|
|
|
39887
40042
|
/**
|
|
39888
40043
|
* Messaging service.
|
|
39889
40044
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
39890
|
-
* @version
|
|
40045
|
+
* @version 209.0.0
|
|
39891
40046
|
*/
|
|
39892
40047
|
|
|
39893
40048
|
/**
|
|
@@ -40246,7 +40401,7 @@ class MobileDevicesApi {
|
|
|
40246
40401
|
/**
|
|
40247
40402
|
* MobileDevices service.
|
|
40248
40403
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
40249
|
-
* @version
|
|
40404
|
+
* @version 209.0.0
|
|
40250
40405
|
*/
|
|
40251
40406
|
|
|
40252
40407
|
/**
|
|
@@ -40397,7 +40552,7 @@ class NotificationsApi {
|
|
|
40397
40552
|
/**
|
|
40398
40553
|
* Notifications service.
|
|
40399
40554
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40400
|
-
* @version
|
|
40555
|
+
* @version 209.0.0
|
|
40401
40556
|
*/
|
|
40402
40557
|
|
|
40403
40558
|
/**
|
|
@@ -40630,7 +40785,7 @@ class OAuthApi {
|
|
|
40630
40785
|
/**
|
|
40631
40786
|
* OAuth service.
|
|
40632
40787
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40633
|
-
* @version
|
|
40788
|
+
* @version 209.0.0
|
|
40634
40789
|
*/
|
|
40635
40790
|
|
|
40636
40791
|
/**
|
|
@@ -40996,7 +41151,7 @@ class ObjectsApi {
|
|
|
40996
41151
|
/**
|
|
40997
41152
|
* Objects service.
|
|
40998
41153
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
40999
|
-
* @version
|
|
41154
|
+
* @version 209.0.0
|
|
41000
41155
|
*/
|
|
41001
41156
|
|
|
41002
41157
|
/**
|
|
@@ -41266,7 +41421,7 @@ class OperationalEventsApi {
|
|
|
41266
41421
|
/**
|
|
41267
41422
|
* OperationalEvents service.
|
|
41268
41423
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
41269
|
-
* @version
|
|
41424
|
+
* @version 209.0.0
|
|
41270
41425
|
*/
|
|
41271
41426
|
|
|
41272
41427
|
/**
|
|
@@ -41326,13 +41481,64 @@ class OperationalEventsApi {
|
|
|
41326
41481
|
);
|
|
41327
41482
|
}
|
|
41328
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
|
+
|
|
41329
41535
|
}
|
|
41330
41536
|
|
|
41331
41537
|
class OrganizationApi {
|
|
41332
41538
|
/**
|
|
41333
41539
|
* Organization service.
|
|
41334
41540
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41335
|
-
* @version
|
|
41541
|
+
* @version 209.0.0
|
|
41336
41542
|
*/
|
|
41337
41543
|
|
|
41338
41544
|
/**
|
|
@@ -41874,7 +42080,7 @@ class OrganizationAuthorizationApi {
|
|
|
41874
42080
|
/**
|
|
41875
42081
|
* OrganizationAuthorization service.
|
|
41876
42082
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
41877
|
-
* @version
|
|
42083
|
+
* @version 209.0.0
|
|
41878
42084
|
*/
|
|
41879
42085
|
|
|
41880
42086
|
/**
|
|
@@ -43268,7 +43474,7 @@ class OutboundApi {
|
|
|
43268
43474
|
/**
|
|
43269
43475
|
* Outbound service.
|
|
43270
43476
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
43271
|
-
* @version
|
|
43477
|
+
* @version 209.0.0
|
|
43272
43478
|
*/
|
|
43273
43479
|
|
|
43274
43480
|
/**
|
|
@@ -47815,7 +48021,7 @@ class PresenceApi {
|
|
|
47815
48021
|
/**
|
|
47816
48022
|
* Presence service.
|
|
47817
48023
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47818
|
-
* @version
|
|
48024
|
+
* @version 209.0.0
|
|
47819
48025
|
*/
|
|
47820
48026
|
|
|
47821
48027
|
/**
|
|
@@ -48559,7 +48765,7 @@ class ProcessAutomationApi {
|
|
|
48559
48765
|
/**
|
|
48560
48766
|
* ProcessAutomation service.
|
|
48561
48767
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48562
|
-
* @version
|
|
48768
|
+
* @version 209.0.0
|
|
48563
48769
|
*/
|
|
48564
48770
|
|
|
48565
48771
|
/**
|
|
@@ -48798,7 +49004,7 @@ class QualityApi {
|
|
|
48798
49004
|
/**
|
|
48799
49005
|
* Quality service.
|
|
48800
49006
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48801
|
-
* @version
|
|
49007
|
+
* @version 209.0.0
|
|
48802
49008
|
*/
|
|
48803
49009
|
|
|
48804
49010
|
/**
|
|
@@ -49083,6 +49289,7 @@ class QualityApi {
|
|
|
49083
49289
|
* @param {String} opts.group group id
|
|
49084
49290
|
* @param {String} opts.agentTeamId team id of agents requested
|
|
49085
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)
|
|
49086
49293
|
*/
|
|
49087
49294
|
getQualityAgentsActivity(opts) {
|
|
49088
49295
|
opts = opts || {};
|
|
@@ -49092,7 +49299,7 @@ class QualityApi {
|
|
|
49092
49299
|
'/api/v2/quality/agents/activity',
|
|
49093
49300
|
'GET',
|
|
49094
49301
|
{ },
|
|
49095
|
-
{ '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'] },
|
|
49096
49303
|
{ },
|
|
49097
49304
|
{ },
|
|
49098
49305
|
null,
|
|
@@ -49307,6 +49514,7 @@ class QualityApi {
|
|
|
49307
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.
|
|
49308
49515
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
49309
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)
|
|
49310
49518
|
*/
|
|
49311
49519
|
getQualityEvaluationsQuery(opts) {
|
|
49312
49520
|
opts = opts || {};
|
|
@@ -49316,7 +49524,7 @@ class QualityApi {
|
|
|
49316
49524
|
'/api/v2/quality/evaluations/query',
|
|
49317
49525
|
'GET',
|
|
49318
49526
|
{ },
|
|
49319
|
-
{ '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'] },
|
|
49320
49528
|
{ },
|
|
49321
49529
|
{ },
|
|
49322
49530
|
null,
|
|
@@ -50584,7 +50792,7 @@ class RecordingApi {
|
|
|
50584
50792
|
/**
|
|
50585
50793
|
* Recording service.
|
|
50586
50794
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50587
|
-
* @version
|
|
50795
|
+
* @version 209.0.0
|
|
50588
50796
|
*/
|
|
50589
50797
|
|
|
50590
50798
|
/**
|
|
@@ -52243,7 +52451,7 @@ class ResponseManagementApi {
|
|
|
52243
52451
|
/**
|
|
52244
52452
|
* ResponseManagement service.
|
|
52245
52453
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
52246
|
-
* @version
|
|
52454
|
+
* @version 209.0.0
|
|
52247
52455
|
*/
|
|
52248
52456
|
|
|
52249
52457
|
/**
|
|
@@ -52753,7 +52961,7 @@ class RoutingApi {
|
|
|
52753
52961
|
/**
|
|
52754
52962
|
* Routing service.
|
|
52755
52963
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52756
|
-
* @version
|
|
52964
|
+
* @version 209.0.0
|
|
52757
52965
|
*/
|
|
52758
52966
|
|
|
52759
52967
|
/**
|
|
@@ -53161,18 +53369,18 @@ class RoutingApi {
|
|
|
53161
53369
|
/**
|
|
53162
53370
|
* Delete a phone number provisioned for SMS.
|
|
53163
53371
|
*
|
|
53164
|
-
* @param {String}
|
|
53372
|
+
* @param {String} phoneNumberId phone number
|
|
53165
53373
|
*/
|
|
53166
|
-
deleteRoutingSmsPhonenumber(
|
|
53167
|
-
// verify the required parameter '
|
|
53168
|
-
if (
|
|
53169
|
-
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';
|
|
53170
53378
|
}
|
|
53171
53379
|
|
|
53172
53380
|
return this.apiClient.callApi(
|
|
53173
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
53381
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
53174
53382
|
'DELETE',
|
|
53175
|
-
{ '
|
|
53383
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
53176
53384
|
{ },
|
|
53177
53385
|
{ },
|
|
53178
53386
|
{ },
|
|
@@ -53338,7 +53546,7 @@ class RoutingApi {
|
|
|
53338
53546
|
}
|
|
53339
53547
|
|
|
53340
53548
|
/**
|
|
53341
|
-
* Remove routing language from user
|
|
53549
|
+
* Remove a routing language from a user
|
|
53342
53550
|
*
|
|
53343
53551
|
* @param {String} userId User ID
|
|
53344
53552
|
* @param {String} languageId languageId
|
|
@@ -53368,7 +53576,7 @@ class RoutingApi {
|
|
|
53368
53576
|
}
|
|
53369
53577
|
|
|
53370
53578
|
/**
|
|
53371
|
-
* Remove routing skill from user
|
|
53579
|
+
* Remove a routing skill from a user
|
|
53372
53580
|
*
|
|
53373
53581
|
* @param {String} userId User ID
|
|
53374
53582
|
* @param {String} skillId skillId
|
|
@@ -54151,9 +54359,13 @@ class RoutingApi {
|
|
|
54151
54359
|
* Get Estimated Wait Time
|
|
54152
54360
|
*
|
|
54153
54361
|
* @param {String} queueId queueId
|
|
54154
|
-
* @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
|
|
54155
54365
|
*/
|
|
54156
|
-
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType) {
|
|
54366
|
+
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType, opts) {
|
|
54367
|
+
opts = opts || {};
|
|
54368
|
+
|
|
54157
54369
|
// verify the required parameter 'queueId' is set
|
|
54158
54370
|
if (queueId === undefined || queueId === null) {
|
|
54159
54371
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';
|
|
@@ -54167,7 +54379,7 @@ class RoutingApi {
|
|
|
54167
54379
|
'/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime',
|
|
54168
54380
|
'GET',
|
|
54169
54381
|
{ 'queueId': queueId,'mediaType': mediaType },
|
|
54170
|
-
{
|
|
54382
|
+
{ 'labelId': opts['labelId'] },
|
|
54171
54383
|
{ },
|
|
54172
54384
|
{ },
|
|
54173
54385
|
null,
|
|
@@ -54718,22 +54930,22 @@ class RoutingApi {
|
|
|
54718
54930
|
/**
|
|
54719
54931
|
* Get a phone number provisioned for SMS.
|
|
54720
54932
|
*
|
|
54721
|
-
* @param {String}
|
|
54933
|
+
* @param {String} phoneNumberId phone number
|
|
54722
54934
|
* @param {Object} opts Optional parameters
|
|
54723
54935
|
* @param {Object} opts.expand Expand response with additional information
|
|
54724
54936
|
*/
|
|
54725
|
-
getRoutingSmsPhonenumber(
|
|
54937
|
+
getRoutingSmsPhonenumber(phoneNumberId, opts) {
|
|
54726
54938
|
opts = opts || {};
|
|
54727
54939
|
|
|
54728
|
-
// verify the required parameter '
|
|
54729
|
-
if (
|
|
54730
|
-
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';
|
|
54731
54943
|
}
|
|
54732
54944
|
|
|
54733
54945
|
return this.apiClient.callApi(
|
|
54734
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
54946
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
54735
54947
|
'GET',
|
|
54736
|
-
{ '
|
|
54948
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
54737
54949
|
{ 'expand': opts['expand'] },
|
|
54738
54950
|
{ },
|
|
54739
54951
|
{ },
|
|
@@ -55147,7 +55359,7 @@ class RoutingApi {
|
|
|
55147
55359
|
}
|
|
55148
55360
|
|
|
55149
55361
|
/**
|
|
55150
|
-
* List routing
|
|
55362
|
+
* List routing languages assigned to a user
|
|
55151
55363
|
*
|
|
55152
55364
|
* @param {String} userId User ID
|
|
55153
55365
|
* @param {Object} opts Optional parameters
|
|
@@ -55178,7 +55390,7 @@ class RoutingApi {
|
|
|
55178
55390
|
}
|
|
55179
55391
|
|
|
55180
55392
|
/**
|
|
55181
|
-
* List routing skills
|
|
55393
|
+
* List routing skills assigned to a user
|
|
55182
55394
|
*
|
|
55183
55395
|
* @param {String} userId User ID
|
|
55184
55396
|
* @param {Object} opts Optional parameters
|
|
@@ -55640,7 +55852,7 @@ class RoutingApi {
|
|
|
55640
55852
|
}
|
|
55641
55853
|
|
|
55642
55854
|
/**
|
|
55643
|
-
* Update routing language proficiency
|
|
55855
|
+
* Update an assigned routing language's proficiency
|
|
55644
55856
|
*
|
|
55645
55857
|
* @param {String} userId User ID
|
|
55646
55858
|
* @param {String} languageId languageId
|
|
@@ -55675,7 +55887,7 @@ class RoutingApi {
|
|
|
55675
55887
|
}
|
|
55676
55888
|
|
|
55677
55889
|
/**
|
|
55678
|
-
*
|
|
55890
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
55679
55891
|
*
|
|
55680
55892
|
* @param {String} userId User ID
|
|
55681
55893
|
* @param {Array.<Object>} body Language
|
|
@@ -55705,7 +55917,7 @@ class RoutingApi {
|
|
|
55705
55917
|
}
|
|
55706
55918
|
|
|
55707
55919
|
/**
|
|
55708
|
-
*
|
|
55920
|
+
* Assign multiple routing skills to a user
|
|
55709
55921
|
*
|
|
55710
55922
|
* @param {String} userId User ID
|
|
55711
55923
|
* @param {Array.<Object>} body Skill
|
|
@@ -56401,7 +56613,7 @@ class RoutingApi {
|
|
|
56401
56613
|
}
|
|
56402
56614
|
|
|
56403
56615
|
/**
|
|
56404
|
-
*
|
|
56616
|
+
* Assign a routing language to a user
|
|
56405
56617
|
*
|
|
56406
56618
|
* @param {String} userId User ID
|
|
56407
56619
|
* @param {Object} body Language
|
|
@@ -56431,7 +56643,7 @@ class RoutingApi {
|
|
|
56431
56643
|
}
|
|
56432
56644
|
|
|
56433
56645
|
/**
|
|
56434
|
-
*
|
|
56646
|
+
* Assign a routing skill to a user
|
|
56435
56647
|
*
|
|
56436
56648
|
* @param {String} userId User ID
|
|
56437
56649
|
* @param {Object} body Skill
|
|
@@ -56658,13 +56870,13 @@ class RoutingApi {
|
|
|
56658
56870
|
/**
|
|
56659
56871
|
* Update a phone number provisioned for SMS.
|
|
56660
56872
|
*
|
|
56661
|
-
* @param {String}
|
|
56873
|
+
* @param {String} phoneNumberId phone number
|
|
56662
56874
|
* @param {Object} body SmsPhoneNumber
|
|
56663
56875
|
*/
|
|
56664
|
-
putRoutingSmsPhonenumber(
|
|
56665
|
-
// verify the required parameter '
|
|
56666
|
-
if (
|
|
56667
|
-
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';
|
|
56668
56880
|
}
|
|
56669
56881
|
// verify the required parameter 'body' is set
|
|
56670
56882
|
if (body === undefined || body === null) {
|
|
@@ -56672,9 +56884,9 @@ class RoutingApi {
|
|
|
56672
56884
|
}
|
|
56673
56885
|
|
|
56674
56886
|
return this.apiClient.callApi(
|
|
56675
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
56887
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
56676
56888
|
'PUT',
|
|
56677
|
-
{ '
|
|
56889
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
56678
56890
|
{ },
|
|
56679
56891
|
{ },
|
|
56680
56892
|
{ },
|
|
@@ -56831,7 +57043,7 @@ class RoutingApi {
|
|
|
56831
57043
|
}
|
|
56832
57044
|
|
|
56833
57045
|
/**
|
|
56834
|
-
* Update routing skill proficiency
|
|
57046
|
+
* Update an assigned routing skill's proficiency
|
|
56835
57047
|
*
|
|
56836
57048
|
* @param {String} userId User ID
|
|
56837
57049
|
* @param {String} skillId skillId
|
|
@@ -56866,7 +57078,7 @@ class RoutingApi {
|
|
|
56866
57078
|
}
|
|
56867
57079
|
|
|
56868
57080
|
/**
|
|
56869
|
-
*
|
|
57081
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
56870
57082
|
*
|
|
56871
57083
|
* @param {String} userId User ID
|
|
56872
57084
|
* @param {Array.<Object>} body Skill
|
|
@@ -56901,7 +57113,7 @@ class SCIMApi {
|
|
|
56901
57113
|
/**
|
|
56902
57114
|
* SCIM service.
|
|
56903
57115
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56904
|
-
* @version
|
|
57116
|
+
* @version 209.0.0
|
|
56905
57117
|
*/
|
|
56906
57118
|
|
|
56907
57119
|
/**
|
|
@@ -57778,7 +57990,7 @@ class ScreenRecordingApi {
|
|
|
57778
57990
|
/**
|
|
57779
57991
|
* ScreenRecording service.
|
|
57780
57992
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57781
|
-
* @version
|
|
57993
|
+
* @version 209.0.0
|
|
57782
57994
|
*/
|
|
57783
57995
|
|
|
57784
57996
|
/**
|
|
@@ -57823,7 +58035,7 @@ class ScriptsApi {
|
|
|
57823
58035
|
/**
|
|
57824
58036
|
* Scripts service.
|
|
57825
58037
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57826
|
-
* @version
|
|
58038
|
+
* @version 209.0.0
|
|
57827
58039
|
*/
|
|
57828
58040
|
|
|
57829
58041
|
/**
|
|
@@ -58267,7 +58479,7 @@ class SearchApi {
|
|
|
58267
58479
|
/**
|
|
58268
58480
|
* Search service.
|
|
58269
58481
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
58270
|
-
* @version
|
|
58482
|
+
* @version 209.0.0
|
|
58271
58483
|
*/
|
|
58272
58484
|
|
|
58273
58485
|
/**
|
|
@@ -58450,6 +58662,35 @@ class SearchApi {
|
|
|
58450
58662
|
);
|
|
58451
58663
|
}
|
|
58452
58664
|
|
|
58665
|
+
/**
|
|
58666
|
+
* Search sites using the q64 value returned from a previous search
|
|
58667
|
+
*
|
|
58668
|
+
* @param {String} q64 q64
|
|
58669
|
+
* @param {Object} opts Optional parameters
|
|
58670
|
+
* @param {Array.<String>} opts.expand expand
|
|
58671
|
+
*/
|
|
58672
|
+
getTelephonyProvidersEdgesSitesSearch(q64, opts) {
|
|
58673
|
+
opts = opts || {};
|
|
58674
|
+
|
|
58675
|
+
// verify the required parameter 'q64' is set
|
|
58676
|
+
if (q64 === undefined || q64 === null) {
|
|
58677
|
+
throw 'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';
|
|
58678
|
+
}
|
|
58679
|
+
|
|
58680
|
+
return this.apiClient.callApi(
|
|
58681
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
58682
|
+
'GET',
|
|
58683
|
+
{ },
|
|
58684
|
+
{ 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
58685
|
+
{ },
|
|
58686
|
+
{ },
|
|
58687
|
+
null,
|
|
58688
|
+
['PureCloud OAuth'],
|
|
58689
|
+
['application/json'],
|
|
58690
|
+
['application/json']
|
|
58691
|
+
);
|
|
58692
|
+
}
|
|
58693
|
+
|
|
58453
58694
|
/**
|
|
58454
58695
|
* Search users using the q64 value returned from a previous search
|
|
58455
58696
|
*
|
|
@@ -58823,6 +59064,31 @@ class SearchApi {
|
|
|
58823
59064
|
);
|
|
58824
59065
|
}
|
|
58825
59066
|
|
|
59067
|
+
/**
|
|
59068
|
+
* Search sites
|
|
59069
|
+
*
|
|
59070
|
+
* @param {Object} body Search request options
|
|
59071
|
+
*/
|
|
59072
|
+
postTelephonyProvidersEdgesSitesSearch(body) {
|
|
59073
|
+
// verify the required parameter 'body' is set
|
|
59074
|
+
if (body === undefined || body === null) {
|
|
59075
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';
|
|
59076
|
+
}
|
|
59077
|
+
|
|
59078
|
+
return this.apiClient.callApi(
|
|
59079
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
59080
|
+
'POST',
|
|
59081
|
+
{ },
|
|
59082
|
+
{ },
|
|
59083
|
+
{ },
|
|
59084
|
+
{ },
|
|
59085
|
+
body,
|
|
59086
|
+
['PureCloud OAuth'],
|
|
59087
|
+
['application/json'],
|
|
59088
|
+
['application/json']
|
|
59089
|
+
);
|
|
59090
|
+
}
|
|
59091
|
+
|
|
58826
59092
|
/**
|
|
58827
59093
|
* Search users
|
|
58828
59094
|
*
|
|
@@ -58956,7 +59222,7 @@ class SettingsApi {
|
|
|
58956
59222
|
/**
|
|
58957
59223
|
* Settings service.
|
|
58958
59224
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
58959
|
-
* @version
|
|
59225
|
+
* @version 209.0.0
|
|
58960
59226
|
*/
|
|
58961
59227
|
|
|
58962
59228
|
/**
|
|
@@ -59172,11 +59438,916 @@ class SettingsApi {
|
|
|
59172
59438
|
|
|
59173
59439
|
}
|
|
59174
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
|
+
|
|
59175
60346
|
class SpeechTextAnalyticsApi {
|
|
59176
60347
|
/**
|
|
59177
60348
|
* SpeechTextAnalytics service.
|
|
59178
60349
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
59179
|
-
* @version
|
|
60350
|
+
* @version 209.0.0
|
|
59180
60351
|
*/
|
|
59181
60352
|
|
|
59182
60353
|
/**
|
|
@@ -59995,13 +61166,13 @@ class SpeechTextAnalyticsApi {
|
|
|
59995
61166
|
}
|
|
59996
61167
|
|
|
59997
61168
|
/**
|
|
59998
|
-
* Translate
|
|
61169
|
+
* Translate a single interaction recording (or an email conversation)
|
|
59999
61170
|
*
|
|
60000
61171
|
* @param {String} languageId Target translation language
|
|
60001
61172
|
* @param {String} conversationId Conversation id
|
|
60002
61173
|
* @param {Object} opts Optional parameters
|
|
60003
|
-
* @param {String} opts.communicationId Communication id associated with the conversation
|
|
60004
|
-
* @param {String} opts.recordingId Recording id associated with the communication
|
|
61174
|
+
* @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
|
|
61175
|
+
* @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
|
|
60005
61176
|
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60006
61177
|
*/
|
|
60007
61178
|
getSpeechandtextanalyticsTranslationsLanguageConversation(languageId, conversationId, opts) {
|
|
@@ -60511,7 +61682,7 @@ class StationsApi {
|
|
|
60511
61682
|
/**
|
|
60512
61683
|
* Stations service.
|
|
60513
61684
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60514
|
-
* @version
|
|
61685
|
+
* @version 209.0.0
|
|
60515
61686
|
*/
|
|
60516
61687
|
|
|
60517
61688
|
/**
|
|
@@ -60613,7 +61784,7 @@ class SuggestApi {
|
|
|
60613
61784
|
/**
|
|
60614
61785
|
* Suggest service.
|
|
60615
61786
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60616
|
-
* @version
|
|
61787
|
+
* @version 209.0.0
|
|
60617
61788
|
*/
|
|
60618
61789
|
|
|
60619
61790
|
/**
|
|
@@ -60752,7 +61923,7 @@ class TaskManagementApi {
|
|
|
60752
61923
|
/**
|
|
60753
61924
|
* TaskManagement service.
|
|
60754
61925
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60755
|
-
* @version
|
|
61926
|
+
* @version 209.0.0
|
|
60756
61927
|
*/
|
|
60757
61928
|
|
|
60758
61929
|
/**
|
|
@@ -62416,7 +63587,7 @@ class TeamsApi {
|
|
|
62416
63587
|
/**
|
|
62417
63588
|
* Teams service.
|
|
62418
63589
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
62419
|
-
* @version
|
|
63590
|
+
* @version 209.0.0
|
|
62420
63591
|
*/
|
|
62421
63592
|
|
|
62422
63593
|
/**
|
|
@@ -62721,7 +63892,7 @@ class TelephonyApi {
|
|
|
62721
63892
|
/**
|
|
62722
63893
|
* Telephony service.
|
|
62723
63894
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62724
|
-
* @version
|
|
63895
|
+
* @version 209.0.0
|
|
62725
63896
|
*/
|
|
62726
63897
|
|
|
62727
63898
|
/**
|
|
@@ -62903,7 +64074,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
62903
64074
|
/**
|
|
62904
64075
|
* TelephonyProvidersEdge service.
|
|
62905
64076
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
62906
|
-
* @version
|
|
64077
|
+
* @version 209.0.0
|
|
62907
64078
|
*/
|
|
62908
64079
|
|
|
62909
64080
|
/**
|
|
@@ -64880,6 +66051,35 @@ class TelephonyProvidersEdgeApi {
|
|
|
64880
66051
|
);
|
|
64881
66052
|
}
|
|
64882
66053
|
|
|
66054
|
+
/**
|
|
66055
|
+
* Search sites using the q64 value returned from a previous search
|
|
66056
|
+
*
|
|
66057
|
+
* @param {String} q64 q64
|
|
66058
|
+
* @param {Object} opts Optional parameters
|
|
66059
|
+
* @param {Array.<String>} opts.expand expand
|
|
66060
|
+
*/
|
|
66061
|
+
getTelephonyProvidersEdgesSitesSearch(q64, opts) {
|
|
66062
|
+
opts = opts || {};
|
|
66063
|
+
|
|
66064
|
+
// verify the required parameter 'q64' is set
|
|
66065
|
+
if (q64 === undefined || q64 === null) {
|
|
66066
|
+
throw 'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';
|
|
66067
|
+
}
|
|
66068
|
+
|
|
66069
|
+
return this.apiClient.callApi(
|
|
66070
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
66071
|
+
'GET',
|
|
66072
|
+
{ },
|
|
66073
|
+
{ 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
66074
|
+
{ },
|
|
66075
|
+
{ },
|
|
66076
|
+
null,
|
|
66077
|
+
['PureCloud OAuth'],
|
|
66078
|
+
['application/json'],
|
|
66079
|
+
['application/json']
|
|
66080
|
+
);
|
|
66081
|
+
}
|
|
66082
|
+
|
|
64883
66083
|
/**
|
|
64884
66084
|
* Get a list of Edge-compatible time zones
|
|
64885
66085
|
*
|
|
@@ -65809,6 +67009,31 @@ class TelephonyProvidersEdgeApi {
|
|
|
65809
67009
|
);
|
|
65810
67010
|
}
|
|
65811
67011
|
|
|
67012
|
+
/**
|
|
67013
|
+
* Search sites
|
|
67014
|
+
*
|
|
67015
|
+
* @param {Object} body Search request options
|
|
67016
|
+
*/
|
|
67017
|
+
postTelephonyProvidersEdgesSitesSearch(body) {
|
|
67018
|
+
// verify the required parameter 'body' is set
|
|
67019
|
+
if (body === undefined || body === null) {
|
|
67020
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';
|
|
67021
|
+
}
|
|
67022
|
+
|
|
67023
|
+
return this.apiClient.callApi(
|
|
67024
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
67025
|
+
'POST',
|
|
67026
|
+
{ },
|
|
67027
|
+
{ },
|
|
67028
|
+
{ },
|
|
67029
|
+
{ },
|
|
67030
|
+
body,
|
|
67031
|
+
['PureCloud OAuth'],
|
|
67032
|
+
['application/json'],
|
|
67033
|
+
['application/json']
|
|
67034
|
+
);
|
|
67035
|
+
}
|
|
67036
|
+
|
|
65812
67037
|
/**
|
|
65813
67038
|
* Create a Trunk Base Settings object
|
|
65814
67039
|
*
|
|
@@ -66300,7 +67525,7 @@ class TextbotsApi {
|
|
|
66300
67525
|
/**
|
|
66301
67526
|
* Textbots service.
|
|
66302
67527
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
66303
|
-
* @version
|
|
67528
|
+
* @version 209.0.0
|
|
66304
67529
|
*/
|
|
66305
67530
|
|
|
66306
67531
|
/**
|
|
@@ -66428,7 +67653,7 @@ class TokensApi {
|
|
|
66428
67653
|
/**
|
|
66429
67654
|
* Tokens service.
|
|
66430
67655
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
66431
|
-
* @version
|
|
67656
|
+
* @version 209.0.0
|
|
66432
67657
|
*/
|
|
66433
67658
|
|
|
66434
67659
|
/**
|
|
@@ -66582,7 +67807,7 @@ class UploadsApi {
|
|
|
66582
67807
|
/**
|
|
66583
67808
|
* Uploads service.
|
|
66584
67809
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66585
|
-
* @version
|
|
67810
|
+
* @version 209.0.0
|
|
66586
67811
|
*/
|
|
66587
67812
|
|
|
66588
67813
|
/**
|
|
@@ -66851,7 +68076,7 @@ class UsageApi {
|
|
|
66851
68076
|
/**
|
|
66852
68077
|
* Usage service.
|
|
66853
68078
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
66854
|
-
* @version
|
|
68079
|
+
* @version 209.0.0
|
|
66855
68080
|
*/
|
|
66856
68081
|
|
|
66857
68082
|
/**
|
|
@@ -67066,7 +68291,7 @@ class UserRecordingsApi {
|
|
|
67066
68291
|
/**
|
|
67067
68292
|
* UserRecordings service.
|
|
67068
68293
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
67069
|
-
* @version
|
|
68294
|
+
* @version 209.0.0
|
|
67070
68295
|
*/
|
|
67071
68296
|
|
|
67072
68297
|
/**
|
|
@@ -67281,7 +68506,7 @@ class UsersApi {
|
|
|
67281
68506
|
/**
|
|
67282
68507
|
* Users service.
|
|
67283
68508
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
67284
|
-
* @version
|
|
68509
|
+
* @version 209.0.0
|
|
67285
68510
|
*/
|
|
67286
68511
|
|
|
67287
68512
|
/**
|
|
@@ -67452,7 +68677,7 @@ class UsersApi {
|
|
|
67452
68677
|
}
|
|
67453
68678
|
|
|
67454
68679
|
/**
|
|
67455
|
-
* Remove routing language from user
|
|
68680
|
+
* Remove a routing language from a user
|
|
67456
68681
|
*
|
|
67457
68682
|
* @param {String} userId User ID
|
|
67458
68683
|
* @param {String} languageId languageId
|
|
@@ -67482,7 +68707,7 @@ class UsersApi {
|
|
|
67482
68707
|
}
|
|
67483
68708
|
|
|
67484
68709
|
/**
|
|
67485
|
-
* Remove routing skill from user
|
|
68710
|
+
* Remove a routing skill from a user
|
|
67486
68711
|
*
|
|
67487
68712
|
* @param {String} userId User ID
|
|
67488
68713
|
* @param {String} skillId skillId
|
|
@@ -68314,7 +69539,7 @@ class UsersApi {
|
|
|
68314
69539
|
}
|
|
68315
69540
|
|
|
68316
69541
|
/**
|
|
68317
|
-
* List routing
|
|
69542
|
+
* List routing languages assigned to a user
|
|
68318
69543
|
*
|
|
68319
69544
|
* @param {String} userId User ID
|
|
68320
69545
|
* @param {Object} opts Optional parameters
|
|
@@ -68345,7 +69570,7 @@ class UsersApi {
|
|
|
68345
69570
|
}
|
|
68346
69571
|
|
|
68347
69572
|
/**
|
|
68348
|
-
* List routing skills
|
|
69573
|
+
* List routing skills assigned to a user
|
|
68349
69574
|
*
|
|
68350
69575
|
* @param {String} userId User ID
|
|
68351
69576
|
* @param {Object} opts Optional parameters
|
|
@@ -68941,7 +70166,7 @@ class UsersApi {
|
|
|
68941
70166
|
}
|
|
68942
70167
|
|
|
68943
70168
|
/**
|
|
68944
|
-
* Update routing language proficiency
|
|
70169
|
+
* Update an assigned routing language's proficiency
|
|
68945
70170
|
*
|
|
68946
70171
|
* @param {String} userId User ID
|
|
68947
70172
|
* @param {String} languageId languageId
|
|
@@ -68976,7 +70201,7 @@ class UsersApi {
|
|
|
68976
70201
|
}
|
|
68977
70202
|
|
|
68978
70203
|
/**
|
|
68979
|
-
*
|
|
70204
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
68980
70205
|
*
|
|
68981
70206
|
* @param {String} userId User ID
|
|
68982
70207
|
* @param {Array.<Object>} body Language
|
|
@@ -69006,7 +70231,7 @@ class UsersApi {
|
|
|
69006
70231
|
}
|
|
69007
70232
|
|
|
69008
70233
|
/**
|
|
69009
|
-
*
|
|
70234
|
+
* Assign multiple routing skills to a user
|
|
69010
70235
|
*
|
|
69011
70236
|
* @param {String} userId User ID
|
|
69012
70237
|
* @param {Array.<Object>} body Skill
|
|
@@ -69443,7 +70668,7 @@ class UsersApi {
|
|
|
69443
70668
|
}
|
|
69444
70669
|
|
|
69445
70670
|
/**
|
|
69446
|
-
*
|
|
70671
|
+
* Assign a routing language to a user
|
|
69447
70672
|
*
|
|
69448
70673
|
* @param {String} userId User ID
|
|
69449
70674
|
* @param {Object} body Language
|
|
@@ -69473,7 +70698,7 @@ class UsersApi {
|
|
|
69473
70698
|
}
|
|
69474
70699
|
|
|
69475
70700
|
/**
|
|
69476
|
-
*
|
|
70701
|
+
* Assign a routing skill to a user
|
|
69477
70702
|
*
|
|
69478
70703
|
* @param {String} userId User ID
|
|
69479
70704
|
* @param {Object} body Skill
|
|
@@ -69885,7 +71110,7 @@ class UsersApi {
|
|
|
69885
71110
|
}
|
|
69886
71111
|
|
|
69887
71112
|
/**
|
|
69888
|
-
* Update routing skill proficiency
|
|
71113
|
+
* Update an assigned routing skill's proficiency
|
|
69889
71114
|
*
|
|
69890
71115
|
* @param {String} userId User ID
|
|
69891
71116
|
* @param {String} skillId skillId
|
|
@@ -69920,7 +71145,7 @@ class UsersApi {
|
|
|
69920
71145
|
}
|
|
69921
71146
|
|
|
69922
71147
|
/**
|
|
69923
|
-
*
|
|
71148
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
69924
71149
|
*
|
|
69925
71150
|
* @param {String} userId User ID
|
|
69926
71151
|
* @param {Array.<Object>} body Skill
|
|
@@ -70110,7 +71335,7 @@ class UtilitiesApi {
|
|
|
70110
71335
|
/**
|
|
70111
71336
|
* Utilities service.
|
|
70112
71337
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
70113
|
-
* @version
|
|
71338
|
+
* @version 209.0.0
|
|
70114
71339
|
*/
|
|
70115
71340
|
|
|
70116
71341
|
/**
|
|
@@ -70221,7 +71446,7 @@ class VoicemailApi {
|
|
|
70221
71446
|
/**
|
|
70222
71447
|
* Voicemail service.
|
|
70223
71448
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
70224
|
-
* @version
|
|
71449
|
+
* @version 209.0.0
|
|
70225
71450
|
*/
|
|
70226
71451
|
|
|
70227
71452
|
/**
|
|
@@ -70943,7 +72168,7 @@ class WebChatApi {
|
|
|
70943
72168
|
/**
|
|
70944
72169
|
* WebChat service.
|
|
70945
72170
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
70946
|
-
* @version
|
|
72171
|
+
* @version 209.0.0
|
|
70947
72172
|
*/
|
|
70948
72173
|
|
|
70949
72174
|
/**
|
|
@@ -71494,7 +72719,7 @@ class WebDeploymentsApi {
|
|
|
71494
72719
|
/**
|
|
71495
72720
|
* WebDeployments service.
|
|
71496
72721
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
71497
|
-
* @version
|
|
72722
|
+
* @version 209.0.0
|
|
71498
72723
|
*/
|
|
71499
72724
|
|
|
71500
72725
|
/**
|
|
@@ -72021,7 +73246,7 @@ class WebMessagingApi {
|
|
|
72021
73246
|
/**
|
|
72022
73247
|
* WebMessaging service.
|
|
72023
73248
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
72024
|
-
* @version
|
|
73249
|
+
* @version 209.0.0
|
|
72025
73250
|
*/
|
|
72026
73251
|
|
|
72027
73252
|
/**
|
|
@@ -72067,7 +73292,7 @@ class WidgetsApi {
|
|
|
72067
73292
|
/**
|
|
72068
73293
|
* Widgets service.
|
|
72069
73294
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
72070
|
-
* @version
|
|
73295
|
+
* @version 209.0.0
|
|
72071
73296
|
*/
|
|
72072
73297
|
|
|
72073
73298
|
/**
|
|
@@ -72213,7 +73438,7 @@ class WorkforceManagementApi {
|
|
|
72213
73438
|
/**
|
|
72214
73439
|
* WorkforceManagement service.
|
|
72215
73440
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
72216
|
-
* @version
|
|
73441
|
+
* @version 209.0.0
|
|
72217
73442
|
*/
|
|
72218
73443
|
|
|
72219
73444
|
/**
|
|
@@ -75249,7 +76474,7 @@ class WorkforceManagementApi {
|
|
|
75249
76474
|
* Gets all the shift trades for a given week
|
|
75250
76475
|
*
|
|
75251
76476
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
75252
|
-
* @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
|
|
75253
76478
|
* @param {Object} opts Optional parameters
|
|
75254
76479
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
75255
76480
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -76475,7 +77700,7 @@ class WorkforceManagementApi {
|
|
|
76475
77700
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
76476
77701
|
*
|
|
76477
77702
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
76478
|
-
* @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
|
|
76479
77704
|
* @param {String} tradeId The ID of the shift trade to update
|
|
76480
77705
|
* @param {Object} body body
|
|
76481
77706
|
*/
|
|
@@ -78735,7 +79960,7 @@ class WorkforceManagementApi {
|
|
|
78735
79960
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
78736
79961
|
*
|
|
78737
79962
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78738
|
-
* @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
|
|
78739
79964
|
* @param {String} tradeId The ID of the shift trade to update
|
|
78740
79965
|
* @param {Object} body body
|
|
78741
79966
|
*/
|
|
@@ -78775,7 +80000,7 @@ class WorkforceManagementApi {
|
|
|
78775
80000
|
* Adds a shift trade
|
|
78776
80001
|
*
|
|
78777
80002
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78778
|
-
* @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
|
|
78779
80004
|
* @param {Object} body body
|
|
78780
80005
|
*/
|
|
78781
80006
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body) {
|
|
@@ -78810,7 +80035,7 @@ class WorkforceManagementApi {
|
|
|
78810
80035
|
* Searches for potential shift trade matches for the current agent
|
|
78811
80036
|
*
|
|
78812
80037
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78813
|
-
* @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
|
|
78814
80039
|
* @param {Object} body body
|
|
78815
80040
|
* @param {Object} opts Optional parameters
|
|
78816
80041
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -78849,7 +80074,7 @@ class WorkforceManagementApi {
|
|
|
78849
80074
|
* Updates the state of a batch of shift trades
|
|
78850
80075
|
* Admin functionality is not supported with "mine".
|
|
78851
80076
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78852
|
-
* @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
|
|
78853
80078
|
* @param {Object} body body
|
|
78854
80079
|
* @param {Object} opts Optional parameters
|
|
78855
80080
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -79427,7 +80652,7 @@ class WorkforceManagementApi {
|
|
|
79427
80652
|
* </pre>
|
|
79428
80653
|
* </p>
|
|
79429
80654
|
* @module purecloud-platform-client-v2/index
|
|
79430
|
-
* @version
|
|
80655
|
+
* @version 209.0.0
|
|
79431
80656
|
*/
|
|
79432
80657
|
class platformClient {
|
|
79433
80658
|
constructor() {
|
|
@@ -79731,6 +80956,11 @@ class platformClient {
|
|
|
79731
80956
|
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
79732
80957
|
*/
|
|
79733
80958
|
this.SettingsApi = SettingsApi;
|
|
80959
|
+
/**
|
|
80960
|
+
* The SocialMediaApi service constructor.
|
|
80961
|
+
* @property {module:purecloud-platform-client-v2/api/SocialMediaApi}
|
|
80962
|
+
*/
|
|
80963
|
+
this.SocialMediaApi = SocialMediaApi;
|
|
79734
80964
|
/**
|
|
79735
80965
|
* The SpeechTextAnalyticsApi service constructor.
|
|
79736
80966
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|