purecloud-platform-client-v2 218.1.0 → 220.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 +4 -4
- package/dist/node/purecloud-platform-client-v2.js +1195 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +1195 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +390 -130
- package/dist/web-cjs/purecloud-platform-client-v2.js +390 -130
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1494 -763
- package/package.json +2 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- 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 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- 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 +37 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +399 -5
- 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 +1 -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 +11 -11
- 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 +3 -3
- 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 +33 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +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 -10
- 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 +3 -3
- 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
|
@@ -690,7 +690,7 @@ class Configuration {
|
|
|
690
690
|
|
|
691
691
|
/**
|
|
692
692
|
* @module purecloud-platform-client-v2/ApiClient
|
|
693
|
-
* @version
|
|
693
|
+
* @version 220.0.0
|
|
694
694
|
*/
|
|
695
695
|
class ApiClient {
|
|
696
696
|
/**
|
|
@@ -785,7 +785,7 @@ class ApiClient {
|
|
|
785
785
|
/**
|
|
786
786
|
* The default HTTP timeout for all API calls.
|
|
787
787
|
* @type {Number}
|
|
788
|
-
* @default
|
|
788
|
+
* @default 16000
|
|
789
789
|
*/
|
|
790
790
|
this.timeout = 16000;
|
|
791
791
|
|
|
@@ -2234,7 +2234,7 @@ class AgentAssistantsApi {
|
|
|
2234
2234
|
/**
|
|
2235
2235
|
* AgentAssistants service.
|
|
2236
2236
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2237
|
-
* @version
|
|
2237
|
+
* @version 220.0.0
|
|
2238
2238
|
*/
|
|
2239
2239
|
|
|
2240
2240
|
/**
|
|
@@ -2610,7 +2610,7 @@ class AgentCopilotApi {
|
|
|
2610
2610
|
/**
|
|
2611
2611
|
* AgentCopilot service.
|
|
2612
2612
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2613
|
-
* @version
|
|
2613
|
+
* @version 220.0.0
|
|
2614
2614
|
*/
|
|
2615
2615
|
|
|
2616
2616
|
/**
|
|
@@ -2686,7 +2686,7 @@ class AgentUIApi {
|
|
|
2686
2686
|
/**
|
|
2687
2687
|
* AgentUI service.
|
|
2688
2688
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2689
|
-
* @version
|
|
2689
|
+
* @version 220.0.0
|
|
2690
2690
|
*/
|
|
2691
2691
|
|
|
2692
2692
|
/**
|
|
@@ -2817,7 +2817,7 @@ class AlertingApi {
|
|
|
2817
2817
|
/**
|
|
2818
2818
|
* Alerting service.
|
|
2819
2819
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2820
|
-
* @version
|
|
2820
|
+
* @version 220.0.0
|
|
2821
2821
|
*/
|
|
2822
2822
|
|
|
2823
2823
|
/**
|
|
@@ -3218,7 +3218,7 @@ class AnalyticsApi {
|
|
|
3218
3218
|
/**
|
|
3219
3219
|
* Analytics service.
|
|
3220
3220
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3221
|
-
* @version
|
|
3221
|
+
* @version 220.0.0
|
|
3222
3222
|
*/
|
|
3223
3223
|
|
|
3224
3224
|
/**
|
|
@@ -6039,7 +6039,7 @@ class ArchitectApi {
|
|
|
6039
6039
|
/**
|
|
6040
6040
|
* Architect service.
|
|
6041
6041
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6042
|
-
* @version
|
|
6042
|
+
* @version 220.0.0
|
|
6043
6043
|
*/
|
|
6044
6044
|
|
|
6045
6045
|
/**
|
|
@@ -7434,7 +7434,7 @@ class ArchitectApi {
|
|
|
7434
7434
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7435
7435
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7436
7436
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
7437
|
-
* @param {String} opts.sortOrder Sort order (default to
|
|
7437
|
+
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
7438
7438
|
* @param {String} opts.name Name of the Schedule to filter by.
|
|
7439
7439
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7440
7440
|
*/
|
|
@@ -10332,7 +10332,7 @@ class AuditApi {
|
|
|
10332
10332
|
/**
|
|
10333
10333
|
* Audit service.
|
|
10334
10334
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10335
|
-
* @version
|
|
10335
|
+
* @version 220.0.0
|
|
10336
10336
|
*/
|
|
10337
10337
|
|
|
10338
10338
|
/**
|
|
@@ -10533,7 +10533,7 @@ class AuthorizationApi {
|
|
|
10533
10533
|
/**
|
|
10534
10534
|
* Authorization service.
|
|
10535
10535
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10536
|
-
* @version
|
|
10536
|
+
* @version 220.0.0
|
|
10537
10537
|
*/
|
|
10538
10538
|
|
|
10539
10539
|
/**
|
|
@@ -10759,6 +10759,31 @@ class AuthorizationApi {
|
|
|
10759
10759
|
);
|
|
10760
10760
|
}
|
|
10761
10761
|
|
|
10762
|
+
/**
|
|
10763
|
+
* Get a list of soft deleted divisions for the org
|
|
10764
|
+
*
|
|
10765
|
+
* @param {Object} opts Optional parameters
|
|
10766
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10767
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10768
|
+
*/
|
|
10769
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
10770
|
+
opts = opts || {};
|
|
10771
|
+
|
|
10772
|
+
|
|
10773
|
+
return this.apiClient.callApi(
|
|
10774
|
+
'/api/v2/authorization/divisions/deleted',
|
|
10775
|
+
'GET',
|
|
10776
|
+
{ },
|
|
10777
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
10778
|
+
{ },
|
|
10779
|
+
{ },
|
|
10780
|
+
null,
|
|
10781
|
+
['PureCloud OAuth'],
|
|
10782
|
+
['application/json'],
|
|
10783
|
+
['application/json']
|
|
10784
|
+
);
|
|
10785
|
+
}
|
|
10786
|
+
|
|
10762
10787
|
/**
|
|
10763
10788
|
* Retrieve the home division for the organization.
|
|
10764
10789
|
* Will not include object counts.
|
|
@@ -10799,6 +10824,34 @@ class AuthorizationApi {
|
|
|
10799
10824
|
);
|
|
10800
10825
|
}
|
|
10801
10826
|
|
|
10827
|
+
/**
|
|
10828
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
10829
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
10830
|
+
* @param {Object} opts Optional parameters
|
|
10831
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
10832
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10833
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
10834
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
10835
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
10836
|
+
*/
|
|
10837
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
10838
|
+
opts = opts || {};
|
|
10839
|
+
|
|
10840
|
+
|
|
10841
|
+
return this.apiClient.callApi(
|
|
10842
|
+
'/api/v2/authorization/divisions/query',
|
|
10843
|
+
'GET',
|
|
10844
|
+
{ },
|
|
10845
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
10846
|
+
{ },
|
|
10847
|
+
{ },
|
|
10848
|
+
null,
|
|
10849
|
+
['PureCloud OAuth'],
|
|
10850
|
+
['application/json'],
|
|
10851
|
+
['application/json']
|
|
10852
|
+
);
|
|
10853
|
+
}
|
|
10854
|
+
|
|
10802
10855
|
/**
|
|
10803
10856
|
* Returns which divisions the current user has the given permission in.
|
|
10804
10857
|
* This route is deprecated, use authorization/divisionspermitted/paged/me instead.
|
|
@@ -12195,7 +12248,7 @@ class BillingApi {
|
|
|
12195
12248
|
/**
|
|
12196
12249
|
* Billing service.
|
|
12197
12250
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12198
|
-
* @version
|
|
12251
|
+
* @version 220.0.0
|
|
12199
12252
|
*/
|
|
12200
12253
|
|
|
12201
12254
|
/**
|
|
@@ -12275,7 +12328,7 @@ class CarrierServicesApi {
|
|
|
12275
12328
|
/**
|
|
12276
12329
|
* CarrierServices service.
|
|
12277
12330
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12278
|
-
* @version
|
|
12331
|
+
* @version 220.0.0
|
|
12279
12332
|
*/
|
|
12280
12333
|
|
|
12281
12334
|
/**
|
|
@@ -12345,7 +12398,7 @@ class ChatApi {
|
|
|
12345
12398
|
/**
|
|
12346
12399
|
* Chat service.
|
|
12347
12400
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12348
|
-
* @version
|
|
12401
|
+
* @version 220.0.0
|
|
12349
12402
|
*/
|
|
12350
12403
|
|
|
12351
12404
|
/**
|
|
@@ -13274,7 +13327,7 @@ class CoachingApi {
|
|
|
13274
13327
|
/**
|
|
13275
13328
|
* Coaching service.
|
|
13276
13329
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13277
|
-
* @version
|
|
13330
|
+
* @version 220.0.0
|
|
13278
13331
|
*/
|
|
13279
13332
|
|
|
13280
13333
|
/**
|
|
@@ -13851,7 +13904,7 @@ class ContentManagementApi {
|
|
|
13851
13904
|
/**
|
|
13852
13905
|
* ContentManagement service.
|
|
13853
13906
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13854
|
-
* @version
|
|
13907
|
+
* @version 220.0.0
|
|
13855
13908
|
*/
|
|
13856
13909
|
|
|
13857
13910
|
/**
|
|
@@ -14932,7 +14985,7 @@ class ConversationsApi {
|
|
|
14932
14985
|
/**
|
|
14933
14986
|
* Conversations service.
|
|
14934
14987
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14935
|
-
* @version
|
|
14988
|
+
* @version 220.0.0
|
|
14936
14989
|
*/
|
|
14937
14990
|
|
|
14938
14991
|
/**
|
|
@@ -21108,6 +21161,7 @@ class ConversationsApi {
|
|
|
21108
21161
|
* See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
|
|
21109
21162
|
* @param {String} conversationId conversationId
|
|
21110
21163
|
* @param {String} communicationId communicationId
|
|
21164
|
+
* @deprecated
|
|
21111
21165
|
*/
|
|
21112
21166
|
postConversationsMessageCommunicationMessagesMedia(conversationId, communicationId) {
|
|
21113
21167
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21133,6 +21187,41 @@ class ConversationsApi {
|
|
|
21133
21187
|
);
|
|
21134
21188
|
}
|
|
21135
21189
|
|
|
21190
|
+
/**
|
|
21191
|
+
* Create a URL to upload a message media file
|
|
21192
|
+
* See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
|
|
21193
|
+
* @param {String} conversationId conversationId
|
|
21194
|
+
* @param {String} communicationId communicationId
|
|
21195
|
+
* @param {Object} body request
|
|
21196
|
+
*/
|
|
21197
|
+
postConversationsMessageCommunicationMessagesMediaUploads(conversationId, communicationId, body) {
|
|
21198
|
+
// verify the required parameter 'conversationId' is set
|
|
21199
|
+
if (conversationId === undefined || conversationId === null) {
|
|
21200
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessagesMediaUploads';
|
|
21201
|
+
}
|
|
21202
|
+
// verify the required parameter 'communicationId' is set
|
|
21203
|
+
if (communicationId === undefined || communicationId === null) {
|
|
21204
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessagesMediaUploads';
|
|
21205
|
+
}
|
|
21206
|
+
// verify the required parameter 'body' is set
|
|
21207
|
+
if (body === undefined || body === null) {
|
|
21208
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationMessagesMediaUploads';
|
|
21209
|
+
}
|
|
21210
|
+
|
|
21211
|
+
return this.apiClient.callApi(
|
|
21212
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/uploads',
|
|
21213
|
+
'POST',
|
|
21214
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
21215
|
+
{ },
|
|
21216
|
+
{ },
|
|
21217
|
+
{ },
|
|
21218
|
+
body,
|
|
21219
|
+
['PureCloud OAuth'],
|
|
21220
|
+
['application/json'],
|
|
21221
|
+
['application/json']
|
|
21222
|
+
);
|
|
21223
|
+
}
|
|
21224
|
+
|
|
21136
21225
|
/**
|
|
21137
21226
|
* Send message typing event
|
|
21138
21227
|
* Send message typing event for existing conversation/communication.
|
|
@@ -22514,7 +22603,7 @@ class DataExtensionsApi {
|
|
|
22514
22603
|
/**
|
|
22515
22604
|
* DataExtensions service.
|
|
22516
22605
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22517
|
-
* @version
|
|
22606
|
+
* @version 220.0.0
|
|
22518
22607
|
*/
|
|
22519
22608
|
|
|
22520
22609
|
/**
|
|
@@ -22600,7 +22689,7 @@ class DataPrivacyApi {
|
|
|
22600
22689
|
/**
|
|
22601
22690
|
* DataPrivacy service.
|
|
22602
22691
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22603
|
-
* @version
|
|
22692
|
+
* @version 220.0.0
|
|
22604
22693
|
*/
|
|
22605
22694
|
|
|
22606
22695
|
/**
|
|
@@ -22770,7 +22859,7 @@ class DownloadsApi {
|
|
|
22770
22859
|
/**
|
|
22771
22860
|
* Downloads service.
|
|
22772
22861
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22773
|
-
* @version
|
|
22862
|
+
* @version 220.0.0
|
|
22774
22863
|
*/
|
|
22775
22864
|
|
|
22776
22865
|
/**
|
|
@@ -22822,7 +22911,7 @@ class EmailsApi {
|
|
|
22822
22911
|
/**
|
|
22823
22912
|
* Emails service.
|
|
22824
22913
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22825
|
-
* @version
|
|
22914
|
+
* @version 220.0.0
|
|
22826
22915
|
*/
|
|
22827
22916
|
|
|
22828
22917
|
/**
|
|
@@ -22951,7 +23040,7 @@ class EmployeeEngagementApi {
|
|
|
22951
23040
|
/**
|
|
22952
23041
|
* EmployeeEngagement service.
|
|
22953
23042
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22954
|
-
* @version
|
|
23043
|
+
* @version 220.0.0
|
|
22955
23044
|
*/
|
|
22956
23045
|
|
|
22957
23046
|
/**
|
|
@@ -23102,7 +23191,7 @@ class EventsApi {
|
|
|
23102
23191
|
/**
|
|
23103
23192
|
* Events service.
|
|
23104
23193
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23105
|
-
* @version
|
|
23194
|
+
* @version 220.0.0
|
|
23106
23195
|
*/
|
|
23107
23196
|
|
|
23108
23197
|
/**
|
|
@@ -23198,7 +23287,7 @@ class ExternalContactsApi {
|
|
|
23198
23287
|
/**
|
|
23199
23288
|
* ExternalContacts service.
|
|
23200
23289
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23201
|
-
* @version
|
|
23290
|
+
* @version 220.0.0
|
|
23202
23291
|
*/
|
|
23203
23292
|
|
|
23204
23293
|
/**
|
|
@@ -23833,6 +23922,71 @@ class ExternalContactsApi {
|
|
|
23833
23922
|
);
|
|
23834
23923
|
}
|
|
23835
23924
|
|
|
23925
|
+
/**
|
|
23926
|
+
* Get the core types from which all schemas are built.
|
|
23927
|
+
*
|
|
23928
|
+
* @param {String} coreTypeName Name of the core type
|
|
23929
|
+
*/
|
|
23930
|
+
getExternalcontactsContactsSchemasCoretype(coreTypeName) {
|
|
23931
|
+
// verify the required parameter 'coreTypeName' is set
|
|
23932
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
23933
|
+
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsContactsSchemasCoretype';
|
|
23934
|
+
}
|
|
23935
|
+
|
|
23936
|
+
return this.apiClient.callApi(
|
|
23937
|
+
'/api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}',
|
|
23938
|
+
'GET',
|
|
23939
|
+
{ 'coreTypeName': coreTypeName },
|
|
23940
|
+
{ },
|
|
23941
|
+
{ },
|
|
23942
|
+
{ },
|
|
23943
|
+
null,
|
|
23944
|
+
['PureCloud OAuth'],
|
|
23945
|
+
['application/json'],
|
|
23946
|
+
['application/json']
|
|
23947
|
+
);
|
|
23948
|
+
}
|
|
23949
|
+
|
|
23950
|
+
/**
|
|
23951
|
+
* Get the core types from which all schemas are built.
|
|
23952
|
+
*
|
|
23953
|
+
*/
|
|
23954
|
+
getExternalcontactsContactsSchemasCoretypes() {
|
|
23955
|
+
|
|
23956
|
+
return this.apiClient.callApi(
|
|
23957
|
+
'/api/v2/externalcontacts/contacts/schemas/coretypes',
|
|
23958
|
+
'GET',
|
|
23959
|
+
{ },
|
|
23960
|
+
{ },
|
|
23961
|
+
{ },
|
|
23962
|
+
{ },
|
|
23963
|
+
null,
|
|
23964
|
+
['PureCloud OAuth'],
|
|
23965
|
+
['application/json'],
|
|
23966
|
+
['application/json']
|
|
23967
|
+
);
|
|
23968
|
+
}
|
|
23969
|
+
|
|
23970
|
+
/**
|
|
23971
|
+
* Get quantitative limits on schemas
|
|
23972
|
+
*
|
|
23973
|
+
*/
|
|
23974
|
+
getExternalcontactsContactsSchemasLimits() {
|
|
23975
|
+
|
|
23976
|
+
return this.apiClient.callApi(
|
|
23977
|
+
'/api/v2/externalcontacts/contacts/schemas/limits',
|
|
23978
|
+
'GET',
|
|
23979
|
+
{ },
|
|
23980
|
+
{ },
|
|
23981
|
+
{ },
|
|
23982
|
+
{ },
|
|
23983
|
+
null,
|
|
23984
|
+
['PureCloud OAuth'],
|
|
23985
|
+
['application/json'],
|
|
23986
|
+
['application/json']
|
|
23987
|
+
);
|
|
23988
|
+
}
|
|
23989
|
+
|
|
23836
23990
|
/**
|
|
23837
23991
|
* Fetch an External Source
|
|
23838
23992
|
*
|
|
@@ -24158,6 +24312,32 @@ class ExternalContactsApi {
|
|
|
24158
24312
|
);
|
|
24159
24313
|
}
|
|
24160
24314
|
|
|
24315
|
+
/**
|
|
24316
|
+
* List the identifiers for an external organization
|
|
24317
|
+
*
|
|
24318
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
24319
|
+
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24320
|
+
*/
|
|
24321
|
+
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
24322
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
24323
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null) {
|
|
24324
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationIdentifiers';
|
|
24325
|
+
}
|
|
24326
|
+
|
|
24327
|
+
return this.apiClient.callApi(
|
|
24328
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
|
|
24329
|
+
'GET',
|
|
24330
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
24331
|
+
{ },
|
|
24332
|
+
{ },
|
|
24333
|
+
{ },
|
|
24334
|
+
null,
|
|
24335
|
+
['PureCloud OAuth'],
|
|
24336
|
+
['application/json'],
|
|
24337
|
+
['application/json']
|
|
24338
|
+
);
|
|
24339
|
+
}
|
|
24340
|
+
|
|
24161
24341
|
/**
|
|
24162
24342
|
* Fetch a note for an external organization
|
|
24163
24343
|
*
|
|
@@ -24387,6 +24567,71 @@ class ExternalContactsApi {
|
|
|
24387
24567
|
);
|
|
24388
24568
|
}
|
|
24389
24569
|
|
|
24570
|
+
/**
|
|
24571
|
+
* Get the core types from which all schemas are built.
|
|
24572
|
+
*
|
|
24573
|
+
* @param {String} coreTypeName Name of the core type
|
|
24574
|
+
*/
|
|
24575
|
+
getExternalcontactsOrganizationsSchemasCoretype(coreTypeName) {
|
|
24576
|
+
// verify the required parameter 'coreTypeName' is set
|
|
24577
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
24578
|
+
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsOrganizationsSchemasCoretype';
|
|
24579
|
+
}
|
|
24580
|
+
|
|
24581
|
+
return this.apiClient.callApi(
|
|
24582
|
+
'/api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}',
|
|
24583
|
+
'GET',
|
|
24584
|
+
{ 'coreTypeName': coreTypeName },
|
|
24585
|
+
{ },
|
|
24586
|
+
{ },
|
|
24587
|
+
{ },
|
|
24588
|
+
null,
|
|
24589
|
+
['PureCloud OAuth'],
|
|
24590
|
+
['application/json'],
|
|
24591
|
+
['application/json']
|
|
24592
|
+
);
|
|
24593
|
+
}
|
|
24594
|
+
|
|
24595
|
+
/**
|
|
24596
|
+
* Get the core types from which all schemas are built.
|
|
24597
|
+
*
|
|
24598
|
+
*/
|
|
24599
|
+
getExternalcontactsOrganizationsSchemasCoretypes() {
|
|
24600
|
+
|
|
24601
|
+
return this.apiClient.callApi(
|
|
24602
|
+
'/api/v2/externalcontacts/organizations/schemas/coretypes',
|
|
24603
|
+
'GET',
|
|
24604
|
+
{ },
|
|
24605
|
+
{ },
|
|
24606
|
+
{ },
|
|
24607
|
+
{ },
|
|
24608
|
+
null,
|
|
24609
|
+
['PureCloud OAuth'],
|
|
24610
|
+
['application/json'],
|
|
24611
|
+
['application/json']
|
|
24612
|
+
);
|
|
24613
|
+
}
|
|
24614
|
+
|
|
24615
|
+
/**
|
|
24616
|
+
* Get quantitative limits on schemas
|
|
24617
|
+
*
|
|
24618
|
+
*/
|
|
24619
|
+
getExternalcontactsOrganizationsSchemasLimits() {
|
|
24620
|
+
|
|
24621
|
+
return this.apiClient.callApi(
|
|
24622
|
+
'/api/v2/externalcontacts/organizations/schemas/limits',
|
|
24623
|
+
'GET',
|
|
24624
|
+
{ },
|
|
24625
|
+
{ },
|
|
24626
|
+
{ },
|
|
24627
|
+
{ },
|
|
24628
|
+
null,
|
|
24629
|
+
['PureCloud OAuth'],
|
|
24630
|
+
['application/json'],
|
|
24631
|
+
['application/json']
|
|
24632
|
+
);
|
|
24633
|
+
}
|
|
24634
|
+
|
|
24390
24635
|
/**
|
|
24391
24636
|
* Fetch a relationship
|
|
24392
24637
|
*
|
|
@@ -24417,12 +24662,12 @@ class ExternalContactsApi {
|
|
|
24417
24662
|
}
|
|
24418
24663
|
|
|
24419
24664
|
/**
|
|
24420
|
-
* Look up contacts
|
|
24665
|
+
* Look up contacts based on an attribute. Maximum of 25 values returned.
|
|
24421
24666
|
*
|
|
24422
|
-
* @param {String} lookupVal User supplied value to lookup contacts
|
|
24667
|
+
* @param {String} lookupVal User supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
24423
24668
|
* @param {Object} opts Optional parameters
|
|
24424
24669
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
24425
|
-
* @param {String} opts.divisionId Specifies which division to lookup contacts
|
|
24670
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts in, for the given lookup value (default to *)
|
|
24426
24671
|
*/
|
|
24427
24672
|
getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
|
|
24428
24673
|
opts = opts || {};
|
|
@@ -24684,6 +24929,37 @@ class ExternalContactsApi {
|
|
|
24684
24929
|
);
|
|
24685
24930
|
}
|
|
24686
24931
|
|
|
24932
|
+
/**
|
|
24933
|
+
* Claim or release identifiers for an external organization
|
|
24934
|
+
*
|
|
24935
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
24936
|
+
* @param {Object} body ClaimRequest
|
|
24937
|
+
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24938
|
+
*/
|
|
24939
|
+
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
24940
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
24941
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null) {
|
|
24942
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
24943
|
+
}
|
|
24944
|
+
// verify the required parameter 'body' is set
|
|
24945
|
+
if (body === undefined || body === null) {
|
|
24946
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
24947
|
+
}
|
|
24948
|
+
|
|
24949
|
+
return this.apiClient.callApi(
|
|
24950
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
|
|
24951
|
+
'PATCH',
|
|
24952
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
24953
|
+
{ },
|
|
24954
|
+
{ },
|
|
24955
|
+
{ },
|
|
24956
|
+
body,
|
|
24957
|
+
['PureCloud OAuth'],
|
|
24958
|
+
['application/json'],
|
|
24959
|
+
['application/json']
|
|
24960
|
+
);
|
|
24961
|
+
}
|
|
24962
|
+
|
|
24687
24963
|
/**
|
|
24688
24964
|
* Bulk fetch contacts
|
|
24689
24965
|
*
|
|
@@ -24760,6 +25036,36 @@ class ExternalContactsApi {
|
|
|
24760
25036
|
);
|
|
24761
25037
|
}
|
|
24762
25038
|
|
|
25039
|
+
/**
|
|
25040
|
+
* Bulk Enrich Contacts - Run up to 10 Enrich operations per request
|
|
25041
|
+
* See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
|
|
25042
|
+
* @param {Object} body Contact Enrich Requests
|
|
25043
|
+
* @param {Object} opts Optional parameters
|
|
25044
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25045
|
+
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25046
|
+
*/
|
|
25047
|
+
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
25048
|
+
opts = opts || {};
|
|
25049
|
+
|
|
25050
|
+
// verify the required parameter 'body' is set
|
|
25051
|
+
if (body === undefined || body === null) {
|
|
25052
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsEnrich';
|
|
25053
|
+
}
|
|
25054
|
+
|
|
25055
|
+
return this.apiClient.callApi(
|
|
25056
|
+
'/api/v2/externalcontacts/bulk/contacts/enrich',
|
|
25057
|
+
'POST',
|
|
25058
|
+
{ },
|
|
25059
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25060
|
+
{ },
|
|
25061
|
+
{ },
|
|
25062
|
+
body,
|
|
25063
|
+
['PureCloud OAuth'],
|
|
25064
|
+
['application/json'],
|
|
25065
|
+
['application/json']
|
|
25066
|
+
);
|
|
25067
|
+
}
|
|
25068
|
+
|
|
24763
25069
|
/**
|
|
24764
25070
|
* Bulk remove contacts
|
|
24765
25071
|
*
|
|
@@ -25011,6 +25317,36 @@ class ExternalContactsApi {
|
|
|
25011
25317
|
);
|
|
25012
25318
|
}
|
|
25013
25319
|
|
|
25320
|
+
/**
|
|
25321
|
+
* Bulk enrich external organizations - Run up to 10 Enrich operations per request
|
|
25322
|
+
* See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
|
|
25323
|
+
* @param {Object} body External Organization Enrich Requests
|
|
25324
|
+
* @param {Object} opts Optional parameters
|
|
25325
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25326
|
+
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25327
|
+
*/
|
|
25328
|
+
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
25329
|
+
opts = opts || {};
|
|
25330
|
+
|
|
25331
|
+
// verify the required parameter 'body' is set
|
|
25332
|
+
if (body === undefined || body === null) {
|
|
25333
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsEnrich';
|
|
25334
|
+
}
|
|
25335
|
+
|
|
25336
|
+
return this.apiClient.callApi(
|
|
25337
|
+
'/api/v2/externalcontacts/bulk/organizations/enrich',
|
|
25338
|
+
'POST',
|
|
25339
|
+
{ },
|
|
25340
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25341
|
+
{ },
|
|
25342
|
+
{ },
|
|
25343
|
+
body,
|
|
25344
|
+
['PureCloud OAuth'],
|
|
25345
|
+
['application/json'],
|
|
25346
|
+
['application/json']
|
|
25347
|
+
);
|
|
25348
|
+
}
|
|
25349
|
+
|
|
25014
25350
|
/**
|
|
25015
25351
|
* Bulk remove organizations
|
|
25016
25352
|
*
|
|
@@ -25241,6 +25577,36 @@ class ExternalContactsApi {
|
|
|
25241
25577
|
);
|
|
25242
25578
|
}
|
|
25243
25579
|
|
|
25580
|
+
/**
|
|
25581
|
+
* Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
|
|
25582
|
+
* 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.
|
|
25583
|
+
* @param {Object} body ContactEnrichRequest
|
|
25584
|
+
* @param {Object} opts Optional parameters
|
|
25585
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25586
|
+
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25587
|
+
*/
|
|
25588
|
+
postExternalcontactsContactsEnrich(body, opts) {
|
|
25589
|
+
opts = opts || {};
|
|
25590
|
+
|
|
25591
|
+
// verify the required parameter 'body' is set
|
|
25592
|
+
if (body === undefined || body === null) {
|
|
25593
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsEnrich';
|
|
25594
|
+
}
|
|
25595
|
+
|
|
25596
|
+
return this.apiClient.callApi(
|
|
25597
|
+
'/api/v2/externalcontacts/contacts/enrich',
|
|
25598
|
+
'POST',
|
|
25599
|
+
{ },
|
|
25600
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25601
|
+
{ },
|
|
25602
|
+
{ },
|
|
25603
|
+
body,
|
|
25604
|
+
['PureCloud OAuth'],
|
|
25605
|
+
['application/json'],
|
|
25606
|
+
['application/json']
|
|
25607
|
+
);
|
|
25608
|
+
}
|
|
25609
|
+
|
|
25244
25610
|
/**
|
|
25245
25611
|
* Create bulk export
|
|
25246
25612
|
*
|
|
@@ -25266,6 +25632,32 @@ class ExternalContactsApi {
|
|
|
25266
25632
|
);
|
|
25267
25633
|
}
|
|
25268
25634
|
|
|
25635
|
+
/**
|
|
25636
|
+
* Merge up to 25 contacts into a new contact record
|
|
25637
|
+
* 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.
|
|
25638
|
+
* @param {Object} body MergeRequest
|
|
25639
|
+
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25640
|
+
*/
|
|
25641
|
+
postExternalcontactsContactsMerge(body) {
|
|
25642
|
+
// verify the required parameter 'body' is set
|
|
25643
|
+
if (body === undefined || body === null) {
|
|
25644
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsMerge';
|
|
25645
|
+
}
|
|
25646
|
+
|
|
25647
|
+
return this.apiClient.callApi(
|
|
25648
|
+
'/api/v2/externalcontacts/contacts/merge',
|
|
25649
|
+
'POST',
|
|
25650
|
+
{ },
|
|
25651
|
+
{ },
|
|
25652
|
+
{ },
|
|
25653
|
+
{ },
|
|
25654
|
+
body,
|
|
25655
|
+
['PureCloud OAuth'],
|
|
25656
|
+
['application/json'],
|
|
25657
|
+
['application/json']
|
|
25658
|
+
);
|
|
25659
|
+
}
|
|
25660
|
+
|
|
25269
25661
|
/**
|
|
25270
25662
|
* Create a schema
|
|
25271
25663
|
*
|
|
@@ -25346,6 +25738,66 @@ class ExternalContactsApi {
|
|
|
25346
25738
|
);
|
|
25347
25739
|
}
|
|
25348
25740
|
|
|
25741
|
+
/**
|
|
25742
|
+
* Fetch a contact using an identifier type and value.
|
|
25743
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
25744
|
+
* @param {Object} identifier
|
|
25745
|
+
* @param {Object} opts Optional parameters
|
|
25746
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25747
|
+
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25748
|
+
*/
|
|
25749
|
+
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
25750
|
+
opts = opts || {};
|
|
25751
|
+
|
|
25752
|
+
// verify the required parameter 'identifier' is set
|
|
25753
|
+
if (identifier === undefined || identifier === null) {
|
|
25754
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupContacts';
|
|
25755
|
+
}
|
|
25756
|
+
|
|
25757
|
+
return this.apiClient.callApi(
|
|
25758
|
+
'/api/v2/externalcontacts/identifierlookup/contacts',
|
|
25759
|
+
'POST',
|
|
25760
|
+
{ },
|
|
25761
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25762
|
+
{ },
|
|
25763
|
+
{ },
|
|
25764
|
+
identifier,
|
|
25765
|
+
['PureCloud OAuth'],
|
|
25766
|
+
['application/json'],
|
|
25767
|
+
['application/json']
|
|
25768
|
+
);
|
|
25769
|
+
}
|
|
25770
|
+
|
|
25771
|
+
/**
|
|
25772
|
+
* Fetch an external organization using an identifier type and value.
|
|
25773
|
+
* This endpoint will only accept ExternalId type identifiers.
|
|
25774
|
+
* @param {Object} identifier
|
|
25775
|
+
* @param {Object} opts Optional parameters
|
|
25776
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25777
|
+
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25778
|
+
*/
|
|
25779
|
+
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
25780
|
+
opts = opts || {};
|
|
25781
|
+
|
|
25782
|
+
// verify the required parameter 'identifier' is set
|
|
25783
|
+
if (identifier === undefined || identifier === null) {
|
|
25784
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupOrganizations';
|
|
25785
|
+
}
|
|
25786
|
+
|
|
25787
|
+
return this.apiClient.callApi(
|
|
25788
|
+
'/api/v2/externalcontacts/identifierlookup/organizations',
|
|
25789
|
+
'POST',
|
|
25790
|
+
{ },
|
|
25791
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25792
|
+
{ },
|
|
25793
|
+
{ },
|
|
25794
|
+
identifier,
|
|
25795
|
+
['PureCloud OAuth'],
|
|
25796
|
+
['application/json'],
|
|
25797
|
+
['application/json']
|
|
25798
|
+
);
|
|
25799
|
+
}
|
|
25800
|
+
|
|
25349
25801
|
/**
|
|
25350
25802
|
* Create CSV import job
|
|
25351
25803
|
*
|
|
@@ -25473,8 +25925,9 @@ class ExternalContactsApi {
|
|
|
25473
25925
|
|
|
25474
25926
|
/**
|
|
25475
25927
|
* Merge two contacts into a new contact record
|
|
25476
|
-
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
25928
|
+
* 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.
|
|
25477
25929
|
* @param {Object} body MergeRequest
|
|
25930
|
+
* @deprecated
|
|
25478
25931
|
*/
|
|
25479
25932
|
postExternalcontactsMergeContacts(body) {
|
|
25480
25933
|
// verify the required parameter 'body' is set
|
|
@@ -25551,6 +26004,36 @@ class ExternalContactsApi {
|
|
|
25551
26004
|
);
|
|
25552
26005
|
}
|
|
25553
26006
|
|
|
26007
|
+
/**
|
|
26008
|
+
* Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
|
|
26009
|
+
* 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
|
|
26010
|
+
* @param {Object} body ExternalOrgEnrichRequest
|
|
26011
|
+
* @param {Object} opts Optional parameters
|
|
26012
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
26013
|
+
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26014
|
+
*/
|
|
26015
|
+
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
26016
|
+
opts = opts || {};
|
|
26017
|
+
|
|
26018
|
+
// verify the required parameter 'body' is set
|
|
26019
|
+
if (body === undefined || body === null) {
|
|
26020
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsOrganizationsEnrich';
|
|
26021
|
+
}
|
|
26022
|
+
|
|
26023
|
+
return this.apiClient.callApi(
|
|
26024
|
+
'/api/v2/externalcontacts/organizations/enrich',
|
|
26025
|
+
'POST',
|
|
26026
|
+
{ },
|
|
26027
|
+
{ 'dryRun': opts['dryRun'] },
|
|
26028
|
+
{ },
|
|
26029
|
+
{ },
|
|
26030
|
+
body,
|
|
26031
|
+
['PureCloud OAuth'],
|
|
26032
|
+
['application/json'],
|
|
26033
|
+
['application/json']
|
|
26034
|
+
);
|
|
26035
|
+
}
|
|
26036
|
+
|
|
25554
26037
|
/**
|
|
25555
26038
|
* Create a schema
|
|
25556
26039
|
*
|
|
@@ -26007,7 +26490,7 @@ class FaxApi {
|
|
|
26007
26490
|
/**
|
|
26008
26491
|
* Fax service.
|
|
26009
26492
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
26010
|
-
* @version
|
|
26493
|
+
* @version 220.0.0
|
|
26011
26494
|
*/
|
|
26012
26495
|
|
|
26013
26496
|
/**
|
|
@@ -26222,7 +26705,7 @@ class FlowsApi {
|
|
|
26222
26705
|
/**
|
|
26223
26706
|
* Flows service.
|
|
26224
26707
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
26225
|
-
* @version
|
|
26708
|
+
* @version 220.0.0
|
|
26226
26709
|
*/
|
|
26227
26710
|
|
|
26228
26711
|
/**
|
|
@@ -26405,7 +26888,7 @@ class GamificationApi {
|
|
|
26405
26888
|
/**
|
|
26406
26889
|
* Gamification service.
|
|
26407
26890
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
26408
|
-
* @version
|
|
26891
|
+
* @version 220.0.0
|
|
26409
26892
|
*/
|
|
26410
26893
|
|
|
26411
26894
|
/**
|
|
@@ -26445,6 +26928,31 @@ class GamificationApi {
|
|
|
26445
26928
|
);
|
|
26446
26929
|
}
|
|
26447
26930
|
|
|
26931
|
+
/**
|
|
26932
|
+
* Delete a Contest by Id
|
|
26933
|
+
*
|
|
26934
|
+
* @param {String} contestId The ID of the contest
|
|
26935
|
+
*/
|
|
26936
|
+
deleteGamificationContest(contestId) {
|
|
26937
|
+
// verify the required parameter 'contestId' is set
|
|
26938
|
+
if (contestId === undefined || contestId === null) {
|
|
26939
|
+
throw 'Missing the required parameter "contestId" when calling deleteGamificationContest';
|
|
26940
|
+
}
|
|
26941
|
+
|
|
26942
|
+
return this.apiClient.callApi(
|
|
26943
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
26944
|
+
'DELETE',
|
|
26945
|
+
{ 'contestId': contestId },
|
|
26946
|
+
{ },
|
|
26947
|
+
{ },
|
|
26948
|
+
{ },
|
|
26949
|
+
null,
|
|
26950
|
+
['PureCloud OAuth'],
|
|
26951
|
+
['application/json'],
|
|
26952
|
+
['application/json']
|
|
26953
|
+
);
|
|
26954
|
+
}
|
|
26955
|
+
|
|
26448
26956
|
/**
|
|
26449
26957
|
* Get an External Metric Definition
|
|
26450
26958
|
*
|
|
@@ -26495,6 +27003,236 @@ class GamificationApi {
|
|
|
26495
27003
|
);
|
|
26496
27004
|
}
|
|
26497
27005
|
|
|
27006
|
+
/**
|
|
27007
|
+
* Get a Contest by Id
|
|
27008
|
+
*
|
|
27009
|
+
* @param {String} contestId The ID of the contest
|
|
27010
|
+
*/
|
|
27011
|
+
getGamificationContest(contestId) {
|
|
27012
|
+
// verify the required parameter 'contestId' is set
|
|
27013
|
+
if (contestId === undefined || contestId === null) {
|
|
27014
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContest';
|
|
27015
|
+
}
|
|
27016
|
+
|
|
27017
|
+
return this.apiClient.callApi(
|
|
27018
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
27019
|
+
'GET',
|
|
27020
|
+
{ 'contestId': contestId },
|
|
27021
|
+
{ },
|
|
27022
|
+
{ },
|
|
27023
|
+
{ },
|
|
27024
|
+
null,
|
|
27025
|
+
['PureCloud OAuth'],
|
|
27026
|
+
['application/json'],
|
|
27027
|
+
['application/json']
|
|
27028
|
+
);
|
|
27029
|
+
}
|
|
27030
|
+
|
|
27031
|
+
/**
|
|
27032
|
+
* Get Contest Scores (Admin)
|
|
27033
|
+
*
|
|
27034
|
+
* @param {String} contestId The ID of the contest
|
|
27035
|
+
* @param {Object} opts Optional parameters
|
|
27036
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27037
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27038
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27039
|
+
* @param {Object} opts.returnsView Desired response results (default to All)
|
|
27040
|
+
*/
|
|
27041
|
+
getGamificationContestAgentsScores(contestId, opts) {
|
|
27042
|
+
opts = opts || {};
|
|
27043
|
+
|
|
27044
|
+
// verify the required parameter 'contestId' is set
|
|
27045
|
+
if (contestId === undefined || contestId === null) {
|
|
27046
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScores';
|
|
27047
|
+
}
|
|
27048
|
+
|
|
27049
|
+
return this.apiClient.callApi(
|
|
27050
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores',
|
|
27051
|
+
'GET',
|
|
27052
|
+
{ 'contestId': contestId },
|
|
27053
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
|
|
27054
|
+
{ },
|
|
27055
|
+
{ },
|
|
27056
|
+
null,
|
|
27057
|
+
['PureCloud OAuth'],
|
|
27058
|
+
['application/json'],
|
|
27059
|
+
['application/json']
|
|
27060
|
+
);
|
|
27061
|
+
}
|
|
27062
|
+
|
|
27063
|
+
/**
|
|
27064
|
+
* Get Contest Scores for the requesting Agent/Supervisor
|
|
27065
|
+
*
|
|
27066
|
+
* @param {String} contestId The ID of the contest
|
|
27067
|
+
* @param {Object} opts Optional parameters
|
|
27068
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27069
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27070
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27071
|
+
* @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
|
|
27072
|
+
*/
|
|
27073
|
+
getGamificationContestAgentsScoresMe(contestId, opts) {
|
|
27074
|
+
opts = opts || {};
|
|
27075
|
+
|
|
27076
|
+
// verify the required parameter 'contestId' is set
|
|
27077
|
+
if (contestId === undefined || contestId === null) {
|
|
27078
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresMe';
|
|
27079
|
+
}
|
|
27080
|
+
|
|
27081
|
+
return this.apiClient.callApi(
|
|
27082
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/me',
|
|
27083
|
+
'GET',
|
|
27084
|
+
{ 'contestId': contestId },
|
|
27085
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
|
|
27086
|
+
{ },
|
|
27087
|
+
{ },
|
|
27088
|
+
null,
|
|
27089
|
+
['PureCloud OAuth'],
|
|
27090
|
+
['application/json'],
|
|
27091
|
+
['application/json']
|
|
27092
|
+
);
|
|
27093
|
+
}
|
|
27094
|
+
|
|
27095
|
+
/**
|
|
27096
|
+
* Get a Contest Score Trend (Average Trend)
|
|
27097
|
+
*
|
|
27098
|
+
* @param {String} contestId The ID of the contest
|
|
27099
|
+
*/
|
|
27100
|
+
getGamificationContestAgentsScoresTrends(contestId) {
|
|
27101
|
+
// verify the required parameter 'contestId' is set
|
|
27102
|
+
if (contestId === undefined || contestId === null) {
|
|
27103
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';
|
|
27104
|
+
}
|
|
27105
|
+
|
|
27106
|
+
return this.apiClient.callApi(
|
|
27107
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/trends',
|
|
27108
|
+
'GET',
|
|
27109
|
+
{ 'contestId': contestId },
|
|
27110
|
+
{ },
|
|
27111
|
+
{ },
|
|
27112
|
+
{ },
|
|
27113
|
+
null,
|
|
27114
|
+
['PureCloud OAuth'],
|
|
27115
|
+
['application/json'],
|
|
27116
|
+
['application/json']
|
|
27117
|
+
);
|
|
27118
|
+
}
|
|
27119
|
+
|
|
27120
|
+
/**
|
|
27121
|
+
* Get a Contest Score Trend for the requesting Agent
|
|
27122
|
+
*
|
|
27123
|
+
* @param {String} contestId The ID of the contest
|
|
27124
|
+
*/
|
|
27125
|
+
getGamificationContestAgentsScoresTrendsMe(contestId) {
|
|
27126
|
+
// verify the required parameter 'contestId' is set
|
|
27127
|
+
if (contestId === undefined || contestId === null) {
|
|
27128
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';
|
|
27129
|
+
}
|
|
27130
|
+
|
|
27131
|
+
return this.apiClient.callApi(
|
|
27132
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/trends/me',
|
|
27133
|
+
'GET',
|
|
27134
|
+
{ 'contestId': contestId },
|
|
27135
|
+
{ },
|
|
27136
|
+
{ },
|
|
27137
|
+
{ },
|
|
27138
|
+
null,
|
|
27139
|
+
['PureCloud OAuth'],
|
|
27140
|
+
['application/json'],
|
|
27141
|
+
['application/json']
|
|
27142
|
+
);
|
|
27143
|
+
}
|
|
27144
|
+
|
|
27145
|
+
/**
|
|
27146
|
+
* Get a Contest Prize Image by Id
|
|
27147
|
+
*
|
|
27148
|
+
* @param {String} contestId The ID of the contest
|
|
27149
|
+
* @param {String} prizeImageId The ID of the prize image
|
|
27150
|
+
*/
|
|
27151
|
+
getGamificationContestPrizeimage(contestId, prizeImageId) {
|
|
27152
|
+
// verify the required parameter 'contestId' is set
|
|
27153
|
+
if (contestId === undefined || contestId === null) {
|
|
27154
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';
|
|
27155
|
+
}
|
|
27156
|
+
// verify the required parameter 'prizeImageId' is set
|
|
27157
|
+
if (prizeImageId === undefined || prizeImageId === null) {
|
|
27158
|
+
throw 'Missing the required parameter "prizeImageId" when calling getGamificationContestPrizeimage';
|
|
27159
|
+
}
|
|
27160
|
+
|
|
27161
|
+
return this.apiClient.callApi(
|
|
27162
|
+
'/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}',
|
|
27163
|
+
'GET',
|
|
27164
|
+
{ 'contestId': contestId,'prizeImageId': prizeImageId },
|
|
27165
|
+
{ },
|
|
27166
|
+
{ },
|
|
27167
|
+
{ },
|
|
27168
|
+
null,
|
|
27169
|
+
['PureCloud OAuth'],
|
|
27170
|
+
['application/json'],
|
|
27171
|
+
['application/json']
|
|
27172
|
+
);
|
|
27173
|
+
}
|
|
27174
|
+
|
|
27175
|
+
/**
|
|
27176
|
+
* Get a List of Contests (Admin)
|
|
27177
|
+
*
|
|
27178
|
+
* @param {Object} opts Optional parameters
|
|
27179
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27180
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27181
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27182
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27183
|
+
* @param {Array.<String>} opts.status
|
|
27184
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
27185
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
27186
|
+
*/
|
|
27187
|
+
getGamificationContests(opts) {
|
|
27188
|
+
opts = opts || {};
|
|
27189
|
+
|
|
27190
|
+
|
|
27191
|
+
return this.apiClient.callApi(
|
|
27192
|
+
'/api/v2/gamification/contests',
|
|
27193
|
+
'GET',
|
|
27194
|
+
{ },
|
|
27195
|
+
{ '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'] },
|
|
27196
|
+
{ },
|
|
27197
|
+
{ },
|
|
27198
|
+
null,
|
|
27199
|
+
['PureCloud OAuth'],
|
|
27200
|
+
['application/json'],
|
|
27201
|
+
['application/json']
|
|
27202
|
+
);
|
|
27203
|
+
}
|
|
27204
|
+
|
|
27205
|
+
/**
|
|
27206
|
+
* Get a List of Contests (Agent/Supervisor)
|
|
27207
|
+
*
|
|
27208
|
+
* @param {Object} opts Optional parameters
|
|
27209
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27210
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27211
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27212
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27213
|
+
* @param {Array.<String>} opts.status
|
|
27214
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
27215
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
27216
|
+
* @param {Object} opts.view (default to participant)
|
|
27217
|
+
*/
|
|
27218
|
+
getGamificationContestsMe(opts) {
|
|
27219
|
+
opts = opts || {};
|
|
27220
|
+
|
|
27221
|
+
|
|
27222
|
+
return this.apiClient.callApi(
|
|
27223
|
+
'/api/v2/gamification/contests/me',
|
|
27224
|
+
'GET',
|
|
27225
|
+
{ },
|
|
27226
|
+
{ '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'] },
|
|
27227
|
+
{ },
|
|
27228
|
+
{ },
|
|
27229
|
+
null,
|
|
27230
|
+
['PureCloud OAuth'],
|
|
27231
|
+
['application/json'],
|
|
27232
|
+
['application/json']
|
|
27233
|
+
);
|
|
27234
|
+
}
|
|
27235
|
+
|
|
26498
27236
|
/**
|
|
26499
27237
|
* Get insights summary
|
|
26500
27238
|
*
|
|
@@ -28145,6 +28883,36 @@ class GamificationApi {
|
|
|
28145
28883
|
);
|
|
28146
28884
|
}
|
|
28147
28885
|
|
|
28886
|
+
/**
|
|
28887
|
+
* Finalize a Contest by Id
|
|
28888
|
+
*
|
|
28889
|
+
* @param {String} contestId The ID of the contest
|
|
28890
|
+
* @param {Object} body Finalize Contest
|
|
28891
|
+
*/
|
|
28892
|
+
patchGamificationContest(contestId, body) {
|
|
28893
|
+
// verify the required parameter 'contestId' is set
|
|
28894
|
+
if (contestId === undefined || contestId === null) {
|
|
28895
|
+
throw 'Missing the required parameter "contestId" when calling patchGamificationContest';
|
|
28896
|
+
}
|
|
28897
|
+
// verify the required parameter 'body' is set
|
|
28898
|
+
if (body === undefined || body === null) {
|
|
28899
|
+
throw 'Missing the required parameter "body" when calling patchGamificationContest';
|
|
28900
|
+
}
|
|
28901
|
+
|
|
28902
|
+
return this.apiClient.callApi(
|
|
28903
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
28904
|
+
'PATCH',
|
|
28905
|
+
{ 'contestId': contestId },
|
|
28906
|
+
{ },
|
|
28907
|
+
{ },
|
|
28908
|
+
{ },
|
|
28909
|
+
body,
|
|
28910
|
+
['PureCloud OAuth'],
|
|
28911
|
+
['application/json'],
|
|
28912
|
+
['application/json']
|
|
28913
|
+
);
|
|
28914
|
+
}
|
|
28915
|
+
|
|
28148
28916
|
/**
|
|
28149
28917
|
* Write External Metric Data
|
|
28150
28918
|
*
|
|
@@ -28193,6 +28961,56 @@ class GamificationApi {
|
|
|
28193
28961
|
);
|
|
28194
28962
|
}
|
|
28195
28963
|
|
|
28964
|
+
/**
|
|
28965
|
+
* Creates a Contest
|
|
28966
|
+
*
|
|
28967
|
+
* @param {Object} body Create Contest
|
|
28968
|
+
*/
|
|
28969
|
+
postGamificationContests(body) {
|
|
28970
|
+
// verify the required parameter 'body' is set
|
|
28971
|
+
if (body === undefined || body === null) {
|
|
28972
|
+
throw 'Missing the required parameter "body" when calling postGamificationContests';
|
|
28973
|
+
}
|
|
28974
|
+
|
|
28975
|
+
return this.apiClient.callApi(
|
|
28976
|
+
'/api/v2/gamification/contests',
|
|
28977
|
+
'POST',
|
|
28978
|
+
{ },
|
|
28979
|
+
{ },
|
|
28980
|
+
{ },
|
|
28981
|
+
{ },
|
|
28982
|
+
body,
|
|
28983
|
+
['PureCloud OAuth'],
|
|
28984
|
+
['application/json'],
|
|
28985
|
+
['application/json']
|
|
28986
|
+
);
|
|
28987
|
+
}
|
|
28988
|
+
|
|
28989
|
+
/**
|
|
28990
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
28991
|
+
*
|
|
28992
|
+
* @param {Object} body query
|
|
28993
|
+
*/
|
|
28994
|
+
postGamificationContestsUploadsPrizeimages(body) {
|
|
28995
|
+
// verify the required parameter 'body' is set
|
|
28996
|
+
if (body === undefined || body === null) {
|
|
28997
|
+
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
28998
|
+
}
|
|
28999
|
+
|
|
29000
|
+
return this.apiClient.callApi(
|
|
29001
|
+
'/api/v2/gamification/contests/uploads/prizeimages',
|
|
29002
|
+
'POST',
|
|
29003
|
+
{ },
|
|
29004
|
+
{ },
|
|
29005
|
+
{ },
|
|
29006
|
+
{ },
|
|
29007
|
+
body,
|
|
29008
|
+
['PureCloud OAuth'],
|
|
29009
|
+
['application/json'],
|
|
29010
|
+
['application/json']
|
|
29011
|
+
);
|
|
29012
|
+
}
|
|
29013
|
+
|
|
28196
29014
|
/**
|
|
28197
29015
|
* Activate a performance profile
|
|
28198
29016
|
*
|
|
@@ -28452,6 +29270,36 @@ class GamificationApi {
|
|
|
28452
29270
|
);
|
|
28453
29271
|
}
|
|
28454
29272
|
|
|
29273
|
+
/**
|
|
29274
|
+
* Update a Contest by Id
|
|
29275
|
+
*
|
|
29276
|
+
* @param {String} contestId The ID of the contest
|
|
29277
|
+
* @param {Object} body Contest
|
|
29278
|
+
*/
|
|
29279
|
+
putGamificationContest(contestId, body) {
|
|
29280
|
+
// verify the required parameter 'contestId' is set
|
|
29281
|
+
if (contestId === undefined || contestId === null) {
|
|
29282
|
+
throw 'Missing the required parameter "contestId" when calling putGamificationContest';
|
|
29283
|
+
}
|
|
29284
|
+
// verify the required parameter 'body' is set
|
|
29285
|
+
if (body === undefined || body === null) {
|
|
29286
|
+
throw 'Missing the required parameter "body" when calling putGamificationContest';
|
|
29287
|
+
}
|
|
29288
|
+
|
|
29289
|
+
return this.apiClient.callApi(
|
|
29290
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
29291
|
+
'PUT',
|
|
29292
|
+
{ 'contestId': contestId },
|
|
29293
|
+
{ },
|
|
29294
|
+
{ },
|
|
29295
|
+
{ },
|
|
29296
|
+
body,
|
|
29297
|
+
['PureCloud OAuth'],
|
|
29298
|
+
['application/json'],
|
|
29299
|
+
['application/json']
|
|
29300
|
+
);
|
|
29301
|
+
}
|
|
29302
|
+
|
|
28455
29303
|
/**
|
|
28456
29304
|
* Updates a performance profile
|
|
28457
29305
|
*
|
|
@@ -28547,7 +29395,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
28547
29395
|
/**
|
|
28548
29396
|
* GeneralDataProtectionRegulation service.
|
|
28549
29397
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
28550
|
-
* @version
|
|
29398
|
+
* @version 220.0.0
|
|
28551
29399
|
*/
|
|
28552
29400
|
|
|
28553
29401
|
/**
|
|
@@ -28677,7 +29525,7 @@ class GeolocationApi {
|
|
|
28677
29525
|
/**
|
|
28678
29526
|
* Geolocation service.
|
|
28679
29527
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
28680
|
-
* @version
|
|
29528
|
+
* @version 220.0.0
|
|
28681
29529
|
*/
|
|
28682
29530
|
|
|
28683
29531
|
/**
|
|
@@ -28808,7 +29656,7 @@ class GreetingsApi {
|
|
|
28808
29656
|
/**
|
|
28809
29657
|
* Greetings service.
|
|
28810
29658
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
28811
|
-
* @version
|
|
29659
|
+
* @version 220.0.0
|
|
28812
29660
|
*/
|
|
28813
29661
|
|
|
28814
29662
|
/**
|
|
@@ -29263,7 +30111,7 @@ class GroupsApi {
|
|
|
29263
30111
|
/**
|
|
29264
30112
|
* Groups service.
|
|
29265
30113
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
29266
|
-
* @version
|
|
30114
|
+
* @version 220.0.0
|
|
29267
30115
|
*/
|
|
29268
30116
|
|
|
29269
30117
|
/**
|
|
@@ -29782,7 +30630,7 @@ class IdentityProviderApi {
|
|
|
29782
30630
|
/**
|
|
29783
30631
|
* IdentityProvider service.
|
|
29784
30632
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
29785
|
-
* @version
|
|
30633
|
+
* @version 220.0.0
|
|
29786
30634
|
*/
|
|
29787
30635
|
|
|
29788
30636
|
/**
|
|
@@ -30643,7 +31491,7 @@ class InfrastructureAsCodeApi {
|
|
|
30643
31491
|
/**
|
|
30644
31492
|
* InfrastructureAsCode service.
|
|
30645
31493
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
30646
|
-
* @version
|
|
31494
|
+
* @version 220.0.0
|
|
30647
31495
|
*/
|
|
30648
31496
|
|
|
30649
31497
|
/**
|
|
@@ -30810,7 +31658,7 @@ class IntegrationsApi {
|
|
|
30810
31658
|
/**
|
|
30811
31659
|
* Integrations service.
|
|
30812
31660
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
30813
|
-
* @version
|
|
31661
|
+
* @version 220.0.0
|
|
30814
31662
|
*/
|
|
30815
31663
|
|
|
30816
31664
|
/**
|
|
@@ -33279,7 +34127,7 @@ class JourneyApi {
|
|
|
33279
34127
|
/**
|
|
33280
34128
|
* Journey service.
|
|
33281
34129
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
33282
|
-
* @version
|
|
34130
|
+
* @version 220.0.0
|
|
33283
34131
|
*/
|
|
33284
34132
|
|
|
33285
34133
|
/**
|
|
@@ -35264,7 +36112,7 @@ class KnowledgeApi {
|
|
|
35264
36112
|
/**
|
|
35265
36113
|
* Knowledge service.
|
|
35266
36114
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
35267
|
-
* @version
|
|
36115
|
+
* @version 220.0.0
|
|
35268
36116
|
*/
|
|
35269
36117
|
|
|
35270
36118
|
/**
|
|
@@ -39137,7 +39985,7 @@ class LanguageUnderstandingApi {
|
|
|
39137
39985
|
/**
|
|
39138
39986
|
* LanguageUnderstanding service.
|
|
39139
39987
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
39140
|
-
* @version
|
|
39988
|
+
* @version 220.0.0
|
|
39141
39989
|
*/
|
|
39142
39990
|
|
|
39143
39991
|
/**
|
|
@@ -40170,7 +41018,7 @@ class LanguagesApi {
|
|
|
40170
41018
|
/**
|
|
40171
41019
|
* Languages service.
|
|
40172
41020
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
40173
|
-
* @version
|
|
41021
|
+
* @version 220.0.0
|
|
40174
41022
|
*/
|
|
40175
41023
|
|
|
40176
41024
|
/**
|
|
@@ -40392,7 +41240,7 @@ class LearningApi {
|
|
|
40392
41240
|
/**
|
|
40393
41241
|
* Learning service.
|
|
40394
41242
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
40395
|
-
* @version
|
|
41243
|
+
* @version 220.0.0
|
|
40396
41244
|
*/
|
|
40397
41245
|
|
|
40398
41246
|
/**
|
|
@@ -41421,7 +42269,7 @@ class LicenseApi {
|
|
|
41421
42269
|
/**
|
|
41422
42270
|
* License service.
|
|
41423
42271
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
41424
|
-
* @version
|
|
42272
|
+
* @version 220.0.0
|
|
41425
42273
|
*/
|
|
41426
42274
|
|
|
41427
42275
|
/**
|
|
@@ -41659,7 +42507,7 @@ class LocationsApi {
|
|
|
41659
42507
|
/**
|
|
41660
42508
|
* Locations service.
|
|
41661
42509
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41662
|
-
* @version
|
|
42510
|
+
* @version 220.0.0
|
|
41663
42511
|
*/
|
|
41664
42512
|
|
|
41665
42513
|
/**
|
|
@@ -41895,7 +42743,7 @@ class LogCaptureApi {
|
|
|
41895
42743
|
/**
|
|
41896
42744
|
* LogCapture service.
|
|
41897
42745
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
41898
|
-
* @version
|
|
42746
|
+
* @version 220.0.0
|
|
41899
42747
|
*/
|
|
41900
42748
|
|
|
41901
42749
|
/**
|
|
@@ -42095,7 +42943,7 @@ class MessagingApi {
|
|
|
42095
42943
|
/**
|
|
42096
42944
|
* Messaging service.
|
|
42097
42945
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
42098
|
-
* @version
|
|
42946
|
+
* @version 220.0.0
|
|
42099
42947
|
*/
|
|
42100
42948
|
|
|
42101
42949
|
/**
|
|
@@ -42454,7 +43302,7 @@ class MobileDevicesApi {
|
|
|
42454
43302
|
/**
|
|
42455
43303
|
* MobileDevices service.
|
|
42456
43304
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
42457
|
-
* @version
|
|
43305
|
+
* @version 220.0.0
|
|
42458
43306
|
*/
|
|
42459
43307
|
|
|
42460
43308
|
/**
|
|
@@ -42605,7 +43453,7 @@ class NotificationsApi {
|
|
|
42605
43453
|
/**
|
|
42606
43454
|
* Notifications service.
|
|
42607
43455
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
42608
|
-
* @version
|
|
43456
|
+
* @version 220.0.0
|
|
42609
43457
|
*/
|
|
42610
43458
|
|
|
42611
43459
|
/**
|
|
@@ -42838,7 +43686,7 @@ class OAuthApi {
|
|
|
42838
43686
|
/**
|
|
42839
43687
|
* OAuth service.
|
|
42840
43688
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42841
|
-
* @version
|
|
43689
|
+
* @version 220.0.0
|
|
42842
43690
|
*/
|
|
42843
43691
|
|
|
42844
43692
|
/**
|
|
@@ -43204,7 +44052,7 @@ class ObjectsApi {
|
|
|
43204
44052
|
/**
|
|
43205
44053
|
* Objects service.
|
|
43206
44054
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
43207
|
-
* @version
|
|
44055
|
+
* @version 220.0.0
|
|
43208
44056
|
*/
|
|
43209
44057
|
|
|
43210
44058
|
/**
|
|
@@ -43309,6 +44157,31 @@ class ObjectsApi {
|
|
|
43309
44157
|
);
|
|
43310
44158
|
}
|
|
43311
44159
|
|
|
44160
|
+
/**
|
|
44161
|
+
* Get a list of soft deleted divisions for the org
|
|
44162
|
+
*
|
|
44163
|
+
* @param {Object} opts Optional parameters
|
|
44164
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
44165
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44166
|
+
*/
|
|
44167
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
44168
|
+
opts = opts || {};
|
|
44169
|
+
|
|
44170
|
+
|
|
44171
|
+
return this.apiClient.callApi(
|
|
44172
|
+
'/api/v2/authorization/divisions/deleted',
|
|
44173
|
+
'GET',
|
|
44174
|
+
{ },
|
|
44175
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
44176
|
+
{ },
|
|
44177
|
+
{ },
|
|
44178
|
+
null,
|
|
44179
|
+
['PureCloud OAuth'],
|
|
44180
|
+
['application/json'],
|
|
44181
|
+
['application/json']
|
|
44182
|
+
);
|
|
44183
|
+
}
|
|
44184
|
+
|
|
43312
44185
|
/**
|
|
43313
44186
|
* Retrieve the home division for the organization.
|
|
43314
44187
|
* Will not include object counts.
|
|
@@ -43349,6 +44222,34 @@ class ObjectsApi {
|
|
|
43349
44222
|
);
|
|
43350
44223
|
}
|
|
43351
44224
|
|
|
44225
|
+
/**
|
|
44226
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
44227
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
44228
|
+
* @param {Object} opts Optional parameters
|
|
44229
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
44230
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
44231
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
44232
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
44233
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
44234
|
+
*/
|
|
44235
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
44236
|
+
opts = opts || {};
|
|
44237
|
+
|
|
44238
|
+
|
|
44239
|
+
return this.apiClient.callApi(
|
|
44240
|
+
'/api/v2/authorization/divisions/query',
|
|
44241
|
+
'GET',
|
|
44242
|
+
{ },
|
|
44243
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
44244
|
+
{ },
|
|
44245
|
+
{ },
|
|
44246
|
+
null,
|
|
44247
|
+
['PureCloud OAuth'],
|
|
44248
|
+
['application/json'],
|
|
44249
|
+
['application/json']
|
|
44250
|
+
);
|
|
44251
|
+
}
|
|
44252
|
+
|
|
43352
44253
|
/**
|
|
43353
44254
|
* Assign a list of objects to a division
|
|
43354
44255
|
* 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"]
|
|
@@ -43475,7 +44376,7 @@ class OperationalEventsApi {
|
|
|
43475
44376
|
/**
|
|
43476
44377
|
* OperationalEvents service.
|
|
43477
44378
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
43478
|
-
* @version
|
|
44379
|
+
* @version 220.0.0
|
|
43479
44380
|
*/
|
|
43480
44381
|
|
|
43481
44382
|
/**
|
|
@@ -43592,7 +44493,7 @@ class OrganizationApi {
|
|
|
43592
44493
|
/**
|
|
43593
44494
|
* Organization service.
|
|
43594
44495
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
43595
|
-
* @version
|
|
44496
|
+
* @version 220.0.0
|
|
43596
44497
|
*/
|
|
43597
44498
|
|
|
43598
44499
|
/**
|
|
@@ -44067,7 +44968,7 @@ class OrganizationAuthorizationApi {
|
|
|
44067
44968
|
/**
|
|
44068
44969
|
* OrganizationAuthorization service.
|
|
44069
44970
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
44070
|
-
* @version
|
|
44971
|
+
* @version 220.0.0
|
|
44071
44972
|
*/
|
|
44072
44973
|
|
|
44073
44974
|
/**
|
|
@@ -45461,7 +46362,7 @@ class OutboundApi {
|
|
|
45461
46362
|
/**
|
|
45462
46363
|
* Outbound service.
|
|
45463
46364
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
45464
|
-
* @version
|
|
46365
|
+
* @version 220.0.0
|
|
45465
46366
|
*/
|
|
45466
46367
|
|
|
45467
46368
|
/**
|
|
@@ -45948,6 +46849,35 @@ class OutboundApi {
|
|
|
45948
46849
|
);
|
|
45949
46850
|
}
|
|
45950
46851
|
|
|
46852
|
+
/**
|
|
46853
|
+
* Deletes all or expired whatsApp numbers from a DNC list.
|
|
46854
|
+
* This operation is only for Internal DNC lists of whatsApp numbers
|
|
46855
|
+
* @param {String} dncListId DncList ID
|
|
46856
|
+
* @param {Object} opts Optional parameters
|
|
46857
|
+
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC whatsApp numbers that are expired (default to false)
|
|
46858
|
+
*/
|
|
46859
|
+
deleteOutboundDnclistWhatsappnumbers(dncListId, opts) {
|
|
46860
|
+
opts = opts || {};
|
|
46861
|
+
|
|
46862
|
+
// verify the required parameter 'dncListId' is set
|
|
46863
|
+
if (dncListId === undefined || dncListId === null) {
|
|
46864
|
+
throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistWhatsappnumbers';
|
|
46865
|
+
}
|
|
46866
|
+
|
|
46867
|
+
return this.apiClient.callApi(
|
|
46868
|
+
'/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
|
|
46869
|
+
'DELETE',
|
|
46870
|
+
{ 'dncListId': dncListId },
|
|
46871
|
+
{ 'expiredOnly': opts['expiredOnly'] },
|
|
46872
|
+
{ },
|
|
46873
|
+
{ },
|
|
46874
|
+
null,
|
|
46875
|
+
['PureCloud OAuth'],
|
|
46876
|
+
['application/json'],
|
|
46877
|
+
['application/json']
|
|
46878
|
+
);
|
|
46879
|
+
}
|
|
46880
|
+
|
|
45951
46881
|
/**
|
|
45952
46882
|
* Delete File Specification Template
|
|
45953
46883
|
*
|
|
@@ -48286,6 +49216,36 @@ class OutboundApi {
|
|
|
48286
49216
|
);
|
|
48287
49217
|
}
|
|
48288
49218
|
|
|
49219
|
+
/**
|
|
49220
|
+
* Add entries to or delete entries from a DNC list.
|
|
49221
|
+
* Only Internal DNC lists may be deleted from
|
|
49222
|
+
* @param {String} dncListId DncList ID
|
|
49223
|
+
* @param {Object} body DNC whatsApp numbers
|
|
49224
|
+
*/
|
|
49225
|
+
patchOutboundDnclistWhatsappnumbers(dncListId, body) {
|
|
49226
|
+
// verify the required parameter 'dncListId' is set
|
|
49227
|
+
if (dncListId === undefined || dncListId === null) {
|
|
49228
|
+
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistWhatsappnumbers';
|
|
49229
|
+
}
|
|
49230
|
+
// verify the required parameter 'body' is set
|
|
49231
|
+
if (body === undefined || body === null) {
|
|
49232
|
+
throw 'Missing the required parameter "body" when calling patchOutboundDnclistWhatsappnumbers';
|
|
49233
|
+
}
|
|
49234
|
+
|
|
49235
|
+
return this.apiClient.callApi(
|
|
49236
|
+
'/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
|
|
49237
|
+
'PATCH',
|
|
49238
|
+
{ 'dncListId': dncListId },
|
|
49239
|
+
{ },
|
|
49240
|
+
{ },
|
|
49241
|
+
{ },
|
|
49242
|
+
body,
|
|
49243
|
+
['PureCloud OAuth'],
|
|
49244
|
+
['application/json'],
|
|
49245
|
+
['application/json']
|
|
49246
|
+
);
|
|
49247
|
+
}
|
|
49248
|
+
|
|
48289
49249
|
/**
|
|
48290
49250
|
* Update the outbound settings for this organization
|
|
48291
49251
|
*
|
|
@@ -50024,7 +50984,7 @@ class PresenceApi {
|
|
|
50024
50984
|
/**
|
|
50025
50985
|
* Presence service.
|
|
50026
50986
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
50027
|
-
* @version
|
|
50987
|
+
* @version 220.0.0
|
|
50028
50988
|
*/
|
|
50029
50989
|
|
|
50030
50990
|
/**
|
|
@@ -50044,10 +51004,10 @@ class PresenceApi {
|
|
|
50044
51004
|
*
|
|
50045
51005
|
* @param {String} definitionId Presence Definition ID
|
|
50046
51006
|
*/
|
|
50047
|
-
|
|
51007
|
+
deletePresenceDefinition0(definitionId) {
|
|
50048
51008
|
// verify the required parameter 'definitionId' is set
|
|
50049
51009
|
if (definitionId === undefined || definitionId === null) {
|
|
50050
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
51010
|
+
throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
|
|
50051
51011
|
}
|
|
50052
51012
|
|
|
50053
51013
|
return this.apiClient.callApi(
|
|
@@ -50122,12 +51082,12 @@ class PresenceApi {
|
|
|
50122
51082
|
* @param {Object} opts Optional parameters
|
|
50123
51083
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
50124
51084
|
*/
|
|
50125
|
-
|
|
51085
|
+
getPresenceDefinition0(definitionId, opts) {
|
|
50126
51086
|
opts = opts || {};
|
|
50127
51087
|
|
|
50128
51088
|
// verify the required parameter 'definitionId' is set
|
|
50129
51089
|
if (definitionId === undefined || definitionId === null) {
|
|
50130
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
51090
|
+
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
50131
51091
|
}
|
|
50132
51092
|
|
|
50133
51093
|
return this.apiClient.callApi(
|
|
@@ -50152,7 +51112,7 @@ class PresenceApi {
|
|
|
50152
51112
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
50153
51113
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
50154
51114
|
*/
|
|
50155
|
-
|
|
51115
|
+
getPresenceDefinitions0(opts) {
|
|
50156
51116
|
opts = opts || {};
|
|
50157
51117
|
|
|
50158
51118
|
|
|
@@ -50520,10 +51480,10 @@ class PresenceApi {
|
|
|
50520
51480
|
*
|
|
50521
51481
|
* @param {Object} body The Presence Definition to create
|
|
50522
51482
|
*/
|
|
50523
|
-
|
|
51483
|
+
postPresenceDefinitions0(body) {
|
|
50524
51484
|
// verify the required parameter 'body' is set
|
|
50525
51485
|
if (body === undefined || body === null) {
|
|
50526
|
-
throw 'Missing the required parameter "body" when calling
|
|
51486
|
+
throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
|
|
50527
51487
|
}
|
|
50528
51488
|
|
|
50529
51489
|
return this.apiClient.callApi(
|
|
@@ -50597,14 +51557,14 @@ class PresenceApi {
|
|
|
50597
51557
|
* @param {String} definitionId Presence Definition ID
|
|
50598
51558
|
* @param {Object} body The updated Presence Definition
|
|
50599
51559
|
*/
|
|
50600
|
-
|
|
51560
|
+
putPresenceDefinition0(definitionId, body) {
|
|
50601
51561
|
// verify the required parameter 'definitionId' is set
|
|
50602
51562
|
if (definitionId === undefined || definitionId === null) {
|
|
50603
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
51563
|
+
throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
|
|
50604
51564
|
}
|
|
50605
51565
|
// verify the required parameter 'body' is set
|
|
50606
51566
|
if (body === undefined || body === null) {
|
|
50607
|
-
throw 'Missing the required parameter "body" when calling
|
|
51567
|
+
throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
|
|
50608
51568
|
}
|
|
50609
51569
|
|
|
50610
51570
|
return this.apiClient.callApi(
|
|
@@ -50768,7 +51728,7 @@ class ProcessAutomationApi {
|
|
|
50768
51728
|
/**
|
|
50769
51729
|
* ProcessAutomation service.
|
|
50770
51730
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
50771
|
-
* @version
|
|
51731
|
+
* @version 220.0.0
|
|
50772
51732
|
*/
|
|
50773
51733
|
|
|
50774
51734
|
/**
|
|
@@ -51007,7 +51967,7 @@ class QualityApi {
|
|
|
51007
51967
|
/**
|
|
51008
51968
|
* Quality service.
|
|
51009
51969
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
51010
|
-
* @version
|
|
51970
|
+
* @version 220.0.0
|
|
51011
51971
|
*/
|
|
51012
51972
|
|
|
51013
51973
|
/**
|
|
@@ -52794,7 +53754,7 @@ class RecordingApi {
|
|
|
52794
53754
|
/**
|
|
52795
53755
|
* Recording service.
|
|
52796
53756
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
52797
|
-
* @version
|
|
53757
|
+
* @version 220.0.0
|
|
52798
53758
|
*/
|
|
52799
53759
|
|
|
52800
53760
|
/**
|
|
@@ -53396,7 +54356,7 @@ class RecordingApi {
|
|
|
53396
54356
|
* @param {Object} opts Optional parameters
|
|
53397
54357
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
53398
54358
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
53399
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
54359
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
|
|
53400
54360
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
53401
54361
|
*/
|
|
53402
54362
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
@@ -53431,7 +54391,7 @@ class RecordingApi {
|
|
|
53431
54391
|
* @param {Object} opts.state Filter by state
|
|
53432
54392
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
53433
54393
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
53434
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
54394
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
|
|
53435
54395
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
53436
54396
|
*/
|
|
53437
54397
|
getRecordingJobs(opts) {
|
|
@@ -54399,7 +55359,7 @@ class ResponseManagementApi {
|
|
|
54399
55359
|
/**
|
|
54400
55360
|
* ResponseManagement service.
|
|
54401
55361
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
54402
|
-
* @version
|
|
55362
|
+
* @version 220.0.0
|
|
54403
55363
|
*/
|
|
54404
55364
|
|
|
54405
55365
|
/**
|
|
@@ -54909,7 +55869,7 @@ class RoutingApi {
|
|
|
54909
55869
|
/**
|
|
54910
55870
|
* Routing service.
|
|
54911
55871
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54912
|
-
* @version
|
|
55872
|
+
* @version 220.0.0
|
|
54913
55873
|
*/
|
|
54914
55874
|
|
|
54915
55875
|
/**
|
|
@@ -55819,7 +56779,7 @@ class RoutingApi {
|
|
|
55819
56779
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
55820
56780
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
55821
56781
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
55822
|
-
* @param {String} opts.filter Optional search filter
|
|
56782
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
55823
56783
|
*/
|
|
55824
56784
|
getRoutingEmailDomains(opts) {
|
|
55825
56785
|
opts = opts || {};
|
|
@@ -55918,7 +56878,9 @@ class RoutingApi {
|
|
|
55918
56878
|
* Get outbound domains
|
|
55919
56879
|
*
|
|
55920
56880
|
* @param {Object} opts Optional parameters
|
|
55921
|
-
* @param {
|
|
56881
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56882
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56883
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
55922
56884
|
*/
|
|
55923
56885
|
getRoutingEmailOutboundDomains(opts) {
|
|
55924
56886
|
opts = opts || {};
|
|
@@ -55928,7 +56890,7 @@ class RoutingApi {
|
|
|
55928
56890
|
'/api/v2/routing/email/outbound/domains',
|
|
55929
56891
|
'GET',
|
|
55930
56892
|
{ },
|
|
55931
|
-
{ 'filter': opts['filter'] },
|
|
56893
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
55932
56894
|
{ },
|
|
55933
56895
|
{ },
|
|
55934
56896
|
null,
|
|
@@ -59212,7 +60174,7 @@ class SCIMApi {
|
|
|
59212
60174
|
/**
|
|
59213
60175
|
* SCIM service.
|
|
59214
60176
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
59215
|
-
* @version
|
|
60177
|
+
* @version 220.0.0
|
|
59216
60178
|
*/
|
|
59217
60179
|
|
|
59218
60180
|
/**
|
|
@@ -60089,7 +61051,7 @@ class ScreenRecordingApi {
|
|
|
60089
61051
|
/**
|
|
60090
61052
|
* ScreenRecording service.
|
|
60091
61053
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
60092
|
-
* @version
|
|
61054
|
+
* @version 220.0.0
|
|
60093
61055
|
*/
|
|
60094
61056
|
|
|
60095
61057
|
/**
|
|
@@ -60134,7 +61096,7 @@ class ScriptsApi {
|
|
|
60134
61096
|
/**
|
|
60135
61097
|
* Scripts service.
|
|
60136
61098
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
60137
|
-
* @version
|
|
61099
|
+
* @version 220.0.0
|
|
60138
61100
|
*/
|
|
60139
61101
|
|
|
60140
61102
|
/**
|
|
@@ -60334,6 +61296,38 @@ class ScriptsApi {
|
|
|
60334
61296
|
);
|
|
60335
61297
|
}
|
|
60336
61298
|
|
|
61299
|
+
/**
|
|
61300
|
+
* Get the published variables
|
|
61301
|
+
*
|
|
61302
|
+
* @param {String} scriptId Script ID
|
|
61303
|
+
* @param {Object} opts Optional parameters
|
|
61304
|
+
* @param {Object} opts.input input
|
|
61305
|
+
* @param {Object} opts.output output
|
|
61306
|
+
* @param {Object} opts.type type
|
|
61307
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
61308
|
+
*/
|
|
61309
|
+
getScriptsPublishedDivisionviewVariables(scriptId, opts) {
|
|
61310
|
+
opts = opts || {};
|
|
61311
|
+
|
|
61312
|
+
// verify the required parameter 'scriptId' is set
|
|
61313
|
+
if (scriptId === undefined || scriptId === null) {
|
|
61314
|
+
throw 'Missing the required parameter "scriptId" when calling getScriptsPublishedDivisionviewVariables';
|
|
61315
|
+
}
|
|
61316
|
+
|
|
61317
|
+
return this.apiClient.callApi(
|
|
61318
|
+
'/api/v2/scripts/published/divisionviews/{scriptId}/variables',
|
|
61319
|
+
'GET',
|
|
61320
|
+
{ 'scriptId': scriptId },
|
|
61321
|
+
{ 'input': opts['input'],'output': opts['output'],'type': opts['type'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
61322
|
+
{ },
|
|
61323
|
+
{ },
|
|
61324
|
+
null,
|
|
61325
|
+
['PureCloud OAuth'],
|
|
61326
|
+
['application/json'],
|
|
61327
|
+
['application/json']
|
|
61328
|
+
);
|
|
61329
|
+
}
|
|
61330
|
+
|
|
60337
61331
|
/**
|
|
60338
61332
|
* Get the published scripts metadata.
|
|
60339
61333
|
*
|
|
@@ -60578,7 +61572,7 @@ class SearchApi {
|
|
|
60578
61572
|
/**
|
|
60579
61573
|
* Search service.
|
|
60580
61574
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
60581
|
-
* @version
|
|
61575
|
+
* @version 220.0.0
|
|
60582
61576
|
*/
|
|
60583
61577
|
|
|
60584
61578
|
/**
|
|
@@ -61321,7 +62315,7 @@ class SettingsApi {
|
|
|
61321
62315
|
/**
|
|
61322
62316
|
* Settings service.
|
|
61323
62317
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
61324
|
-
* @version
|
|
62318
|
+
* @version 220.0.0
|
|
61325
62319
|
*/
|
|
61326
62320
|
|
|
61327
62321
|
/**
|
|
@@ -61605,7 +62599,7 @@ class SocialMediaApi {
|
|
|
61605
62599
|
/**
|
|
61606
62600
|
* SocialMedia service.
|
|
61607
62601
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
61608
|
-
* @version
|
|
62602
|
+
* @version 220.0.0
|
|
61609
62603
|
*/
|
|
61610
62604
|
|
|
61611
62605
|
/**
|
|
@@ -62893,7 +63887,7 @@ class SpeechTextAnalyticsApi {
|
|
|
62893
63887
|
/**
|
|
62894
63888
|
* SpeechTextAnalytics service.
|
|
62895
63889
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
62896
|
-
* @version
|
|
63890
|
+
* @version 220.0.0
|
|
62897
63891
|
*/
|
|
62898
63892
|
|
|
62899
63893
|
/**
|
|
@@ -64334,7 +65328,7 @@ class StationsApi {
|
|
|
64334
65328
|
/**
|
|
64335
65329
|
* Stations service.
|
|
64336
65330
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
64337
|
-
* @version
|
|
65331
|
+
* @version 220.0.0
|
|
64338
65332
|
*/
|
|
64339
65333
|
|
|
64340
65334
|
/**
|
|
@@ -64436,7 +65430,7 @@ class SuggestApi {
|
|
|
64436
65430
|
/**
|
|
64437
65431
|
* Suggest service.
|
|
64438
65432
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
64439
|
-
* @version
|
|
65433
|
+
* @version 220.0.0
|
|
64440
65434
|
*/
|
|
64441
65435
|
|
|
64442
65436
|
/**
|
|
@@ -64575,7 +65569,7 @@ class TaskManagementApi {
|
|
|
64575
65569
|
/**
|
|
64576
65570
|
* TaskManagement service.
|
|
64577
65571
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
64578
|
-
* @version
|
|
65572
|
+
* @version 220.0.0
|
|
64579
65573
|
*/
|
|
64580
65574
|
|
|
64581
65575
|
/**
|
|
@@ -64893,7 +65887,6 @@ class TaskManagementApi {
|
|
|
64893
65887
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
64894
65888
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
64895
65889
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
64896
|
-
* getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64897
65890
|
*/
|
|
64898
65891
|
getTaskmanagementWorkbinHistory(workbinId, opts) {
|
|
64899
65892
|
opts = opts || {};
|
|
@@ -64922,7 +65915,6 @@ class TaskManagementApi {
|
|
|
64922
65915
|
*
|
|
64923
65916
|
* @param {String} workbinId Workbin ID
|
|
64924
65917
|
* @param {Number} entityVersion Workbin version
|
|
64925
|
-
* getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64926
65918
|
*/
|
|
64927
65919
|
getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
|
|
64928
65920
|
// verify the required parameter 'workbinId' is set
|
|
@@ -64956,7 +65948,6 @@ class TaskManagementApi {
|
|
|
64956
65948
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
64957
65949
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
64958
65950
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
64959
|
-
* getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64960
65951
|
*/
|
|
64961
65952
|
getTaskmanagementWorkbinVersions(workbinId, opts) {
|
|
64962
65953
|
opts = opts || {};
|
|
@@ -65017,7 +66008,6 @@ class TaskManagementApi {
|
|
|
65017
66008
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
65018
66009
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
65019
66010
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
65020
|
-
* getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65021
66011
|
*/
|
|
65022
66012
|
getTaskmanagementWorkitemHistory(workitemId, opts) {
|
|
65023
66013
|
opts = opts || {};
|
|
@@ -65083,7 +66073,6 @@ class TaskManagementApi {
|
|
|
65083
66073
|
*
|
|
65084
66074
|
* @param {String} workitemId Workitem ID
|
|
65085
66075
|
* @param {Number} entityVersion Workitem version
|
|
65086
|
-
* getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65087
66076
|
*/
|
|
65088
66077
|
getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
|
|
65089
66078
|
// verify the required parameter 'workitemId' is set
|
|
@@ -65117,7 +66106,6 @@ class TaskManagementApi {
|
|
|
65117
66106
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
65118
66107
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
65119
66108
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
65120
|
-
* getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65121
66109
|
*/
|
|
65122
66110
|
getTaskmanagementWorkitemVersions(workitemId, opts) {
|
|
65123
66111
|
opts = opts || {};
|
|
@@ -65450,6 +66438,71 @@ class TaskManagementApi {
|
|
|
65450
66438
|
);
|
|
65451
66439
|
}
|
|
65452
66440
|
|
|
66441
|
+
/**
|
|
66442
|
+
* Get the core types from which all schemas are built.
|
|
66443
|
+
*
|
|
66444
|
+
* @param {String} coreTypeName Name of the core type
|
|
66445
|
+
*/
|
|
66446
|
+
getTaskmanagementWorkitemsSchemasCoretype(coreTypeName) {
|
|
66447
|
+
// verify the required parameter 'coreTypeName' is set
|
|
66448
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
66449
|
+
throw 'Missing the required parameter "coreTypeName" when calling getTaskmanagementWorkitemsSchemasCoretype';
|
|
66450
|
+
}
|
|
66451
|
+
|
|
66452
|
+
return this.apiClient.callApi(
|
|
66453
|
+
'/api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}',
|
|
66454
|
+
'GET',
|
|
66455
|
+
{ 'coreTypeName': coreTypeName },
|
|
66456
|
+
{ },
|
|
66457
|
+
{ },
|
|
66458
|
+
{ },
|
|
66459
|
+
null,
|
|
66460
|
+
['PureCloud OAuth'],
|
|
66461
|
+
['application/json'],
|
|
66462
|
+
['application/json']
|
|
66463
|
+
);
|
|
66464
|
+
}
|
|
66465
|
+
|
|
66466
|
+
/**
|
|
66467
|
+
* Get the core types from which all schemas are built.
|
|
66468
|
+
*
|
|
66469
|
+
*/
|
|
66470
|
+
getTaskmanagementWorkitemsSchemasCoretypes() {
|
|
66471
|
+
|
|
66472
|
+
return this.apiClient.callApi(
|
|
66473
|
+
'/api/v2/taskmanagement/workitems/schemas/coretypes',
|
|
66474
|
+
'GET',
|
|
66475
|
+
{ },
|
|
66476
|
+
{ },
|
|
66477
|
+
{ },
|
|
66478
|
+
{ },
|
|
66479
|
+
null,
|
|
66480
|
+
['PureCloud OAuth'],
|
|
66481
|
+
['application/json'],
|
|
66482
|
+
['application/json']
|
|
66483
|
+
);
|
|
66484
|
+
}
|
|
66485
|
+
|
|
66486
|
+
/**
|
|
66487
|
+
* Get quantitative limits on schemas
|
|
66488
|
+
*
|
|
66489
|
+
*/
|
|
66490
|
+
getTaskmanagementWorkitemsSchemasLimits() {
|
|
66491
|
+
|
|
66492
|
+
return this.apiClient.callApi(
|
|
66493
|
+
'/api/v2/taskmanagement/workitems/schemas/limits',
|
|
66494
|
+
'GET',
|
|
66495
|
+
{ },
|
|
66496
|
+
{ },
|
|
66497
|
+
{ },
|
|
66498
|
+
{ },
|
|
66499
|
+
null,
|
|
66500
|
+
['PureCloud OAuth'],
|
|
66501
|
+
['application/json'],
|
|
66502
|
+
['application/json']
|
|
66503
|
+
);
|
|
66504
|
+
}
|
|
66505
|
+
|
|
65453
66506
|
/**
|
|
65454
66507
|
* Get a worktype
|
|
65455
66508
|
*
|
|
@@ -65668,7 +66721,6 @@ class TaskManagementApi {
|
|
|
65668
66721
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
65669
66722
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
65670
66723
|
* @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
|
|
65671
|
-
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65672
66724
|
*/
|
|
65673
66725
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
65674
66726
|
opts = opts || {};
|
|
@@ -65752,7 +66804,6 @@ class TaskManagementApi {
|
|
|
65752
66804
|
*
|
|
65753
66805
|
* @param {String} worktypeId Worktype id
|
|
65754
66806
|
* @param {Number} entityVersion Worktype version
|
|
65755
|
-
* getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65756
66807
|
*/
|
|
65757
66808
|
getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
|
|
65758
66809
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -65786,7 +66837,6 @@ class TaskManagementApi {
|
|
|
65786
66837
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
65787
66838
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
65788
66839
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
65789
|
-
* getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65790
66840
|
*/
|
|
65791
66841
|
getTaskmanagementWorktypeVersions(worktypeId, opts) {
|
|
65792
66842
|
opts = opts || {};
|
|
@@ -66681,7 +67731,7 @@ class TeamsApi {
|
|
|
66681
67731
|
/**
|
|
66682
67732
|
* Teams service.
|
|
66683
67733
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
66684
|
-
* @version
|
|
67734
|
+
* @version 220.0.0
|
|
66685
67735
|
*/
|
|
66686
67736
|
|
|
66687
67737
|
/**
|
|
@@ -66986,7 +68036,7 @@ class TelephonyApi {
|
|
|
66986
68036
|
/**
|
|
66987
68037
|
* Telephony service.
|
|
66988
68038
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
66989
|
-
* @version
|
|
68039
|
+
* @version 220.0.0
|
|
66990
68040
|
*/
|
|
66991
68041
|
|
|
66992
68042
|
/**
|
|
@@ -67168,7 +68218,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
67168
68218
|
/**
|
|
67169
68219
|
* TelephonyProvidersEdge service.
|
|
67170
68220
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
67171
|
-
* @version
|
|
68221
|
+
* @version 220.0.0
|
|
67172
68222
|
*/
|
|
67173
68223
|
|
|
67174
68224
|
/**
|
|
@@ -70620,7 +71670,7 @@ class TextbotsApi {
|
|
|
70620
71670
|
/**
|
|
70621
71671
|
* Textbots service.
|
|
70622
71672
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
70623
|
-
* @version
|
|
71673
|
+
* @version 220.0.0
|
|
70624
71674
|
*/
|
|
70625
71675
|
|
|
70626
71676
|
/**
|
|
@@ -70641,8 +71691,8 @@ class TextbotsApi {
|
|
|
70641
71691
|
* @param {Object} opts Optional parameters
|
|
70642
71692
|
* @param {Array.<String>} opts.botType Bot types
|
|
70643
71693
|
* @param {String} opts.botName Bot name
|
|
70644
|
-
* @param {Array.<String>} opts.botId Bot IDs
|
|
70645
|
-
* @param {Number} opts.pageSize The maximum results to return (default to 25)
|
|
71694
|
+
* @param {Array.<String>} opts.botId Bot IDs. Maximum of 50
|
|
71695
|
+
* @param {Number} opts.pageSize The maximum results to return. Maximum of 100 (default to 25)
|
|
70646
71696
|
*/
|
|
70647
71697
|
getTextbotsBotsSearch(opts) {
|
|
70648
71698
|
opts = opts || {};
|
|
@@ -70748,7 +71798,7 @@ class TokensApi {
|
|
|
70748
71798
|
/**
|
|
70749
71799
|
* Tokens service.
|
|
70750
71800
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
70751
|
-
* @version
|
|
71801
|
+
* @version 220.0.0
|
|
70752
71802
|
*/
|
|
70753
71803
|
|
|
70754
71804
|
/**
|
|
@@ -70902,7 +71952,7 @@ class UploadsApi {
|
|
|
70902
71952
|
/**
|
|
70903
71953
|
* Uploads service.
|
|
70904
71954
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
70905
|
-
* @version
|
|
71955
|
+
* @version 220.0.0
|
|
70906
71956
|
*/
|
|
70907
71957
|
|
|
70908
71958
|
/**
|
|
@@ -70947,6 +71997,31 @@ class UploadsApi {
|
|
|
70947
71997
|
);
|
|
70948
71998
|
}
|
|
70949
71999
|
|
|
72000
|
+
/**
|
|
72001
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
72002
|
+
*
|
|
72003
|
+
* @param {Object} body query
|
|
72004
|
+
*/
|
|
72005
|
+
postGamificationContestsUploadsPrizeimages(body) {
|
|
72006
|
+
// verify the required parameter 'body' is set
|
|
72007
|
+
if (body === undefined || body === null) {
|
|
72008
|
+
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
72009
|
+
}
|
|
72010
|
+
|
|
72011
|
+
return this.apiClient.callApi(
|
|
72012
|
+
'/api/v2/gamification/contests/uploads/prizeimages',
|
|
72013
|
+
'POST',
|
|
72014
|
+
{ },
|
|
72015
|
+
{ },
|
|
72016
|
+
{ },
|
|
72017
|
+
{ },
|
|
72018
|
+
body,
|
|
72019
|
+
['PureCloud OAuth'],
|
|
72020
|
+
['application/json'],
|
|
72021
|
+
['application/json']
|
|
72022
|
+
);
|
|
72023
|
+
}
|
|
72024
|
+
|
|
70950
72025
|
/**
|
|
70951
72026
|
* Create upload presigned URL for draft function package file.
|
|
70952
72027
|
*
|
|
@@ -71168,7 +72243,7 @@ class UsageApi {
|
|
|
71168
72243
|
/**
|
|
71169
72244
|
* Usage service.
|
|
71170
72245
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
71171
|
-
* @version
|
|
72246
|
+
* @version 220.0.0
|
|
71172
72247
|
*/
|
|
71173
72248
|
|
|
71174
72249
|
/**
|
|
@@ -71383,7 +72458,7 @@ class UserRecordingsApi {
|
|
|
71383
72458
|
/**
|
|
71384
72459
|
* UserRecordings service.
|
|
71385
72460
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
71386
|
-
* @version
|
|
72461
|
+
* @version 220.0.0
|
|
71387
72462
|
*/
|
|
71388
72463
|
|
|
71389
72464
|
/**
|
|
@@ -71598,7 +72673,7 @@ class UsersApi {
|
|
|
71598
72673
|
/**
|
|
71599
72674
|
* Users service.
|
|
71600
72675
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
71601
|
-
* @version
|
|
72676
|
+
* @version 220.0.0
|
|
71602
72677
|
*/
|
|
71603
72678
|
|
|
71604
72679
|
/**
|
|
@@ -74551,7 +75626,7 @@ class UtilitiesApi {
|
|
|
74551
75626
|
/**
|
|
74552
75627
|
* Utilities service.
|
|
74553
75628
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
74554
|
-
* @version
|
|
75629
|
+
* @version 220.0.0
|
|
74555
75630
|
*/
|
|
74556
75631
|
|
|
74557
75632
|
/**
|
|
@@ -74662,7 +75737,7 @@ class VoicemailApi {
|
|
|
74662
75737
|
/**
|
|
74663
75738
|
* Voicemail service.
|
|
74664
75739
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
74665
|
-
* @version
|
|
75740
|
+
* @version 220.0.0
|
|
74666
75741
|
*/
|
|
74667
75742
|
|
|
74668
75743
|
/**
|
|
@@ -75384,7 +76459,7 @@ class WebChatApi {
|
|
|
75384
76459
|
/**
|
|
75385
76460
|
* WebChat service.
|
|
75386
76461
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
75387
|
-
* @version
|
|
76462
|
+
* @version 220.0.0
|
|
75388
76463
|
*/
|
|
75389
76464
|
|
|
75390
76465
|
/**
|
|
@@ -75944,7 +77019,7 @@ class WebDeploymentsApi {
|
|
|
75944
77019
|
/**
|
|
75945
77020
|
* WebDeployments service.
|
|
75946
77021
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
75947
|
-
* @version
|
|
77022
|
+
* @version 220.0.0
|
|
75948
77023
|
*/
|
|
75949
77024
|
|
|
75950
77025
|
/**
|
|
@@ -76528,7 +77603,7 @@ class WebMessagingApi {
|
|
|
76528
77603
|
/**
|
|
76529
77604
|
* WebMessaging service.
|
|
76530
77605
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
76531
|
-
* @version
|
|
77606
|
+
* @version 220.0.0
|
|
76532
77607
|
*/
|
|
76533
77608
|
|
|
76534
77609
|
/**
|
|
@@ -76574,7 +77649,7 @@ class WidgetsApi {
|
|
|
76574
77649
|
/**
|
|
76575
77650
|
* Widgets service.
|
|
76576
77651
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
76577
|
-
* @version
|
|
77652
|
+
* @version 220.0.0
|
|
76578
77653
|
*/
|
|
76579
77654
|
|
|
76580
77655
|
/**
|
|
@@ -76725,7 +77800,7 @@ class WorkforceManagementApi {
|
|
|
76725
77800
|
/**
|
|
76726
77801
|
* WorkforceManagement service.
|
|
76727
77802
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
76728
|
-
* @version
|
|
77803
|
+
* @version 220.0.0
|
|
76729
77804
|
*/
|
|
76730
77805
|
|
|
76731
77806
|
/**
|
|
@@ -79295,8 +80370,9 @@ class WorkforceManagementApi {
|
|
|
79295
80370
|
}
|
|
79296
80371
|
|
|
79297
80372
|
/**
|
|
79298
|
-
* Retrieves delete job status for historical data imports of the organization
|
|
79299
|
-
*
|
|
80373
|
+
* Retrieves delete job status for historical data imports of the organization.
|
|
80374
|
+
* Deprecated: Please use GET /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
80375
|
+
* @deprecated
|
|
79300
80376
|
*/
|
|
79301
80377
|
getWorkforcemanagementHistoricaldataDeletejob() {
|
|
79302
80378
|
|
|
@@ -82868,8 +83944,9 @@ class WorkforceManagementApi {
|
|
|
82868
83944
|
}
|
|
82869
83945
|
|
|
82870
83946
|
/**
|
|
82871
|
-
* Delete the entries of the historical data imports in the organization
|
|
82872
|
-
*
|
|
83947
|
+
* Delete the entries of the historical data imports in the organization.
|
|
83948
|
+
* Deprecated: Please use POST /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
83949
|
+
* @deprecated
|
|
82873
83950
|
*/
|
|
82874
83951
|
postWorkforcemanagementHistoricaldataDeletejob() {
|
|
82875
83952
|
|
|
@@ -84118,7 +85195,7 @@ class WorkforceManagementApi {
|
|
|
84118
85195
|
* </pre>
|
|
84119
85196
|
* </p>
|
|
84120
85197
|
* @module purecloud-platform-client-v2/index
|
|
84121
|
-
* @version
|
|
85198
|
+
* @version 220.0.0
|
|
84122
85199
|
*/
|
|
84123
85200
|
class platformClient {
|
|
84124
85201
|
constructor() {
|