purecloud-platform-client-v2 218.0.0 → 219.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 +1362 -94
- package/dist/web-amd/purecloud-platform-client-v2.js +1362 -94
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +396 -97
- package/dist/web-cjs/purecloud-platform-client-v2.js +396 -97
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +701 -1
- 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 +1 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +61 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +54 -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 +36 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +65 -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 +396 -2
- 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 +366 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- 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 +54 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -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 +60 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +6 -4
- 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 +65 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- 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 +66 -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 +26 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -5
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -687,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
687
|
|
|
688
688
|
/**
|
|
689
689
|
* @module purecloud-platform-client-v2/ApiClient
|
|
690
|
-
* @version
|
|
690
|
+
* @version 219.0.0
|
|
691
691
|
*/
|
|
692
692
|
class ApiClient {
|
|
693
693
|
/**
|
|
@@ -2231,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2231
2231
|
/**
|
|
2232
2232
|
* AgentAssistants service.
|
|
2233
2233
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2234
|
-
* @version
|
|
2234
|
+
* @version 219.0.0
|
|
2235
2235
|
*/
|
|
2236
2236
|
|
|
2237
2237
|
/**
|
|
@@ -2607,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2607
2607
|
/**
|
|
2608
2608
|
* AgentCopilot service.
|
|
2609
2609
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2610
|
-
* @version
|
|
2610
|
+
* @version 219.0.0
|
|
2611
2611
|
*/
|
|
2612
2612
|
|
|
2613
2613
|
/**
|
|
@@ -2683,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2683
2683
|
/**
|
|
2684
2684
|
* AgentUI service.
|
|
2685
2685
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2686
|
-
* @version
|
|
2686
|
+
* @version 219.0.0
|
|
2687
2687
|
*/
|
|
2688
2688
|
|
|
2689
2689
|
/**
|
|
@@ -2814,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2814
2814
|
/**
|
|
2815
2815
|
* Alerting service.
|
|
2816
2816
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2817
|
-
* @version
|
|
2817
|
+
* @version 219.0.0
|
|
2818
2818
|
*/
|
|
2819
2819
|
|
|
2820
2820
|
/**
|
|
@@ -3215,7 +3215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3215
3215
|
/**
|
|
3216
3216
|
* Analytics service.
|
|
3217
3217
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3218
|
-
* @version
|
|
3218
|
+
* @version 219.0.0
|
|
3219
3219
|
*/
|
|
3220
3220
|
|
|
3221
3221
|
/**
|
|
@@ -3340,7 +3340,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3340
3340
|
* Get an agent and their active sessions by user ID
|
|
3341
3341
|
*
|
|
3342
3342
|
* @param {String} userId userId
|
|
3343
|
-
* getAnalyticsAgentStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3344
3343
|
*/
|
|
3345
3344
|
getAnalyticsAgentStatus(userId) {
|
|
3346
3345
|
// verify the required parameter 'userId' is set
|
|
@@ -4792,7 +4791,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4792
4791
|
* Count agents by segment type
|
|
4793
4792
|
*
|
|
4794
4793
|
* @param {Object} body query
|
|
4795
|
-
* postAnalyticsAgentsStatusCounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4796
4794
|
*/
|
|
4797
4795
|
postAnalyticsAgentsStatusCounts(body) {
|
|
4798
4796
|
// verify the required parameter 'body' is set
|
|
@@ -4818,7 +4816,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4818
4816
|
* Retrieve the top 50 agents matching the query filters
|
|
4819
4817
|
*
|
|
4820
4818
|
* @param {Object} body query
|
|
4821
|
-
* postAnalyticsAgentsStatusQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4822
4819
|
*/
|
|
4823
4820
|
postAnalyticsAgentsStatusQuery(body) {
|
|
4824
4821
|
// verify the required parameter 'body' is set
|
|
@@ -6039,7 +6036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6039
6036
|
/**
|
|
6040
6037
|
* Architect service.
|
|
6041
6038
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6042
|
-
* @version
|
|
6039
|
+
* @version 219.0.0
|
|
6043
6040
|
*/
|
|
6044
6041
|
|
|
6045
6042
|
/**
|
|
@@ -9077,6 +9074,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9077
9074
|
);
|
|
9078
9075
|
}
|
|
9079
9076
|
|
|
9077
|
+
/**
|
|
9078
|
+
* Creates a presigned URL for uploading a user prompt file
|
|
9079
|
+
*
|
|
9080
|
+
* @param {String} promptId Prompt ID
|
|
9081
|
+
* @param {String} languageCode Language
|
|
9082
|
+
*/
|
|
9083
|
+
postArchitectPromptResourceUploads(promptId, languageCode) {
|
|
9084
|
+
// verify the required parameter 'promptId' is set
|
|
9085
|
+
if (promptId === undefined || promptId === null) {
|
|
9086
|
+
throw 'Missing the required parameter "promptId" when calling postArchitectPromptResourceUploads';
|
|
9087
|
+
}
|
|
9088
|
+
// verify the required parameter 'languageCode' is set
|
|
9089
|
+
if (languageCode === undefined || languageCode === null) {
|
|
9090
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectPromptResourceUploads';
|
|
9091
|
+
}
|
|
9092
|
+
|
|
9093
|
+
return this.apiClient.callApi(
|
|
9094
|
+
'/api/v2/architect/prompts/{promptId}/resources/{languageCode}/uploads',
|
|
9095
|
+
'POST',
|
|
9096
|
+
{ 'promptId': promptId,'languageCode': languageCode },
|
|
9097
|
+
{ },
|
|
9098
|
+
{ },
|
|
9099
|
+
{ },
|
|
9100
|
+
null,
|
|
9101
|
+
['PureCloud OAuth'],
|
|
9102
|
+
['application/json'],
|
|
9103
|
+
['application/json']
|
|
9104
|
+
);
|
|
9105
|
+
}
|
|
9106
|
+
|
|
9080
9107
|
/**
|
|
9081
9108
|
* Create a new user prompt resource
|
|
9082
9109
|
*
|
|
@@ -9207,6 +9234,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9207
9234
|
);
|
|
9208
9235
|
}
|
|
9209
9236
|
|
|
9237
|
+
/**
|
|
9238
|
+
* Creates a presigned URL for uploading a system prompt file
|
|
9239
|
+
*
|
|
9240
|
+
* @param {String} promptId Prompt ID
|
|
9241
|
+
* @param {String} languageCode Language
|
|
9242
|
+
*/
|
|
9243
|
+
postArchitectSystempromptResourceUploads(promptId, languageCode) {
|
|
9244
|
+
// verify the required parameter 'promptId' is set
|
|
9245
|
+
if (promptId === undefined || promptId === null) {
|
|
9246
|
+
throw 'Missing the required parameter "promptId" when calling postArchitectSystempromptResourceUploads';
|
|
9247
|
+
}
|
|
9248
|
+
// verify the required parameter 'languageCode' is set
|
|
9249
|
+
if (languageCode === undefined || languageCode === null) {
|
|
9250
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectSystempromptResourceUploads';
|
|
9251
|
+
}
|
|
9252
|
+
|
|
9253
|
+
return this.apiClient.callApi(
|
|
9254
|
+
'/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}/uploads',
|
|
9255
|
+
'POST',
|
|
9256
|
+
{ 'promptId': promptId,'languageCode': languageCode },
|
|
9257
|
+
{ },
|
|
9258
|
+
{ },
|
|
9259
|
+
{ },
|
|
9260
|
+
null,
|
|
9261
|
+
['PureCloud OAuth'],
|
|
9262
|
+
['application/json'],
|
|
9263
|
+
['application/json']
|
|
9264
|
+
);
|
|
9265
|
+
}
|
|
9266
|
+
|
|
9210
9267
|
/**
|
|
9211
9268
|
* Create system prompt resource override.
|
|
9212
9269
|
*
|
|
@@ -10272,7 +10329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10272
10329
|
/**
|
|
10273
10330
|
* Audit service.
|
|
10274
10331
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10275
|
-
* @version
|
|
10332
|
+
* @version 219.0.0
|
|
10276
10333
|
*/
|
|
10277
10334
|
|
|
10278
10335
|
/**
|
|
@@ -10473,7 +10530,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10473
10530
|
/**
|
|
10474
10531
|
* Authorization service.
|
|
10475
10532
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10476
|
-
* @version
|
|
10533
|
+
* @version 219.0.0
|
|
10477
10534
|
*/
|
|
10478
10535
|
|
|
10479
10536
|
/**
|
|
@@ -10699,6 +10756,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10699
10756
|
);
|
|
10700
10757
|
}
|
|
10701
10758
|
|
|
10759
|
+
/**
|
|
10760
|
+
* Get a list of soft deleted divisions for the org
|
|
10761
|
+
*
|
|
10762
|
+
* @param {Object} opts Optional parameters
|
|
10763
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10764
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10765
|
+
*/
|
|
10766
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
10767
|
+
opts = opts || {};
|
|
10768
|
+
|
|
10769
|
+
|
|
10770
|
+
return this.apiClient.callApi(
|
|
10771
|
+
'/api/v2/authorization/divisions/deleted',
|
|
10772
|
+
'GET',
|
|
10773
|
+
{ },
|
|
10774
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
10775
|
+
{ },
|
|
10776
|
+
{ },
|
|
10777
|
+
null,
|
|
10778
|
+
['PureCloud OAuth'],
|
|
10779
|
+
['application/json'],
|
|
10780
|
+
['application/json']
|
|
10781
|
+
);
|
|
10782
|
+
}
|
|
10783
|
+
|
|
10702
10784
|
/**
|
|
10703
10785
|
* Retrieve the home division for the organization.
|
|
10704
10786
|
* Will not include object counts.
|
|
@@ -10739,6 +10821,34 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10739
10821
|
);
|
|
10740
10822
|
}
|
|
10741
10823
|
|
|
10824
|
+
/**
|
|
10825
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
10826
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
10827
|
+
* @param {Object} opts Optional parameters
|
|
10828
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
10829
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10830
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
10831
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
10832
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
10833
|
+
*/
|
|
10834
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
10835
|
+
opts = opts || {};
|
|
10836
|
+
|
|
10837
|
+
|
|
10838
|
+
return this.apiClient.callApi(
|
|
10839
|
+
'/api/v2/authorization/divisions/query',
|
|
10840
|
+
'GET',
|
|
10841
|
+
{ },
|
|
10842
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
10843
|
+
{ },
|
|
10844
|
+
{ },
|
|
10845
|
+
null,
|
|
10846
|
+
['PureCloud OAuth'],
|
|
10847
|
+
['application/json'],
|
|
10848
|
+
['application/json']
|
|
10849
|
+
);
|
|
10850
|
+
}
|
|
10851
|
+
|
|
10742
10852
|
/**
|
|
10743
10853
|
* Returns which divisions the current user has the given permission in.
|
|
10744
10854
|
* This route is deprecated, use authorization/divisionspermitted/paged/me instead.
|
|
@@ -12135,7 +12245,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12135
12245
|
/**
|
|
12136
12246
|
* Billing service.
|
|
12137
12247
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12138
|
-
* @version
|
|
12248
|
+
* @version 219.0.0
|
|
12139
12249
|
*/
|
|
12140
12250
|
|
|
12141
12251
|
/**
|
|
@@ -12215,7 +12325,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12215
12325
|
/**
|
|
12216
12326
|
* CarrierServices service.
|
|
12217
12327
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12218
|
-
* @version
|
|
12328
|
+
* @version 219.0.0
|
|
12219
12329
|
*/
|
|
12220
12330
|
|
|
12221
12331
|
/**
|
|
@@ -12285,7 +12395,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12285
12395
|
/**
|
|
12286
12396
|
* Chat service.
|
|
12287
12397
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12288
|
-
* @version
|
|
12398
|
+
* @version 219.0.0
|
|
12289
12399
|
*/
|
|
12290
12400
|
|
|
12291
12401
|
/**
|
|
@@ -13214,7 +13324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13214
13324
|
/**
|
|
13215
13325
|
* Coaching service.
|
|
13216
13326
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13217
|
-
* @version
|
|
13327
|
+
* @version 219.0.0
|
|
13218
13328
|
*/
|
|
13219
13329
|
|
|
13220
13330
|
/**
|
|
@@ -13791,7 +13901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13791
13901
|
/**
|
|
13792
13902
|
* ContentManagement service.
|
|
13793
13903
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13794
|
-
* @version
|
|
13904
|
+
* @version 219.0.0
|
|
13795
13905
|
*/
|
|
13796
13906
|
|
|
13797
13907
|
/**
|
|
@@ -14872,7 +14982,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14872
14982
|
/**
|
|
14873
14983
|
* Conversations service.
|
|
14874
14984
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14875
|
-
* @version
|
|
14985
|
+
* @version 219.0.0
|
|
14876
14986
|
*/
|
|
14877
14987
|
|
|
14878
14988
|
/**
|
|
@@ -17960,6 +18070,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17960
18070
|
);
|
|
17961
18071
|
}
|
|
17962
18072
|
|
|
18073
|
+
/**
|
|
18074
|
+
* Update the feedback for the summary.
|
|
18075
|
+
*
|
|
18076
|
+
* @param {String} conversationId Conversation ID
|
|
18077
|
+
* @param {String} summaryId Summary ID
|
|
18078
|
+
* @param {Object} opts Optional parameters
|
|
18079
|
+
* @param {Object} opts.body
|
|
18080
|
+
* patchConversationSummaryFeedback is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18081
|
+
*/
|
|
18082
|
+
patchConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
18083
|
+
opts = opts || {};
|
|
18084
|
+
|
|
18085
|
+
// verify the required parameter 'conversationId' is set
|
|
18086
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18087
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSummaryFeedback';
|
|
18088
|
+
}
|
|
18089
|
+
// verify the required parameter 'summaryId' is set
|
|
18090
|
+
if (summaryId === undefined || summaryId === null) {
|
|
18091
|
+
throw 'Missing the required parameter "summaryId" when calling patchConversationSummaryFeedback';
|
|
18092
|
+
}
|
|
18093
|
+
|
|
18094
|
+
return this.apiClient.callApi(
|
|
18095
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback',
|
|
18096
|
+
'PATCH',
|
|
18097
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
18098
|
+
{ },
|
|
18099
|
+
{ },
|
|
18100
|
+
{ },
|
|
18101
|
+
opts['body'],
|
|
18102
|
+
['PureCloud OAuth'],
|
|
18103
|
+
['application/json'],
|
|
18104
|
+
['application/json']
|
|
18105
|
+
);
|
|
18106
|
+
}
|
|
18107
|
+
|
|
17963
18108
|
/**
|
|
17964
18109
|
* Update the utilization label on a conversation. When there is no value provided, the system default label is applied
|
|
17965
18110
|
*
|
|
@@ -22419,7 +22564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22419
22564
|
/**
|
|
22420
22565
|
* DataExtensions service.
|
|
22421
22566
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22422
|
-
* @version
|
|
22567
|
+
* @version 219.0.0
|
|
22423
22568
|
*/
|
|
22424
22569
|
|
|
22425
22570
|
/**
|
|
@@ -22505,7 +22650,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22505
22650
|
/**
|
|
22506
22651
|
* DataPrivacy service.
|
|
22507
22652
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22508
|
-
* @version
|
|
22653
|
+
* @version 219.0.0
|
|
22509
22654
|
*/
|
|
22510
22655
|
|
|
22511
22656
|
/**
|
|
@@ -22675,7 +22820,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22675
22820
|
/**
|
|
22676
22821
|
* Downloads service.
|
|
22677
22822
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22678
|
-
* @version
|
|
22823
|
+
* @version 219.0.0
|
|
22679
22824
|
*/
|
|
22680
22825
|
|
|
22681
22826
|
/**
|
|
@@ -22727,7 +22872,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22727
22872
|
/**
|
|
22728
22873
|
* Emails service.
|
|
22729
22874
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22730
|
-
* @version
|
|
22875
|
+
* @version 219.0.0
|
|
22731
22876
|
*/
|
|
22732
22877
|
|
|
22733
22878
|
/**
|
|
@@ -22742,6 +22887,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22742
22887
|
}
|
|
22743
22888
|
|
|
22744
22889
|
|
|
22890
|
+
/**
|
|
22891
|
+
* Reset email threading settings to default
|
|
22892
|
+
*
|
|
22893
|
+
*/
|
|
22894
|
+
deleteEmailsSettingsThreading() {
|
|
22895
|
+
|
|
22896
|
+
return this.apiClient.callApi(
|
|
22897
|
+
'/api/v2/emails/settings/threading',
|
|
22898
|
+
'DELETE',
|
|
22899
|
+
{ },
|
|
22900
|
+
{ },
|
|
22901
|
+
{ },
|
|
22902
|
+
{ },
|
|
22903
|
+
null,
|
|
22904
|
+
['PureCloud OAuth'],
|
|
22905
|
+
['application/json'],
|
|
22906
|
+
['application/json']
|
|
22907
|
+
);
|
|
22908
|
+
}
|
|
22909
|
+
|
|
22745
22910
|
/**
|
|
22746
22911
|
* Get email Contact Center settings
|
|
22747
22912
|
*
|
|
@@ -22762,6 +22927,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22762
22927
|
);
|
|
22763
22928
|
}
|
|
22764
22929
|
|
|
22930
|
+
/**
|
|
22931
|
+
* Get email threading settings
|
|
22932
|
+
*
|
|
22933
|
+
*/
|
|
22934
|
+
getEmailsSettingsThreading() {
|
|
22935
|
+
|
|
22936
|
+
return this.apiClient.callApi(
|
|
22937
|
+
'/api/v2/emails/settings/threading',
|
|
22938
|
+
'GET',
|
|
22939
|
+
{ },
|
|
22940
|
+
{ },
|
|
22941
|
+
{ },
|
|
22942
|
+
{ },
|
|
22943
|
+
null,
|
|
22944
|
+
['PureCloud OAuth'],
|
|
22945
|
+
['application/json'],
|
|
22946
|
+
['application/json']
|
|
22947
|
+
);
|
|
22948
|
+
}
|
|
22949
|
+
|
|
22765
22950
|
/**
|
|
22766
22951
|
* Patch email Contact Center settings
|
|
22767
22952
|
*
|
|
@@ -22786,13 +22971,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22786
22971
|
);
|
|
22787
22972
|
}
|
|
22788
22973
|
|
|
22974
|
+
/**
|
|
22975
|
+
* Patch email threading settings
|
|
22976
|
+
*
|
|
22977
|
+
* @param {Object} opts Optional parameters
|
|
22978
|
+
* @param {Object} opts.body
|
|
22979
|
+
*/
|
|
22980
|
+
patchEmailsSettingsThreading(opts) {
|
|
22981
|
+
opts = opts || {};
|
|
22982
|
+
|
|
22983
|
+
|
|
22984
|
+
return this.apiClient.callApi(
|
|
22985
|
+
'/api/v2/emails/settings/threading',
|
|
22986
|
+
'PATCH',
|
|
22987
|
+
{ },
|
|
22988
|
+
{ },
|
|
22989
|
+
{ },
|
|
22990
|
+
{ },
|
|
22991
|
+
opts['body'],
|
|
22992
|
+
['PureCloud OAuth'],
|
|
22993
|
+
['application/json'],
|
|
22994
|
+
['application/json']
|
|
22995
|
+
);
|
|
22996
|
+
}
|
|
22997
|
+
|
|
22789
22998
|
}
|
|
22790
22999
|
|
|
22791
23000
|
class EmployeeEngagementApi {
|
|
22792
23001
|
/**
|
|
22793
23002
|
* EmployeeEngagement service.
|
|
22794
23003
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22795
|
-
* @version
|
|
23004
|
+
* @version 219.0.0
|
|
22796
23005
|
*/
|
|
22797
23006
|
|
|
22798
23007
|
/**
|
|
@@ -22943,7 +23152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22943
23152
|
/**
|
|
22944
23153
|
* Events service.
|
|
22945
23154
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22946
|
-
* @version
|
|
23155
|
+
* @version 219.0.0
|
|
22947
23156
|
*/
|
|
22948
23157
|
|
|
22949
23158
|
/**
|
|
@@ -23039,7 +23248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23039
23248
|
/**
|
|
23040
23249
|
* ExternalContacts service.
|
|
23041
23250
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23042
|
-
* @version
|
|
23251
|
+
* @version 219.0.0
|
|
23043
23252
|
*/
|
|
23044
23253
|
|
|
23045
23254
|
/**
|
|
@@ -23674,6 +23883,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23674
23883
|
);
|
|
23675
23884
|
}
|
|
23676
23885
|
|
|
23886
|
+
/**
|
|
23887
|
+
* Get the core types from which all schemas are built.
|
|
23888
|
+
*
|
|
23889
|
+
* @param {String} coreTypeName Name of the core type
|
|
23890
|
+
*/
|
|
23891
|
+
getExternalcontactsContactsSchemasCoretype(coreTypeName) {
|
|
23892
|
+
// verify the required parameter 'coreTypeName' is set
|
|
23893
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
23894
|
+
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsContactsSchemasCoretype';
|
|
23895
|
+
}
|
|
23896
|
+
|
|
23897
|
+
return this.apiClient.callApi(
|
|
23898
|
+
'/api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}',
|
|
23899
|
+
'GET',
|
|
23900
|
+
{ 'coreTypeName': coreTypeName },
|
|
23901
|
+
{ },
|
|
23902
|
+
{ },
|
|
23903
|
+
{ },
|
|
23904
|
+
null,
|
|
23905
|
+
['PureCloud OAuth'],
|
|
23906
|
+
['application/json'],
|
|
23907
|
+
['application/json']
|
|
23908
|
+
);
|
|
23909
|
+
}
|
|
23910
|
+
|
|
23911
|
+
/**
|
|
23912
|
+
* Get the core types from which all schemas are built.
|
|
23913
|
+
*
|
|
23914
|
+
*/
|
|
23915
|
+
getExternalcontactsContactsSchemasCoretypes() {
|
|
23916
|
+
|
|
23917
|
+
return this.apiClient.callApi(
|
|
23918
|
+
'/api/v2/externalcontacts/contacts/schemas/coretypes',
|
|
23919
|
+
'GET',
|
|
23920
|
+
{ },
|
|
23921
|
+
{ },
|
|
23922
|
+
{ },
|
|
23923
|
+
{ },
|
|
23924
|
+
null,
|
|
23925
|
+
['PureCloud OAuth'],
|
|
23926
|
+
['application/json'],
|
|
23927
|
+
['application/json']
|
|
23928
|
+
);
|
|
23929
|
+
}
|
|
23930
|
+
|
|
23931
|
+
/**
|
|
23932
|
+
* Get quantitative limits on schemas
|
|
23933
|
+
*
|
|
23934
|
+
*/
|
|
23935
|
+
getExternalcontactsContactsSchemasLimits() {
|
|
23936
|
+
|
|
23937
|
+
return this.apiClient.callApi(
|
|
23938
|
+
'/api/v2/externalcontacts/contacts/schemas/limits',
|
|
23939
|
+
'GET',
|
|
23940
|
+
{ },
|
|
23941
|
+
{ },
|
|
23942
|
+
{ },
|
|
23943
|
+
{ },
|
|
23944
|
+
null,
|
|
23945
|
+
['PureCloud OAuth'],
|
|
23946
|
+
['application/json'],
|
|
23947
|
+
['application/json']
|
|
23948
|
+
);
|
|
23949
|
+
}
|
|
23950
|
+
|
|
23677
23951
|
/**
|
|
23678
23952
|
* Fetch an External Source
|
|
23679
23953
|
*
|
|
@@ -23999,6 +24273,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23999
24273
|
);
|
|
24000
24274
|
}
|
|
24001
24275
|
|
|
24276
|
+
/**
|
|
24277
|
+
* List the identifiers for an external organization
|
|
24278
|
+
*
|
|
24279
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
24280
|
+
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24281
|
+
*/
|
|
24282
|
+
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
24283
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
24284
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null) {
|
|
24285
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationIdentifiers';
|
|
24286
|
+
}
|
|
24287
|
+
|
|
24288
|
+
return this.apiClient.callApi(
|
|
24289
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
|
|
24290
|
+
'GET',
|
|
24291
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
24292
|
+
{ },
|
|
24293
|
+
{ },
|
|
24294
|
+
{ },
|
|
24295
|
+
null,
|
|
24296
|
+
['PureCloud OAuth'],
|
|
24297
|
+
['application/json'],
|
|
24298
|
+
['application/json']
|
|
24299
|
+
);
|
|
24300
|
+
}
|
|
24301
|
+
|
|
24002
24302
|
/**
|
|
24003
24303
|
* Fetch a note for an external organization
|
|
24004
24304
|
*
|
|
@@ -24228,6 +24528,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24228
24528
|
);
|
|
24229
24529
|
}
|
|
24230
24530
|
|
|
24531
|
+
/**
|
|
24532
|
+
* Get the core types from which all schemas are built.
|
|
24533
|
+
*
|
|
24534
|
+
* @param {String} coreTypeName Name of the core type
|
|
24535
|
+
*/
|
|
24536
|
+
getExternalcontactsOrganizationsSchemasCoretype(coreTypeName) {
|
|
24537
|
+
// verify the required parameter 'coreTypeName' is set
|
|
24538
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
24539
|
+
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsOrganizationsSchemasCoretype';
|
|
24540
|
+
}
|
|
24541
|
+
|
|
24542
|
+
return this.apiClient.callApi(
|
|
24543
|
+
'/api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}',
|
|
24544
|
+
'GET',
|
|
24545
|
+
{ 'coreTypeName': coreTypeName },
|
|
24546
|
+
{ },
|
|
24547
|
+
{ },
|
|
24548
|
+
{ },
|
|
24549
|
+
null,
|
|
24550
|
+
['PureCloud OAuth'],
|
|
24551
|
+
['application/json'],
|
|
24552
|
+
['application/json']
|
|
24553
|
+
);
|
|
24554
|
+
}
|
|
24555
|
+
|
|
24556
|
+
/**
|
|
24557
|
+
* Get the core types from which all schemas are built.
|
|
24558
|
+
*
|
|
24559
|
+
*/
|
|
24560
|
+
getExternalcontactsOrganizationsSchemasCoretypes() {
|
|
24561
|
+
|
|
24562
|
+
return this.apiClient.callApi(
|
|
24563
|
+
'/api/v2/externalcontacts/organizations/schemas/coretypes',
|
|
24564
|
+
'GET',
|
|
24565
|
+
{ },
|
|
24566
|
+
{ },
|
|
24567
|
+
{ },
|
|
24568
|
+
{ },
|
|
24569
|
+
null,
|
|
24570
|
+
['PureCloud OAuth'],
|
|
24571
|
+
['application/json'],
|
|
24572
|
+
['application/json']
|
|
24573
|
+
);
|
|
24574
|
+
}
|
|
24575
|
+
|
|
24576
|
+
/**
|
|
24577
|
+
* Get quantitative limits on schemas
|
|
24578
|
+
*
|
|
24579
|
+
*/
|
|
24580
|
+
getExternalcontactsOrganizationsSchemasLimits() {
|
|
24581
|
+
|
|
24582
|
+
return this.apiClient.callApi(
|
|
24583
|
+
'/api/v2/externalcontacts/organizations/schemas/limits',
|
|
24584
|
+
'GET',
|
|
24585
|
+
{ },
|
|
24586
|
+
{ },
|
|
24587
|
+
{ },
|
|
24588
|
+
{ },
|
|
24589
|
+
null,
|
|
24590
|
+
['PureCloud OAuth'],
|
|
24591
|
+
['application/json'],
|
|
24592
|
+
['application/json']
|
|
24593
|
+
);
|
|
24594
|
+
}
|
|
24595
|
+
|
|
24231
24596
|
/**
|
|
24232
24597
|
* Fetch a relationship
|
|
24233
24598
|
*
|
|
@@ -24525,6 +24890,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24525
24890
|
);
|
|
24526
24891
|
}
|
|
24527
24892
|
|
|
24893
|
+
/**
|
|
24894
|
+
* Claim or release identifiers for an external organization
|
|
24895
|
+
*
|
|
24896
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
24897
|
+
* @param {Object} body ClaimRequest
|
|
24898
|
+
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24899
|
+
*/
|
|
24900
|
+
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
24901
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
24902
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null) {
|
|
24903
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
24904
|
+
}
|
|
24905
|
+
// verify the required parameter 'body' is set
|
|
24906
|
+
if (body === undefined || body === null) {
|
|
24907
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
24908
|
+
}
|
|
24909
|
+
|
|
24910
|
+
return this.apiClient.callApi(
|
|
24911
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
|
|
24912
|
+
'PATCH',
|
|
24913
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
24914
|
+
{ },
|
|
24915
|
+
{ },
|
|
24916
|
+
{ },
|
|
24917
|
+
body,
|
|
24918
|
+
['PureCloud OAuth'],
|
|
24919
|
+
['application/json'],
|
|
24920
|
+
['application/json']
|
|
24921
|
+
);
|
|
24922
|
+
}
|
|
24923
|
+
|
|
24528
24924
|
/**
|
|
24529
24925
|
* Bulk fetch contacts
|
|
24530
24926
|
*
|
|
@@ -24601,6 +24997,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24601
24997
|
);
|
|
24602
24998
|
}
|
|
24603
24999
|
|
|
25000
|
+
/**
|
|
25001
|
+
* Bulk Enrich Contacts - Run up to 10 Enrich operations per request
|
|
25002
|
+
* See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
|
|
25003
|
+
* @param {Object} body Contact Enrich Requests
|
|
25004
|
+
* @param {Object} opts Optional parameters
|
|
25005
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25006
|
+
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25007
|
+
*/
|
|
25008
|
+
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
25009
|
+
opts = opts || {};
|
|
25010
|
+
|
|
25011
|
+
// verify the required parameter 'body' is set
|
|
25012
|
+
if (body === undefined || body === null) {
|
|
25013
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsEnrich';
|
|
25014
|
+
}
|
|
25015
|
+
|
|
25016
|
+
return this.apiClient.callApi(
|
|
25017
|
+
'/api/v2/externalcontacts/bulk/contacts/enrich',
|
|
25018
|
+
'POST',
|
|
25019
|
+
{ },
|
|
25020
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25021
|
+
{ },
|
|
25022
|
+
{ },
|
|
25023
|
+
body,
|
|
25024
|
+
['PureCloud OAuth'],
|
|
25025
|
+
['application/json'],
|
|
25026
|
+
['application/json']
|
|
25027
|
+
);
|
|
25028
|
+
}
|
|
25029
|
+
|
|
24604
25030
|
/**
|
|
24605
25031
|
* Bulk remove contacts
|
|
24606
25032
|
*
|
|
@@ -24852,6 +25278,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24852
25278
|
);
|
|
24853
25279
|
}
|
|
24854
25280
|
|
|
25281
|
+
/**
|
|
25282
|
+
* Bulk enrich external organizations - Run up to 10 Enrich operations per request
|
|
25283
|
+
* See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
|
|
25284
|
+
* @param {Object} body External Organization Enrich Requests
|
|
25285
|
+
* @param {Object} opts Optional parameters
|
|
25286
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25287
|
+
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25288
|
+
*/
|
|
25289
|
+
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
25290
|
+
opts = opts || {};
|
|
25291
|
+
|
|
25292
|
+
// verify the required parameter 'body' is set
|
|
25293
|
+
if (body === undefined || body === null) {
|
|
25294
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsEnrich';
|
|
25295
|
+
}
|
|
25296
|
+
|
|
25297
|
+
return this.apiClient.callApi(
|
|
25298
|
+
'/api/v2/externalcontacts/bulk/organizations/enrich',
|
|
25299
|
+
'POST',
|
|
25300
|
+
{ },
|
|
25301
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25302
|
+
{ },
|
|
25303
|
+
{ },
|
|
25304
|
+
body,
|
|
25305
|
+
['PureCloud OAuth'],
|
|
25306
|
+
['application/json'],
|
|
25307
|
+
['application/json']
|
|
25308
|
+
);
|
|
25309
|
+
}
|
|
25310
|
+
|
|
24855
25311
|
/**
|
|
24856
25312
|
* Bulk remove organizations
|
|
24857
25313
|
*
|
|
@@ -25082,6 +25538,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25082
25538
|
);
|
|
25083
25539
|
}
|
|
25084
25540
|
|
|
25541
|
+
/**
|
|
25542
|
+
* Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
|
|
25543
|
+
* You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
|
|
25544
|
+
* @param {Object} body ContactEnrichRequest
|
|
25545
|
+
* @param {Object} opts Optional parameters
|
|
25546
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25547
|
+
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25548
|
+
*/
|
|
25549
|
+
postExternalcontactsContactsEnrich(body, opts) {
|
|
25550
|
+
opts = opts || {};
|
|
25551
|
+
|
|
25552
|
+
// verify the required parameter 'body' is set
|
|
25553
|
+
if (body === undefined || body === null) {
|
|
25554
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsEnrich';
|
|
25555
|
+
}
|
|
25556
|
+
|
|
25557
|
+
return this.apiClient.callApi(
|
|
25558
|
+
'/api/v2/externalcontacts/contacts/enrich',
|
|
25559
|
+
'POST',
|
|
25560
|
+
{ },
|
|
25561
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25562
|
+
{ },
|
|
25563
|
+
{ },
|
|
25564
|
+
body,
|
|
25565
|
+
['PureCloud OAuth'],
|
|
25566
|
+
['application/json'],
|
|
25567
|
+
['application/json']
|
|
25568
|
+
);
|
|
25569
|
+
}
|
|
25570
|
+
|
|
25085
25571
|
/**
|
|
25086
25572
|
* Create bulk export
|
|
25087
25573
|
*
|
|
@@ -25107,6 +25593,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25107
25593
|
);
|
|
25108
25594
|
}
|
|
25109
25595
|
|
|
25596
|
+
/**
|
|
25597
|
+
* Merge up to 25 contacts into a new contact record
|
|
25598
|
+
* Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
|
|
25599
|
+
* @param {Object} body MergeRequest
|
|
25600
|
+
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25601
|
+
*/
|
|
25602
|
+
postExternalcontactsContactsMerge(body) {
|
|
25603
|
+
// verify the required parameter 'body' is set
|
|
25604
|
+
if (body === undefined || body === null) {
|
|
25605
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsMerge';
|
|
25606
|
+
}
|
|
25607
|
+
|
|
25608
|
+
return this.apiClient.callApi(
|
|
25609
|
+
'/api/v2/externalcontacts/contacts/merge',
|
|
25610
|
+
'POST',
|
|
25611
|
+
{ },
|
|
25612
|
+
{ },
|
|
25613
|
+
{ },
|
|
25614
|
+
{ },
|
|
25615
|
+
body,
|
|
25616
|
+
['PureCloud OAuth'],
|
|
25617
|
+
['application/json'],
|
|
25618
|
+
['application/json']
|
|
25619
|
+
);
|
|
25620
|
+
}
|
|
25621
|
+
|
|
25110
25622
|
/**
|
|
25111
25623
|
* Create a schema
|
|
25112
25624
|
*
|
|
@@ -25187,6 +25699,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25187
25699
|
);
|
|
25188
25700
|
}
|
|
25189
25701
|
|
|
25702
|
+
/**
|
|
25703
|
+
* Fetch a contact using an identifier type and value.
|
|
25704
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
25705
|
+
* @param {Object} identifier
|
|
25706
|
+
* @param {Object} opts Optional parameters
|
|
25707
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25708
|
+
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25709
|
+
*/
|
|
25710
|
+
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
25711
|
+
opts = opts || {};
|
|
25712
|
+
|
|
25713
|
+
// verify the required parameter 'identifier' is set
|
|
25714
|
+
if (identifier === undefined || identifier === null) {
|
|
25715
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupContacts';
|
|
25716
|
+
}
|
|
25717
|
+
|
|
25718
|
+
return this.apiClient.callApi(
|
|
25719
|
+
'/api/v2/externalcontacts/identifierlookup/contacts',
|
|
25720
|
+
'POST',
|
|
25721
|
+
{ },
|
|
25722
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25723
|
+
{ },
|
|
25724
|
+
{ },
|
|
25725
|
+
identifier,
|
|
25726
|
+
['PureCloud OAuth'],
|
|
25727
|
+
['application/json'],
|
|
25728
|
+
['application/json']
|
|
25729
|
+
);
|
|
25730
|
+
}
|
|
25731
|
+
|
|
25732
|
+
/**
|
|
25733
|
+
* Fetch an external organization using an identifier type and value.
|
|
25734
|
+
* This endpoint will only accept ExternalId type identifiers.
|
|
25735
|
+
* @param {Object} identifier
|
|
25736
|
+
* @param {Object} opts Optional parameters
|
|
25737
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25738
|
+
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25739
|
+
*/
|
|
25740
|
+
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
25741
|
+
opts = opts || {};
|
|
25742
|
+
|
|
25743
|
+
// verify the required parameter 'identifier' is set
|
|
25744
|
+
if (identifier === undefined || identifier === null) {
|
|
25745
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupOrganizations';
|
|
25746
|
+
}
|
|
25747
|
+
|
|
25748
|
+
return this.apiClient.callApi(
|
|
25749
|
+
'/api/v2/externalcontacts/identifierlookup/organizations',
|
|
25750
|
+
'POST',
|
|
25751
|
+
{ },
|
|
25752
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25753
|
+
{ },
|
|
25754
|
+
{ },
|
|
25755
|
+
identifier,
|
|
25756
|
+
['PureCloud OAuth'],
|
|
25757
|
+
['application/json'],
|
|
25758
|
+
['application/json']
|
|
25759
|
+
);
|
|
25760
|
+
}
|
|
25761
|
+
|
|
25190
25762
|
/**
|
|
25191
25763
|
* Create CSV import job
|
|
25192
25764
|
*
|
|
@@ -25314,8 +25886,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25314
25886
|
|
|
25315
25887
|
/**
|
|
25316
25888
|
* Merge two contacts into a new contact record
|
|
25317
|
-
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
25889
|
+
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
|
|
25318
25890
|
* @param {Object} body MergeRequest
|
|
25891
|
+
* @deprecated
|
|
25319
25892
|
*/
|
|
25320
25893
|
postExternalcontactsMergeContacts(body) {
|
|
25321
25894
|
// verify the required parameter 'body' is set
|
|
@@ -25392,6 +25965,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25392
25965
|
);
|
|
25393
25966
|
}
|
|
25394
25967
|
|
|
25968
|
+
/**
|
|
25969
|
+
* Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
|
|
25970
|
+
* You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
|
|
25971
|
+
* @param {Object} body ExternalOrgEnrichRequest
|
|
25972
|
+
* @param {Object} opts Optional parameters
|
|
25973
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25974
|
+
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25975
|
+
*/
|
|
25976
|
+
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
25977
|
+
opts = opts || {};
|
|
25978
|
+
|
|
25979
|
+
// verify the required parameter 'body' is set
|
|
25980
|
+
if (body === undefined || body === null) {
|
|
25981
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsOrganizationsEnrich';
|
|
25982
|
+
}
|
|
25983
|
+
|
|
25984
|
+
return this.apiClient.callApi(
|
|
25985
|
+
'/api/v2/externalcontacts/organizations/enrich',
|
|
25986
|
+
'POST',
|
|
25987
|
+
{ },
|
|
25988
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25989
|
+
{ },
|
|
25990
|
+
{ },
|
|
25991
|
+
body,
|
|
25992
|
+
['PureCloud OAuth'],
|
|
25993
|
+
['application/json'],
|
|
25994
|
+
['application/json']
|
|
25995
|
+
);
|
|
25996
|
+
}
|
|
25997
|
+
|
|
25395
25998
|
/**
|
|
25396
25999
|
* Create a schema
|
|
25397
26000
|
*
|
|
@@ -25848,7 +26451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25848
26451
|
/**
|
|
25849
26452
|
* Fax service.
|
|
25850
26453
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25851
|
-
* @version
|
|
26454
|
+
* @version 219.0.0
|
|
25852
26455
|
*/
|
|
25853
26456
|
|
|
25854
26457
|
/**
|
|
@@ -26063,7 +26666,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26063
26666
|
/**
|
|
26064
26667
|
* Flows service.
|
|
26065
26668
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
26066
|
-
* @version
|
|
26669
|
+
* @version 219.0.0
|
|
26067
26670
|
*/
|
|
26068
26671
|
|
|
26069
26672
|
/**
|
|
@@ -26246,7 +26849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26246
26849
|
/**
|
|
26247
26850
|
* Gamification service.
|
|
26248
26851
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
26249
|
-
* @version
|
|
26852
|
+
* @version 219.0.0
|
|
26250
26853
|
*/
|
|
26251
26854
|
|
|
26252
26855
|
/**
|
|
@@ -26286,6 +26889,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26286
26889
|
);
|
|
26287
26890
|
}
|
|
26288
26891
|
|
|
26892
|
+
/**
|
|
26893
|
+
* Delete a Contest by Id
|
|
26894
|
+
*
|
|
26895
|
+
* @param {String} contestId The ID of the contest
|
|
26896
|
+
*/
|
|
26897
|
+
deleteGamificationContest(contestId) {
|
|
26898
|
+
// verify the required parameter 'contestId' is set
|
|
26899
|
+
if (contestId === undefined || contestId === null) {
|
|
26900
|
+
throw 'Missing the required parameter "contestId" when calling deleteGamificationContest';
|
|
26901
|
+
}
|
|
26902
|
+
|
|
26903
|
+
return this.apiClient.callApi(
|
|
26904
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
26905
|
+
'DELETE',
|
|
26906
|
+
{ 'contestId': contestId },
|
|
26907
|
+
{ },
|
|
26908
|
+
{ },
|
|
26909
|
+
{ },
|
|
26910
|
+
null,
|
|
26911
|
+
['PureCloud OAuth'],
|
|
26912
|
+
['application/json'],
|
|
26913
|
+
['application/json']
|
|
26914
|
+
);
|
|
26915
|
+
}
|
|
26916
|
+
|
|
26289
26917
|
/**
|
|
26290
26918
|
* Get an External Metric Definition
|
|
26291
26919
|
*
|
|
@@ -26336,6 +26964,236 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26336
26964
|
);
|
|
26337
26965
|
}
|
|
26338
26966
|
|
|
26967
|
+
/**
|
|
26968
|
+
* Get a Contest by Id
|
|
26969
|
+
*
|
|
26970
|
+
* @param {String} contestId The ID of the contest
|
|
26971
|
+
*/
|
|
26972
|
+
getGamificationContest(contestId) {
|
|
26973
|
+
// verify the required parameter 'contestId' is set
|
|
26974
|
+
if (contestId === undefined || contestId === null) {
|
|
26975
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContest';
|
|
26976
|
+
}
|
|
26977
|
+
|
|
26978
|
+
return this.apiClient.callApi(
|
|
26979
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
26980
|
+
'GET',
|
|
26981
|
+
{ 'contestId': contestId },
|
|
26982
|
+
{ },
|
|
26983
|
+
{ },
|
|
26984
|
+
{ },
|
|
26985
|
+
null,
|
|
26986
|
+
['PureCloud OAuth'],
|
|
26987
|
+
['application/json'],
|
|
26988
|
+
['application/json']
|
|
26989
|
+
);
|
|
26990
|
+
}
|
|
26991
|
+
|
|
26992
|
+
/**
|
|
26993
|
+
* Get Contest Scores (Admin)
|
|
26994
|
+
*
|
|
26995
|
+
* @param {String} contestId The ID of the contest
|
|
26996
|
+
* @param {Object} opts Optional parameters
|
|
26997
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
26998
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
26999
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27000
|
+
* @param {Object} opts.returnsView Desired response results (default to All)
|
|
27001
|
+
*/
|
|
27002
|
+
getGamificationContestAgentsScores(contestId, opts) {
|
|
27003
|
+
opts = opts || {};
|
|
27004
|
+
|
|
27005
|
+
// verify the required parameter 'contestId' is set
|
|
27006
|
+
if (contestId === undefined || contestId === null) {
|
|
27007
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScores';
|
|
27008
|
+
}
|
|
27009
|
+
|
|
27010
|
+
return this.apiClient.callApi(
|
|
27011
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores',
|
|
27012
|
+
'GET',
|
|
27013
|
+
{ 'contestId': contestId },
|
|
27014
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
|
|
27015
|
+
{ },
|
|
27016
|
+
{ },
|
|
27017
|
+
null,
|
|
27018
|
+
['PureCloud OAuth'],
|
|
27019
|
+
['application/json'],
|
|
27020
|
+
['application/json']
|
|
27021
|
+
);
|
|
27022
|
+
}
|
|
27023
|
+
|
|
27024
|
+
/**
|
|
27025
|
+
* Get Contest Scores for the requesting Agent/Supervisor
|
|
27026
|
+
*
|
|
27027
|
+
* @param {String} contestId The ID of the contest
|
|
27028
|
+
* @param {Object} opts Optional parameters
|
|
27029
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27030
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27031
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27032
|
+
* @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
|
|
27033
|
+
*/
|
|
27034
|
+
getGamificationContestAgentsScoresMe(contestId, opts) {
|
|
27035
|
+
opts = opts || {};
|
|
27036
|
+
|
|
27037
|
+
// verify the required parameter 'contestId' is set
|
|
27038
|
+
if (contestId === undefined || contestId === null) {
|
|
27039
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresMe';
|
|
27040
|
+
}
|
|
27041
|
+
|
|
27042
|
+
return this.apiClient.callApi(
|
|
27043
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/me',
|
|
27044
|
+
'GET',
|
|
27045
|
+
{ 'contestId': contestId },
|
|
27046
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
|
|
27047
|
+
{ },
|
|
27048
|
+
{ },
|
|
27049
|
+
null,
|
|
27050
|
+
['PureCloud OAuth'],
|
|
27051
|
+
['application/json'],
|
|
27052
|
+
['application/json']
|
|
27053
|
+
);
|
|
27054
|
+
}
|
|
27055
|
+
|
|
27056
|
+
/**
|
|
27057
|
+
* Get a Contest Score Trend (Average Trend)
|
|
27058
|
+
*
|
|
27059
|
+
* @param {String} contestId The ID of the contest
|
|
27060
|
+
*/
|
|
27061
|
+
getGamificationContestAgentsScoresTrends(contestId) {
|
|
27062
|
+
// verify the required parameter 'contestId' is set
|
|
27063
|
+
if (contestId === undefined || contestId === null) {
|
|
27064
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';
|
|
27065
|
+
}
|
|
27066
|
+
|
|
27067
|
+
return this.apiClient.callApi(
|
|
27068
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/trends',
|
|
27069
|
+
'GET',
|
|
27070
|
+
{ 'contestId': contestId },
|
|
27071
|
+
{ },
|
|
27072
|
+
{ },
|
|
27073
|
+
{ },
|
|
27074
|
+
null,
|
|
27075
|
+
['PureCloud OAuth'],
|
|
27076
|
+
['application/json'],
|
|
27077
|
+
['application/json']
|
|
27078
|
+
);
|
|
27079
|
+
}
|
|
27080
|
+
|
|
27081
|
+
/**
|
|
27082
|
+
* Get a Contest Score Trend for the requesting Agent
|
|
27083
|
+
*
|
|
27084
|
+
* @param {String} contestId The ID of the contest
|
|
27085
|
+
*/
|
|
27086
|
+
getGamificationContestAgentsScoresTrendsMe(contestId) {
|
|
27087
|
+
// verify the required parameter 'contestId' is set
|
|
27088
|
+
if (contestId === undefined || contestId === null) {
|
|
27089
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';
|
|
27090
|
+
}
|
|
27091
|
+
|
|
27092
|
+
return this.apiClient.callApi(
|
|
27093
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/trends/me',
|
|
27094
|
+
'GET',
|
|
27095
|
+
{ 'contestId': contestId },
|
|
27096
|
+
{ },
|
|
27097
|
+
{ },
|
|
27098
|
+
{ },
|
|
27099
|
+
null,
|
|
27100
|
+
['PureCloud OAuth'],
|
|
27101
|
+
['application/json'],
|
|
27102
|
+
['application/json']
|
|
27103
|
+
);
|
|
27104
|
+
}
|
|
27105
|
+
|
|
27106
|
+
/**
|
|
27107
|
+
* Get a Contest Prize Image by Id
|
|
27108
|
+
*
|
|
27109
|
+
* @param {String} contestId The ID of the contest
|
|
27110
|
+
* @param {String} prizeImageId The ID of the prize image
|
|
27111
|
+
*/
|
|
27112
|
+
getGamificationContestPrizeimage(contestId, prizeImageId) {
|
|
27113
|
+
// verify the required parameter 'contestId' is set
|
|
27114
|
+
if (contestId === undefined || contestId === null) {
|
|
27115
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';
|
|
27116
|
+
}
|
|
27117
|
+
// verify the required parameter 'prizeImageId' is set
|
|
27118
|
+
if (prizeImageId === undefined || prizeImageId === null) {
|
|
27119
|
+
throw 'Missing the required parameter "prizeImageId" when calling getGamificationContestPrizeimage';
|
|
27120
|
+
}
|
|
27121
|
+
|
|
27122
|
+
return this.apiClient.callApi(
|
|
27123
|
+
'/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}',
|
|
27124
|
+
'GET',
|
|
27125
|
+
{ 'contestId': contestId,'prizeImageId': prizeImageId },
|
|
27126
|
+
{ },
|
|
27127
|
+
{ },
|
|
27128
|
+
{ },
|
|
27129
|
+
null,
|
|
27130
|
+
['PureCloud OAuth'],
|
|
27131
|
+
['application/json'],
|
|
27132
|
+
['application/json']
|
|
27133
|
+
);
|
|
27134
|
+
}
|
|
27135
|
+
|
|
27136
|
+
/**
|
|
27137
|
+
* Get a List of Contests (Admin)
|
|
27138
|
+
*
|
|
27139
|
+
* @param {Object} opts Optional parameters
|
|
27140
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27141
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27142
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27143
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27144
|
+
* @param {Array.<String>} opts.status
|
|
27145
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
27146
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
27147
|
+
*/
|
|
27148
|
+
getGamificationContests(opts) {
|
|
27149
|
+
opts = opts || {};
|
|
27150
|
+
|
|
27151
|
+
|
|
27152
|
+
return this.apiClient.callApi(
|
|
27153
|
+
'/api/v2/gamification/contests',
|
|
27154
|
+
'GET',
|
|
27155
|
+
{ },
|
|
27156
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
27157
|
+
{ },
|
|
27158
|
+
{ },
|
|
27159
|
+
null,
|
|
27160
|
+
['PureCloud OAuth'],
|
|
27161
|
+
['application/json'],
|
|
27162
|
+
['application/json']
|
|
27163
|
+
);
|
|
27164
|
+
}
|
|
27165
|
+
|
|
27166
|
+
/**
|
|
27167
|
+
* Get a List of Contests (Agent/Supervisor)
|
|
27168
|
+
*
|
|
27169
|
+
* @param {Object} opts Optional parameters
|
|
27170
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27171
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27172
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27173
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27174
|
+
* @param {Array.<String>} opts.status
|
|
27175
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
27176
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
27177
|
+
* @param {Object} opts.view (default to participant)
|
|
27178
|
+
*/
|
|
27179
|
+
getGamificationContestsMe(opts) {
|
|
27180
|
+
opts = opts || {};
|
|
27181
|
+
|
|
27182
|
+
|
|
27183
|
+
return this.apiClient.callApi(
|
|
27184
|
+
'/api/v2/gamification/contests/me',
|
|
27185
|
+
'GET',
|
|
27186
|
+
{ },
|
|
27187
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'view': opts['view'] },
|
|
27188
|
+
{ },
|
|
27189
|
+
{ },
|
|
27190
|
+
null,
|
|
27191
|
+
['PureCloud OAuth'],
|
|
27192
|
+
['application/json'],
|
|
27193
|
+
['application/json']
|
|
27194
|
+
);
|
|
27195
|
+
}
|
|
27196
|
+
|
|
26339
27197
|
/**
|
|
26340
27198
|
* Get insights summary
|
|
26341
27199
|
*
|
|
@@ -27986,6 +28844,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27986
28844
|
);
|
|
27987
28845
|
}
|
|
27988
28846
|
|
|
28847
|
+
/**
|
|
28848
|
+
* Finalize a Contest by Id
|
|
28849
|
+
*
|
|
28850
|
+
* @param {String} contestId The ID of the contest
|
|
28851
|
+
* @param {Object} body Finalize Contest
|
|
28852
|
+
*/
|
|
28853
|
+
patchGamificationContest(contestId, body) {
|
|
28854
|
+
// verify the required parameter 'contestId' is set
|
|
28855
|
+
if (contestId === undefined || contestId === null) {
|
|
28856
|
+
throw 'Missing the required parameter "contestId" when calling patchGamificationContest';
|
|
28857
|
+
}
|
|
28858
|
+
// verify the required parameter 'body' is set
|
|
28859
|
+
if (body === undefined || body === null) {
|
|
28860
|
+
throw 'Missing the required parameter "body" when calling patchGamificationContest';
|
|
28861
|
+
}
|
|
28862
|
+
|
|
28863
|
+
return this.apiClient.callApi(
|
|
28864
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
28865
|
+
'PATCH',
|
|
28866
|
+
{ 'contestId': contestId },
|
|
28867
|
+
{ },
|
|
28868
|
+
{ },
|
|
28869
|
+
{ },
|
|
28870
|
+
body,
|
|
28871
|
+
['PureCloud OAuth'],
|
|
28872
|
+
['application/json'],
|
|
28873
|
+
['application/json']
|
|
28874
|
+
);
|
|
28875
|
+
}
|
|
28876
|
+
|
|
27989
28877
|
/**
|
|
27990
28878
|
* Write External Metric Data
|
|
27991
28879
|
*
|
|
@@ -28034,6 +28922,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28034
28922
|
);
|
|
28035
28923
|
}
|
|
28036
28924
|
|
|
28925
|
+
/**
|
|
28926
|
+
* Creates a Contest
|
|
28927
|
+
*
|
|
28928
|
+
* @param {Object} body Create Contest
|
|
28929
|
+
*/
|
|
28930
|
+
postGamificationContests(body) {
|
|
28931
|
+
// verify the required parameter 'body' is set
|
|
28932
|
+
if (body === undefined || body === null) {
|
|
28933
|
+
throw 'Missing the required parameter "body" when calling postGamificationContests';
|
|
28934
|
+
}
|
|
28935
|
+
|
|
28936
|
+
return this.apiClient.callApi(
|
|
28937
|
+
'/api/v2/gamification/contests',
|
|
28938
|
+
'POST',
|
|
28939
|
+
{ },
|
|
28940
|
+
{ },
|
|
28941
|
+
{ },
|
|
28942
|
+
{ },
|
|
28943
|
+
body,
|
|
28944
|
+
['PureCloud OAuth'],
|
|
28945
|
+
['application/json'],
|
|
28946
|
+
['application/json']
|
|
28947
|
+
);
|
|
28948
|
+
}
|
|
28949
|
+
|
|
28950
|
+
/**
|
|
28951
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
28952
|
+
*
|
|
28953
|
+
* @param {Object} body query
|
|
28954
|
+
*/
|
|
28955
|
+
postGamificationContestsUploadsPrizeimages(body) {
|
|
28956
|
+
// verify the required parameter 'body' is set
|
|
28957
|
+
if (body === undefined || body === null) {
|
|
28958
|
+
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
28959
|
+
}
|
|
28960
|
+
|
|
28961
|
+
return this.apiClient.callApi(
|
|
28962
|
+
'/api/v2/gamification/contests/uploads/prizeimages',
|
|
28963
|
+
'POST',
|
|
28964
|
+
{ },
|
|
28965
|
+
{ },
|
|
28966
|
+
{ },
|
|
28967
|
+
{ },
|
|
28968
|
+
body,
|
|
28969
|
+
['PureCloud OAuth'],
|
|
28970
|
+
['application/json'],
|
|
28971
|
+
['application/json']
|
|
28972
|
+
);
|
|
28973
|
+
}
|
|
28974
|
+
|
|
28037
28975
|
/**
|
|
28038
28976
|
* Activate a performance profile
|
|
28039
28977
|
*
|
|
@@ -28293,6 +29231,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28293
29231
|
);
|
|
28294
29232
|
}
|
|
28295
29233
|
|
|
29234
|
+
/**
|
|
29235
|
+
* Update a Contest by Id
|
|
29236
|
+
*
|
|
29237
|
+
* @param {String} contestId The ID of the contest
|
|
29238
|
+
* @param {Object} body Contest
|
|
29239
|
+
*/
|
|
29240
|
+
putGamificationContest(contestId, body) {
|
|
29241
|
+
// verify the required parameter 'contestId' is set
|
|
29242
|
+
if (contestId === undefined || contestId === null) {
|
|
29243
|
+
throw 'Missing the required parameter "contestId" when calling putGamificationContest';
|
|
29244
|
+
}
|
|
29245
|
+
// verify the required parameter 'body' is set
|
|
29246
|
+
if (body === undefined || body === null) {
|
|
29247
|
+
throw 'Missing the required parameter "body" when calling putGamificationContest';
|
|
29248
|
+
}
|
|
29249
|
+
|
|
29250
|
+
return this.apiClient.callApi(
|
|
29251
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
29252
|
+
'PUT',
|
|
29253
|
+
{ 'contestId': contestId },
|
|
29254
|
+
{ },
|
|
29255
|
+
{ },
|
|
29256
|
+
{ },
|
|
29257
|
+
body,
|
|
29258
|
+
['PureCloud OAuth'],
|
|
29259
|
+
['application/json'],
|
|
29260
|
+
['application/json']
|
|
29261
|
+
);
|
|
29262
|
+
}
|
|
29263
|
+
|
|
28296
29264
|
/**
|
|
28297
29265
|
* Updates a performance profile
|
|
28298
29266
|
*
|
|
@@ -28388,7 +29356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28388
29356
|
/**
|
|
28389
29357
|
* GeneralDataProtectionRegulation service.
|
|
28390
29358
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
28391
|
-
* @version
|
|
29359
|
+
* @version 219.0.0
|
|
28392
29360
|
*/
|
|
28393
29361
|
|
|
28394
29362
|
/**
|
|
@@ -28518,7 +29486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28518
29486
|
/**
|
|
28519
29487
|
* Geolocation service.
|
|
28520
29488
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
28521
|
-
* @version
|
|
29489
|
+
* @version 219.0.0
|
|
28522
29490
|
*/
|
|
28523
29491
|
|
|
28524
29492
|
/**
|
|
@@ -28649,7 +29617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28649
29617
|
/**
|
|
28650
29618
|
* Greetings service.
|
|
28651
29619
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
28652
|
-
* @version
|
|
29620
|
+
* @version 219.0.0
|
|
28653
29621
|
*/
|
|
28654
29622
|
|
|
28655
29623
|
/**
|
|
@@ -29104,7 +30072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29104
30072
|
/**
|
|
29105
30073
|
* Groups service.
|
|
29106
30074
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
29107
|
-
* @version
|
|
30075
|
+
* @version 219.0.0
|
|
29108
30076
|
*/
|
|
29109
30077
|
|
|
29110
30078
|
/**
|
|
@@ -29623,7 +30591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29623
30591
|
/**
|
|
29624
30592
|
* IdentityProvider service.
|
|
29625
30593
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
29626
|
-
* @version
|
|
30594
|
+
* @version 219.0.0
|
|
29627
30595
|
*/
|
|
29628
30596
|
|
|
29629
30597
|
/**
|
|
@@ -30484,7 +31452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30484
31452
|
/**
|
|
30485
31453
|
* InfrastructureAsCode service.
|
|
30486
31454
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
30487
|
-
* @version
|
|
31455
|
+
* @version 219.0.0
|
|
30488
31456
|
*/
|
|
30489
31457
|
|
|
30490
31458
|
/**
|
|
@@ -30651,7 +31619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30651
31619
|
/**
|
|
30652
31620
|
* Integrations service.
|
|
30653
31621
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
30654
|
-
* @version
|
|
31622
|
+
* @version 219.0.0
|
|
30655
31623
|
*/
|
|
30656
31624
|
|
|
30657
31625
|
/**
|
|
@@ -32881,6 +33849,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32881
33849
|
);
|
|
32882
33850
|
}
|
|
32883
33851
|
|
|
33852
|
+
/**
|
|
33853
|
+
* Invoke Webhook
|
|
33854
|
+
*
|
|
33855
|
+
* @param {String} tokenId The token of the webhook to be invoked
|
|
33856
|
+
* @param {Object.<String, {String: Object}>} body Webhook Invocation Payload
|
|
33857
|
+
*/
|
|
33858
|
+
postIntegrationsWebhookEvents(tokenId, body) {
|
|
33859
|
+
// verify the required parameter 'tokenId' is set
|
|
33860
|
+
if (tokenId === undefined || tokenId === null) {
|
|
33861
|
+
throw 'Missing the required parameter "tokenId" when calling postIntegrationsWebhookEvents';
|
|
33862
|
+
}
|
|
33863
|
+
// verify the required parameter 'body' is set
|
|
33864
|
+
if (body === undefined || body === null) {
|
|
33865
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsWebhookEvents';
|
|
33866
|
+
}
|
|
33867
|
+
|
|
33868
|
+
return this.apiClient.callApi(
|
|
33869
|
+
'/api/v2/integrations/webhooks/{tokenId}/events',
|
|
33870
|
+
'POST',
|
|
33871
|
+
{ 'tokenId': tokenId },
|
|
33872
|
+
{ },
|
|
33873
|
+
{ },
|
|
33874
|
+
{ },
|
|
33875
|
+
body,
|
|
33876
|
+
['PureCloud OAuth'],
|
|
33877
|
+
['application/json'],
|
|
33878
|
+
['application/json']
|
|
33879
|
+
);
|
|
33880
|
+
}
|
|
33881
|
+
|
|
32884
33882
|
/**
|
|
32885
33883
|
* Update integration configuration.
|
|
32886
33884
|
*
|
|
@@ -33090,7 +34088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33090
34088
|
/**
|
|
33091
34089
|
* Journey service.
|
|
33092
34090
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
33093
|
-
* @version
|
|
34091
|
+
* @version 219.0.0
|
|
33094
34092
|
*/
|
|
33095
34093
|
|
|
33096
34094
|
/**
|
|
@@ -35075,7 +36073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35075
36073
|
/**
|
|
35076
36074
|
* Knowledge service.
|
|
35077
36075
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
35078
|
-
* @version
|
|
36076
|
+
* @version 219.0.0
|
|
35079
36077
|
*/
|
|
35080
36078
|
|
|
35081
36079
|
/**
|
|
@@ -38948,7 +39946,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38948
39946
|
/**
|
|
38949
39947
|
* LanguageUnderstanding service.
|
|
38950
39948
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38951
|
-
* @version
|
|
39949
|
+
* @version 219.0.0
|
|
38952
39950
|
*/
|
|
38953
39951
|
|
|
38954
39952
|
/**
|
|
@@ -39981,7 +40979,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39981
40979
|
/**
|
|
39982
40980
|
* Languages service.
|
|
39983
40981
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39984
|
-
* @version
|
|
40982
|
+
* @version 219.0.0
|
|
39985
40983
|
*/
|
|
39986
40984
|
|
|
39987
40985
|
/**
|
|
@@ -40203,7 +41201,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40203
41201
|
/**
|
|
40204
41202
|
* Learning service.
|
|
40205
41203
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
40206
|
-
* @version
|
|
41204
|
+
* @version 219.0.0
|
|
40207
41205
|
*/
|
|
40208
41206
|
|
|
40209
41207
|
/**
|
|
@@ -41232,7 +42230,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41232
42230
|
/**
|
|
41233
42231
|
* License service.
|
|
41234
42232
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
41235
|
-
* @version
|
|
42233
|
+
* @version 219.0.0
|
|
41236
42234
|
*/
|
|
41237
42235
|
|
|
41238
42236
|
/**
|
|
@@ -41470,7 +42468,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41470
42468
|
/**
|
|
41471
42469
|
* Locations service.
|
|
41472
42470
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41473
|
-
* @version
|
|
42471
|
+
* @version 219.0.0
|
|
41474
42472
|
*/
|
|
41475
42473
|
|
|
41476
42474
|
/**
|
|
@@ -41706,7 +42704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41706
42704
|
/**
|
|
41707
42705
|
* LogCapture service.
|
|
41708
42706
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
41709
|
-
* @version
|
|
42707
|
+
* @version 219.0.0
|
|
41710
42708
|
*/
|
|
41711
42709
|
|
|
41712
42710
|
/**
|
|
@@ -41906,7 +42904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41906
42904
|
/**
|
|
41907
42905
|
* Messaging service.
|
|
41908
42906
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
41909
|
-
* @version
|
|
42907
|
+
* @version 219.0.0
|
|
41910
42908
|
*/
|
|
41911
42909
|
|
|
41912
42910
|
/**
|
|
@@ -42265,7 +43263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42265
43263
|
/**
|
|
42266
43264
|
* MobileDevices service.
|
|
42267
43265
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
42268
|
-
* @version
|
|
43266
|
+
* @version 219.0.0
|
|
42269
43267
|
*/
|
|
42270
43268
|
|
|
42271
43269
|
/**
|
|
@@ -42416,7 +43414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42416
43414
|
/**
|
|
42417
43415
|
* Notifications service.
|
|
42418
43416
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
42419
|
-
* @version
|
|
43417
|
+
* @version 219.0.0
|
|
42420
43418
|
*/
|
|
42421
43419
|
|
|
42422
43420
|
/**
|
|
@@ -42649,7 +43647,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42649
43647
|
/**
|
|
42650
43648
|
* OAuth service.
|
|
42651
43649
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42652
|
-
* @version
|
|
43650
|
+
* @version 219.0.0
|
|
42653
43651
|
*/
|
|
42654
43652
|
|
|
42655
43653
|
/**
|
|
@@ -43015,7 +44013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43015
44013
|
/**
|
|
43016
44014
|
* Objects service.
|
|
43017
44015
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
43018
|
-
* @version
|
|
44016
|
+
* @version 219.0.0
|
|
43019
44017
|
*/
|
|
43020
44018
|
|
|
43021
44019
|
/**
|
|
@@ -43120,6 +44118,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43120
44118
|
);
|
|
43121
44119
|
}
|
|
43122
44120
|
|
|
44121
|
+
/**
|
|
44122
|
+
* Get a list of soft deleted divisions for the org
|
|
44123
|
+
*
|
|
44124
|
+
* @param {Object} opts Optional parameters
|
|
44125
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
44126
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44127
|
+
*/
|
|
44128
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
44129
|
+
opts = opts || {};
|
|
44130
|
+
|
|
44131
|
+
|
|
44132
|
+
return this.apiClient.callApi(
|
|
44133
|
+
'/api/v2/authorization/divisions/deleted',
|
|
44134
|
+
'GET',
|
|
44135
|
+
{ },
|
|
44136
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
44137
|
+
{ },
|
|
44138
|
+
{ },
|
|
44139
|
+
null,
|
|
44140
|
+
['PureCloud OAuth'],
|
|
44141
|
+
['application/json'],
|
|
44142
|
+
['application/json']
|
|
44143
|
+
);
|
|
44144
|
+
}
|
|
44145
|
+
|
|
43123
44146
|
/**
|
|
43124
44147
|
* Retrieve the home division for the organization.
|
|
43125
44148
|
* Will not include object counts.
|
|
@@ -43160,6 +44183,34 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43160
44183
|
);
|
|
43161
44184
|
}
|
|
43162
44185
|
|
|
44186
|
+
/**
|
|
44187
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
44188
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
44189
|
+
* @param {Object} opts Optional parameters
|
|
44190
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
44191
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
44192
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
44193
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
44194
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
44195
|
+
*/
|
|
44196
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
44197
|
+
opts = opts || {};
|
|
44198
|
+
|
|
44199
|
+
|
|
44200
|
+
return this.apiClient.callApi(
|
|
44201
|
+
'/api/v2/authorization/divisions/query',
|
|
44202
|
+
'GET',
|
|
44203
|
+
{ },
|
|
44204
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
44205
|
+
{ },
|
|
44206
|
+
{ },
|
|
44207
|
+
null,
|
|
44208
|
+
['PureCloud OAuth'],
|
|
44209
|
+
['application/json'],
|
|
44210
|
+
['application/json']
|
|
44211
|
+
);
|
|
44212
|
+
}
|
|
44213
|
+
|
|
43163
44214
|
/**
|
|
43164
44215
|
* Assign a list of objects to a division
|
|
43165
44216
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
@@ -43286,7 +44337,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43286
44337
|
/**
|
|
43287
44338
|
* OperationalEvents service.
|
|
43288
44339
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
43289
|
-
* @version
|
|
44340
|
+
* @version 219.0.0
|
|
43290
44341
|
*/
|
|
43291
44342
|
|
|
43292
44343
|
/**
|
|
@@ -43403,7 +44454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43403
44454
|
/**
|
|
43404
44455
|
* Organization service.
|
|
43405
44456
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
43406
|
-
* @version
|
|
44457
|
+
* @version 219.0.0
|
|
43407
44458
|
*/
|
|
43408
44459
|
|
|
43409
44460
|
/**
|
|
@@ -43878,7 +44929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43878
44929
|
/**
|
|
43879
44930
|
* OrganizationAuthorization service.
|
|
43880
44931
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43881
|
-
* @version
|
|
44932
|
+
* @version 219.0.0
|
|
43882
44933
|
*/
|
|
43883
44934
|
|
|
43884
44935
|
/**
|
|
@@ -45272,7 +46323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45272
46323
|
/**
|
|
45273
46324
|
* Outbound service.
|
|
45274
46325
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
45275
|
-
* @version
|
|
46326
|
+
* @version 219.0.0
|
|
45276
46327
|
*/
|
|
45277
46328
|
|
|
45278
46329
|
/**
|
|
@@ -45759,6 +46810,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45759
46810
|
);
|
|
45760
46811
|
}
|
|
45761
46812
|
|
|
46813
|
+
/**
|
|
46814
|
+
* Deletes all or expired whatsApp numbers from a DNC list.
|
|
46815
|
+
* This operation is only for Internal DNC lists of whatsApp numbers
|
|
46816
|
+
* @param {String} dncListId DncList ID
|
|
46817
|
+
* @param {Object} opts Optional parameters
|
|
46818
|
+
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC whatsApp numbers that are expired (default to false)
|
|
46819
|
+
*/
|
|
46820
|
+
deleteOutboundDnclistWhatsappnumbers(dncListId, opts) {
|
|
46821
|
+
opts = opts || {};
|
|
46822
|
+
|
|
46823
|
+
// verify the required parameter 'dncListId' is set
|
|
46824
|
+
if (dncListId === undefined || dncListId === null) {
|
|
46825
|
+
throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistWhatsappnumbers';
|
|
46826
|
+
}
|
|
46827
|
+
|
|
46828
|
+
return this.apiClient.callApi(
|
|
46829
|
+
'/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
|
|
46830
|
+
'DELETE',
|
|
46831
|
+
{ 'dncListId': dncListId },
|
|
46832
|
+
{ 'expiredOnly': opts['expiredOnly'] },
|
|
46833
|
+
{ },
|
|
46834
|
+
{ },
|
|
46835
|
+
null,
|
|
46836
|
+
['PureCloud OAuth'],
|
|
46837
|
+
['application/json'],
|
|
46838
|
+
['application/json']
|
|
46839
|
+
);
|
|
46840
|
+
}
|
|
46841
|
+
|
|
45762
46842
|
/**
|
|
45763
46843
|
* Delete File Specification Template
|
|
45764
46844
|
*
|
|
@@ -48097,6 +49177,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48097
49177
|
);
|
|
48098
49178
|
}
|
|
48099
49179
|
|
|
49180
|
+
/**
|
|
49181
|
+
* Add entries to or delete entries from a DNC list.
|
|
49182
|
+
* Only Internal DNC lists may be deleted from
|
|
49183
|
+
* @param {String} dncListId DncList ID
|
|
49184
|
+
* @param {Object} body DNC whatsApp numbers
|
|
49185
|
+
*/
|
|
49186
|
+
patchOutboundDnclistWhatsappnumbers(dncListId, body) {
|
|
49187
|
+
// verify the required parameter 'dncListId' is set
|
|
49188
|
+
if (dncListId === undefined || dncListId === null) {
|
|
49189
|
+
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistWhatsappnumbers';
|
|
49190
|
+
}
|
|
49191
|
+
// verify the required parameter 'body' is set
|
|
49192
|
+
if (body === undefined || body === null) {
|
|
49193
|
+
throw 'Missing the required parameter "body" when calling patchOutboundDnclistWhatsappnumbers';
|
|
49194
|
+
}
|
|
49195
|
+
|
|
49196
|
+
return this.apiClient.callApi(
|
|
49197
|
+
'/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
|
|
49198
|
+
'PATCH',
|
|
49199
|
+
{ 'dncListId': dncListId },
|
|
49200
|
+
{ },
|
|
49201
|
+
{ },
|
|
49202
|
+
{ },
|
|
49203
|
+
body,
|
|
49204
|
+
['PureCloud OAuth'],
|
|
49205
|
+
['application/json'],
|
|
49206
|
+
['application/json']
|
|
49207
|
+
);
|
|
49208
|
+
}
|
|
49209
|
+
|
|
48100
49210
|
/**
|
|
48101
49211
|
* Update the outbound settings for this organization
|
|
48102
49212
|
*
|
|
@@ -49835,7 +50945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49835
50945
|
/**
|
|
49836
50946
|
* Presence service.
|
|
49837
50947
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
49838
|
-
* @version
|
|
50948
|
+
* @version 219.0.0
|
|
49839
50949
|
*/
|
|
49840
50950
|
|
|
49841
50951
|
/**
|
|
@@ -50579,7 +51689,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50579
51689
|
/**
|
|
50580
51690
|
* ProcessAutomation service.
|
|
50581
51691
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
50582
|
-
* @version
|
|
51692
|
+
* @version 219.0.0
|
|
50583
51693
|
*/
|
|
50584
51694
|
|
|
50585
51695
|
/**
|
|
@@ -50818,7 +51928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50818
51928
|
/**
|
|
50819
51929
|
* Quality service.
|
|
50820
51930
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
50821
|
-
* @version
|
|
51931
|
+
* @version 219.0.0
|
|
50822
51932
|
*/
|
|
50823
51933
|
|
|
50824
51934
|
/**
|
|
@@ -52605,7 +53715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52605
53715
|
/**
|
|
52606
53716
|
* Recording service.
|
|
52607
53717
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
52608
|
-
* @version
|
|
53718
|
+
* @version 219.0.0
|
|
52609
53719
|
*/
|
|
52610
53720
|
|
|
52611
53721
|
/**
|
|
@@ -52912,7 +54022,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52912
54022
|
}
|
|
52913
54023
|
|
|
52914
54024
|
/**
|
|
52915
|
-
* Get recording metadata for a conversation. Does not return playable media
|
|
54025
|
+
* Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.
|
|
52916
54026
|
*
|
|
52917
54027
|
* @param {String} conversationId Conversation ID
|
|
52918
54028
|
*/
|
|
@@ -54210,7 +55320,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54210
55320
|
/**
|
|
54211
55321
|
* ResponseManagement service.
|
|
54212
55322
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
54213
|
-
* @version
|
|
55323
|
+
* @version 219.0.0
|
|
54214
55324
|
*/
|
|
54215
55325
|
|
|
54216
55326
|
/**
|
|
@@ -54720,7 +55830,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54720
55830
|
/**
|
|
54721
55831
|
* Routing service.
|
|
54722
55832
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54723
|
-
* @version
|
|
55833
|
+
* @version 219.0.0
|
|
54724
55834
|
*/
|
|
54725
55835
|
|
|
54726
55836
|
/**
|
|
@@ -55630,7 +56740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55630
56740
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
55631
56741
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
55632
56742
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
55633
|
-
* @param {String} opts.filter Optional search filter
|
|
56743
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
55634
56744
|
*/
|
|
55635
56745
|
getRoutingEmailDomains(opts) {
|
|
55636
56746
|
opts = opts || {};
|
|
@@ -55729,7 +56839,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55729
56839
|
* Get outbound domains
|
|
55730
56840
|
*
|
|
55731
56841
|
* @param {Object} opts Optional parameters
|
|
55732
|
-
* @param {
|
|
56842
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56843
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56844
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
55733
56845
|
*/
|
|
55734
56846
|
getRoutingEmailOutboundDomains(opts) {
|
|
55735
56847
|
opts = opts || {};
|
|
@@ -55739,7 +56851,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55739
56851
|
'/api/v2/routing/email/outbound/domains',
|
|
55740
56852
|
'GET',
|
|
55741
56853
|
{ },
|
|
55742
|
-
{ 'filter': opts['filter'] },
|
|
56854
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
55743
56855
|
{ },
|
|
55744
56856
|
{ },
|
|
55745
56857
|
null,
|
|
@@ -59023,7 +60135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59023
60135
|
/**
|
|
59024
60136
|
* SCIM service.
|
|
59025
60137
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
59026
|
-
* @version
|
|
60138
|
+
* @version 219.0.0
|
|
59027
60139
|
*/
|
|
59028
60140
|
|
|
59029
60141
|
/**
|
|
@@ -59900,7 +61012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59900
61012
|
/**
|
|
59901
61013
|
* ScreenRecording service.
|
|
59902
61014
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
59903
|
-
* @version
|
|
61015
|
+
* @version 219.0.0
|
|
59904
61016
|
*/
|
|
59905
61017
|
|
|
59906
61018
|
/**
|
|
@@ -59945,7 +61057,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59945
61057
|
/**
|
|
59946
61058
|
* Scripts service.
|
|
59947
61059
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
59948
|
-
* @version
|
|
61060
|
+
* @version 219.0.0
|
|
59949
61061
|
*/
|
|
59950
61062
|
|
|
59951
61063
|
/**
|
|
@@ -60389,7 +61501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60389
61501
|
/**
|
|
60390
61502
|
* Search service.
|
|
60391
61503
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
60392
|
-
* @version
|
|
61504
|
+
* @version 219.0.0
|
|
60393
61505
|
*/
|
|
60394
61506
|
|
|
60395
61507
|
/**
|
|
@@ -61132,7 +62244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61132
62244
|
/**
|
|
61133
62245
|
* Settings service.
|
|
61134
62246
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
61135
|
-
* @version
|
|
62247
|
+
* @version 219.0.0
|
|
61136
62248
|
*/
|
|
61137
62249
|
|
|
61138
62250
|
/**
|
|
@@ -61147,6 +62259,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61147
62259
|
}
|
|
61148
62260
|
|
|
61149
62261
|
|
|
62262
|
+
/**
|
|
62263
|
+
* Reset email threading settings to default
|
|
62264
|
+
*
|
|
62265
|
+
*/
|
|
62266
|
+
deleteEmailsSettingsThreading() {
|
|
62267
|
+
|
|
62268
|
+
return this.apiClient.callApi(
|
|
62269
|
+
'/api/v2/emails/settings/threading',
|
|
62270
|
+
'DELETE',
|
|
62271
|
+
{ },
|
|
62272
|
+
{ },
|
|
62273
|
+
{ },
|
|
62274
|
+
{ },
|
|
62275
|
+
null,
|
|
62276
|
+
['PureCloud OAuth'],
|
|
62277
|
+
['application/json'],
|
|
62278
|
+
['application/json']
|
|
62279
|
+
);
|
|
62280
|
+
}
|
|
62281
|
+
|
|
61150
62282
|
/**
|
|
61151
62283
|
* Delete agent auto answer settings
|
|
61152
62284
|
*
|
|
@@ -61192,6 +62324,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61192
62324
|
);
|
|
61193
62325
|
}
|
|
61194
62326
|
|
|
62327
|
+
/**
|
|
62328
|
+
* Get email threading settings
|
|
62329
|
+
*
|
|
62330
|
+
*/
|
|
62331
|
+
getEmailsSettingsThreading() {
|
|
62332
|
+
|
|
62333
|
+
return this.apiClient.callApi(
|
|
62334
|
+
'/api/v2/emails/settings/threading',
|
|
62335
|
+
'GET',
|
|
62336
|
+
{ },
|
|
62337
|
+
{ },
|
|
62338
|
+
{ },
|
|
62339
|
+
{ },
|
|
62340
|
+
null,
|
|
62341
|
+
['PureCloud OAuth'],
|
|
62342
|
+
['application/json'],
|
|
62343
|
+
['application/json']
|
|
62344
|
+
);
|
|
62345
|
+
}
|
|
62346
|
+
|
|
61195
62347
|
/**
|
|
61196
62348
|
* Get the execution history enabled setting.
|
|
61197
62349
|
* Get the execution history enabled setting.
|
|
@@ -61261,6 +62413,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61261
62413
|
);
|
|
61262
62414
|
}
|
|
61263
62415
|
|
|
62416
|
+
/**
|
|
62417
|
+
* Patch email threading settings
|
|
62418
|
+
*
|
|
62419
|
+
* @param {Object} opts Optional parameters
|
|
62420
|
+
* @param {Object} opts.body
|
|
62421
|
+
*/
|
|
62422
|
+
patchEmailsSettingsThreading(opts) {
|
|
62423
|
+
opts = opts || {};
|
|
62424
|
+
|
|
62425
|
+
|
|
62426
|
+
return this.apiClient.callApi(
|
|
62427
|
+
'/api/v2/emails/settings/threading',
|
|
62428
|
+
'PATCH',
|
|
62429
|
+
{ },
|
|
62430
|
+
{ },
|
|
62431
|
+
{ },
|
|
62432
|
+
{ },
|
|
62433
|
+
opts['body'],
|
|
62434
|
+
['PureCloud OAuth'],
|
|
62435
|
+
['application/json'],
|
|
62436
|
+
['application/json']
|
|
62437
|
+
);
|
|
62438
|
+
}
|
|
62439
|
+
|
|
61264
62440
|
/**
|
|
61265
62441
|
* Edit the execution history on off setting.
|
|
61266
62442
|
* Edit the execution history on off setting.
|
|
@@ -61352,7 +62528,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61352
62528
|
/**
|
|
61353
62529
|
* SocialMedia service.
|
|
61354
62530
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
61355
|
-
* @version
|
|
62531
|
+
* @version 219.0.0
|
|
61356
62532
|
*/
|
|
61357
62533
|
|
|
61358
62534
|
/**
|
|
@@ -62640,7 +63816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62640
63816
|
/**
|
|
62641
63817
|
* SpeechTextAnalytics service.
|
|
62642
63818
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
62643
|
-
* @version
|
|
63819
|
+
* @version 219.0.0
|
|
62644
63820
|
*/
|
|
62645
63821
|
|
|
62646
63822
|
/**
|
|
@@ -64081,7 +65257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64081
65257
|
/**
|
|
64082
65258
|
* Stations service.
|
|
64083
65259
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
64084
|
-
* @version
|
|
65260
|
+
* @version 219.0.0
|
|
64085
65261
|
*/
|
|
64086
65262
|
|
|
64087
65263
|
/**
|
|
@@ -64183,7 +65359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64183
65359
|
/**
|
|
64184
65360
|
* Suggest service.
|
|
64185
65361
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
64186
|
-
* @version
|
|
65362
|
+
* @version 219.0.0
|
|
64187
65363
|
*/
|
|
64188
65364
|
|
|
64189
65365
|
/**
|
|
@@ -64322,7 +65498,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64322
65498
|
/**
|
|
64323
65499
|
* TaskManagement service.
|
|
64324
65500
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
64325
|
-
* @version
|
|
65501
|
+
* @version 219.0.0
|
|
64326
65502
|
*/
|
|
64327
65503
|
|
|
64328
65504
|
/**
|
|
@@ -65197,6 +66373,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65197
66373
|
);
|
|
65198
66374
|
}
|
|
65199
66375
|
|
|
66376
|
+
/**
|
|
66377
|
+
* Get the core types from which all schemas are built.
|
|
66378
|
+
*
|
|
66379
|
+
* @param {String} coreTypeName Name of the core type
|
|
66380
|
+
*/
|
|
66381
|
+
getTaskmanagementWorkitemsSchemasCoretype(coreTypeName) {
|
|
66382
|
+
// verify the required parameter 'coreTypeName' is set
|
|
66383
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
66384
|
+
throw 'Missing the required parameter "coreTypeName" when calling getTaskmanagementWorkitemsSchemasCoretype';
|
|
66385
|
+
}
|
|
66386
|
+
|
|
66387
|
+
return this.apiClient.callApi(
|
|
66388
|
+
'/api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}',
|
|
66389
|
+
'GET',
|
|
66390
|
+
{ 'coreTypeName': coreTypeName },
|
|
66391
|
+
{ },
|
|
66392
|
+
{ },
|
|
66393
|
+
{ },
|
|
66394
|
+
null,
|
|
66395
|
+
['PureCloud OAuth'],
|
|
66396
|
+
['application/json'],
|
|
66397
|
+
['application/json']
|
|
66398
|
+
);
|
|
66399
|
+
}
|
|
66400
|
+
|
|
66401
|
+
/**
|
|
66402
|
+
* Get the core types from which all schemas are built.
|
|
66403
|
+
*
|
|
66404
|
+
*/
|
|
66405
|
+
getTaskmanagementWorkitemsSchemasCoretypes() {
|
|
66406
|
+
|
|
66407
|
+
return this.apiClient.callApi(
|
|
66408
|
+
'/api/v2/taskmanagement/workitems/schemas/coretypes',
|
|
66409
|
+
'GET',
|
|
66410
|
+
{ },
|
|
66411
|
+
{ },
|
|
66412
|
+
{ },
|
|
66413
|
+
{ },
|
|
66414
|
+
null,
|
|
66415
|
+
['PureCloud OAuth'],
|
|
66416
|
+
['application/json'],
|
|
66417
|
+
['application/json']
|
|
66418
|
+
);
|
|
66419
|
+
}
|
|
66420
|
+
|
|
66421
|
+
/**
|
|
66422
|
+
* Get quantitative limits on schemas
|
|
66423
|
+
*
|
|
66424
|
+
*/
|
|
66425
|
+
getTaskmanagementWorkitemsSchemasLimits() {
|
|
66426
|
+
|
|
66427
|
+
return this.apiClient.callApi(
|
|
66428
|
+
'/api/v2/taskmanagement/workitems/schemas/limits',
|
|
66429
|
+
'GET',
|
|
66430
|
+
{ },
|
|
66431
|
+
{ },
|
|
66432
|
+
{ },
|
|
66433
|
+
{ },
|
|
66434
|
+
null,
|
|
66435
|
+
['PureCloud OAuth'],
|
|
66436
|
+
['application/json'],
|
|
66437
|
+
['application/json']
|
|
66438
|
+
);
|
|
66439
|
+
}
|
|
66440
|
+
|
|
65200
66441
|
/**
|
|
65201
66442
|
* Get a worktype
|
|
65202
66443
|
*
|
|
@@ -66428,7 +67669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66428
67669
|
/**
|
|
66429
67670
|
* Teams service.
|
|
66430
67671
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
66431
|
-
* @version
|
|
67672
|
+
* @version 219.0.0
|
|
66432
67673
|
*/
|
|
66433
67674
|
|
|
66434
67675
|
/**
|
|
@@ -66733,7 +67974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66733
67974
|
/**
|
|
66734
67975
|
* Telephony service.
|
|
66735
67976
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
66736
|
-
* @version
|
|
67977
|
+
* @version 219.0.0
|
|
66737
67978
|
*/
|
|
66738
67979
|
|
|
66739
67980
|
/**
|
|
@@ -66915,7 +68156,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66915
68156
|
/**
|
|
66916
68157
|
* TelephonyProvidersEdge service.
|
|
66917
68158
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
66918
|
-
* @version
|
|
68159
|
+
* @version 219.0.0
|
|
66919
68160
|
*/
|
|
66920
68161
|
|
|
66921
68162
|
/**
|
|
@@ -70367,7 +71608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70367
71608
|
/**
|
|
70368
71609
|
* Textbots service.
|
|
70369
71610
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
70370
|
-
* @version
|
|
71611
|
+
* @version 219.0.0
|
|
70371
71612
|
*/
|
|
70372
71613
|
|
|
70373
71614
|
/**
|
|
@@ -70495,7 +71736,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70495
71736
|
/**
|
|
70496
71737
|
* Tokens service.
|
|
70497
71738
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
70498
|
-
* @version
|
|
71739
|
+
* @version 219.0.0
|
|
70499
71740
|
*/
|
|
70500
71741
|
|
|
70501
71742
|
/**
|
|
@@ -70649,7 +71890,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70649
71890
|
/**
|
|
70650
71891
|
* Uploads service.
|
|
70651
71892
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
70652
|
-
* @version
|
|
71893
|
+
* @version 219.0.0
|
|
70653
71894
|
*/
|
|
70654
71895
|
|
|
70655
71896
|
/**
|
|
@@ -70694,6 +71935,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70694
71935
|
);
|
|
70695
71936
|
}
|
|
70696
71937
|
|
|
71938
|
+
/**
|
|
71939
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
71940
|
+
*
|
|
71941
|
+
* @param {Object} body query
|
|
71942
|
+
*/
|
|
71943
|
+
postGamificationContestsUploadsPrizeimages(body) {
|
|
71944
|
+
// verify the required parameter 'body' is set
|
|
71945
|
+
if (body === undefined || body === null) {
|
|
71946
|
+
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
71947
|
+
}
|
|
71948
|
+
|
|
71949
|
+
return this.apiClient.callApi(
|
|
71950
|
+
'/api/v2/gamification/contests/uploads/prizeimages',
|
|
71951
|
+
'POST',
|
|
71952
|
+
{ },
|
|
71953
|
+
{ },
|
|
71954
|
+
{ },
|
|
71955
|
+
{ },
|
|
71956
|
+
body,
|
|
71957
|
+
['PureCloud OAuth'],
|
|
71958
|
+
['application/json'],
|
|
71959
|
+
['application/json']
|
|
71960
|
+
);
|
|
71961
|
+
}
|
|
71962
|
+
|
|
70697
71963
|
/**
|
|
70698
71964
|
* Create upload presigned URL for draft function package file.
|
|
70699
71965
|
*
|
|
@@ -70915,7 +72181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70915
72181
|
/**
|
|
70916
72182
|
* Usage service.
|
|
70917
72183
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
70918
|
-
* @version
|
|
72184
|
+
* @version 219.0.0
|
|
70919
72185
|
*/
|
|
70920
72186
|
|
|
70921
72187
|
/**
|
|
@@ -71130,7 +72396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71130
72396
|
/**
|
|
71131
72397
|
* UserRecordings service.
|
|
71132
72398
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
71133
|
-
* @version
|
|
72399
|
+
* @version 219.0.0
|
|
71134
72400
|
*/
|
|
71135
72401
|
|
|
71136
72402
|
/**
|
|
@@ -71345,7 +72611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71345
72611
|
/**
|
|
71346
72612
|
* Users service.
|
|
71347
72613
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
71348
|
-
* @version
|
|
72614
|
+
* @version 219.0.0
|
|
71349
72615
|
*/
|
|
71350
72616
|
|
|
71351
72617
|
/**
|
|
@@ -74298,7 +75564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74298
75564
|
/**
|
|
74299
75565
|
* Utilities service.
|
|
74300
75566
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
74301
|
-
* @version
|
|
75567
|
+
* @version 219.0.0
|
|
74302
75568
|
*/
|
|
74303
75569
|
|
|
74304
75570
|
/**
|
|
@@ -74409,7 +75675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74409
75675
|
/**
|
|
74410
75676
|
* Voicemail service.
|
|
74411
75677
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
74412
|
-
* @version
|
|
75678
|
+
* @version 219.0.0
|
|
74413
75679
|
*/
|
|
74414
75680
|
|
|
74415
75681
|
/**
|
|
@@ -75131,7 +76397,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75131
76397
|
/**
|
|
75132
76398
|
* WebChat service.
|
|
75133
76399
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
75134
|
-
* @version
|
|
76400
|
+
* @version 219.0.0
|
|
75135
76401
|
*/
|
|
75136
76402
|
|
|
75137
76403
|
/**
|
|
@@ -75691,7 +76957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75691
76957
|
/**
|
|
75692
76958
|
* WebDeployments service.
|
|
75693
76959
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
75694
|
-
* @version
|
|
76960
|
+
* @version 219.0.0
|
|
75695
76961
|
*/
|
|
75696
76962
|
|
|
75697
76963
|
/**
|
|
@@ -76275,7 +77541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76275
77541
|
/**
|
|
76276
77542
|
* WebMessaging service.
|
|
76277
77543
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
76278
|
-
* @version
|
|
77544
|
+
* @version 219.0.0
|
|
76279
77545
|
*/
|
|
76280
77546
|
|
|
76281
77547
|
/**
|
|
@@ -76321,7 +77587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76321
77587
|
/**
|
|
76322
77588
|
* Widgets service.
|
|
76323
77589
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
76324
|
-
* @version
|
|
77590
|
+
* @version 219.0.0
|
|
76325
77591
|
*/
|
|
76326
77592
|
|
|
76327
77593
|
/**
|
|
@@ -76472,7 +77738,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76472
77738
|
/**
|
|
76473
77739
|
* WorkforceManagement service.
|
|
76474
77740
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
76475
|
-
* @version
|
|
77741
|
+
* @version 219.0.0
|
|
76476
77742
|
*/
|
|
76477
77743
|
|
|
76478
77744
|
/**
|
|
@@ -79042,8 +80308,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79042
80308
|
}
|
|
79043
80309
|
|
|
79044
80310
|
/**
|
|
79045
|
-
* Retrieves delete job status for historical data imports of the organization
|
|
79046
|
-
*
|
|
80311
|
+
* Retrieves delete job status for historical data imports of the organization.
|
|
80312
|
+
* Deprecated: Please use GET /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
80313
|
+
* @deprecated
|
|
79047
80314
|
*/
|
|
79048
80315
|
getWorkforcemanagementHistoricaldataDeletejob() {
|
|
79049
80316
|
|
|
@@ -82615,8 +83882,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82615
83882
|
}
|
|
82616
83883
|
|
|
82617
83884
|
/**
|
|
82618
|
-
* Delete the entries of the historical data imports in the organization
|
|
82619
|
-
*
|
|
83885
|
+
* Delete the entries of the historical data imports in the organization.
|
|
83886
|
+
* Deprecated: Please use POST /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
83887
|
+
* @deprecated
|
|
82620
83888
|
*/
|
|
82621
83889
|
postWorkforcemanagementHistoricaldataDeletejob() {
|
|
82622
83890
|
|
|
@@ -83865,7 +85133,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83865
85133
|
* </pre>
|
|
83866
85134
|
* </p>
|
|
83867
85135
|
* @module purecloud-platform-client-v2/index
|
|
83868
|
-
* @version
|
|
85136
|
+
* @version 219.0.0
|
|
83869
85137
|
*/
|
|
83870
85138
|
class platformClient {
|
|
83871
85139
|
constructor() {
|