purecloud-platform-client-v2 168.2.0 → 169.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 -35
- package/dist/node/purecloud-platform-client-v2.js +24925 -20106
- package/dist/web-amd/purecloud-platform-client-v2.js +24925 -20106
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +24925 -20106
- package/dist/web-cjs/purecloud-platform-client-v2.js +24925 -20106
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +2457 -16
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1418 -227
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +142 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
- 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 +4 -4
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +172 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +114 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +114 -4
- 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 +333 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +260 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +200 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
- 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 +11 -6
- 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 +59 -10
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +53 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +136 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +174 -10
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +199 -6
- 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 +80 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +25 -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 +1282 -0
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +32 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +33 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +47 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +51 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +172 -7
- 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 +6 -6
- 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 +6 -6
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class LanguagesApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Languages service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 169.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,7 @@ class LanguagesApi {
|
|
|
24
24
|
* Delete Language (Deprecated)
|
|
25
25
|
* This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
|
|
26
26
|
* @param {String} languageId Language ID
|
|
27
|
-
|
|
27
|
+
* @deprecated
|
|
28
28
|
*/
|
|
29
29
|
deleteLanguage(languageId) {
|
|
30
30
|
// verify the required parameter 'languageId' is set
|
|
@@ -50,7 +50,7 @@ class LanguagesApi {
|
|
|
50
50
|
* Get Language (Deprecated)
|
|
51
51
|
* This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
|
|
52
52
|
* @param {String} languageId Language ID
|
|
53
|
-
|
|
53
|
+
* @deprecated
|
|
54
54
|
*/
|
|
55
55
|
getLanguage(languageId) {
|
|
56
56
|
// verify the required parameter 'languageId' is set
|
|
@@ -80,7 +80,7 @@ class LanguagesApi {
|
|
|
80
80
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
81
81
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
82
82
|
* @param {String} opts.name Name
|
|
83
|
-
|
|
83
|
+
* @deprecated
|
|
84
84
|
*/
|
|
85
85
|
getLanguages(opts) {
|
|
86
86
|
opts = opts || {};
|
|
@@ -199,7 +199,7 @@ class LanguagesApi {
|
|
|
199
199
|
* Create Language (Deprecated)
|
|
200
200
|
* This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
|
|
201
201
|
* @param {Object} body Language
|
|
202
|
-
|
|
202
|
+
* @deprecated
|
|
203
203
|
*/
|
|
204
204
|
postLanguages(body) {
|
|
205
205
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class MessagingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Messaging service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 169.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -22,8 +22,9 @@ class MessagingApi {
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* Delete a supported content profile
|
|
25
|
-
*
|
|
25
|
+
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
26
26
|
* @param {String} supportedContentId Supported Content ID
|
|
27
|
+
* @deprecated
|
|
27
28
|
*/
|
|
28
29
|
deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
29
30
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -47,10 +48,11 @@ class MessagingApi {
|
|
|
47
48
|
|
|
48
49
|
/**
|
|
49
50
|
* Get a list of Supported Content profiles
|
|
50
|
-
*
|
|
51
|
+
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
|
|
51
52
|
* @param {Object} opts Optional parameters
|
|
52
53
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
53
54
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
55
|
+
* @deprecated
|
|
54
56
|
*/
|
|
55
57
|
getMessagingSupportedcontent(opts) {
|
|
56
58
|
opts = opts || {};
|
|
@@ -72,8 +74,9 @@ class MessagingApi {
|
|
|
72
74
|
|
|
73
75
|
/**
|
|
74
76
|
* Get a supported content profile
|
|
75
|
-
*
|
|
77
|
+
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
76
78
|
* @param {String} supportedContentId Supported Content ID
|
|
79
|
+
* @deprecated
|
|
77
80
|
*/
|
|
78
81
|
getMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
79
82
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -97,9 +100,10 @@ class MessagingApi {
|
|
|
97
100
|
|
|
98
101
|
/**
|
|
99
102
|
* Update a supported content profile
|
|
100
|
-
*
|
|
103
|
+
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
101
104
|
* @param {String} supportedContentId Supported Content ID
|
|
102
105
|
* @param {Object} body SupportedContent
|
|
106
|
+
* @deprecated
|
|
103
107
|
*/
|
|
104
108
|
patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
|
|
105
109
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -127,8 +131,9 @@ class MessagingApi {
|
|
|
127
131
|
|
|
128
132
|
/**
|
|
129
133
|
* Create a Supported Content profile
|
|
130
|
-
*
|
|
134
|
+
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
131
135
|
* @param {Object} body SupportedContent
|
|
136
|
+
* @deprecated
|
|
132
137
|
*/
|
|
133
138
|
postMessagingSupportedcontent(body) {
|
|
134
139
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class OrganizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Organization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 169.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,7 @@ class OrganizationApi {
|
|
|
24
24
|
* Fetch field config for an entity type
|
|
25
25
|
*
|
|
26
26
|
* @param {Object} type Field type
|
|
27
|
-
|
|
27
|
+
* @deprecated
|
|
28
28
|
*/
|
|
29
29
|
getFieldconfig(type) {
|
|
30
30
|
// verify the required parameter 'type' is set
|
|
@@ -47,9 +47,30 @@ class OrganizationApi {
|
|
|
47
47
|
}
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* Gets the organization's settings
|
|
51
51
|
*
|
|
52
52
|
*/
|
|
53
|
+
getOrganizationsAuthenticationSettings() {
|
|
54
|
+
|
|
55
|
+
return this.apiClient.callApi(
|
|
56
|
+
'/api/v2/organizations/authentication/settings',
|
|
57
|
+
'GET',
|
|
58
|
+
{ },
|
|
59
|
+
{ },
|
|
60
|
+
{ },
|
|
61
|
+
{ },
|
|
62
|
+
null,
|
|
63
|
+
['PureCloud OAuth'],
|
|
64
|
+
['application/json'],
|
|
65
|
+
['application/json']
|
|
66
|
+
);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* Get the list of domains that will be allowed to embed PureCloud applications
|
|
71
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
72
|
+
* @deprecated
|
|
73
|
+
*/
|
|
53
74
|
getOrganizationsEmbeddedintegration() {
|
|
54
75
|
|
|
55
76
|
return this.apiClient.callApi(
|
|
@@ -68,7 +89,8 @@ class OrganizationApi {
|
|
|
68
89
|
|
|
69
90
|
/**
|
|
70
91
|
* Get organization IP address whitelist settings
|
|
71
|
-
*
|
|
92
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
93
|
+
* @deprecated
|
|
72
94
|
*/
|
|
73
95
|
getOrganizationsIpaddressauthentication() {
|
|
74
96
|
|
|
@@ -255,9 +277,9 @@ class OrganizationApi {
|
|
|
255
277
|
}
|
|
256
278
|
|
|
257
279
|
/**
|
|
258
|
-
*
|
|
280
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
259
281
|
*
|
|
260
|
-
|
|
282
|
+
* @deprecated
|
|
261
283
|
*/
|
|
262
284
|
getOrganizationsWhitelist() {
|
|
263
285
|
|
|
@@ -275,6 +297,31 @@ class OrganizationApi {
|
|
|
275
297
|
);
|
|
276
298
|
}
|
|
277
299
|
|
|
300
|
+
/**
|
|
301
|
+
* Update the organization's settings
|
|
302
|
+
*
|
|
303
|
+
* @param {Object} body Org settings
|
|
304
|
+
*/
|
|
305
|
+
patchOrganizationsAuthenticationSettings(body) {
|
|
306
|
+
// verify the required parameter 'body' is set
|
|
307
|
+
if (body === undefined || body === null) {
|
|
308
|
+
throw 'Missing the required parameter "body" when calling patchOrganizationsAuthenticationSettings';
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
return this.apiClient.callApi(
|
|
312
|
+
'/api/v2/organizations/authentication/settings',
|
|
313
|
+
'PATCH',
|
|
314
|
+
{ },
|
|
315
|
+
{ },
|
|
316
|
+
{ },
|
|
317
|
+
{ },
|
|
318
|
+
body,
|
|
319
|
+
['PureCloud OAuth'],
|
|
320
|
+
['application/json'],
|
|
321
|
+
['application/json']
|
|
322
|
+
);
|
|
323
|
+
}
|
|
324
|
+
|
|
278
325
|
/**
|
|
279
326
|
* Update organization
|
|
280
327
|
*
|
|
@@ -307,8 +354,9 @@ class OrganizationApi {
|
|
|
307
354
|
|
|
308
355
|
/**
|
|
309
356
|
* Update the list of domains that will be allowed to embed PureCloud applications
|
|
310
|
-
*
|
|
357
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
311
358
|
* @param {Object} body Whitelist settings
|
|
359
|
+
* @deprecated
|
|
312
360
|
*/
|
|
313
361
|
putOrganizationsEmbeddedintegration(body) {
|
|
314
362
|
// verify the required parameter 'body' is set
|
|
@@ -332,8 +380,9 @@ class OrganizationApi {
|
|
|
332
380
|
|
|
333
381
|
/**
|
|
334
382
|
* Update organization IP address whitelist settings
|
|
335
|
-
*
|
|
383
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
336
384
|
* @param {Object} body IP address Whitelist settings
|
|
385
|
+
* @deprecated
|
|
337
386
|
*/
|
|
338
387
|
putOrganizationsIpaddressauthentication(body) {
|
|
339
388
|
// verify the required parameter 'body' is set
|
|
@@ -380,10 +429,10 @@ class OrganizationApi {
|
|
|
380
429
|
}
|
|
381
430
|
|
|
382
431
|
/**
|
|
383
|
-
*
|
|
432
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
384
433
|
*
|
|
385
434
|
* @param {Object} body Whitelist settings
|
|
386
|
-
|
|
435
|
+
* @deprecated
|
|
387
436
|
*/
|
|
388
437
|
putOrganizationsWhitelist(body) {
|
|
389
438
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* OrganizationAuthorization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 169.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -195,6 +195,32 @@ class OrganizationAuthorizationApi {
|
|
|
195
195
|
);
|
|
196
196
|
}
|
|
197
197
|
|
|
198
|
+
/**
|
|
199
|
+
* Delete Bulk Org Trustees
|
|
200
|
+
*
|
|
201
|
+
* @param {Array.<String>} id Comma separated list of trustee ids to remove
|
|
202
|
+
* Preview Endpoint
|
|
203
|
+
*/
|
|
204
|
+
deleteOrgauthorizationTrustees(id) {
|
|
205
|
+
// verify the required parameter 'id' is set
|
|
206
|
+
if (id === undefined || id === null) {
|
|
207
|
+
throw 'Missing the required parameter "id" when calling deleteOrgauthorizationTrustees';
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
return this.apiClient.callApi(
|
|
211
|
+
'/api/v2/orgauthorization/trustees',
|
|
212
|
+
'DELETE',
|
|
213
|
+
{ },
|
|
214
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
215
|
+
{ },
|
|
216
|
+
{ },
|
|
217
|
+
null,
|
|
218
|
+
['PureCloud OAuth'],
|
|
219
|
+
['application/json'],
|
|
220
|
+
['application/json']
|
|
221
|
+
);
|
|
222
|
+
}
|
|
223
|
+
|
|
198
224
|
/**
|
|
199
225
|
* Delete Org Trust
|
|
200
226
|
*
|
|
@@ -310,6 +336,32 @@ class OrganizationAuthorizationApi {
|
|
|
310
336
|
);
|
|
311
337
|
}
|
|
312
338
|
|
|
339
|
+
/**
|
|
340
|
+
* Delete Bulk Org Trustors
|
|
341
|
+
*
|
|
342
|
+
* @param {Array.<String>} id Comma separated list of trustor ids to remove
|
|
343
|
+
* Preview Endpoint
|
|
344
|
+
*/
|
|
345
|
+
deleteOrgauthorizationTrustors(id) {
|
|
346
|
+
// verify the required parameter 'id' is set
|
|
347
|
+
if (id === undefined || id === null) {
|
|
348
|
+
throw 'Missing the required parameter "id" when calling deleteOrgauthorizationTrustors';
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
return this.apiClient.callApi(
|
|
352
|
+
'/api/v2/orgauthorization/trustors',
|
|
353
|
+
'DELETE',
|
|
354
|
+
{ },
|
|
355
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
356
|
+
{ },
|
|
357
|
+
{ },
|
|
358
|
+
null,
|
|
359
|
+
['PureCloud OAuth'],
|
|
360
|
+
['application/json'],
|
|
361
|
+
['application/json']
|
|
362
|
+
);
|
|
363
|
+
}
|
|
364
|
+
|
|
313
365
|
/**
|
|
314
366
|
* Get Pairing Info
|
|
315
367
|
*
|
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 169.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2490,7 +2490,7 @@ class OutboundApi {
|
|
|
2490
2490
|
* This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
|
|
2491
2491
|
* @param {String} campaignId Campaign ID
|
|
2492
2492
|
* @param {Object} body ContactCallbackRequest
|
|
2493
|
-
|
|
2493
|
+
* @deprecated
|
|
2494
2494
|
*/
|
|
2495
2495
|
postOutboundCampaignCallbackSchedule(campaignId, body) {
|
|
2496
2496
|
// verify the required parameter 'campaignId' is set
|
|
@@ -5,7 +5,7 @@ class PresenceApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Presence service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 169.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,32 @@ class PresenceApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Delete a Presence Definition
|
|
25
|
+
*
|
|
26
|
+
* @param {String} definitionId Presence Definition ID
|
|
27
|
+
* Preview Endpoint
|
|
28
|
+
*/
|
|
29
|
+
deletePresenceDefinition(definitionId) {
|
|
30
|
+
// verify the required parameter 'definitionId' is set
|
|
31
|
+
if (definitionId === undefined || definitionId === null) {
|
|
32
|
+
throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return this.apiClient.callApi(
|
|
36
|
+
'/api/v2/presence/definitions/{definitionId}',
|
|
37
|
+
'DELETE',
|
|
38
|
+
{ 'definitionId': definitionId },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
{ },
|
|
42
|
+
null,
|
|
43
|
+
['PureCloud OAuth'],
|
|
44
|
+
['application/json'],
|
|
45
|
+
['application/json']
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
|
|
23
49
|
/**
|
|
24
50
|
* Delete a Presence Source
|
|
25
51
|
*
|
|
@@ -70,6 +96,58 @@ class PresenceApi {
|
|
|
70
96
|
);
|
|
71
97
|
}
|
|
72
98
|
|
|
99
|
+
/**
|
|
100
|
+
* Get a Presence Definition
|
|
101
|
+
*
|
|
102
|
+
* @param {String} definitionId Presence Definition ID
|
|
103
|
+
* Preview Endpoint
|
|
104
|
+
*/
|
|
105
|
+
getPresenceDefinition(definitionId) {
|
|
106
|
+
// verify the required parameter 'definitionId' is set
|
|
107
|
+
if (definitionId === undefined || definitionId === null) {
|
|
108
|
+
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition';
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
return this.apiClient.callApi(
|
|
112
|
+
'/api/v2/presence/definitions/{definitionId}',
|
|
113
|
+
'GET',
|
|
114
|
+
{ 'definitionId': definitionId },
|
|
115
|
+
{ },
|
|
116
|
+
{ },
|
|
117
|
+
{ },
|
|
118
|
+
null,
|
|
119
|
+
['PureCloud OAuth'],
|
|
120
|
+
['application/json'],
|
|
121
|
+
['application/json']
|
|
122
|
+
);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Get a list of Presence Definitions
|
|
127
|
+
*
|
|
128
|
+
* @param {Object} opts Optional parameters
|
|
129
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
130
|
+
* @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.
|
|
131
|
+
* Preview Endpoint
|
|
132
|
+
*/
|
|
133
|
+
getPresenceDefinitions(opts) {
|
|
134
|
+
opts = opts || {};
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
return this.apiClient.callApi(
|
|
138
|
+
'/api/v2/presence/definitions',
|
|
139
|
+
'GET',
|
|
140
|
+
{ },
|
|
141
|
+
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
142
|
+
{ },
|
|
143
|
+
{ },
|
|
144
|
+
null,
|
|
145
|
+
['PureCloud OAuth'],
|
|
146
|
+
['application/json'],
|
|
147
|
+
['application/json']
|
|
148
|
+
);
|
|
149
|
+
}
|
|
150
|
+
|
|
73
151
|
/**
|
|
74
152
|
* Get the presence settings
|
|
75
153
|
*
|
|
@@ -360,6 +438,32 @@ class PresenceApi {
|
|
|
360
438
|
);
|
|
361
439
|
}
|
|
362
440
|
|
|
441
|
+
/**
|
|
442
|
+
* Create a Presence Definition
|
|
443
|
+
*
|
|
444
|
+
* @param {Object} body The Presence Definition to create
|
|
445
|
+
* Preview Endpoint
|
|
446
|
+
*/
|
|
447
|
+
postPresenceDefinitions(body) {
|
|
448
|
+
// verify the required parameter 'body' is set
|
|
449
|
+
if (body === undefined || body === null) {
|
|
450
|
+
throw 'Missing the required parameter "body" when calling postPresenceDefinitions';
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
return this.apiClient.callApi(
|
|
454
|
+
'/api/v2/presence/definitions',
|
|
455
|
+
'POST',
|
|
456
|
+
{ },
|
|
457
|
+
{ },
|
|
458
|
+
{ },
|
|
459
|
+
{ },
|
|
460
|
+
body,
|
|
461
|
+
['PureCloud OAuth'],
|
|
462
|
+
['application/json'],
|
|
463
|
+
['application/json']
|
|
464
|
+
);
|
|
465
|
+
}
|
|
466
|
+
|
|
363
467
|
/**
|
|
364
468
|
* Create a Presence Source
|
|
365
469
|
*
|
|
@@ -410,6 +514,37 @@ class PresenceApi {
|
|
|
410
514
|
);
|
|
411
515
|
}
|
|
412
516
|
|
|
517
|
+
/**
|
|
518
|
+
* Update a Presence Definition
|
|
519
|
+
*
|
|
520
|
+
* @param {String} definitionId Presence Definition ID
|
|
521
|
+
* @param {Object} body The updated Presence Definition
|
|
522
|
+
* Preview Endpoint
|
|
523
|
+
*/
|
|
524
|
+
putPresenceDefinition(definitionId, body) {
|
|
525
|
+
// verify the required parameter 'definitionId' is set
|
|
526
|
+
if (definitionId === undefined || definitionId === null) {
|
|
527
|
+
throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition';
|
|
528
|
+
}
|
|
529
|
+
// verify the required parameter 'body' is set
|
|
530
|
+
if (body === undefined || body === null) {
|
|
531
|
+
throw 'Missing the required parameter "body" when calling putPresenceDefinition';
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
return this.apiClient.callApi(
|
|
535
|
+
'/api/v2/presence/definitions/{definitionId}',
|
|
536
|
+
'PUT',
|
|
537
|
+
{ 'definitionId': definitionId },
|
|
538
|
+
{ },
|
|
539
|
+
{ },
|
|
540
|
+
{ },
|
|
541
|
+
body,
|
|
542
|
+
['PureCloud OAuth'],
|
|
543
|
+
['application/json'],
|
|
544
|
+
['application/json']
|
|
545
|
+
);
|
|
546
|
+
}
|
|
547
|
+
|
|
413
548
|
/**
|
|
414
549
|
* Update the presence settings
|
|
415
550
|
*
|