purecloud-platform-client-v2 180.0.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 +475 -160
- package/dist/web-amd/purecloud-platform-client-v2.js +475 -160
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +475 -160
- package/dist/web-cjs/purecloud-platform-client-v2.js +683 -195
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +420 -234
- 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 +1 -74
- 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 +1 -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
|
*
|
|
@@ -12553,32 +12506,6 @@ class ChatApi {
|
|
|
12553
12506
|
);
|
|
12554
12507
|
}
|
|
12555
12508
|
|
|
12556
|
-
/**
|
|
12557
|
-
* Update Chat Settings.
|
|
12558
|
-
* This route is deprecated, please use /chats/settings instead
|
|
12559
|
-
* @param {Object} body Chat
|
|
12560
|
-
* @deprecated
|
|
12561
|
-
*/
|
|
12562
|
-
putChatSettings(body) {
|
|
12563
|
-
// verify the required parameter 'body' is set
|
|
12564
|
-
if (body === undefined || body === null) {
|
|
12565
|
-
throw 'Missing the required parameter "body" when calling putChatSettings';
|
|
12566
|
-
}
|
|
12567
|
-
|
|
12568
|
-
return this.apiClient.callApi(
|
|
12569
|
-
'/api/v2/chat/settings',
|
|
12570
|
-
'PUT',
|
|
12571
|
-
{ },
|
|
12572
|
-
{ },
|
|
12573
|
-
{ },
|
|
12574
|
-
{ },
|
|
12575
|
-
body,
|
|
12576
|
-
['PureCloud OAuth'],
|
|
12577
|
-
['application/json'],
|
|
12578
|
-
['application/json']
|
|
12579
|
-
);
|
|
12580
|
-
}
|
|
12581
|
-
|
|
12582
12509
|
/**
|
|
12583
12510
|
* Update Chat Settings.
|
|
12584
12511
|
*
|
|
@@ -12610,7 +12537,7 @@ class CoachingApi {
|
|
|
12610
12537
|
/**
|
|
12611
12538
|
* Coaching service.
|
|
12612
12539
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12613
|
-
* @version
|
|
12540
|
+
* @version 181.0.0
|
|
12614
12541
|
*/
|
|
12615
12542
|
|
|
12616
12543
|
/**
|
|
@@ -13187,7 +13114,7 @@ class ContentManagementApi {
|
|
|
13187
13114
|
/**
|
|
13188
13115
|
* ContentManagement service.
|
|
13189
13116
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13190
|
-
* @version
|
|
13117
|
+
* @version 181.0.0
|
|
13191
13118
|
*/
|
|
13192
13119
|
|
|
13193
13120
|
/**
|
|
@@ -14330,7 +14257,7 @@ class ConversationsApi {
|
|
|
14330
14257
|
/**
|
|
14331
14258
|
* Conversations service.
|
|
14332
14259
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14333
|
-
* @version
|
|
14260
|
+
* @version 181.0.0
|
|
14334
14261
|
*/
|
|
14335
14262
|
|
|
14336
14263
|
/**
|
|
@@ -18375,6 +18302,36 @@ class ConversationsApi {
|
|
|
18375
18302
|
);
|
|
18376
18303
|
}
|
|
18377
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
|
+
|
|
18378
18335
|
/**
|
|
18379
18336
|
* Update or activate a WhatsApp messaging integration
|
|
18380
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.
|
|
@@ -20601,9 +20558,10 @@ class ConversationsApi {
|
|
|
20601
20558
|
}
|
|
20602
20559
|
|
|
20603
20560
|
/**
|
|
20604
|
-
* Create a WhatsApp Integration
|
|
20605
|
-
* 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.
|
|
20606
20563
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
20564
|
+
* @deprecated
|
|
20607
20565
|
*/
|
|
20608
20566
|
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
20609
20567
|
// verify the required parameter 'body' is set
|
|
@@ -20625,6 +20583,31 @@ class ConversationsApi {
|
|
|
20625
20583
|
);
|
|
20626
20584
|
}
|
|
20627
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
|
+
|
|
20628
20611
|
/**
|
|
20629
20612
|
* Create a messaging setting
|
|
20630
20613
|
*
|
|
@@ -21414,7 +21397,7 @@ class DataExtensionsApi {
|
|
|
21414
21397
|
/**
|
|
21415
21398
|
* DataExtensions service.
|
|
21416
21399
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21417
|
-
* @version
|
|
21400
|
+
* @version 181.0.0
|
|
21418
21401
|
*/
|
|
21419
21402
|
|
|
21420
21403
|
/**
|
|
@@ -21500,7 +21483,7 @@ class DownloadsApi {
|
|
|
21500
21483
|
/**
|
|
21501
21484
|
* Downloads service.
|
|
21502
21485
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21503
|
-
* @version
|
|
21486
|
+
* @version 181.0.0
|
|
21504
21487
|
*/
|
|
21505
21488
|
|
|
21506
21489
|
/**
|
|
@@ -21552,7 +21535,7 @@ class EmailsApi {
|
|
|
21552
21535
|
/**
|
|
21553
21536
|
* Emails service.
|
|
21554
21537
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21555
|
-
* @version
|
|
21538
|
+
* @version 181.0.0
|
|
21556
21539
|
*/
|
|
21557
21540
|
|
|
21558
21541
|
/**
|
|
@@ -21617,7 +21600,7 @@ class EventsApi {
|
|
|
21617
21600
|
/**
|
|
21618
21601
|
* Events service.
|
|
21619
21602
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21620
|
-
* @version
|
|
21603
|
+
* @version 181.0.0
|
|
21621
21604
|
*/
|
|
21622
21605
|
|
|
21623
21606
|
/**
|
|
@@ -21713,7 +21696,7 @@ class ExternalContactsApi {
|
|
|
21713
21696
|
/**
|
|
21714
21697
|
* ExternalContacts service.
|
|
21715
21698
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21716
|
-
* @version
|
|
21699
|
+
* @version 181.0.0
|
|
21717
21700
|
*/
|
|
21718
21701
|
|
|
21719
21702
|
/**
|
|
@@ -23671,7 +23654,7 @@ class FaxApi {
|
|
|
23671
23654
|
/**
|
|
23672
23655
|
* Fax service.
|
|
23673
23656
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23674
|
-
* @version
|
|
23657
|
+
* @version 181.0.0
|
|
23675
23658
|
*/
|
|
23676
23659
|
|
|
23677
23660
|
/**
|
|
@@ -23842,7 +23825,7 @@ class FlowsApi {
|
|
|
23842
23825
|
/**
|
|
23843
23826
|
* Flows service.
|
|
23844
23827
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23845
|
-
* @version
|
|
23828
|
+
* @version 181.0.0
|
|
23846
23829
|
*/
|
|
23847
23830
|
|
|
23848
23831
|
/**
|
|
@@ -24026,7 +24009,7 @@ class GamificationApi {
|
|
|
24026
24009
|
/**
|
|
24027
24010
|
* Gamification service.
|
|
24028
24011
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24029
|
-
* @version
|
|
24012
|
+
* @version 181.0.0
|
|
24030
24013
|
*/
|
|
24031
24014
|
|
|
24032
24015
|
/**
|
|
@@ -26112,7 +26095,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26112
26095
|
/**
|
|
26113
26096
|
* GeneralDataProtectionRegulation service.
|
|
26114
26097
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26115
|
-
* @version
|
|
26098
|
+
* @version 181.0.0
|
|
26116
26099
|
*/
|
|
26117
26100
|
|
|
26118
26101
|
/**
|
|
@@ -26242,7 +26225,7 @@ class GeolocationApi {
|
|
|
26242
26225
|
/**
|
|
26243
26226
|
* Geolocation service.
|
|
26244
26227
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26245
|
-
* @version
|
|
26228
|
+
* @version 181.0.0
|
|
26246
26229
|
*/
|
|
26247
26230
|
|
|
26248
26231
|
/**
|
|
@@ -26373,7 +26356,7 @@ class GreetingsApi {
|
|
|
26373
26356
|
/**
|
|
26374
26357
|
* Greetings service.
|
|
26375
26358
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26376
|
-
* @version
|
|
26359
|
+
* @version 181.0.0
|
|
26377
26360
|
*/
|
|
26378
26361
|
|
|
26379
26362
|
/**
|
|
@@ -26828,7 +26811,7 @@ class GroupsApi {
|
|
|
26828
26811
|
/**
|
|
26829
26812
|
* Groups service.
|
|
26830
26813
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26831
|
-
* @version
|
|
26814
|
+
* @version 181.0.0
|
|
26832
26815
|
*/
|
|
26833
26816
|
|
|
26834
26817
|
/**
|
|
@@ -27347,7 +27330,7 @@ class IdentityProviderApi {
|
|
|
27347
27330
|
/**
|
|
27348
27331
|
* IdentityProvider service.
|
|
27349
27332
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27350
|
-
* @version
|
|
27333
|
+
* @version 181.0.0
|
|
27351
27334
|
*/
|
|
27352
27335
|
|
|
27353
27336
|
/**
|
|
@@ -28103,7 +28086,7 @@ class InfrastructureAsCodeApi {
|
|
|
28103
28086
|
/**
|
|
28104
28087
|
* InfrastructureAsCode service.
|
|
28105
28088
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28106
|
-
* @version
|
|
28089
|
+
* @version 181.0.0
|
|
28107
28090
|
*/
|
|
28108
28091
|
|
|
28109
28092
|
/**
|
|
@@ -28270,7 +28253,7 @@ class IntegrationsApi {
|
|
|
28270
28253
|
/**
|
|
28271
28254
|
* Integrations service.
|
|
28272
28255
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28273
|
-
* @version
|
|
28256
|
+
* @version 181.0.0
|
|
28274
28257
|
*/
|
|
28275
28258
|
|
|
28276
28259
|
/**
|
|
@@ -30232,7 +30215,7 @@ class JourneyApi {
|
|
|
30232
30215
|
/**
|
|
30233
30216
|
* Journey service.
|
|
30234
30217
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30235
|
-
* @version
|
|
30218
|
+
* @version 181.0.0
|
|
30236
30219
|
*/
|
|
30237
30220
|
|
|
30238
30221
|
/**
|
|
@@ -30674,6 +30657,48 @@ class JourneyApi {
|
|
|
30674
30657
|
);
|
|
30675
30658
|
}
|
|
30676
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
|
+
|
|
30677
30702
|
/**
|
|
30678
30703
|
* Retrieve a single outcome.
|
|
30679
30704
|
*
|
|
@@ -31263,13 +31288,42 @@ class JourneyApi {
|
|
|
31263
31288
|
);
|
|
31264
31289
|
}
|
|
31265
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
|
+
|
|
31266
31321
|
/**
|
|
31267
31322
|
* Send a journey app event, used for tracking customer activity on an application.
|
|
31268
31323
|
*
|
|
31269
31324
|
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
31270
31325
|
* @param {Object} opts Optional parameters
|
|
31271
31326
|
* @param {Object} opts.body
|
|
31272
|
-
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31273
31327
|
*/
|
|
31274
31328
|
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
31275
31329
|
opts = opts || {};
|
|
@@ -31396,7 +31450,7 @@ class KnowledgeApi {
|
|
|
31396
31450
|
/**
|
|
31397
31451
|
* Knowledge service.
|
|
31398
31452
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31399
|
-
* @version
|
|
31453
|
+
* @version 181.0.0
|
|
31400
31454
|
*/
|
|
31401
31455
|
|
|
31402
31456
|
/**
|
|
@@ -34217,7 +34271,7 @@ class LanguageUnderstandingApi {
|
|
|
34217
34271
|
/**
|
|
34218
34272
|
* LanguageUnderstanding service.
|
|
34219
34273
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34220
|
-
* @version
|
|
34274
|
+
* @version 181.0.0
|
|
34221
34275
|
*/
|
|
34222
34276
|
|
|
34223
34277
|
/**
|
|
@@ -35230,7 +35284,7 @@ class LanguagesApi {
|
|
|
35230
35284
|
/**
|
|
35231
35285
|
* Languages service.
|
|
35232
35286
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35233
|
-
* @version
|
|
35287
|
+
* @version 181.0.0
|
|
35234
35288
|
*/
|
|
35235
35289
|
|
|
35236
35290
|
/**
|
|
@@ -35452,7 +35506,7 @@ class LearningApi {
|
|
|
35452
35506
|
/**
|
|
35453
35507
|
* Learning service.
|
|
35454
35508
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35455
|
-
* @version
|
|
35509
|
+
* @version 181.0.0
|
|
35456
35510
|
*/
|
|
35457
35511
|
|
|
35458
35512
|
/**
|
|
@@ -36271,7 +36325,7 @@ class LicenseApi {
|
|
|
36271
36325
|
/**
|
|
36272
36326
|
* License service.
|
|
36273
36327
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36274
|
-
* @version
|
|
36328
|
+
* @version 181.0.0
|
|
36275
36329
|
*/
|
|
36276
36330
|
|
|
36277
36331
|
/**
|
|
@@ -36509,7 +36563,7 @@ class LocationsApi {
|
|
|
36509
36563
|
/**
|
|
36510
36564
|
* Locations service.
|
|
36511
36565
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36512
|
-
* @version
|
|
36566
|
+
* @version 181.0.0
|
|
36513
36567
|
*/
|
|
36514
36568
|
|
|
36515
36569
|
/**
|
|
@@ -36745,7 +36799,7 @@ class MessagingApi {
|
|
|
36745
36799
|
/**
|
|
36746
36800
|
* Messaging service.
|
|
36747
36801
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
36748
|
-
* @version
|
|
36802
|
+
* @version 181.0.0
|
|
36749
36803
|
*/
|
|
36750
36804
|
|
|
36751
36805
|
/**
|
|
@@ -37104,7 +37158,7 @@ class MobileDevicesApi {
|
|
|
37104
37158
|
/**
|
|
37105
37159
|
* MobileDevices service.
|
|
37106
37160
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37107
|
-
* @version
|
|
37161
|
+
* @version 181.0.0
|
|
37108
37162
|
*/
|
|
37109
37163
|
|
|
37110
37164
|
/**
|
|
@@ -37255,7 +37309,7 @@ class NotificationsApi {
|
|
|
37255
37309
|
/**
|
|
37256
37310
|
* Notifications service.
|
|
37257
37311
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
37258
|
-
* @version
|
|
37312
|
+
* @version 181.0.0
|
|
37259
37313
|
*/
|
|
37260
37314
|
|
|
37261
37315
|
/**
|
|
@@ -37488,7 +37542,7 @@ class OAuthApi {
|
|
|
37488
37542
|
/**
|
|
37489
37543
|
* OAuth service.
|
|
37490
37544
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37491
|
-
* @version
|
|
37545
|
+
* @version 181.0.0
|
|
37492
37546
|
*/
|
|
37493
37547
|
|
|
37494
37548
|
/**
|
|
@@ -37854,7 +37908,7 @@ class ObjectsApi {
|
|
|
37854
37908
|
/**
|
|
37855
37909
|
* Objects service.
|
|
37856
37910
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
37857
|
-
* @version
|
|
37911
|
+
* @version 181.0.0
|
|
37858
37912
|
*/
|
|
37859
37913
|
|
|
37860
37914
|
/**
|
|
@@ -38121,11 +38175,77 @@ class ObjectsApi {
|
|
|
38121
38175
|
|
|
38122
38176
|
}
|
|
38123
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
|
+
|
|
38124
38244
|
class OrganizationApi {
|
|
38125
38245
|
/**
|
|
38126
38246
|
* Organization service.
|
|
38127
38247
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38128
|
-
* @version
|
|
38248
|
+
* @version 181.0.0
|
|
38129
38249
|
*/
|
|
38130
38250
|
|
|
38131
38251
|
/**
|
|
@@ -38580,7 +38700,7 @@ class OrganizationAuthorizationApi {
|
|
|
38580
38700
|
/**
|
|
38581
38701
|
* OrganizationAuthorization service.
|
|
38582
38702
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
38583
|
-
* @version
|
|
38703
|
+
* @version 181.0.0
|
|
38584
38704
|
*/
|
|
38585
38705
|
|
|
38586
38706
|
/**
|
|
@@ -39927,7 +40047,7 @@ class OutboundApi {
|
|
|
39927
40047
|
/**
|
|
39928
40048
|
* Outbound service.
|
|
39929
40049
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
39930
|
-
* @version
|
|
40050
|
+
* @version 181.0.0
|
|
39931
40051
|
*/
|
|
39932
40052
|
|
|
39933
40053
|
/**
|
|
@@ -43549,7 +43669,7 @@ class PresenceApi {
|
|
|
43549
43669
|
/**
|
|
43550
43670
|
* Presence service.
|
|
43551
43671
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
43552
|
-
* @version
|
|
43672
|
+
* @version 181.0.0
|
|
43553
43673
|
*/
|
|
43554
43674
|
|
|
43555
43675
|
/**
|
|
@@ -43644,9 +43764,13 @@ class PresenceApi {
|
|
|
43644
43764
|
* Get a Presence Definition
|
|
43645
43765
|
*
|
|
43646
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.
|
|
43647
43769
|
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
43648
43770
|
*/
|
|
43649
|
-
getPresenceDefinition0(definitionId) {
|
|
43771
|
+
getPresenceDefinition0(definitionId, opts) {
|
|
43772
|
+
opts = opts || {};
|
|
43773
|
+
|
|
43650
43774
|
// verify the required parameter 'definitionId' is set
|
|
43651
43775
|
if (definitionId === undefined || definitionId === null) {
|
|
43652
43776
|
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
@@ -43656,7 +43780,7 @@ class PresenceApi {
|
|
|
43656
43780
|
'/api/v2/presence/definitions/{definitionId}',
|
|
43657
43781
|
'GET',
|
|
43658
43782
|
{ 'definitionId': definitionId },
|
|
43659
|
-
{
|
|
43783
|
+
{ 'localeCode': opts['localeCode'] },
|
|
43660
43784
|
{ },
|
|
43661
43785
|
{ },
|
|
43662
43786
|
null,
|
|
@@ -43672,6 +43796,7 @@ class PresenceApi {
|
|
|
43672
43796
|
* @param {Object} opts Optional parameters
|
|
43673
43797
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
43674
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.
|
|
43675
43800
|
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
43676
43801
|
*/
|
|
43677
43802
|
getPresenceDefinitions0(opts) {
|
|
@@ -43682,7 +43807,7 @@ class PresenceApi {
|
|
|
43682
43807
|
'/api/v2/presence/definitions',
|
|
43683
43808
|
'GET',
|
|
43684
43809
|
{ },
|
|
43685
|
-
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
43810
|
+
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'localeCode': opts['localeCode'] },
|
|
43686
43811
|
{ },
|
|
43687
43812
|
{ },
|
|
43688
43813
|
null,
|
|
@@ -44288,7 +44413,7 @@ class ProcessAutomationApi {
|
|
|
44288
44413
|
/**
|
|
44289
44414
|
* ProcessAutomation service.
|
|
44290
44415
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
44291
|
-
* @version
|
|
44416
|
+
* @version 181.0.0
|
|
44292
44417
|
*/
|
|
44293
44418
|
|
|
44294
44419
|
/**
|
|
@@ -44527,7 +44652,7 @@ class QualityApi {
|
|
|
44527
44652
|
/**
|
|
44528
44653
|
* Quality service.
|
|
44529
44654
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
44530
|
-
* @version
|
|
44655
|
+
* @version 181.0.0
|
|
44531
44656
|
*/
|
|
44532
44657
|
|
|
44533
44658
|
/**
|
|
@@ -45236,7 +45361,7 @@ class QualityApi {
|
|
|
45236
45361
|
|
|
45237
45362
|
/**
|
|
45238
45363
|
* Get the list of evaluation forms
|
|
45239
|
-
*
|
|
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.
|
|
45240
45365
|
* @param {Object} opts Optional parameters
|
|
45241
45366
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
45242
45367
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -46281,7 +46406,7 @@ class RecordingApi {
|
|
|
46281
46406
|
/**
|
|
46282
46407
|
* Recording service.
|
|
46283
46408
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
46284
|
-
* @version
|
|
46409
|
+
* @version 181.0.0
|
|
46285
46410
|
*/
|
|
46286
46411
|
|
|
46287
46412
|
/**
|
|
@@ -47918,7 +48043,7 @@ class ResponseManagementApi {
|
|
|
47918
48043
|
/**
|
|
47919
48044
|
* ResponseManagement service.
|
|
47920
48045
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
47921
|
-
* @version
|
|
48046
|
+
* @version 181.0.0
|
|
47922
48047
|
*/
|
|
47923
48048
|
|
|
47924
48049
|
/**
|
|
@@ -48403,7 +48528,7 @@ class RoutingApi {
|
|
|
48403
48528
|
/**
|
|
48404
48529
|
* Routing service.
|
|
48405
48530
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
48406
|
-
* @version
|
|
48531
|
+
* @version 181.0.0
|
|
48407
48532
|
*/
|
|
48408
48533
|
|
|
48409
48534
|
/**
|
|
@@ -52111,7 +52236,7 @@ class SCIMApi {
|
|
|
52111
52236
|
/**
|
|
52112
52237
|
* SCIM service.
|
|
52113
52238
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
52114
|
-
* @version
|
|
52239
|
+
* @version 181.0.0
|
|
52115
52240
|
*/
|
|
52116
52241
|
|
|
52117
52242
|
/**
|
|
@@ -52988,7 +53113,7 @@ class ScriptsApi {
|
|
|
52988
53113
|
/**
|
|
52989
53114
|
* Scripts service.
|
|
52990
53115
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
52991
|
-
* @version
|
|
53116
|
+
* @version 181.0.0
|
|
52992
53117
|
*/
|
|
52993
53118
|
|
|
52994
53119
|
/**
|
|
@@ -53432,7 +53557,7 @@ class SearchApi {
|
|
|
53432
53557
|
/**
|
|
53433
53558
|
* Search service.
|
|
53434
53559
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
53435
|
-
* @version
|
|
53560
|
+
* @version 181.0.0
|
|
53436
53561
|
*/
|
|
53437
53562
|
|
|
53438
53563
|
/**
|
|
@@ -54121,7 +54246,7 @@ class SettingsApi {
|
|
|
54121
54246
|
/**
|
|
54122
54247
|
* Settings service.
|
|
54123
54248
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
54124
|
-
* @version
|
|
54249
|
+
* @version 181.0.0
|
|
54125
54250
|
*/
|
|
54126
54251
|
|
|
54127
54252
|
/**
|
|
@@ -54186,7 +54311,7 @@ class SpeechTextAnalyticsApi {
|
|
|
54186
54311
|
/**
|
|
54187
54312
|
* SpeechTextAnalytics service.
|
|
54188
54313
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
54189
|
-
* @version
|
|
54314
|
+
* @version 181.0.0
|
|
54190
54315
|
*/
|
|
54191
54316
|
|
|
54192
54317
|
/**
|
|
@@ -55299,7 +55424,7 @@ class StationsApi {
|
|
|
55299
55424
|
/**
|
|
55300
55425
|
* Stations service.
|
|
55301
55426
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
55302
|
-
* @version
|
|
55427
|
+
* @version 181.0.0
|
|
55303
55428
|
*/
|
|
55304
55429
|
|
|
55305
55430
|
/**
|
|
@@ -55401,7 +55526,7 @@ class SuggestApi {
|
|
|
55401
55526
|
/**
|
|
55402
55527
|
* Suggest service.
|
|
55403
55528
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
55404
|
-
* @version
|
|
55529
|
+
* @version 181.0.0
|
|
55405
55530
|
*/
|
|
55406
55531
|
|
|
55407
55532
|
/**
|
|
@@ -55540,7 +55665,7 @@ class TaskManagementApi {
|
|
|
55540
55665
|
/**
|
|
55541
55666
|
* TaskManagement service.
|
|
55542
55667
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
55543
|
-
* @version
|
|
55668
|
+
* @version 181.0.0
|
|
55544
55669
|
*/
|
|
55545
55670
|
|
|
55546
55671
|
/**
|
|
@@ -56821,7 +56946,7 @@ class TeamsApi {
|
|
|
56821
56946
|
/**
|
|
56822
56947
|
* Teams service.
|
|
56823
56948
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
56824
|
-
* @version
|
|
56949
|
+
* @version 181.0.0
|
|
56825
56950
|
*/
|
|
56826
56951
|
|
|
56827
56952
|
/**
|
|
@@ -57123,7 +57248,7 @@ class TelephonyApi {
|
|
|
57123
57248
|
/**
|
|
57124
57249
|
* Telephony service.
|
|
57125
57250
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
57126
|
-
* @version
|
|
57251
|
+
* @version 181.0.0
|
|
57127
57252
|
*/
|
|
57128
57253
|
|
|
57129
57254
|
/**
|
|
@@ -57307,7 +57432,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
57307
57432
|
/**
|
|
57308
57433
|
* TelephonyProvidersEdge service.
|
|
57309
57434
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
57310
|
-
* @version
|
|
57435
|
+
* @version 181.0.0
|
|
57311
57436
|
*/
|
|
57312
57437
|
|
|
57313
57438
|
/**
|
|
@@ -59231,6 +59356,31 @@ class TelephonyProvidersEdgeApi {
|
|
|
59231
59356
|
);
|
|
59232
59357
|
}
|
|
59233
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
|
+
|
|
59234
59384
|
/**
|
|
59235
59385
|
* Get the list of Sites.
|
|
59236
59386
|
*
|
|
@@ -59527,6 +59677,36 @@ class TelephonyProvidersEdgeApi {
|
|
|
59527
59677
|
);
|
|
59528
59678
|
}
|
|
59529
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
|
+
|
|
59530
59710
|
/**
|
|
59531
59711
|
* Nslookup request command to collect networking-related information from an Edge for a target IP or host.
|
|
59532
59712
|
*
|
|
@@ -60560,6 +60740,36 @@ class TelephonyProvidersEdgeApi {
|
|
|
60560
60740
|
);
|
|
60561
60741
|
}
|
|
60562
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
|
+
|
|
60563
60773
|
/**
|
|
60564
60774
|
* Update a Trunk Base Settings object by ID
|
|
60565
60775
|
*
|
|
@@ -60596,7 +60806,7 @@ class TextbotsApi {
|
|
|
60596
60806
|
/**
|
|
60597
60807
|
* Textbots service.
|
|
60598
60808
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
60599
|
-
* @version
|
|
60809
|
+
* @version 181.0.0
|
|
60600
60810
|
*/
|
|
60601
60811
|
|
|
60602
60812
|
/**
|
|
@@ -60724,7 +60934,7 @@ class TokensApi {
|
|
|
60724
60934
|
/**
|
|
60725
60935
|
* Tokens service.
|
|
60726
60936
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
60727
|
-
* @version
|
|
60937
|
+
* @version 181.0.0
|
|
60728
60938
|
*/
|
|
60729
60939
|
|
|
60730
60940
|
/**
|
|
@@ -60880,7 +61090,7 @@ class UploadsApi {
|
|
|
60880
61090
|
/**
|
|
60881
61091
|
* Uploads service.
|
|
60882
61092
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
60883
|
-
* @version
|
|
61093
|
+
* @version 181.0.0
|
|
60884
61094
|
*/
|
|
60885
61095
|
|
|
60886
61096
|
/**
|
|
@@ -61056,7 +61266,7 @@ class UsageApi {
|
|
|
61056
61266
|
/**
|
|
61057
61267
|
* Usage service.
|
|
61058
61268
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
61059
|
-
* @version
|
|
61269
|
+
* @version 181.0.0
|
|
61060
61270
|
*/
|
|
61061
61271
|
|
|
61062
61272
|
/**
|
|
@@ -61266,7 +61476,7 @@ class UserRecordingsApi {
|
|
|
61266
61476
|
/**
|
|
61267
61477
|
* UserRecordings service.
|
|
61268
61478
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
61269
|
-
* @version
|
|
61479
|
+
* @version 181.0.0
|
|
61270
61480
|
*/
|
|
61271
61481
|
|
|
61272
61482
|
/**
|
|
@@ -61451,7 +61661,7 @@ class UsersApi {
|
|
|
61451
61661
|
/**
|
|
61452
61662
|
* Users service.
|
|
61453
61663
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
61454
|
-
* @version
|
|
61664
|
+
* @version 181.0.0
|
|
61455
61665
|
*/
|
|
61456
61666
|
|
|
61457
61667
|
/**
|
|
@@ -61686,6 +61896,36 @@ class UsersApi {
|
|
|
61686
61896
|
);
|
|
61687
61897
|
}
|
|
61688
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
|
+
|
|
61689
61929
|
/**
|
|
61690
61930
|
* Get status for async query for user aggregates
|
|
61691
61931
|
*
|
|
@@ -62582,6 +62822,31 @@ class UsersApi {
|
|
|
62582
62822
|
);
|
|
62583
62823
|
}
|
|
62584
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
|
+
|
|
62585
62850
|
/**
|
|
62586
62851
|
* Get the list of available users.
|
|
62587
62852
|
*
|
|
@@ -63027,7 +63292,7 @@ class UsersApi {
|
|
|
63027
63292
|
}
|
|
63028
63293
|
|
|
63029
63294
|
/**
|
|
63030
|
-
* Update bulk acd autoanswer on users
|
|
63295
|
+
* Update bulk acd autoanswer on users. Max 50 users can be updated at a time.
|
|
63031
63296
|
*
|
|
63032
63297
|
* @param {Array.<Object>} body Users
|
|
63033
63298
|
*/
|
|
@@ -64006,13 +64271,48 @@ class UsersApi {
|
|
|
64006
64271
|
);
|
|
64007
64272
|
}
|
|
64008
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
|
+
|
|
64009
64309
|
}
|
|
64010
64310
|
|
|
64011
64311
|
class UtilitiesApi {
|
|
64012
64312
|
/**
|
|
64013
64313
|
* Utilities service.
|
|
64014
64314
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
64015
|
-
* @version
|
|
64315
|
+
* @version 181.0.0
|
|
64016
64316
|
*/
|
|
64017
64317
|
|
|
64018
64318
|
/**
|
|
@@ -64123,7 +64423,7 @@ class VoicemailApi {
|
|
|
64123
64423
|
/**
|
|
64124
64424
|
* Voicemail service.
|
|
64125
64425
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
64126
|
-
* @version
|
|
64426
|
+
* @version 181.0.0
|
|
64127
64427
|
*/
|
|
64128
64428
|
|
|
64129
64429
|
/**
|
|
@@ -64790,7 +65090,7 @@ class WebChatApi {
|
|
|
64790
65090
|
/**
|
|
64791
65091
|
* WebChat service.
|
|
64792
65092
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
64793
|
-
* @version
|
|
65093
|
+
* @version 181.0.0
|
|
64794
65094
|
*/
|
|
64795
65095
|
|
|
64796
65096
|
/**
|
|
@@ -65339,7 +65639,7 @@ class WebDeploymentsApi {
|
|
|
65339
65639
|
/**
|
|
65340
65640
|
* WebDeployments service.
|
|
65341
65641
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
65342
|
-
* @version
|
|
65642
|
+
* @version 181.0.0
|
|
65343
65643
|
*/
|
|
65344
65644
|
|
|
65345
65645
|
/**
|
|
@@ -65866,7 +66166,7 @@ class WebMessagingApi {
|
|
|
65866
66166
|
/**
|
|
65867
66167
|
* WebMessaging service.
|
|
65868
66168
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
65869
|
-
* @version
|
|
66169
|
+
* @version 181.0.0
|
|
65870
66170
|
*/
|
|
65871
66171
|
|
|
65872
66172
|
/**
|
|
@@ -65912,7 +66212,7 @@ class WidgetsApi {
|
|
|
65912
66212
|
/**
|
|
65913
66213
|
* Widgets service.
|
|
65914
66214
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
65915
|
-
* @version
|
|
66215
|
+
* @version 181.0.0
|
|
65916
66216
|
*/
|
|
65917
66217
|
|
|
65918
66218
|
/**
|
|
@@ -66058,7 +66358,7 @@ class WorkforceManagementApi {
|
|
|
66058
66358
|
/**
|
|
66059
66359
|
* WorkforceManagement service.
|
|
66060
66360
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
66061
|
-
* @version
|
|
66361
|
+
* @version 181.0.0
|
|
66062
66362
|
*/
|
|
66063
66363
|
|
|
66064
66364
|
/**
|
|
@@ -66741,8 +67041,12 @@ class WorkforceManagementApi {
|
|
|
66741
67041
|
* Get activity codes
|
|
66742
67042
|
*
|
|
66743
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
|
|
66744
67046
|
*/
|
|
66745
|
-
getWorkforcemanagementBusinessunitActivitycodes(businessUnitId) {
|
|
67047
|
+
getWorkforcemanagementBusinessunitActivitycodes(businessUnitId, opts) {
|
|
67048
|
+
opts = opts || {};
|
|
67049
|
+
|
|
66746
67050
|
// verify the required parameter 'businessUnitId' is set
|
|
66747
67051
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
66748
67052
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';
|
|
@@ -66752,7 +67056,7 @@ class WorkforceManagementApi {
|
|
|
66752
67056
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes',
|
|
66753
67057
|
'GET',
|
|
66754
67058
|
{ 'businessUnitId': businessUnitId },
|
|
66755
|
-
{
|
|
67059
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
66756
67060
|
{ },
|
|
66757
67061
|
{ },
|
|
66758
67062
|
null,
|
|
@@ -68142,6 +68446,7 @@ class WorkforceManagementApi {
|
|
|
68142
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
|
|
68143
68447
|
* @param {Object} opts Optional parameters
|
|
68144
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
|
|
68145
68450
|
*/
|
|
68146
68451
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
68147
68452
|
opts = opts || {};
|
|
@@ -68159,7 +68464,7 @@ class WorkforceManagementApi {
|
|
|
68159
68464
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades',
|
|
68160
68465
|
'GET',
|
|
68161
68466
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
68162
|
-
{ 'evaluateMatches': opts['evaluateMatches'] },
|
|
68467
|
+
{ 'evaluateMatches': opts['evaluateMatches'],'forceDownloadService': opts['forceDownloadService'] },
|
|
68163
68468
|
{ },
|
|
68164
68469
|
{ },
|
|
68165
68470
|
null,
|
|
@@ -70407,6 +70712,7 @@ class WorkforceManagementApi {
|
|
|
70407
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
|
|
70408
70713
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
70409
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
|
|
70410
70716
|
* @param {Object} opts.body body
|
|
70411
70717
|
*/
|
|
70412
70718
|
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, opts) {
|
|
@@ -70421,7 +70727,7 @@ class WorkforceManagementApi {
|
|
|
70421
70727
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query',
|
|
70422
70728
|
'POST',
|
|
70423
70729
|
{ 'managementUnitId': managementUnitId },
|
|
70424
|
-
{
|
|
70730
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
70425
70731
|
{ },
|
|
70426
70732
|
{ },
|
|
70427
70733
|
opts['body'],
|
|
@@ -70645,8 +70951,12 @@ class WorkforceManagementApi {
|
|
|
70645
70951
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
70646
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
|
|
70647
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
|
|
70648
70956
|
*/
|
|
70649
|
-
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body) {
|
|
70957
|
+
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
|
|
70958
|
+
opts = opts || {};
|
|
70959
|
+
|
|
70650
70960
|
// verify the required parameter 'managementUnitId' is set
|
|
70651
70961
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
70652
70962
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';
|
|
@@ -70664,7 +70974,7 @@ class WorkforceManagementApi {
|
|
|
70664
70974
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search',
|
|
70665
70975
|
'POST',
|
|
70666
70976
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
70667
|
-
{
|
|
70977
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
70668
70978
|
{ },
|
|
70669
70979
|
{ },
|
|
70670
70980
|
body,
|
|
@@ -71222,7 +71532,7 @@ class WorkforceManagementApi {
|
|
|
71222
71532
|
* </pre>
|
|
71223
71533
|
* </p>
|
|
71224
71534
|
* @module purecloud-platform-client-v2/index
|
|
71225
|
-
* @version
|
|
71535
|
+
* @version 181.0.0
|
|
71226
71536
|
*/
|
|
71227
71537
|
class platformClient {
|
|
71228
71538
|
constructor() {
|
|
@@ -71426,6 +71736,11 @@ class platformClient {
|
|
|
71426
71736
|
* @property {module:purecloud-platform-client-v2/api/ObjectsApi}
|
|
71427
71737
|
*/
|
|
71428
71738
|
this.ObjectsApi = ObjectsApi;
|
|
71739
|
+
/**
|
|
71740
|
+
* The OperationalEventsApi service constructor.
|
|
71741
|
+
* @property {module:purecloud-platform-client-v2/api/OperationalEventsApi}
|
|
71742
|
+
*/
|
|
71743
|
+
this.OperationalEventsApi = OperationalEventsApi;
|
|
71429
71744
|
/**
|
|
71430
71745
|
* The OrganizationApi service constructor.
|
|
71431
71746
|
* @property {module:purecloud-platform-client-v2/api/OrganizationApi}
|