purecloud-platform-client-v2 128.0.0 → 131.1.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 +2 -8
- package/dist/node/purecloud-platform-client-v2.js +681 -100
- package/dist/web-amd/purecloud-platform-client-v2.js +681 -100
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +681 -100
- package/dist/web-cjs/purecloud-platform-client-v2.js +681 -100
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +524 -50
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +176 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +121 -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/IntegrationsApi.js +30 -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 +3 -3
- 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/MessagingApi.js +156 -0
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +51 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +8 -8
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -4
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -21
- 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/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +22 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +2 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@ import Configuration from './configuration.js';
|
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6
|
-
* @version
|
|
6
|
+
* @version 131.1.0
|
|
7
7
|
*/
|
|
8
8
|
class ApiClient {
|
|
9
9
|
/**
|
|
@@ -950,7 +950,7 @@ class ApiClient {
|
|
|
950
950
|
|
|
951
951
|
// set header parameters
|
|
952
952
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
953
|
-
//request.set({ 'purecloud-sdk': '
|
|
953
|
+
//request.set({ 'purecloud-sdk': '131.1.0' });
|
|
954
954
|
|
|
955
955
|
// set request timeout
|
|
956
956
|
request.timeout(that.timeout);
|
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 131.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -506,6 +506,26 @@ class AnalyticsApi {
|
|
|
506
506
|
);
|
|
507
507
|
}
|
|
508
508
|
|
|
509
|
+
/**
|
|
510
|
+
* Get AnalyticsReportingSettings for an organization
|
|
511
|
+
*
|
|
512
|
+
*/
|
|
513
|
+
getAnalyticsReportingSettings() {
|
|
514
|
+
|
|
515
|
+
return this.apiClient.callApi(
|
|
516
|
+
'/api/v2/analytics/reporting/settings',
|
|
517
|
+
'GET',
|
|
518
|
+
{ },
|
|
519
|
+
{ },
|
|
520
|
+
{ },
|
|
521
|
+
{ },
|
|
522
|
+
null,
|
|
523
|
+
['PureCloud OAuth'],
|
|
524
|
+
['application/json'],
|
|
525
|
+
['application/json']
|
|
526
|
+
);
|
|
527
|
+
}
|
|
528
|
+
|
|
509
529
|
/**
|
|
510
530
|
* Get a list of report time periods.
|
|
511
531
|
*
|
|
@@ -601,6 +621,31 @@ class AnalyticsApi {
|
|
|
601
621
|
);
|
|
602
622
|
}
|
|
603
623
|
|
|
624
|
+
/**
|
|
625
|
+
* Patch AnalyticsReportingSettings values for an organization
|
|
626
|
+
*
|
|
627
|
+
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
628
|
+
*/
|
|
629
|
+
patchAnalyticsReportingSettings(body) {
|
|
630
|
+
// verify the required parameter 'body' is set
|
|
631
|
+
if (body === undefined || body === null) {
|
|
632
|
+
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
return this.apiClient.callApi(
|
|
636
|
+
'/api/v2/analytics/reporting/settings',
|
|
637
|
+
'PATCH',
|
|
638
|
+
{ },
|
|
639
|
+
{ },
|
|
640
|
+
{ },
|
|
641
|
+
{ },
|
|
642
|
+
body,
|
|
643
|
+
['PureCloud OAuth'],
|
|
644
|
+
['application/json'],
|
|
645
|
+
['application/json']
|
|
646
|
+
);
|
|
647
|
+
}
|
|
648
|
+
|
|
604
649
|
/**
|
|
605
650
|
* Query for bot aggregates
|
|
606
651
|
*
|
|
@@ -5,7 +5,7 @@ class CoachingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Coaching service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 131.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -204,6 +204,7 @@ class CoachingApi {
|
|
|
204
204
|
* @param {Array.<String>} opts.relationships Relationships to filter by
|
|
205
205
|
* @param {String} opts.completionInterval Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
206
206
|
* @param {Object} opts.overdue Overdue status to filter by
|
|
207
|
+
* @param {Object} opts.intervalCondition Filter condition for interval
|
|
207
208
|
*/
|
|
208
209
|
getCoachingAppointments(userIds, opts) {
|
|
209
210
|
opts = opts || {};
|
|
@@ -217,7 +218,7 @@ class CoachingApi {
|
|
|
217
218
|
'/api/v2/coaching/appointments',
|
|
218
219
|
'GET',
|
|
219
220
|
{ },
|
|
220
|
-
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'] },
|
|
221
|
+
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'intervalCondition': opts['intervalCondition'] },
|
|
221
222
|
{ },
|
|
222
223
|
{ },
|
|
223
224
|
null,
|
|
@@ -240,6 +241,7 @@ class CoachingApi {
|
|
|
240
241
|
* @param {Array.<String>} opts.relationships Relationships to filter by
|
|
241
242
|
* @param {String} opts.completionInterval Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
242
243
|
* @param {Object} opts.overdue Overdue status to filter by
|
|
244
|
+
* @param {Object} opts.intervalCondition Filter condition for interval
|
|
243
245
|
*/
|
|
244
246
|
getCoachingAppointmentsMe(opts) {
|
|
245
247
|
opts = opts || {};
|
|
@@ -249,7 +251,7 @@ class CoachingApi {
|
|
|
249
251
|
'/api/v2/coaching/appointments/me',
|
|
250
252
|
'GET',
|
|
251
253
|
{ },
|
|
252
|
-
{ 'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'] },
|
|
254
|
+
{ 'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'intervalCondition': opts['intervalCondition'] },
|
|
253
255
|
{ },
|
|
254
256
|
{ },
|
|
255
257
|
null,
|
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 131.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -295,6 +295,31 @@ class ConversationsApi {
|
|
|
295
295
|
);
|
|
296
296
|
}
|
|
297
297
|
|
|
298
|
+
/**
|
|
299
|
+
* Delete a supported content profile
|
|
300
|
+
*
|
|
301
|
+
* @param {String} supportedContentId Supported Content ID
|
|
302
|
+
*/
|
|
303
|
+
deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
304
|
+
// verify the required parameter 'supportedContentId' is set
|
|
305
|
+
if (supportedContentId === undefined || supportedContentId === null) {
|
|
306
|
+
throw 'Missing the required parameter "supportedContentId" when calling deleteConversationsMessagingSupportedcontentSupportedContentId';
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
return this.apiClient.callApi(
|
|
310
|
+
'/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
|
|
311
|
+
'DELETE',
|
|
312
|
+
{ 'supportedContentId': supportedContentId },
|
|
313
|
+
{ },
|
|
314
|
+
{ },
|
|
315
|
+
{ },
|
|
316
|
+
null,
|
|
317
|
+
['PureCloud OAuth'],
|
|
318
|
+
['application/json'],
|
|
319
|
+
['application/json']
|
|
320
|
+
);
|
|
321
|
+
}
|
|
322
|
+
|
|
298
323
|
/**
|
|
299
324
|
* Get a conversation by id
|
|
300
325
|
*
|
|
@@ -1887,6 +1912,76 @@ class ConversationsApi {
|
|
|
1887
1912
|
);
|
|
1888
1913
|
}
|
|
1889
1914
|
|
|
1915
|
+
/**
|
|
1916
|
+
* Get a list of Supported Content profiles
|
|
1917
|
+
*
|
|
1918
|
+
* @param {Object} opts Optional parameters
|
|
1919
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1920
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1921
|
+
*/
|
|
1922
|
+
getConversationsMessagingSupportedcontent(opts) {
|
|
1923
|
+
opts = opts || {};
|
|
1924
|
+
|
|
1925
|
+
|
|
1926
|
+
return this.apiClient.callApi(
|
|
1927
|
+
'/api/v2/conversations/messaging/supportedcontent',
|
|
1928
|
+
'GET',
|
|
1929
|
+
{ },
|
|
1930
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
1931
|
+
{ },
|
|
1932
|
+
{ },
|
|
1933
|
+
null,
|
|
1934
|
+
['PureCloud OAuth'],
|
|
1935
|
+
['application/json'],
|
|
1936
|
+
['application/json']
|
|
1937
|
+
);
|
|
1938
|
+
}
|
|
1939
|
+
|
|
1940
|
+
/**
|
|
1941
|
+
* Get the organization's default supported content profile that will be used as the default when creating an integration.
|
|
1942
|
+
* When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
|
|
1943
|
+
*/
|
|
1944
|
+
getConversationsMessagingSupportedcontentDefault() {
|
|
1945
|
+
|
|
1946
|
+
return this.apiClient.callApi(
|
|
1947
|
+
'/api/v2/conversations/messaging/supportedcontent/default',
|
|
1948
|
+
'GET',
|
|
1949
|
+
{ },
|
|
1950
|
+
{ },
|
|
1951
|
+
{ },
|
|
1952
|
+
{ },
|
|
1953
|
+
null,
|
|
1954
|
+
['PureCloud OAuth'],
|
|
1955
|
+
['application/json'],
|
|
1956
|
+
['application/json']
|
|
1957
|
+
);
|
|
1958
|
+
}
|
|
1959
|
+
|
|
1960
|
+
/**
|
|
1961
|
+
* Get a supported content profile
|
|
1962
|
+
*
|
|
1963
|
+
* @param {String} supportedContentId Supported Content ID
|
|
1964
|
+
*/
|
|
1965
|
+
getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
1966
|
+
// verify the required parameter 'supportedContentId' is set
|
|
1967
|
+
if (supportedContentId === undefined || supportedContentId === null) {
|
|
1968
|
+
throw 'Missing the required parameter "supportedContentId" when calling getConversationsMessagingSupportedcontentSupportedContentId';
|
|
1969
|
+
}
|
|
1970
|
+
|
|
1971
|
+
return this.apiClient.callApi(
|
|
1972
|
+
'/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
|
|
1973
|
+
'GET',
|
|
1974
|
+
{ 'supportedContentId': supportedContentId },
|
|
1975
|
+
{ },
|
|
1976
|
+
{ },
|
|
1977
|
+
{ },
|
|
1978
|
+
null,
|
|
1979
|
+
['PureCloud OAuth'],
|
|
1980
|
+
['application/json'],
|
|
1981
|
+
['application/json']
|
|
1982
|
+
);
|
|
1983
|
+
}
|
|
1984
|
+
|
|
1890
1985
|
/**
|
|
1891
1986
|
* Get conversation threading window timeline for each messaging type
|
|
1892
1987
|
* Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
|
|
@@ -2968,6 +3063,36 @@ class ConversationsApi {
|
|
|
2968
3063
|
);
|
|
2969
3064
|
}
|
|
2970
3065
|
|
|
3066
|
+
/**
|
|
3067
|
+
* Update a supported content profile
|
|
3068
|
+
*
|
|
3069
|
+
* @param {String} supportedContentId Supported Content ID
|
|
3070
|
+
* @param {Object} body SupportedContent
|
|
3071
|
+
*/
|
|
3072
|
+
patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
|
|
3073
|
+
// verify the required parameter 'supportedContentId' is set
|
|
3074
|
+
if (supportedContentId === undefined || supportedContentId === null) {
|
|
3075
|
+
throw 'Missing the required parameter "supportedContentId" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
|
|
3076
|
+
}
|
|
3077
|
+
// verify the required parameter 'body' is set
|
|
3078
|
+
if (body === undefined || body === null) {
|
|
3079
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
|
|
3080
|
+
}
|
|
3081
|
+
|
|
3082
|
+
return this.apiClient.callApi(
|
|
3083
|
+
'/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
|
|
3084
|
+
'PATCH',
|
|
3085
|
+
{ 'supportedContentId': supportedContentId },
|
|
3086
|
+
{ },
|
|
3087
|
+
{ },
|
|
3088
|
+
{ },
|
|
3089
|
+
body,
|
|
3090
|
+
['PureCloud OAuth'],
|
|
3091
|
+
['application/json'],
|
|
3092
|
+
['application/json']
|
|
3093
|
+
);
|
|
3094
|
+
}
|
|
3095
|
+
|
|
2971
3096
|
/**
|
|
2972
3097
|
* Index conversation properties
|
|
2973
3098
|
*
|
|
@@ -4203,6 +4328,31 @@ class ConversationsApi {
|
|
|
4203
4328
|
);
|
|
4204
4329
|
}
|
|
4205
4330
|
|
|
4331
|
+
/**
|
|
4332
|
+
* Create a Supported Content profile
|
|
4333
|
+
*
|
|
4334
|
+
* @param {Object} body SupportedContent
|
|
4335
|
+
*/
|
|
4336
|
+
postConversationsMessagingSupportedcontent(body) {
|
|
4337
|
+
// verify the required parameter 'body' is set
|
|
4338
|
+
if (body === undefined || body === null) {
|
|
4339
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingSupportedcontent';
|
|
4340
|
+
}
|
|
4341
|
+
|
|
4342
|
+
return this.apiClient.callApi(
|
|
4343
|
+
'/api/v2/conversations/messaging/supportedcontent',
|
|
4344
|
+
'POST',
|
|
4345
|
+
{ },
|
|
4346
|
+
{ },
|
|
4347
|
+
{ },
|
|
4348
|
+
{ },
|
|
4349
|
+
body,
|
|
4350
|
+
['PureCloud OAuth'],
|
|
4351
|
+
['application/json'],
|
|
4352
|
+
['application/json']
|
|
4353
|
+
);
|
|
4354
|
+
}
|
|
4355
|
+
|
|
4206
4356
|
/**
|
|
4207
4357
|
* Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
4208
4358
|
*
|
|
@@ -4363,6 +4513,31 @@ class ConversationsApi {
|
|
|
4363
4513
|
);
|
|
4364
4514
|
}
|
|
4365
4515
|
|
|
4516
|
+
/**
|
|
4517
|
+
* Set the organization's default supported content profile that may be assigned to an integration when it is created.
|
|
4518
|
+
* When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
|
|
4519
|
+
* @param {Object} body SupportedContent
|
|
4520
|
+
*/
|
|
4521
|
+
putConversationsMessagingSupportedcontentDefault(body) {
|
|
4522
|
+
// verify the required parameter 'body' is set
|
|
4523
|
+
if (body === undefined || body === null) {
|
|
4524
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingSupportedcontentDefault';
|
|
4525
|
+
}
|
|
4526
|
+
|
|
4527
|
+
return this.apiClient.callApi(
|
|
4528
|
+
'/api/v2/conversations/messaging/supportedcontent/default',
|
|
4529
|
+
'PUT',
|
|
4530
|
+
{ },
|
|
4531
|
+
{ },
|
|
4532
|
+
{ },
|
|
4533
|
+
{ },
|
|
4534
|
+
body,
|
|
4535
|
+
['PureCloud OAuth'],
|
|
4536
|
+
['application/json'],
|
|
4537
|
+
['application/json']
|
|
4538
|
+
);
|
|
4539
|
+
}
|
|
4540
|
+
|
|
4366
4541
|
/**
|
|
4367
4542
|
* Update conversation threading window timeline for each messaging type
|
|
4368
4543
|
* PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.
|
|
@@ -5,7 +5,7 @@ class GamificationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Gamification service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 131.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -273,6 +273,31 @@ class GamificationApi {
|
|
|
273
273
|
);
|
|
274
274
|
}
|
|
275
275
|
|
|
276
|
+
/**
|
|
277
|
+
* Members of a given performance profile
|
|
278
|
+
*
|
|
279
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
280
|
+
*/
|
|
281
|
+
getGamificationProfileMembers(performanceProfileId) {
|
|
282
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
283
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
284
|
+
throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
return this.apiClient.callApi(
|
|
288
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members',
|
|
289
|
+
'GET',
|
|
290
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
291
|
+
{ },
|
|
292
|
+
{ },
|
|
293
|
+
{ },
|
|
294
|
+
null,
|
|
295
|
+
['PureCloud OAuth'],
|
|
296
|
+
['application/json'],
|
|
297
|
+
['application/json']
|
|
298
|
+
);
|
|
299
|
+
}
|
|
300
|
+
|
|
276
301
|
/**
|
|
277
302
|
* Performance profile gamified metric by id
|
|
278
303
|
*
|
|
@@ -1127,6 +1152,101 @@ class GamificationApi {
|
|
|
1127
1152
|
);
|
|
1128
1153
|
}
|
|
1129
1154
|
|
|
1155
|
+
/**
|
|
1156
|
+
* Assign members to a given performance profile
|
|
1157
|
+
*
|
|
1158
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
1159
|
+
* @param {Object} body assignUsers
|
|
1160
|
+
*/
|
|
1161
|
+
postGamificationProfileMembers(performanceProfileId, body) {
|
|
1162
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
1163
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
1164
|
+
throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
|
|
1165
|
+
}
|
|
1166
|
+
// verify the required parameter 'body' is set
|
|
1167
|
+
if (body === undefined || body === null) {
|
|
1168
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMembers';
|
|
1169
|
+
}
|
|
1170
|
+
|
|
1171
|
+
return this.apiClient.callApi(
|
|
1172
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members',
|
|
1173
|
+
'POST',
|
|
1174
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
1175
|
+
{ },
|
|
1176
|
+
{ },
|
|
1177
|
+
{ },
|
|
1178
|
+
body,
|
|
1179
|
+
['PureCloud OAuth'],
|
|
1180
|
+
['application/json'],
|
|
1181
|
+
['application/json']
|
|
1182
|
+
);
|
|
1183
|
+
}
|
|
1184
|
+
|
|
1185
|
+
/**
|
|
1186
|
+
* Validate member assignment
|
|
1187
|
+
*
|
|
1188
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
1189
|
+
* @param {Object} body memberAssignments
|
|
1190
|
+
*/
|
|
1191
|
+
postGamificationProfileMembersValidate(performanceProfileId, body) {
|
|
1192
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
1193
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
1194
|
+
throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
|
|
1195
|
+
}
|
|
1196
|
+
// verify the required parameter 'body' is set
|
|
1197
|
+
if (body === undefined || body === null) {
|
|
1198
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';
|
|
1199
|
+
}
|
|
1200
|
+
|
|
1201
|
+
return this.apiClient.callApi(
|
|
1202
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
|
|
1203
|
+
'POST',
|
|
1204
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
1205
|
+
{ },
|
|
1206
|
+
{ },
|
|
1207
|
+
{ },
|
|
1208
|
+
body,
|
|
1209
|
+
['PureCloud OAuth'],
|
|
1210
|
+
['application/json'],
|
|
1211
|
+
['application/json']
|
|
1212
|
+
);
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* Creates a linked metric
|
|
1217
|
+
*
|
|
1218
|
+
* @param {String} sourceProfileId Source Performance Profile Id
|
|
1219
|
+
* @param {String} sourceMetricId Source Metric Id
|
|
1220
|
+
* @param {Object} body linkedMetric
|
|
1221
|
+
*/
|
|
1222
|
+
postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body) {
|
|
1223
|
+
// verify the required parameter 'sourceProfileId' is set
|
|
1224
|
+
if (sourceProfileId === undefined || sourceProfileId === null) {
|
|
1225
|
+
throw 'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';
|
|
1226
|
+
}
|
|
1227
|
+
// verify the required parameter 'sourceMetricId' is set
|
|
1228
|
+
if (sourceMetricId === undefined || sourceMetricId === null) {
|
|
1229
|
+
throw 'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';
|
|
1230
|
+
}
|
|
1231
|
+
// verify the required parameter 'body' is set
|
|
1232
|
+
if (body === undefined || body === null) {
|
|
1233
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMetricLink';
|
|
1234
|
+
}
|
|
1235
|
+
|
|
1236
|
+
return this.apiClient.callApi(
|
|
1237
|
+
'/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link',
|
|
1238
|
+
'POST',
|
|
1239
|
+
{ 'sourceProfileId': sourceProfileId,'sourceMetricId': sourceMetricId },
|
|
1240
|
+
{ },
|
|
1241
|
+
{ },
|
|
1242
|
+
{ },
|
|
1243
|
+
body,
|
|
1244
|
+
['PureCloud OAuth'],
|
|
1245
|
+
['application/json'],
|
|
1246
|
+
['application/json']
|
|
1247
|
+
);
|
|
1248
|
+
}
|
|
1249
|
+
|
|
1130
1250
|
/**
|
|
1131
1251
|
* Creates a gamified metric with a given metric definition and metric objective under in a performance profile
|
|
1132
1252
|
*
|