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
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 181.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1485,7 +1485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1485
1485
|
/**
|
|
1486
1486
|
* Alerting service.
|
|
1487
1487
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1488
|
-
* @version
|
|
1488
|
+
* @version 181.0.0
|
|
1489
1489
|
*/
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
@@ -2135,7 +2135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2135
2135
|
/**
|
|
2136
2136
|
* Analytics service.
|
|
2137
2137
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2138
|
-
* @version
|
|
2138
|
+
* @version 181.0.0
|
|
2139
2139
|
*/
|
|
2140
2140
|
|
|
2141
2141
|
/**
|
|
@@ -4581,7 +4581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4581
4581
|
/**
|
|
4582
4582
|
* Architect service.
|
|
4583
4583
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4584
|
-
* @version
|
|
4584
|
+
* @version 181.0.0
|
|
4585
4585
|
*/
|
|
4586
4586
|
|
|
4587
4587
|
/**
|
|
@@ -8416,7 +8416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8416
8416
|
/**
|
|
8417
8417
|
* Audit service.
|
|
8418
8418
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8419
|
-
* @version
|
|
8419
|
+
* @version 181.0.0
|
|
8420
8420
|
*/
|
|
8421
8421
|
|
|
8422
8422
|
/**
|
|
@@ -8587,7 +8587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8587
8587
|
/**
|
|
8588
8588
|
* Authorization service.
|
|
8589
8589
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8590
|
-
* @version
|
|
8590
|
+
* @version 181.0.0
|
|
8591
8591
|
*/
|
|
8592
8592
|
|
|
8593
8593
|
/**
|
|
@@ -9818,7 +9818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9818
9818
|
/**
|
|
9819
9819
|
* Billing service.
|
|
9820
9820
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9821
|
-
* @version
|
|
9821
|
+
* @version 181.0.0
|
|
9822
9822
|
*/
|
|
9823
9823
|
|
|
9824
9824
|
/**
|
|
@@ -9898,7 +9898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9898
9898
|
/**
|
|
9899
9899
|
* CarrierServices service.
|
|
9900
9900
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9901
|
-
* @version
|
|
9901
|
+
* @version 181.0.0
|
|
9902
9902
|
*/
|
|
9903
9903
|
|
|
9904
9904
|
/**
|
|
@@ -9968,7 +9968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9968
9968
|
/**
|
|
9969
9969
|
* Chat service.
|
|
9970
9970
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9971
|
-
* @version
|
|
9971
|
+
* @version 181.0.0
|
|
9972
9972
|
*/
|
|
9973
9973
|
|
|
9974
9974
|
/**
|
|
@@ -10107,27 +10107,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10107
10107
|
);
|
|
10108
10108
|
}
|
|
10109
10109
|
|
|
10110
|
-
/**
|
|
10111
|
-
* Get Chat Settings.
|
|
10112
|
-
* This route is deprecated, please use /chats/settings instead
|
|
10113
|
-
* @deprecated
|
|
10114
|
-
*/
|
|
10115
|
-
getChatSettings() {
|
|
10116
|
-
|
|
10117
|
-
return this.apiClient.callApi(
|
|
10118
|
-
'/api/v2/chat/settings',
|
|
10119
|
-
'GET',
|
|
10120
|
-
{ },
|
|
10121
|
-
{ },
|
|
10122
|
-
{ },
|
|
10123
|
-
{ },
|
|
10124
|
-
null,
|
|
10125
|
-
['PureCloud OAuth'],
|
|
10126
|
-
['application/json'],
|
|
10127
|
-
['application/json']
|
|
10128
|
-
);
|
|
10129
|
-
}
|
|
10130
|
-
|
|
10131
10110
|
/**
|
|
10132
10111
|
* Get a message
|
|
10133
10112
|
*
|
|
@@ -10376,32 +10355,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10376
10355
|
);
|
|
10377
10356
|
}
|
|
10378
10357
|
|
|
10379
|
-
/**
|
|
10380
|
-
* Patch Chat Settings.
|
|
10381
|
-
* This route is deprecated, please use /chats/settings instead
|
|
10382
|
-
* @param {Object} body Chat
|
|
10383
|
-
* @deprecated
|
|
10384
|
-
*/
|
|
10385
|
-
patchChatSettings(body) {
|
|
10386
|
-
// verify the required parameter 'body' is set
|
|
10387
|
-
if (body === undefined || body === null) {
|
|
10388
|
-
throw 'Missing the required parameter "body" when calling patchChatSettings';
|
|
10389
|
-
}
|
|
10390
|
-
|
|
10391
|
-
return this.apiClient.callApi(
|
|
10392
|
-
'/api/v2/chat/settings',
|
|
10393
|
-
'PATCH',
|
|
10394
|
-
{ },
|
|
10395
|
-
{ },
|
|
10396
|
-
{ },
|
|
10397
|
-
{ },
|
|
10398
|
-
body,
|
|
10399
|
-
['PureCloud OAuth'],
|
|
10400
|
-
['application/json'],
|
|
10401
|
-
['application/json']
|
|
10402
|
-
);
|
|
10403
|
-
}
|
|
10404
|
-
|
|
10405
10358
|
/**
|
|
10406
10359
|
* Set properties for a room
|
|
10407
10360
|
*
|
|
@@ -10680,32 +10633,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10680
10633
|
);
|
|
10681
10634
|
}
|
|
10682
10635
|
|
|
10683
|
-
/**
|
|
10684
|
-
* Update Chat Settings.
|
|
10685
|
-
* This route is deprecated, please use /chats/settings instead
|
|
10686
|
-
* @param {Object} body Chat
|
|
10687
|
-
* @deprecated
|
|
10688
|
-
*/
|
|
10689
|
-
putChatSettings(body) {
|
|
10690
|
-
// verify the required parameter 'body' is set
|
|
10691
|
-
if (body === undefined || body === null) {
|
|
10692
|
-
throw 'Missing the required parameter "body" when calling putChatSettings';
|
|
10693
|
-
}
|
|
10694
|
-
|
|
10695
|
-
return this.apiClient.callApi(
|
|
10696
|
-
'/api/v2/chat/settings',
|
|
10697
|
-
'PUT',
|
|
10698
|
-
{ },
|
|
10699
|
-
{ },
|
|
10700
|
-
{ },
|
|
10701
|
-
{ },
|
|
10702
|
-
body,
|
|
10703
|
-
['PureCloud OAuth'],
|
|
10704
|
-
['application/json'],
|
|
10705
|
-
['application/json']
|
|
10706
|
-
);
|
|
10707
|
-
}
|
|
10708
|
-
|
|
10709
10636
|
/**
|
|
10710
10637
|
* Update Chat Settings.
|
|
10711
10638
|
*
|
|
@@ -10737,7 +10664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10737
10664
|
/**
|
|
10738
10665
|
* Coaching service.
|
|
10739
10666
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10740
|
-
* @version
|
|
10667
|
+
* @version 181.0.0
|
|
10741
10668
|
*/
|
|
10742
10669
|
|
|
10743
10670
|
/**
|
|
@@ -11314,7 +11241,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11314
11241
|
/**
|
|
11315
11242
|
* ContentManagement service.
|
|
11316
11243
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11317
|
-
* @version
|
|
11244
|
+
* @version 181.0.0
|
|
11318
11245
|
*/
|
|
11319
11246
|
|
|
11320
11247
|
/**
|
|
@@ -12457,7 +12384,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12457
12384
|
/**
|
|
12458
12385
|
* Conversations service.
|
|
12459
12386
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12460
|
-
* @version
|
|
12387
|
+
* @version 181.0.0
|
|
12461
12388
|
*/
|
|
12462
12389
|
|
|
12463
12390
|
/**
|
|
@@ -16502,6 +16429,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16502
16429
|
);
|
|
16503
16430
|
}
|
|
16504
16431
|
|
|
16432
|
+
/**
|
|
16433
|
+
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
16434
|
+
* 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
|
|
16435
|
+
* @param {String} integrationId Integration ID
|
|
16436
|
+
* @param {Object} body WhatsAppEmbeddedSignupIntegrationActivationRequest
|
|
16437
|
+
*/
|
|
16438
|
+
patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(integrationId, body) {
|
|
16439
|
+
// verify the required parameter 'integrationId' is set
|
|
16440
|
+
if (integrationId === undefined || integrationId === null) {
|
|
16441
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';
|
|
16442
|
+
}
|
|
16443
|
+
// verify the required parameter 'body' is set
|
|
16444
|
+
if (body === undefined || body === null) {
|
|
16445
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';
|
|
16446
|
+
}
|
|
16447
|
+
|
|
16448
|
+
return this.apiClient.callApi(
|
|
16449
|
+
'/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}',
|
|
16450
|
+
'PATCH',
|
|
16451
|
+
{ 'integrationId': integrationId },
|
|
16452
|
+
{ },
|
|
16453
|
+
{ },
|
|
16454
|
+
{ },
|
|
16455
|
+
body,
|
|
16456
|
+
['PureCloud OAuth'],
|
|
16457
|
+
['application/json'],
|
|
16458
|
+
['application/json']
|
|
16459
|
+
);
|
|
16460
|
+
}
|
|
16461
|
+
|
|
16505
16462
|
/**
|
|
16506
16463
|
* Update or activate a WhatsApp messaging integration
|
|
16507
16464
|
* 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.
|
|
@@ -18728,9 +18685,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18728
18685
|
}
|
|
18729
18686
|
|
|
18730
18687
|
/**
|
|
18731
|
-
* Create a WhatsApp Integration
|
|
18732
|
-
* 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.
|
|
18688
|
+
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
18689
|
+
* [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.
|
|
18733
18690
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
18691
|
+
* @deprecated
|
|
18734
18692
|
*/
|
|
18735
18693
|
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
18736
18694
|
// verify the required parameter 'body' is set
|
|
@@ -18752,6 +18710,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18752
18710
|
);
|
|
18753
18711
|
}
|
|
18754
18712
|
|
|
18713
|
+
/**
|
|
18714
|
+
* Create a WhatsApp Integration using the WhatsApp embedded signup flow
|
|
18715
|
+
* 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.
|
|
18716
|
+
* @param {Object} body WhatsAppEmbeddedSignupIntegrationRequest
|
|
18717
|
+
*/
|
|
18718
|
+
postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(body) {
|
|
18719
|
+
// verify the required parameter 'body' is set
|
|
18720
|
+
if (body === undefined || body === null) {
|
|
18721
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsappEmbeddedsignup';
|
|
18722
|
+
}
|
|
18723
|
+
|
|
18724
|
+
return this.apiClient.callApi(
|
|
18725
|
+
'/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup',
|
|
18726
|
+
'POST',
|
|
18727
|
+
{ },
|
|
18728
|
+
{ },
|
|
18729
|
+
{ },
|
|
18730
|
+
{ },
|
|
18731
|
+
body,
|
|
18732
|
+
['PureCloud OAuth'],
|
|
18733
|
+
['application/json'],
|
|
18734
|
+
['application/json']
|
|
18735
|
+
);
|
|
18736
|
+
}
|
|
18737
|
+
|
|
18755
18738
|
/**
|
|
18756
18739
|
* Create a messaging setting
|
|
18757
18740
|
*
|
|
@@ -19541,7 +19524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19541
19524
|
/**
|
|
19542
19525
|
* DataExtensions service.
|
|
19543
19526
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19544
|
-
* @version
|
|
19527
|
+
* @version 181.0.0
|
|
19545
19528
|
*/
|
|
19546
19529
|
|
|
19547
19530
|
/**
|
|
@@ -19627,7 +19610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19627
19610
|
/**
|
|
19628
19611
|
* Downloads service.
|
|
19629
19612
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
19630
|
-
* @version
|
|
19613
|
+
* @version 181.0.0
|
|
19631
19614
|
*/
|
|
19632
19615
|
|
|
19633
19616
|
/**
|
|
@@ -19679,7 +19662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19679
19662
|
/**
|
|
19680
19663
|
* Emails service.
|
|
19681
19664
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
19682
|
-
* @version
|
|
19665
|
+
* @version 181.0.0
|
|
19683
19666
|
*/
|
|
19684
19667
|
|
|
19685
19668
|
/**
|
|
@@ -19744,7 +19727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19744
19727
|
/**
|
|
19745
19728
|
* Events service.
|
|
19746
19729
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
19747
|
-
* @version
|
|
19730
|
+
* @version 181.0.0
|
|
19748
19731
|
*/
|
|
19749
19732
|
|
|
19750
19733
|
/**
|
|
@@ -19840,7 +19823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19840
19823
|
/**
|
|
19841
19824
|
* ExternalContacts service.
|
|
19842
19825
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19843
|
-
* @version
|
|
19826
|
+
* @version 181.0.0
|
|
19844
19827
|
*/
|
|
19845
19828
|
|
|
19846
19829
|
/**
|
|
@@ -21798,7 +21781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21798
21781
|
/**
|
|
21799
21782
|
* Fax service.
|
|
21800
21783
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21801
|
-
* @version
|
|
21784
|
+
* @version 181.0.0
|
|
21802
21785
|
*/
|
|
21803
21786
|
|
|
21804
21787
|
/**
|
|
@@ -21969,7 +21952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21969
21952
|
/**
|
|
21970
21953
|
* Flows service.
|
|
21971
21954
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
21972
|
-
* @version
|
|
21955
|
+
* @version 181.0.0
|
|
21973
21956
|
*/
|
|
21974
21957
|
|
|
21975
21958
|
/**
|
|
@@ -22153,7 +22136,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22153
22136
|
/**
|
|
22154
22137
|
* Gamification service.
|
|
22155
22138
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22156
|
-
* @version
|
|
22139
|
+
* @version 181.0.0
|
|
22157
22140
|
*/
|
|
22158
22141
|
|
|
22159
22142
|
/**
|
|
@@ -24239,7 +24222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24239
24222
|
/**
|
|
24240
24223
|
* GeneralDataProtectionRegulation service.
|
|
24241
24224
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24242
|
-
* @version
|
|
24225
|
+
* @version 181.0.0
|
|
24243
24226
|
*/
|
|
24244
24227
|
|
|
24245
24228
|
/**
|
|
@@ -24369,7 +24352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24369
24352
|
/**
|
|
24370
24353
|
* Geolocation service.
|
|
24371
24354
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24372
|
-
* @version
|
|
24355
|
+
* @version 181.0.0
|
|
24373
24356
|
*/
|
|
24374
24357
|
|
|
24375
24358
|
/**
|
|
@@ -24500,7 +24483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24500
24483
|
/**
|
|
24501
24484
|
* Greetings service.
|
|
24502
24485
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24503
|
-
* @version
|
|
24486
|
+
* @version 181.0.0
|
|
24504
24487
|
*/
|
|
24505
24488
|
|
|
24506
24489
|
/**
|
|
@@ -24955,7 +24938,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24955
24938
|
/**
|
|
24956
24939
|
* Groups service.
|
|
24957
24940
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
24958
|
-
* @version
|
|
24941
|
+
* @version 181.0.0
|
|
24959
24942
|
*/
|
|
24960
24943
|
|
|
24961
24944
|
/**
|
|
@@ -25474,7 +25457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25474
25457
|
/**
|
|
25475
25458
|
* IdentityProvider service.
|
|
25476
25459
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25477
|
-
* @version
|
|
25460
|
+
* @version 181.0.0
|
|
25478
25461
|
*/
|
|
25479
25462
|
|
|
25480
25463
|
/**
|
|
@@ -26230,7 +26213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26230
26213
|
/**
|
|
26231
26214
|
* InfrastructureAsCode service.
|
|
26232
26215
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26233
|
-
* @version
|
|
26216
|
+
* @version 181.0.0
|
|
26234
26217
|
*/
|
|
26235
26218
|
|
|
26236
26219
|
/**
|
|
@@ -26397,7 +26380,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26397
26380
|
/**
|
|
26398
26381
|
* Integrations service.
|
|
26399
26382
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26400
|
-
* @version
|
|
26383
|
+
* @version 181.0.0
|
|
26401
26384
|
*/
|
|
26402
26385
|
|
|
26403
26386
|
/**
|
|
@@ -28359,7 +28342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28359
28342
|
/**
|
|
28360
28343
|
* Journey service.
|
|
28361
28344
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28362
|
-
* @version
|
|
28345
|
+
* @version 181.0.0
|
|
28363
28346
|
*/
|
|
28364
28347
|
|
|
28365
28348
|
/**
|
|
@@ -28801,6 +28784,48 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28801
28784
|
);
|
|
28802
28785
|
}
|
|
28803
28786
|
|
|
28787
|
+
/**
|
|
28788
|
+
* Send a ping.
|
|
28789
|
+
*
|
|
28790
|
+
* @param {String} deploymentId The ID of the deployment sending the ping.
|
|
28791
|
+
* @param {String} customerCookieId ID of the customer associated with the ping.
|
|
28792
|
+
* @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
28793
|
+
* @param {Object} opts Optional parameters
|
|
28794
|
+
* @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.
|
|
28795
|
+
* @param {String} opts.dt Document Title. A human readable name for the page or screen
|
|
28796
|
+
* @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
|
|
28797
|
+
* @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.
|
|
28798
|
+
*/
|
|
28799
|
+
getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, sessionId, opts) {
|
|
28800
|
+
opts = opts || {};
|
|
28801
|
+
|
|
28802
|
+
// verify the required parameter 'deploymentId' is set
|
|
28803
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
28804
|
+
throw 'Missing the required parameter "deploymentId" when calling getJourneyDeploymentCustomerPing';
|
|
28805
|
+
}
|
|
28806
|
+
// verify the required parameter 'customerCookieId' is set
|
|
28807
|
+
if (customerCookieId === undefined || customerCookieId === null) {
|
|
28808
|
+
throw 'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';
|
|
28809
|
+
}
|
|
28810
|
+
// verify the required parameter 'sessionId' is set
|
|
28811
|
+
if (sessionId === undefined || sessionId === null) {
|
|
28812
|
+
throw 'Missing the required parameter "sessionId" when calling getJourneyDeploymentCustomerPing';
|
|
28813
|
+
}
|
|
28814
|
+
|
|
28815
|
+
return this.apiClient.callApi(
|
|
28816
|
+
'/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping',
|
|
28817
|
+
'GET',
|
|
28818
|
+
{ 'deploymentId': deploymentId,'customerCookieId': customerCookieId },
|
|
28819
|
+
{ 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': sessionId,'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
|
|
28820
|
+
{ },
|
|
28821
|
+
{ },
|
|
28822
|
+
null,
|
|
28823
|
+
['PureCloud OAuth'],
|
|
28824
|
+
['application/json'],
|
|
28825
|
+
['application/json']
|
|
28826
|
+
);
|
|
28827
|
+
}
|
|
28828
|
+
|
|
28804
28829
|
/**
|
|
28805
28830
|
* Retrieve a single outcome.
|
|
28806
28831
|
*
|
|
@@ -29390,13 +29415,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29390
29415
|
);
|
|
29391
29416
|
}
|
|
29392
29417
|
|
|
29418
|
+
/**
|
|
29419
|
+
* Sends an action event, which is used for changing the state of actions that have been offered to the user.
|
|
29420
|
+
*
|
|
29421
|
+
* @param {String} deploymentId The ID of the deployment sending the beacon.
|
|
29422
|
+
* @param {Object} body
|
|
29423
|
+
*/
|
|
29424
|
+
postJourneyDeploymentActionevent(deploymentId, body) {
|
|
29425
|
+
// verify the required parameter 'deploymentId' is set
|
|
29426
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
29427
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentActionevent';
|
|
29428
|
+
}
|
|
29429
|
+
// verify the required parameter 'body' is set
|
|
29430
|
+
if (body === undefined || body === null) {
|
|
29431
|
+
throw 'Missing the required parameter "body" when calling postJourneyDeploymentActionevent';
|
|
29432
|
+
}
|
|
29433
|
+
|
|
29434
|
+
return this.apiClient.callApi(
|
|
29435
|
+
'/api/v2/journey/deployments/{deploymentId}/actionevent',
|
|
29436
|
+
'POST',
|
|
29437
|
+
{ 'deploymentId': deploymentId },
|
|
29438
|
+
{ },
|
|
29439
|
+
{ },
|
|
29440
|
+
{ },
|
|
29441
|
+
body,
|
|
29442
|
+
['PureCloud OAuth'],
|
|
29443
|
+
['application/json'],
|
|
29444
|
+
['application/json']
|
|
29445
|
+
);
|
|
29446
|
+
}
|
|
29447
|
+
|
|
29393
29448
|
/**
|
|
29394
29449
|
* Send a journey app event, used for tracking customer activity on an application.
|
|
29395
29450
|
*
|
|
29396
29451
|
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
29397
29452
|
* @param {Object} opts Optional parameters
|
|
29398
29453
|
* @param {Object} opts.body
|
|
29399
|
-
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29400
29454
|
*/
|
|
29401
29455
|
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
29402
29456
|
opts = opts || {};
|
|
@@ -29523,7 +29577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29523
29577
|
/**
|
|
29524
29578
|
* Knowledge service.
|
|
29525
29579
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29526
|
-
* @version
|
|
29580
|
+
* @version 181.0.0
|
|
29527
29581
|
*/
|
|
29528
29582
|
|
|
29529
29583
|
/**
|
|
@@ -32344,7 +32398,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32344
32398
|
/**
|
|
32345
32399
|
* LanguageUnderstanding service.
|
|
32346
32400
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32347
|
-
* @version
|
|
32401
|
+
* @version 181.0.0
|
|
32348
32402
|
*/
|
|
32349
32403
|
|
|
32350
32404
|
/**
|
|
@@ -33357,7 +33411,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33357
33411
|
/**
|
|
33358
33412
|
* Languages service.
|
|
33359
33413
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33360
|
-
* @version
|
|
33414
|
+
* @version 181.0.0
|
|
33361
33415
|
*/
|
|
33362
33416
|
|
|
33363
33417
|
/**
|
|
@@ -33579,7 +33633,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33579
33633
|
/**
|
|
33580
33634
|
* Learning service.
|
|
33581
33635
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33582
|
-
* @version
|
|
33636
|
+
* @version 181.0.0
|
|
33583
33637
|
*/
|
|
33584
33638
|
|
|
33585
33639
|
/**
|
|
@@ -34398,7 +34452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34398
34452
|
/**
|
|
34399
34453
|
* License service.
|
|
34400
34454
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34401
|
-
* @version
|
|
34455
|
+
* @version 181.0.0
|
|
34402
34456
|
*/
|
|
34403
34457
|
|
|
34404
34458
|
/**
|
|
@@ -34636,7 +34690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34636
34690
|
/**
|
|
34637
34691
|
* Locations service.
|
|
34638
34692
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34639
|
-
* @version
|
|
34693
|
+
* @version 181.0.0
|
|
34640
34694
|
*/
|
|
34641
34695
|
|
|
34642
34696
|
/**
|
|
@@ -34872,7 +34926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34872
34926
|
/**
|
|
34873
34927
|
* Messaging service.
|
|
34874
34928
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34875
|
-
* @version
|
|
34929
|
+
* @version 181.0.0
|
|
34876
34930
|
*/
|
|
34877
34931
|
|
|
34878
34932
|
/**
|
|
@@ -35231,7 +35285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35231
35285
|
/**
|
|
35232
35286
|
* MobileDevices service.
|
|
35233
35287
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35234
|
-
* @version
|
|
35288
|
+
* @version 181.0.0
|
|
35235
35289
|
*/
|
|
35236
35290
|
|
|
35237
35291
|
/**
|
|
@@ -35382,7 +35436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35382
35436
|
/**
|
|
35383
35437
|
* Notifications service.
|
|
35384
35438
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35385
|
-
* @version
|
|
35439
|
+
* @version 181.0.0
|
|
35386
35440
|
*/
|
|
35387
35441
|
|
|
35388
35442
|
/**
|
|
@@ -35615,7 +35669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35615
35669
|
/**
|
|
35616
35670
|
* OAuth service.
|
|
35617
35671
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35618
|
-
* @version
|
|
35672
|
+
* @version 181.0.0
|
|
35619
35673
|
*/
|
|
35620
35674
|
|
|
35621
35675
|
/**
|
|
@@ -35981,7 +36035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35981
36035
|
/**
|
|
35982
36036
|
* Objects service.
|
|
35983
36037
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
35984
|
-
* @version
|
|
36038
|
+
* @version 181.0.0
|
|
35985
36039
|
*/
|
|
35986
36040
|
|
|
35987
36041
|
/**
|
|
@@ -36248,11 +36302,77 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36248
36302
|
|
|
36249
36303
|
}
|
|
36250
36304
|
|
|
36305
|
+
class OperationalEventsApi {
|
|
36306
|
+
/**
|
|
36307
|
+
* OperationalEvents service.
|
|
36308
|
+
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36309
|
+
* @version 181.0.0
|
|
36310
|
+
*/
|
|
36311
|
+
|
|
36312
|
+
/**
|
|
36313
|
+
* Constructs a new OperationalEventsApi.
|
|
36314
|
+
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36315
|
+
* @class
|
|
36316
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
36317
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
36318
|
+
*/
|
|
36319
|
+
constructor(apiClient) {
|
|
36320
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
36321
|
+
}
|
|
36322
|
+
|
|
36323
|
+
|
|
36324
|
+
/**
|
|
36325
|
+
* Get an operational event definition by its id
|
|
36326
|
+
*
|
|
36327
|
+
* @param {String} eventDefinitionId EventDefinition id
|
|
36328
|
+
*/
|
|
36329
|
+
getUsageEventsDefinition(eventDefinitionId) {
|
|
36330
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
36331
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null) {
|
|
36332
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling getUsageEventsDefinition';
|
|
36333
|
+
}
|
|
36334
|
+
|
|
36335
|
+
return this.apiClient.callApi(
|
|
36336
|
+
'/api/v2/usage/events/definitions/{eventDefinitionId}',
|
|
36337
|
+
'GET',
|
|
36338
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
36339
|
+
{ },
|
|
36340
|
+
{ },
|
|
36341
|
+
{ },
|
|
36342
|
+
null,
|
|
36343
|
+
['PureCloud OAuth'],
|
|
36344
|
+
['application/json'],
|
|
36345
|
+
['application/json']
|
|
36346
|
+
);
|
|
36347
|
+
}
|
|
36348
|
+
|
|
36349
|
+
/**
|
|
36350
|
+
* Get all operational event definitions
|
|
36351
|
+
*
|
|
36352
|
+
*/
|
|
36353
|
+
getUsageEventsDefinitions() {
|
|
36354
|
+
|
|
36355
|
+
return this.apiClient.callApi(
|
|
36356
|
+
'/api/v2/usage/events/definitions',
|
|
36357
|
+
'GET',
|
|
36358
|
+
{ },
|
|
36359
|
+
{ },
|
|
36360
|
+
{ },
|
|
36361
|
+
{ },
|
|
36362
|
+
null,
|
|
36363
|
+
['PureCloud OAuth'],
|
|
36364
|
+
['application/json'],
|
|
36365
|
+
['application/json']
|
|
36366
|
+
);
|
|
36367
|
+
}
|
|
36368
|
+
|
|
36369
|
+
}
|
|
36370
|
+
|
|
36251
36371
|
class OrganizationApi {
|
|
36252
36372
|
/**
|
|
36253
36373
|
* Organization service.
|
|
36254
36374
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36255
|
-
* @version
|
|
36375
|
+
* @version 181.0.0
|
|
36256
36376
|
*/
|
|
36257
36377
|
|
|
36258
36378
|
/**
|
|
@@ -36707,7 +36827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36707
36827
|
/**
|
|
36708
36828
|
* OrganizationAuthorization service.
|
|
36709
36829
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36710
|
-
* @version
|
|
36830
|
+
* @version 181.0.0
|
|
36711
36831
|
*/
|
|
36712
36832
|
|
|
36713
36833
|
/**
|
|
@@ -38054,7 +38174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38054
38174
|
/**
|
|
38055
38175
|
* Outbound service.
|
|
38056
38176
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38057
|
-
* @version
|
|
38177
|
+
* @version 181.0.0
|
|
38058
38178
|
*/
|
|
38059
38179
|
|
|
38060
38180
|
/**
|
|
@@ -41676,7 +41796,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41676
41796
|
/**
|
|
41677
41797
|
* Presence service.
|
|
41678
41798
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
41679
|
-
* @version
|
|
41799
|
+
* @version 181.0.0
|
|
41680
41800
|
*/
|
|
41681
41801
|
|
|
41682
41802
|
/**
|
|
@@ -41771,9 +41891,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41771
41891
|
* Get a Presence Definition
|
|
41772
41892
|
*
|
|
41773
41893
|
* @param {String} definitionId Presence Definition ID
|
|
41894
|
+
* @param {Object} opts Optional parameters
|
|
41895
|
+
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
41774
41896
|
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
41775
41897
|
*/
|
|
41776
|
-
getPresenceDefinition0(definitionId) {
|
|
41898
|
+
getPresenceDefinition0(definitionId, opts) {
|
|
41899
|
+
opts = opts || {};
|
|
41900
|
+
|
|
41777
41901
|
// verify the required parameter 'definitionId' is set
|
|
41778
41902
|
if (definitionId === undefined || definitionId === null) {
|
|
41779
41903
|
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
@@ -41783,7 +41907,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41783
41907
|
'/api/v2/presence/definitions/{definitionId}',
|
|
41784
41908
|
'GET',
|
|
41785
41909
|
{ 'definitionId': definitionId },
|
|
41786
|
-
{
|
|
41910
|
+
{ 'localeCode': opts['localeCode'] },
|
|
41787
41911
|
{ },
|
|
41788
41912
|
{ },
|
|
41789
41913
|
null,
|
|
@@ -41799,6 +41923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41799
41923
|
* @param {Object} opts Optional parameters
|
|
41800
41924
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
41801
41925
|
* @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.
|
|
41926
|
+
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
41802
41927
|
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
41803
41928
|
*/
|
|
41804
41929
|
getPresenceDefinitions0(opts) {
|
|
@@ -41809,7 +41934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41809
41934
|
'/api/v2/presence/definitions',
|
|
41810
41935
|
'GET',
|
|
41811
41936
|
{ },
|
|
41812
|
-
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
41937
|
+
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'localeCode': opts['localeCode'] },
|
|
41813
41938
|
{ },
|
|
41814
41939
|
{ },
|
|
41815
41940
|
null,
|
|
@@ -42415,7 +42540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42415
42540
|
/**
|
|
42416
42541
|
* ProcessAutomation service.
|
|
42417
42542
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
42418
|
-
* @version
|
|
42543
|
+
* @version 181.0.0
|
|
42419
42544
|
*/
|
|
42420
42545
|
|
|
42421
42546
|
/**
|
|
@@ -42654,7 +42779,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42654
42779
|
/**
|
|
42655
42780
|
* Quality service.
|
|
42656
42781
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
42657
|
-
* @version
|
|
42782
|
+
* @version 181.0.0
|
|
42658
42783
|
*/
|
|
42659
42784
|
|
|
42660
42785
|
/**
|
|
@@ -43363,7 +43488,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43363
43488
|
|
|
43364
43489
|
/**
|
|
43365
43490
|
* Get the list of evaluation forms
|
|
43366
|
-
*
|
|
43491
|
+
* 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.
|
|
43367
43492
|
* @param {Object} opts Optional parameters
|
|
43368
43493
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
43369
43494
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -44408,7 +44533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44408
44533
|
/**
|
|
44409
44534
|
* Recording service.
|
|
44410
44535
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44411
|
-
* @version
|
|
44536
|
+
* @version 181.0.0
|
|
44412
44537
|
*/
|
|
44413
44538
|
|
|
44414
44539
|
/**
|
|
@@ -46045,7 +46170,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46045
46170
|
/**
|
|
46046
46171
|
* ResponseManagement service.
|
|
46047
46172
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46048
|
-
* @version
|
|
46173
|
+
* @version 181.0.0
|
|
46049
46174
|
*/
|
|
46050
46175
|
|
|
46051
46176
|
/**
|
|
@@ -46530,7 +46655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46530
46655
|
/**
|
|
46531
46656
|
* Routing service.
|
|
46532
46657
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46533
|
-
* @version
|
|
46658
|
+
* @version 181.0.0
|
|
46534
46659
|
*/
|
|
46535
46660
|
|
|
46536
46661
|
/**
|
|
@@ -50238,7 +50363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50238
50363
|
/**
|
|
50239
50364
|
* SCIM service.
|
|
50240
50365
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50241
|
-
* @version
|
|
50366
|
+
* @version 181.0.0
|
|
50242
50367
|
*/
|
|
50243
50368
|
|
|
50244
50369
|
/**
|
|
@@ -51115,7 +51240,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51115
51240
|
/**
|
|
51116
51241
|
* Scripts service.
|
|
51117
51242
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51118
|
-
* @version
|
|
51243
|
+
* @version 181.0.0
|
|
51119
51244
|
*/
|
|
51120
51245
|
|
|
51121
51246
|
/**
|
|
@@ -51559,7 +51684,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51559
51684
|
/**
|
|
51560
51685
|
* Search service.
|
|
51561
51686
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51562
|
-
* @version
|
|
51687
|
+
* @version 181.0.0
|
|
51563
51688
|
*/
|
|
51564
51689
|
|
|
51565
51690
|
/**
|
|
@@ -52248,7 +52373,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52248
52373
|
/**
|
|
52249
52374
|
* Settings service.
|
|
52250
52375
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
52251
|
-
* @version
|
|
52376
|
+
* @version 181.0.0
|
|
52252
52377
|
*/
|
|
52253
52378
|
|
|
52254
52379
|
/**
|
|
@@ -52313,7 +52438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52313
52438
|
/**
|
|
52314
52439
|
* SpeechTextAnalytics service.
|
|
52315
52440
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52316
|
-
* @version
|
|
52441
|
+
* @version 181.0.0
|
|
52317
52442
|
*/
|
|
52318
52443
|
|
|
52319
52444
|
/**
|
|
@@ -53426,7 +53551,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53426
53551
|
/**
|
|
53427
53552
|
* Stations service.
|
|
53428
53553
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
53429
|
-
* @version
|
|
53554
|
+
* @version 181.0.0
|
|
53430
53555
|
*/
|
|
53431
53556
|
|
|
53432
53557
|
/**
|
|
@@ -53528,7 +53653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53528
53653
|
/**
|
|
53529
53654
|
* Suggest service.
|
|
53530
53655
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53531
|
-
* @version
|
|
53656
|
+
* @version 181.0.0
|
|
53532
53657
|
*/
|
|
53533
53658
|
|
|
53534
53659
|
/**
|
|
@@ -53667,7 +53792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53667
53792
|
/**
|
|
53668
53793
|
* TaskManagement service.
|
|
53669
53794
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
53670
|
-
* @version
|
|
53795
|
+
* @version 181.0.0
|
|
53671
53796
|
*/
|
|
53672
53797
|
|
|
53673
53798
|
/**
|
|
@@ -54948,7 +55073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54948
55073
|
/**
|
|
54949
55074
|
* Teams service.
|
|
54950
55075
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
54951
|
-
* @version
|
|
55076
|
+
* @version 181.0.0
|
|
54952
55077
|
*/
|
|
54953
55078
|
|
|
54954
55079
|
/**
|
|
@@ -55250,7 +55375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55250
55375
|
/**
|
|
55251
55376
|
* Telephony service.
|
|
55252
55377
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
55253
|
-
* @version
|
|
55378
|
+
* @version 181.0.0
|
|
55254
55379
|
*/
|
|
55255
55380
|
|
|
55256
55381
|
/**
|
|
@@ -55434,7 +55559,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55434
55559
|
/**
|
|
55435
55560
|
* TelephonyProvidersEdge service.
|
|
55436
55561
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
55437
|
-
* @version
|
|
55562
|
+
* @version 181.0.0
|
|
55438
55563
|
*/
|
|
55439
55564
|
|
|
55440
55565
|
/**
|
|
@@ -57358,6 +57483,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57358
57483
|
);
|
|
57359
57484
|
}
|
|
57360
57485
|
|
|
57486
|
+
/**
|
|
57487
|
+
* Get site connections for a site.
|
|
57488
|
+
*
|
|
57489
|
+
* @param {String} siteId Site ID
|
|
57490
|
+
*/
|
|
57491
|
+
getTelephonyProvidersEdgesSiteSiteconnections(siteId) {
|
|
57492
|
+
// verify the required parameter 'siteId' is set
|
|
57493
|
+
if (siteId === undefined || siteId === null) {
|
|
57494
|
+
throw 'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteSiteconnections';
|
|
57495
|
+
}
|
|
57496
|
+
|
|
57497
|
+
return this.apiClient.callApi(
|
|
57498
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
57499
|
+
'GET',
|
|
57500
|
+
{ 'siteId': siteId },
|
|
57501
|
+
{ },
|
|
57502
|
+
{ },
|
|
57503
|
+
{ },
|
|
57504
|
+
null,
|
|
57505
|
+
['PureCloud OAuth'],
|
|
57506
|
+
['application/json'],
|
|
57507
|
+
['application/json']
|
|
57508
|
+
);
|
|
57509
|
+
}
|
|
57510
|
+
|
|
57361
57511
|
/**
|
|
57362
57512
|
* Get the list of Sites.
|
|
57363
57513
|
*
|
|
@@ -57654,6 +57804,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57654
57804
|
);
|
|
57655
57805
|
}
|
|
57656
57806
|
|
|
57807
|
+
/**
|
|
57808
|
+
* Disable site connections for a site.
|
|
57809
|
+
*
|
|
57810
|
+
* @param {String} siteId Site ID
|
|
57811
|
+
* @param {Object} body Site
|
|
57812
|
+
*/
|
|
57813
|
+
patchTelephonyProvidersEdgesSiteSiteconnections(siteId, body) {
|
|
57814
|
+
// verify the required parameter 'siteId' is set
|
|
57815
|
+
if (siteId === undefined || siteId === null) {
|
|
57816
|
+
throw 'Missing the required parameter "siteId" when calling patchTelephonyProvidersEdgesSiteSiteconnections';
|
|
57817
|
+
}
|
|
57818
|
+
// verify the required parameter 'body' is set
|
|
57819
|
+
if (body === undefined || body === null) {
|
|
57820
|
+
throw 'Missing the required parameter "body" when calling patchTelephonyProvidersEdgesSiteSiteconnections';
|
|
57821
|
+
}
|
|
57822
|
+
|
|
57823
|
+
return this.apiClient.callApi(
|
|
57824
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
57825
|
+
'PATCH',
|
|
57826
|
+
{ 'siteId': siteId },
|
|
57827
|
+
{ },
|
|
57828
|
+
{ },
|
|
57829
|
+
{ },
|
|
57830
|
+
body,
|
|
57831
|
+
['PureCloud OAuth'],
|
|
57832
|
+
['application/json'],
|
|
57833
|
+
['application/json']
|
|
57834
|
+
);
|
|
57835
|
+
}
|
|
57836
|
+
|
|
57657
57837
|
/**
|
|
57658
57838
|
* Nslookup request command to collect networking-related information from an Edge for a target IP or host.
|
|
57659
57839
|
*
|
|
@@ -58687,6 +58867,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58687
58867
|
);
|
|
58688
58868
|
}
|
|
58689
58869
|
|
|
58870
|
+
/**
|
|
58871
|
+
* Update site connections for a site.
|
|
58872
|
+
*
|
|
58873
|
+
* @param {String} siteId Site ID
|
|
58874
|
+
* @param {Object} body Site
|
|
58875
|
+
*/
|
|
58876
|
+
putTelephonyProvidersEdgesSiteSiteconnections(siteId, body) {
|
|
58877
|
+
// verify the required parameter 'siteId' is set
|
|
58878
|
+
if (siteId === undefined || siteId === null) {
|
|
58879
|
+
throw 'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteSiteconnections';
|
|
58880
|
+
}
|
|
58881
|
+
// verify the required parameter 'body' is set
|
|
58882
|
+
if (body === undefined || body === null) {
|
|
58883
|
+
throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteSiteconnections';
|
|
58884
|
+
}
|
|
58885
|
+
|
|
58886
|
+
return this.apiClient.callApi(
|
|
58887
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
58888
|
+
'PUT',
|
|
58889
|
+
{ 'siteId': siteId },
|
|
58890
|
+
{ },
|
|
58891
|
+
{ },
|
|
58892
|
+
{ },
|
|
58893
|
+
body,
|
|
58894
|
+
['PureCloud OAuth'],
|
|
58895
|
+
['application/json'],
|
|
58896
|
+
['application/json']
|
|
58897
|
+
);
|
|
58898
|
+
}
|
|
58899
|
+
|
|
58690
58900
|
/**
|
|
58691
58901
|
* Update a Trunk Base Settings object by ID
|
|
58692
58902
|
*
|
|
@@ -58723,7 +58933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58723
58933
|
/**
|
|
58724
58934
|
* Textbots service.
|
|
58725
58935
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
58726
|
-
* @version
|
|
58936
|
+
* @version 181.0.0
|
|
58727
58937
|
*/
|
|
58728
58938
|
|
|
58729
58939
|
/**
|
|
@@ -58851,7 +59061,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58851
59061
|
/**
|
|
58852
59062
|
* Tokens service.
|
|
58853
59063
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
58854
|
-
* @version
|
|
59064
|
+
* @version 181.0.0
|
|
58855
59065
|
*/
|
|
58856
59066
|
|
|
58857
59067
|
/**
|
|
@@ -59007,7 +59217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59007
59217
|
/**
|
|
59008
59218
|
* Uploads service.
|
|
59009
59219
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
59010
|
-
* @version
|
|
59220
|
+
* @version 181.0.0
|
|
59011
59221
|
*/
|
|
59012
59222
|
|
|
59013
59223
|
/**
|
|
@@ -59183,7 +59393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59183
59393
|
/**
|
|
59184
59394
|
* Usage service.
|
|
59185
59395
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
59186
|
-
* @version
|
|
59396
|
+
* @version 181.0.0
|
|
59187
59397
|
*/
|
|
59188
59398
|
|
|
59189
59399
|
/**
|
|
@@ -59393,7 +59603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59393
59603
|
/**
|
|
59394
59604
|
* UserRecordings service.
|
|
59395
59605
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
59396
|
-
* @version
|
|
59606
|
+
* @version 181.0.0
|
|
59397
59607
|
*/
|
|
59398
59608
|
|
|
59399
59609
|
/**
|
|
@@ -59578,7 +59788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59578
59788
|
/**
|
|
59579
59789
|
* Users service.
|
|
59580
59790
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
59581
|
-
* @version
|
|
59791
|
+
* @version 181.0.0
|
|
59582
59792
|
*/
|
|
59583
59793
|
|
|
59584
59794
|
/**
|
|
@@ -59813,6 +60023,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59813
60023
|
);
|
|
59814
60024
|
}
|
|
59815
60025
|
|
|
60026
|
+
/**
|
|
60027
|
+
* Delete a verifier
|
|
60028
|
+
*
|
|
60029
|
+
* @param {String} userId User ID
|
|
60030
|
+
* @param {String} verifierId Verifier ID
|
|
60031
|
+
*/
|
|
60032
|
+
deleteUserVerifier(userId, verifierId) {
|
|
60033
|
+
// verify the required parameter 'userId' is set
|
|
60034
|
+
if (userId === undefined || userId === null) {
|
|
60035
|
+
throw 'Missing the required parameter "userId" when calling deleteUserVerifier';
|
|
60036
|
+
}
|
|
60037
|
+
// verify the required parameter 'verifierId' is set
|
|
60038
|
+
if (verifierId === undefined || verifierId === null) {
|
|
60039
|
+
throw 'Missing the required parameter "verifierId" when calling deleteUserVerifier';
|
|
60040
|
+
}
|
|
60041
|
+
|
|
60042
|
+
return this.apiClient.callApi(
|
|
60043
|
+
'/api/v2/users/{userId}/verifiers/{verifierId}',
|
|
60044
|
+
'DELETE',
|
|
60045
|
+
{ 'userId': userId,'verifierId': verifierId },
|
|
60046
|
+
{ },
|
|
60047
|
+
{ },
|
|
60048
|
+
{ },
|
|
60049
|
+
null,
|
|
60050
|
+
['PureCloud OAuth'],
|
|
60051
|
+
['application/json'],
|
|
60052
|
+
['application/json']
|
|
60053
|
+
);
|
|
60054
|
+
}
|
|
60055
|
+
|
|
59816
60056
|
/**
|
|
59817
60057
|
* Get status for async query for user aggregates
|
|
59818
60058
|
*
|
|
@@ -60709,6 +60949,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60709
60949
|
);
|
|
60710
60950
|
}
|
|
60711
60951
|
|
|
60952
|
+
/**
|
|
60953
|
+
* Get a list of verifiers
|
|
60954
|
+
*
|
|
60955
|
+
* @param {String} userId User ID
|
|
60956
|
+
*/
|
|
60957
|
+
getUserVerifiers(userId) {
|
|
60958
|
+
// verify the required parameter 'userId' is set
|
|
60959
|
+
if (userId === undefined || userId === null) {
|
|
60960
|
+
throw 'Missing the required parameter "userId" when calling getUserVerifiers';
|
|
60961
|
+
}
|
|
60962
|
+
|
|
60963
|
+
return this.apiClient.callApi(
|
|
60964
|
+
'/api/v2/users/{userId}/verifiers',
|
|
60965
|
+
'GET',
|
|
60966
|
+
{ 'userId': userId },
|
|
60967
|
+
{ },
|
|
60968
|
+
{ },
|
|
60969
|
+
{ },
|
|
60970
|
+
null,
|
|
60971
|
+
['PureCloud OAuth'],
|
|
60972
|
+
['application/json'],
|
|
60973
|
+
['application/json']
|
|
60974
|
+
);
|
|
60975
|
+
}
|
|
60976
|
+
|
|
60712
60977
|
/**
|
|
60713
60978
|
* Get the list of available users.
|
|
60714
60979
|
*
|
|
@@ -61154,7 +61419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61154
61419
|
}
|
|
61155
61420
|
|
|
61156
61421
|
/**
|
|
61157
|
-
* Update bulk acd autoanswer on users
|
|
61422
|
+
* Update bulk acd autoanswer on users. Max 50 users can be updated at a time.
|
|
61158
61423
|
*
|
|
61159
61424
|
* @param {Array.<Object>} body Users
|
|
61160
61425
|
*/
|
|
@@ -62133,13 +62398,48 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62133
62398
|
);
|
|
62134
62399
|
}
|
|
62135
62400
|
|
|
62401
|
+
/**
|
|
62402
|
+
* Update a verifier
|
|
62403
|
+
*
|
|
62404
|
+
* @param {String} userId User ID
|
|
62405
|
+
* @param {String} verifierId Verifier ID
|
|
62406
|
+
* @param {Object} body Verifier Update
|
|
62407
|
+
*/
|
|
62408
|
+
putUserVerifier(userId, verifierId, body) {
|
|
62409
|
+
// verify the required parameter 'userId' is set
|
|
62410
|
+
if (userId === undefined || userId === null) {
|
|
62411
|
+
throw 'Missing the required parameter "userId" when calling putUserVerifier';
|
|
62412
|
+
}
|
|
62413
|
+
// verify the required parameter 'verifierId' is set
|
|
62414
|
+
if (verifierId === undefined || verifierId === null) {
|
|
62415
|
+
throw 'Missing the required parameter "verifierId" when calling putUserVerifier';
|
|
62416
|
+
}
|
|
62417
|
+
// verify the required parameter 'body' is set
|
|
62418
|
+
if (body === undefined || body === null) {
|
|
62419
|
+
throw 'Missing the required parameter "body" when calling putUserVerifier';
|
|
62420
|
+
}
|
|
62421
|
+
|
|
62422
|
+
return this.apiClient.callApi(
|
|
62423
|
+
'/api/v2/users/{userId}/verifiers/{verifierId}',
|
|
62424
|
+
'PUT',
|
|
62425
|
+
{ 'userId': userId,'verifierId': verifierId },
|
|
62426
|
+
{ },
|
|
62427
|
+
{ },
|
|
62428
|
+
{ },
|
|
62429
|
+
body,
|
|
62430
|
+
['PureCloud OAuth'],
|
|
62431
|
+
['application/json'],
|
|
62432
|
+
['application/json']
|
|
62433
|
+
);
|
|
62434
|
+
}
|
|
62435
|
+
|
|
62136
62436
|
}
|
|
62137
62437
|
|
|
62138
62438
|
class UtilitiesApi {
|
|
62139
62439
|
/**
|
|
62140
62440
|
* Utilities service.
|
|
62141
62441
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
62142
|
-
* @version
|
|
62442
|
+
* @version 181.0.0
|
|
62143
62443
|
*/
|
|
62144
62444
|
|
|
62145
62445
|
/**
|
|
@@ -62250,7 +62550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62250
62550
|
/**
|
|
62251
62551
|
* Voicemail service.
|
|
62252
62552
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
62253
|
-
* @version
|
|
62553
|
+
* @version 181.0.0
|
|
62254
62554
|
*/
|
|
62255
62555
|
|
|
62256
62556
|
/**
|
|
@@ -62917,7 +63217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62917
63217
|
/**
|
|
62918
63218
|
* WebChat service.
|
|
62919
63219
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
62920
|
-
* @version
|
|
63220
|
+
* @version 181.0.0
|
|
62921
63221
|
*/
|
|
62922
63222
|
|
|
62923
63223
|
/**
|
|
@@ -63466,7 +63766,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63466
63766
|
/**
|
|
63467
63767
|
* WebDeployments service.
|
|
63468
63768
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
63469
|
-
* @version
|
|
63769
|
+
* @version 181.0.0
|
|
63470
63770
|
*/
|
|
63471
63771
|
|
|
63472
63772
|
/**
|
|
@@ -63993,7 +64293,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63993
64293
|
/**
|
|
63994
64294
|
* WebMessaging service.
|
|
63995
64295
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
63996
|
-
* @version
|
|
64296
|
+
* @version 181.0.0
|
|
63997
64297
|
*/
|
|
63998
64298
|
|
|
63999
64299
|
/**
|
|
@@ -64039,7 +64339,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64039
64339
|
/**
|
|
64040
64340
|
* Widgets service.
|
|
64041
64341
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
64042
|
-
* @version
|
|
64342
|
+
* @version 181.0.0
|
|
64043
64343
|
*/
|
|
64044
64344
|
|
|
64045
64345
|
/**
|
|
@@ -64185,7 +64485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64185
64485
|
/**
|
|
64186
64486
|
* WorkforceManagement service.
|
|
64187
64487
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
64188
|
-
* @version
|
|
64488
|
+
* @version 181.0.0
|
|
64189
64489
|
*/
|
|
64190
64490
|
|
|
64191
64491
|
/**
|
|
@@ -64868,8 +65168,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64868
65168
|
* Get activity codes
|
|
64869
65169
|
*
|
|
64870
65170
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
65171
|
+
* @param {Object} opts Optional parameters
|
|
65172
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
64871
65173
|
*/
|
|
64872
|
-
getWorkforcemanagementBusinessunitActivitycodes(businessUnitId) {
|
|
65174
|
+
getWorkforcemanagementBusinessunitActivitycodes(businessUnitId, opts) {
|
|
65175
|
+
opts = opts || {};
|
|
65176
|
+
|
|
64873
65177
|
// verify the required parameter 'businessUnitId' is set
|
|
64874
65178
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
64875
65179
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';
|
|
@@ -64879,7 +65183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64879
65183
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes',
|
|
64880
65184
|
'GET',
|
|
64881
65185
|
{ 'businessUnitId': businessUnitId },
|
|
64882
|
-
{
|
|
65186
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
64883
65187
|
{ },
|
|
64884
65188
|
{ },
|
|
64885
65189
|
null,
|
|
@@ -66269,6 +66573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66269
66573
|
* @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
|
|
66270
66574
|
* @param {Object} opts Optional parameters
|
|
66271
66575
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
66576
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
66272
66577
|
*/
|
|
66273
66578
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
66274
66579
|
opts = opts || {};
|
|
@@ -66286,7 +66591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66286
66591
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades',
|
|
66287
66592
|
'GET',
|
|
66288
66593
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
66289
|
-
{ 'evaluateMatches': opts['evaluateMatches'] },
|
|
66594
|
+
{ 'evaluateMatches': opts['evaluateMatches'],'forceDownloadService': opts['forceDownloadService'] },
|
|
66290
66595
|
{ },
|
|
66291
66596
|
{ },
|
|
66292
66597
|
null,
|
|
@@ -68534,6 +68839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68534
68839
|
* 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
|
|
68535
68840
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
68536
68841
|
* @param {Object} opts Optional parameters
|
|
68842
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
68537
68843
|
* @param {Object} opts.body body
|
|
68538
68844
|
*/
|
|
68539
68845
|
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, opts) {
|
|
@@ -68548,7 +68854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68548
68854
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query',
|
|
68549
68855
|
'POST',
|
|
68550
68856
|
{ 'managementUnitId': managementUnitId },
|
|
68551
|
-
{
|
|
68857
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
68552
68858
|
{ },
|
|
68553
68859
|
{ },
|
|
68554
68860
|
opts['body'],
|
|
@@ -68772,8 +69078,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68772
69078
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
68773
69079
|
* @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
|
|
68774
69080
|
* @param {Object} body body
|
|
69081
|
+
* @param {Object} opts Optional parameters
|
|
69082
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
68775
69083
|
*/
|
|
68776
|
-
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body) {
|
|
69084
|
+
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
|
|
69085
|
+
opts = opts || {};
|
|
69086
|
+
|
|
68777
69087
|
// verify the required parameter 'managementUnitId' is set
|
|
68778
69088
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
68779
69089
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';
|
|
@@ -68791,7 +69101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68791
69101
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search',
|
|
68792
69102
|
'POST',
|
|
68793
69103
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
68794
|
-
{
|
|
69104
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
68795
69105
|
{ },
|
|
68796
69106
|
{ },
|
|
68797
69107
|
body,
|
|
@@ -69349,7 +69659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69349
69659
|
* </pre>
|
|
69350
69660
|
* </p>
|
|
69351
69661
|
* @module purecloud-platform-client-v2/index
|
|
69352
|
-
* @version
|
|
69662
|
+
* @version 181.0.0
|
|
69353
69663
|
*/
|
|
69354
69664
|
class platformClient {
|
|
69355
69665
|
constructor() {
|
|
@@ -69553,6 +69863,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69553
69863
|
* @property {module:purecloud-platform-client-v2/api/ObjectsApi}
|
|
69554
69864
|
*/
|
|
69555
69865
|
this.ObjectsApi = ObjectsApi;
|
|
69866
|
+
/**
|
|
69867
|
+
* The OperationalEventsApi service constructor.
|
|
69868
|
+
* @property {module:purecloud-platform-client-v2/api/OperationalEventsApi}
|
|
69869
|
+
*/
|
|
69870
|
+
this.OperationalEventsApi = OperationalEventsApi;
|
|
69556
69871
|
/**
|
|
69557
69872
|
* The OrganizationApi service constructor.
|
|
69558
69873
|
* @property {module:purecloud-platform-client-v2/api/OrganizationApi}
|