purecloud-platform-client-v2 158.0.0 → 160.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 +637 -185
- package/dist/web-amd/purecloud-platform-client-v2.js +637 -185
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +637 -185
- package/dist/web-cjs/purecloud-platform-client-v2.js +7146 -481
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +444 -169
- package/package.json +3 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +16 -4
- 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/ChatApi.js +1 -1
- 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 +27 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +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 +107 -0
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +95 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +2 -3
- 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 +55 -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 +13 -5
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +60 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -102
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +38 -3
- 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 +26 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +76 -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/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +32 -1
- 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 +26 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -397,9 +397,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
397
397
|
}
|
|
398
398
|
}
|
|
399
399
|
|
|
400
|
+
const { HttpsProxyAgent } = require('hpagent');
|
|
401
|
+
|
|
400
402
|
/**
|
|
401
403
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
404
|
+
* @version 160.0.0
|
|
403
405
|
*/
|
|
404
406
|
class ApiClient {
|
|
405
407
|
/**
|
|
@@ -668,16 +670,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
668
670
|
reject(new Error('The client credentials grant is not supported in a browser.'));
|
|
669
671
|
return;
|
|
670
672
|
}
|
|
671
|
-
|
|
672
673
|
const headers = {
|
|
673
674
|
'Authorization': `Basic ${authHeader}`
|
|
674
675
|
};
|
|
676
|
+
let httpsAgent;
|
|
677
|
+
if (this.proxy !== undefined){
|
|
678
|
+
httpsAgent = new HttpsProxyAgent({
|
|
679
|
+
proxy : `${this.proxy.protocol}://${this.proxy.host}:${this.proxy.port}`
|
|
680
|
+
});
|
|
681
|
+
}
|
|
675
682
|
axios__default["default"]({
|
|
676
683
|
method: `POST`,
|
|
677
684
|
url: `https://login.${this.config.environment}/oauth/token`,
|
|
678
685
|
headers: headers,
|
|
679
686
|
data: 'grant_type=client_credentials',
|
|
680
|
-
|
|
687
|
+
httpsAgent: httpsAgent
|
|
681
688
|
})
|
|
682
689
|
.then((response) => {
|
|
683
690
|
// Logging
|
|
@@ -1374,10 +1381,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1374
1381
|
sendRequest(this);
|
|
1375
1382
|
function sendRequest(that) {
|
|
1376
1383
|
var url = that.buildUrl(path, pathParams);
|
|
1384
|
+
let httpsAgent;
|
|
1385
|
+
if (that.proxy !== undefined){
|
|
1386
|
+
httpsAgent = new HttpsProxyAgent({
|
|
1387
|
+
proxy : `${that.proxy.protocol}://${that.proxy.host}:${that.proxy.port}`
|
|
1388
|
+
});
|
|
1389
|
+
}
|
|
1377
1390
|
var request = {
|
|
1378
1391
|
method: httpMethod,
|
|
1379
1392
|
url: url,
|
|
1380
|
-
|
|
1393
|
+
httpsAgent: httpsAgent,
|
|
1381
1394
|
timeout: that.timeout,
|
|
1382
1395
|
params: that.serialize(queryParams)
|
|
1383
1396
|
};
|
|
@@ -1478,7 +1491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1478
1491
|
/**
|
|
1479
1492
|
* Alerting service.
|
|
1480
1493
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1481
|
-
* @version
|
|
1494
|
+
* @version 160.0.0
|
|
1482
1495
|
*/
|
|
1483
1496
|
|
|
1484
1497
|
/**
|
|
@@ -1792,7 +1805,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1792
1805
|
/**
|
|
1793
1806
|
* Analytics service.
|
|
1794
1807
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1795
|
-
* @version
|
|
1808
|
+
* @version 160.0.0
|
|
1796
1809
|
*/
|
|
1797
1810
|
|
|
1798
1811
|
/**
|
|
@@ -3046,7 +3059,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3046
3059
|
/**
|
|
3047
3060
|
* Architect service.
|
|
3048
3061
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3049
|
-
* @version
|
|
3062
|
+
* @version 160.0.0
|
|
3050
3063
|
*/
|
|
3051
3064
|
|
|
3052
3065
|
/**
|
|
@@ -6094,7 +6107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6094
6107
|
/**
|
|
6095
6108
|
* Audit service.
|
|
6096
6109
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6097
|
-
* @version
|
|
6110
|
+
* @version 160.0.0
|
|
6098
6111
|
*/
|
|
6099
6112
|
|
|
6100
6113
|
/**
|
|
@@ -6265,7 +6278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6265
6278
|
/**
|
|
6266
6279
|
* Authorization service.
|
|
6267
6280
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6268
|
-
* @version
|
|
6281
|
+
* @version 160.0.0
|
|
6269
6282
|
*/
|
|
6270
6283
|
|
|
6271
6284
|
/**
|
|
@@ -7493,7 +7506,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7493
7506
|
/**
|
|
7494
7507
|
* Billing service.
|
|
7495
7508
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7496
|
-
* @version
|
|
7509
|
+
* @version 160.0.0
|
|
7497
7510
|
*/
|
|
7498
7511
|
|
|
7499
7512
|
/**
|
|
@@ -7573,7 +7586,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7573
7586
|
/**
|
|
7574
7587
|
* Chat service.
|
|
7575
7588
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7576
|
-
* @version
|
|
7589
|
+
* @version 160.0.0
|
|
7577
7590
|
*/
|
|
7578
7591
|
|
|
7579
7592
|
/**
|
|
@@ -7664,7 +7677,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7664
7677
|
/**
|
|
7665
7678
|
* Coaching service.
|
|
7666
7679
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7667
|
-
* @version
|
|
7680
|
+
* @version 160.0.0
|
|
7668
7681
|
*/
|
|
7669
7682
|
|
|
7670
7683
|
/**
|
|
@@ -8241,7 +8254,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8241
8254
|
/**
|
|
8242
8255
|
* ContentManagement service.
|
|
8243
8256
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8244
|
-
* @version
|
|
8257
|
+
* @version 160.0.0
|
|
8245
8258
|
*/
|
|
8246
8259
|
|
|
8247
8260
|
/**
|
|
@@ -9381,7 +9394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9381
9394
|
/**
|
|
9382
9395
|
* Conversations service.
|
|
9383
9396
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9384
|
-
* @version
|
|
9397
|
+
* @version 160.0.0
|
|
9385
9398
|
*/
|
|
9386
9399
|
|
|
9387
9400
|
/**
|
|
@@ -12769,7 +12782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12769
12782
|
}
|
|
12770
12783
|
|
|
12771
12784
|
/**
|
|
12772
|
-
* Creates a cobrowse session
|
|
12785
|
+
* Creates a cobrowse session. Requires conversation:cobrowse:add (for web messaging) or conversation:cobrowsevoice:add permission.
|
|
12773
12786
|
*
|
|
12774
12787
|
* @param {String} conversationId Conversation ID
|
|
12775
12788
|
*/
|
|
@@ -14083,6 +14096,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14083
14096
|
);
|
|
14084
14097
|
}
|
|
14085
14098
|
|
|
14099
|
+
/**
|
|
14100
|
+
* Search conversations
|
|
14101
|
+
*
|
|
14102
|
+
* @param {Object} body Search request options
|
|
14103
|
+
*/
|
|
14104
|
+
postConversationsParticipantsAttributesSearch(body) {
|
|
14105
|
+
// verify the required parameter 'body' is set
|
|
14106
|
+
if (body === undefined || body === null) {
|
|
14107
|
+
throw 'Missing the required parameter "body" when calling postConversationsParticipantsAttributesSearch';
|
|
14108
|
+
}
|
|
14109
|
+
|
|
14110
|
+
return this.apiClient.callApi(
|
|
14111
|
+
'/api/v2/conversations/participants/attributes/search',
|
|
14112
|
+
'POST',
|
|
14113
|
+
{ },
|
|
14114
|
+
{ },
|
|
14115
|
+
{ },
|
|
14116
|
+
{ },
|
|
14117
|
+
body,
|
|
14118
|
+
['PureCloud OAuth'],
|
|
14119
|
+
['application/json'],
|
|
14120
|
+
['application/json']
|
|
14121
|
+
);
|
|
14122
|
+
}
|
|
14123
|
+
|
|
14086
14124
|
/**
|
|
14087
14125
|
* Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
14088
14126
|
*
|
|
@@ -14629,7 +14667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14629
14667
|
/**
|
|
14630
14668
|
* DataExtensions service.
|
|
14631
14669
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14632
|
-
* @version
|
|
14670
|
+
* @version 160.0.0
|
|
14633
14671
|
*/
|
|
14634
14672
|
|
|
14635
14673
|
/**
|
|
@@ -14715,7 +14753,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14715
14753
|
/**
|
|
14716
14754
|
* Downloads service.
|
|
14717
14755
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14718
|
-
* @version
|
|
14756
|
+
* @version 160.0.0
|
|
14719
14757
|
*/
|
|
14720
14758
|
|
|
14721
14759
|
/**
|
|
@@ -14767,7 +14805,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14767
14805
|
/**
|
|
14768
14806
|
* Events service.
|
|
14769
14807
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14770
|
-
* @version
|
|
14808
|
+
* @version 160.0.0
|
|
14771
14809
|
*/
|
|
14772
14810
|
|
|
14773
14811
|
/**
|
|
@@ -14863,7 +14901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14863
14901
|
/**
|
|
14864
14902
|
* ExternalContacts service.
|
|
14865
14903
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14866
|
-
* @version
|
|
14904
|
+
* @version 160.0.0
|
|
14867
14905
|
*/
|
|
14868
14906
|
|
|
14869
14907
|
/**
|
|
@@ -16821,7 +16859,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16821
16859
|
/**
|
|
16822
16860
|
* Fax service.
|
|
16823
16861
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16824
|
-
* @version
|
|
16862
|
+
* @version 160.0.0
|
|
16825
16863
|
*/
|
|
16826
16864
|
|
|
16827
16865
|
/**
|
|
@@ -16992,7 +17030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16992
17030
|
/**
|
|
16993
17031
|
* Flows service.
|
|
16994
17032
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16995
|
-
* @version
|
|
17033
|
+
* @version 160.0.0
|
|
16996
17034
|
*/
|
|
16997
17035
|
|
|
16998
17036
|
/**
|
|
@@ -17063,7 +17101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17063
17101
|
/**
|
|
17064
17102
|
* Gamification service.
|
|
17065
17103
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17066
|
-
* @version
|
|
17104
|
+
* @version 160.0.0
|
|
17067
17105
|
*/
|
|
17068
17106
|
|
|
17069
17107
|
/**
|
|
@@ -18680,7 +18718,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18680
18718
|
/**
|
|
18681
18719
|
* GeneralDataProtectionRegulation service.
|
|
18682
18720
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18683
|
-
* @version
|
|
18721
|
+
* @version 160.0.0
|
|
18684
18722
|
*/
|
|
18685
18723
|
|
|
18686
18724
|
/**
|
|
@@ -18810,7 +18848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18810
18848
|
/**
|
|
18811
18849
|
* Geolocation service.
|
|
18812
18850
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18813
|
-
* @version
|
|
18851
|
+
* @version 160.0.0
|
|
18814
18852
|
*/
|
|
18815
18853
|
|
|
18816
18854
|
/**
|
|
@@ -18941,7 +18979,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18941
18979
|
/**
|
|
18942
18980
|
* Greetings service.
|
|
18943
18981
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18944
|
-
* @version
|
|
18982
|
+
* @version 160.0.0
|
|
18945
18983
|
*/
|
|
18946
18984
|
|
|
18947
18985
|
/**
|
|
@@ -19396,7 +19434,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19396
19434
|
/**
|
|
19397
19435
|
* Groups service.
|
|
19398
19436
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19399
|
-
* @version
|
|
19437
|
+
* @version 160.0.0
|
|
19400
19438
|
*/
|
|
19401
19439
|
|
|
19402
19440
|
/**
|
|
@@ -19802,7 +19840,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19802
19840
|
/**
|
|
19803
19841
|
* IdentityProvider service.
|
|
19804
19842
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19805
|
-
* @version
|
|
19843
|
+
* @version 160.0.0
|
|
19806
19844
|
*/
|
|
19807
19845
|
|
|
19808
19846
|
/**
|
|
@@ -20554,11 +20592,113 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20554
20592
|
|
|
20555
20593
|
}
|
|
20556
20594
|
|
|
20595
|
+
class InfrastructureAsCodeApi {
|
|
20596
|
+
/**
|
|
20597
|
+
* InfrastructureAsCode service.
|
|
20598
|
+
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
20599
|
+
* @version 160.0.0
|
|
20600
|
+
*/
|
|
20601
|
+
|
|
20602
|
+
/**
|
|
20603
|
+
* Constructs a new InfrastructureAsCodeApi.
|
|
20604
|
+
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
20605
|
+
* @class
|
|
20606
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
20607
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
20608
|
+
*/
|
|
20609
|
+
constructor(apiClient) {
|
|
20610
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
20611
|
+
}
|
|
20612
|
+
|
|
20613
|
+
|
|
20614
|
+
/**
|
|
20615
|
+
* Get job status and results
|
|
20616
|
+
* Get the execution status of a submitted job, optionally including results and error details.
|
|
20617
|
+
* @param {String} jobId Job ID
|
|
20618
|
+
* @param {Object} opts Optional parameters
|
|
20619
|
+
* @param {Boolean} opts.details Include details of execution, including job results or error information (default to false)
|
|
20620
|
+
*/
|
|
20621
|
+
getInfrastructureascodeJob(jobId, opts) {
|
|
20622
|
+
opts = opts || {};
|
|
20623
|
+
|
|
20624
|
+
// verify the required parameter 'jobId' is set
|
|
20625
|
+
if (jobId === undefined || jobId === null) {
|
|
20626
|
+
throw 'Missing the required parameter "jobId" when calling getInfrastructureascodeJob';
|
|
20627
|
+
}
|
|
20628
|
+
|
|
20629
|
+
return this.apiClient.callApi(
|
|
20630
|
+
'/api/v2/infrastructureascode/jobs/{jobId}',
|
|
20631
|
+
'GET',
|
|
20632
|
+
{ 'jobId': jobId },
|
|
20633
|
+
{ 'details': opts['details'] },
|
|
20634
|
+
{ },
|
|
20635
|
+
{ },
|
|
20636
|
+
null,
|
|
20637
|
+
['PureCloud OAuth'],
|
|
20638
|
+
['application/json'],
|
|
20639
|
+
['application/json']
|
|
20640
|
+
);
|
|
20641
|
+
}
|
|
20642
|
+
|
|
20643
|
+
/**
|
|
20644
|
+
* Get job history
|
|
20645
|
+
* Get a history of submitted jobs, optionally including error messages.
|
|
20646
|
+
* @param {Object} opts Optional parameters
|
|
20647
|
+
* @param {Number} opts.maxResults Number of jobs to show (default to 1)
|
|
20648
|
+
* @param {Boolean} opts.includeErrors Include error messages (default to false)
|
|
20649
|
+
* @param {Object} opts.sortBy Sort by (default to id)
|
|
20650
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
20651
|
+
*/
|
|
20652
|
+
getInfrastructureascodeJobs(opts) {
|
|
20653
|
+
opts = opts || {};
|
|
20654
|
+
|
|
20655
|
+
|
|
20656
|
+
return this.apiClient.callApi(
|
|
20657
|
+
'/api/v2/infrastructureascode/jobs',
|
|
20658
|
+
'GET',
|
|
20659
|
+
{ },
|
|
20660
|
+
{ 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
20661
|
+
{ },
|
|
20662
|
+
{ },
|
|
20663
|
+
null,
|
|
20664
|
+
['PureCloud OAuth'],
|
|
20665
|
+
['application/json'],
|
|
20666
|
+
['application/json']
|
|
20667
|
+
);
|
|
20668
|
+
}
|
|
20669
|
+
|
|
20670
|
+
/**
|
|
20671
|
+
* Create a Job
|
|
20672
|
+
* Create and submit a job for remote execution or see job planning results.
|
|
20673
|
+
* @param {Object} body
|
|
20674
|
+
*/
|
|
20675
|
+
postInfrastructureascodeJobs(body) {
|
|
20676
|
+
// verify the required parameter 'body' is set
|
|
20677
|
+
if (body === undefined || body === null) {
|
|
20678
|
+
throw 'Missing the required parameter "body" when calling postInfrastructureascodeJobs';
|
|
20679
|
+
}
|
|
20680
|
+
|
|
20681
|
+
return this.apiClient.callApi(
|
|
20682
|
+
'/api/v2/infrastructureascode/jobs',
|
|
20683
|
+
'POST',
|
|
20684
|
+
{ },
|
|
20685
|
+
{ },
|
|
20686
|
+
{ },
|
|
20687
|
+
{ },
|
|
20688
|
+
body,
|
|
20689
|
+
['PureCloud OAuth'],
|
|
20690
|
+
['application/json'],
|
|
20691
|
+
['application/json']
|
|
20692
|
+
);
|
|
20693
|
+
}
|
|
20694
|
+
|
|
20695
|
+
}
|
|
20696
|
+
|
|
20557
20697
|
class IntegrationsApi {
|
|
20558
20698
|
/**
|
|
20559
20699
|
* Integrations service.
|
|
20560
20700
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20561
|
-
* @version
|
|
20701
|
+
* @version 160.0.0
|
|
20562
20702
|
*/
|
|
20563
20703
|
|
|
20564
20704
|
/**
|
|
@@ -22158,7 +22298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22158
22298
|
/**
|
|
22159
22299
|
* Journey service.
|
|
22160
22300
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22161
|
-
* @version
|
|
22301
|
+
* @version 160.0.0
|
|
22162
22302
|
*/
|
|
22163
22303
|
|
|
22164
22304
|
/**
|
|
@@ -22252,6 +22392,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22252
22392
|
);
|
|
22253
22393
|
}
|
|
22254
22394
|
|
|
22395
|
+
/**
|
|
22396
|
+
* Delete an outcome predictor.
|
|
22397
|
+
*
|
|
22398
|
+
* @param {String} predictorId ID of predictor
|
|
22399
|
+
*/
|
|
22400
|
+
deleteJourneyOutcomesPredictor(predictorId) {
|
|
22401
|
+
// verify the required parameter 'predictorId' is set
|
|
22402
|
+
if (predictorId === undefined || predictorId === null) {
|
|
22403
|
+
throw 'Missing the required parameter "predictorId" when calling deleteJourneyOutcomesPredictor';
|
|
22404
|
+
}
|
|
22405
|
+
|
|
22406
|
+
return this.apiClient.callApi(
|
|
22407
|
+
'/api/v2/journey/outcomes/predictors/{predictorId}',
|
|
22408
|
+
'DELETE',
|
|
22409
|
+
{ 'predictorId': predictorId },
|
|
22410
|
+
{ },
|
|
22411
|
+
{ },
|
|
22412
|
+
{ },
|
|
22413
|
+
null,
|
|
22414
|
+
['PureCloud OAuth'],
|
|
22415
|
+
['application/json'],
|
|
22416
|
+
['application/json']
|
|
22417
|
+
);
|
|
22418
|
+
}
|
|
22419
|
+
|
|
22255
22420
|
/**
|
|
22256
22421
|
* Delete a segment.
|
|
22257
22422
|
*
|
|
@@ -22542,6 +22707,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22542
22707
|
);
|
|
22543
22708
|
}
|
|
22544
22709
|
|
|
22710
|
+
/**
|
|
22711
|
+
* Retrieve a single outcome predictor.
|
|
22712
|
+
*
|
|
22713
|
+
* @param {String} predictorId ID of predictor
|
|
22714
|
+
*/
|
|
22715
|
+
getJourneyOutcomesPredictor(predictorId) {
|
|
22716
|
+
// verify the required parameter 'predictorId' is set
|
|
22717
|
+
if (predictorId === undefined || predictorId === null) {
|
|
22718
|
+
throw 'Missing the required parameter "predictorId" when calling getJourneyOutcomesPredictor';
|
|
22719
|
+
}
|
|
22720
|
+
|
|
22721
|
+
return this.apiClient.callApi(
|
|
22722
|
+
'/api/v2/journey/outcomes/predictors/{predictorId}',
|
|
22723
|
+
'GET',
|
|
22724
|
+
{ 'predictorId': predictorId },
|
|
22725
|
+
{ },
|
|
22726
|
+
{ },
|
|
22727
|
+
{ },
|
|
22728
|
+
null,
|
|
22729
|
+
['PureCloud OAuth'],
|
|
22730
|
+
['application/json'],
|
|
22731
|
+
['application/json']
|
|
22732
|
+
);
|
|
22733
|
+
}
|
|
22734
|
+
|
|
22735
|
+
/**
|
|
22736
|
+
* Retrieve all outcome predictors.
|
|
22737
|
+
*
|
|
22738
|
+
*/
|
|
22739
|
+
getJourneyOutcomesPredictors() {
|
|
22740
|
+
|
|
22741
|
+
return this.apiClient.callApi(
|
|
22742
|
+
'/api/v2/journey/outcomes/predictors',
|
|
22743
|
+
'GET',
|
|
22744
|
+
{ },
|
|
22745
|
+
{ },
|
|
22746
|
+
{ },
|
|
22747
|
+
{ },
|
|
22748
|
+
null,
|
|
22749
|
+
['PureCloud OAuth'],
|
|
22750
|
+
['application/json'],
|
|
22751
|
+
['application/json']
|
|
22752
|
+
);
|
|
22753
|
+
}
|
|
22754
|
+
|
|
22545
22755
|
/**
|
|
22546
22756
|
* Retrieve a single segment.
|
|
22547
22757
|
*
|
|
@@ -22914,6 +23124,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22914
23124
|
);
|
|
22915
23125
|
}
|
|
22916
23126
|
|
|
23127
|
+
/**
|
|
23128
|
+
* Create an outcome predictor.
|
|
23129
|
+
*
|
|
23130
|
+
* @param {Object} opts Optional parameters
|
|
23131
|
+
* @param {Object} opts.body
|
|
23132
|
+
*/
|
|
23133
|
+
postJourneyOutcomesPredictors(opts) {
|
|
23134
|
+
opts = opts || {};
|
|
23135
|
+
|
|
23136
|
+
|
|
23137
|
+
return this.apiClient.callApi(
|
|
23138
|
+
'/api/v2/journey/outcomes/predictors',
|
|
23139
|
+
'POST',
|
|
23140
|
+
{ },
|
|
23141
|
+
{ },
|
|
23142
|
+
{ },
|
|
23143
|
+
{ },
|
|
23144
|
+
opts['body'],
|
|
23145
|
+
['PureCloud OAuth'],
|
|
23146
|
+
['application/json'],
|
|
23147
|
+
['application/json']
|
|
23148
|
+
);
|
|
23149
|
+
}
|
|
23150
|
+
|
|
22917
23151
|
/**
|
|
22918
23152
|
* Create a segment.
|
|
22919
23153
|
*
|
|
@@ -22944,7 +23178,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22944
23178
|
/**
|
|
22945
23179
|
* Knowledge service.
|
|
22946
23180
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22947
|
-
* @version
|
|
23181
|
+
* @version 160.0.0
|
|
22948
23182
|
*/
|
|
22949
23183
|
|
|
22950
23184
|
/**
|
|
@@ -23347,7 +23581,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23347
23581
|
* @param {String} sessionId Knowledge guest session ID.
|
|
23348
23582
|
* @param {Object} opts Optional parameters
|
|
23349
23583
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23350
|
-
* @param {Boolean} opts.includeSubcategories Deprecated - Do Not Use. Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23351
23584
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
23352
23585
|
*/
|
|
23353
23586
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
@@ -23362,7 +23595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23362
23595
|
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
23363
23596
|
'GET',
|
|
23364
23597
|
{ 'sessionId': sessionId },
|
|
23365
|
-
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'
|
|
23598
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'pageSize': opts['pageSize'] },
|
|
23366
23599
|
{ },
|
|
23367
23600
|
{ },
|
|
23368
23601
|
null,
|
|
@@ -25377,7 +25610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25377
25610
|
/**
|
|
25378
25611
|
* LanguageUnderstanding service.
|
|
25379
25612
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25380
|
-
* @version
|
|
25613
|
+
* @version 160.0.0
|
|
25381
25614
|
*/
|
|
25382
25615
|
|
|
25383
25616
|
/**
|
|
@@ -26390,7 +26623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26390
26623
|
/**
|
|
26391
26624
|
* Languages service.
|
|
26392
26625
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26393
|
-
* @version
|
|
26626
|
+
* @version 160.0.0
|
|
26394
26627
|
*/
|
|
26395
26628
|
|
|
26396
26629
|
/**
|
|
@@ -26608,7 +26841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26608
26841
|
/**
|
|
26609
26842
|
* Learning service.
|
|
26610
26843
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26611
|
-
* @version
|
|
26844
|
+
* @version 160.0.0
|
|
26612
26845
|
*/
|
|
26613
26846
|
|
|
26614
26847
|
/**
|
|
@@ -27016,6 +27249,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27016
27249
|
);
|
|
27017
27250
|
}
|
|
27018
27251
|
|
|
27252
|
+
/**
|
|
27253
|
+
* Reschedule Learning Assignment
|
|
27254
|
+
*
|
|
27255
|
+
* @param {String} assignmentId The ID of Learning Assignment
|
|
27256
|
+
* @param {Object} opts Optional parameters
|
|
27257
|
+
* @param {Object} opts.body The Learning assignment reschedule model
|
|
27258
|
+
*/
|
|
27259
|
+
patchLearningAssignmentReschedule(assignmentId, opts) {
|
|
27260
|
+
opts = opts || {};
|
|
27261
|
+
|
|
27262
|
+
// verify the required parameter 'assignmentId' is set
|
|
27263
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
27264
|
+
throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentReschedule';
|
|
27265
|
+
}
|
|
27266
|
+
|
|
27267
|
+
return this.apiClient.callApi(
|
|
27268
|
+
'/api/v2/learning/assignments/{assignmentId}/reschedule',
|
|
27269
|
+
'PATCH',
|
|
27270
|
+
{ 'assignmentId': assignmentId },
|
|
27271
|
+
{ },
|
|
27272
|
+
{ },
|
|
27273
|
+
{ },
|
|
27274
|
+
opts['body'],
|
|
27275
|
+
['PureCloud OAuth'],
|
|
27276
|
+
['application/json'],
|
|
27277
|
+
['application/json']
|
|
27278
|
+
);
|
|
27279
|
+
}
|
|
27280
|
+
|
|
27019
27281
|
/**
|
|
27020
27282
|
* Score learning assessment for preview
|
|
27021
27283
|
*
|
|
@@ -27303,6 +27565,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27303
27565
|
);
|
|
27304
27566
|
}
|
|
27305
27567
|
|
|
27568
|
+
/**
|
|
27569
|
+
* Get list of possible slots where a learning activity can be scheduled.
|
|
27570
|
+
*
|
|
27571
|
+
* @param {Object} body The slot search request
|
|
27572
|
+
*/
|
|
27573
|
+
postLearningScheduleslotsQuery(body) {
|
|
27574
|
+
// verify the required parameter 'body' is set
|
|
27575
|
+
if (body === undefined || body === null) {
|
|
27576
|
+
throw 'Missing the required parameter "body" when calling postLearningScheduleslotsQuery';
|
|
27577
|
+
}
|
|
27578
|
+
|
|
27579
|
+
return this.apiClient.callApi(
|
|
27580
|
+
'/api/v2/learning/scheduleslots/query',
|
|
27581
|
+
'POST',
|
|
27582
|
+
{ },
|
|
27583
|
+
{ },
|
|
27584
|
+
{ },
|
|
27585
|
+
{ },
|
|
27586
|
+
body,
|
|
27587
|
+
['PureCloud OAuth'],
|
|
27588
|
+
['application/json'],
|
|
27589
|
+
['application/json']
|
|
27590
|
+
);
|
|
27591
|
+
}
|
|
27592
|
+
|
|
27306
27593
|
/**
|
|
27307
27594
|
* Update a learning module
|
|
27308
27595
|
* This will update the name, description, completion time in days and inform steps for a learning module
|
|
@@ -27369,7 +27656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27369
27656
|
/**
|
|
27370
27657
|
* License service.
|
|
27371
27658
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27372
|
-
* @version
|
|
27659
|
+
* @version 160.0.0
|
|
27373
27660
|
*/
|
|
27374
27661
|
|
|
27375
27662
|
/**
|
|
@@ -27607,7 +27894,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27607
27894
|
/**
|
|
27608
27895
|
* Locations service.
|
|
27609
27896
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27610
|
-
* @version
|
|
27897
|
+
* @version 160.0.0
|
|
27611
27898
|
*/
|
|
27612
27899
|
|
|
27613
27900
|
/**
|
|
@@ -27843,7 +28130,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27843
28130
|
/**
|
|
27844
28131
|
* Messaging service.
|
|
27845
28132
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27846
|
-
* @version
|
|
28133
|
+
* @version 160.0.0
|
|
27847
28134
|
*/
|
|
27848
28135
|
|
|
27849
28136
|
/**
|
|
@@ -27994,7 +28281,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27994
28281
|
/**
|
|
27995
28282
|
* MobileDevices service.
|
|
27996
28283
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27997
|
-
* @version
|
|
28284
|
+
* @version 160.0.0
|
|
27998
28285
|
*/
|
|
27999
28286
|
|
|
28000
28287
|
/**
|
|
@@ -28145,7 +28432,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28145
28432
|
/**
|
|
28146
28433
|
* Notifications service.
|
|
28147
28434
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28148
|
-
* @version
|
|
28435
|
+
* @version 160.0.0
|
|
28149
28436
|
*/
|
|
28150
28437
|
|
|
28151
28438
|
/**
|
|
@@ -28289,8 +28576,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28289
28576
|
*
|
|
28290
28577
|
* @param {String} channelId Channel ID
|
|
28291
28578
|
* @param {Array.<Object>} body Body
|
|
28579
|
+
* @param {Object} opts Optional parameters
|
|
28580
|
+
* @param {Boolean} opts.ignoreErrors Optionally prevent throwing of errors for failed permissions checks. (default to false)
|
|
28292
28581
|
*/
|
|
28293
|
-
postNotificationsChannelSubscriptions(channelId, body) {
|
|
28582
|
+
postNotificationsChannelSubscriptions(channelId, body, opts) {
|
|
28583
|
+
opts = opts || {};
|
|
28584
|
+
|
|
28294
28585
|
// verify the required parameter 'channelId' is set
|
|
28295
28586
|
if (channelId === undefined || channelId === null) {
|
|
28296
28587
|
throw 'Missing the required parameter "channelId" when calling postNotificationsChannelSubscriptions';
|
|
@@ -28304,7 +28595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28304
28595
|
'/api/v2/notifications/channels/{channelId}/subscriptions',
|
|
28305
28596
|
'POST',
|
|
28306
28597
|
{ 'channelId': channelId },
|
|
28307
|
-
{
|
|
28598
|
+
{ 'ignoreErrors': opts['ignoreErrors'] },
|
|
28308
28599
|
{ },
|
|
28309
28600
|
{ },
|
|
28310
28601
|
body,
|
|
@@ -28339,8 +28630,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28339
28630
|
*
|
|
28340
28631
|
* @param {String} channelId Channel ID
|
|
28341
28632
|
* @param {Array.<Object>} body Body
|
|
28633
|
+
* @param {Object} opts Optional parameters
|
|
28634
|
+
* @param {Boolean} opts.ignoreErrors Optionally prevent throwing of errors for failed permissions checks. (default to false)
|
|
28342
28635
|
*/
|
|
28343
|
-
putNotificationsChannelSubscriptions(channelId, body) {
|
|
28636
|
+
putNotificationsChannelSubscriptions(channelId, body, opts) {
|
|
28637
|
+
opts = opts || {};
|
|
28638
|
+
|
|
28344
28639
|
// verify the required parameter 'channelId' is set
|
|
28345
28640
|
if (channelId === undefined || channelId === null) {
|
|
28346
28641
|
throw 'Missing the required parameter "channelId" when calling putNotificationsChannelSubscriptions';
|
|
@@ -28354,7 +28649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28354
28649
|
'/api/v2/notifications/channels/{channelId}/subscriptions',
|
|
28355
28650
|
'PUT',
|
|
28356
28651
|
{ 'channelId': channelId },
|
|
28357
|
-
{
|
|
28652
|
+
{ 'ignoreErrors': opts['ignoreErrors'] },
|
|
28358
28653
|
{ },
|
|
28359
28654
|
{ },
|
|
28360
28655
|
body,
|
|
@@ -28370,7 +28665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28370
28665
|
/**
|
|
28371
28666
|
* OAuth service.
|
|
28372
28667
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28373
|
-
* @version
|
|
28668
|
+
* @version 160.0.0
|
|
28374
28669
|
*/
|
|
28375
28670
|
|
|
28376
28671
|
/**
|
|
@@ -28736,7 +29031,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28736
29031
|
/**
|
|
28737
29032
|
* Objects service.
|
|
28738
29033
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28739
|
-
* @version
|
|
29034
|
+
* @version 160.0.0
|
|
28740
29035
|
*/
|
|
28741
29036
|
|
|
28742
29037
|
/**
|
|
@@ -29007,7 +29302,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29007
29302
|
/**
|
|
29008
29303
|
* Organization service.
|
|
29009
29304
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
29010
|
-
* @version
|
|
29305
|
+
* @version 160.0.0
|
|
29011
29306
|
*/
|
|
29012
29307
|
|
|
29013
29308
|
/**
|
|
@@ -29410,7 +29705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29410
29705
|
/**
|
|
29411
29706
|
* OrganizationAuthorization service.
|
|
29412
29707
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29413
|
-
* @version
|
|
29708
|
+
* @version 160.0.0
|
|
29414
29709
|
*/
|
|
29415
29710
|
|
|
29416
29711
|
/**
|
|
@@ -30705,7 +31000,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30705
31000
|
/**
|
|
30706
31001
|
* Outbound service.
|
|
30707
31002
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30708
|
-
* @version
|
|
31003
|
+
* @version 160.0.0
|
|
30709
31004
|
*/
|
|
30710
31005
|
|
|
30711
31006
|
/**
|
|
@@ -31055,6 +31350,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31055
31350
|
);
|
|
31056
31351
|
}
|
|
31057
31352
|
|
|
31353
|
+
/**
|
|
31354
|
+
* Deletes all or expired custom exclusion column entries from a DNC list.
|
|
31355
|
+
* This operation is only for Internal DNC lists of custom exclusion column entries
|
|
31356
|
+
* @param {String} dncListId DncList ID
|
|
31357
|
+
* @param {Object} opts Optional parameters
|
|
31358
|
+
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
31359
|
+
*/
|
|
31360
|
+
deleteOutboundDnclistCustomexclusioncolumns(dncListId, opts) {
|
|
31361
|
+
opts = opts || {};
|
|
31362
|
+
|
|
31363
|
+
// verify the required parameter 'dncListId' is set
|
|
31364
|
+
if (dncListId === undefined || dncListId === null) {
|
|
31365
|
+
throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistCustomexclusioncolumns';
|
|
31366
|
+
}
|
|
31367
|
+
|
|
31368
|
+
return this.apiClient.callApi(
|
|
31369
|
+
'/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns',
|
|
31370
|
+
'DELETE',
|
|
31371
|
+
{ 'dncListId': dncListId },
|
|
31372
|
+
{ 'expiredOnly': opts['expiredOnly'] },
|
|
31373
|
+
{ },
|
|
31374
|
+
{ },
|
|
31375
|
+
null,
|
|
31376
|
+
['PureCloud OAuth'],
|
|
31377
|
+
['application/json'],
|
|
31378
|
+
['application/json']
|
|
31379
|
+
);
|
|
31380
|
+
}
|
|
31381
|
+
|
|
31058
31382
|
/**
|
|
31059
31383
|
* Deletes all or expired email addresses from a DNC list.
|
|
31060
31384
|
* This operation is Only for Internal DNC lists of email addresses
|
|
@@ -32883,6 +33207,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32883
33207
|
);
|
|
32884
33208
|
}
|
|
32885
33209
|
|
|
33210
|
+
/**
|
|
33211
|
+
* Add entries to or delete entries from a DNC list.
|
|
33212
|
+
* Only Internal DNC lists may be deleted from
|
|
33213
|
+
* @param {String} dncListId DncList ID
|
|
33214
|
+
* @param {Object} body DNC Custom exclusion column entries
|
|
33215
|
+
*/
|
|
33216
|
+
patchOutboundDnclistCustomexclusioncolumns(dncListId, body) {
|
|
33217
|
+
// verify the required parameter 'dncListId' is set
|
|
33218
|
+
if (dncListId === undefined || dncListId === null) {
|
|
33219
|
+
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistCustomexclusioncolumns';
|
|
33220
|
+
}
|
|
33221
|
+
// verify the required parameter 'body' is set
|
|
33222
|
+
if (body === undefined || body === null) {
|
|
33223
|
+
throw 'Missing the required parameter "body" when calling patchOutboundDnclistCustomexclusioncolumns';
|
|
33224
|
+
}
|
|
33225
|
+
|
|
33226
|
+
return this.apiClient.callApi(
|
|
33227
|
+
'/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns',
|
|
33228
|
+
'PATCH',
|
|
33229
|
+
{ 'dncListId': dncListId },
|
|
33230
|
+
{ },
|
|
33231
|
+
{ },
|
|
33232
|
+
{ },
|
|
33233
|
+
body,
|
|
33234
|
+
['PureCloud OAuth'],
|
|
33235
|
+
['application/json'],
|
|
33236
|
+
['application/json']
|
|
33237
|
+
);
|
|
33238
|
+
}
|
|
33239
|
+
|
|
32886
33240
|
/**
|
|
32887
33241
|
* Add emails to or Delete emails from a DNC list.
|
|
32888
33242
|
* Only Internal DNC lists may be added to or deleted from
|
|
@@ -34242,7 +34596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34242
34596
|
/**
|
|
34243
34597
|
* Presence service.
|
|
34244
34598
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
34245
|
-
* @version
|
|
34599
|
+
* @version 160.0.0
|
|
34246
34600
|
*/
|
|
34247
34601
|
|
|
34248
34602
|
/**
|
|
@@ -34748,7 +35102,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34748
35102
|
/**
|
|
34749
35103
|
* ProcessAutomation service.
|
|
34750
35104
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34751
|
-
* @version
|
|
35105
|
+
* @version 160.0.0
|
|
34752
35106
|
*/
|
|
34753
35107
|
|
|
34754
35108
|
/**
|
|
@@ -34987,7 +35341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34987
35341
|
/**
|
|
34988
35342
|
* Quality service.
|
|
34989
35343
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34990
|
-
* @version
|
|
35344
|
+
* @version 160.0.0
|
|
34991
35345
|
*/
|
|
34992
35346
|
|
|
34993
35347
|
/**
|
|
@@ -35249,7 +35603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35249
35603
|
* @param {String} conversationId conversationId
|
|
35250
35604
|
* @param {String} evaluationId evaluationId
|
|
35251
35605
|
* @param {Object} opts Optional parameters
|
|
35252
|
-
* @param {String} opts.expand agent, evaluator, evaluationForm
|
|
35606
|
+
* @param {String} opts.expand agent, assignee, evaluator, evaluationForm
|
|
35253
35607
|
*/
|
|
35254
35608
|
getQualityConversationEvaluation(conversationId, evaluationId, opts) {
|
|
35255
35609
|
opts = opts || {};
|
|
@@ -35360,7 +35714,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35360
35714
|
|
|
35361
35715
|
/**
|
|
35362
35716
|
* Queries Evaluations and returns a paged list
|
|
35363
|
-
* Query params must include one of conversationId, evaluatorUserId, or
|
|
35717
|
+
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
35364
35718
|
* @param {Object} opts Optional parameters
|
|
35365
35719
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
35366
35720
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -35371,6 +35725,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35371
35725
|
* @param {String} opts.conversationId conversationId specified
|
|
35372
35726
|
* @param {String} opts.agentUserId user id of the agent
|
|
35373
35727
|
* @param {String} opts.evaluatorUserId evaluator user id
|
|
35728
|
+
* @param {String} opts.assigneeUserId assignee user id
|
|
35374
35729
|
* @param {String} opts.queueId queue id
|
|
35375
35730
|
* @param {String} opts.startTime start time of the evaluation query
|
|
35376
35731
|
* @param {String} opts.endTime end time of the evaluation query
|
|
@@ -35389,7 +35744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35389
35744
|
'/api/v2/quality/evaluations/query',
|
|
35390
35745
|
'GET',
|
|
35391
35746
|
{ },
|
|
35392
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
35747
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
35393
35748
|
{ },
|
|
35394
35749
|
{ },
|
|
35395
35750
|
null,
|
|
@@ -36565,7 +36920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36565
36920
|
/**
|
|
36566
36921
|
* Recording service.
|
|
36567
36922
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
36568
|
-
* @version
|
|
36923
|
+
* @version 160.0.0
|
|
36569
36924
|
*/
|
|
36570
36925
|
|
|
36571
36926
|
/**
|
|
@@ -37266,51 +37621,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37266
37621
|
);
|
|
37267
37622
|
}
|
|
37268
37623
|
|
|
37269
|
-
/**
|
|
37270
|
-
* Get the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
37271
|
-
*
|
|
37272
|
-
* @param {String} settingsId Settings Id
|
|
37273
|
-
*/
|
|
37274
|
-
getRecordingLocalkeysSetting(settingsId) {
|
|
37275
|
-
// verify the required parameter 'settingsId' is set
|
|
37276
|
-
if (settingsId === undefined || settingsId === null) {
|
|
37277
|
-
throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
|
|
37278
|
-
}
|
|
37279
|
-
|
|
37280
|
-
return this.apiClient.callApi(
|
|
37281
|
-
'/api/v2/recording/localkeys/settings/{settingsId}',
|
|
37282
|
-
'GET',
|
|
37283
|
-
{ 'settingsId': settingsId },
|
|
37284
|
-
{ },
|
|
37285
|
-
{ },
|
|
37286
|
-
{ },
|
|
37287
|
-
null,
|
|
37288
|
-
['PureCloud OAuth'],
|
|
37289
|
-
['application/json'],
|
|
37290
|
-
['application/json']
|
|
37291
|
-
);
|
|
37292
|
-
}
|
|
37293
|
-
|
|
37294
|
-
/**
|
|
37295
|
-
* gets a list local key settings data. Replaced by API recording/keyconfigurations
|
|
37296
|
-
*
|
|
37297
|
-
*/
|
|
37298
|
-
getRecordingLocalkeysSettings() {
|
|
37299
|
-
|
|
37300
|
-
return this.apiClient.callApi(
|
|
37301
|
-
'/api/v2/recording/localkeys/settings',
|
|
37302
|
-
'GET',
|
|
37303
|
-
{ },
|
|
37304
|
-
{ },
|
|
37305
|
-
{ },
|
|
37306
|
-
{ },
|
|
37307
|
-
null,
|
|
37308
|
-
['PureCloud OAuth'],
|
|
37309
|
-
['application/json'],
|
|
37310
|
-
['application/json']
|
|
37311
|
-
);
|
|
37312
|
-
}
|
|
37313
|
-
|
|
37314
37624
|
/**
|
|
37315
37625
|
* Gets media retention policy list with query options to filter on name and enabled.
|
|
37316
37626
|
* for a less verbose response, add summary=true to this endpoint
|
|
@@ -37695,7 +38005,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37695
38005
|
|
|
37696
38006
|
/**
|
|
37697
38007
|
* Create a recording bulk job.
|
|
37698
|
-
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.
|
|
38008
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.
|
|
37699
38009
|
* @param {Object} body query
|
|
37700
38010
|
*/
|
|
37701
38011
|
postRecordingJobs(body) {
|
|
@@ -37793,31 +38103,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37793
38103
|
);
|
|
37794
38104
|
}
|
|
37795
38105
|
|
|
37796
|
-
/**
|
|
37797
|
-
* create settings for local key creation. Replaced by API recording/keyconfigurations
|
|
37798
|
-
*
|
|
37799
|
-
* @param {Object} body Local Encryption Configuration
|
|
37800
|
-
*/
|
|
37801
|
-
postRecordingLocalkeysSettings(body) {
|
|
37802
|
-
// verify the required parameter 'body' is set
|
|
37803
|
-
if (body === undefined || body === null) {
|
|
37804
|
-
throw 'Missing the required parameter "body" when calling postRecordingLocalkeysSettings';
|
|
37805
|
-
}
|
|
37806
|
-
|
|
37807
|
-
return this.apiClient.callApi(
|
|
37808
|
-
'/api/v2/recording/localkeys/settings',
|
|
37809
|
-
'POST',
|
|
37810
|
-
{ },
|
|
37811
|
-
{ },
|
|
37812
|
-
{ },
|
|
37813
|
-
{ },
|
|
37814
|
-
body,
|
|
37815
|
-
['PureCloud OAuth'],
|
|
37816
|
-
['application/json'],
|
|
37817
|
-
['application/json']
|
|
37818
|
-
);
|
|
37819
|
-
}
|
|
37820
|
-
|
|
37821
38106
|
/**
|
|
37822
38107
|
* Create media retention policy
|
|
37823
38108
|
* Policy does not work retroactively
|
|
@@ -38161,36 +38446,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38161
38446
|
);
|
|
38162
38447
|
}
|
|
38163
38448
|
|
|
38164
|
-
/**
|
|
38165
|
-
* Update the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
38166
|
-
*
|
|
38167
|
-
* @param {String} settingsId Settings Id
|
|
38168
|
-
* @param {Object} body Local Encryption metadata
|
|
38169
|
-
*/
|
|
38170
|
-
putRecordingLocalkeysSetting(settingsId, body) {
|
|
38171
|
-
// verify the required parameter 'settingsId' is set
|
|
38172
|
-
if (settingsId === undefined || settingsId === null) {
|
|
38173
|
-
throw 'Missing the required parameter "settingsId" when calling putRecordingLocalkeysSetting';
|
|
38174
|
-
}
|
|
38175
|
-
// verify the required parameter 'body' is set
|
|
38176
|
-
if (body === undefined || body === null) {
|
|
38177
|
-
throw 'Missing the required parameter "body" when calling putRecordingLocalkeysSetting';
|
|
38178
|
-
}
|
|
38179
|
-
|
|
38180
|
-
return this.apiClient.callApi(
|
|
38181
|
-
'/api/v2/recording/localkeys/settings/{settingsId}',
|
|
38182
|
-
'PUT',
|
|
38183
|
-
{ 'settingsId': settingsId },
|
|
38184
|
-
{ },
|
|
38185
|
-
{ },
|
|
38186
|
-
{ },
|
|
38187
|
-
body,
|
|
38188
|
-
['PureCloud OAuth'],
|
|
38189
|
-
['application/json'],
|
|
38190
|
-
['application/json']
|
|
38191
|
-
);
|
|
38192
|
-
}
|
|
38193
|
-
|
|
38194
38449
|
/**
|
|
38195
38450
|
* Update a media retention policy
|
|
38196
38451
|
* Policy does not work retroactively
|
|
@@ -38302,7 +38557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38302
38557
|
/**
|
|
38303
38558
|
* ResponseManagement service.
|
|
38304
38559
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
38305
|
-
* @version
|
|
38560
|
+
* @version 160.0.0
|
|
38306
38561
|
*/
|
|
38307
38562
|
|
|
38308
38563
|
/**
|
|
@@ -38786,7 +39041,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38786
39041
|
/**
|
|
38787
39042
|
* Routing service.
|
|
38788
39043
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38789
|
-
* @version
|
|
39044
|
+
* @version 160.0.0
|
|
38790
39045
|
*/
|
|
38791
39046
|
|
|
38792
39047
|
/**
|
|
@@ -40589,8 +40844,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40589
40844
|
* Get a phone number provisioned for SMS.
|
|
40590
40845
|
*
|
|
40591
40846
|
* @param {String} addressId Address ID
|
|
40847
|
+
* @param {Object} opts Optional parameters
|
|
40848
|
+
* @param {Object} opts.expand Expand response with additional information
|
|
40592
40849
|
*/
|
|
40593
|
-
getRoutingSmsPhonenumber(addressId) {
|
|
40850
|
+
getRoutingSmsPhonenumber(addressId, opts) {
|
|
40851
|
+
opts = opts || {};
|
|
40852
|
+
|
|
40594
40853
|
// verify the required parameter 'addressId' is set
|
|
40595
40854
|
if (addressId === undefined || addressId === null) {
|
|
40596
40855
|
throw 'Missing the required parameter "addressId" when calling getRoutingSmsPhonenumber';
|
|
@@ -40600,7 +40859,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40600
40859
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
40601
40860
|
'GET',
|
|
40602
40861
|
{ 'addressId': addressId },
|
|
40603
|
-
{
|
|
40862
|
+
{ 'expand': opts['expand'] },
|
|
40604
40863
|
{ },
|
|
40605
40864
|
{ },
|
|
40606
40865
|
null,
|
|
@@ -40834,6 +41093,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40834
41093
|
);
|
|
40835
41094
|
}
|
|
40836
41095
|
|
|
41096
|
+
/**
|
|
41097
|
+
* Get skill groups for a user
|
|
41098
|
+
*
|
|
41099
|
+
* @param {String} userId User ID
|
|
41100
|
+
* @param {Object} opts Optional parameters
|
|
41101
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41102
|
+
* @param {String} opts.after The cursor that points to the next page
|
|
41103
|
+
* @param {String} opts.before The cursor that points to the previous page
|
|
41104
|
+
*/
|
|
41105
|
+
getUserSkillgroups(userId, opts) {
|
|
41106
|
+
opts = opts || {};
|
|
41107
|
+
|
|
41108
|
+
// verify the required parameter 'userId' is set
|
|
41109
|
+
if (userId === undefined || userId === null) {
|
|
41110
|
+
throw 'Missing the required parameter "userId" when calling getUserSkillgroups';
|
|
41111
|
+
}
|
|
41112
|
+
|
|
41113
|
+
return this.apiClient.callApi(
|
|
41114
|
+
'/api/v2/users/{userId}/skillgroups',
|
|
41115
|
+
'GET',
|
|
41116
|
+
{ 'userId': userId },
|
|
41117
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'] },
|
|
41118
|
+
{ },
|
|
41119
|
+
{ },
|
|
41120
|
+
null,
|
|
41121
|
+
['PureCloud OAuth'],
|
|
41122
|
+
['application/json'],
|
|
41123
|
+
['application/json']
|
|
41124
|
+
);
|
|
41125
|
+
}
|
|
41126
|
+
|
|
40837
41127
|
/**
|
|
40838
41128
|
* Update attributes of an in-queue conversation
|
|
40839
41129
|
* Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, languageId, and priority.
|
|
@@ -42251,7 +42541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42251
42541
|
/**
|
|
42252
42542
|
* SCIM service.
|
|
42253
42543
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
42254
|
-
* @version
|
|
42544
|
+
* @version 160.0.0
|
|
42255
42545
|
*/
|
|
42256
42546
|
|
|
42257
42547
|
/**
|
|
@@ -43128,7 +43418,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43128
43418
|
/**
|
|
43129
43419
|
* Scripts service.
|
|
43130
43420
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
43131
|
-
* @version
|
|
43421
|
+
* @version 160.0.0
|
|
43132
43422
|
*/
|
|
43133
43423
|
|
|
43134
43424
|
/**
|
|
@@ -43547,7 +43837,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43547
43837
|
/**
|
|
43548
43838
|
* Search service.
|
|
43549
43839
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
43550
|
-
* @version
|
|
43840
|
+
* @version 160.0.0
|
|
43551
43841
|
*/
|
|
43552
43842
|
|
|
43553
43843
|
/**
|
|
@@ -43814,6 +44104,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43814
44104
|
);
|
|
43815
44105
|
}
|
|
43816
44106
|
|
|
44107
|
+
/**
|
|
44108
|
+
* Search conversations
|
|
44109
|
+
*
|
|
44110
|
+
* @param {Object} body Search request options
|
|
44111
|
+
*/
|
|
44112
|
+
postConversationsParticipantsAttributesSearch(body) {
|
|
44113
|
+
// verify the required parameter 'body' is set
|
|
44114
|
+
if (body === undefined || body === null) {
|
|
44115
|
+
throw 'Missing the required parameter "body" when calling postConversationsParticipantsAttributesSearch';
|
|
44116
|
+
}
|
|
44117
|
+
|
|
44118
|
+
return this.apiClient.callApi(
|
|
44119
|
+
'/api/v2/conversations/participants/attributes/search',
|
|
44120
|
+
'POST',
|
|
44121
|
+
{ },
|
|
44122
|
+
{ },
|
|
44123
|
+
{ },
|
|
44124
|
+
{ },
|
|
44125
|
+
body,
|
|
44126
|
+
['PureCloud OAuth'],
|
|
44127
|
+
['application/json'],
|
|
44128
|
+
['application/json']
|
|
44129
|
+
);
|
|
44130
|
+
}
|
|
44131
|
+
|
|
43817
44132
|
/**
|
|
43818
44133
|
* Search gkn documentation
|
|
43819
44134
|
*
|
|
@@ -44132,7 +44447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44132
44447
|
/**
|
|
44133
44448
|
* SpeechTextAnalytics service.
|
|
44134
44449
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
44135
|
-
* @version
|
|
44450
|
+
* @version 160.0.0
|
|
44136
44451
|
*/
|
|
44137
44452
|
|
|
44138
44453
|
/**
|
|
@@ -44351,6 +44666,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44351
44666
|
);
|
|
44352
44667
|
}
|
|
44353
44668
|
|
|
44669
|
+
/**
|
|
44670
|
+
* Get transcription engine settings of a program
|
|
44671
|
+
*
|
|
44672
|
+
* @param {String} programId The id of the program
|
|
44673
|
+
*/
|
|
44674
|
+
getSpeechandtextanalyticsProgramTranscriptionengines(programId) {
|
|
44675
|
+
// verify the required parameter 'programId' is set
|
|
44676
|
+
if (programId === undefined || programId === null) {
|
|
44677
|
+
throw 'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgramTranscriptionengines';
|
|
44678
|
+
}
|
|
44679
|
+
|
|
44680
|
+
return this.apiClient.callApi(
|
|
44681
|
+
'/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines',
|
|
44682
|
+
'GET',
|
|
44683
|
+
{ 'programId': programId },
|
|
44684
|
+
{ },
|
|
44685
|
+
{ },
|
|
44686
|
+
{ },
|
|
44687
|
+
null,
|
|
44688
|
+
['PureCloud OAuth'],
|
|
44689
|
+
['application/json'],
|
|
44690
|
+
['application/json']
|
|
44691
|
+
);
|
|
44692
|
+
}
|
|
44693
|
+
|
|
44354
44694
|
/**
|
|
44355
44695
|
* Get the list of Speech and Text Analytics programs
|
|
44356
44696
|
*
|
|
@@ -44452,6 +44792,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44452
44792
|
);
|
|
44453
44793
|
}
|
|
44454
44794
|
|
|
44795
|
+
/**
|
|
44796
|
+
* Get supported dialects for each transcription engine
|
|
44797
|
+
*
|
|
44798
|
+
*/
|
|
44799
|
+
getSpeechandtextanalyticsProgramsTranscriptionenginesDialects() {
|
|
44800
|
+
|
|
44801
|
+
return this.apiClient.callApi(
|
|
44802
|
+
'/api/v2/speechandtextanalytics/programs/transcriptionengines/dialects',
|
|
44803
|
+
'GET',
|
|
44804
|
+
{ },
|
|
44805
|
+
{ },
|
|
44806
|
+
{ },
|
|
44807
|
+
{ },
|
|
44808
|
+
null,
|
|
44809
|
+
['PureCloud OAuth'],
|
|
44810
|
+
['application/json'],
|
|
44811
|
+
['application/json']
|
|
44812
|
+
);
|
|
44813
|
+
}
|
|
44814
|
+
|
|
44455
44815
|
/**
|
|
44456
44816
|
* Get the list of Speech and Text Analytics unpublished programs
|
|
44457
44817
|
*
|
|
@@ -44925,6 +45285,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44925
45285
|
);
|
|
44926
45286
|
}
|
|
44927
45287
|
|
|
45288
|
+
/**
|
|
45289
|
+
* Update transcription engine settings of a program
|
|
45290
|
+
*
|
|
45291
|
+
* @param {String} programId The id of the program
|
|
45292
|
+
* @param {Object} body Program transcription engine setting
|
|
45293
|
+
*/
|
|
45294
|
+
putSpeechandtextanalyticsProgramTranscriptionengines(programId, body) {
|
|
45295
|
+
// verify the required parameter 'programId' is set
|
|
45296
|
+
if (programId === undefined || programId === null) {
|
|
45297
|
+
throw 'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgramTranscriptionengines';
|
|
45298
|
+
}
|
|
45299
|
+
// verify the required parameter 'body' is set
|
|
45300
|
+
if (body === undefined || body === null) {
|
|
45301
|
+
throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgramTranscriptionengines';
|
|
45302
|
+
}
|
|
45303
|
+
|
|
45304
|
+
return this.apiClient.callApi(
|
|
45305
|
+
'/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines',
|
|
45306
|
+
'PUT',
|
|
45307
|
+
{ 'programId': programId },
|
|
45308
|
+
{ },
|
|
45309
|
+
{ },
|
|
45310
|
+
{ },
|
|
45311
|
+
body,
|
|
45312
|
+
['PureCloud OAuth'],
|
|
45313
|
+
['application/json'],
|
|
45314
|
+
['application/json']
|
|
45315
|
+
);
|
|
45316
|
+
}
|
|
45317
|
+
|
|
44928
45318
|
/**
|
|
44929
45319
|
* Update Speech And Text Analytics Settings
|
|
44930
45320
|
*
|
|
@@ -44986,7 +45376,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44986
45376
|
/**
|
|
44987
45377
|
* Stations service.
|
|
44988
45378
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44989
|
-
* @version
|
|
45379
|
+
* @version 160.0.0
|
|
44990
45380
|
*/
|
|
44991
45381
|
|
|
44992
45382
|
/**
|
|
@@ -45133,7 +45523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45133
45523
|
/**
|
|
45134
45524
|
* Suggest service.
|
|
45135
45525
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
45136
|
-
* @version
|
|
45526
|
+
* @version 160.0.0
|
|
45137
45527
|
*/
|
|
45138
45528
|
|
|
45139
45529
|
/**
|
|
@@ -45272,7 +45662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45272
45662
|
/**
|
|
45273
45663
|
* Teams service.
|
|
45274
45664
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
45275
|
-
* @version
|
|
45665
|
+
* @version 160.0.0
|
|
45276
45666
|
*/
|
|
45277
45667
|
|
|
45278
45668
|
/**
|
|
@@ -45543,7 +45933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45543
45933
|
/**
|
|
45544
45934
|
* Telephony service.
|
|
45545
45935
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
45546
|
-
* @version
|
|
45936
|
+
* @version 160.0.0
|
|
45547
45937
|
*/
|
|
45548
45938
|
|
|
45549
45939
|
/**
|
|
@@ -45671,7 +46061,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45671
46061
|
/**
|
|
45672
46062
|
* TelephonyProvidersEdge service.
|
|
45673
46063
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
45674
|
-
* @version
|
|
46064
|
+
* @version 160.0.0
|
|
45675
46065
|
*/
|
|
45676
46066
|
|
|
45677
46067
|
/**
|
|
@@ -46677,6 +47067,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46677
47067
|
* @param {String} opts.edgeGroupId Filter by edgeGroup.id
|
|
46678
47068
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
46679
47069
|
* @param {Boolean} opts.managed Filter by managed
|
|
47070
|
+
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
46680
47071
|
*/
|
|
46681
47072
|
getTelephonyProvidersEdges(opts) {
|
|
46682
47073
|
opts = opts || {};
|
|
@@ -46686,7 +47077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46686
47077
|
'/api/v2/telephony/providers/edges',
|
|
46687
47078
|
'GET',
|
|
46688
47079
|
{ },
|
|
46689
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'site.id': opts['siteId'],'edgeGroup.id': opts['edgeGroupId'],'sortBy': opts['sortBy'],'managed': opts['managed'] },
|
|
47080
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'site.id': opts['siteId'],'edgeGroup.id': opts['edgeGroupId'],'sortBy': opts['sortBy'],'managed': opts['managed'],'showCloudMedia': opts['showCloudMedia'] },
|
|
46690
47081
|
{ },
|
|
46691
47082
|
{ },
|
|
46692
47083
|
null,
|
|
@@ -49304,7 +49695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49304
49695
|
/**
|
|
49305
49696
|
* Textbots service.
|
|
49306
49697
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
49307
|
-
* @version
|
|
49698
|
+
* @version 160.0.0
|
|
49308
49699
|
*/
|
|
49309
49700
|
|
|
49310
49701
|
/**
|
|
@@ -49432,7 +49823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49432
49823
|
/**
|
|
49433
49824
|
* Tokens service.
|
|
49434
49825
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
49435
|
-
* @version
|
|
49826
|
+
* @version 160.0.0
|
|
49436
49827
|
*/
|
|
49437
49828
|
|
|
49438
49829
|
/**
|
|
@@ -49538,7 +49929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49538
49929
|
/**
|
|
49539
49930
|
* Uploads service.
|
|
49540
49931
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
49541
|
-
* @version
|
|
49932
|
+
* @version 160.0.0
|
|
49542
49933
|
*/
|
|
49543
49934
|
|
|
49544
49935
|
/**
|
|
@@ -49714,7 +50105,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49714
50105
|
/**
|
|
49715
50106
|
* Usage service.
|
|
49716
50107
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
49717
|
-
* @version
|
|
50108
|
+
* @version 160.0.0
|
|
49718
50109
|
*/
|
|
49719
50110
|
|
|
49720
50111
|
/**
|
|
@@ -49785,7 +50176,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49785
50176
|
/**
|
|
49786
50177
|
* UserRecordings service.
|
|
49787
50178
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49788
|
-
* @version
|
|
50179
|
+
* @version 160.0.0
|
|
49789
50180
|
*/
|
|
49790
50181
|
|
|
49791
50182
|
/**
|
|
@@ -49970,7 +50361,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49970
50361
|
/**
|
|
49971
50362
|
* Users service.
|
|
49972
50363
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49973
|
-
* @version
|
|
50364
|
+
* @version 160.0.0
|
|
49974
50365
|
*/
|
|
49975
50366
|
|
|
49976
50367
|
/**
|
|
@@ -50899,6 +51290,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50899
51290
|
);
|
|
50900
51291
|
}
|
|
50901
51292
|
|
|
51293
|
+
/**
|
|
51294
|
+
* Get skill groups for a user
|
|
51295
|
+
*
|
|
51296
|
+
* @param {String} userId User ID
|
|
51297
|
+
* @param {Object} opts Optional parameters
|
|
51298
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
51299
|
+
* @param {String} opts.after The cursor that points to the next page
|
|
51300
|
+
* @param {String} opts.before The cursor that points to the previous page
|
|
51301
|
+
*/
|
|
51302
|
+
getUserSkillgroups(userId, opts) {
|
|
51303
|
+
opts = opts || {};
|
|
51304
|
+
|
|
51305
|
+
// verify the required parameter 'userId' is set
|
|
51306
|
+
if (userId === undefined || userId === null) {
|
|
51307
|
+
throw 'Missing the required parameter "userId" when calling getUserSkillgroups';
|
|
51308
|
+
}
|
|
51309
|
+
|
|
51310
|
+
return this.apiClient.callApi(
|
|
51311
|
+
'/api/v2/users/{userId}/skillgroups',
|
|
51312
|
+
'GET',
|
|
51313
|
+
{ 'userId': userId },
|
|
51314
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'] },
|
|
51315
|
+
{ },
|
|
51316
|
+
{ },
|
|
51317
|
+
null,
|
|
51318
|
+
['PureCloud OAuth'],
|
|
51319
|
+
['application/json'],
|
|
51320
|
+
['application/json']
|
|
51321
|
+
);
|
|
51322
|
+
}
|
|
51323
|
+
|
|
50902
51324
|
/**
|
|
50903
51325
|
* Get user state information.
|
|
50904
51326
|
*
|
|
@@ -52327,7 +52749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52327
52749
|
/**
|
|
52328
52750
|
* Utilities service.
|
|
52329
52751
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
52330
|
-
* @version
|
|
52752
|
+
* @version 160.0.0
|
|
52331
52753
|
*/
|
|
52332
52754
|
|
|
52333
52755
|
/**
|
|
@@ -52438,7 +52860,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52438
52860
|
/**
|
|
52439
52861
|
* Voicemail service.
|
|
52440
52862
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
52441
|
-
* @version
|
|
52863
|
+
* @version 160.0.0
|
|
52442
52864
|
*/
|
|
52443
52865
|
|
|
52444
52866
|
/**
|
|
@@ -53105,7 +53527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53105
53527
|
/**
|
|
53106
53528
|
* WebChat service.
|
|
53107
53529
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
53108
|
-
* @version
|
|
53530
|
+
* @version 160.0.0
|
|
53109
53531
|
*/
|
|
53110
53532
|
|
|
53111
53533
|
/**
|
|
@@ -53649,7 +54071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53649
54071
|
/**
|
|
53650
54072
|
* WebDeployments service.
|
|
53651
54073
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
53652
|
-
* @version
|
|
54074
|
+
* @version 160.0.0
|
|
53653
54075
|
*/
|
|
53654
54076
|
|
|
53655
54077
|
/**
|
|
@@ -54171,7 +54593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54171
54593
|
/**
|
|
54172
54594
|
* WebMessaging service.
|
|
54173
54595
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
54174
|
-
* @version
|
|
54596
|
+
* @version 160.0.0
|
|
54175
54597
|
*/
|
|
54176
54598
|
|
|
54177
54599
|
/**
|
|
@@ -54217,7 +54639,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54217
54639
|
/**
|
|
54218
54640
|
* Widgets service.
|
|
54219
54641
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
54220
|
-
* @version
|
|
54642
|
+
* @version 160.0.0
|
|
54221
54643
|
*/
|
|
54222
54644
|
|
|
54223
54645
|
/**
|
|
@@ -54363,7 +54785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54363
54785
|
/**
|
|
54364
54786
|
* WorkforceManagement service.
|
|
54365
54787
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
54366
|
-
* @version
|
|
54788
|
+
* @version 160.0.0
|
|
54367
54789
|
*/
|
|
54368
54790
|
|
|
54369
54791
|
/**
|
|
@@ -57398,6 +57820,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57398
57820
|
);
|
|
57399
57821
|
}
|
|
57400
57822
|
|
|
57823
|
+
/**
|
|
57824
|
+
* Get agent possible work shifts for requested time frame
|
|
57825
|
+
*
|
|
57826
|
+
* @param {Object} body body
|
|
57827
|
+
*/
|
|
57828
|
+
postWorkforcemanagementAgentsMePossibleworkshifts(body) {
|
|
57829
|
+
// verify the required parameter 'body' is set
|
|
57830
|
+
if (body === undefined || body === null) {
|
|
57831
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsMePossibleworkshifts';
|
|
57832
|
+
}
|
|
57833
|
+
|
|
57834
|
+
return this.apiClient.callApi(
|
|
57835
|
+
'/api/v2/workforcemanagement/agents/me/possibleworkshifts',
|
|
57836
|
+
'POST',
|
|
57837
|
+
{ },
|
|
57838
|
+
{ },
|
|
57839
|
+
{ },
|
|
57840
|
+
{ },
|
|
57841
|
+
body,
|
|
57842
|
+
['PureCloud OAuth'],
|
|
57843
|
+
['application/json'],
|
|
57844
|
+
['application/json']
|
|
57845
|
+
);
|
|
57846
|
+
}
|
|
57847
|
+
|
|
57401
57848
|
/**
|
|
57402
57849
|
* Get published schedule for the current user
|
|
57403
57850
|
*
|
|
@@ -59082,7 +59529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59082
59529
|
* </pre>
|
|
59083
59530
|
* </p>
|
|
59084
59531
|
* @module purecloud-platform-client-v2/index
|
|
59085
|
-
* @version
|
|
59532
|
+
* @version 160.0.0
|
|
59086
59533
|
*/
|
|
59087
59534
|
class platformClient {
|
|
59088
59535
|
constructor() {
|
|
@@ -59206,6 +59653,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59206
59653
|
* @property {module:purecloud-platform-client-v2/api/IdentityProviderApi}
|
|
59207
59654
|
*/
|
|
59208
59655
|
this.IdentityProviderApi = IdentityProviderApi;
|
|
59656
|
+
/**
|
|
59657
|
+
* The InfrastructureAsCodeApi service constructor.
|
|
59658
|
+
* @property {module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi}
|
|
59659
|
+
*/
|
|
59660
|
+
this.InfrastructureAsCodeApi = InfrastructureAsCodeApi;
|
|
59209
59661
|
/**
|
|
59210
59662
|
* The IntegrationsApi service constructor.
|
|
59211
59663
|
* @property {module:purecloud-platform-client-v2/api/IntegrationsApi}
|