purecloud-platform-client-v2 208.0.0 → 209.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1088 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +1088 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +406 -134
- package/dist/web-cjs/purecloud-platform-client-v2.js +547 -209
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +3406 -2914
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +52 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +29 -25
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +910 -0
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -7
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -483,7 +483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
483
483
|
|
|
484
484
|
/**
|
|
485
485
|
* @module purecloud-platform-client-v2/ApiClient
|
|
486
|
-
* @version
|
|
486
|
+
* @version 209.0.0
|
|
487
487
|
*/
|
|
488
488
|
class ApiClient {
|
|
489
489
|
/**
|
|
@@ -1927,7 +1927,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1927
1927
|
/**
|
|
1928
1928
|
* AgentAssistants service.
|
|
1929
1929
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1930
|
-
* @version
|
|
1930
|
+
* @version 209.0.0
|
|
1931
1931
|
*/
|
|
1932
1932
|
|
|
1933
1933
|
/**
|
|
@@ -2303,7 +2303,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2303
2303
|
/**
|
|
2304
2304
|
* AgentCopilot service.
|
|
2305
2305
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2306
|
-
* @version
|
|
2306
|
+
* @version 209.0.0
|
|
2307
2307
|
*/
|
|
2308
2308
|
|
|
2309
2309
|
/**
|
|
@@ -2379,7 +2379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2379
2379
|
/**
|
|
2380
2380
|
* AgentUI service.
|
|
2381
2381
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2382
|
-
* @version
|
|
2382
|
+
* @version 209.0.0
|
|
2383
2383
|
*/
|
|
2384
2384
|
|
|
2385
2385
|
/**
|
|
@@ -2510,7 +2510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2510
2510
|
/**
|
|
2511
2511
|
* Alerting service.
|
|
2512
2512
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2513
|
-
* @version
|
|
2513
|
+
* @version 209.0.0
|
|
2514
2514
|
*/
|
|
2515
2515
|
|
|
2516
2516
|
/**
|
|
@@ -3171,7 +3171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3171
3171
|
/**
|
|
3172
3172
|
* Analytics service.
|
|
3173
3173
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3174
|
-
* @version
|
|
3174
|
+
* @version 209.0.0
|
|
3175
3175
|
*/
|
|
3176
3176
|
|
|
3177
3177
|
/**
|
|
@@ -3350,7 +3350,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3350
3350
|
|
|
3351
3351
|
/**
|
|
3352
3352
|
* Get Reporting Turns (division aware).
|
|
3353
|
-
* 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.
|
|
3353
|
+
* 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.
|
|
3354
3354
|
* @param {String} botFlowId ID of the bot flow.
|
|
3355
3355
|
* @param {Object} opts Optional parameters
|
|
3356
3356
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -3385,7 +3385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3385
3385
|
|
|
3386
3386
|
/**
|
|
3387
3387
|
* Get Reporting Turns.
|
|
3388
|
-
* 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.
|
|
3388
|
+
* 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.
|
|
3389
3389
|
* @param {String} botFlowId ID of the bot flow.
|
|
3390
3390
|
* @param {Object} opts Optional parameters
|
|
3391
3391
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -3421,7 +3421,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3421
3421
|
|
|
3422
3422
|
/**
|
|
3423
3423
|
* Get Bot Flow Sessions.
|
|
3424
|
-
* 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.
|
|
3424
|
+
* 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.
|
|
3425
3425
|
* @param {String} botFlowId ID of the bot flow.
|
|
3426
3426
|
* @param {Object} opts Optional parameters
|
|
3427
3427
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -5784,7 +5784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5784
5784
|
/**
|
|
5785
5785
|
* Architect service.
|
|
5786
5786
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5787
|
-
* @version
|
|
5787
|
+
* @version 209.0.0
|
|
5788
5788
|
*/
|
|
5789
5789
|
|
|
5790
5790
|
/**
|
|
@@ -9906,7 +9906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9906
9906
|
/**
|
|
9907
9907
|
* Audit service.
|
|
9908
9908
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9909
|
-
* @version
|
|
9909
|
+
* @version 209.0.0
|
|
9910
9910
|
*/
|
|
9911
9911
|
|
|
9912
9912
|
/**
|
|
@@ -10107,7 +10107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10107
10107
|
/**
|
|
10108
10108
|
* Authorization service.
|
|
10109
10109
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10110
|
-
* @version
|
|
10110
|
+
* @version 209.0.0
|
|
10111
10111
|
*/
|
|
10112
10112
|
|
|
10113
10113
|
/**
|
|
@@ -11390,7 +11390,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11390
11390
|
/**
|
|
11391
11391
|
* Billing service.
|
|
11392
11392
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11393
|
-
* @version
|
|
11393
|
+
* @version 209.0.0
|
|
11394
11394
|
*/
|
|
11395
11395
|
|
|
11396
11396
|
/**
|
|
@@ -11470,7 +11470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11470
11470
|
/**
|
|
11471
11471
|
* CarrierServices service.
|
|
11472
11472
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11473
|
-
* @version
|
|
11473
|
+
* @version 209.0.0
|
|
11474
11474
|
*/
|
|
11475
11475
|
|
|
11476
11476
|
/**
|
|
@@ -11540,7 +11540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11540
11540
|
/**
|
|
11541
11541
|
* Chat service.
|
|
11542
11542
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11543
|
-
* @version
|
|
11543
|
+
* @version 209.0.0
|
|
11544
11544
|
*/
|
|
11545
11545
|
|
|
11546
11546
|
/**
|
|
@@ -12476,7 +12476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12476
12476
|
/**
|
|
12477
12477
|
* Coaching service.
|
|
12478
12478
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12479
|
-
* @version
|
|
12479
|
+
* @version 209.0.0
|
|
12480
12480
|
*/
|
|
12481
12481
|
|
|
12482
12482
|
/**
|
|
@@ -13053,7 +13053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13053
13053
|
/**
|
|
13054
13054
|
* ContentManagement service.
|
|
13055
13055
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13056
|
-
* @version
|
|
13056
|
+
* @version 209.0.0
|
|
13057
13057
|
*/
|
|
13058
13058
|
|
|
13059
13059
|
/**
|
|
@@ -14134,7 +14134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14134
14134
|
/**
|
|
14135
14135
|
* Conversations service.
|
|
14136
14136
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14137
|
-
* @version
|
|
14137
|
+
* @version 209.0.0
|
|
14138
14138
|
*/
|
|
14139
14139
|
|
|
14140
14140
|
/**
|
|
@@ -14920,7 +14920,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14920
14920
|
* Get the summaries of the conversation.
|
|
14921
14921
|
*
|
|
14922
14922
|
* @param {String} conversationId Conversation ID
|
|
14923
|
-
* getConversationSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14924
14923
|
*/
|
|
14925
14924
|
getConversationSummaries(conversationId) {
|
|
14926
14925
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21276,7 +21275,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21276
21275
|
/**
|
|
21277
21276
|
* DataExtensions service.
|
|
21278
21277
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21279
|
-
* @version
|
|
21278
|
+
* @version 209.0.0
|
|
21280
21279
|
*/
|
|
21281
21280
|
|
|
21282
21281
|
/**
|
|
@@ -21362,7 +21361,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21362
21361
|
/**
|
|
21363
21362
|
* Downloads service.
|
|
21364
21363
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21365
|
-
* @version
|
|
21364
|
+
* @version 209.0.0
|
|
21366
21365
|
*/
|
|
21367
21366
|
|
|
21368
21367
|
/**
|
|
@@ -21414,7 +21413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21414
21413
|
/**
|
|
21415
21414
|
* Emails service.
|
|
21416
21415
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21417
|
-
* @version
|
|
21416
|
+
* @version 209.0.0
|
|
21418
21417
|
*/
|
|
21419
21418
|
|
|
21420
21419
|
/**
|
|
@@ -21479,7 +21478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21479
21478
|
/**
|
|
21480
21479
|
* EmployeeEngagement service.
|
|
21481
21480
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21482
|
-
* @version
|
|
21481
|
+
* @version 209.0.0
|
|
21483
21482
|
*/
|
|
21484
21483
|
|
|
21485
21484
|
/**
|
|
@@ -21630,7 +21629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21630
21629
|
/**
|
|
21631
21630
|
* Events service.
|
|
21632
21631
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21633
|
-
* @version
|
|
21632
|
+
* @version 209.0.0
|
|
21634
21633
|
*/
|
|
21635
21634
|
|
|
21636
21635
|
/**
|
|
@@ -21726,7 +21725,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21726
21725
|
/**
|
|
21727
21726
|
* ExternalContacts service.
|
|
21728
21727
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21729
|
-
* @version
|
|
21728
|
+
* @version 209.0.0
|
|
21730
21729
|
*/
|
|
21731
21730
|
|
|
21732
21731
|
/**
|
|
@@ -24051,7 +24050,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24051
24050
|
/**
|
|
24052
24051
|
* Fax service.
|
|
24053
24052
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24054
|
-
* @version
|
|
24053
|
+
* @version 209.0.0
|
|
24055
24054
|
*/
|
|
24056
24055
|
|
|
24057
24056
|
/**
|
|
@@ -24266,7 +24265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24266
24265
|
/**
|
|
24267
24266
|
* Flows service.
|
|
24268
24267
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
24269
|
-
* @version
|
|
24268
|
+
* @version 209.0.0
|
|
24270
24269
|
*/
|
|
24271
24270
|
|
|
24272
24271
|
/**
|
|
@@ -24449,7 +24448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24449
24448
|
/**
|
|
24450
24449
|
* Gamification service.
|
|
24451
24450
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24452
|
-
* @version
|
|
24451
|
+
* @version 209.0.0
|
|
24453
24452
|
*/
|
|
24454
24453
|
|
|
24455
24454
|
/**
|
|
@@ -26535,7 +26534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26535
26534
|
/**
|
|
26536
26535
|
* GeneralDataProtectionRegulation service.
|
|
26537
26536
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26538
|
-
* @version
|
|
26537
|
+
* @version 209.0.0
|
|
26539
26538
|
*/
|
|
26540
26539
|
|
|
26541
26540
|
/**
|
|
@@ -26665,7 +26664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26665
26664
|
/**
|
|
26666
26665
|
* Geolocation service.
|
|
26667
26666
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26668
|
-
* @version
|
|
26667
|
+
* @version 209.0.0
|
|
26669
26668
|
*/
|
|
26670
26669
|
|
|
26671
26670
|
/**
|
|
@@ -26796,7 +26795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26796
26795
|
/**
|
|
26797
26796
|
* Greetings service.
|
|
26798
26797
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26799
|
-
* @version
|
|
26798
|
+
* @version 209.0.0
|
|
26800
26799
|
*/
|
|
26801
26800
|
|
|
26802
26801
|
/**
|
|
@@ -27251,7 +27250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27251
27250
|
/**
|
|
27252
27251
|
* Groups service.
|
|
27253
27252
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27254
|
-
* @version
|
|
27253
|
+
* @version 209.0.0
|
|
27255
27254
|
*/
|
|
27256
27255
|
|
|
27257
27256
|
/**
|
|
@@ -27770,7 +27769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27770
27769
|
/**
|
|
27771
27770
|
* IdentityProvider service.
|
|
27772
27771
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27773
|
-
* @version
|
|
27772
|
+
* @version 209.0.0
|
|
27774
27773
|
*/
|
|
27775
27774
|
|
|
27776
27775
|
/**
|
|
@@ -28631,7 +28630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28631
28630
|
/**
|
|
28632
28631
|
* InfrastructureAsCode service.
|
|
28633
28632
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28634
|
-
* @version
|
|
28633
|
+
* @version 209.0.0
|
|
28635
28634
|
*/
|
|
28636
28635
|
|
|
28637
28636
|
/**
|
|
@@ -28798,7 +28797,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28798
28797
|
/**
|
|
28799
28798
|
* Integrations service.
|
|
28800
28799
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28801
|
-
* @version
|
|
28800
|
+
* @version 209.0.0
|
|
28802
28801
|
*/
|
|
28803
28802
|
|
|
28804
28803
|
/**
|
|
@@ -31240,7 +31239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31240
31239
|
/**
|
|
31241
31240
|
* Journey service.
|
|
31242
31241
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31243
|
-
* @version
|
|
31242
|
+
* @version 209.0.0
|
|
31244
31243
|
*/
|
|
31245
31244
|
|
|
31246
31245
|
/**
|
|
@@ -33205,7 +33204,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33205
33204
|
/**
|
|
33206
33205
|
* Knowledge service.
|
|
33207
33206
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
33208
|
-
* @version
|
|
33207
|
+
* @version 209.0.0
|
|
33209
33208
|
*/
|
|
33210
33209
|
|
|
33211
33210
|
/**
|
|
@@ -33729,8 +33728,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33729
33728
|
* Get sync options available for a knowledge-connect integration
|
|
33730
33729
|
*
|
|
33731
33730
|
* @param {String} integrationId Integration ID
|
|
33731
|
+
* @param {Object} opts Optional parameters
|
|
33732
|
+
* @param {Array.<String>} opts.knowledgeBaseIds Narrowing down filtering option results by knowledge base.
|
|
33732
33733
|
*/
|
|
33733
|
-
getKnowledgeIntegrationOptions(integrationId) {
|
|
33734
|
+
getKnowledgeIntegrationOptions(integrationId, opts) {
|
|
33735
|
+
opts = opts || {};
|
|
33736
|
+
|
|
33734
33737
|
// verify the required parameter 'integrationId' is set
|
|
33735
33738
|
if (integrationId === undefined || integrationId === null) {
|
|
33736
33739
|
throw 'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';
|
|
@@ -33740,7 +33743,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33740
33743
|
'/api/v2/knowledge/integrations/{integrationId}/options',
|
|
33741
33744
|
'GET',
|
|
33742
33745
|
{ 'integrationId': integrationId },
|
|
33743
|
-
{
|
|
33746
|
+
{ 'knowledgeBaseIds': this.apiClient.buildCollectionParam(opts['knowledgeBaseIds'], 'multi') },
|
|
33744
33747
|
{ },
|
|
33745
33748
|
{ },
|
|
33746
33749
|
null,
|
|
@@ -37077,7 +37080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37077
37080
|
/**
|
|
37078
37081
|
* LanguageUnderstanding service.
|
|
37079
37082
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
37080
|
-
* @version
|
|
37083
|
+
* @version 209.0.0
|
|
37081
37084
|
*/
|
|
37082
37085
|
|
|
37083
37086
|
/**
|
|
@@ -38111,7 +38114,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38111
38114
|
/**
|
|
38112
38115
|
* Languages service.
|
|
38113
38116
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
38114
|
-
* @version
|
|
38117
|
+
* @version 209.0.0
|
|
38115
38118
|
*/
|
|
38116
38119
|
|
|
38117
38120
|
/**
|
|
@@ -38333,7 +38336,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38333
38336
|
/**
|
|
38334
38337
|
* Learning service.
|
|
38335
38338
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
38336
|
-
* @version
|
|
38339
|
+
* @version 209.0.0
|
|
38337
38340
|
*/
|
|
38338
38341
|
|
|
38339
38342
|
/**
|
|
@@ -39362,7 +39365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39362
39365
|
/**
|
|
39363
39366
|
* License service.
|
|
39364
39367
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
39365
|
-
* @version
|
|
39368
|
+
* @version 209.0.0
|
|
39366
39369
|
*/
|
|
39367
39370
|
|
|
39368
39371
|
/**
|
|
@@ -39600,7 +39603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39600
39603
|
/**
|
|
39601
39604
|
* Locations service.
|
|
39602
39605
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39603
|
-
* @version
|
|
39606
|
+
* @version 209.0.0
|
|
39604
39607
|
*/
|
|
39605
39608
|
|
|
39606
39609
|
/**
|
|
@@ -39836,7 +39839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39836
39839
|
/**
|
|
39837
39840
|
* LogCapture service.
|
|
39838
39841
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39839
|
-
* @version
|
|
39842
|
+
* @version 209.0.0
|
|
39840
39843
|
*/
|
|
39841
39844
|
|
|
39842
39845
|
/**
|
|
@@ -40036,7 +40039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40036
40039
|
/**
|
|
40037
40040
|
* Messaging service.
|
|
40038
40041
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40039
|
-
* @version
|
|
40042
|
+
* @version 209.0.0
|
|
40040
40043
|
*/
|
|
40041
40044
|
|
|
40042
40045
|
/**
|
|
@@ -40395,7 +40398,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40395
40398
|
/**
|
|
40396
40399
|
* MobileDevices service.
|
|
40397
40400
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
40398
|
-
* @version
|
|
40401
|
+
* @version 209.0.0
|
|
40399
40402
|
*/
|
|
40400
40403
|
|
|
40401
40404
|
/**
|
|
@@ -40546,7 +40549,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40546
40549
|
/**
|
|
40547
40550
|
* Notifications service.
|
|
40548
40551
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40549
|
-
* @version
|
|
40552
|
+
* @version 209.0.0
|
|
40550
40553
|
*/
|
|
40551
40554
|
|
|
40552
40555
|
/**
|
|
@@ -40779,7 +40782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40779
40782
|
/**
|
|
40780
40783
|
* OAuth service.
|
|
40781
40784
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40782
|
-
* @version
|
|
40785
|
+
* @version 209.0.0
|
|
40783
40786
|
*/
|
|
40784
40787
|
|
|
40785
40788
|
/**
|
|
@@ -41145,7 +41148,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41145
41148
|
/**
|
|
41146
41149
|
* Objects service.
|
|
41147
41150
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
41148
|
-
* @version
|
|
41151
|
+
* @version 209.0.0
|
|
41149
41152
|
*/
|
|
41150
41153
|
|
|
41151
41154
|
/**
|
|
@@ -41415,7 +41418,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41415
41418
|
/**
|
|
41416
41419
|
* OperationalEvents service.
|
|
41417
41420
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
41418
|
-
* @version
|
|
41421
|
+
* @version 209.0.0
|
|
41419
41422
|
*/
|
|
41420
41423
|
|
|
41421
41424
|
/**
|
|
@@ -41475,13 +41478,64 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41475
41478
|
);
|
|
41476
41479
|
}
|
|
41477
41480
|
|
|
41481
|
+
/**
|
|
41482
|
+
* Get aggregates for operational events in a timeframe.
|
|
41483
|
+
*
|
|
41484
|
+
* @param {Object} opts Optional parameters
|
|
41485
|
+
* @param {Object} opts.body
|
|
41486
|
+
*/
|
|
41487
|
+
postUsageEventsAggregatesQuery(opts) {
|
|
41488
|
+
opts = opts || {};
|
|
41489
|
+
|
|
41490
|
+
|
|
41491
|
+
return this.apiClient.callApi(
|
|
41492
|
+
'/api/v2/usage/events/aggregates/query',
|
|
41493
|
+
'POST',
|
|
41494
|
+
{ },
|
|
41495
|
+
{ },
|
|
41496
|
+
{ },
|
|
41497
|
+
{ },
|
|
41498
|
+
opts['body'],
|
|
41499
|
+
['PureCloud OAuth'],
|
|
41500
|
+
['application/json'],
|
|
41501
|
+
['application/json']
|
|
41502
|
+
);
|
|
41503
|
+
}
|
|
41504
|
+
|
|
41505
|
+
/**
|
|
41506
|
+
* Query operational events in a timeframe.
|
|
41507
|
+
*
|
|
41508
|
+
* @param {Object} opts Optional parameters
|
|
41509
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41510
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41511
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41512
|
+
* @param {Object} opts.body
|
|
41513
|
+
*/
|
|
41514
|
+
postUsageEventsQuery(opts) {
|
|
41515
|
+
opts = opts || {};
|
|
41516
|
+
|
|
41517
|
+
|
|
41518
|
+
return this.apiClient.callApi(
|
|
41519
|
+
'/api/v2/usage/events/query',
|
|
41520
|
+
'POST',
|
|
41521
|
+
{ },
|
|
41522
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
41523
|
+
{ },
|
|
41524
|
+
{ },
|
|
41525
|
+
opts['body'],
|
|
41526
|
+
['PureCloud OAuth'],
|
|
41527
|
+
['application/json'],
|
|
41528
|
+
['application/json']
|
|
41529
|
+
);
|
|
41530
|
+
}
|
|
41531
|
+
|
|
41478
41532
|
}
|
|
41479
41533
|
|
|
41480
41534
|
class OrganizationApi {
|
|
41481
41535
|
/**
|
|
41482
41536
|
* Organization service.
|
|
41483
41537
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41484
|
-
* @version
|
|
41538
|
+
* @version 209.0.0
|
|
41485
41539
|
*/
|
|
41486
41540
|
|
|
41487
41541
|
/**
|
|
@@ -42023,7 +42077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42023
42077
|
/**
|
|
42024
42078
|
* OrganizationAuthorization service.
|
|
42025
42079
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42026
|
-
* @version
|
|
42080
|
+
* @version 209.0.0
|
|
42027
42081
|
*/
|
|
42028
42082
|
|
|
42029
42083
|
/**
|
|
@@ -43417,7 +43471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43417
43471
|
/**
|
|
43418
43472
|
* Outbound service.
|
|
43419
43473
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
43420
|
-
* @version
|
|
43474
|
+
* @version 209.0.0
|
|
43421
43475
|
*/
|
|
43422
43476
|
|
|
43423
43477
|
/**
|
|
@@ -47964,7 +48018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47964
48018
|
/**
|
|
47965
48019
|
* Presence service.
|
|
47966
48020
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47967
|
-
* @version
|
|
48021
|
+
* @version 209.0.0
|
|
47968
48022
|
*/
|
|
47969
48023
|
|
|
47970
48024
|
/**
|
|
@@ -48708,7 +48762,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48708
48762
|
/**
|
|
48709
48763
|
* ProcessAutomation service.
|
|
48710
48764
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48711
|
-
* @version
|
|
48765
|
+
* @version 209.0.0
|
|
48712
48766
|
*/
|
|
48713
48767
|
|
|
48714
48768
|
/**
|
|
@@ -48947,7 +49001,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48947
49001
|
/**
|
|
48948
49002
|
* Quality service.
|
|
48949
49003
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48950
|
-
* @version
|
|
49004
|
+
* @version 209.0.0
|
|
48951
49005
|
*/
|
|
48952
49006
|
|
|
48953
49007
|
/**
|
|
@@ -49232,6 +49286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49232
49286
|
* @param {String} opts.group group id
|
|
49233
49287
|
* @param {String} opts.agentTeamId team id of agents requested
|
|
49234
49288
|
* @param {String} opts.formContextId shared id between form versions
|
|
49289
|
+
* @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)
|
|
49235
49290
|
*/
|
|
49236
49291
|
getQualityAgentsActivity(opts) {
|
|
49237
49292
|
opts = opts || {};
|
|
@@ -49241,7 +49296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49241
49296
|
'/api/v2/quality/agents/activity',
|
|
49242
49297
|
'GET',
|
|
49243
49298
|
{ },
|
|
49244
|
-
{ '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'] },
|
|
49299
|
+
{ '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'] },
|
|
49245
49300
|
{ },
|
|
49246
49301
|
{ },
|
|
49247
49302
|
null,
|
|
@@ -49456,6 +49511,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49456
49511
|
* @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.
|
|
49457
49512
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
49458
49513
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
49514
|
+
* @param {Boolean} opts.includeDeletedUsers Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (default to false)
|
|
49459
49515
|
*/
|
|
49460
49516
|
getQualityEvaluationsQuery(opts) {
|
|
49461
49517
|
opts = opts || {};
|
|
@@ -49465,7 +49521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49465
49521
|
'/api/v2/quality/evaluations/query',
|
|
49466
49522
|
'GET',
|
|
49467
49523
|
{ },
|
|
49468
|
-
{ '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'] },
|
|
49524
|
+
{ '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'] },
|
|
49469
49525
|
{ },
|
|
49470
49526
|
{ },
|
|
49471
49527
|
null,
|
|
@@ -50733,7 +50789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50733
50789
|
/**
|
|
50734
50790
|
* Recording service.
|
|
50735
50791
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50736
|
-
* @version
|
|
50792
|
+
* @version 209.0.0
|
|
50737
50793
|
*/
|
|
50738
50794
|
|
|
50739
50795
|
/**
|
|
@@ -52392,7 +52448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52392
52448
|
/**
|
|
52393
52449
|
* ResponseManagement service.
|
|
52394
52450
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
52395
|
-
* @version
|
|
52451
|
+
* @version 209.0.0
|
|
52396
52452
|
*/
|
|
52397
52453
|
|
|
52398
52454
|
/**
|
|
@@ -52902,7 +52958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52902
52958
|
/**
|
|
52903
52959
|
* Routing service.
|
|
52904
52960
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52905
|
-
* @version
|
|
52961
|
+
* @version 209.0.0
|
|
52906
52962
|
*/
|
|
52907
52963
|
|
|
52908
52964
|
/**
|
|
@@ -53310,18 +53366,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53310
53366
|
/**
|
|
53311
53367
|
* Delete a phone number provisioned for SMS.
|
|
53312
53368
|
*
|
|
53313
|
-
* @param {String}
|
|
53369
|
+
* @param {String} phoneNumberId phone number
|
|
53314
53370
|
*/
|
|
53315
|
-
deleteRoutingSmsPhonenumber(
|
|
53316
|
-
// verify the required parameter '
|
|
53317
|
-
if (
|
|
53318
|
-
throw 'Missing the required parameter "
|
|
53371
|
+
deleteRoutingSmsPhonenumber(phoneNumberId) {
|
|
53372
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
53373
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
53374
|
+
throw 'Missing the required parameter "phoneNumberId" when calling deleteRoutingSmsPhonenumber';
|
|
53319
53375
|
}
|
|
53320
53376
|
|
|
53321
53377
|
return this.apiClient.callApi(
|
|
53322
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
53378
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
53323
53379
|
'DELETE',
|
|
53324
|
-
{ '
|
|
53380
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
53325
53381
|
{ },
|
|
53326
53382
|
{ },
|
|
53327
53383
|
{ },
|
|
@@ -54300,9 +54356,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54300
54356
|
* Get Estimated Wait Time
|
|
54301
54357
|
*
|
|
54302
54358
|
* @param {String} queueId queueId
|
|
54303
|
-
* @param {
|
|
54359
|
+
* @param {Object} mediaType mediaType
|
|
54360
|
+
* @param {Object} opts Optional parameters
|
|
54361
|
+
* @param {String} opts.labelId Unique id that represents the interaction label used with media type for EWT calculation
|
|
54304
54362
|
*/
|
|
54305
|
-
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType) {
|
|
54363
|
+
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType, opts) {
|
|
54364
|
+
opts = opts || {};
|
|
54365
|
+
|
|
54306
54366
|
// verify the required parameter 'queueId' is set
|
|
54307
54367
|
if (queueId === undefined || queueId === null) {
|
|
54308
54368
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';
|
|
@@ -54316,7 +54376,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54316
54376
|
'/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime',
|
|
54317
54377
|
'GET',
|
|
54318
54378
|
{ 'queueId': queueId,'mediaType': mediaType },
|
|
54319
|
-
{
|
|
54379
|
+
{ 'labelId': opts['labelId'] },
|
|
54320
54380
|
{ },
|
|
54321
54381
|
{ },
|
|
54322
54382
|
null,
|
|
@@ -54867,22 +54927,22 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54867
54927
|
/**
|
|
54868
54928
|
* Get a phone number provisioned for SMS.
|
|
54869
54929
|
*
|
|
54870
|
-
* @param {String}
|
|
54930
|
+
* @param {String} phoneNumberId phone number
|
|
54871
54931
|
* @param {Object} opts Optional parameters
|
|
54872
54932
|
* @param {Object} opts.expand Expand response with additional information
|
|
54873
54933
|
*/
|
|
54874
|
-
getRoutingSmsPhonenumber(
|
|
54934
|
+
getRoutingSmsPhonenumber(phoneNumberId, opts) {
|
|
54875
54935
|
opts = opts || {};
|
|
54876
54936
|
|
|
54877
|
-
// verify the required parameter '
|
|
54878
|
-
if (
|
|
54879
|
-
throw 'Missing the required parameter "
|
|
54937
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
54938
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
54939
|
+
throw 'Missing the required parameter "phoneNumberId" when calling getRoutingSmsPhonenumber';
|
|
54880
54940
|
}
|
|
54881
54941
|
|
|
54882
54942
|
return this.apiClient.callApi(
|
|
54883
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
54943
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
54884
54944
|
'GET',
|
|
54885
|
-
{ '
|
|
54945
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
54886
54946
|
{ 'expand': opts['expand'] },
|
|
54887
54947
|
{ },
|
|
54888
54948
|
{ },
|
|
@@ -56807,13 +56867,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56807
56867
|
/**
|
|
56808
56868
|
* Update a phone number provisioned for SMS.
|
|
56809
56869
|
*
|
|
56810
|
-
* @param {String}
|
|
56870
|
+
* @param {String} phoneNumberId phone number
|
|
56811
56871
|
* @param {Object} body SmsPhoneNumber
|
|
56812
56872
|
*/
|
|
56813
|
-
putRoutingSmsPhonenumber(
|
|
56814
|
-
// verify the required parameter '
|
|
56815
|
-
if (
|
|
56816
|
-
throw 'Missing the required parameter "
|
|
56873
|
+
putRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
56874
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
56875
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
56876
|
+
throw 'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';
|
|
56817
56877
|
}
|
|
56818
56878
|
// verify the required parameter 'body' is set
|
|
56819
56879
|
if (body === undefined || body === null) {
|
|
@@ -56821,9 +56881,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56821
56881
|
}
|
|
56822
56882
|
|
|
56823
56883
|
return this.apiClient.callApi(
|
|
56824
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
56884
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
56825
56885
|
'PUT',
|
|
56826
|
-
{ '
|
|
56886
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
56827
56887
|
{ },
|
|
56828
56888
|
{ },
|
|
56829
56889
|
{ },
|
|
@@ -57050,7 +57110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57050
57110
|
/**
|
|
57051
57111
|
* SCIM service.
|
|
57052
57112
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
57053
|
-
* @version
|
|
57113
|
+
* @version 209.0.0
|
|
57054
57114
|
*/
|
|
57055
57115
|
|
|
57056
57116
|
/**
|
|
@@ -57927,7 +57987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57927
57987
|
/**
|
|
57928
57988
|
* ScreenRecording service.
|
|
57929
57989
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57930
|
-
* @version
|
|
57990
|
+
* @version 209.0.0
|
|
57931
57991
|
*/
|
|
57932
57992
|
|
|
57933
57993
|
/**
|
|
@@ -57972,7 +58032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57972
58032
|
/**
|
|
57973
58033
|
* Scripts service.
|
|
57974
58034
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57975
|
-
* @version
|
|
58035
|
+
* @version 209.0.0
|
|
57976
58036
|
*/
|
|
57977
58037
|
|
|
57978
58038
|
/**
|
|
@@ -58416,7 +58476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58416
58476
|
/**
|
|
58417
58477
|
* Search service.
|
|
58418
58478
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
58419
|
-
* @version
|
|
58479
|
+
* @version 209.0.0
|
|
58420
58480
|
*/
|
|
58421
58481
|
|
|
58422
58482
|
/**
|
|
@@ -59159,7 +59219,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59159
59219
|
/**
|
|
59160
59220
|
* Settings service.
|
|
59161
59221
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
59162
|
-
* @version
|
|
59222
|
+
* @version 209.0.0
|
|
59163
59223
|
*/
|
|
59164
59224
|
|
|
59165
59225
|
/**
|
|
@@ -59375,11 +59435,916 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59375
59435
|
|
|
59376
59436
|
}
|
|
59377
59437
|
|
|
59438
|
+
class SocialMediaApi {
|
|
59439
|
+
/**
|
|
59440
|
+
* SocialMedia service.
|
|
59441
|
+
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
59442
|
+
* @version 209.0.0
|
|
59443
|
+
*/
|
|
59444
|
+
|
|
59445
|
+
/**
|
|
59446
|
+
* Constructs a new SocialMediaApi.
|
|
59447
|
+
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
59448
|
+
* @class
|
|
59449
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
59450
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
59451
|
+
*/
|
|
59452
|
+
constructor(apiClient) {
|
|
59453
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
59454
|
+
}
|
|
59455
|
+
|
|
59456
|
+
|
|
59457
|
+
/**
|
|
59458
|
+
* Delete a social topic.
|
|
59459
|
+
*
|
|
59460
|
+
* @param {String} topicId topicId
|
|
59461
|
+
* @param {Object} opts Optional parameters
|
|
59462
|
+
* @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.
|
|
59463
|
+
* deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59464
|
+
*/
|
|
59465
|
+
deleteSocialmediaTopic(topicId, opts) {
|
|
59466
|
+
opts = opts || {};
|
|
59467
|
+
|
|
59468
|
+
// verify the required parameter 'topicId' is set
|
|
59469
|
+
if (topicId === undefined || topicId === null) {
|
|
59470
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopic';
|
|
59471
|
+
}
|
|
59472
|
+
|
|
59473
|
+
return this.apiClient.callApi(
|
|
59474
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
59475
|
+
'DELETE',
|
|
59476
|
+
{ 'topicId': topicId },
|
|
59477
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59478
|
+
{ },
|
|
59479
|
+
{ },
|
|
59480
|
+
null,
|
|
59481
|
+
['PureCloud OAuth'],
|
|
59482
|
+
['application/json'],
|
|
59483
|
+
['application/json']
|
|
59484
|
+
);
|
|
59485
|
+
}
|
|
59486
|
+
|
|
59487
|
+
/**
|
|
59488
|
+
* Delete a Facebook data ingestion rule.
|
|
59489
|
+
*
|
|
59490
|
+
* @param {String} topicId topicId
|
|
59491
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59492
|
+
* @param {Object} opts Optional parameters
|
|
59493
|
+
* @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)
|
|
59494
|
+
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59495
|
+
*/
|
|
59496
|
+
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
59497
|
+
opts = opts || {};
|
|
59498
|
+
|
|
59499
|
+
// verify the required parameter 'topicId' is set
|
|
59500
|
+
if (topicId === undefined || topicId === null) {
|
|
59501
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59502
|
+
}
|
|
59503
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59504
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59505
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59506
|
+
}
|
|
59507
|
+
|
|
59508
|
+
return this.apiClient.callApi(
|
|
59509
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
59510
|
+
'DELETE',
|
|
59511
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59512
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59513
|
+
{ },
|
|
59514
|
+
{ },
|
|
59515
|
+
null,
|
|
59516
|
+
['PureCloud OAuth'],
|
|
59517
|
+
['application/json'],
|
|
59518
|
+
['application/json']
|
|
59519
|
+
);
|
|
59520
|
+
}
|
|
59521
|
+
|
|
59522
|
+
/**
|
|
59523
|
+
* Delete a open data ingestion rule.
|
|
59524
|
+
*
|
|
59525
|
+
* @param {String} topicId topicId
|
|
59526
|
+
* @param {String} openId openId
|
|
59527
|
+
* @param {Object} opts Optional parameters
|
|
59528
|
+
* @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)
|
|
59529
|
+
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59530
|
+
*/
|
|
59531
|
+
deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
59532
|
+
opts = opts || {};
|
|
59533
|
+
|
|
59534
|
+
// verify the required parameter 'topicId' is set
|
|
59535
|
+
if (topicId === undefined || topicId === null) {
|
|
59536
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59537
|
+
}
|
|
59538
|
+
// verify the required parameter 'openId' is set
|
|
59539
|
+
if (openId === undefined || openId === null) {
|
|
59540
|
+
throw 'Missing the required parameter "openId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59541
|
+
}
|
|
59542
|
+
|
|
59543
|
+
return this.apiClient.callApi(
|
|
59544
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
59545
|
+
'DELETE',
|
|
59546
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59547
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59548
|
+
{ },
|
|
59549
|
+
{ },
|
|
59550
|
+
null,
|
|
59551
|
+
['PureCloud OAuth'],
|
|
59552
|
+
['application/json'],
|
|
59553
|
+
['application/json']
|
|
59554
|
+
);
|
|
59555
|
+
}
|
|
59556
|
+
|
|
59557
|
+
/**
|
|
59558
|
+
* Delete a X (formally Twitter) data ingestion rule.
|
|
59559
|
+
*
|
|
59560
|
+
* @param {String} topicId topicId
|
|
59561
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59562
|
+
* @param {Object} opts Optional parameters
|
|
59563
|
+
* @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)
|
|
59564
|
+
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59565
|
+
*/
|
|
59566
|
+
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
59567
|
+
opts = opts || {};
|
|
59568
|
+
|
|
59569
|
+
// verify the required parameter 'topicId' is set
|
|
59570
|
+
if (topicId === undefined || topicId === null) {
|
|
59571
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59572
|
+
}
|
|
59573
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59574
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59575
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59576
|
+
}
|
|
59577
|
+
|
|
59578
|
+
return this.apiClient.callApi(
|
|
59579
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
59580
|
+
'DELETE',
|
|
59581
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59582
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59583
|
+
{ },
|
|
59584
|
+
{ },
|
|
59585
|
+
null,
|
|
59586
|
+
['PureCloud OAuth'],
|
|
59587
|
+
['application/json'],
|
|
59588
|
+
['application/json']
|
|
59589
|
+
);
|
|
59590
|
+
}
|
|
59591
|
+
|
|
59592
|
+
/**
|
|
59593
|
+
* Get a single social topic.
|
|
59594
|
+
*
|
|
59595
|
+
* @param {String} topicId topicId
|
|
59596
|
+
* @param {Object} opts Optional parameters
|
|
59597
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59598
|
+
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59599
|
+
*/
|
|
59600
|
+
getSocialmediaTopic(topicId, opts) {
|
|
59601
|
+
opts = opts || {};
|
|
59602
|
+
|
|
59603
|
+
// verify the required parameter 'topicId' is set
|
|
59604
|
+
if (topicId === undefined || topicId === null) {
|
|
59605
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopic';
|
|
59606
|
+
}
|
|
59607
|
+
|
|
59608
|
+
return this.apiClient.callApi(
|
|
59609
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
59610
|
+
'GET',
|
|
59611
|
+
{ 'topicId': topicId },
|
|
59612
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59613
|
+
{ },
|
|
59614
|
+
{ },
|
|
59615
|
+
null,
|
|
59616
|
+
['PureCloud OAuth'],
|
|
59617
|
+
['application/json'],
|
|
59618
|
+
['application/json']
|
|
59619
|
+
);
|
|
59620
|
+
}
|
|
59621
|
+
|
|
59622
|
+
/**
|
|
59623
|
+
* Get a single Facebook data ingestion rule.
|
|
59624
|
+
*
|
|
59625
|
+
* @param {String} topicId topicId
|
|
59626
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59627
|
+
* @param {Object} opts Optional parameters
|
|
59628
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59629
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59630
|
+
*/
|
|
59631
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
59632
|
+
opts = opts || {};
|
|
59633
|
+
|
|
59634
|
+
// verify the required parameter 'topicId' is set
|
|
59635
|
+
if (topicId === undefined || topicId === null) {
|
|
59636
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59637
|
+
}
|
|
59638
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59639
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59640
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59641
|
+
}
|
|
59642
|
+
|
|
59643
|
+
return this.apiClient.callApi(
|
|
59644
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
59645
|
+
'GET',
|
|
59646
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59647
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59648
|
+
{ },
|
|
59649
|
+
{ },
|
|
59650
|
+
null,
|
|
59651
|
+
['PureCloud OAuth'],
|
|
59652
|
+
['application/json'],
|
|
59653
|
+
['application/json']
|
|
59654
|
+
);
|
|
59655
|
+
}
|
|
59656
|
+
|
|
59657
|
+
/**
|
|
59658
|
+
* Get a single Facebook data ingestion rule version.
|
|
59659
|
+
*
|
|
59660
|
+
* @param {String} topicId topicId
|
|
59661
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59662
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59663
|
+
* @param {Object} opts Optional parameters
|
|
59664
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59665
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59666
|
+
*/
|
|
59667
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
59668
|
+
opts = opts || {};
|
|
59669
|
+
|
|
59670
|
+
// verify the required parameter 'topicId' is set
|
|
59671
|
+
if (topicId === undefined || topicId === null) {
|
|
59672
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59673
|
+
}
|
|
59674
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59675
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59676
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59677
|
+
}
|
|
59678
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59679
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59680
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59681
|
+
}
|
|
59682
|
+
|
|
59683
|
+
return this.apiClient.callApi(
|
|
59684
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
59685
|
+
'GET',
|
|
59686
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59687
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59688
|
+
{ },
|
|
59689
|
+
{ },
|
|
59690
|
+
null,
|
|
59691
|
+
['PureCloud OAuth'],
|
|
59692
|
+
['application/json'],
|
|
59693
|
+
['application/json']
|
|
59694
|
+
);
|
|
59695
|
+
}
|
|
59696
|
+
|
|
59697
|
+
/**
|
|
59698
|
+
* Get the Facebook data ingestion rule versions.
|
|
59699
|
+
*
|
|
59700
|
+
* @param {String} topicId topicId
|
|
59701
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59702
|
+
* @param {Object} opts Optional parameters
|
|
59703
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59704
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59705
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59706
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59707
|
+
*/
|
|
59708
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
|
|
59709
|
+
opts = opts || {};
|
|
59710
|
+
|
|
59711
|
+
// verify the required parameter 'topicId' is set
|
|
59712
|
+
if (topicId === undefined || topicId === null) {
|
|
59713
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
59714
|
+
}
|
|
59715
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59716
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59717
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
59718
|
+
}
|
|
59719
|
+
|
|
59720
|
+
return this.apiClient.callApi(
|
|
59721
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions',
|
|
59722
|
+
'GET',
|
|
59723
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59724
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59725
|
+
{ },
|
|
59726
|
+
{ },
|
|
59727
|
+
null,
|
|
59728
|
+
['PureCloud OAuth'],
|
|
59729
|
+
['application/json'],
|
|
59730
|
+
['application/json']
|
|
59731
|
+
);
|
|
59732
|
+
}
|
|
59733
|
+
|
|
59734
|
+
/**
|
|
59735
|
+
* Get a single open data ingestion rule.
|
|
59736
|
+
*
|
|
59737
|
+
* @param {String} topicId topicId
|
|
59738
|
+
* @param {String} openId openId
|
|
59739
|
+
* @param {Object} opts Optional parameters
|
|
59740
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59741
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59742
|
+
*/
|
|
59743
|
+
getSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
59744
|
+
opts = opts || {};
|
|
59745
|
+
|
|
59746
|
+
// verify the required parameter 'topicId' is set
|
|
59747
|
+
if (topicId === undefined || topicId === null) {
|
|
59748
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59749
|
+
}
|
|
59750
|
+
// verify the required parameter 'openId' is set
|
|
59751
|
+
if (openId === undefined || openId === null) {
|
|
59752
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59753
|
+
}
|
|
59754
|
+
|
|
59755
|
+
return this.apiClient.callApi(
|
|
59756
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
59757
|
+
'GET',
|
|
59758
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59759
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59760
|
+
{ },
|
|
59761
|
+
{ },
|
|
59762
|
+
null,
|
|
59763
|
+
['PureCloud OAuth'],
|
|
59764
|
+
['application/json'],
|
|
59765
|
+
['application/json']
|
|
59766
|
+
);
|
|
59767
|
+
}
|
|
59768
|
+
|
|
59769
|
+
/**
|
|
59770
|
+
* Get a single Open data ingestion rule version.
|
|
59771
|
+
*
|
|
59772
|
+
* @param {String} topicId topicId
|
|
59773
|
+
* @param {String} openId openId
|
|
59774
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59775
|
+
* @param {Object} opts Optional parameters
|
|
59776
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59777
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59778
|
+
*/
|
|
59779
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId, openId, dataIngestionRuleVersion, opts) {
|
|
59780
|
+
opts = opts || {};
|
|
59781
|
+
|
|
59782
|
+
// verify the required parameter 'topicId' is set
|
|
59783
|
+
if (topicId === undefined || topicId === null) {
|
|
59784
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59785
|
+
}
|
|
59786
|
+
// verify the required parameter 'openId' is set
|
|
59787
|
+
if (openId === undefined || openId === null) {
|
|
59788
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59789
|
+
}
|
|
59790
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59791
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59792
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59793
|
+
}
|
|
59794
|
+
|
|
59795
|
+
return this.apiClient.callApi(
|
|
59796
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}',
|
|
59797
|
+
'GET',
|
|
59798
|
+
{ 'topicId': topicId,'openId': openId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59799
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59800
|
+
{ },
|
|
59801
|
+
{ },
|
|
59802
|
+
null,
|
|
59803
|
+
['PureCloud OAuth'],
|
|
59804
|
+
['application/json'],
|
|
59805
|
+
['application/json']
|
|
59806
|
+
);
|
|
59807
|
+
}
|
|
59808
|
+
|
|
59809
|
+
/**
|
|
59810
|
+
* Get the Open data ingestion rule versions.
|
|
59811
|
+
*
|
|
59812
|
+
* @param {String} topicId topicId
|
|
59813
|
+
* @param {String} openId openId
|
|
59814
|
+
* @param {Object} opts Optional parameters
|
|
59815
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59816
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59817
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59818
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59819
|
+
*/
|
|
59820
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId, openId, opts) {
|
|
59821
|
+
opts = opts || {};
|
|
59822
|
+
|
|
59823
|
+
// verify the required parameter 'topicId' is set
|
|
59824
|
+
if (topicId === undefined || topicId === null) {
|
|
59825
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
59826
|
+
}
|
|
59827
|
+
// verify the required parameter 'openId' is set
|
|
59828
|
+
if (openId === undefined || openId === null) {
|
|
59829
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
59830
|
+
}
|
|
59831
|
+
|
|
59832
|
+
return this.apiClient.callApi(
|
|
59833
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions',
|
|
59834
|
+
'GET',
|
|
59835
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59836
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59837
|
+
{ },
|
|
59838
|
+
{ },
|
|
59839
|
+
null,
|
|
59840
|
+
['PureCloud OAuth'],
|
|
59841
|
+
['application/json'],
|
|
59842
|
+
['application/json']
|
|
59843
|
+
);
|
|
59844
|
+
}
|
|
59845
|
+
|
|
59846
|
+
/**
|
|
59847
|
+
* Get a single X (formally Twitter) data ingestion rule.
|
|
59848
|
+
*
|
|
59849
|
+
* @param {String} topicId topicId
|
|
59850
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59851
|
+
* @param {Object} opts Optional parameters
|
|
59852
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59853
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59854
|
+
*/
|
|
59855
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
59856
|
+
opts = opts || {};
|
|
59857
|
+
|
|
59858
|
+
// verify the required parameter 'topicId' is set
|
|
59859
|
+
if (topicId === undefined || topicId === null) {
|
|
59860
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59861
|
+
}
|
|
59862
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59863
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59864
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59865
|
+
}
|
|
59866
|
+
|
|
59867
|
+
return this.apiClient.callApi(
|
|
59868
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
59869
|
+
'GET',
|
|
59870
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59871
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59872
|
+
{ },
|
|
59873
|
+
{ },
|
|
59874
|
+
null,
|
|
59875
|
+
['PureCloud OAuth'],
|
|
59876
|
+
['application/json'],
|
|
59877
|
+
['application/json']
|
|
59878
|
+
);
|
|
59879
|
+
}
|
|
59880
|
+
|
|
59881
|
+
/**
|
|
59882
|
+
* Get a single X (formally Twitter) data ingestion rule version.
|
|
59883
|
+
*
|
|
59884
|
+
* @param {String} topicId topicId
|
|
59885
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59886
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59887
|
+
* @param {Object} opts Optional parameters
|
|
59888
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59889
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59890
|
+
*/
|
|
59891
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
59892
|
+
opts = opts || {};
|
|
59893
|
+
|
|
59894
|
+
// verify the required parameter 'topicId' is set
|
|
59895
|
+
if (topicId === undefined || topicId === null) {
|
|
59896
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59897
|
+
}
|
|
59898
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59899
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59900
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59901
|
+
}
|
|
59902
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59903
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59904
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59905
|
+
}
|
|
59906
|
+
|
|
59907
|
+
return this.apiClient.callApi(
|
|
59908
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
59909
|
+
'GET',
|
|
59910
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59911
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59912
|
+
{ },
|
|
59913
|
+
{ },
|
|
59914
|
+
null,
|
|
59915
|
+
['PureCloud OAuth'],
|
|
59916
|
+
['application/json'],
|
|
59917
|
+
['application/json']
|
|
59918
|
+
);
|
|
59919
|
+
}
|
|
59920
|
+
|
|
59921
|
+
/**
|
|
59922
|
+
* Get the Open data ingestion rule versions.
|
|
59923
|
+
*
|
|
59924
|
+
* @param {String} topicId topicId
|
|
59925
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59926
|
+
* @param {Object} opts Optional parameters
|
|
59927
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59928
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59929
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59930
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59931
|
+
*/
|
|
59932
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
|
|
59933
|
+
opts = opts || {};
|
|
59934
|
+
|
|
59935
|
+
// verify the required parameter 'topicId' is set
|
|
59936
|
+
if (topicId === undefined || topicId === null) {
|
|
59937
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
59938
|
+
}
|
|
59939
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59940
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59941
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
59942
|
+
}
|
|
59943
|
+
|
|
59944
|
+
return this.apiClient.callApi(
|
|
59945
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions',
|
|
59946
|
+
'GET',
|
|
59947
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59948
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59949
|
+
{ },
|
|
59950
|
+
{ },
|
|
59951
|
+
null,
|
|
59952
|
+
['PureCloud OAuth'],
|
|
59953
|
+
['application/json'],
|
|
59954
|
+
['application/json']
|
|
59955
|
+
);
|
|
59956
|
+
}
|
|
59957
|
+
|
|
59958
|
+
/**
|
|
59959
|
+
* Retrieve all social topics.
|
|
59960
|
+
*
|
|
59961
|
+
* @param {Object} opts Optional parameters
|
|
59962
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59963
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59964
|
+
* @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.
|
|
59965
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59966
|
+
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59967
|
+
*/
|
|
59968
|
+
getSocialmediaTopics(opts) {
|
|
59969
|
+
opts = opts || {};
|
|
59970
|
+
|
|
59971
|
+
|
|
59972
|
+
return this.apiClient.callApi(
|
|
59973
|
+
'/api/v2/socialmedia/topics',
|
|
59974
|
+
'GET',
|
|
59975
|
+
{ },
|
|
59976
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
|
|
59977
|
+
{ },
|
|
59978
|
+
{ },
|
|
59979
|
+
null,
|
|
59980
|
+
['PureCloud OAuth'],
|
|
59981
|
+
['application/json'],
|
|
59982
|
+
['application/json']
|
|
59983
|
+
);
|
|
59984
|
+
}
|
|
59985
|
+
|
|
59986
|
+
/**
|
|
59987
|
+
* Update a social topic.
|
|
59988
|
+
*
|
|
59989
|
+
* @param {String} topicId topicId
|
|
59990
|
+
* @param {Object} opts Optional parameters
|
|
59991
|
+
* @param {Object} opts.body
|
|
59992
|
+
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59993
|
+
*/
|
|
59994
|
+
patchSocialmediaTopic(topicId, opts) {
|
|
59995
|
+
opts = opts || {};
|
|
59996
|
+
|
|
59997
|
+
// verify the required parameter 'topicId' is set
|
|
59998
|
+
if (topicId === undefined || topicId === null) {
|
|
59999
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopic';
|
|
60000
|
+
}
|
|
60001
|
+
|
|
60002
|
+
return this.apiClient.callApi(
|
|
60003
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
60004
|
+
'PATCH',
|
|
60005
|
+
{ 'topicId': topicId },
|
|
60006
|
+
{ },
|
|
60007
|
+
{ },
|
|
60008
|
+
{ },
|
|
60009
|
+
opts['body'],
|
|
60010
|
+
['PureCloud OAuth'],
|
|
60011
|
+
['application/json'],
|
|
60012
|
+
['application/json']
|
|
60013
|
+
);
|
|
60014
|
+
}
|
|
60015
|
+
|
|
60016
|
+
/**
|
|
60017
|
+
* Update the status of a Facebook data ingestion rule.
|
|
60018
|
+
*
|
|
60019
|
+
* @param {String} topicId topicId
|
|
60020
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60021
|
+
* @param {Object} opts Optional parameters
|
|
60022
|
+
* @param {Object} opts.body
|
|
60023
|
+
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60024
|
+
*/
|
|
60025
|
+
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60026
|
+
opts = opts || {};
|
|
60027
|
+
|
|
60028
|
+
// verify the required parameter 'topicId' is set
|
|
60029
|
+
if (topicId === undefined || topicId === null) {
|
|
60030
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60031
|
+
}
|
|
60032
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60033
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60034
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60035
|
+
}
|
|
60036
|
+
|
|
60037
|
+
return this.apiClient.callApi(
|
|
60038
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60039
|
+
'PATCH',
|
|
60040
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60041
|
+
{ },
|
|
60042
|
+
{ },
|
|
60043
|
+
{ },
|
|
60044
|
+
opts['body'],
|
|
60045
|
+
['PureCloud OAuth'],
|
|
60046
|
+
['application/json'],
|
|
60047
|
+
['application/json']
|
|
60048
|
+
);
|
|
60049
|
+
}
|
|
60050
|
+
|
|
60051
|
+
/**
|
|
60052
|
+
* Update the status of a open data ingestion rule.
|
|
60053
|
+
*
|
|
60054
|
+
* @param {String} topicId topicId
|
|
60055
|
+
* @param {String} openId openId
|
|
60056
|
+
* @param {Object} opts Optional parameters
|
|
60057
|
+
* @param {Object} opts.body
|
|
60058
|
+
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60059
|
+
*/
|
|
60060
|
+
patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60061
|
+
opts = opts || {};
|
|
60062
|
+
|
|
60063
|
+
// verify the required parameter 'topicId' is set
|
|
60064
|
+
if (topicId === undefined || topicId === null) {
|
|
60065
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60066
|
+
}
|
|
60067
|
+
// verify the required parameter 'openId' is set
|
|
60068
|
+
if (openId === undefined || openId === null) {
|
|
60069
|
+
throw 'Missing the required parameter "openId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60070
|
+
}
|
|
60071
|
+
|
|
60072
|
+
return this.apiClient.callApi(
|
|
60073
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60074
|
+
'PATCH',
|
|
60075
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60076
|
+
{ },
|
|
60077
|
+
{ },
|
|
60078
|
+
{ },
|
|
60079
|
+
opts['body'],
|
|
60080
|
+
['PureCloud OAuth'],
|
|
60081
|
+
['application/json'],
|
|
60082
|
+
['application/json']
|
|
60083
|
+
);
|
|
60084
|
+
}
|
|
60085
|
+
|
|
60086
|
+
/**
|
|
60087
|
+
* Update the status of a X (formally Twitter) data ingestion rule.
|
|
60088
|
+
*
|
|
60089
|
+
* @param {String} topicId topicId
|
|
60090
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60091
|
+
* @param {Object} opts Optional parameters
|
|
60092
|
+
* @param {Object} opts.body
|
|
60093
|
+
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60094
|
+
*/
|
|
60095
|
+
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60096
|
+
opts = opts || {};
|
|
60097
|
+
|
|
60098
|
+
// verify the required parameter 'topicId' is set
|
|
60099
|
+
if (topicId === undefined || topicId === null) {
|
|
60100
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60101
|
+
}
|
|
60102
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60103
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60104
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60105
|
+
}
|
|
60106
|
+
|
|
60107
|
+
return this.apiClient.callApi(
|
|
60108
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60109
|
+
'PATCH',
|
|
60110
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60111
|
+
{ },
|
|
60112
|
+
{ },
|
|
60113
|
+
{ },
|
|
60114
|
+
opts['body'],
|
|
60115
|
+
['PureCloud OAuth'],
|
|
60116
|
+
['application/json'],
|
|
60117
|
+
['application/json']
|
|
60118
|
+
);
|
|
60119
|
+
}
|
|
60120
|
+
|
|
60121
|
+
/**
|
|
60122
|
+
* Create an Facebook data ingestion rule.
|
|
60123
|
+
*
|
|
60124
|
+
* @param {String} topicId topicId
|
|
60125
|
+
* @param {Object} opts Optional parameters
|
|
60126
|
+
* @param {Object} opts.body
|
|
60127
|
+
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60128
|
+
*/
|
|
60129
|
+
postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
|
|
60130
|
+
opts = opts || {};
|
|
60131
|
+
|
|
60132
|
+
// verify the required parameter 'topicId' is set
|
|
60133
|
+
if (topicId === undefined || topicId === null) {
|
|
60134
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesFacebook';
|
|
60135
|
+
}
|
|
60136
|
+
|
|
60137
|
+
return this.apiClient.callApi(
|
|
60138
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook',
|
|
60139
|
+
'POST',
|
|
60140
|
+
{ 'topicId': topicId },
|
|
60141
|
+
{ },
|
|
60142
|
+
{ },
|
|
60143
|
+
{ },
|
|
60144
|
+
opts['body'],
|
|
60145
|
+
['PureCloud OAuth'],
|
|
60146
|
+
['application/json'],
|
|
60147
|
+
['application/json']
|
|
60148
|
+
);
|
|
60149
|
+
}
|
|
60150
|
+
|
|
60151
|
+
/**
|
|
60152
|
+
* Create an open data ingestion rule.
|
|
60153
|
+
*
|
|
60154
|
+
* @param {String} topicId topicId
|
|
60155
|
+
* @param {Object} opts Optional parameters
|
|
60156
|
+
* @param {Object} opts.body
|
|
60157
|
+
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60158
|
+
*/
|
|
60159
|
+
postSocialmediaTopicDataingestionrulesOpen(topicId, opts) {
|
|
60160
|
+
opts = opts || {};
|
|
60161
|
+
|
|
60162
|
+
// verify the required parameter 'topicId' is set
|
|
60163
|
+
if (topicId === undefined || topicId === null) {
|
|
60164
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpen';
|
|
60165
|
+
}
|
|
60166
|
+
|
|
60167
|
+
return this.apiClient.callApi(
|
|
60168
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open',
|
|
60169
|
+
'POST',
|
|
60170
|
+
{ 'topicId': topicId },
|
|
60171
|
+
{ },
|
|
60172
|
+
{ },
|
|
60173
|
+
{ },
|
|
60174
|
+
opts['body'],
|
|
60175
|
+
['PureCloud OAuth'],
|
|
60176
|
+
['application/json'],
|
|
60177
|
+
['application/json']
|
|
60178
|
+
);
|
|
60179
|
+
}
|
|
60180
|
+
|
|
60181
|
+
/**
|
|
60182
|
+
* Create an twitter data ingestion rule.
|
|
60183
|
+
*
|
|
60184
|
+
* @param {String} topicId topicId
|
|
60185
|
+
* @param {Object} opts Optional parameters
|
|
60186
|
+
* @param {Object} opts.body
|
|
60187
|
+
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60188
|
+
*/
|
|
60189
|
+
postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
|
|
60190
|
+
opts = opts || {};
|
|
60191
|
+
|
|
60192
|
+
// verify the required parameter 'topicId' is set
|
|
60193
|
+
if (topicId === undefined || topicId === null) {
|
|
60194
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesTwitter';
|
|
60195
|
+
}
|
|
60196
|
+
|
|
60197
|
+
return this.apiClient.callApi(
|
|
60198
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter',
|
|
60199
|
+
'POST',
|
|
60200
|
+
{ 'topicId': topicId },
|
|
60201
|
+
{ },
|
|
60202
|
+
{ },
|
|
60203
|
+
{ },
|
|
60204
|
+
opts['body'],
|
|
60205
|
+
['PureCloud OAuth'],
|
|
60206
|
+
['application/json'],
|
|
60207
|
+
['application/json']
|
|
60208
|
+
);
|
|
60209
|
+
}
|
|
60210
|
+
|
|
60211
|
+
/**
|
|
60212
|
+
* Create a social topic.
|
|
60213
|
+
*
|
|
60214
|
+
* @param {Object} opts Optional parameters
|
|
60215
|
+
* @param {Object} opts.body
|
|
60216
|
+
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60217
|
+
*/
|
|
60218
|
+
postSocialmediaTopics(opts) {
|
|
60219
|
+
opts = opts || {};
|
|
60220
|
+
|
|
60221
|
+
|
|
60222
|
+
return this.apiClient.callApi(
|
|
60223
|
+
'/api/v2/socialmedia/topics',
|
|
60224
|
+
'POST',
|
|
60225
|
+
{ },
|
|
60226
|
+
{ },
|
|
60227
|
+
{ },
|
|
60228
|
+
{ },
|
|
60229
|
+
opts['body'],
|
|
60230
|
+
['PureCloud OAuth'],
|
|
60231
|
+
['application/json'],
|
|
60232
|
+
['application/json']
|
|
60233
|
+
);
|
|
60234
|
+
}
|
|
60235
|
+
|
|
60236
|
+
/**
|
|
60237
|
+
* Update the Facebook data ingestion rule.
|
|
60238
|
+
*
|
|
60239
|
+
* @param {String} topicId topicId
|
|
60240
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60241
|
+
* @param {Object} opts Optional parameters
|
|
60242
|
+
* @param {Object} opts.body
|
|
60243
|
+
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60244
|
+
*/
|
|
60245
|
+
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60246
|
+
opts = opts || {};
|
|
60247
|
+
|
|
60248
|
+
// verify the required parameter 'topicId' is set
|
|
60249
|
+
if (topicId === undefined || topicId === null) {
|
|
60250
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60251
|
+
}
|
|
60252
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60253
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60254
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60255
|
+
}
|
|
60256
|
+
|
|
60257
|
+
return this.apiClient.callApi(
|
|
60258
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60259
|
+
'PUT',
|
|
60260
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60261
|
+
{ },
|
|
60262
|
+
{ },
|
|
60263
|
+
{ },
|
|
60264
|
+
opts['body'],
|
|
60265
|
+
['PureCloud OAuth'],
|
|
60266
|
+
['application/json'],
|
|
60267
|
+
['application/json']
|
|
60268
|
+
);
|
|
60269
|
+
}
|
|
60270
|
+
|
|
60271
|
+
/**
|
|
60272
|
+
* Update the open data ingestion rule.
|
|
60273
|
+
*
|
|
60274
|
+
* @param {String} topicId topicId
|
|
60275
|
+
* @param {String} openId openId
|
|
60276
|
+
* @param {Object} opts Optional parameters
|
|
60277
|
+
* @param {Object} opts.body
|
|
60278
|
+
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60279
|
+
*/
|
|
60280
|
+
putSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60281
|
+
opts = opts || {};
|
|
60282
|
+
|
|
60283
|
+
// verify the required parameter 'topicId' is set
|
|
60284
|
+
if (topicId === undefined || topicId === null) {
|
|
60285
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60286
|
+
}
|
|
60287
|
+
// verify the required parameter 'openId' is set
|
|
60288
|
+
if (openId === undefined || openId === null) {
|
|
60289
|
+
throw 'Missing the required parameter "openId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60290
|
+
}
|
|
60291
|
+
|
|
60292
|
+
return this.apiClient.callApi(
|
|
60293
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60294
|
+
'PUT',
|
|
60295
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60296
|
+
{ },
|
|
60297
|
+
{ },
|
|
60298
|
+
{ },
|
|
60299
|
+
opts['body'],
|
|
60300
|
+
['PureCloud OAuth'],
|
|
60301
|
+
['application/json'],
|
|
60302
|
+
['application/json']
|
|
60303
|
+
);
|
|
60304
|
+
}
|
|
60305
|
+
|
|
60306
|
+
/**
|
|
60307
|
+
* Update the X (formally Twitter) data ingestion rule.
|
|
60308
|
+
*
|
|
60309
|
+
* @param {String} topicId topicId
|
|
60310
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60311
|
+
* @param {Object} opts Optional parameters
|
|
60312
|
+
* @param {Object} opts.body
|
|
60313
|
+
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60314
|
+
*/
|
|
60315
|
+
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60316
|
+
opts = opts || {};
|
|
60317
|
+
|
|
60318
|
+
// verify the required parameter 'topicId' is set
|
|
60319
|
+
if (topicId === undefined || topicId === null) {
|
|
60320
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60321
|
+
}
|
|
60322
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60323
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60324
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60325
|
+
}
|
|
60326
|
+
|
|
60327
|
+
return this.apiClient.callApi(
|
|
60328
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60329
|
+
'PUT',
|
|
60330
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60331
|
+
{ },
|
|
60332
|
+
{ },
|
|
60333
|
+
{ },
|
|
60334
|
+
opts['body'],
|
|
60335
|
+
['PureCloud OAuth'],
|
|
60336
|
+
['application/json'],
|
|
60337
|
+
['application/json']
|
|
60338
|
+
);
|
|
60339
|
+
}
|
|
60340
|
+
|
|
60341
|
+
}
|
|
60342
|
+
|
|
59378
60343
|
class SpeechTextAnalyticsApi {
|
|
59379
60344
|
/**
|
|
59380
60345
|
* SpeechTextAnalytics service.
|
|
59381
60346
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
59382
|
-
* @version
|
|
60347
|
+
* @version 209.0.0
|
|
59383
60348
|
*/
|
|
59384
60349
|
|
|
59385
60350
|
/**
|
|
@@ -60714,7 +61679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60714
61679
|
/**
|
|
60715
61680
|
* Stations service.
|
|
60716
61681
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60717
|
-
* @version
|
|
61682
|
+
* @version 209.0.0
|
|
60718
61683
|
*/
|
|
60719
61684
|
|
|
60720
61685
|
/**
|
|
@@ -60816,7 +61781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60816
61781
|
/**
|
|
60817
61782
|
* Suggest service.
|
|
60818
61783
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60819
|
-
* @version
|
|
61784
|
+
* @version 209.0.0
|
|
60820
61785
|
*/
|
|
60821
61786
|
|
|
60822
61787
|
/**
|
|
@@ -60955,7 +61920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60955
61920
|
/**
|
|
60956
61921
|
* TaskManagement service.
|
|
60957
61922
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60958
|
-
* @version
|
|
61923
|
+
* @version 209.0.0
|
|
60959
61924
|
*/
|
|
60960
61925
|
|
|
60961
61926
|
/**
|
|
@@ -62619,7 +63584,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62619
63584
|
/**
|
|
62620
63585
|
* Teams service.
|
|
62621
63586
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
62622
|
-
* @version
|
|
63587
|
+
* @version 209.0.0
|
|
62623
63588
|
*/
|
|
62624
63589
|
|
|
62625
63590
|
/**
|
|
@@ -62924,7 +63889,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62924
63889
|
/**
|
|
62925
63890
|
* Telephony service.
|
|
62926
63891
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62927
|
-
* @version
|
|
63892
|
+
* @version 209.0.0
|
|
62928
63893
|
*/
|
|
62929
63894
|
|
|
62930
63895
|
/**
|
|
@@ -63106,7 +64071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63106
64071
|
/**
|
|
63107
64072
|
* TelephonyProvidersEdge service.
|
|
63108
64073
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
63109
|
-
* @version
|
|
64074
|
+
* @version 209.0.0
|
|
63110
64075
|
*/
|
|
63111
64076
|
|
|
63112
64077
|
/**
|
|
@@ -66557,7 +67522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66557
67522
|
/**
|
|
66558
67523
|
* Textbots service.
|
|
66559
67524
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
66560
|
-
* @version
|
|
67525
|
+
* @version 209.0.0
|
|
66561
67526
|
*/
|
|
66562
67527
|
|
|
66563
67528
|
/**
|
|
@@ -66685,7 +67650,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66685
67650
|
/**
|
|
66686
67651
|
* Tokens service.
|
|
66687
67652
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
66688
|
-
* @version
|
|
67653
|
+
* @version 209.0.0
|
|
66689
67654
|
*/
|
|
66690
67655
|
|
|
66691
67656
|
/**
|
|
@@ -66839,7 +67804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66839
67804
|
/**
|
|
66840
67805
|
* Uploads service.
|
|
66841
67806
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66842
|
-
* @version
|
|
67807
|
+
* @version 209.0.0
|
|
66843
67808
|
*/
|
|
66844
67809
|
|
|
66845
67810
|
/**
|
|
@@ -67108,7 +68073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67108
68073
|
/**
|
|
67109
68074
|
* Usage service.
|
|
67110
68075
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
67111
|
-
* @version
|
|
68076
|
+
* @version 209.0.0
|
|
67112
68077
|
*/
|
|
67113
68078
|
|
|
67114
68079
|
/**
|
|
@@ -67323,7 +68288,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67323
68288
|
/**
|
|
67324
68289
|
* UserRecordings service.
|
|
67325
68290
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
67326
|
-
* @version
|
|
68291
|
+
* @version 209.0.0
|
|
67327
68292
|
*/
|
|
67328
68293
|
|
|
67329
68294
|
/**
|
|
@@ -67538,7 +68503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67538
68503
|
/**
|
|
67539
68504
|
* Users service.
|
|
67540
68505
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
67541
|
-
* @version
|
|
68506
|
+
* @version 209.0.0
|
|
67542
68507
|
*/
|
|
67543
68508
|
|
|
67544
68509
|
/**
|
|
@@ -70367,7 +71332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70367
71332
|
/**
|
|
70368
71333
|
* Utilities service.
|
|
70369
71334
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
70370
|
-
* @version
|
|
71335
|
+
* @version 209.0.0
|
|
70371
71336
|
*/
|
|
70372
71337
|
|
|
70373
71338
|
/**
|
|
@@ -70478,7 +71443,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70478
71443
|
/**
|
|
70479
71444
|
* Voicemail service.
|
|
70480
71445
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
70481
|
-
* @version
|
|
71446
|
+
* @version 209.0.0
|
|
70482
71447
|
*/
|
|
70483
71448
|
|
|
70484
71449
|
/**
|
|
@@ -71200,7 +72165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71200
72165
|
/**
|
|
71201
72166
|
* WebChat service.
|
|
71202
72167
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
71203
|
-
* @version
|
|
72168
|
+
* @version 209.0.0
|
|
71204
72169
|
*/
|
|
71205
72170
|
|
|
71206
72171
|
/**
|
|
@@ -71751,7 +72716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71751
72716
|
/**
|
|
71752
72717
|
* WebDeployments service.
|
|
71753
72718
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
71754
|
-
* @version
|
|
72719
|
+
* @version 209.0.0
|
|
71755
72720
|
*/
|
|
71756
72721
|
|
|
71757
72722
|
/**
|
|
@@ -72278,7 +73243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72278
73243
|
/**
|
|
72279
73244
|
* WebMessaging service.
|
|
72280
73245
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
72281
|
-
* @version
|
|
73246
|
+
* @version 209.0.0
|
|
72282
73247
|
*/
|
|
72283
73248
|
|
|
72284
73249
|
/**
|
|
@@ -72324,7 +73289,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72324
73289
|
/**
|
|
72325
73290
|
* Widgets service.
|
|
72326
73291
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
72327
|
-
* @version
|
|
73292
|
+
* @version 209.0.0
|
|
72328
73293
|
*/
|
|
72329
73294
|
|
|
72330
73295
|
/**
|
|
@@ -72470,7 +73435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72470
73435
|
/**
|
|
72471
73436
|
* WorkforceManagement service.
|
|
72472
73437
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
72473
|
-
* @version
|
|
73438
|
+
* @version 209.0.0
|
|
72474
73439
|
*/
|
|
72475
73440
|
|
|
72476
73441
|
/**
|
|
@@ -75506,7 +76471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75506
76471
|
* Gets all the shift trades for a given week
|
|
75507
76472
|
*
|
|
75508
76473
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
75509
|
-
* @param {String} weekDateId The start date of the
|
|
76474
|
+
* @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
|
|
75510
76475
|
* @param {Object} opts Optional parameters
|
|
75511
76476
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
75512
76477
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -76732,7 +77697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76732
77697
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
76733
77698
|
*
|
|
76734
77699
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
76735
|
-
* @param {String} weekDateId The start date of the
|
|
77700
|
+
* @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
|
|
76736
77701
|
* @param {String} tradeId The ID of the shift trade to update
|
|
76737
77702
|
* @param {Object} body body
|
|
76738
77703
|
*/
|
|
@@ -78992,7 +79957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78992
79957
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
78993
79958
|
*
|
|
78994
79959
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78995
|
-
* @param {String} weekDateId The start date of the
|
|
79960
|
+
* @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
|
|
78996
79961
|
* @param {String} tradeId The ID of the shift trade to update
|
|
78997
79962
|
* @param {Object} body body
|
|
78998
79963
|
*/
|
|
@@ -79032,7 +79997,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79032
79997
|
* Adds a shift trade
|
|
79033
79998
|
*
|
|
79034
79999
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
79035
|
-
* @param {String} weekDateId The start date of the
|
|
80000
|
+
* @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
|
|
79036
80001
|
* @param {Object} body body
|
|
79037
80002
|
*/
|
|
79038
80003
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body) {
|
|
@@ -79067,7 +80032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79067
80032
|
* Searches for potential shift trade matches for the current agent
|
|
79068
80033
|
*
|
|
79069
80034
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
79070
|
-
* @param {String} weekDateId The start date of the
|
|
80035
|
+
* @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
|
|
79071
80036
|
* @param {Object} body body
|
|
79072
80037
|
* @param {Object} opts Optional parameters
|
|
79073
80038
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -79106,7 +80071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79106
80071
|
* Updates the state of a batch of shift trades
|
|
79107
80072
|
* Admin functionality is not supported with "mine".
|
|
79108
80073
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
79109
|
-
* @param {String} weekDateId The start date of the
|
|
80074
|
+
* @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
|
|
79110
80075
|
* @param {Object} body body
|
|
79111
80076
|
* @param {Object} opts Optional parameters
|
|
79112
80077
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -79684,7 +80649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79684
80649
|
* </pre>
|
|
79685
80650
|
* </p>
|
|
79686
80651
|
* @module purecloud-platform-client-v2/index
|
|
79687
|
-
* @version
|
|
80652
|
+
* @version 209.0.0
|
|
79688
80653
|
*/
|
|
79689
80654
|
class platformClient {
|
|
79690
80655
|
constructor() {
|
|
@@ -79988,6 +80953,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79988
80953
|
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
79989
80954
|
*/
|
|
79990
80955
|
this.SettingsApi = SettingsApi;
|
|
80956
|
+
/**
|
|
80957
|
+
* The SocialMediaApi service constructor.
|
|
80958
|
+
* @property {module:purecloud-platform-client-v2/api/SocialMediaApi}
|
|
80959
|
+
*/
|
|
80960
|
+
this.SocialMediaApi = SocialMediaApi;
|
|
79991
80961
|
/**
|
|
79992
80962
|
* The SpeechTextAnalyticsApi service constructor.
|
|
79993
80963
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|