purecloud-platform-client-v2 208.0.0 → 210.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1514 -138
- package/dist/web-amd/purecloud-platform-client-v2.js +1514 -138
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +516 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +697 -259
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +3829 -3147
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +175 -0
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +240 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -9
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +52 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +29 -25
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +910 -0
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +11 -19
- package/src/purecloud-platform-client-v2/index.js +13 -1
|
@@ -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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.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 210.0.0
|
|
21280
21279
|
*/
|
|
21281
21280
|
|
|
21282
21281
|
/**
|
|
@@ -21358,11 +21357,181 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21358
21357
|
|
|
21359
21358
|
}
|
|
21360
21359
|
|
|
21360
|
+
class DataPrivacyApi {
|
|
21361
|
+
/**
|
|
21362
|
+
* DataPrivacy service.
|
|
21363
|
+
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21364
|
+
* @version 210.0.0
|
|
21365
|
+
*/
|
|
21366
|
+
|
|
21367
|
+
/**
|
|
21368
|
+
* Constructs a new DataPrivacyApi.
|
|
21369
|
+
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21370
|
+
* @class
|
|
21371
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
21372
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
21373
|
+
*/
|
|
21374
|
+
constructor(apiClient) {
|
|
21375
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
21376
|
+
}
|
|
21377
|
+
|
|
21378
|
+
|
|
21379
|
+
/**
|
|
21380
|
+
* Delete a masking rule.
|
|
21381
|
+
*
|
|
21382
|
+
* @param {String} ruleId ruleId
|
|
21383
|
+
*/
|
|
21384
|
+
deleteDataprivacyMaskingrule(ruleId) {
|
|
21385
|
+
// verify the required parameter 'ruleId' is set
|
|
21386
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21387
|
+
throw 'Missing the required parameter "ruleId" when calling deleteDataprivacyMaskingrule';
|
|
21388
|
+
}
|
|
21389
|
+
|
|
21390
|
+
return this.apiClient.callApi(
|
|
21391
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21392
|
+
'DELETE',
|
|
21393
|
+
{ 'ruleId': ruleId },
|
|
21394
|
+
{ },
|
|
21395
|
+
{ },
|
|
21396
|
+
{ },
|
|
21397
|
+
null,
|
|
21398
|
+
['PureCloud OAuth'],
|
|
21399
|
+
['application/json'],
|
|
21400
|
+
['application/json']
|
|
21401
|
+
);
|
|
21402
|
+
}
|
|
21403
|
+
|
|
21404
|
+
/**
|
|
21405
|
+
* Fetch details about a masking rule.
|
|
21406
|
+
*
|
|
21407
|
+
* @param {String} ruleId ruleId
|
|
21408
|
+
*/
|
|
21409
|
+
getDataprivacyMaskingrule(ruleId) {
|
|
21410
|
+
// verify the required parameter 'ruleId' is set
|
|
21411
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21412
|
+
throw 'Missing the required parameter "ruleId" when calling getDataprivacyMaskingrule';
|
|
21413
|
+
}
|
|
21414
|
+
|
|
21415
|
+
return this.apiClient.callApi(
|
|
21416
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21417
|
+
'GET',
|
|
21418
|
+
{ 'ruleId': ruleId },
|
|
21419
|
+
{ },
|
|
21420
|
+
{ },
|
|
21421
|
+
{ },
|
|
21422
|
+
null,
|
|
21423
|
+
['PureCloud OAuth'],
|
|
21424
|
+
['application/json'],
|
|
21425
|
+
['application/json']
|
|
21426
|
+
);
|
|
21427
|
+
}
|
|
21428
|
+
|
|
21429
|
+
/**
|
|
21430
|
+
* Retrieve the list of masking rules.
|
|
21431
|
+
*
|
|
21432
|
+
*/
|
|
21433
|
+
getDataprivacyMaskingrules() {
|
|
21434
|
+
|
|
21435
|
+
return this.apiClient.callApi(
|
|
21436
|
+
'/api/v2/dataprivacy/maskingrules',
|
|
21437
|
+
'GET',
|
|
21438
|
+
{ },
|
|
21439
|
+
{ },
|
|
21440
|
+
{ },
|
|
21441
|
+
{ },
|
|
21442
|
+
null,
|
|
21443
|
+
['PureCloud OAuth'],
|
|
21444
|
+
['application/json'],
|
|
21445
|
+
['application/json']
|
|
21446
|
+
);
|
|
21447
|
+
}
|
|
21448
|
+
|
|
21449
|
+
/**
|
|
21450
|
+
* Update information about a masking rule.
|
|
21451
|
+
*
|
|
21452
|
+
* @param {String} ruleId ruleId
|
|
21453
|
+
* @param {Object} opts Optional parameters
|
|
21454
|
+
* @param {Object} opts.body
|
|
21455
|
+
*/
|
|
21456
|
+
patchDataprivacyMaskingrule(ruleId, opts) {
|
|
21457
|
+
opts = opts || {};
|
|
21458
|
+
|
|
21459
|
+
// verify the required parameter 'ruleId' is set
|
|
21460
|
+
if (ruleId === undefined || ruleId === null) {
|
|
21461
|
+
throw 'Missing the required parameter "ruleId" when calling patchDataprivacyMaskingrule';
|
|
21462
|
+
}
|
|
21463
|
+
|
|
21464
|
+
return this.apiClient.callApi(
|
|
21465
|
+
'/api/v2/dataprivacy/maskingrules/{ruleId}',
|
|
21466
|
+
'PATCH',
|
|
21467
|
+
{ 'ruleId': ruleId },
|
|
21468
|
+
{ },
|
|
21469
|
+
{ },
|
|
21470
|
+
{ },
|
|
21471
|
+
opts['body'],
|
|
21472
|
+
['PureCloud OAuth'],
|
|
21473
|
+
['application/json'],
|
|
21474
|
+
['application/json']
|
|
21475
|
+
);
|
|
21476
|
+
}
|
|
21477
|
+
|
|
21478
|
+
/**
|
|
21479
|
+
* Create a new masking rule resource.
|
|
21480
|
+
*
|
|
21481
|
+
* @param {Object} body Details for creating masking rule resource
|
|
21482
|
+
*/
|
|
21483
|
+
postDataprivacyMaskingrules(body) {
|
|
21484
|
+
// verify the required parameter 'body' is set
|
|
21485
|
+
if (body === undefined || body === null) {
|
|
21486
|
+
throw 'Missing the required parameter "body" when calling postDataprivacyMaskingrules';
|
|
21487
|
+
}
|
|
21488
|
+
|
|
21489
|
+
return this.apiClient.callApi(
|
|
21490
|
+
'/api/v2/dataprivacy/maskingrules',
|
|
21491
|
+
'POST',
|
|
21492
|
+
{ },
|
|
21493
|
+
{ },
|
|
21494
|
+
{ },
|
|
21495
|
+
{ },
|
|
21496
|
+
body,
|
|
21497
|
+
['PureCloud OAuth'],
|
|
21498
|
+
['application/json'],
|
|
21499
|
+
['application/json']
|
|
21500
|
+
);
|
|
21501
|
+
}
|
|
21502
|
+
|
|
21503
|
+
/**
|
|
21504
|
+
* Validate masking before creating.
|
|
21505
|
+
*
|
|
21506
|
+
* @param {Object} body Text to be masked
|
|
21507
|
+
*/
|
|
21508
|
+
postDataprivacyMaskingrulesValidate(body) {
|
|
21509
|
+
// verify the required parameter 'body' is set
|
|
21510
|
+
if (body === undefined || body === null) {
|
|
21511
|
+
throw 'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';
|
|
21512
|
+
}
|
|
21513
|
+
|
|
21514
|
+
return this.apiClient.callApi(
|
|
21515
|
+
'/api/v2/dataprivacy/maskingrules/validate',
|
|
21516
|
+
'POST',
|
|
21517
|
+
{ },
|
|
21518
|
+
{ },
|
|
21519
|
+
{ },
|
|
21520
|
+
{ },
|
|
21521
|
+
body,
|
|
21522
|
+
['PureCloud OAuth'],
|
|
21523
|
+
['application/json'],
|
|
21524
|
+
['application/json']
|
|
21525
|
+
);
|
|
21526
|
+
}
|
|
21527
|
+
|
|
21528
|
+
}
|
|
21529
|
+
|
|
21361
21530
|
class DownloadsApi {
|
|
21362
21531
|
/**
|
|
21363
21532
|
* Downloads service.
|
|
21364
21533
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21365
|
-
* @version
|
|
21534
|
+
* @version 210.0.0
|
|
21366
21535
|
*/
|
|
21367
21536
|
|
|
21368
21537
|
/**
|
|
@@ -21414,7 +21583,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21414
21583
|
/**
|
|
21415
21584
|
* Emails service.
|
|
21416
21585
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21417
|
-
* @version
|
|
21586
|
+
* @version 210.0.0
|
|
21418
21587
|
*/
|
|
21419
21588
|
|
|
21420
21589
|
/**
|
|
@@ -21479,7 +21648,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21479
21648
|
/**
|
|
21480
21649
|
* EmployeeEngagement service.
|
|
21481
21650
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21482
|
-
* @version
|
|
21651
|
+
* @version 210.0.0
|
|
21483
21652
|
*/
|
|
21484
21653
|
|
|
21485
21654
|
/**
|
|
@@ -21630,7 +21799,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21630
21799
|
/**
|
|
21631
21800
|
* Events service.
|
|
21632
21801
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21633
|
-
* @version
|
|
21802
|
+
* @version 210.0.0
|
|
21634
21803
|
*/
|
|
21635
21804
|
|
|
21636
21805
|
/**
|
|
@@ -21726,7 +21895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21726
21895
|
/**
|
|
21727
21896
|
* ExternalContacts service.
|
|
21728
21897
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21729
|
-
* @version
|
|
21898
|
+
* @version 210.0.0
|
|
21730
21899
|
*/
|
|
21731
21900
|
|
|
21732
21901
|
/**
|
|
@@ -21871,6 +22040,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21871
22040
|
);
|
|
21872
22041
|
}
|
|
21873
22042
|
|
|
22043
|
+
/**
|
|
22044
|
+
* Delete Settings
|
|
22045
|
+
*
|
|
22046
|
+
* @param {String} settingsId Settings id
|
|
22047
|
+
*/
|
|
22048
|
+
deleteExternalcontactsImportSetting(settingsId) {
|
|
22049
|
+
// verify the required parameter 'settingsId' is set
|
|
22050
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22051
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportSetting';
|
|
22052
|
+
}
|
|
22053
|
+
|
|
22054
|
+
return this.apiClient.callApi(
|
|
22055
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
22056
|
+
'DELETE',
|
|
22057
|
+
{ 'settingsId': settingsId },
|
|
22058
|
+
{ },
|
|
22059
|
+
{ },
|
|
22060
|
+
{ },
|
|
22061
|
+
null,
|
|
22062
|
+
['PureCloud OAuth'],
|
|
22063
|
+
['application/json'],
|
|
22064
|
+
['application/json']
|
|
22065
|
+
);
|
|
22066
|
+
}
|
|
22067
|
+
|
|
21874
22068
|
/**
|
|
21875
22069
|
* Delete an external organization
|
|
21876
22070
|
*
|
|
@@ -22437,6 +22631,110 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22437
22631
|
);
|
|
22438
22632
|
}
|
|
22439
22633
|
|
|
22634
|
+
/**
|
|
22635
|
+
* Get job based on id
|
|
22636
|
+
*
|
|
22637
|
+
* @param {String} jobId Job id
|
|
22638
|
+
*/
|
|
22639
|
+
getExternalcontactsImportJob(jobId) {
|
|
22640
|
+
// verify the required parameter 'jobId' is set
|
|
22641
|
+
if (jobId === undefined || jobId === null) {
|
|
22642
|
+
throw 'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';
|
|
22643
|
+
}
|
|
22644
|
+
|
|
22645
|
+
return this.apiClient.callApi(
|
|
22646
|
+
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
22647
|
+
'GET',
|
|
22648
|
+
{ 'jobId': jobId },
|
|
22649
|
+
{ },
|
|
22650
|
+
{ },
|
|
22651
|
+
{ },
|
|
22652
|
+
null,
|
|
22653
|
+
['PureCloud OAuth'],
|
|
22654
|
+
['application/json'],
|
|
22655
|
+
['application/json']
|
|
22656
|
+
);
|
|
22657
|
+
}
|
|
22658
|
+
|
|
22659
|
+
/**
|
|
22660
|
+
* List jobs for organization
|
|
22661
|
+
*
|
|
22662
|
+
* @param {Object} opts Optional parameters
|
|
22663
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22664
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
22665
|
+
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
22666
|
+
* @param {Object} opts.jobStatus Search term to filter by jobStatus
|
|
22667
|
+
*/
|
|
22668
|
+
getExternalcontactsImportJobs(opts) {
|
|
22669
|
+
opts = opts || {};
|
|
22670
|
+
|
|
22671
|
+
|
|
22672
|
+
return this.apiClient.callApi(
|
|
22673
|
+
'/api/v2/externalcontacts/import/jobs',
|
|
22674
|
+
'GET',
|
|
22675
|
+
{ },
|
|
22676
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
22677
|
+
{ },
|
|
22678
|
+
{ },
|
|
22679
|
+
null,
|
|
22680
|
+
['PureCloud OAuth'],
|
|
22681
|
+
['application/json'],
|
|
22682
|
+
['application/json']
|
|
22683
|
+
);
|
|
22684
|
+
}
|
|
22685
|
+
|
|
22686
|
+
/**
|
|
22687
|
+
* Get setting based on id
|
|
22688
|
+
*
|
|
22689
|
+
* @param {String} settingsId Settings id
|
|
22690
|
+
*/
|
|
22691
|
+
getExternalcontactsImportSetting(settingsId) {
|
|
22692
|
+
// verify the required parameter 'settingsId' is set
|
|
22693
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22694
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportSetting';
|
|
22695
|
+
}
|
|
22696
|
+
|
|
22697
|
+
return this.apiClient.callApi(
|
|
22698
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
22699
|
+
'GET',
|
|
22700
|
+
{ 'settingsId': settingsId },
|
|
22701
|
+
{ },
|
|
22702
|
+
{ },
|
|
22703
|
+
{ },
|
|
22704
|
+
null,
|
|
22705
|
+
['PureCloud OAuth'],
|
|
22706
|
+
['application/json'],
|
|
22707
|
+
['application/json']
|
|
22708
|
+
);
|
|
22709
|
+
}
|
|
22710
|
+
|
|
22711
|
+
/**
|
|
22712
|
+
* List settings for organization
|
|
22713
|
+
*
|
|
22714
|
+
* @param {Object} opts Optional parameters
|
|
22715
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22716
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
22717
|
+
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
22718
|
+
* @param {String} opts.name Search term to filter by settings name
|
|
22719
|
+
*/
|
|
22720
|
+
getExternalcontactsImportSettings(opts) {
|
|
22721
|
+
opts = opts || {};
|
|
22722
|
+
|
|
22723
|
+
|
|
22724
|
+
return this.apiClient.callApi(
|
|
22725
|
+
'/api/v2/externalcontacts/import/settings',
|
|
22726
|
+
'GET',
|
|
22727
|
+
{ },
|
|
22728
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
22729
|
+
{ },
|
|
22730
|
+
{ },
|
|
22731
|
+
null,
|
|
22732
|
+
['PureCloud OAuth'],
|
|
22733
|
+
['application/json'],
|
|
22734
|
+
['application/json']
|
|
22735
|
+
);
|
|
22736
|
+
}
|
|
22737
|
+
|
|
22440
22738
|
/**
|
|
22441
22739
|
* Fetch an external organization
|
|
22442
22740
|
*
|
|
@@ -23575,6 +23873,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23575
23873
|
);
|
|
23576
23874
|
}
|
|
23577
23875
|
|
|
23876
|
+
/**
|
|
23877
|
+
* Create a new job
|
|
23878
|
+
*
|
|
23879
|
+
* @param {Object} body Job
|
|
23880
|
+
*/
|
|
23881
|
+
postExternalcontactsImportJobs(body) {
|
|
23882
|
+
// verify the required parameter 'body' is set
|
|
23883
|
+
if (body === undefined || body === null) {
|
|
23884
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportJobs';
|
|
23885
|
+
}
|
|
23886
|
+
|
|
23887
|
+
return this.apiClient.callApi(
|
|
23888
|
+
'/api/v2/externalcontacts/import/jobs',
|
|
23889
|
+
'POST',
|
|
23890
|
+
{ },
|
|
23891
|
+
{ },
|
|
23892
|
+
{ },
|
|
23893
|
+
{ },
|
|
23894
|
+
body,
|
|
23895
|
+
['PureCloud OAuth'],
|
|
23896
|
+
['application/json'],
|
|
23897
|
+
['application/json']
|
|
23898
|
+
);
|
|
23899
|
+
}
|
|
23900
|
+
|
|
23901
|
+
/**
|
|
23902
|
+
* Create a new settings
|
|
23903
|
+
*
|
|
23904
|
+
* @param {Object} body Setting
|
|
23905
|
+
*/
|
|
23906
|
+
postExternalcontactsImportSettings(body) {
|
|
23907
|
+
// verify the required parameter 'body' is set
|
|
23908
|
+
if (body === undefined || body === null) {
|
|
23909
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportSettings';
|
|
23910
|
+
}
|
|
23911
|
+
|
|
23912
|
+
return this.apiClient.callApi(
|
|
23913
|
+
'/api/v2/externalcontacts/import/settings',
|
|
23914
|
+
'POST',
|
|
23915
|
+
{ },
|
|
23916
|
+
{ },
|
|
23917
|
+
{ },
|
|
23918
|
+
{ },
|
|
23919
|
+
body,
|
|
23920
|
+
['PureCloud OAuth'],
|
|
23921
|
+
['application/json'],
|
|
23922
|
+
['application/json']
|
|
23923
|
+
);
|
|
23924
|
+
}
|
|
23925
|
+
|
|
23578
23926
|
/**
|
|
23579
23927
|
* Merge two contacts into a new contact record
|
|
23580
23928
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -23890,6 +24238,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23890
24238
|
);
|
|
23891
24239
|
}
|
|
23892
24240
|
|
|
24241
|
+
/**
|
|
24242
|
+
* Update Job's workflow status
|
|
24243
|
+
*
|
|
24244
|
+
* @param {String} jobId Job id
|
|
24245
|
+
* @param {Object} body Status of the Job's workflow
|
|
24246
|
+
*/
|
|
24247
|
+
putExternalcontactsImportJob(jobId, body) {
|
|
24248
|
+
// verify the required parameter 'jobId' is set
|
|
24249
|
+
if (jobId === undefined || jobId === null) {
|
|
24250
|
+
throw 'Missing the required parameter "jobId" when calling putExternalcontactsImportJob';
|
|
24251
|
+
}
|
|
24252
|
+
// verify the required parameter 'body' is set
|
|
24253
|
+
if (body === undefined || body === null) {
|
|
24254
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportJob';
|
|
24255
|
+
}
|
|
24256
|
+
|
|
24257
|
+
return this.apiClient.callApi(
|
|
24258
|
+
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
24259
|
+
'PUT',
|
|
24260
|
+
{ 'jobId': jobId },
|
|
24261
|
+
{ },
|
|
24262
|
+
{ },
|
|
24263
|
+
{ },
|
|
24264
|
+
body,
|
|
24265
|
+
['PureCloud OAuth'],
|
|
24266
|
+
['application/json'],
|
|
24267
|
+
['application/json']
|
|
24268
|
+
);
|
|
24269
|
+
}
|
|
24270
|
+
|
|
24271
|
+
/**
|
|
24272
|
+
* Update settings
|
|
24273
|
+
*
|
|
24274
|
+
* @param {String} settingsId Settings id
|
|
24275
|
+
* @param {Object} body Setting
|
|
24276
|
+
*/
|
|
24277
|
+
putExternalcontactsImportSetting(settingsId, body) {
|
|
24278
|
+
// verify the required parameter 'settingsId' is set
|
|
24279
|
+
if (settingsId === undefined || settingsId === null) {
|
|
24280
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportSetting';
|
|
24281
|
+
}
|
|
24282
|
+
// verify the required parameter 'body' is set
|
|
24283
|
+
if (body === undefined || body === null) {
|
|
24284
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportSetting';
|
|
24285
|
+
}
|
|
24286
|
+
|
|
24287
|
+
return this.apiClient.callApi(
|
|
24288
|
+
'/api/v2/externalcontacts/import/settings/{settingsId}',
|
|
24289
|
+
'PUT',
|
|
24290
|
+
{ 'settingsId': settingsId },
|
|
24291
|
+
{ },
|
|
24292
|
+
{ },
|
|
24293
|
+
{ },
|
|
24294
|
+
body,
|
|
24295
|
+
['PureCloud OAuth'],
|
|
24296
|
+
['application/json'],
|
|
24297
|
+
['application/json']
|
|
24298
|
+
);
|
|
24299
|
+
}
|
|
24300
|
+
|
|
23893
24301
|
/**
|
|
23894
24302
|
* Update an external organization
|
|
23895
24303
|
*
|
|
@@ -24051,7 +24459,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24051
24459
|
/**
|
|
24052
24460
|
* Fax service.
|
|
24053
24461
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24054
|
-
* @version
|
|
24462
|
+
* @version 210.0.0
|
|
24055
24463
|
*/
|
|
24056
24464
|
|
|
24057
24465
|
/**
|
|
@@ -24266,7 +24674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24266
24674
|
/**
|
|
24267
24675
|
* Flows service.
|
|
24268
24676
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
24269
|
-
* @version
|
|
24677
|
+
* @version 210.0.0
|
|
24270
24678
|
*/
|
|
24271
24679
|
|
|
24272
24680
|
/**
|
|
@@ -24449,7 +24857,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24449
24857
|
/**
|
|
24450
24858
|
* Gamification service.
|
|
24451
24859
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24452
|
-
* @version
|
|
24860
|
+
* @version 210.0.0
|
|
24453
24861
|
*/
|
|
24454
24862
|
|
|
24455
24863
|
/**
|
|
@@ -26535,7 +26943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26535
26943
|
/**
|
|
26536
26944
|
* GeneralDataProtectionRegulation service.
|
|
26537
26945
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26538
|
-
* @version
|
|
26946
|
+
* @version 210.0.0
|
|
26539
26947
|
*/
|
|
26540
26948
|
|
|
26541
26949
|
/**
|
|
@@ -26665,7 +27073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26665
27073
|
/**
|
|
26666
27074
|
* Geolocation service.
|
|
26667
27075
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26668
|
-
* @version
|
|
27076
|
+
* @version 210.0.0
|
|
26669
27077
|
*/
|
|
26670
27078
|
|
|
26671
27079
|
/**
|
|
@@ -26796,7 +27204,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26796
27204
|
/**
|
|
26797
27205
|
* Greetings service.
|
|
26798
27206
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26799
|
-
* @version
|
|
27207
|
+
* @version 210.0.0
|
|
26800
27208
|
*/
|
|
26801
27209
|
|
|
26802
27210
|
/**
|
|
@@ -27251,7 +27659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27251
27659
|
/**
|
|
27252
27660
|
* Groups service.
|
|
27253
27661
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27254
|
-
* @version
|
|
27662
|
+
* @version 210.0.0
|
|
27255
27663
|
*/
|
|
27256
27664
|
|
|
27257
27665
|
/**
|
|
@@ -27770,7 +28178,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27770
28178
|
/**
|
|
27771
28179
|
* IdentityProvider service.
|
|
27772
28180
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27773
|
-
* @version
|
|
28181
|
+
* @version 210.0.0
|
|
27774
28182
|
*/
|
|
27775
28183
|
|
|
27776
28184
|
/**
|
|
@@ -28631,7 +29039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28631
29039
|
/**
|
|
28632
29040
|
* InfrastructureAsCode service.
|
|
28633
29041
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28634
|
-
* @version
|
|
29042
|
+
* @version 210.0.0
|
|
28635
29043
|
*/
|
|
28636
29044
|
|
|
28637
29045
|
/**
|
|
@@ -28798,7 +29206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28798
29206
|
/**
|
|
28799
29207
|
* Integrations service.
|
|
28800
29208
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28801
|
-
* @version
|
|
29209
|
+
* @version 210.0.0
|
|
28802
29210
|
*/
|
|
28803
29211
|
|
|
28804
29212
|
/**
|
|
@@ -31240,7 +31648,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31240
31648
|
/**
|
|
31241
31649
|
* Journey service.
|
|
31242
31650
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31243
|
-
* @version
|
|
31651
|
+
* @version 210.0.0
|
|
31244
31652
|
*/
|
|
31245
31653
|
|
|
31246
31654
|
/**
|
|
@@ -31411,7 +31819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31411
31819
|
|
|
31412
31820
|
/**
|
|
31413
31821
|
* Delete the Schedule of a JourneyView
|
|
31414
|
-
*
|
|
31822
|
+
*
|
|
31415
31823
|
* @param {String} viewId Journey View Id
|
|
31416
31824
|
*/
|
|
31417
31825
|
deleteJourneyViewSchedules(viewId) {
|
|
@@ -32084,7 +32492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32084
32492
|
|
|
32085
32493
|
/**
|
|
32086
32494
|
* Get the Schedule for a JourneyView
|
|
32087
|
-
*
|
|
32495
|
+
*
|
|
32088
32496
|
* @param {String} viewId Journey View Id
|
|
32089
32497
|
*/
|
|
32090
32498
|
getJourneyViewSchedules(viewId) {
|
|
@@ -32214,7 +32622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32214
32622
|
|
|
32215
32623
|
/**
|
|
32216
32624
|
* Get the job for a journey view version.
|
|
32217
|
-
*
|
|
32625
|
+
*
|
|
32218
32626
|
* @param {String} viewId Journey View Id
|
|
32219
32627
|
* @param {String} journeyVersionId Journey View Version
|
|
32220
32628
|
* @param {String} jobId JobId
|
|
@@ -32249,7 +32657,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32249
32657
|
|
|
32250
32658
|
/**
|
|
32251
32659
|
* Get the result of a job for a journey view version.
|
|
32252
|
-
*
|
|
32660
|
+
*
|
|
32253
32661
|
* @param {String} viewId JourneyViewResult id
|
|
32254
32662
|
* @param {String} journeyViewVersion Journey View Version
|
|
32255
32663
|
* @param {String} jobId Id of the executing job
|
|
@@ -32324,7 +32732,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32324
32732
|
|
|
32325
32733
|
/**
|
|
32326
32734
|
* Get the latest job of a journey view version.
|
|
32327
|
-
*
|
|
32735
|
+
*
|
|
32328
32736
|
* @param {String} viewId Journey View Id
|
|
32329
32737
|
* @param {String} journeyVersionId Journey View Version
|
|
32330
32738
|
*/
|
|
@@ -32624,7 +33032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32624
33032
|
|
|
32625
33033
|
/**
|
|
32626
33034
|
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
32627
|
-
*
|
|
33035
|
+
*
|
|
32628
33036
|
* @param {String} viewId Journey View Id
|
|
32629
33037
|
* @param {String} journeyVersionId Journey View Version
|
|
32630
33038
|
* @param {String} jobId JobId
|
|
@@ -33027,7 +33435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33027
33435
|
|
|
33028
33436
|
/**
|
|
33029
33437
|
* Submit a job request for a journey view version.
|
|
33030
|
-
*
|
|
33438
|
+
*
|
|
33031
33439
|
* @param {String} viewId Journey View Id
|
|
33032
33440
|
* @param {String} journeyVersionId Journey View Version
|
|
33033
33441
|
*/
|
|
@@ -33136,7 +33544,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33136
33544
|
|
|
33137
33545
|
/**
|
|
33138
33546
|
* Update the Schedule for a JourneyView
|
|
33139
|
-
*
|
|
33547
|
+
*
|
|
33140
33548
|
* @param {String} viewId Journey View Id
|
|
33141
33549
|
* @param {Object} body journeyViewSchedule
|
|
33142
33550
|
*/
|
|
@@ -33205,7 +33613,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33205
33613
|
/**
|
|
33206
33614
|
* Knowledge service.
|
|
33207
33615
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
33208
|
-
* @version
|
|
33616
|
+
* @version 210.0.0
|
|
33209
33617
|
*/
|
|
33210
33618
|
|
|
33211
33619
|
/**
|
|
@@ -33729,8 +34137,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33729
34137
|
* Get sync options available for a knowledge-connect integration
|
|
33730
34138
|
*
|
|
33731
34139
|
* @param {String} integrationId Integration ID
|
|
34140
|
+
* @param {Object} opts Optional parameters
|
|
34141
|
+
* @param {Array.<String>} opts.knowledgeBaseIds Narrowing down filtering option results by knowledge base.
|
|
33732
34142
|
*/
|
|
33733
|
-
getKnowledgeIntegrationOptions(integrationId) {
|
|
34143
|
+
getKnowledgeIntegrationOptions(integrationId, opts) {
|
|
34144
|
+
opts = opts || {};
|
|
34145
|
+
|
|
33734
34146
|
// verify the required parameter 'integrationId' is set
|
|
33735
34147
|
if (integrationId === undefined || integrationId === null) {
|
|
33736
34148
|
throw 'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';
|
|
@@ -33740,7 +34152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33740
34152
|
'/api/v2/knowledge/integrations/{integrationId}/options',
|
|
33741
34153
|
'GET',
|
|
33742
34154
|
{ 'integrationId': integrationId },
|
|
33743
|
-
{
|
|
34155
|
+
{ 'knowledgeBaseIds': this.apiClient.buildCollectionParam(opts['knowledgeBaseIds'], 'multi') },
|
|
33744
34156
|
{ },
|
|
33745
34157
|
{ },
|
|
33746
34158
|
null,
|
|
@@ -37077,7 +37489,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37077
37489
|
/**
|
|
37078
37490
|
* LanguageUnderstanding service.
|
|
37079
37491
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
37080
|
-
* @version
|
|
37492
|
+
* @version 210.0.0
|
|
37081
37493
|
*/
|
|
37082
37494
|
|
|
37083
37495
|
/**
|
|
@@ -38111,7 +38523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38111
38523
|
/**
|
|
38112
38524
|
* Languages service.
|
|
38113
38525
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
38114
|
-
* @version
|
|
38526
|
+
* @version 210.0.0
|
|
38115
38527
|
*/
|
|
38116
38528
|
|
|
38117
38529
|
/**
|
|
@@ -38333,7 +38745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38333
38745
|
/**
|
|
38334
38746
|
* Learning service.
|
|
38335
38747
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
38336
|
-
* @version
|
|
38748
|
+
* @version 210.0.0
|
|
38337
38749
|
*/
|
|
38338
38750
|
|
|
38339
38751
|
/**
|
|
@@ -39362,7 +39774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39362
39774
|
/**
|
|
39363
39775
|
* License service.
|
|
39364
39776
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
39365
|
-
* @version
|
|
39777
|
+
* @version 210.0.0
|
|
39366
39778
|
*/
|
|
39367
39779
|
|
|
39368
39780
|
/**
|
|
@@ -39600,7 +40012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39600
40012
|
/**
|
|
39601
40013
|
* Locations service.
|
|
39602
40014
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39603
|
-
* @version
|
|
40015
|
+
* @version 210.0.0
|
|
39604
40016
|
*/
|
|
39605
40017
|
|
|
39606
40018
|
/**
|
|
@@ -39836,7 +40248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39836
40248
|
/**
|
|
39837
40249
|
* LogCapture service.
|
|
39838
40250
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39839
|
-
* @version
|
|
40251
|
+
* @version 210.0.0
|
|
39840
40252
|
*/
|
|
39841
40253
|
|
|
39842
40254
|
/**
|
|
@@ -40036,7 +40448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40036
40448
|
/**
|
|
40037
40449
|
* Messaging service.
|
|
40038
40450
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40039
|
-
* @version
|
|
40451
|
+
* @version 210.0.0
|
|
40040
40452
|
*/
|
|
40041
40453
|
|
|
40042
40454
|
/**
|
|
@@ -40395,7 +40807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40395
40807
|
/**
|
|
40396
40808
|
* MobileDevices service.
|
|
40397
40809
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
40398
|
-
* @version
|
|
40810
|
+
* @version 210.0.0
|
|
40399
40811
|
*/
|
|
40400
40812
|
|
|
40401
40813
|
/**
|
|
@@ -40546,7 +40958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40546
40958
|
/**
|
|
40547
40959
|
* Notifications service.
|
|
40548
40960
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40549
|
-
* @version
|
|
40961
|
+
* @version 210.0.0
|
|
40550
40962
|
*/
|
|
40551
40963
|
|
|
40552
40964
|
/**
|
|
@@ -40779,7 +41191,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40779
41191
|
/**
|
|
40780
41192
|
* OAuth service.
|
|
40781
41193
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40782
|
-
* @version
|
|
41194
|
+
* @version 210.0.0
|
|
40783
41195
|
*/
|
|
40784
41196
|
|
|
40785
41197
|
/**
|
|
@@ -41145,7 +41557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41145
41557
|
/**
|
|
41146
41558
|
* Objects service.
|
|
41147
41559
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
41148
|
-
* @version
|
|
41560
|
+
* @version 210.0.0
|
|
41149
41561
|
*/
|
|
41150
41562
|
|
|
41151
41563
|
/**
|
|
@@ -41415,7 +41827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41415
41827
|
/**
|
|
41416
41828
|
* OperationalEvents service.
|
|
41417
41829
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
41418
|
-
* @version
|
|
41830
|
+
* @version 210.0.0
|
|
41419
41831
|
*/
|
|
41420
41832
|
|
|
41421
41833
|
/**
|
|
@@ -41475,13 +41887,64 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41475
41887
|
);
|
|
41476
41888
|
}
|
|
41477
41889
|
|
|
41890
|
+
/**
|
|
41891
|
+
* Get aggregates for operational events in a timeframe.
|
|
41892
|
+
*
|
|
41893
|
+
* @param {Object} opts Optional parameters
|
|
41894
|
+
* @param {Object} opts.body
|
|
41895
|
+
*/
|
|
41896
|
+
postUsageEventsAggregatesQuery(opts) {
|
|
41897
|
+
opts = opts || {};
|
|
41898
|
+
|
|
41899
|
+
|
|
41900
|
+
return this.apiClient.callApi(
|
|
41901
|
+
'/api/v2/usage/events/aggregates/query',
|
|
41902
|
+
'POST',
|
|
41903
|
+
{ },
|
|
41904
|
+
{ },
|
|
41905
|
+
{ },
|
|
41906
|
+
{ },
|
|
41907
|
+
opts['body'],
|
|
41908
|
+
['PureCloud OAuth'],
|
|
41909
|
+
['application/json'],
|
|
41910
|
+
['application/json']
|
|
41911
|
+
);
|
|
41912
|
+
}
|
|
41913
|
+
|
|
41914
|
+
/**
|
|
41915
|
+
* Query operational events in a timeframe.
|
|
41916
|
+
*
|
|
41917
|
+
* @param {Object} opts Optional parameters
|
|
41918
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41919
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41920
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41921
|
+
* @param {Object} opts.body
|
|
41922
|
+
*/
|
|
41923
|
+
postUsageEventsQuery(opts) {
|
|
41924
|
+
opts = opts || {};
|
|
41925
|
+
|
|
41926
|
+
|
|
41927
|
+
return this.apiClient.callApi(
|
|
41928
|
+
'/api/v2/usage/events/query',
|
|
41929
|
+
'POST',
|
|
41930
|
+
{ },
|
|
41931
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
41932
|
+
{ },
|
|
41933
|
+
{ },
|
|
41934
|
+
opts['body'],
|
|
41935
|
+
['PureCloud OAuth'],
|
|
41936
|
+
['application/json'],
|
|
41937
|
+
['application/json']
|
|
41938
|
+
);
|
|
41939
|
+
}
|
|
41940
|
+
|
|
41478
41941
|
}
|
|
41479
41942
|
|
|
41480
41943
|
class OrganizationApi {
|
|
41481
41944
|
/**
|
|
41482
41945
|
* Organization service.
|
|
41483
41946
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41484
|
-
* @version
|
|
41947
|
+
* @version 210.0.0
|
|
41485
41948
|
*/
|
|
41486
41949
|
|
|
41487
41950
|
/**
|
|
@@ -42023,7 +42486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42023
42486
|
/**
|
|
42024
42487
|
* OrganizationAuthorization service.
|
|
42025
42488
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
42026
|
-
* @version
|
|
42489
|
+
* @version 210.0.0
|
|
42027
42490
|
*/
|
|
42028
42491
|
|
|
42029
42492
|
/**
|
|
@@ -43417,7 +43880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43417
43880
|
/**
|
|
43418
43881
|
* Outbound service.
|
|
43419
43882
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
43420
|
-
* @version
|
|
43883
|
+
* @version 210.0.0
|
|
43421
43884
|
*/
|
|
43422
43885
|
|
|
43423
43886
|
/**
|
|
@@ -47964,7 +48427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47964
48427
|
/**
|
|
47965
48428
|
* Presence service.
|
|
47966
48429
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47967
|
-
* @version
|
|
48430
|
+
* @version 210.0.0
|
|
47968
48431
|
*/
|
|
47969
48432
|
|
|
47970
48433
|
/**
|
|
@@ -48708,7 +49171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48708
49171
|
/**
|
|
48709
49172
|
* ProcessAutomation service.
|
|
48710
49173
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48711
|
-
* @version
|
|
49174
|
+
* @version 210.0.0
|
|
48712
49175
|
*/
|
|
48713
49176
|
|
|
48714
49177
|
/**
|
|
@@ -48947,7 +49410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48947
49410
|
/**
|
|
48948
49411
|
* Quality service.
|
|
48949
49412
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48950
|
-
* @version
|
|
49413
|
+
* @version 210.0.0
|
|
48951
49414
|
*/
|
|
48952
49415
|
|
|
48953
49416
|
/**
|
|
@@ -49232,6 +49695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49232
49695
|
* @param {String} opts.group group id
|
|
49233
49696
|
* @param {String} opts.agentTeamId team id of agents requested
|
|
49234
49697
|
* @param {String} opts.formContextId shared id between form versions
|
|
49698
|
+
* @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
49699
|
*/
|
|
49236
49700
|
getQualityAgentsActivity(opts) {
|
|
49237
49701
|
opts = opts || {};
|
|
@@ -49241,7 +49705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49241
49705
|
'/api/v2/quality/agents/activity',
|
|
49242
49706
|
'GET',
|
|
49243
49707
|
{ },
|
|
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'] },
|
|
49708
|
+
{ '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
49709
|
{ },
|
|
49246
49710
|
{ },
|
|
49247
49711
|
null,
|
|
@@ -49456,6 +49920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49456
49920
|
* @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
49921
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
49458
49922
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
49923
|
+
* @param {Boolean} opts.includeDeletedUsers Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (default to false)
|
|
49459
49924
|
*/
|
|
49460
49925
|
getQualityEvaluationsQuery(opts) {
|
|
49461
49926
|
opts = opts || {};
|
|
@@ -49465,7 +49930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49465
49930
|
'/api/v2/quality/evaluations/query',
|
|
49466
49931
|
'GET',
|
|
49467
49932
|
{ },
|
|
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'] },
|
|
49933
|
+
{ '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
49934
|
{ },
|
|
49470
49935
|
{ },
|
|
49471
49936
|
null,
|
|
@@ -50733,7 +51198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50733
51198
|
/**
|
|
50734
51199
|
* Recording service.
|
|
50735
51200
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50736
|
-
* @version
|
|
51201
|
+
* @version 210.0.0
|
|
50737
51202
|
*/
|
|
50738
51203
|
|
|
50739
51204
|
/**
|
|
@@ -52392,7 +52857,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52392
52857
|
/**
|
|
52393
52858
|
* ResponseManagement service.
|
|
52394
52859
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
52395
|
-
* @version
|
|
52860
|
+
* @version 210.0.0
|
|
52396
52861
|
*/
|
|
52397
52862
|
|
|
52398
52863
|
/**
|
|
@@ -52902,7 +53367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52902
53367
|
/**
|
|
52903
53368
|
* Routing service.
|
|
52904
53369
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52905
|
-
* @version
|
|
53370
|
+
* @version 210.0.0
|
|
52906
53371
|
*/
|
|
52907
53372
|
|
|
52908
53373
|
/**
|
|
@@ -53310,18 +53775,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53310
53775
|
/**
|
|
53311
53776
|
* Delete a phone number provisioned for SMS.
|
|
53312
53777
|
*
|
|
53313
|
-
* @param {String}
|
|
53778
|
+
* @param {String} phoneNumberId phone number
|
|
53314
53779
|
*/
|
|
53315
|
-
deleteRoutingSmsPhonenumber(
|
|
53316
|
-
// verify the required parameter '
|
|
53317
|
-
if (
|
|
53318
|
-
throw 'Missing the required parameter "
|
|
53780
|
+
deleteRoutingSmsPhonenumber(phoneNumberId) {
|
|
53781
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
53782
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
53783
|
+
throw 'Missing the required parameter "phoneNumberId" when calling deleteRoutingSmsPhonenumber';
|
|
53319
53784
|
}
|
|
53320
53785
|
|
|
53321
53786
|
return this.apiClient.callApi(
|
|
53322
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
53787
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
53323
53788
|
'DELETE',
|
|
53324
|
-
{ '
|
|
53789
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
53325
53790
|
{ },
|
|
53326
53791
|
{ },
|
|
53327
53792
|
{ },
|
|
@@ -54300,9 +54765,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54300
54765
|
* Get Estimated Wait Time
|
|
54301
54766
|
*
|
|
54302
54767
|
* @param {String} queueId queueId
|
|
54303
|
-
* @param {
|
|
54768
|
+
* @param {Object} mediaType mediaType
|
|
54769
|
+
* @param {Object} opts Optional parameters
|
|
54770
|
+
* @param {String} opts.labelId Unique id that represents the interaction label used with media type for EWT calculation
|
|
54304
54771
|
*/
|
|
54305
|
-
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType) {
|
|
54772
|
+
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType, opts) {
|
|
54773
|
+
opts = opts || {};
|
|
54774
|
+
|
|
54306
54775
|
// verify the required parameter 'queueId' is set
|
|
54307
54776
|
if (queueId === undefined || queueId === null) {
|
|
54308
54777
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';
|
|
@@ -54316,7 +54785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54316
54785
|
'/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime',
|
|
54317
54786
|
'GET',
|
|
54318
54787
|
{ 'queueId': queueId,'mediaType': mediaType },
|
|
54319
|
-
{
|
|
54788
|
+
{ 'labelId': opts['labelId'] },
|
|
54320
54789
|
{ },
|
|
54321
54790
|
{ },
|
|
54322
54791
|
null,
|
|
@@ -54867,22 +55336,22 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54867
55336
|
/**
|
|
54868
55337
|
* Get a phone number provisioned for SMS.
|
|
54869
55338
|
*
|
|
54870
|
-
* @param {String}
|
|
55339
|
+
* @param {String} phoneNumberId phone number
|
|
54871
55340
|
* @param {Object} opts Optional parameters
|
|
54872
55341
|
* @param {Object} opts.expand Expand response with additional information
|
|
54873
55342
|
*/
|
|
54874
|
-
getRoutingSmsPhonenumber(
|
|
55343
|
+
getRoutingSmsPhonenumber(phoneNumberId, opts) {
|
|
54875
55344
|
opts = opts || {};
|
|
54876
55345
|
|
|
54877
|
-
// verify the required parameter '
|
|
54878
|
-
if (
|
|
54879
|
-
throw 'Missing the required parameter "
|
|
55346
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
55347
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
55348
|
+
throw 'Missing the required parameter "phoneNumberId" when calling getRoutingSmsPhonenumber';
|
|
54880
55349
|
}
|
|
54881
55350
|
|
|
54882
55351
|
return this.apiClient.callApi(
|
|
54883
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
55352
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
54884
55353
|
'GET',
|
|
54885
|
-
{ '
|
|
55354
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
54886
55355
|
{ 'expand': opts['expand'] },
|
|
54887
55356
|
{ },
|
|
54888
55357
|
{ },
|
|
@@ -56807,13 +57276,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56807
57276
|
/**
|
|
56808
57277
|
* Update a phone number provisioned for SMS.
|
|
56809
57278
|
*
|
|
56810
|
-
* @param {String}
|
|
57279
|
+
* @param {String} phoneNumberId phone number
|
|
56811
57280
|
* @param {Object} body SmsPhoneNumber
|
|
56812
57281
|
*/
|
|
56813
|
-
putRoutingSmsPhonenumber(
|
|
56814
|
-
// verify the required parameter '
|
|
56815
|
-
if (
|
|
56816
|
-
throw 'Missing the required parameter "
|
|
57282
|
+
putRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
57283
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
57284
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
57285
|
+
throw 'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';
|
|
56817
57286
|
}
|
|
56818
57287
|
// verify the required parameter 'body' is set
|
|
56819
57288
|
if (body === undefined || body === null) {
|
|
@@ -56821,9 +57290,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56821
57290
|
}
|
|
56822
57291
|
|
|
56823
57292
|
return this.apiClient.callApi(
|
|
56824
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
57293
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
56825
57294
|
'PUT',
|
|
56826
|
-
{ '
|
|
57295
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
56827
57296
|
{ },
|
|
56828
57297
|
{ },
|
|
56829
57298
|
{ },
|
|
@@ -57050,7 +57519,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57050
57519
|
/**
|
|
57051
57520
|
* SCIM service.
|
|
57052
57521
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
57053
|
-
* @version
|
|
57522
|
+
* @version 210.0.0
|
|
57054
57523
|
*/
|
|
57055
57524
|
|
|
57056
57525
|
/**
|
|
@@ -57927,7 +58396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57927
58396
|
/**
|
|
57928
58397
|
* ScreenRecording service.
|
|
57929
58398
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57930
|
-
* @version
|
|
58399
|
+
* @version 210.0.0
|
|
57931
58400
|
*/
|
|
57932
58401
|
|
|
57933
58402
|
/**
|
|
@@ -57972,7 +58441,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57972
58441
|
/**
|
|
57973
58442
|
* Scripts service.
|
|
57974
58443
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57975
|
-
* @version
|
|
58444
|
+
* @version 210.0.0
|
|
57976
58445
|
*/
|
|
57977
58446
|
|
|
57978
58447
|
/**
|
|
@@ -58416,7 +58885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58416
58885
|
/**
|
|
58417
58886
|
* Search service.
|
|
58418
58887
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
58419
|
-
* @version
|
|
58888
|
+
* @version 210.0.0
|
|
58420
58889
|
*/
|
|
58421
58890
|
|
|
58422
58891
|
/**
|
|
@@ -59159,7 +59628,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59159
59628
|
/**
|
|
59160
59629
|
* Settings service.
|
|
59161
59630
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
59162
|
-
* @version
|
|
59631
|
+
* @version 210.0.0
|
|
59163
59632
|
*/
|
|
59164
59633
|
|
|
59165
59634
|
/**
|
|
@@ -59375,11 +59844,916 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59375
59844
|
|
|
59376
59845
|
}
|
|
59377
59846
|
|
|
59847
|
+
class SocialMediaApi {
|
|
59848
|
+
/**
|
|
59849
|
+
* SocialMedia service.
|
|
59850
|
+
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
59851
|
+
* @version 210.0.0
|
|
59852
|
+
*/
|
|
59853
|
+
|
|
59854
|
+
/**
|
|
59855
|
+
* Constructs a new SocialMediaApi.
|
|
59856
|
+
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
59857
|
+
* @class
|
|
59858
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
59859
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
59860
|
+
*/
|
|
59861
|
+
constructor(apiClient) {
|
|
59862
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
59863
|
+
}
|
|
59864
|
+
|
|
59865
|
+
|
|
59866
|
+
/**
|
|
59867
|
+
* Delete a social topic.
|
|
59868
|
+
*
|
|
59869
|
+
* @param {String} topicId topicId
|
|
59870
|
+
* @param {Object} opts Optional parameters
|
|
59871
|
+
* @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.
|
|
59872
|
+
* deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59873
|
+
*/
|
|
59874
|
+
deleteSocialmediaTopic(topicId, opts) {
|
|
59875
|
+
opts = opts || {};
|
|
59876
|
+
|
|
59877
|
+
// verify the required parameter 'topicId' is set
|
|
59878
|
+
if (topicId === undefined || topicId === null) {
|
|
59879
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopic';
|
|
59880
|
+
}
|
|
59881
|
+
|
|
59882
|
+
return this.apiClient.callApi(
|
|
59883
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
59884
|
+
'DELETE',
|
|
59885
|
+
{ 'topicId': topicId },
|
|
59886
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59887
|
+
{ },
|
|
59888
|
+
{ },
|
|
59889
|
+
null,
|
|
59890
|
+
['PureCloud OAuth'],
|
|
59891
|
+
['application/json'],
|
|
59892
|
+
['application/json']
|
|
59893
|
+
);
|
|
59894
|
+
}
|
|
59895
|
+
|
|
59896
|
+
/**
|
|
59897
|
+
* Delete a Facebook data ingestion rule.
|
|
59898
|
+
*
|
|
59899
|
+
* @param {String} topicId topicId
|
|
59900
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59901
|
+
* @param {Object} opts Optional parameters
|
|
59902
|
+
* @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)
|
|
59903
|
+
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59904
|
+
*/
|
|
59905
|
+
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
59906
|
+
opts = opts || {};
|
|
59907
|
+
|
|
59908
|
+
// verify the required parameter 'topicId' is set
|
|
59909
|
+
if (topicId === undefined || topicId === null) {
|
|
59910
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59911
|
+
}
|
|
59912
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59913
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59914
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59915
|
+
}
|
|
59916
|
+
|
|
59917
|
+
return this.apiClient.callApi(
|
|
59918
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
59919
|
+
'DELETE',
|
|
59920
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59921
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59922
|
+
{ },
|
|
59923
|
+
{ },
|
|
59924
|
+
null,
|
|
59925
|
+
['PureCloud OAuth'],
|
|
59926
|
+
['application/json'],
|
|
59927
|
+
['application/json']
|
|
59928
|
+
);
|
|
59929
|
+
}
|
|
59930
|
+
|
|
59931
|
+
/**
|
|
59932
|
+
* Delete a open data ingestion rule.
|
|
59933
|
+
*
|
|
59934
|
+
* @param {String} topicId topicId
|
|
59935
|
+
* @param {String} openId openId
|
|
59936
|
+
* @param {Object} opts Optional parameters
|
|
59937
|
+
* @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)
|
|
59938
|
+
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59939
|
+
*/
|
|
59940
|
+
deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
59941
|
+
opts = opts || {};
|
|
59942
|
+
|
|
59943
|
+
// verify the required parameter 'topicId' is set
|
|
59944
|
+
if (topicId === undefined || topicId === null) {
|
|
59945
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59946
|
+
}
|
|
59947
|
+
// verify the required parameter 'openId' is set
|
|
59948
|
+
if (openId === undefined || openId === null) {
|
|
59949
|
+
throw 'Missing the required parameter "openId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59950
|
+
}
|
|
59951
|
+
|
|
59952
|
+
return this.apiClient.callApi(
|
|
59953
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
59954
|
+
'DELETE',
|
|
59955
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59956
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59957
|
+
{ },
|
|
59958
|
+
{ },
|
|
59959
|
+
null,
|
|
59960
|
+
['PureCloud OAuth'],
|
|
59961
|
+
['application/json'],
|
|
59962
|
+
['application/json']
|
|
59963
|
+
);
|
|
59964
|
+
}
|
|
59965
|
+
|
|
59966
|
+
/**
|
|
59967
|
+
* Delete a X (formally Twitter) data ingestion rule.
|
|
59968
|
+
*
|
|
59969
|
+
* @param {String} topicId topicId
|
|
59970
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59971
|
+
* @param {Object} opts Optional parameters
|
|
59972
|
+
* @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)
|
|
59973
|
+
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59974
|
+
*/
|
|
59975
|
+
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
59976
|
+
opts = opts || {};
|
|
59977
|
+
|
|
59978
|
+
// verify the required parameter 'topicId' is set
|
|
59979
|
+
if (topicId === undefined || topicId === null) {
|
|
59980
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59981
|
+
}
|
|
59982
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59983
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59984
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59985
|
+
}
|
|
59986
|
+
|
|
59987
|
+
return this.apiClient.callApi(
|
|
59988
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
59989
|
+
'DELETE',
|
|
59990
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59991
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59992
|
+
{ },
|
|
59993
|
+
{ },
|
|
59994
|
+
null,
|
|
59995
|
+
['PureCloud OAuth'],
|
|
59996
|
+
['application/json'],
|
|
59997
|
+
['application/json']
|
|
59998
|
+
);
|
|
59999
|
+
}
|
|
60000
|
+
|
|
60001
|
+
/**
|
|
60002
|
+
* Get a single social topic.
|
|
60003
|
+
*
|
|
60004
|
+
* @param {String} topicId topicId
|
|
60005
|
+
* @param {Object} opts Optional parameters
|
|
60006
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60007
|
+
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60008
|
+
*/
|
|
60009
|
+
getSocialmediaTopic(topicId, opts) {
|
|
60010
|
+
opts = opts || {};
|
|
60011
|
+
|
|
60012
|
+
// verify the required parameter 'topicId' is set
|
|
60013
|
+
if (topicId === undefined || topicId === null) {
|
|
60014
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopic';
|
|
60015
|
+
}
|
|
60016
|
+
|
|
60017
|
+
return this.apiClient.callApi(
|
|
60018
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
60019
|
+
'GET',
|
|
60020
|
+
{ 'topicId': topicId },
|
|
60021
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60022
|
+
{ },
|
|
60023
|
+
{ },
|
|
60024
|
+
null,
|
|
60025
|
+
['PureCloud OAuth'],
|
|
60026
|
+
['application/json'],
|
|
60027
|
+
['application/json']
|
|
60028
|
+
);
|
|
60029
|
+
}
|
|
60030
|
+
|
|
60031
|
+
/**
|
|
60032
|
+
* Get a single Facebook data ingestion rule.
|
|
60033
|
+
*
|
|
60034
|
+
* @param {String} topicId topicId
|
|
60035
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60036
|
+
* @param {Object} opts Optional parameters
|
|
60037
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60038
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60039
|
+
*/
|
|
60040
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60041
|
+
opts = opts || {};
|
|
60042
|
+
|
|
60043
|
+
// verify the required parameter 'topicId' is set
|
|
60044
|
+
if (topicId === undefined || topicId === null) {
|
|
60045
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60046
|
+
}
|
|
60047
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60048
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60049
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60050
|
+
}
|
|
60051
|
+
|
|
60052
|
+
return this.apiClient.callApi(
|
|
60053
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60054
|
+
'GET',
|
|
60055
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60056
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60057
|
+
{ },
|
|
60058
|
+
{ },
|
|
60059
|
+
null,
|
|
60060
|
+
['PureCloud OAuth'],
|
|
60061
|
+
['application/json'],
|
|
60062
|
+
['application/json']
|
|
60063
|
+
);
|
|
60064
|
+
}
|
|
60065
|
+
|
|
60066
|
+
/**
|
|
60067
|
+
* Get a single Facebook data ingestion rule version.
|
|
60068
|
+
*
|
|
60069
|
+
* @param {String} topicId topicId
|
|
60070
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60071
|
+
* @param {String} dataIngestionRuleVersion version
|
|
60072
|
+
* @param {Object} opts Optional parameters
|
|
60073
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
60074
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60075
|
+
*/
|
|
60076
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
60077
|
+
opts = opts || {};
|
|
60078
|
+
|
|
60079
|
+
// verify the required parameter 'topicId' is set
|
|
60080
|
+
if (topicId === undefined || topicId === null) {
|
|
60081
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
60082
|
+
}
|
|
60083
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60084
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60085
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
60086
|
+
}
|
|
60087
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
60088
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
60089
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
60090
|
+
}
|
|
60091
|
+
|
|
60092
|
+
return this.apiClient.callApi(
|
|
60093
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
60094
|
+
'GET',
|
|
60095
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
60096
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60097
|
+
{ },
|
|
60098
|
+
{ },
|
|
60099
|
+
null,
|
|
60100
|
+
['PureCloud OAuth'],
|
|
60101
|
+
['application/json'],
|
|
60102
|
+
['application/json']
|
|
60103
|
+
);
|
|
60104
|
+
}
|
|
60105
|
+
|
|
60106
|
+
/**
|
|
60107
|
+
* Get the Facebook data ingestion rule versions.
|
|
60108
|
+
*
|
|
60109
|
+
* @param {String} topicId topicId
|
|
60110
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60111
|
+
* @param {Object} opts Optional parameters
|
|
60112
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60113
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60114
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60115
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60116
|
+
*/
|
|
60117
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
|
|
60118
|
+
opts = opts || {};
|
|
60119
|
+
|
|
60120
|
+
// verify the required parameter 'topicId' is set
|
|
60121
|
+
if (topicId === undefined || topicId === null) {
|
|
60122
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
60123
|
+
}
|
|
60124
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60125
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60126
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
60127
|
+
}
|
|
60128
|
+
|
|
60129
|
+
return this.apiClient.callApi(
|
|
60130
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions',
|
|
60131
|
+
'GET',
|
|
60132
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60133
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
60134
|
+
{ },
|
|
60135
|
+
{ },
|
|
60136
|
+
null,
|
|
60137
|
+
['PureCloud OAuth'],
|
|
60138
|
+
['application/json'],
|
|
60139
|
+
['application/json']
|
|
60140
|
+
);
|
|
60141
|
+
}
|
|
60142
|
+
|
|
60143
|
+
/**
|
|
60144
|
+
* Get a single open data ingestion rule.
|
|
60145
|
+
*
|
|
60146
|
+
* @param {String} topicId topicId
|
|
60147
|
+
* @param {String} openId openId
|
|
60148
|
+
* @param {Object} opts Optional parameters
|
|
60149
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60150
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60151
|
+
*/
|
|
60152
|
+
getSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60153
|
+
opts = opts || {};
|
|
60154
|
+
|
|
60155
|
+
// verify the required parameter 'topicId' is set
|
|
60156
|
+
if (topicId === undefined || topicId === null) {
|
|
60157
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60158
|
+
}
|
|
60159
|
+
// verify the required parameter 'openId' is set
|
|
60160
|
+
if (openId === undefined || openId === null) {
|
|
60161
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60162
|
+
}
|
|
60163
|
+
|
|
60164
|
+
return this.apiClient.callApi(
|
|
60165
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60166
|
+
'GET',
|
|
60167
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60168
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60169
|
+
{ },
|
|
60170
|
+
{ },
|
|
60171
|
+
null,
|
|
60172
|
+
['PureCloud OAuth'],
|
|
60173
|
+
['application/json'],
|
|
60174
|
+
['application/json']
|
|
60175
|
+
);
|
|
60176
|
+
}
|
|
60177
|
+
|
|
60178
|
+
/**
|
|
60179
|
+
* Get a single Open data ingestion rule version.
|
|
60180
|
+
*
|
|
60181
|
+
* @param {String} topicId topicId
|
|
60182
|
+
* @param {String} openId openId
|
|
60183
|
+
* @param {String} dataIngestionRuleVersion version
|
|
60184
|
+
* @param {Object} opts Optional parameters
|
|
60185
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
60186
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60187
|
+
*/
|
|
60188
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId, openId, dataIngestionRuleVersion, opts) {
|
|
60189
|
+
opts = opts || {};
|
|
60190
|
+
|
|
60191
|
+
// verify the required parameter 'topicId' is set
|
|
60192
|
+
if (topicId === undefined || topicId === null) {
|
|
60193
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
60194
|
+
}
|
|
60195
|
+
// verify the required parameter 'openId' is set
|
|
60196
|
+
if (openId === undefined || openId === null) {
|
|
60197
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
60198
|
+
}
|
|
60199
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
60200
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
60201
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
60202
|
+
}
|
|
60203
|
+
|
|
60204
|
+
return this.apiClient.callApi(
|
|
60205
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}',
|
|
60206
|
+
'GET',
|
|
60207
|
+
{ 'topicId': topicId,'openId': openId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
60208
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60209
|
+
{ },
|
|
60210
|
+
{ },
|
|
60211
|
+
null,
|
|
60212
|
+
['PureCloud OAuth'],
|
|
60213
|
+
['application/json'],
|
|
60214
|
+
['application/json']
|
|
60215
|
+
);
|
|
60216
|
+
}
|
|
60217
|
+
|
|
60218
|
+
/**
|
|
60219
|
+
* Get the Open data ingestion rule versions.
|
|
60220
|
+
*
|
|
60221
|
+
* @param {String} topicId topicId
|
|
60222
|
+
* @param {String} openId openId
|
|
60223
|
+
* @param {Object} opts Optional parameters
|
|
60224
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60225
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60226
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60227
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60228
|
+
*/
|
|
60229
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId, openId, opts) {
|
|
60230
|
+
opts = opts || {};
|
|
60231
|
+
|
|
60232
|
+
// verify the required parameter 'topicId' is set
|
|
60233
|
+
if (topicId === undefined || topicId === null) {
|
|
60234
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
60235
|
+
}
|
|
60236
|
+
// verify the required parameter 'openId' is set
|
|
60237
|
+
if (openId === undefined || openId === null) {
|
|
60238
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
60239
|
+
}
|
|
60240
|
+
|
|
60241
|
+
return this.apiClient.callApi(
|
|
60242
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions',
|
|
60243
|
+
'GET',
|
|
60244
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60245
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
60246
|
+
{ },
|
|
60247
|
+
{ },
|
|
60248
|
+
null,
|
|
60249
|
+
['PureCloud OAuth'],
|
|
60250
|
+
['application/json'],
|
|
60251
|
+
['application/json']
|
|
60252
|
+
);
|
|
60253
|
+
}
|
|
60254
|
+
|
|
60255
|
+
/**
|
|
60256
|
+
* Get a single X (formally Twitter) data ingestion rule.
|
|
60257
|
+
*
|
|
60258
|
+
* @param {String} topicId topicId
|
|
60259
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60260
|
+
* @param {Object} opts Optional parameters
|
|
60261
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60262
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60263
|
+
*/
|
|
60264
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60265
|
+
opts = opts || {};
|
|
60266
|
+
|
|
60267
|
+
// verify the required parameter 'topicId' is set
|
|
60268
|
+
if (topicId === undefined || topicId === null) {
|
|
60269
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60270
|
+
}
|
|
60271
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60272
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60273
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60274
|
+
}
|
|
60275
|
+
|
|
60276
|
+
return this.apiClient.callApi(
|
|
60277
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60278
|
+
'GET',
|
|
60279
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60280
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60281
|
+
{ },
|
|
60282
|
+
{ },
|
|
60283
|
+
null,
|
|
60284
|
+
['PureCloud OAuth'],
|
|
60285
|
+
['application/json'],
|
|
60286
|
+
['application/json']
|
|
60287
|
+
);
|
|
60288
|
+
}
|
|
60289
|
+
|
|
60290
|
+
/**
|
|
60291
|
+
* Get a single X (formally Twitter) data ingestion rule version.
|
|
60292
|
+
*
|
|
60293
|
+
* @param {String} topicId topicId
|
|
60294
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60295
|
+
* @param {String} dataIngestionRuleVersion version
|
|
60296
|
+
* @param {Object} opts Optional parameters
|
|
60297
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
60298
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60299
|
+
*/
|
|
60300
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
60301
|
+
opts = opts || {};
|
|
60302
|
+
|
|
60303
|
+
// verify the required parameter 'topicId' is set
|
|
60304
|
+
if (topicId === undefined || topicId === null) {
|
|
60305
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
60306
|
+
}
|
|
60307
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60308
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60309
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
60310
|
+
}
|
|
60311
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
60312
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
60313
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
60314
|
+
}
|
|
60315
|
+
|
|
60316
|
+
return this.apiClient.callApi(
|
|
60317
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
60318
|
+
'GET',
|
|
60319
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
60320
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
60321
|
+
{ },
|
|
60322
|
+
{ },
|
|
60323
|
+
null,
|
|
60324
|
+
['PureCloud OAuth'],
|
|
60325
|
+
['application/json'],
|
|
60326
|
+
['application/json']
|
|
60327
|
+
);
|
|
60328
|
+
}
|
|
60329
|
+
|
|
60330
|
+
/**
|
|
60331
|
+
* Get the Open data ingestion rule versions.
|
|
60332
|
+
*
|
|
60333
|
+
* @param {String} topicId topicId
|
|
60334
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60335
|
+
* @param {Object} opts Optional parameters
|
|
60336
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60337
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60338
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60339
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60340
|
+
*/
|
|
60341
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
|
|
60342
|
+
opts = opts || {};
|
|
60343
|
+
|
|
60344
|
+
// verify the required parameter 'topicId' is set
|
|
60345
|
+
if (topicId === undefined || topicId === null) {
|
|
60346
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
60347
|
+
}
|
|
60348
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60349
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60350
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
60351
|
+
}
|
|
60352
|
+
|
|
60353
|
+
return this.apiClient.callApi(
|
|
60354
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions',
|
|
60355
|
+
'GET',
|
|
60356
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60357
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
60358
|
+
{ },
|
|
60359
|
+
{ },
|
|
60360
|
+
null,
|
|
60361
|
+
['PureCloud OAuth'],
|
|
60362
|
+
['application/json'],
|
|
60363
|
+
['application/json']
|
|
60364
|
+
);
|
|
60365
|
+
}
|
|
60366
|
+
|
|
60367
|
+
/**
|
|
60368
|
+
* Retrieve all social topics.
|
|
60369
|
+
*
|
|
60370
|
+
* @param {Object} opts Optional parameters
|
|
60371
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
60372
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
60373
|
+
* @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.
|
|
60374
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60375
|
+
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60376
|
+
*/
|
|
60377
|
+
getSocialmediaTopics(opts) {
|
|
60378
|
+
opts = opts || {};
|
|
60379
|
+
|
|
60380
|
+
|
|
60381
|
+
return this.apiClient.callApi(
|
|
60382
|
+
'/api/v2/socialmedia/topics',
|
|
60383
|
+
'GET',
|
|
60384
|
+
{ },
|
|
60385
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
|
|
60386
|
+
{ },
|
|
60387
|
+
{ },
|
|
60388
|
+
null,
|
|
60389
|
+
['PureCloud OAuth'],
|
|
60390
|
+
['application/json'],
|
|
60391
|
+
['application/json']
|
|
60392
|
+
);
|
|
60393
|
+
}
|
|
60394
|
+
|
|
60395
|
+
/**
|
|
60396
|
+
* Update a social topic.
|
|
60397
|
+
*
|
|
60398
|
+
* @param {String} topicId topicId
|
|
60399
|
+
* @param {Object} opts Optional parameters
|
|
60400
|
+
* @param {Object} opts.body
|
|
60401
|
+
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60402
|
+
*/
|
|
60403
|
+
patchSocialmediaTopic(topicId, opts) {
|
|
60404
|
+
opts = opts || {};
|
|
60405
|
+
|
|
60406
|
+
// verify the required parameter 'topicId' is set
|
|
60407
|
+
if (topicId === undefined || topicId === null) {
|
|
60408
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopic';
|
|
60409
|
+
}
|
|
60410
|
+
|
|
60411
|
+
return this.apiClient.callApi(
|
|
60412
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
60413
|
+
'PATCH',
|
|
60414
|
+
{ 'topicId': topicId },
|
|
60415
|
+
{ },
|
|
60416
|
+
{ },
|
|
60417
|
+
{ },
|
|
60418
|
+
opts['body'],
|
|
60419
|
+
['PureCloud OAuth'],
|
|
60420
|
+
['application/json'],
|
|
60421
|
+
['application/json']
|
|
60422
|
+
);
|
|
60423
|
+
}
|
|
60424
|
+
|
|
60425
|
+
/**
|
|
60426
|
+
* Update the status of a Facebook data ingestion rule.
|
|
60427
|
+
*
|
|
60428
|
+
* @param {String} topicId topicId
|
|
60429
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60430
|
+
* @param {Object} opts Optional parameters
|
|
60431
|
+
* @param {Object} opts.body
|
|
60432
|
+
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60433
|
+
*/
|
|
60434
|
+
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60435
|
+
opts = opts || {};
|
|
60436
|
+
|
|
60437
|
+
// verify the required parameter 'topicId' is set
|
|
60438
|
+
if (topicId === undefined || topicId === null) {
|
|
60439
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60440
|
+
}
|
|
60441
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60442
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60443
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60444
|
+
}
|
|
60445
|
+
|
|
60446
|
+
return this.apiClient.callApi(
|
|
60447
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60448
|
+
'PATCH',
|
|
60449
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60450
|
+
{ },
|
|
60451
|
+
{ },
|
|
60452
|
+
{ },
|
|
60453
|
+
opts['body'],
|
|
60454
|
+
['PureCloud OAuth'],
|
|
60455
|
+
['application/json'],
|
|
60456
|
+
['application/json']
|
|
60457
|
+
);
|
|
60458
|
+
}
|
|
60459
|
+
|
|
60460
|
+
/**
|
|
60461
|
+
* Update the status of a open data ingestion rule.
|
|
60462
|
+
*
|
|
60463
|
+
* @param {String} topicId topicId
|
|
60464
|
+
* @param {String} openId openId
|
|
60465
|
+
* @param {Object} opts Optional parameters
|
|
60466
|
+
* @param {Object} opts.body
|
|
60467
|
+
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60468
|
+
*/
|
|
60469
|
+
patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60470
|
+
opts = opts || {};
|
|
60471
|
+
|
|
60472
|
+
// verify the required parameter 'topicId' is set
|
|
60473
|
+
if (topicId === undefined || topicId === null) {
|
|
60474
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60475
|
+
}
|
|
60476
|
+
// verify the required parameter 'openId' is set
|
|
60477
|
+
if (openId === undefined || openId === null) {
|
|
60478
|
+
throw 'Missing the required parameter "openId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60479
|
+
}
|
|
60480
|
+
|
|
60481
|
+
return this.apiClient.callApi(
|
|
60482
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60483
|
+
'PATCH',
|
|
60484
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60485
|
+
{ },
|
|
60486
|
+
{ },
|
|
60487
|
+
{ },
|
|
60488
|
+
opts['body'],
|
|
60489
|
+
['PureCloud OAuth'],
|
|
60490
|
+
['application/json'],
|
|
60491
|
+
['application/json']
|
|
60492
|
+
);
|
|
60493
|
+
}
|
|
60494
|
+
|
|
60495
|
+
/**
|
|
60496
|
+
* Update the status of a X (formally Twitter) data ingestion rule.
|
|
60497
|
+
*
|
|
60498
|
+
* @param {String} topicId topicId
|
|
60499
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60500
|
+
* @param {Object} opts Optional parameters
|
|
60501
|
+
* @param {Object} opts.body
|
|
60502
|
+
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60503
|
+
*/
|
|
60504
|
+
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60505
|
+
opts = opts || {};
|
|
60506
|
+
|
|
60507
|
+
// verify the required parameter 'topicId' is set
|
|
60508
|
+
if (topicId === undefined || topicId === null) {
|
|
60509
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60510
|
+
}
|
|
60511
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60512
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60513
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60514
|
+
}
|
|
60515
|
+
|
|
60516
|
+
return this.apiClient.callApi(
|
|
60517
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60518
|
+
'PATCH',
|
|
60519
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60520
|
+
{ },
|
|
60521
|
+
{ },
|
|
60522
|
+
{ },
|
|
60523
|
+
opts['body'],
|
|
60524
|
+
['PureCloud OAuth'],
|
|
60525
|
+
['application/json'],
|
|
60526
|
+
['application/json']
|
|
60527
|
+
);
|
|
60528
|
+
}
|
|
60529
|
+
|
|
60530
|
+
/**
|
|
60531
|
+
* Create an Facebook data ingestion rule.
|
|
60532
|
+
*
|
|
60533
|
+
* @param {String} topicId topicId
|
|
60534
|
+
* @param {Object} opts Optional parameters
|
|
60535
|
+
* @param {Object} opts.body
|
|
60536
|
+
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60537
|
+
*/
|
|
60538
|
+
postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
|
|
60539
|
+
opts = opts || {};
|
|
60540
|
+
|
|
60541
|
+
// verify the required parameter 'topicId' is set
|
|
60542
|
+
if (topicId === undefined || topicId === null) {
|
|
60543
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesFacebook';
|
|
60544
|
+
}
|
|
60545
|
+
|
|
60546
|
+
return this.apiClient.callApi(
|
|
60547
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook',
|
|
60548
|
+
'POST',
|
|
60549
|
+
{ 'topicId': topicId },
|
|
60550
|
+
{ },
|
|
60551
|
+
{ },
|
|
60552
|
+
{ },
|
|
60553
|
+
opts['body'],
|
|
60554
|
+
['PureCloud OAuth'],
|
|
60555
|
+
['application/json'],
|
|
60556
|
+
['application/json']
|
|
60557
|
+
);
|
|
60558
|
+
}
|
|
60559
|
+
|
|
60560
|
+
/**
|
|
60561
|
+
* Create an open data ingestion rule.
|
|
60562
|
+
*
|
|
60563
|
+
* @param {String} topicId topicId
|
|
60564
|
+
* @param {Object} opts Optional parameters
|
|
60565
|
+
* @param {Object} opts.body
|
|
60566
|
+
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60567
|
+
*/
|
|
60568
|
+
postSocialmediaTopicDataingestionrulesOpen(topicId, opts) {
|
|
60569
|
+
opts = opts || {};
|
|
60570
|
+
|
|
60571
|
+
// verify the required parameter 'topicId' is set
|
|
60572
|
+
if (topicId === undefined || topicId === null) {
|
|
60573
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpen';
|
|
60574
|
+
}
|
|
60575
|
+
|
|
60576
|
+
return this.apiClient.callApi(
|
|
60577
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open',
|
|
60578
|
+
'POST',
|
|
60579
|
+
{ 'topicId': topicId },
|
|
60580
|
+
{ },
|
|
60581
|
+
{ },
|
|
60582
|
+
{ },
|
|
60583
|
+
opts['body'],
|
|
60584
|
+
['PureCloud OAuth'],
|
|
60585
|
+
['application/json'],
|
|
60586
|
+
['application/json']
|
|
60587
|
+
);
|
|
60588
|
+
}
|
|
60589
|
+
|
|
60590
|
+
/**
|
|
60591
|
+
* Create an twitter data ingestion rule.
|
|
60592
|
+
*
|
|
60593
|
+
* @param {String} topicId topicId
|
|
60594
|
+
* @param {Object} opts Optional parameters
|
|
60595
|
+
* @param {Object} opts.body
|
|
60596
|
+
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60597
|
+
*/
|
|
60598
|
+
postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
|
|
60599
|
+
opts = opts || {};
|
|
60600
|
+
|
|
60601
|
+
// verify the required parameter 'topicId' is set
|
|
60602
|
+
if (topicId === undefined || topicId === null) {
|
|
60603
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesTwitter';
|
|
60604
|
+
}
|
|
60605
|
+
|
|
60606
|
+
return this.apiClient.callApi(
|
|
60607
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter',
|
|
60608
|
+
'POST',
|
|
60609
|
+
{ 'topicId': topicId },
|
|
60610
|
+
{ },
|
|
60611
|
+
{ },
|
|
60612
|
+
{ },
|
|
60613
|
+
opts['body'],
|
|
60614
|
+
['PureCloud OAuth'],
|
|
60615
|
+
['application/json'],
|
|
60616
|
+
['application/json']
|
|
60617
|
+
);
|
|
60618
|
+
}
|
|
60619
|
+
|
|
60620
|
+
/**
|
|
60621
|
+
* Create a social topic.
|
|
60622
|
+
*
|
|
60623
|
+
* @param {Object} opts Optional parameters
|
|
60624
|
+
* @param {Object} opts.body
|
|
60625
|
+
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60626
|
+
*/
|
|
60627
|
+
postSocialmediaTopics(opts) {
|
|
60628
|
+
opts = opts || {};
|
|
60629
|
+
|
|
60630
|
+
|
|
60631
|
+
return this.apiClient.callApi(
|
|
60632
|
+
'/api/v2/socialmedia/topics',
|
|
60633
|
+
'POST',
|
|
60634
|
+
{ },
|
|
60635
|
+
{ },
|
|
60636
|
+
{ },
|
|
60637
|
+
{ },
|
|
60638
|
+
opts['body'],
|
|
60639
|
+
['PureCloud OAuth'],
|
|
60640
|
+
['application/json'],
|
|
60641
|
+
['application/json']
|
|
60642
|
+
);
|
|
60643
|
+
}
|
|
60644
|
+
|
|
60645
|
+
/**
|
|
60646
|
+
* Update the Facebook data ingestion rule.
|
|
60647
|
+
*
|
|
60648
|
+
* @param {String} topicId topicId
|
|
60649
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60650
|
+
* @param {Object} opts Optional parameters
|
|
60651
|
+
* @param {Object} opts.body
|
|
60652
|
+
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60653
|
+
*/
|
|
60654
|
+
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60655
|
+
opts = opts || {};
|
|
60656
|
+
|
|
60657
|
+
// verify the required parameter 'topicId' is set
|
|
60658
|
+
if (topicId === undefined || topicId === null) {
|
|
60659
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60660
|
+
}
|
|
60661
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60662
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60663
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60664
|
+
}
|
|
60665
|
+
|
|
60666
|
+
return this.apiClient.callApi(
|
|
60667
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60668
|
+
'PUT',
|
|
60669
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60670
|
+
{ },
|
|
60671
|
+
{ },
|
|
60672
|
+
{ },
|
|
60673
|
+
opts['body'],
|
|
60674
|
+
['PureCloud OAuth'],
|
|
60675
|
+
['application/json'],
|
|
60676
|
+
['application/json']
|
|
60677
|
+
);
|
|
60678
|
+
}
|
|
60679
|
+
|
|
60680
|
+
/**
|
|
60681
|
+
* Update the open data ingestion rule.
|
|
60682
|
+
*
|
|
60683
|
+
* @param {String} topicId topicId
|
|
60684
|
+
* @param {String} openId openId
|
|
60685
|
+
* @param {Object} opts Optional parameters
|
|
60686
|
+
* @param {Object} opts.body
|
|
60687
|
+
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60688
|
+
*/
|
|
60689
|
+
putSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60690
|
+
opts = opts || {};
|
|
60691
|
+
|
|
60692
|
+
// verify the required parameter 'topicId' is set
|
|
60693
|
+
if (topicId === undefined || topicId === null) {
|
|
60694
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60695
|
+
}
|
|
60696
|
+
// verify the required parameter 'openId' is set
|
|
60697
|
+
if (openId === undefined || openId === null) {
|
|
60698
|
+
throw 'Missing the required parameter "openId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60699
|
+
}
|
|
60700
|
+
|
|
60701
|
+
return this.apiClient.callApi(
|
|
60702
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60703
|
+
'PUT',
|
|
60704
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60705
|
+
{ },
|
|
60706
|
+
{ },
|
|
60707
|
+
{ },
|
|
60708
|
+
opts['body'],
|
|
60709
|
+
['PureCloud OAuth'],
|
|
60710
|
+
['application/json'],
|
|
60711
|
+
['application/json']
|
|
60712
|
+
);
|
|
60713
|
+
}
|
|
60714
|
+
|
|
60715
|
+
/**
|
|
60716
|
+
* Update the X (formally Twitter) data ingestion rule.
|
|
60717
|
+
*
|
|
60718
|
+
* @param {String} topicId topicId
|
|
60719
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60720
|
+
* @param {Object} opts Optional parameters
|
|
60721
|
+
* @param {Object} opts.body
|
|
60722
|
+
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60723
|
+
*/
|
|
60724
|
+
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60725
|
+
opts = opts || {};
|
|
60726
|
+
|
|
60727
|
+
// verify the required parameter 'topicId' is set
|
|
60728
|
+
if (topicId === undefined || topicId === null) {
|
|
60729
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60730
|
+
}
|
|
60731
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60732
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60733
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60734
|
+
}
|
|
60735
|
+
|
|
60736
|
+
return this.apiClient.callApi(
|
|
60737
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60738
|
+
'PUT',
|
|
60739
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60740
|
+
{ },
|
|
60741
|
+
{ },
|
|
60742
|
+
{ },
|
|
60743
|
+
opts['body'],
|
|
60744
|
+
['PureCloud OAuth'],
|
|
60745
|
+
['application/json'],
|
|
60746
|
+
['application/json']
|
|
60747
|
+
);
|
|
60748
|
+
}
|
|
60749
|
+
|
|
60750
|
+
}
|
|
60751
|
+
|
|
59378
60752
|
class SpeechTextAnalyticsApi {
|
|
59379
60753
|
/**
|
|
59380
60754
|
* SpeechTextAnalytics service.
|
|
59381
60755
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
59382
|
-
* @version
|
|
60756
|
+
* @version 210.0.0
|
|
59383
60757
|
*/
|
|
59384
60758
|
|
|
59385
60759
|
/**
|
|
@@ -60714,7 +62088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60714
62088
|
/**
|
|
60715
62089
|
* Stations service.
|
|
60716
62090
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60717
|
-
* @version
|
|
62091
|
+
* @version 210.0.0
|
|
60718
62092
|
*/
|
|
60719
62093
|
|
|
60720
62094
|
/**
|
|
@@ -60816,7 +62190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60816
62190
|
/**
|
|
60817
62191
|
* Suggest service.
|
|
60818
62192
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60819
|
-
* @version
|
|
62193
|
+
* @version 210.0.0
|
|
60820
62194
|
*/
|
|
60821
62195
|
|
|
60822
62196
|
/**
|
|
@@ -60955,7 +62329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60955
62329
|
/**
|
|
60956
62330
|
* TaskManagement service.
|
|
60957
62331
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60958
|
-
* @version
|
|
62332
|
+
* @version 210.0.0
|
|
60959
62333
|
*/
|
|
60960
62334
|
|
|
60961
62335
|
/**
|
|
@@ -62619,7 +63993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62619
63993
|
/**
|
|
62620
63994
|
* Teams service.
|
|
62621
63995
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
62622
|
-
* @version
|
|
63996
|
+
* @version 210.0.0
|
|
62623
63997
|
*/
|
|
62624
63998
|
|
|
62625
63999
|
/**
|
|
@@ -62924,7 +64298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62924
64298
|
/**
|
|
62925
64299
|
* Telephony service.
|
|
62926
64300
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62927
|
-
* @version
|
|
64301
|
+
* @version 210.0.0
|
|
62928
64302
|
*/
|
|
62929
64303
|
|
|
62930
64304
|
/**
|
|
@@ -63106,7 +64480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63106
64480
|
/**
|
|
63107
64481
|
* TelephonyProvidersEdge service.
|
|
63108
64482
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
63109
|
-
* @version
|
|
64483
|
+
* @version 210.0.0
|
|
63110
64484
|
*/
|
|
63111
64485
|
|
|
63112
64486
|
/**
|
|
@@ -66557,7 +67931,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66557
67931
|
/**
|
|
66558
67932
|
* Textbots service.
|
|
66559
67933
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
66560
|
-
* @version
|
|
67934
|
+
* @version 210.0.0
|
|
66561
67935
|
*/
|
|
66562
67936
|
|
|
66563
67937
|
/**
|
|
@@ -66685,7 +68059,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66685
68059
|
/**
|
|
66686
68060
|
* Tokens service.
|
|
66687
68061
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
66688
|
-
* @version
|
|
68062
|
+
* @version 210.0.0
|
|
66689
68063
|
*/
|
|
66690
68064
|
|
|
66691
68065
|
/**
|
|
@@ -66839,7 +68213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66839
68213
|
/**
|
|
66840
68214
|
* Uploads service.
|
|
66841
68215
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66842
|
-
* @version
|
|
68216
|
+
* @version 210.0.0
|
|
66843
68217
|
*/
|
|
66844
68218
|
|
|
66845
68219
|
/**
|
|
@@ -67108,7 +68482,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67108
68482
|
/**
|
|
67109
68483
|
* Usage service.
|
|
67110
68484
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
67111
|
-
* @version
|
|
68485
|
+
* @version 210.0.0
|
|
67112
68486
|
*/
|
|
67113
68487
|
|
|
67114
68488
|
/**
|
|
@@ -67323,7 +68697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67323
68697
|
/**
|
|
67324
68698
|
* UserRecordings service.
|
|
67325
68699
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
67326
|
-
* @version
|
|
68700
|
+
* @version 210.0.0
|
|
67327
68701
|
*/
|
|
67328
68702
|
|
|
67329
68703
|
/**
|
|
@@ -67538,7 +68912,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67538
68912
|
/**
|
|
67539
68913
|
* Users service.
|
|
67540
68914
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
67541
|
-
* @version
|
|
68915
|
+
* @version 210.0.0
|
|
67542
68916
|
*/
|
|
67543
68917
|
|
|
67544
68918
|
/**
|
|
@@ -70367,7 +71741,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70367
71741
|
/**
|
|
70368
71742
|
* Utilities service.
|
|
70369
71743
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
70370
|
-
* @version
|
|
71744
|
+
* @version 210.0.0
|
|
70371
71745
|
*/
|
|
70372
71746
|
|
|
70373
71747
|
/**
|
|
@@ -70478,7 +71852,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70478
71852
|
/**
|
|
70479
71853
|
* Voicemail service.
|
|
70480
71854
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
70481
|
-
* @version
|
|
71855
|
+
* @version 210.0.0
|
|
70482
71856
|
*/
|
|
70483
71857
|
|
|
70484
71858
|
/**
|
|
@@ -71200,7 +72574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71200
72574
|
/**
|
|
71201
72575
|
* WebChat service.
|
|
71202
72576
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
71203
|
-
* @version
|
|
72577
|
+
* @version 210.0.0
|
|
71204
72578
|
*/
|
|
71205
72579
|
|
|
71206
72580
|
/**
|
|
@@ -71751,7 +73125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71751
73125
|
/**
|
|
71752
73126
|
* WebDeployments service.
|
|
71753
73127
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
71754
|
-
* @version
|
|
73128
|
+
* @version 210.0.0
|
|
71755
73129
|
*/
|
|
71756
73130
|
|
|
71757
73131
|
/**
|
|
@@ -72278,7 +73652,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72278
73652
|
/**
|
|
72279
73653
|
* WebMessaging service.
|
|
72280
73654
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
72281
|
-
* @version
|
|
73655
|
+
* @version 210.0.0
|
|
72282
73656
|
*/
|
|
72283
73657
|
|
|
72284
73658
|
/**
|
|
@@ -72324,7 +73698,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72324
73698
|
/**
|
|
72325
73699
|
* Widgets service.
|
|
72326
73700
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
72327
|
-
* @version
|
|
73701
|
+
* @version 210.0.0
|
|
72328
73702
|
*/
|
|
72329
73703
|
|
|
72330
73704
|
/**
|
|
@@ -72470,7 +73844,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72470
73844
|
/**
|
|
72471
73845
|
* WorkforceManagement service.
|
|
72472
73846
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
72473
|
-
* @version
|
|
73847
|
+
* @version 210.0.0
|
|
72474
73848
|
*/
|
|
72475
73849
|
|
|
72476
73850
|
/**
|
|
@@ -75370,12 +76744,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75370
76744
|
*
|
|
75371
76745
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
75372
76746
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
75373
|
-
* @param {Object} opts Optional parameters
|
|
75374
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
75375
76747
|
*/
|
|
75376
|
-
getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId
|
|
75377
|
-
opts = opts || {};
|
|
75378
|
-
|
|
76748
|
+
getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId) {
|
|
75379
76749
|
// verify the required parameter 'managementUnitId' is set
|
|
75380
76750
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
75381
76751
|
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';
|
|
@@ -75389,7 +76759,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75389
76759
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests',
|
|
75390
76760
|
'GET',
|
|
75391
76761
|
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
75392
|
-
{
|
|
76762
|
+
{ },
|
|
75393
76763
|
{ },
|
|
75394
76764
|
{ },
|
|
75395
76765
|
null,
|
|
@@ -75506,7 +76876,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75506
76876
|
* Gets all the shift trades for a given week
|
|
75507
76877
|
*
|
|
75508
76878
|
* @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
|
|
76879
|
+
* @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
76880
|
* @param {Object} opts Optional parameters
|
|
75511
76881
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
75512
76882
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -75880,18 +77250,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75880
77250
|
/**
|
|
75881
77251
|
* Get a list of time off requests for the current user
|
|
75882
77252
|
*
|
|
75883
|
-
* @param {Object} opts Optional parameters
|
|
75884
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
75885
77253
|
*/
|
|
75886
|
-
getWorkforcemanagementTimeoffrequests(
|
|
75887
|
-
opts = opts || {};
|
|
75888
|
-
|
|
77254
|
+
getWorkforcemanagementTimeoffrequests() {
|
|
75889
77255
|
|
|
75890
77256
|
return this.apiClient.callApi(
|
|
75891
77257
|
'/api/v2/workforcemanagement/timeoffrequests',
|
|
75892
77258
|
'GET',
|
|
75893
77259
|
{ },
|
|
75894
|
-
{
|
|
77260
|
+
{ },
|
|
75895
77261
|
{ },
|
|
75896
77262
|
{ },
|
|
75897
77263
|
null,
|
|
@@ -76732,7 +78098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76732
78098
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
76733
78099
|
*
|
|
76734
78100
|
* @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
|
|
78101
|
+
* @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
78102
|
* @param {String} tradeId The ID of the shift trade to update
|
|
76737
78103
|
* @param {Object} body body
|
|
76738
78104
|
*/
|
|
@@ -78992,7 +80358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78992
80358
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
78993
80359
|
*
|
|
78994
80360
|
* @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
|
|
80361
|
+
* @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
80362
|
* @param {String} tradeId The ID of the shift trade to update
|
|
78997
80363
|
* @param {Object} body body
|
|
78998
80364
|
*/
|
|
@@ -79032,7 +80398,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79032
80398
|
* Adds a shift trade
|
|
79033
80399
|
*
|
|
79034
80400
|
* @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
|
|
80401
|
+
* @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
80402
|
* @param {Object} body body
|
|
79037
80403
|
*/
|
|
79038
80404
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body) {
|
|
@@ -79067,7 +80433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79067
80433
|
* Searches for potential shift trade matches for the current agent
|
|
79068
80434
|
*
|
|
79069
80435
|
* @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
|
|
80436
|
+
* @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
80437
|
* @param {Object} body body
|
|
79072
80438
|
* @param {Object} opts Optional parameters
|
|
79073
80439
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -79106,7 +80472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79106
80472
|
* Updates the state of a batch of shift trades
|
|
79107
80473
|
* Admin functionality is not supported with "mine".
|
|
79108
80474
|
* @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
|
|
80475
|
+
* @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
80476
|
* @param {Object} body body
|
|
79111
80477
|
* @param {Object} opts Optional parameters
|
|
79112
80478
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -79684,7 +81050,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79684
81050
|
* </pre>
|
|
79685
81051
|
* </p>
|
|
79686
81052
|
* @module purecloud-platform-client-v2/index
|
|
79687
|
-
* @version
|
|
81053
|
+
* @version 210.0.0
|
|
79688
81054
|
*/
|
|
79689
81055
|
class platformClient {
|
|
79690
81056
|
constructor() {
|
|
@@ -79773,6 +81139,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79773
81139
|
* @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
|
|
79774
81140
|
*/
|
|
79775
81141
|
this.DataExtensionsApi = DataExtensionsApi;
|
|
81142
|
+
/**
|
|
81143
|
+
* The DataPrivacyApi service constructor.
|
|
81144
|
+
* @property {module:purecloud-platform-client-v2/api/DataPrivacyApi}
|
|
81145
|
+
*/
|
|
81146
|
+
this.DataPrivacyApi = DataPrivacyApi;
|
|
79776
81147
|
/**
|
|
79777
81148
|
* The DownloadsApi service constructor.
|
|
79778
81149
|
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
@@ -79988,6 +81359,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79988
81359
|
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
79989
81360
|
*/
|
|
79990
81361
|
this.SettingsApi = SettingsApi;
|
|
81362
|
+
/**
|
|
81363
|
+
* The SocialMediaApi service constructor.
|
|
81364
|
+
* @property {module:purecloud-platform-client-v2/api/SocialMediaApi}
|
|
81365
|
+
*/
|
|
81366
|
+
this.SocialMediaApi = SocialMediaApi;
|
|
79991
81367
|
/**
|
|
79992
81368
|
* The SpeechTextAnalyticsApi service constructor.
|
|
79993
81369
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|