purecloud-platform-client-v2 179.3.0 → 181.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +538 -166
- package/dist/web-amd/purecloud-platform-client-v2.js +538 -166
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +538 -166
- package/dist/web-cjs/purecloud-platform-client-v2.js +790 -213
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +459 -250
- 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 +1 -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/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +8 -80
- 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 +59 -3
- 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/EmailsApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +73 -2
- 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/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +71 -0
- 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 +9 -4
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- 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 +1 -1
- 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/SettingsApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +57 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +86 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +92 -2
- 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 +17 -7
- package/src/purecloud-platform-client-v2/index.js +7 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 181.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3358,7 +3358,7 @@ class AlertingApi {
|
|
|
3358
3358
|
/**
|
|
3359
3359
|
* Alerting service.
|
|
3360
3360
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3361
|
-
* @version
|
|
3361
|
+
* @version 181.0.0
|
|
3362
3362
|
*/
|
|
3363
3363
|
|
|
3364
3364
|
/**
|
|
@@ -4008,7 +4008,7 @@ class AnalyticsApi {
|
|
|
4008
4008
|
/**
|
|
4009
4009
|
* Analytics service.
|
|
4010
4010
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4011
|
-
* @version
|
|
4011
|
+
* @version 181.0.0
|
|
4012
4012
|
*/
|
|
4013
4013
|
|
|
4014
4014
|
/**
|
|
@@ -6454,7 +6454,7 @@ class ArchitectApi {
|
|
|
6454
6454
|
/**
|
|
6455
6455
|
* Architect service.
|
|
6456
6456
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6457
|
-
* @version
|
|
6457
|
+
* @version 181.0.0
|
|
6458
6458
|
*/
|
|
6459
6459
|
|
|
6460
6460
|
/**
|
|
@@ -10289,7 +10289,7 @@ class AuditApi {
|
|
|
10289
10289
|
/**
|
|
10290
10290
|
* Audit service.
|
|
10291
10291
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10292
|
-
* @version
|
|
10292
|
+
* @version 181.0.0
|
|
10293
10293
|
*/
|
|
10294
10294
|
|
|
10295
10295
|
/**
|
|
@@ -10460,7 +10460,7 @@ class AuthorizationApi {
|
|
|
10460
10460
|
/**
|
|
10461
10461
|
* Authorization service.
|
|
10462
10462
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10463
|
-
* @version
|
|
10463
|
+
* @version 181.0.0
|
|
10464
10464
|
*/
|
|
10465
10465
|
|
|
10466
10466
|
/**
|
|
@@ -11691,7 +11691,7 @@ class BillingApi {
|
|
|
11691
11691
|
/**
|
|
11692
11692
|
* Billing service.
|
|
11693
11693
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11694
|
-
* @version
|
|
11694
|
+
* @version 181.0.0
|
|
11695
11695
|
*/
|
|
11696
11696
|
|
|
11697
11697
|
/**
|
|
@@ -11771,7 +11771,7 @@ class CarrierServicesApi {
|
|
|
11771
11771
|
/**
|
|
11772
11772
|
* CarrierServices service.
|
|
11773
11773
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11774
|
-
* @version
|
|
11774
|
+
* @version 181.0.0
|
|
11775
11775
|
*/
|
|
11776
11776
|
|
|
11777
11777
|
/**
|
|
@@ -11841,7 +11841,7 @@ class ChatApi {
|
|
|
11841
11841
|
/**
|
|
11842
11842
|
* Chat service.
|
|
11843
11843
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11844
|
-
* @version
|
|
11844
|
+
* @version 181.0.0
|
|
11845
11845
|
*/
|
|
11846
11846
|
|
|
11847
11847
|
/**
|
|
@@ -11980,27 +11980,6 @@ class ChatApi {
|
|
|
11980
11980
|
);
|
|
11981
11981
|
}
|
|
11982
11982
|
|
|
11983
|
-
/**
|
|
11984
|
-
* Get Chat Settings.
|
|
11985
|
-
* This route is deprecated, please use /chats/settings instead
|
|
11986
|
-
* @deprecated
|
|
11987
|
-
*/
|
|
11988
|
-
getChatSettings() {
|
|
11989
|
-
|
|
11990
|
-
return this.apiClient.callApi(
|
|
11991
|
-
'/api/v2/chat/settings',
|
|
11992
|
-
'GET',
|
|
11993
|
-
{ },
|
|
11994
|
-
{ },
|
|
11995
|
-
{ },
|
|
11996
|
-
{ },
|
|
11997
|
-
null,
|
|
11998
|
-
['PureCloud OAuth'],
|
|
11999
|
-
['application/json'],
|
|
12000
|
-
['application/json']
|
|
12001
|
-
);
|
|
12002
|
-
}
|
|
12003
|
-
|
|
12004
11983
|
/**
|
|
12005
11984
|
* Get a message
|
|
12006
11985
|
*
|
|
@@ -12249,32 +12228,6 @@ class ChatApi {
|
|
|
12249
12228
|
);
|
|
12250
12229
|
}
|
|
12251
12230
|
|
|
12252
|
-
/**
|
|
12253
|
-
* Patch Chat Settings.
|
|
12254
|
-
* This route is deprecated, please use /chats/settings instead
|
|
12255
|
-
* @param {Object} body Chat
|
|
12256
|
-
* @deprecated
|
|
12257
|
-
*/
|
|
12258
|
-
patchChatSettings(body) {
|
|
12259
|
-
// verify the required parameter 'body' is set
|
|
12260
|
-
if (body === undefined || body === null) {
|
|
12261
|
-
throw 'Missing the required parameter "body" when calling patchChatSettings';
|
|
12262
|
-
}
|
|
12263
|
-
|
|
12264
|
-
return this.apiClient.callApi(
|
|
12265
|
-
'/api/v2/chat/settings',
|
|
12266
|
-
'PATCH',
|
|
12267
|
-
{ },
|
|
12268
|
-
{ },
|
|
12269
|
-
{ },
|
|
12270
|
-
{ },
|
|
12271
|
-
body,
|
|
12272
|
-
['PureCloud OAuth'],
|
|
12273
|
-
['application/json'],
|
|
12274
|
-
['application/json']
|
|
12275
|
-
);
|
|
12276
|
-
}
|
|
12277
|
-
|
|
12278
12231
|
/**
|
|
12279
12232
|
* Set properties for a room
|
|
12280
12233
|
*
|
|
@@ -12499,13 +12452,14 @@ class ChatApi {
|
|
|
12499
12452
|
/**
|
|
12500
12453
|
* Create an adhoc room
|
|
12501
12454
|
*
|
|
12502
|
-
* @param {Object}
|
|
12503
|
-
* @param {Object} opts.body Room properties
|
|
12455
|
+
* @param {Object} body Room properties
|
|
12504
12456
|
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12505
12457
|
*/
|
|
12506
|
-
postChatsRooms(
|
|
12507
|
-
|
|
12508
|
-
|
|
12458
|
+
postChatsRooms(body) {
|
|
12459
|
+
// verify the required parameter 'body' is set
|
|
12460
|
+
if (body === undefined || body === null) {
|
|
12461
|
+
throw 'Missing the required parameter "body" when calling postChatsRooms';
|
|
12462
|
+
}
|
|
12509
12463
|
|
|
12510
12464
|
return this.apiClient.callApi(
|
|
12511
12465
|
'/api/v2/chats/rooms',
|
|
@@ -12514,7 +12468,7 @@ class ChatApi {
|
|
|
12514
12468
|
{ },
|
|
12515
12469
|
{ },
|
|
12516
12470
|
{ },
|
|
12517
|
-
|
|
12471
|
+
body,
|
|
12518
12472
|
['PureCloud OAuth'],
|
|
12519
12473
|
['application/json'],
|
|
12520
12474
|
['application/json']
|
|
@@ -12552,32 +12506,6 @@ class ChatApi {
|
|
|
12552
12506
|
);
|
|
12553
12507
|
}
|
|
12554
12508
|
|
|
12555
|
-
/**
|
|
12556
|
-
* Update Chat Settings.
|
|
12557
|
-
* This route is deprecated, please use /chats/settings instead
|
|
12558
|
-
* @param {Object} body Chat
|
|
12559
|
-
* @deprecated
|
|
12560
|
-
*/
|
|
12561
|
-
putChatSettings(body) {
|
|
12562
|
-
// verify the required parameter 'body' is set
|
|
12563
|
-
if (body === undefined || body === null) {
|
|
12564
|
-
throw 'Missing the required parameter "body" when calling putChatSettings';
|
|
12565
|
-
}
|
|
12566
|
-
|
|
12567
|
-
return this.apiClient.callApi(
|
|
12568
|
-
'/api/v2/chat/settings',
|
|
12569
|
-
'PUT',
|
|
12570
|
-
{ },
|
|
12571
|
-
{ },
|
|
12572
|
-
{ },
|
|
12573
|
-
{ },
|
|
12574
|
-
body,
|
|
12575
|
-
['PureCloud OAuth'],
|
|
12576
|
-
['application/json'],
|
|
12577
|
-
['application/json']
|
|
12578
|
-
);
|
|
12579
|
-
}
|
|
12580
|
-
|
|
12581
12509
|
/**
|
|
12582
12510
|
* Update Chat Settings.
|
|
12583
12511
|
*
|
|
@@ -12609,7 +12537,7 @@ class CoachingApi {
|
|
|
12609
12537
|
/**
|
|
12610
12538
|
* Coaching service.
|
|
12611
12539
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12612
|
-
* @version
|
|
12540
|
+
* @version 181.0.0
|
|
12613
12541
|
*/
|
|
12614
12542
|
|
|
12615
12543
|
/**
|
|
@@ -13186,7 +13114,7 @@ class ContentManagementApi {
|
|
|
13186
13114
|
/**
|
|
13187
13115
|
* ContentManagement service.
|
|
13188
13116
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13189
|
-
* @version
|
|
13117
|
+
* @version 181.0.0
|
|
13190
13118
|
*/
|
|
13191
13119
|
|
|
13192
13120
|
/**
|
|
@@ -14329,7 +14257,7 @@ class ConversationsApi {
|
|
|
14329
14257
|
/**
|
|
14330
14258
|
* Conversations service.
|
|
14331
14259
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14332
|
-
* @version
|
|
14260
|
+
* @version 181.0.0
|
|
14333
14261
|
*/
|
|
14334
14262
|
|
|
14335
14263
|
/**
|
|
@@ -18374,6 +18302,36 @@ class ConversationsApi {
|
|
|
18374
18302
|
);
|
|
18375
18303
|
}
|
|
18376
18304
|
|
|
18305
|
+
/**
|
|
18306
|
+
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
18307
|
+
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
|
|
18308
|
+
* @param {String} integrationId Integration ID
|
|
18309
|
+
* @param {Object} body WhatsAppEmbeddedSignupIntegrationActivationRequest
|
|
18310
|
+
*/
|
|
18311
|
+
patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(integrationId, body) {
|
|
18312
|
+
// verify the required parameter 'integrationId' is set
|
|
18313
|
+
if (integrationId === undefined || integrationId === null) {
|
|
18314
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';
|
|
18315
|
+
}
|
|
18316
|
+
// verify the required parameter 'body' is set
|
|
18317
|
+
if (body === undefined || body === null) {
|
|
18318
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';
|
|
18319
|
+
}
|
|
18320
|
+
|
|
18321
|
+
return this.apiClient.callApi(
|
|
18322
|
+
'/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}',
|
|
18323
|
+
'PATCH',
|
|
18324
|
+
{ 'integrationId': integrationId },
|
|
18325
|
+
{ },
|
|
18326
|
+
{ },
|
|
18327
|
+
{ },
|
|
18328
|
+
body,
|
|
18329
|
+
['PureCloud OAuth'],
|
|
18330
|
+
['application/json'],
|
|
18331
|
+
['application/json']
|
|
18332
|
+
);
|
|
18333
|
+
}
|
|
18334
|
+
|
|
18377
18335
|
/**
|
|
18378
18336
|
* Update or activate a WhatsApp messaging integration
|
|
18379
18337
|
* The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
@@ -20600,9 +20558,10 @@ class ConversationsApi {
|
|
|
20600
20558
|
}
|
|
20601
20559
|
|
|
20602
20560
|
/**
|
|
20603
|
-
* Create a WhatsApp Integration
|
|
20604
|
-
* You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
20561
|
+
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
20562
|
+
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
20605
20563
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
20564
|
+
* @deprecated
|
|
20606
20565
|
*/
|
|
20607
20566
|
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
20608
20567
|
// verify the required parameter 'body' is set
|
|
@@ -20624,6 +20583,31 @@ class ConversationsApi {
|
|
|
20624
20583
|
);
|
|
20625
20584
|
}
|
|
20626
20585
|
|
|
20586
|
+
/**
|
|
20587
|
+
* Create a WhatsApp Integration using the WhatsApp embedded signup flow
|
|
20588
|
+
* Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.
|
|
20589
|
+
* @param {Object} body WhatsAppEmbeddedSignupIntegrationRequest
|
|
20590
|
+
*/
|
|
20591
|
+
postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(body) {
|
|
20592
|
+
// verify the required parameter 'body' is set
|
|
20593
|
+
if (body === undefined || body === null) {
|
|
20594
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsappEmbeddedsignup';
|
|
20595
|
+
}
|
|
20596
|
+
|
|
20597
|
+
return this.apiClient.callApi(
|
|
20598
|
+
'/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup',
|
|
20599
|
+
'POST',
|
|
20600
|
+
{ },
|
|
20601
|
+
{ },
|
|
20602
|
+
{ },
|
|
20603
|
+
{ },
|
|
20604
|
+
body,
|
|
20605
|
+
['PureCloud OAuth'],
|
|
20606
|
+
['application/json'],
|
|
20607
|
+
['application/json']
|
|
20608
|
+
);
|
|
20609
|
+
}
|
|
20610
|
+
|
|
20627
20611
|
/**
|
|
20628
20612
|
* Create a messaging setting
|
|
20629
20613
|
*
|
|
@@ -21413,7 +21397,7 @@ class DataExtensionsApi {
|
|
|
21413
21397
|
/**
|
|
21414
21398
|
* DataExtensions service.
|
|
21415
21399
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21416
|
-
* @version
|
|
21400
|
+
* @version 181.0.0
|
|
21417
21401
|
*/
|
|
21418
21402
|
|
|
21419
21403
|
/**
|
|
@@ -21499,7 +21483,7 @@ class DownloadsApi {
|
|
|
21499
21483
|
/**
|
|
21500
21484
|
* Downloads service.
|
|
21501
21485
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21502
|
-
* @version
|
|
21486
|
+
* @version 181.0.0
|
|
21503
21487
|
*/
|
|
21504
21488
|
|
|
21505
21489
|
/**
|
|
@@ -21551,7 +21535,7 @@ class EmailsApi {
|
|
|
21551
21535
|
/**
|
|
21552
21536
|
* Emails service.
|
|
21553
21537
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21554
|
-
* @version
|
|
21538
|
+
* @version 181.0.0
|
|
21555
21539
|
*/
|
|
21556
21540
|
|
|
21557
21541
|
/**
|
|
@@ -21616,7 +21600,7 @@ class EventsApi {
|
|
|
21616
21600
|
/**
|
|
21617
21601
|
* Events service.
|
|
21618
21602
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21619
|
-
* @version
|
|
21603
|
+
* @version 181.0.0
|
|
21620
21604
|
*/
|
|
21621
21605
|
|
|
21622
21606
|
/**
|
|
@@ -21712,7 +21696,7 @@ class ExternalContactsApi {
|
|
|
21712
21696
|
/**
|
|
21713
21697
|
* ExternalContacts service.
|
|
21714
21698
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21715
|
-
* @version
|
|
21699
|
+
* @version 181.0.0
|
|
21716
21700
|
*/
|
|
21717
21701
|
|
|
21718
21702
|
/**
|
|
@@ -23670,7 +23654,7 @@ class FaxApi {
|
|
|
23670
23654
|
/**
|
|
23671
23655
|
* Fax service.
|
|
23672
23656
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23673
|
-
* @version
|
|
23657
|
+
* @version 181.0.0
|
|
23674
23658
|
*/
|
|
23675
23659
|
|
|
23676
23660
|
/**
|
|
@@ -23841,7 +23825,7 @@ class FlowsApi {
|
|
|
23841
23825
|
/**
|
|
23842
23826
|
* Flows service.
|
|
23843
23827
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23844
|
-
* @version
|
|
23828
|
+
* @version 181.0.0
|
|
23845
23829
|
*/
|
|
23846
23830
|
|
|
23847
23831
|
/**
|
|
@@ -24025,7 +24009,7 @@ class GamificationApi {
|
|
|
24025
24009
|
/**
|
|
24026
24010
|
* Gamification service.
|
|
24027
24011
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24028
|
-
* @version
|
|
24012
|
+
* @version 181.0.0
|
|
24029
24013
|
*/
|
|
24030
24014
|
|
|
24031
24015
|
/**
|
|
@@ -26111,7 +26095,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26111
26095
|
/**
|
|
26112
26096
|
* GeneralDataProtectionRegulation service.
|
|
26113
26097
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26114
|
-
* @version
|
|
26098
|
+
* @version 181.0.0
|
|
26115
26099
|
*/
|
|
26116
26100
|
|
|
26117
26101
|
/**
|
|
@@ -26241,7 +26225,7 @@ class GeolocationApi {
|
|
|
26241
26225
|
/**
|
|
26242
26226
|
* Geolocation service.
|
|
26243
26227
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26244
|
-
* @version
|
|
26228
|
+
* @version 181.0.0
|
|
26245
26229
|
*/
|
|
26246
26230
|
|
|
26247
26231
|
/**
|
|
@@ -26372,7 +26356,7 @@ class GreetingsApi {
|
|
|
26372
26356
|
/**
|
|
26373
26357
|
* Greetings service.
|
|
26374
26358
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26375
|
-
* @version
|
|
26359
|
+
* @version 181.0.0
|
|
26376
26360
|
*/
|
|
26377
26361
|
|
|
26378
26362
|
/**
|
|
@@ -26827,7 +26811,7 @@ class GroupsApi {
|
|
|
26827
26811
|
/**
|
|
26828
26812
|
* Groups service.
|
|
26829
26813
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26830
|
-
* @version
|
|
26814
|
+
* @version 181.0.0
|
|
26831
26815
|
*/
|
|
26832
26816
|
|
|
26833
26817
|
/**
|
|
@@ -27346,7 +27330,7 @@ class IdentityProviderApi {
|
|
|
27346
27330
|
/**
|
|
27347
27331
|
* IdentityProvider service.
|
|
27348
27332
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27349
|
-
* @version
|
|
27333
|
+
* @version 181.0.0
|
|
27350
27334
|
*/
|
|
27351
27335
|
|
|
27352
27336
|
/**
|
|
@@ -28102,7 +28086,7 @@ class InfrastructureAsCodeApi {
|
|
|
28102
28086
|
/**
|
|
28103
28087
|
* InfrastructureAsCode service.
|
|
28104
28088
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28105
|
-
* @version
|
|
28089
|
+
* @version 181.0.0
|
|
28106
28090
|
*/
|
|
28107
28091
|
|
|
28108
28092
|
/**
|
|
@@ -28269,7 +28253,7 @@ class IntegrationsApi {
|
|
|
28269
28253
|
/**
|
|
28270
28254
|
* Integrations service.
|
|
28271
28255
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28272
|
-
* @version
|
|
28256
|
+
* @version 181.0.0
|
|
28273
28257
|
*/
|
|
28274
28258
|
|
|
28275
28259
|
/**
|
|
@@ -30231,7 +30215,7 @@ class JourneyApi {
|
|
|
30231
30215
|
/**
|
|
30232
30216
|
* Journey service.
|
|
30233
30217
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30234
|
-
* @version
|
|
30218
|
+
* @version 181.0.0
|
|
30235
30219
|
*/
|
|
30236
30220
|
|
|
30237
30221
|
/**
|
|
@@ -30673,6 +30657,48 @@ class JourneyApi {
|
|
|
30673
30657
|
);
|
|
30674
30658
|
}
|
|
30675
30659
|
|
|
30660
|
+
/**
|
|
30661
|
+
* Send a ping.
|
|
30662
|
+
*
|
|
30663
|
+
* @param {String} deploymentId The ID of the deployment sending the ping.
|
|
30664
|
+
* @param {String} customerCookieId ID of the customer associated with the ping.
|
|
30665
|
+
* @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
30666
|
+
* @param {Object} opts Optional parameters
|
|
30667
|
+
* @param {String} opts.dl Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.
|
|
30668
|
+
* @param {String} opts.dt Document Title. A human readable name for the page or screen
|
|
30669
|
+
* @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
|
|
30670
|
+
* @param {Number} opts.sinceLastBeaconMilliseconds How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.
|
|
30671
|
+
*/
|
|
30672
|
+
getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, sessionId, opts) {
|
|
30673
|
+
opts = opts || {};
|
|
30674
|
+
|
|
30675
|
+
// verify the required parameter 'deploymentId' is set
|
|
30676
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
30677
|
+
throw 'Missing the required parameter "deploymentId" when calling getJourneyDeploymentCustomerPing';
|
|
30678
|
+
}
|
|
30679
|
+
// verify the required parameter 'customerCookieId' is set
|
|
30680
|
+
if (customerCookieId === undefined || customerCookieId === null) {
|
|
30681
|
+
throw 'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';
|
|
30682
|
+
}
|
|
30683
|
+
// verify the required parameter 'sessionId' is set
|
|
30684
|
+
if (sessionId === undefined || sessionId === null) {
|
|
30685
|
+
throw 'Missing the required parameter "sessionId" when calling getJourneyDeploymentCustomerPing';
|
|
30686
|
+
}
|
|
30687
|
+
|
|
30688
|
+
return this.apiClient.callApi(
|
|
30689
|
+
'/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping',
|
|
30690
|
+
'GET',
|
|
30691
|
+
{ 'deploymentId': deploymentId,'customerCookieId': customerCookieId },
|
|
30692
|
+
{ 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': sessionId,'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
|
|
30693
|
+
{ },
|
|
30694
|
+
{ },
|
|
30695
|
+
null,
|
|
30696
|
+
['PureCloud OAuth'],
|
|
30697
|
+
['application/json'],
|
|
30698
|
+
['application/json']
|
|
30699
|
+
);
|
|
30700
|
+
}
|
|
30701
|
+
|
|
30676
30702
|
/**
|
|
30677
30703
|
* Retrieve a single outcome.
|
|
30678
30704
|
*
|
|
@@ -31262,13 +31288,42 @@ class JourneyApi {
|
|
|
31262
31288
|
);
|
|
31263
31289
|
}
|
|
31264
31290
|
|
|
31291
|
+
/**
|
|
31292
|
+
* Sends an action event, which is used for changing the state of actions that have been offered to the user.
|
|
31293
|
+
*
|
|
31294
|
+
* @param {String} deploymentId The ID of the deployment sending the beacon.
|
|
31295
|
+
* @param {Object} body
|
|
31296
|
+
*/
|
|
31297
|
+
postJourneyDeploymentActionevent(deploymentId, body) {
|
|
31298
|
+
// verify the required parameter 'deploymentId' is set
|
|
31299
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
31300
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentActionevent';
|
|
31301
|
+
}
|
|
31302
|
+
// verify the required parameter 'body' is set
|
|
31303
|
+
if (body === undefined || body === null) {
|
|
31304
|
+
throw 'Missing the required parameter "body" when calling postJourneyDeploymentActionevent';
|
|
31305
|
+
}
|
|
31306
|
+
|
|
31307
|
+
return this.apiClient.callApi(
|
|
31308
|
+
'/api/v2/journey/deployments/{deploymentId}/actionevent',
|
|
31309
|
+
'POST',
|
|
31310
|
+
{ 'deploymentId': deploymentId },
|
|
31311
|
+
{ },
|
|
31312
|
+
{ },
|
|
31313
|
+
{ },
|
|
31314
|
+
body,
|
|
31315
|
+
['PureCloud OAuth'],
|
|
31316
|
+
['application/json'],
|
|
31317
|
+
['application/json']
|
|
31318
|
+
);
|
|
31319
|
+
}
|
|
31320
|
+
|
|
31265
31321
|
/**
|
|
31266
31322
|
* Send a journey app event, used for tracking customer activity on an application.
|
|
31267
31323
|
*
|
|
31268
31324
|
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
31269
31325
|
* @param {Object} opts Optional parameters
|
|
31270
31326
|
* @param {Object} opts.body
|
|
31271
|
-
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31272
31327
|
*/
|
|
31273
31328
|
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
31274
31329
|
opts = opts || {};
|
|
@@ -31395,7 +31450,7 @@ class KnowledgeApi {
|
|
|
31395
31450
|
/**
|
|
31396
31451
|
* Knowledge service.
|
|
31397
31452
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31398
|
-
* @version
|
|
31453
|
+
* @version 181.0.0
|
|
31399
31454
|
*/
|
|
31400
31455
|
|
|
31401
31456
|
/**
|
|
@@ -34216,7 +34271,7 @@ class LanguageUnderstandingApi {
|
|
|
34216
34271
|
/**
|
|
34217
34272
|
* LanguageUnderstanding service.
|
|
34218
34273
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34219
|
-
* @version
|
|
34274
|
+
* @version 181.0.0
|
|
34220
34275
|
*/
|
|
34221
34276
|
|
|
34222
34277
|
/**
|
|
@@ -35229,7 +35284,7 @@ class LanguagesApi {
|
|
|
35229
35284
|
/**
|
|
35230
35285
|
* Languages service.
|
|
35231
35286
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35232
|
-
* @version
|
|
35287
|
+
* @version 181.0.0
|
|
35233
35288
|
*/
|
|
35234
35289
|
|
|
35235
35290
|
/**
|
|
@@ -35451,7 +35506,7 @@ class LearningApi {
|
|
|
35451
35506
|
/**
|
|
35452
35507
|
* Learning service.
|
|
35453
35508
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35454
|
-
* @version
|
|
35509
|
+
* @version 181.0.0
|
|
35455
35510
|
*/
|
|
35456
35511
|
|
|
35457
35512
|
/**
|
|
@@ -36270,7 +36325,7 @@ class LicenseApi {
|
|
|
36270
36325
|
/**
|
|
36271
36326
|
* License service.
|
|
36272
36327
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36273
|
-
* @version
|
|
36328
|
+
* @version 181.0.0
|
|
36274
36329
|
*/
|
|
36275
36330
|
|
|
36276
36331
|
/**
|
|
@@ -36508,7 +36563,7 @@ class LocationsApi {
|
|
|
36508
36563
|
/**
|
|
36509
36564
|
* Locations service.
|
|
36510
36565
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36511
|
-
* @version
|
|
36566
|
+
* @version 181.0.0
|
|
36512
36567
|
*/
|
|
36513
36568
|
|
|
36514
36569
|
/**
|
|
@@ -36744,7 +36799,7 @@ class MessagingApi {
|
|
|
36744
36799
|
/**
|
|
36745
36800
|
* Messaging service.
|
|
36746
36801
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
36747
|
-
* @version
|
|
36802
|
+
* @version 181.0.0
|
|
36748
36803
|
*/
|
|
36749
36804
|
|
|
36750
36805
|
/**
|
|
@@ -37103,7 +37158,7 @@ class MobileDevicesApi {
|
|
|
37103
37158
|
/**
|
|
37104
37159
|
* MobileDevices service.
|
|
37105
37160
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37106
|
-
* @version
|
|
37161
|
+
* @version 181.0.0
|
|
37107
37162
|
*/
|
|
37108
37163
|
|
|
37109
37164
|
/**
|
|
@@ -37254,7 +37309,7 @@ class NotificationsApi {
|
|
|
37254
37309
|
/**
|
|
37255
37310
|
* Notifications service.
|
|
37256
37311
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
37257
|
-
* @version
|
|
37312
|
+
* @version 181.0.0
|
|
37258
37313
|
*/
|
|
37259
37314
|
|
|
37260
37315
|
/**
|
|
@@ -37487,7 +37542,7 @@ class OAuthApi {
|
|
|
37487
37542
|
/**
|
|
37488
37543
|
* OAuth service.
|
|
37489
37544
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37490
|
-
* @version
|
|
37545
|
+
* @version 181.0.0
|
|
37491
37546
|
*/
|
|
37492
37547
|
|
|
37493
37548
|
/**
|
|
@@ -37853,7 +37908,7 @@ class ObjectsApi {
|
|
|
37853
37908
|
/**
|
|
37854
37909
|
* Objects service.
|
|
37855
37910
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
37856
|
-
* @version
|
|
37911
|
+
* @version 181.0.0
|
|
37857
37912
|
*/
|
|
37858
37913
|
|
|
37859
37914
|
/**
|
|
@@ -38120,11 +38175,77 @@ class ObjectsApi {
|
|
|
38120
38175
|
|
|
38121
38176
|
}
|
|
38122
38177
|
|
|
38178
|
+
class OperationalEventsApi {
|
|
38179
|
+
/**
|
|
38180
|
+
* OperationalEvents service.
|
|
38181
|
+
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38182
|
+
* @version 181.0.0
|
|
38183
|
+
*/
|
|
38184
|
+
|
|
38185
|
+
/**
|
|
38186
|
+
* Constructs a new OperationalEventsApi.
|
|
38187
|
+
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38188
|
+
* @class
|
|
38189
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
38190
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
38191
|
+
*/
|
|
38192
|
+
constructor(apiClient) {
|
|
38193
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
38194
|
+
}
|
|
38195
|
+
|
|
38196
|
+
|
|
38197
|
+
/**
|
|
38198
|
+
* Get an operational event definition by its id
|
|
38199
|
+
*
|
|
38200
|
+
* @param {String} eventDefinitionId EventDefinition id
|
|
38201
|
+
*/
|
|
38202
|
+
getUsageEventsDefinition(eventDefinitionId) {
|
|
38203
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
38204
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null) {
|
|
38205
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling getUsageEventsDefinition';
|
|
38206
|
+
}
|
|
38207
|
+
|
|
38208
|
+
return this.apiClient.callApi(
|
|
38209
|
+
'/api/v2/usage/events/definitions/{eventDefinitionId}',
|
|
38210
|
+
'GET',
|
|
38211
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
38212
|
+
{ },
|
|
38213
|
+
{ },
|
|
38214
|
+
{ },
|
|
38215
|
+
null,
|
|
38216
|
+
['PureCloud OAuth'],
|
|
38217
|
+
['application/json'],
|
|
38218
|
+
['application/json']
|
|
38219
|
+
);
|
|
38220
|
+
}
|
|
38221
|
+
|
|
38222
|
+
/**
|
|
38223
|
+
* Get all operational event definitions
|
|
38224
|
+
*
|
|
38225
|
+
*/
|
|
38226
|
+
getUsageEventsDefinitions() {
|
|
38227
|
+
|
|
38228
|
+
return this.apiClient.callApi(
|
|
38229
|
+
'/api/v2/usage/events/definitions',
|
|
38230
|
+
'GET',
|
|
38231
|
+
{ },
|
|
38232
|
+
{ },
|
|
38233
|
+
{ },
|
|
38234
|
+
{ },
|
|
38235
|
+
null,
|
|
38236
|
+
['PureCloud OAuth'],
|
|
38237
|
+
['application/json'],
|
|
38238
|
+
['application/json']
|
|
38239
|
+
);
|
|
38240
|
+
}
|
|
38241
|
+
|
|
38242
|
+
}
|
|
38243
|
+
|
|
38123
38244
|
class OrganizationApi {
|
|
38124
38245
|
/**
|
|
38125
38246
|
* Organization service.
|
|
38126
38247
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38127
|
-
* @version
|
|
38248
|
+
* @version 181.0.0
|
|
38128
38249
|
*/
|
|
38129
38250
|
|
|
38130
38251
|
/**
|
|
@@ -38579,7 +38700,7 @@ class OrganizationAuthorizationApi {
|
|
|
38579
38700
|
/**
|
|
38580
38701
|
* OrganizationAuthorization service.
|
|
38581
38702
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38582
|
-
* @version
|
|
38703
|
+
* @version 181.0.0
|
|
38583
38704
|
*/
|
|
38584
38705
|
|
|
38585
38706
|
/**
|
|
@@ -39926,7 +40047,7 @@ class OutboundApi {
|
|
|
39926
40047
|
/**
|
|
39927
40048
|
* Outbound service.
|
|
39928
40049
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
39929
|
-
* @version
|
|
40050
|
+
* @version 181.0.0
|
|
39930
40051
|
*/
|
|
39931
40052
|
|
|
39932
40053
|
/**
|
|
@@ -43548,7 +43669,7 @@ class PresenceApi {
|
|
|
43548
43669
|
/**
|
|
43549
43670
|
* Presence service.
|
|
43550
43671
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
43551
|
-
* @version
|
|
43672
|
+
* @version 181.0.0
|
|
43552
43673
|
*/
|
|
43553
43674
|
|
|
43554
43675
|
/**
|
|
@@ -43643,9 +43764,13 @@ class PresenceApi {
|
|
|
43643
43764
|
* Get a Presence Definition
|
|
43644
43765
|
*
|
|
43645
43766
|
* @param {String} definitionId Presence Definition ID
|
|
43767
|
+
* @param {Object} opts Optional parameters
|
|
43768
|
+
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
43646
43769
|
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
43647
43770
|
*/
|
|
43648
|
-
getPresenceDefinition0(definitionId) {
|
|
43771
|
+
getPresenceDefinition0(definitionId, opts) {
|
|
43772
|
+
opts = opts || {};
|
|
43773
|
+
|
|
43649
43774
|
// verify the required parameter 'definitionId' is set
|
|
43650
43775
|
if (definitionId === undefined || definitionId === null) {
|
|
43651
43776
|
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
@@ -43655,7 +43780,7 @@ class PresenceApi {
|
|
|
43655
43780
|
'/api/v2/presence/definitions/{definitionId}',
|
|
43656
43781
|
'GET',
|
|
43657
43782
|
{ 'definitionId': definitionId },
|
|
43658
|
-
{
|
|
43783
|
+
{ 'localeCode': opts['localeCode'] },
|
|
43659
43784
|
{ },
|
|
43660
43785
|
{ },
|
|
43661
43786
|
null,
|
|
@@ -43671,6 +43796,7 @@ class PresenceApi {
|
|
|
43671
43796
|
* @param {Object} opts Optional parameters
|
|
43672
43797
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
43673
43798
|
* @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.
|
|
43799
|
+
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
43674
43800
|
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
43675
43801
|
*/
|
|
43676
43802
|
getPresenceDefinitions0(opts) {
|
|
@@ -43681,7 +43807,7 @@ class PresenceApi {
|
|
|
43681
43807
|
'/api/v2/presence/definitions',
|
|
43682
43808
|
'GET',
|
|
43683
43809
|
{ },
|
|
43684
|
-
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
43810
|
+
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'localeCode': opts['localeCode'] },
|
|
43685
43811
|
{ },
|
|
43686
43812
|
{ },
|
|
43687
43813
|
null,
|
|
@@ -44287,7 +44413,7 @@ class ProcessAutomationApi {
|
|
|
44287
44413
|
/**
|
|
44288
44414
|
* ProcessAutomation service.
|
|
44289
44415
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
44290
|
-
* @version
|
|
44416
|
+
* @version 181.0.0
|
|
44291
44417
|
*/
|
|
44292
44418
|
|
|
44293
44419
|
/**
|
|
@@ -44526,7 +44652,7 @@ class QualityApi {
|
|
|
44526
44652
|
/**
|
|
44527
44653
|
* Quality service.
|
|
44528
44654
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
44529
|
-
* @version
|
|
44655
|
+
* @version 181.0.0
|
|
44530
44656
|
*/
|
|
44531
44657
|
|
|
44532
44658
|
/**
|
|
@@ -45235,7 +45361,7 @@ class QualityApi {
|
|
|
45235
45361
|
|
|
45236
45362
|
/**
|
|
45237
45363
|
* Get the list of evaluation forms
|
|
45238
|
-
*
|
|
45364
|
+
* By default, "published" field is always returned as false for all evaluation forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding evaluation form. In addition, "questionGroups", the detailed information about evaluation form, is not returned by default. We will enhance this field in the future release.
|
|
45239
45365
|
* @param {Object} opts Optional parameters
|
|
45240
45366
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
45241
45367
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -46280,7 +46406,7 @@ class RecordingApi {
|
|
|
46280
46406
|
/**
|
|
46281
46407
|
* Recording service.
|
|
46282
46408
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
46283
|
-
* @version
|
|
46409
|
+
* @version 181.0.0
|
|
46284
46410
|
*/
|
|
46285
46411
|
|
|
46286
46412
|
/**
|
|
@@ -47917,7 +48043,7 @@ class ResponseManagementApi {
|
|
|
47917
48043
|
/**
|
|
47918
48044
|
* ResponseManagement service.
|
|
47919
48045
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
47920
|
-
* @version
|
|
48046
|
+
* @version 181.0.0
|
|
47921
48047
|
*/
|
|
47922
48048
|
|
|
47923
48049
|
/**
|
|
@@ -48402,7 +48528,7 @@ class RoutingApi {
|
|
|
48402
48528
|
/**
|
|
48403
48529
|
* Routing service.
|
|
48404
48530
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
48405
|
-
* @version
|
|
48531
|
+
* @version 181.0.0
|
|
48406
48532
|
*/
|
|
48407
48533
|
|
|
48408
48534
|
/**
|
|
@@ -52110,7 +52236,7 @@ class SCIMApi {
|
|
|
52110
52236
|
/**
|
|
52111
52237
|
* SCIM service.
|
|
52112
52238
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
52113
|
-
* @version
|
|
52239
|
+
* @version 181.0.0
|
|
52114
52240
|
*/
|
|
52115
52241
|
|
|
52116
52242
|
/**
|
|
@@ -52987,7 +53113,7 @@ class ScriptsApi {
|
|
|
52987
53113
|
/**
|
|
52988
53114
|
* Scripts service.
|
|
52989
53115
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
52990
|
-
* @version
|
|
53116
|
+
* @version 181.0.0
|
|
52991
53117
|
*/
|
|
52992
53118
|
|
|
52993
53119
|
/**
|
|
@@ -53431,7 +53557,7 @@ class SearchApi {
|
|
|
53431
53557
|
/**
|
|
53432
53558
|
* Search service.
|
|
53433
53559
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
53434
|
-
* @version
|
|
53560
|
+
* @version 181.0.0
|
|
53435
53561
|
*/
|
|
53436
53562
|
|
|
53437
53563
|
/**
|
|
@@ -54120,7 +54246,7 @@ class SettingsApi {
|
|
|
54120
54246
|
/**
|
|
54121
54247
|
* Settings service.
|
|
54122
54248
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
54123
|
-
* @version
|
|
54249
|
+
* @version 181.0.0
|
|
54124
54250
|
*/
|
|
54125
54251
|
|
|
54126
54252
|
/**
|
|
@@ -54185,7 +54311,7 @@ class SpeechTextAnalyticsApi {
|
|
|
54185
54311
|
/**
|
|
54186
54312
|
* SpeechTextAnalytics service.
|
|
54187
54313
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
54188
|
-
* @version
|
|
54314
|
+
* @version 181.0.0
|
|
54189
54315
|
*/
|
|
54190
54316
|
|
|
54191
54317
|
/**
|
|
@@ -55298,7 +55424,7 @@ class StationsApi {
|
|
|
55298
55424
|
/**
|
|
55299
55425
|
* Stations service.
|
|
55300
55426
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
55301
|
-
* @version
|
|
55427
|
+
* @version 181.0.0
|
|
55302
55428
|
*/
|
|
55303
55429
|
|
|
55304
55430
|
/**
|
|
@@ -55400,7 +55526,7 @@ class SuggestApi {
|
|
|
55400
55526
|
/**
|
|
55401
55527
|
* Suggest service.
|
|
55402
55528
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
55403
|
-
* @version
|
|
55529
|
+
* @version 181.0.0
|
|
55404
55530
|
*/
|
|
55405
55531
|
|
|
55406
55532
|
/**
|
|
@@ -55539,7 +55665,7 @@ class TaskManagementApi {
|
|
|
55539
55665
|
/**
|
|
55540
55666
|
* TaskManagement service.
|
|
55541
55667
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
55542
|
-
* @version
|
|
55668
|
+
* @version 181.0.0
|
|
55543
55669
|
*/
|
|
55544
55670
|
|
|
55545
55671
|
/**
|
|
@@ -56820,7 +56946,7 @@ class TeamsApi {
|
|
|
56820
56946
|
/**
|
|
56821
56947
|
* Teams service.
|
|
56822
56948
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
56823
|
-
* @version
|
|
56949
|
+
* @version 181.0.0
|
|
56824
56950
|
*/
|
|
56825
56951
|
|
|
56826
56952
|
/**
|
|
@@ -57122,7 +57248,7 @@ class TelephonyApi {
|
|
|
57122
57248
|
/**
|
|
57123
57249
|
* Telephony service.
|
|
57124
57250
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
57125
|
-
* @version
|
|
57251
|
+
* @version 181.0.0
|
|
57126
57252
|
*/
|
|
57127
57253
|
|
|
57128
57254
|
/**
|
|
@@ -57157,6 +57283,62 @@ class TelephonyApi {
|
|
|
57157
57283
|
);
|
|
57158
57284
|
}
|
|
57159
57285
|
|
|
57286
|
+
/**
|
|
57287
|
+
* Get a SIP message.
|
|
57288
|
+
* Get the raw form of the SIP message
|
|
57289
|
+
* @param {String} conversationId Conversation id
|
|
57290
|
+
* getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57291
|
+
*/
|
|
57292
|
+
getTelephonySipmessagesConversation(conversationId) {
|
|
57293
|
+
// verify the required parameter 'conversationId' is set
|
|
57294
|
+
if (conversationId === undefined || conversationId === null) {
|
|
57295
|
+
throw 'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversation';
|
|
57296
|
+
}
|
|
57297
|
+
|
|
57298
|
+
return this.apiClient.callApi(
|
|
57299
|
+
'/api/v2/telephony/sipmessages/conversations/{conversationId}',
|
|
57300
|
+
'GET',
|
|
57301
|
+
{ 'conversationId': conversationId },
|
|
57302
|
+
{ },
|
|
57303
|
+
{ },
|
|
57304
|
+
{ },
|
|
57305
|
+
null,
|
|
57306
|
+
['PureCloud OAuth'],
|
|
57307
|
+
['application/json'],
|
|
57308
|
+
['application/json']
|
|
57309
|
+
);
|
|
57310
|
+
}
|
|
57311
|
+
|
|
57312
|
+
/**
|
|
57313
|
+
* Get SIP headers.
|
|
57314
|
+
* Get parsed SIP headers. Returns specific headers if key query parameters are added.
|
|
57315
|
+
* @param {String} conversationId Conversation id
|
|
57316
|
+
* @param {Object} opts Optional parameters
|
|
57317
|
+
* @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
|
|
57318
|
+
* getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57319
|
+
*/
|
|
57320
|
+
getTelephonySipmessagesConversationHeaders(conversationId, opts) {
|
|
57321
|
+
opts = opts || {};
|
|
57322
|
+
|
|
57323
|
+
// verify the required parameter 'conversationId' is set
|
|
57324
|
+
if (conversationId === undefined || conversationId === null) {
|
|
57325
|
+
throw 'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversationHeaders';
|
|
57326
|
+
}
|
|
57327
|
+
|
|
57328
|
+
return this.apiClient.callApi(
|
|
57329
|
+
'/api/v2/telephony/sipmessages/conversations/{conversationId}/headers',
|
|
57330
|
+
'GET',
|
|
57331
|
+
{ 'conversationId': conversationId },
|
|
57332
|
+
{ 'keys': this.apiClient.buildCollectionParam(opts['keys'], 'multi') },
|
|
57333
|
+
{ },
|
|
57334
|
+
{ },
|
|
57335
|
+
null,
|
|
57336
|
+
['PureCloud OAuth'],
|
|
57337
|
+
['application/json'],
|
|
57338
|
+
['application/json']
|
|
57339
|
+
);
|
|
57340
|
+
}
|
|
57341
|
+
|
|
57160
57342
|
/**
|
|
57161
57343
|
* Fetch SIP metadata
|
|
57162
57344
|
* Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
|
|
@@ -57250,7 +57432,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
57250
57432
|
/**
|
|
57251
57433
|
* TelephonyProvidersEdge service.
|
|
57252
57434
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
57253
|
-
* @version
|
|
57435
|
+
* @version 181.0.0
|
|
57254
57436
|
*/
|
|
57255
57437
|
|
|
57256
57438
|
/**
|
|
@@ -59174,6 +59356,31 @@ class TelephonyProvidersEdgeApi {
|
|
|
59174
59356
|
);
|
|
59175
59357
|
}
|
|
59176
59358
|
|
|
59359
|
+
/**
|
|
59360
|
+
* Get site connections for a site.
|
|
59361
|
+
*
|
|
59362
|
+
* @param {String} siteId Site ID
|
|
59363
|
+
*/
|
|
59364
|
+
getTelephonyProvidersEdgesSiteSiteconnections(siteId) {
|
|
59365
|
+
// verify the required parameter 'siteId' is set
|
|
59366
|
+
if (siteId === undefined || siteId === null) {
|
|
59367
|
+
throw 'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteSiteconnections';
|
|
59368
|
+
}
|
|
59369
|
+
|
|
59370
|
+
return this.apiClient.callApi(
|
|
59371
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
59372
|
+
'GET',
|
|
59373
|
+
{ 'siteId': siteId },
|
|
59374
|
+
{ },
|
|
59375
|
+
{ },
|
|
59376
|
+
{ },
|
|
59377
|
+
null,
|
|
59378
|
+
['PureCloud OAuth'],
|
|
59379
|
+
['application/json'],
|
|
59380
|
+
['application/json']
|
|
59381
|
+
);
|
|
59382
|
+
}
|
|
59383
|
+
|
|
59177
59384
|
/**
|
|
59178
59385
|
* Get the list of Sites.
|
|
59179
59386
|
*
|
|
@@ -59470,6 +59677,36 @@ class TelephonyProvidersEdgeApi {
|
|
|
59470
59677
|
);
|
|
59471
59678
|
}
|
|
59472
59679
|
|
|
59680
|
+
/**
|
|
59681
|
+
* Disable site connections for a site.
|
|
59682
|
+
*
|
|
59683
|
+
* @param {String} siteId Site ID
|
|
59684
|
+
* @param {Object} body Site
|
|
59685
|
+
*/
|
|
59686
|
+
patchTelephonyProvidersEdgesSiteSiteconnections(siteId, body) {
|
|
59687
|
+
// verify the required parameter 'siteId' is set
|
|
59688
|
+
if (siteId === undefined || siteId === null) {
|
|
59689
|
+
throw 'Missing the required parameter "siteId" when calling patchTelephonyProvidersEdgesSiteSiteconnections';
|
|
59690
|
+
}
|
|
59691
|
+
// verify the required parameter 'body' is set
|
|
59692
|
+
if (body === undefined || body === null) {
|
|
59693
|
+
throw 'Missing the required parameter "body" when calling patchTelephonyProvidersEdgesSiteSiteconnections';
|
|
59694
|
+
}
|
|
59695
|
+
|
|
59696
|
+
return this.apiClient.callApi(
|
|
59697
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
59698
|
+
'PATCH',
|
|
59699
|
+
{ 'siteId': siteId },
|
|
59700
|
+
{ },
|
|
59701
|
+
{ },
|
|
59702
|
+
{ },
|
|
59703
|
+
body,
|
|
59704
|
+
['PureCloud OAuth'],
|
|
59705
|
+
['application/json'],
|
|
59706
|
+
['application/json']
|
|
59707
|
+
);
|
|
59708
|
+
}
|
|
59709
|
+
|
|
59473
59710
|
/**
|
|
59474
59711
|
* Nslookup request command to collect networking-related information from an Edge for a target IP or host.
|
|
59475
59712
|
*
|
|
@@ -60503,6 +60740,36 @@ class TelephonyProvidersEdgeApi {
|
|
|
60503
60740
|
);
|
|
60504
60741
|
}
|
|
60505
60742
|
|
|
60743
|
+
/**
|
|
60744
|
+
* Update site connections for a site.
|
|
60745
|
+
*
|
|
60746
|
+
* @param {String} siteId Site ID
|
|
60747
|
+
* @param {Object} body Site
|
|
60748
|
+
*/
|
|
60749
|
+
putTelephonyProvidersEdgesSiteSiteconnections(siteId, body) {
|
|
60750
|
+
// verify the required parameter 'siteId' is set
|
|
60751
|
+
if (siteId === undefined || siteId === null) {
|
|
60752
|
+
throw 'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteSiteconnections';
|
|
60753
|
+
}
|
|
60754
|
+
// verify the required parameter 'body' is set
|
|
60755
|
+
if (body === undefined || body === null) {
|
|
60756
|
+
throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteSiteconnections';
|
|
60757
|
+
}
|
|
60758
|
+
|
|
60759
|
+
return this.apiClient.callApi(
|
|
60760
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
60761
|
+
'PUT',
|
|
60762
|
+
{ 'siteId': siteId },
|
|
60763
|
+
{ },
|
|
60764
|
+
{ },
|
|
60765
|
+
{ },
|
|
60766
|
+
body,
|
|
60767
|
+
['PureCloud OAuth'],
|
|
60768
|
+
['application/json'],
|
|
60769
|
+
['application/json']
|
|
60770
|
+
);
|
|
60771
|
+
}
|
|
60772
|
+
|
|
60506
60773
|
/**
|
|
60507
60774
|
* Update a Trunk Base Settings object by ID
|
|
60508
60775
|
*
|
|
@@ -60539,7 +60806,7 @@ class TextbotsApi {
|
|
|
60539
60806
|
/**
|
|
60540
60807
|
* Textbots service.
|
|
60541
60808
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
60542
|
-
* @version
|
|
60809
|
+
* @version 181.0.0
|
|
60543
60810
|
*/
|
|
60544
60811
|
|
|
60545
60812
|
/**
|
|
@@ -60667,7 +60934,7 @@ class TokensApi {
|
|
|
60667
60934
|
/**
|
|
60668
60935
|
* Tokens service.
|
|
60669
60936
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
60670
|
-
* @version
|
|
60937
|
+
* @version 181.0.0
|
|
60671
60938
|
*/
|
|
60672
60939
|
|
|
60673
60940
|
/**
|
|
@@ -60823,7 +61090,7 @@ class UploadsApi {
|
|
|
60823
61090
|
/**
|
|
60824
61091
|
* Uploads service.
|
|
60825
61092
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
60826
|
-
* @version
|
|
61093
|
+
* @version 181.0.0
|
|
60827
61094
|
*/
|
|
60828
61095
|
|
|
60829
61096
|
/**
|
|
@@ -60999,7 +61266,7 @@ class UsageApi {
|
|
|
60999
61266
|
/**
|
|
61000
61267
|
* Usage service.
|
|
61001
61268
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
61002
|
-
* @version
|
|
61269
|
+
* @version 181.0.0
|
|
61003
61270
|
*/
|
|
61004
61271
|
|
|
61005
61272
|
/**
|
|
@@ -61209,7 +61476,7 @@ class UserRecordingsApi {
|
|
|
61209
61476
|
/**
|
|
61210
61477
|
* UserRecordings service.
|
|
61211
61478
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
61212
|
-
* @version
|
|
61479
|
+
* @version 181.0.0
|
|
61213
61480
|
*/
|
|
61214
61481
|
|
|
61215
61482
|
/**
|
|
@@ -61394,7 +61661,7 @@ class UsersApi {
|
|
|
61394
61661
|
/**
|
|
61395
61662
|
* Users service.
|
|
61396
61663
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
61397
|
-
* @version
|
|
61664
|
+
* @version 181.0.0
|
|
61398
61665
|
*/
|
|
61399
61666
|
|
|
61400
61667
|
/**
|
|
@@ -61629,6 +61896,36 @@ class UsersApi {
|
|
|
61629
61896
|
);
|
|
61630
61897
|
}
|
|
61631
61898
|
|
|
61899
|
+
/**
|
|
61900
|
+
* Delete a verifier
|
|
61901
|
+
*
|
|
61902
|
+
* @param {String} userId User ID
|
|
61903
|
+
* @param {String} verifierId Verifier ID
|
|
61904
|
+
*/
|
|
61905
|
+
deleteUserVerifier(userId, verifierId) {
|
|
61906
|
+
// verify the required parameter 'userId' is set
|
|
61907
|
+
if (userId === undefined || userId === null) {
|
|
61908
|
+
throw 'Missing the required parameter "userId" when calling deleteUserVerifier';
|
|
61909
|
+
}
|
|
61910
|
+
// verify the required parameter 'verifierId' is set
|
|
61911
|
+
if (verifierId === undefined || verifierId === null) {
|
|
61912
|
+
throw 'Missing the required parameter "verifierId" when calling deleteUserVerifier';
|
|
61913
|
+
}
|
|
61914
|
+
|
|
61915
|
+
return this.apiClient.callApi(
|
|
61916
|
+
'/api/v2/users/{userId}/verifiers/{verifierId}',
|
|
61917
|
+
'DELETE',
|
|
61918
|
+
{ 'userId': userId,'verifierId': verifierId },
|
|
61919
|
+
{ },
|
|
61920
|
+
{ },
|
|
61921
|
+
{ },
|
|
61922
|
+
null,
|
|
61923
|
+
['PureCloud OAuth'],
|
|
61924
|
+
['application/json'],
|
|
61925
|
+
['application/json']
|
|
61926
|
+
);
|
|
61927
|
+
}
|
|
61928
|
+
|
|
61632
61929
|
/**
|
|
61633
61930
|
* Get status for async query for user aggregates
|
|
61634
61931
|
*
|
|
@@ -62525,6 +62822,31 @@ class UsersApi {
|
|
|
62525
62822
|
);
|
|
62526
62823
|
}
|
|
62527
62824
|
|
|
62825
|
+
/**
|
|
62826
|
+
* Get a list of verifiers
|
|
62827
|
+
*
|
|
62828
|
+
* @param {String} userId User ID
|
|
62829
|
+
*/
|
|
62830
|
+
getUserVerifiers(userId) {
|
|
62831
|
+
// verify the required parameter 'userId' is set
|
|
62832
|
+
if (userId === undefined || userId === null) {
|
|
62833
|
+
throw 'Missing the required parameter "userId" when calling getUserVerifiers';
|
|
62834
|
+
}
|
|
62835
|
+
|
|
62836
|
+
return this.apiClient.callApi(
|
|
62837
|
+
'/api/v2/users/{userId}/verifiers',
|
|
62838
|
+
'GET',
|
|
62839
|
+
{ 'userId': userId },
|
|
62840
|
+
{ },
|
|
62841
|
+
{ },
|
|
62842
|
+
{ },
|
|
62843
|
+
null,
|
|
62844
|
+
['PureCloud OAuth'],
|
|
62845
|
+
['application/json'],
|
|
62846
|
+
['application/json']
|
|
62847
|
+
);
|
|
62848
|
+
}
|
|
62849
|
+
|
|
62528
62850
|
/**
|
|
62529
62851
|
* Get the list of available users.
|
|
62530
62852
|
*
|
|
@@ -62970,7 +63292,7 @@ class UsersApi {
|
|
|
62970
63292
|
}
|
|
62971
63293
|
|
|
62972
63294
|
/**
|
|
62973
|
-
* Update bulk acd autoanswer on users
|
|
63295
|
+
* Update bulk acd autoanswer on users. Max 50 users can be updated at a time.
|
|
62974
63296
|
*
|
|
62975
63297
|
* @param {Array.<Object>} body Users
|
|
62976
63298
|
*/
|
|
@@ -63949,13 +64271,48 @@ class UsersApi {
|
|
|
63949
64271
|
);
|
|
63950
64272
|
}
|
|
63951
64273
|
|
|
64274
|
+
/**
|
|
64275
|
+
* Update a verifier
|
|
64276
|
+
*
|
|
64277
|
+
* @param {String} userId User ID
|
|
64278
|
+
* @param {String} verifierId Verifier ID
|
|
64279
|
+
* @param {Object} body Verifier Update
|
|
64280
|
+
*/
|
|
64281
|
+
putUserVerifier(userId, verifierId, body) {
|
|
64282
|
+
// verify the required parameter 'userId' is set
|
|
64283
|
+
if (userId === undefined || userId === null) {
|
|
64284
|
+
throw 'Missing the required parameter "userId" when calling putUserVerifier';
|
|
64285
|
+
}
|
|
64286
|
+
// verify the required parameter 'verifierId' is set
|
|
64287
|
+
if (verifierId === undefined || verifierId === null) {
|
|
64288
|
+
throw 'Missing the required parameter "verifierId" when calling putUserVerifier';
|
|
64289
|
+
}
|
|
64290
|
+
// verify the required parameter 'body' is set
|
|
64291
|
+
if (body === undefined || body === null) {
|
|
64292
|
+
throw 'Missing the required parameter "body" when calling putUserVerifier';
|
|
64293
|
+
}
|
|
64294
|
+
|
|
64295
|
+
return this.apiClient.callApi(
|
|
64296
|
+
'/api/v2/users/{userId}/verifiers/{verifierId}',
|
|
64297
|
+
'PUT',
|
|
64298
|
+
{ 'userId': userId,'verifierId': verifierId },
|
|
64299
|
+
{ },
|
|
64300
|
+
{ },
|
|
64301
|
+
{ },
|
|
64302
|
+
body,
|
|
64303
|
+
['PureCloud OAuth'],
|
|
64304
|
+
['application/json'],
|
|
64305
|
+
['application/json']
|
|
64306
|
+
);
|
|
64307
|
+
}
|
|
64308
|
+
|
|
63952
64309
|
}
|
|
63953
64310
|
|
|
63954
64311
|
class UtilitiesApi {
|
|
63955
64312
|
/**
|
|
63956
64313
|
* Utilities service.
|
|
63957
64314
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
63958
|
-
* @version
|
|
64315
|
+
* @version 181.0.0
|
|
63959
64316
|
*/
|
|
63960
64317
|
|
|
63961
64318
|
/**
|
|
@@ -64066,7 +64423,7 @@ class VoicemailApi {
|
|
|
64066
64423
|
/**
|
|
64067
64424
|
* Voicemail service.
|
|
64068
64425
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
64069
|
-
* @version
|
|
64426
|
+
* @version 181.0.0
|
|
64070
64427
|
*/
|
|
64071
64428
|
|
|
64072
64429
|
/**
|
|
@@ -64733,7 +65090,7 @@ class WebChatApi {
|
|
|
64733
65090
|
/**
|
|
64734
65091
|
* WebChat service.
|
|
64735
65092
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
64736
|
-
* @version
|
|
65093
|
+
* @version 181.0.0
|
|
64737
65094
|
*/
|
|
64738
65095
|
|
|
64739
65096
|
/**
|
|
@@ -65282,7 +65639,7 @@ class WebDeploymentsApi {
|
|
|
65282
65639
|
/**
|
|
65283
65640
|
* WebDeployments service.
|
|
65284
65641
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
65285
|
-
* @version
|
|
65642
|
+
* @version 181.0.0
|
|
65286
65643
|
*/
|
|
65287
65644
|
|
|
65288
65645
|
/**
|
|
@@ -65809,7 +66166,7 @@ class WebMessagingApi {
|
|
|
65809
66166
|
/**
|
|
65810
66167
|
* WebMessaging service.
|
|
65811
66168
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
65812
|
-
* @version
|
|
66169
|
+
* @version 181.0.0
|
|
65813
66170
|
*/
|
|
65814
66171
|
|
|
65815
66172
|
/**
|
|
@@ -65855,7 +66212,7 @@ class WidgetsApi {
|
|
|
65855
66212
|
/**
|
|
65856
66213
|
* Widgets service.
|
|
65857
66214
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
65858
|
-
* @version
|
|
66215
|
+
* @version 181.0.0
|
|
65859
66216
|
*/
|
|
65860
66217
|
|
|
65861
66218
|
/**
|
|
@@ -66001,7 +66358,7 @@ class WorkforceManagementApi {
|
|
|
66001
66358
|
/**
|
|
66002
66359
|
* WorkforceManagement service.
|
|
66003
66360
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
66004
|
-
* @version
|
|
66361
|
+
* @version 181.0.0
|
|
66005
66362
|
*/
|
|
66006
66363
|
|
|
66007
66364
|
/**
|
|
@@ -66684,8 +67041,12 @@ class WorkforceManagementApi {
|
|
|
66684
67041
|
* Get activity codes
|
|
66685
67042
|
*
|
|
66686
67043
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
67044
|
+
* @param {Object} opts Optional parameters
|
|
67045
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
66687
67046
|
*/
|
|
66688
|
-
getWorkforcemanagementBusinessunitActivitycodes(businessUnitId) {
|
|
67047
|
+
getWorkforcemanagementBusinessunitActivitycodes(businessUnitId, opts) {
|
|
67048
|
+
opts = opts || {};
|
|
67049
|
+
|
|
66689
67050
|
// verify the required parameter 'businessUnitId' is set
|
|
66690
67051
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
66691
67052
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';
|
|
@@ -66695,7 +67056,7 @@ class WorkforceManagementApi {
|
|
|
66695
67056
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes',
|
|
66696
67057
|
'GET',
|
|
66697
67058
|
{ 'businessUnitId': businessUnitId },
|
|
66698
|
-
{
|
|
67059
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
66699
67060
|
{ },
|
|
66700
67061
|
{ },
|
|
66701
67062
|
null,
|
|
@@ -68085,6 +68446,7 @@ class WorkforceManagementApi {
|
|
|
68085
68446
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
68086
68447
|
* @param {Object} opts Optional parameters
|
|
68087
68448
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
68449
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
68088
68450
|
*/
|
|
68089
68451
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
68090
68452
|
opts = opts || {};
|
|
@@ -68102,7 +68464,7 @@ class WorkforceManagementApi {
|
|
|
68102
68464
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades',
|
|
68103
68465
|
'GET',
|
|
68104
68466
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
68105
|
-
{ 'evaluateMatches': opts['evaluateMatches'] },
|
|
68467
|
+
{ 'evaluateMatches': opts['evaluateMatches'],'forceDownloadService': opts['forceDownloadService'] },
|
|
68106
68468
|
{ },
|
|
68107
68469
|
{ },
|
|
68108
68470
|
null,
|
|
@@ -70350,6 +70712,7 @@ class WorkforceManagementApi {
|
|
|
70350
70712
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
70351
70713
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
70352
70714
|
* @param {Object} opts Optional parameters
|
|
70715
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
70353
70716
|
* @param {Object} opts.body body
|
|
70354
70717
|
*/
|
|
70355
70718
|
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, opts) {
|
|
@@ -70364,7 +70727,7 @@ class WorkforceManagementApi {
|
|
|
70364
70727
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query',
|
|
70365
70728
|
'POST',
|
|
70366
70729
|
{ 'managementUnitId': managementUnitId },
|
|
70367
|
-
{
|
|
70730
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
70368
70731
|
{ },
|
|
70369
70732
|
{ },
|
|
70370
70733
|
opts['body'],
|
|
@@ -70588,8 +70951,12 @@ class WorkforceManagementApi {
|
|
|
70588
70951
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
70589
70952
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
70590
70953
|
* @param {Object} body body
|
|
70954
|
+
* @param {Object} opts Optional parameters
|
|
70955
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
70591
70956
|
*/
|
|
70592
|
-
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body) {
|
|
70957
|
+
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
|
|
70958
|
+
opts = opts || {};
|
|
70959
|
+
|
|
70593
70960
|
// verify the required parameter 'managementUnitId' is set
|
|
70594
70961
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
70595
70962
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';
|
|
@@ -70607,7 +70974,7 @@ class WorkforceManagementApi {
|
|
|
70607
70974
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search',
|
|
70608
70975
|
'POST',
|
|
70609
70976
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
70610
|
-
{
|
|
70977
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
70611
70978
|
{ },
|
|
70612
70979
|
{ },
|
|
70613
70980
|
body,
|
|
@@ -71165,7 +71532,7 @@ class WorkforceManagementApi {
|
|
|
71165
71532
|
* </pre>
|
|
71166
71533
|
* </p>
|
|
71167
71534
|
* @module purecloud-platform-client-v2/index
|
|
71168
|
-
* @version
|
|
71535
|
+
* @version 181.0.0
|
|
71169
71536
|
*/
|
|
71170
71537
|
class platformClient {
|
|
71171
71538
|
constructor() {
|
|
@@ -71369,6 +71736,11 @@ class platformClient {
|
|
|
71369
71736
|
* @property {module:purecloud-platform-client-v2/api/ObjectsApi}
|
|
71370
71737
|
*/
|
|
71371
71738
|
this.ObjectsApi = ObjectsApi;
|
|
71739
|
+
/**
|
|
71740
|
+
* The OperationalEventsApi service constructor.
|
|
71741
|
+
* @property {module:purecloud-platform-client-v2/api/OperationalEventsApi}
|
|
71742
|
+
*/
|
|
71743
|
+
this.OperationalEventsApi = OperationalEventsApi;
|
|
71372
71744
|
/**
|
|
71373
71745
|
* The OrganizationApi service constructor.
|
|
71374
71746
|
* @property {module:purecloud-platform-client-v2/api/OrganizationApi}
|