purecloud-platform-client-v2 138.0.0 → 140.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 +523 -147
- package/dist/web-amd/purecloud-platform-client-v2.js +523 -147
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +523 -147
- package/dist/web-cjs/purecloud-platform-client-v2.js +523 -147
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +783 -224
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +5 -2
- 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 +15 -15
- 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 +271 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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 +28 -27
- 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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +5 -5
- 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 +111 -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/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 +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 +16 -24
- 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/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/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -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 +15 -15
- 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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -397,7 +397,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
397
397
|
|
|
398
398
|
/**
|
|
399
399
|
* @module purecloud-platform-client-v2/ApiClient
|
|
400
|
-
* @version
|
|
400
|
+
* @version 140.0.0
|
|
401
401
|
*/
|
|
402
402
|
class ApiClient {
|
|
403
403
|
/**
|
|
@@ -1150,7 +1150,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1150
1150
|
serialize(obj) {
|
|
1151
1151
|
var result = {};
|
|
1152
1152
|
for (var p in obj) {
|
|
1153
|
-
if (obj.hasOwnProperty(p)) {
|
|
1153
|
+
if (obj.hasOwnProperty(p) && obj[p] !== undefined) {
|
|
1154
1154
|
result[encodeURIComponent(p)] = Array.isArray(obj[p]) ? obj[p].join(",") : this.paramToString(obj[p]);
|
|
1155
1155
|
}
|
|
1156
1156
|
}
|
|
@@ -1287,6 +1287,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1287
1287
|
*/
|
|
1288
1288
|
buildCollectionParam(param, collectionFormat) {
|
|
1289
1289
|
if (!param) return;
|
|
1290
|
+
if (!Array.isArray(param)) {
|
|
1291
|
+
param = [param];
|
|
1292
|
+
}
|
|
1290
1293
|
|
|
1291
1294
|
switch (collectionFormat) {
|
|
1292
1295
|
case 'csv':
|
|
@@ -1472,7 +1475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1472
1475
|
/**
|
|
1473
1476
|
* Alerting service.
|
|
1474
1477
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1475
|
-
* @version
|
|
1478
|
+
* @version 140.0.0
|
|
1476
1479
|
*/
|
|
1477
1480
|
|
|
1478
1481
|
/**
|
|
@@ -1786,7 +1789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1786
1789
|
/**
|
|
1787
1790
|
* Analytics service.
|
|
1788
1791
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1789
|
-
* @version
|
|
1792
|
+
* @version 140.0.0
|
|
1790
1793
|
*/
|
|
1791
1794
|
|
|
1792
1795
|
/**
|
|
@@ -2968,7 +2971,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2968
2971
|
/**
|
|
2969
2972
|
* Architect service.
|
|
2970
2973
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2971
|
-
* @version
|
|
2974
|
+
* @version 140.0.0
|
|
2972
2975
|
*/
|
|
2973
2976
|
|
|
2974
2977
|
/**
|
|
@@ -6013,7 +6016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6013
6016
|
/**
|
|
6014
6017
|
* Audit service.
|
|
6015
6018
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6016
|
-
* @version
|
|
6019
|
+
* @version 140.0.0
|
|
6017
6020
|
*/
|
|
6018
6021
|
|
|
6019
6022
|
/**
|
|
@@ -6184,7 +6187,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6184
6187
|
/**
|
|
6185
6188
|
* Authorization service.
|
|
6186
6189
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6187
|
-
* @version
|
|
6190
|
+
* @version 140.0.0
|
|
6188
6191
|
*/
|
|
6189
6192
|
|
|
6190
6193
|
/**
|
|
@@ -6789,18 +6792,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6789
6792
|
/**
|
|
6790
6793
|
* Returns a listing of roles and permissions for a user.
|
|
6791
6794
|
*
|
|
6792
|
-
* @param {String}
|
|
6795
|
+
* @param {String} subjectId User ID
|
|
6793
6796
|
*/
|
|
6794
|
-
getUserRoles(
|
|
6795
|
-
// verify the required parameter '
|
|
6796
|
-
if (
|
|
6797
|
-
throw 'Missing the required parameter "
|
|
6797
|
+
getUserRoles(subjectId) {
|
|
6798
|
+
// verify the required parameter 'subjectId' is set
|
|
6799
|
+
if (subjectId === undefined || subjectId === null) {
|
|
6800
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
6798
6801
|
}
|
|
6799
6802
|
|
|
6800
6803
|
return this.apiClient.callApi(
|
|
6801
|
-
'/api/v2/users/{
|
|
6804
|
+
'/api/v2/users/{subjectId}/roles',
|
|
6802
6805
|
'GET',
|
|
6803
|
-
{ '
|
|
6806
|
+
{ 'subjectId': subjectId },
|
|
6804
6807
|
{ },
|
|
6805
6808
|
{ },
|
|
6806
6809
|
{ },
|
|
@@ -7334,13 +7337,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7334
7337
|
/**
|
|
7335
7338
|
* Sets the user's roles
|
|
7336
7339
|
*
|
|
7337
|
-
* @param {String}
|
|
7340
|
+
* @param {String} subjectId User ID
|
|
7338
7341
|
* @param {Array.<String>} body List of roles
|
|
7339
7342
|
*/
|
|
7340
|
-
putUserRoles(
|
|
7341
|
-
// verify the required parameter '
|
|
7342
|
-
if (
|
|
7343
|
-
throw 'Missing the required parameter "
|
|
7343
|
+
putUserRoles(subjectId, body) {
|
|
7344
|
+
// verify the required parameter 'subjectId' is set
|
|
7345
|
+
if (subjectId === undefined || subjectId === null) {
|
|
7346
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
7344
7347
|
}
|
|
7345
7348
|
// verify the required parameter 'body' is set
|
|
7346
7349
|
if (body === undefined || body === null) {
|
|
@@ -7348,9 +7351,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7348
7351
|
}
|
|
7349
7352
|
|
|
7350
7353
|
return this.apiClient.callApi(
|
|
7351
|
-
'/api/v2/users/{
|
|
7354
|
+
'/api/v2/users/{subjectId}/roles',
|
|
7352
7355
|
'PUT',
|
|
7353
|
-
{ '
|
|
7356
|
+
{ 'subjectId': subjectId },
|
|
7354
7357
|
{ },
|
|
7355
7358
|
{ },
|
|
7356
7359
|
{ },
|
|
@@ -7367,7 +7370,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7367
7370
|
/**
|
|
7368
7371
|
* Billing service.
|
|
7369
7372
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7370
|
-
* @version
|
|
7373
|
+
* @version 140.0.0
|
|
7371
7374
|
*/
|
|
7372
7375
|
|
|
7373
7376
|
/**
|
|
@@ -7447,7 +7450,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7447
7450
|
/**
|
|
7448
7451
|
* Chat service.
|
|
7449
7452
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7450
|
-
* @version
|
|
7453
|
+
* @version 140.0.0
|
|
7451
7454
|
*/
|
|
7452
7455
|
|
|
7453
7456
|
/**
|
|
@@ -7538,7 +7541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7538
7541
|
/**
|
|
7539
7542
|
* Coaching service.
|
|
7540
7543
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7541
|
-
* @version
|
|
7544
|
+
* @version 140.0.0
|
|
7542
7545
|
*/
|
|
7543
7546
|
|
|
7544
7547
|
/**
|
|
@@ -8115,7 +8118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8115
8118
|
/**
|
|
8116
8119
|
* ContentManagement service.
|
|
8117
8120
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8118
|
-
* @version
|
|
8121
|
+
* @version 140.0.0
|
|
8119
8122
|
*/
|
|
8120
8123
|
|
|
8121
8124
|
/**
|
|
@@ -9255,7 +9258,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9255
9258
|
/**
|
|
9256
9259
|
* Conversations service.
|
|
9257
9260
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9258
|
-
* @version
|
|
9261
|
+
* @version 140.0.0
|
|
9259
9262
|
*/
|
|
9260
9263
|
|
|
9261
9264
|
/**
|
|
@@ -13803,6 +13806,126 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13803
13806
|
);
|
|
13804
13807
|
}
|
|
13805
13808
|
|
|
13809
|
+
/**
|
|
13810
|
+
* Update a conversation by setting its recording state
|
|
13811
|
+
*
|
|
13812
|
+
* @param {String} conversationId conversationId
|
|
13813
|
+
* @param {Object} body SetRecordingState
|
|
13814
|
+
*/
|
|
13815
|
+
putConversationsCallRecordingstate(conversationId, body) {
|
|
13816
|
+
// verify the required parameter 'conversationId' is set
|
|
13817
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13818
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';
|
|
13819
|
+
}
|
|
13820
|
+
// verify the required parameter 'body' is set
|
|
13821
|
+
if (body === undefined || body === null) {
|
|
13822
|
+
throw 'Missing the required parameter "body" when calling putConversationsCallRecordingstate';
|
|
13823
|
+
}
|
|
13824
|
+
|
|
13825
|
+
return this.apiClient.callApi(
|
|
13826
|
+
'/api/v2/conversations/calls/{conversationId}/recordingstate',
|
|
13827
|
+
'PUT',
|
|
13828
|
+
{ 'conversationId': conversationId },
|
|
13829
|
+
{ },
|
|
13830
|
+
{ },
|
|
13831
|
+
{ },
|
|
13832
|
+
body,
|
|
13833
|
+
['PureCloud OAuth'],
|
|
13834
|
+
['application/json'],
|
|
13835
|
+
['application/json']
|
|
13836
|
+
);
|
|
13837
|
+
}
|
|
13838
|
+
|
|
13839
|
+
/**
|
|
13840
|
+
* Update a conversation by setting its recording state
|
|
13841
|
+
*
|
|
13842
|
+
* @param {String} conversationId conversationId
|
|
13843
|
+
* @param {Object} body SetRecordingState
|
|
13844
|
+
*/
|
|
13845
|
+
putConversationsCallbackRecordingstate(conversationId, body) {
|
|
13846
|
+
// verify the required parameter 'conversationId' is set
|
|
13847
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13848
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';
|
|
13849
|
+
}
|
|
13850
|
+
// verify the required parameter 'body' is set
|
|
13851
|
+
if (body === undefined || body === null) {
|
|
13852
|
+
throw 'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';
|
|
13853
|
+
}
|
|
13854
|
+
|
|
13855
|
+
return this.apiClient.callApi(
|
|
13856
|
+
'/api/v2/conversations/callbacks/{conversationId}/recordingstate',
|
|
13857
|
+
'PUT',
|
|
13858
|
+
{ 'conversationId': conversationId },
|
|
13859
|
+
{ },
|
|
13860
|
+
{ },
|
|
13861
|
+
{ },
|
|
13862
|
+
body,
|
|
13863
|
+
['PureCloud OAuth'],
|
|
13864
|
+
['application/json'],
|
|
13865
|
+
['application/json']
|
|
13866
|
+
);
|
|
13867
|
+
}
|
|
13868
|
+
|
|
13869
|
+
/**
|
|
13870
|
+
* Update a conversation by setting its recording state
|
|
13871
|
+
*
|
|
13872
|
+
* @param {String} conversationId conversationId
|
|
13873
|
+
* @param {Object} body SetRecordingState
|
|
13874
|
+
*/
|
|
13875
|
+
putConversationsChatRecordingstate(conversationId, body) {
|
|
13876
|
+
// verify the required parameter 'conversationId' is set
|
|
13877
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13878
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';
|
|
13879
|
+
}
|
|
13880
|
+
// verify the required parameter 'body' is set
|
|
13881
|
+
if (body === undefined || body === null) {
|
|
13882
|
+
throw 'Missing the required parameter "body" when calling putConversationsChatRecordingstate';
|
|
13883
|
+
}
|
|
13884
|
+
|
|
13885
|
+
return this.apiClient.callApi(
|
|
13886
|
+
'/api/v2/conversations/chats/{conversationId}/recordingstate',
|
|
13887
|
+
'PUT',
|
|
13888
|
+
{ 'conversationId': conversationId },
|
|
13889
|
+
{ },
|
|
13890
|
+
{ },
|
|
13891
|
+
{ },
|
|
13892
|
+
body,
|
|
13893
|
+
['PureCloud OAuth'],
|
|
13894
|
+
['application/json'],
|
|
13895
|
+
['application/json']
|
|
13896
|
+
);
|
|
13897
|
+
}
|
|
13898
|
+
|
|
13899
|
+
/**
|
|
13900
|
+
* Update a conversation by setting its recording state
|
|
13901
|
+
*
|
|
13902
|
+
* @param {String} conversationId conversationId
|
|
13903
|
+
* @param {Object} body SetRecordingState
|
|
13904
|
+
*/
|
|
13905
|
+
putConversationsCobrowsesessionRecordingstate(conversationId, body) {
|
|
13906
|
+
// verify the required parameter 'conversationId' is set
|
|
13907
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13908
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';
|
|
13909
|
+
}
|
|
13910
|
+
// verify the required parameter 'body' is set
|
|
13911
|
+
if (body === undefined || body === null) {
|
|
13912
|
+
throw 'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';
|
|
13913
|
+
}
|
|
13914
|
+
|
|
13915
|
+
return this.apiClient.callApi(
|
|
13916
|
+
'/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate',
|
|
13917
|
+
'PUT',
|
|
13918
|
+
{ 'conversationId': conversationId },
|
|
13919
|
+
{ },
|
|
13920
|
+
{ },
|
|
13921
|
+
{ },
|
|
13922
|
+
body,
|
|
13923
|
+
['PureCloud OAuth'],
|
|
13924
|
+
['application/json'],
|
|
13925
|
+
['application/json']
|
|
13926
|
+
);
|
|
13927
|
+
}
|
|
13928
|
+
|
|
13806
13929
|
/**
|
|
13807
13930
|
* Update conversation draft reply
|
|
13808
13931
|
*
|
|
@@ -13833,6 +13956,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13833
13956
|
);
|
|
13834
13957
|
}
|
|
13835
13958
|
|
|
13959
|
+
/**
|
|
13960
|
+
* Update a conversation by setting its recording state
|
|
13961
|
+
*
|
|
13962
|
+
* @param {String} conversationId conversationId
|
|
13963
|
+
* @param {Object} body SetRecordingState
|
|
13964
|
+
*/
|
|
13965
|
+
putConversationsEmailRecordingstate(conversationId, body) {
|
|
13966
|
+
// verify the required parameter 'conversationId' is set
|
|
13967
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13968
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';
|
|
13969
|
+
}
|
|
13970
|
+
// verify the required parameter 'body' is set
|
|
13971
|
+
if (body === undefined || body === null) {
|
|
13972
|
+
throw 'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';
|
|
13973
|
+
}
|
|
13974
|
+
|
|
13975
|
+
return this.apiClient.callApi(
|
|
13976
|
+
'/api/v2/conversations/emails/{conversationId}/recordingstate',
|
|
13977
|
+
'PUT',
|
|
13978
|
+
{ 'conversationId': conversationId },
|
|
13979
|
+
{ },
|
|
13980
|
+
{ },
|
|
13981
|
+
{ },
|
|
13982
|
+
body,
|
|
13983
|
+
['PureCloud OAuth'],
|
|
13984
|
+
['application/json'],
|
|
13985
|
+
['application/json']
|
|
13986
|
+
);
|
|
13987
|
+
}
|
|
13988
|
+
|
|
13989
|
+
/**
|
|
13990
|
+
* Update a conversation by setting its recording state
|
|
13991
|
+
*
|
|
13992
|
+
* @param {String} conversationId conversationId
|
|
13993
|
+
* @param {Object} body SetRecordingState
|
|
13994
|
+
*/
|
|
13995
|
+
putConversationsMessageRecordingstate(conversationId, body) {
|
|
13996
|
+
// verify the required parameter 'conversationId' is set
|
|
13997
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13998
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';
|
|
13999
|
+
}
|
|
14000
|
+
// verify the required parameter 'body' is set
|
|
14001
|
+
if (body === undefined || body === null) {
|
|
14002
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';
|
|
14003
|
+
}
|
|
14004
|
+
|
|
14005
|
+
return this.apiClient.callApi(
|
|
14006
|
+
'/api/v2/conversations/messages/{conversationId}/recordingstate',
|
|
14007
|
+
'PUT',
|
|
14008
|
+
{ 'conversationId': conversationId },
|
|
14009
|
+
{ },
|
|
14010
|
+
{ },
|
|
14011
|
+
{ },
|
|
14012
|
+
body,
|
|
14013
|
+
['PureCloud OAuth'],
|
|
14014
|
+
['application/json'],
|
|
14015
|
+
['application/json']
|
|
14016
|
+
);
|
|
14017
|
+
}
|
|
14018
|
+
|
|
13836
14019
|
/**
|
|
13837
14020
|
* Update a LINE messenger integration
|
|
13838
14021
|
*
|
|
@@ -13913,13 +14096,103 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13913
14096
|
);
|
|
13914
14097
|
}
|
|
13915
14098
|
|
|
14099
|
+
/**
|
|
14100
|
+
* Update a conversation by setting its recording state
|
|
14101
|
+
*
|
|
14102
|
+
* @param {String} conversationId conversationId
|
|
14103
|
+
* @param {Object} body SetRecordingState
|
|
14104
|
+
*/
|
|
14105
|
+
putConversationsScreenshareRecordingstate(conversationId, body) {
|
|
14106
|
+
// verify the required parameter 'conversationId' is set
|
|
14107
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14108
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';
|
|
14109
|
+
}
|
|
14110
|
+
// verify the required parameter 'body' is set
|
|
14111
|
+
if (body === undefined || body === null) {
|
|
14112
|
+
throw 'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';
|
|
14113
|
+
}
|
|
14114
|
+
|
|
14115
|
+
return this.apiClient.callApi(
|
|
14116
|
+
'/api/v2/conversations/screenshares/{conversationId}/recordingstate',
|
|
14117
|
+
'PUT',
|
|
14118
|
+
{ 'conversationId': conversationId },
|
|
14119
|
+
{ },
|
|
14120
|
+
{ },
|
|
14121
|
+
{ },
|
|
14122
|
+
body,
|
|
14123
|
+
['PureCloud OAuth'],
|
|
14124
|
+
['application/json'],
|
|
14125
|
+
['application/json']
|
|
14126
|
+
);
|
|
14127
|
+
}
|
|
14128
|
+
|
|
14129
|
+
/**
|
|
14130
|
+
* Update a conversation by setting its recording state
|
|
14131
|
+
*
|
|
14132
|
+
* @param {String} conversationId conversationId
|
|
14133
|
+
* @param {Object} body SetRecordingState
|
|
14134
|
+
*/
|
|
14135
|
+
putConversationsSocialRecordingstate(conversationId, body) {
|
|
14136
|
+
// verify the required parameter 'conversationId' is set
|
|
14137
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14138
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';
|
|
14139
|
+
}
|
|
14140
|
+
// verify the required parameter 'body' is set
|
|
14141
|
+
if (body === undefined || body === null) {
|
|
14142
|
+
throw 'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';
|
|
14143
|
+
}
|
|
14144
|
+
|
|
14145
|
+
return this.apiClient.callApi(
|
|
14146
|
+
'/api/v2/conversations/socials/{conversationId}/recordingstate',
|
|
14147
|
+
'PUT',
|
|
14148
|
+
{ 'conversationId': conversationId },
|
|
14149
|
+
{ },
|
|
14150
|
+
{ },
|
|
14151
|
+
{ },
|
|
14152
|
+
body,
|
|
14153
|
+
['PureCloud OAuth'],
|
|
14154
|
+
['application/json'],
|
|
14155
|
+
['application/json']
|
|
14156
|
+
);
|
|
14157
|
+
}
|
|
14158
|
+
|
|
14159
|
+
/**
|
|
14160
|
+
* Update a conversation by setting its recording state
|
|
14161
|
+
*
|
|
14162
|
+
* @param {String} conversationId conversationId
|
|
14163
|
+
* @param {Object} body SetRecordingState
|
|
14164
|
+
*/
|
|
14165
|
+
putConversationsVideoRecordingstate(conversationId, body) {
|
|
14166
|
+
// verify the required parameter 'conversationId' is set
|
|
14167
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14168
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';
|
|
14169
|
+
}
|
|
14170
|
+
// verify the required parameter 'body' is set
|
|
14171
|
+
if (body === undefined || body === null) {
|
|
14172
|
+
throw 'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';
|
|
14173
|
+
}
|
|
14174
|
+
|
|
14175
|
+
return this.apiClient.callApi(
|
|
14176
|
+
'/api/v2/conversations/videos/{conversationId}/recordingstate',
|
|
14177
|
+
'PUT',
|
|
14178
|
+
{ 'conversationId': conversationId },
|
|
14179
|
+
{ },
|
|
14180
|
+
{ },
|
|
14181
|
+
{ },
|
|
14182
|
+
body,
|
|
14183
|
+
['PureCloud OAuth'],
|
|
14184
|
+
['application/json'],
|
|
14185
|
+
['application/json']
|
|
14186
|
+
);
|
|
14187
|
+
}
|
|
14188
|
+
|
|
13916
14189
|
}
|
|
13917
14190
|
|
|
13918
14191
|
class DataExtensionsApi {
|
|
13919
14192
|
/**
|
|
13920
14193
|
* DataExtensions service.
|
|
13921
14194
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13922
|
-
* @version
|
|
14195
|
+
* @version 140.0.0
|
|
13923
14196
|
*/
|
|
13924
14197
|
|
|
13925
14198
|
/**
|
|
@@ -14005,7 +14278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14005
14278
|
/**
|
|
14006
14279
|
* ExternalContacts service.
|
|
14007
14280
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14008
|
-
* @version
|
|
14281
|
+
* @version 140.0.0
|
|
14009
14282
|
*/
|
|
14010
14283
|
|
|
14011
14284
|
/**
|
|
@@ -15748,7 +16021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15748
16021
|
/**
|
|
15749
16022
|
* Fax service.
|
|
15750
16023
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15751
|
-
* @version
|
|
16024
|
+
* @version 140.0.0
|
|
15752
16025
|
*/
|
|
15753
16026
|
|
|
15754
16027
|
/**
|
|
@@ -15919,7 +16192,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15919
16192
|
/**
|
|
15920
16193
|
* Flows service.
|
|
15921
16194
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15922
|
-
* @version
|
|
16195
|
+
* @version 140.0.0
|
|
15923
16196
|
*/
|
|
15924
16197
|
|
|
15925
16198
|
/**
|
|
@@ -15990,7 +16263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15990
16263
|
/**
|
|
15991
16264
|
* Gamification service.
|
|
15992
16265
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15993
|
-
* @version
|
|
16266
|
+
* @version 140.0.0
|
|
15994
16267
|
*/
|
|
15995
16268
|
|
|
15996
16269
|
/**
|
|
@@ -16135,7 +16408,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16135
16408
|
|
|
16136
16409
|
/**
|
|
16137
16410
|
* Gamified metric by id
|
|
16138
|
-
*
|
|
16411
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
16139
16412
|
* @param {String} metricId metric Id
|
|
16140
16413
|
* @param {Object} opts Optional parameters
|
|
16141
16414
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
@@ -16210,7 +16483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16210
16483
|
|
|
16211
16484
|
/**
|
|
16212
16485
|
* All gamified metrics for a given profile
|
|
16213
|
-
*
|
|
16486
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
16214
16487
|
* @param {Object} opts Optional parameters
|
|
16215
16488
|
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
16216
16489
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
@@ -16261,18 +16534,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16261
16534
|
/**
|
|
16262
16535
|
* Members of a given performance profile
|
|
16263
16536
|
*
|
|
16264
|
-
* @param {String}
|
|
16537
|
+
* @param {String} profileId Profile Id
|
|
16265
16538
|
*/
|
|
16266
|
-
getGamificationProfileMembers(
|
|
16267
|
-
// verify the required parameter '
|
|
16268
|
-
if (
|
|
16269
|
-
throw 'Missing the required parameter "
|
|
16539
|
+
getGamificationProfileMembers(profileId) {
|
|
16540
|
+
// verify the required parameter 'profileId' is set
|
|
16541
|
+
if (profileId === undefined || profileId === null) {
|
|
16542
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
|
|
16270
16543
|
}
|
|
16271
16544
|
|
|
16272
16545
|
return this.apiClient.callApi(
|
|
16273
|
-
'/api/v2/gamification/profiles/{
|
|
16546
|
+
'/api/v2/gamification/profiles/{profileId}/members',
|
|
16274
16547
|
'GET',
|
|
16275
|
-
{ '
|
|
16548
|
+
{ 'profileId': profileId },
|
|
16276
16549
|
{ },
|
|
16277
16550
|
{ },
|
|
16278
16551
|
{ },
|
|
@@ -16324,6 +16597,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16324
16597
|
* @param {Object} opts Optional parameters
|
|
16325
16598
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
16326
16599
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16600
|
+
* @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
|
|
16327
16601
|
*/
|
|
16328
16602
|
getGamificationProfileMetrics(profileId, opts) {
|
|
16329
16603
|
opts = opts || {};
|
|
@@ -16337,7 +16611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16337
16611
|
'/api/v2/gamification/profiles/{profileId}/metrics',
|
|
16338
16612
|
'GET',
|
|
16339
16613
|
{ 'profileId': profileId },
|
|
16340
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
|
|
16614
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
|
|
16341
16615
|
{ },
|
|
16342
16616
|
{ },
|
|
16343
16617
|
null,
|
|
@@ -17064,7 +17338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17064
17338
|
|
|
17065
17339
|
/**
|
|
17066
17340
|
* Creates a gamified metric with a given metric definition and metric objective
|
|
17067
|
-
*
|
|
17341
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
17068
17342
|
* @param {Object} body Metric
|
|
17069
17343
|
*/
|
|
17070
17344
|
postGamificationMetrics(body) {
|
|
@@ -17140,13 +17414,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17140
17414
|
/**
|
|
17141
17415
|
* Assign members to a given performance profile
|
|
17142
17416
|
*
|
|
17143
|
-
* @param {String}
|
|
17417
|
+
* @param {String} profileId Profile Id
|
|
17144
17418
|
* @param {Object} body assignUsers
|
|
17145
17419
|
*/
|
|
17146
|
-
postGamificationProfileMembers(
|
|
17147
|
-
// verify the required parameter '
|
|
17148
|
-
if (
|
|
17149
|
-
throw 'Missing the required parameter "
|
|
17420
|
+
postGamificationProfileMembers(profileId, body) {
|
|
17421
|
+
// verify the required parameter 'profileId' is set
|
|
17422
|
+
if (profileId === undefined || profileId === null) {
|
|
17423
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
|
|
17150
17424
|
}
|
|
17151
17425
|
// verify the required parameter 'body' is set
|
|
17152
17426
|
if (body === undefined || body === null) {
|
|
@@ -17154,9 +17428,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17154
17428
|
}
|
|
17155
17429
|
|
|
17156
17430
|
return this.apiClient.callApi(
|
|
17157
|
-
'/api/v2/gamification/profiles/{
|
|
17431
|
+
'/api/v2/gamification/profiles/{profileId}/members',
|
|
17158
17432
|
'POST',
|
|
17159
|
-
{ '
|
|
17433
|
+
{ 'profileId': profileId },
|
|
17160
17434
|
{ },
|
|
17161
17435
|
{ },
|
|
17162
17436
|
{ },
|
|
@@ -17170,13 +17444,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17170
17444
|
/**
|
|
17171
17445
|
* Validate member assignment
|
|
17172
17446
|
*
|
|
17173
|
-
* @param {String}
|
|
17447
|
+
* @param {String} profileId Profile Id
|
|
17174
17448
|
* @param {Object} body memberAssignments
|
|
17175
17449
|
*/
|
|
17176
|
-
postGamificationProfileMembersValidate(
|
|
17177
|
-
// verify the required parameter '
|
|
17178
|
-
if (
|
|
17179
|
-
throw 'Missing the required parameter "
|
|
17450
|
+
postGamificationProfileMembersValidate(profileId, body) {
|
|
17451
|
+
// verify the required parameter 'profileId' is set
|
|
17452
|
+
if (profileId === undefined || profileId === null) {
|
|
17453
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
|
|
17180
17454
|
}
|
|
17181
17455
|
// verify the required parameter 'body' is set
|
|
17182
17456
|
if (body === undefined || body === null) {
|
|
@@ -17184,9 +17458,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17184
17458
|
}
|
|
17185
17459
|
|
|
17186
17460
|
return this.apiClient.callApi(
|
|
17187
|
-
'/api/v2/gamification/profiles/{
|
|
17461
|
+
'/api/v2/gamification/profiles/{profileId}/members/validate',
|
|
17188
17462
|
'POST',
|
|
17189
|
-
{ '
|
|
17463
|
+
{ 'profileId': profileId },
|
|
17190
17464
|
{ },
|
|
17191
17465
|
{ },
|
|
17192
17466
|
{ },
|
|
@@ -17293,7 +17567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17293
17567
|
|
|
17294
17568
|
/**
|
|
17295
17569
|
* Updates a metric
|
|
17296
|
-
*
|
|
17570
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
17297
17571
|
* @param {String} metricId metric Id
|
|
17298
17572
|
* @param {Object} body Metric
|
|
17299
17573
|
* @param {Object} opts Optional parameters
|
|
@@ -17420,7 +17694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17420
17694
|
/**
|
|
17421
17695
|
* GeneralDataProtectionRegulation service.
|
|
17422
17696
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17423
|
-
* @version
|
|
17697
|
+
* @version 140.0.0
|
|
17424
17698
|
*/
|
|
17425
17699
|
|
|
17426
17700
|
/**
|
|
@@ -17550,7 +17824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17550
17824
|
/**
|
|
17551
17825
|
* Geolocation service.
|
|
17552
17826
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17553
|
-
* @version
|
|
17827
|
+
* @version 140.0.0
|
|
17554
17828
|
*/
|
|
17555
17829
|
|
|
17556
17830
|
/**
|
|
@@ -17681,7 +17955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17681
17955
|
/**
|
|
17682
17956
|
* Greetings service.
|
|
17683
17957
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17684
|
-
* @version
|
|
17958
|
+
* @version 140.0.0
|
|
17685
17959
|
*/
|
|
17686
17960
|
|
|
17687
17961
|
/**
|
|
@@ -18136,7 +18410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18136
18410
|
/**
|
|
18137
18411
|
* Groups service.
|
|
18138
18412
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18139
|
-
* @version
|
|
18413
|
+
* @version 140.0.0
|
|
18140
18414
|
*/
|
|
18141
18415
|
|
|
18142
18416
|
/**
|
|
@@ -18541,7 +18815,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18541
18815
|
/**
|
|
18542
18816
|
* IdentityProvider service.
|
|
18543
18817
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18544
|
-
* @version
|
|
18818
|
+
* @version 140.0.0
|
|
18545
18819
|
*/
|
|
18546
18820
|
|
|
18547
18821
|
/**
|
|
@@ -19297,7 +19571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19297
19571
|
/**
|
|
19298
19572
|
* Integrations service.
|
|
19299
19573
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19300
|
-
* @version
|
|
19574
|
+
* @version 140.0.0
|
|
19301
19575
|
*/
|
|
19302
19576
|
|
|
19303
19577
|
/**
|
|
@@ -20974,7 +21248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20974
21248
|
/**
|
|
20975
21249
|
* Journey service.
|
|
20976
21250
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20977
|
-
* @version
|
|
21251
|
+
* @version 140.0.0
|
|
20978
21252
|
*/
|
|
20979
21253
|
|
|
20980
21254
|
/**
|
|
@@ -21685,7 +21959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21685
21959
|
/**
|
|
21686
21960
|
* Knowledge service.
|
|
21687
21961
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21688
|
-
* @version
|
|
21962
|
+
* @version 140.0.0
|
|
21689
21963
|
*/
|
|
21690
21964
|
|
|
21691
21965
|
/**
|
|
@@ -21863,7 +22137,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21863
22137
|
* @param {Object} opts Optional parameters
|
|
21864
22138
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
21865
22139
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
21866
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22140
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
21867
22141
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
21868
22142
|
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
21869
22143
|
*/
|
|
@@ -21971,7 +22245,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21971
22245
|
* @param {Object} opts Optional parameters
|
|
21972
22246
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
21973
22247
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
21974
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22248
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
21975
22249
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
21976
22250
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
21977
22251
|
* @param {String} opts.title Filter by document title.
|
|
@@ -22083,7 +22357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22083
22357
|
* @param {Object} opts Optional parameters
|
|
22084
22358
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22085
22359
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22086
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22360
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22087
22361
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22088
22362
|
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
22089
22363
|
*/
|
|
@@ -22119,7 +22393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22119
22393
|
* @param {Object} opts Optional parameters
|
|
22120
22394
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22121
22395
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22122
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22396
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22123
22397
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22124
22398
|
* @param {String} opts.name Filter by Name.
|
|
22125
22399
|
* @param {Object} opts.coreLanguage Filter by core language.
|
|
@@ -22585,7 +22859,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22585
22859
|
/**
|
|
22586
22860
|
* LanguageUnderstanding service.
|
|
22587
22861
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22588
|
-
* @version
|
|
22862
|
+
* @version 140.0.0
|
|
22589
22863
|
*/
|
|
22590
22864
|
|
|
22591
22865
|
/**
|
|
@@ -23489,7 +23763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23489
23763
|
/**
|
|
23490
23764
|
* Languages service.
|
|
23491
23765
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23492
|
-
* @version
|
|
23766
|
+
* @version 140.0.0
|
|
23493
23767
|
*/
|
|
23494
23768
|
|
|
23495
23769
|
/**
|
|
@@ -23757,7 +24031,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23757
24031
|
/**
|
|
23758
24032
|
* Learning service.
|
|
23759
24033
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23760
|
-
* @version
|
|
24034
|
+
* @version 140.0.0
|
|
23761
24035
|
*/
|
|
23762
24036
|
|
|
23763
24037
|
/**
|
|
@@ -23955,6 +24229,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23955
24229
|
);
|
|
23956
24230
|
}
|
|
23957
24231
|
|
|
24232
|
+
/**
|
|
24233
|
+
* Get a specific Learning Module job status
|
|
24234
|
+
*
|
|
24235
|
+
* @param {String} moduleId The ID of the learning module
|
|
24236
|
+
* @param {String} jobId The ID of the learning module job
|
|
24237
|
+
*/
|
|
24238
|
+
getLearningModuleJob(moduleId, jobId) {
|
|
24239
|
+
// verify the required parameter 'moduleId' is set
|
|
24240
|
+
if (moduleId === undefined || moduleId === null) {
|
|
24241
|
+
throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
|
|
24242
|
+
}
|
|
24243
|
+
// verify the required parameter 'jobId' is set
|
|
24244
|
+
if (jobId === undefined || jobId === null) {
|
|
24245
|
+
throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
|
|
24246
|
+
}
|
|
24247
|
+
|
|
24248
|
+
return this.apiClient.callApi(
|
|
24249
|
+
'/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
|
|
24250
|
+
'GET',
|
|
24251
|
+
{ 'moduleId': moduleId,'jobId': jobId },
|
|
24252
|
+
{ },
|
|
24253
|
+
{ },
|
|
24254
|
+
{ },
|
|
24255
|
+
null,
|
|
24256
|
+
['PureCloud OAuth'],
|
|
24257
|
+
['application/json'],
|
|
24258
|
+
['application/json']
|
|
24259
|
+
);
|
|
24260
|
+
}
|
|
24261
|
+
|
|
23958
24262
|
/**
|
|
23959
24263
|
* Get a learning module rule
|
|
23960
24264
|
*
|
|
@@ -24100,6 +24404,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24100
24404
|
);
|
|
24101
24405
|
}
|
|
24102
24406
|
|
|
24407
|
+
/**
|
|
24408
|
+
* Reassign Learning Assignment
|
|
24409
|
+
* This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
|
|
24410
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
24411
|
+
*/
|
|
24412
|
+
postLearningAssignmentReassign(assignmentId) {
|
|
24413
|
+
// verify the required parameter 'assignmentId' is set
|
|
24414
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
24415
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
|
|
24416
|
+
}
|
|
24417
|
+
|
|
24418
|
+
return this.apiClient.callApi(
|
|
24419
|
+
'/api/v2/learning/assignments/{assignmentId}/reassign',
|
|
24420
|
+
'POST',
|
|
24421
|
+
{ 'assignmentId': assignmentId },
|
|
24422
|
+
{ },
|
|
24423
|
+
{ },
|
|
24424
|
+
{ },
|
|
24425
|
+
null,
|
|
24426
|
+
['PureCloud OAuth'],
|
|
24427
|
+
['application/json'],
|
|
24428
|
+
['application/json']
|
|
24429
|
+
);
|
|
24430
|
+
}
|
|
24431
|
+
|
|
24432
|
+
/**
|
|
24433
|
+
* Reset Learning Assignment
|
|
24434
|
+
* This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
|
|
24435
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
24436
|
+
*/
|
|
24437
|
+
postLearningAssignmentReset(assignmentId) {
|
|
24438
|
+
// verify the required parameter 'assignmentId' is set
|
|
24439
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
24440
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
|
|
24441
|
+
}
|
|
24442
|
+
|
|
24443
|
+
return this.apiClient.callApi(
|
|
24444
|
+
'/api/v2/learning/assignments/{assignmentId}/reset',
|
|
24445
|
+
'POST',
|
|
24446
|
+
{ 'assignmentId': assignmentId },
|
|
24447
|
+
{ },
|
|
24448
|
+
{ },
|
|
24449
|
+
{ },
|
|
24450
|
+
null,
|
|
24451
|
+
['PureCloud OAuth'],
|
|
24452
|
+
['application/json'],
|
|
24453
|
+
['application/json']
|
|
24454
|
+
);
|
|
24455
|
+
}
|
|
24456
|
+
|
|
24103
24457
|
/**
|
|
24104
24458
|
* Create Learning Assignment
|
|
24105
24459
|
*
|
|
@@ -24197,6 +24551,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24197
24551
|
);
|
|
24198
24552
|
}
|
|
24199
24553
|
|
|
24554
|
+
/**
|
|
24555
|
+
* Starts a specified operation on learning module
|
|
24556
|
+
* This will initiate operation specified in the request body for a learning module
|
|
24557
|
+
* @param {String} moduleId The ID of the learning module
|
|
24558
|
+
* @param {Object} body The learning module job request
|
|
24559
|
+
*/
|
|
24560
|
+
postLearningModuleJobs(moduleId, body) {
|
|
24561
|
+
// verify the required parameter 'moduleId' is set
|
|
24562
|
+
if (moduleId === undefined || moduleId === null) {
|
|
24563
|
+
throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
|
|
24564
|
+
}
|
|
24565
|
+
// verify the required parameter 'body' is set
|
|
24566
|
+
if (body === undefined || body === null) {
|
|
24567
|
+
throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
|
|
24568
|
+
}
|
|
24569
|
+
|
|
24570
|
+
return this.apiClient.callApi(
|
|
24571
|
+
'/api/v2/learning/modules/{moduleId}/jobs',
|
|
24572
|
+
'POST',
|
|
24573
|
+
{ 'moduleId': moduleId },
|
|
24574
|
+
{ },
|
|
24575
|
+
{ },
|
|
24576
|
+
{ },
|
|
24577
|
+
body,
|
|
24578
|
+
['PureCloud OAuth'],
|
|
24579
|
+
['application/json'],
|
|
24580
|
+
['application/json']
|
|
24581
|
+
);
|
|
24582
|
+
}
|
|
24583
|
+
|
|
24200
24584
|
/**
|
|
24201
24585
|
* Publish a Learning module
|
|
24202
24586
|
*
|
|
@@ -24348,7 +24732,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24348
24732
|
/**
|
|
24349
24733
|
* License service.
|
|
24350
24734
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24351
|
-
* @version
|
|
24735
|
+
* @version 140.0.0
|
|
24352
24736
|
*/
|
|
24353
24737
|
|
|
24354
24738
|
/**
|
|
@@ -24586,7 +24970,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24586
24970
|
/**
|
|
24587
24971
|
* Locations service.
|
|
24588
24972
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24589
|
-
* @version
|
|
24973
|
+
* @version 140.0.0
|
|
24590
24974
|
*/
|
|
24591
24975
|
|
|
24592
24976
|
/**
|
|
@@ -24822,7 +25206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24822
25206
|
/**
|
|
24823
25207
|
* Messaging service.
|
|
24824
25208
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24825
|
-
* @version
|
|
25209
|
+
* @version 140.0.0
|
|
24826
25210
|
*/
|
|
24827
25211
|
|
|
24828
25212
|
/**
|
|
@@ -24973,7 +25357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24973
25357
|
/**
|
|
24974
25358
|
* MobileDevices service.
|
|
24975
25359
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24976
|
-
* @version
|
|
25360
|
+
* @version 140.0.0
|
|
24977
25361
|
*/
|
|
24978
25362
|
|
|
24979
25363
|
/**
|
|
@@ -25124,7 +25508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25124
25508
|
/**
|
|
25125
25509
|
* Notifications service.
|
|
25126
25510
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25127
|
-
* @version
|
|
25511
|
+
* @version 140.0.0
|
|
25128
25512
|
*/
|
|
25129
25513
|
|
|
25130
25514
|
/**
|
|
@@ -25349,7 +25733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25349
25733
|
/**
|
|
25350
25734
|
* OAuth service.
|
|
25351
25735
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25352
|
-
* @version
|
|
25736
|
+
* @version 140.0.0
|
|
25353
25737
|
*/
|
|
25354
25738
|
|
|
25355
25739
|
/**
|
|
@@ -25715,7 +26099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25715
26099
|
/**
|
|
25716
26100
|
* Objects service.
|
|
25717
26101
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25718
|
-
* @version
|
|
26102
|
+
* @version 140.0.0
|
|
25719
26103
|
*/
|
|
25720
26104
|
|
|
25721
26105
|
/**
|
|
@@ -25986,7 +26370,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25986
26370
|
/**
|
|
25987
26371
|
* Organization service.
|
|
25988
26372
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25989
|
-
* @version
|
|
26373
|
+
* @version 140.0.0
|
|
25990
26374
|
*/
|
|
25991
26375
|
|
|
25992
26376
|
/**
|
|
@@ -26389,7 +26773,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26389
26773
|
/**
|
|
26390
26774
|
* OrganizationAuthorization service.
|
|
26391
26775
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26392
|
-
* @version
|
|
26776
|
+
* @version 140.0.0
|
|
26393
26777
|
*/
|
|
26394
26778
|
|
|
26395
26779
|
/**
|
|
@@ -27314,7 +27698,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27314
27698
|
/**
|
|
27315
27699
|
* Outbound service.
|
|
27316
27700
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27317
|
-
* @version
|
|
27701
|
+
* @version 140.0.0
|
|
27318
27702
|
*/
|
|
27319
27703
|
|
|
27320
27704
|
/**
|
|
@@ -30569,7 +30953,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30569
30953
|
/**
|
|
30570
30954
|
* Presence service.
|
|
30571
30955
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30572
|
-
* @version
|
|
30956
|
+
* @version 140.0.0
|
|
30573
30957
|
*/
|
|
30574
30958
|
|
|
30575
30959
|
/**
|
|
@@ -30891,7 +31275,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30891
31275
|
/**
|
|
30892
31276
|
* Quality service.
|
|
30893
31277
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30894
|
-
* @version
|
|
31278
|
+
* @version 140.0.0
|
|
30895
31279
|
*/
|
|
30896
31280
|
|
|
30897
31281
|
/**
|
|
@@ -31649,7 +32033,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31649
32033
|
/**
|
|
31650
32034
|
* Retrieve a list of the latest form versions by context ids
|
|
31651
32035
|
*
|
|
31652
|
-
* @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
|
|
32036
|
+
* @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.
|
|
31653
32037
|
* @param {Object} opts Optional parameters
|
|
31654
32038
|
* @param {Boolean} opts.published If true, the latest published version will be included. If false, only the unpublished version will be included. (default to true)
|
|
31655
32039
|
*/
|
|
@@ -32469,7 +32853,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32469
32853
|
/**
|
|
32470
32854
|
* Recording service.
|
|
32471
32855
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32472
|
-
* @version
|
|
32856
|
+
* @version 140.0.0
|
|
32473
32857
|
*/
|
|
32474
32858
|
|
|
32475
32859
|
/**
|
|
@@ -34122,7 +34506,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34122
34506
|
/**
|
|
34123
34507
|
* ResponseManagement service.
|
|
34124
34508
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34125
|
-
* @version
|
|
34509
|
+
* @version 140.0.0
|
|
34126
34510
|
*/
|
|
34127
34511
|
|
|
34128
34512
|
/**
|
|
@@ -34606,7 +34990,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34606
34990
|
/**
|
|
34607
34991
|
* Routing service.
|
|
34608
34992
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34609
|
-
* @version
|
|
34993
|
+
* @version 140.0.0
|
|
34610
34994
|
*/
|
|
34611
34995
|
|
|
34612
34996
|
/**
|
|
@@ -34919,12 +35303,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34919
35303
|
* Delete a phone number provisioned for SMS.
|
|
34920
35304
|
*
|
|
34921
35305
|
* @param {String} addressId Address ID
|
|
34922
|
-
* @param {Object} opts Optional parameters
|
|
34923
|
-
* @param {Boolean} opts.async Delete a phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the deletion of a provisioned phone number. (default to false)
|
|
34924
35306
|
*/
|
|
34925
|
-
deleteRoutingSmsPhonenumber(addressId
|
|
34926
|
-
opts = opts || {};
|
|
34927
|
-
|
|
35307
|
+
deleteRoutingSmsPhonenumber(addressId) {
|
|
34928
35308
|
// verify the required parameter 'addressId' is set
|
|
34929
35309
|
if (addressId === undefined || addressId === null) {
|
|
34930
35310
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -34934,7 +35314,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34934
35314
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
34935
35315
|
'DELETE',
|
|
34936
35316
|
{ 'addressId': addressId },
|
|
34937
|
-
{
|
|
35317
|
+
{ },
|
|
34938
35318
|
{ },
|
|
34939
35319
|
{ },
|
|
34940
35320
|
null,
|
|
@@ -35105,7 +35485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35105
35485
|
* @param {Object} opts Optional parameters
|
|
35106
35486
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
35107
35487
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35108
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
35488
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
35109
35489
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35110
35490
|
* @param {Array.<String>} opts.queueId Queue ID(s) to filter assessments by.
|
|
35111
35491
|
*/
|
|
@@ -35416,7 +35796,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35416
35796
|
* @param {Object} opts Optional parameters
|
|
35417
35797
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
35418
35798
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35419
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
35799
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
35420
35800
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35421
35801
|
* @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
|
|
35422
35802
|
*/
|
|
@@ -35439,16 +35819,20 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35439
35819
|
}
|
|
35440
35820
|
|
|
35441
35821
|
/**
|
|
35442
|
-
* Get a list of Key Performance Indicators
|
|
35822
|
+
* Get a list of Key Performance Indicators
|
|
35443
35823
|
*
|
|
35824
|
+
* @param {Object} opts Optional parameters
|
|
35825
|
+
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
35444
35826
|
*/
|
|
35445
|
-
getRoutingPredictorsKeyperformanceindicators() {
|
|
35827
|
+
getRoutingPredictorsKeyperformanceindicators(opts) {
|
|
35828
|
+
opts = opts || {};
|
|
35829
|
+
|
|
35446
35830
|
|
|
35447
35831
|
return this.apiClient.callApi(
|
|
35448
35832
|
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
35449
35833
|
'GET',
|
|
35450
35834
|
{ },
|
|
35451
|
-
{
|
|
35835
|
+
{ 'kpiGroup': opts['kpiGroup'] },
|
|
35452
35836
|
{ },
|
|
35453
35837
|
{ },
|
|
35454
35838
|
null,
|
|
@@ -37088,12 +37472,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37088
37472
|
* Provision a phone number for SMS
|
|
37089
37473
|
*
|
|
37090
37474
|
* @param {Object} body SmsPhoneNumber
|
|
37091
|
-
* @param {Object} opts Optional parameters
|
|
37092
|
-
* @param {Boolean} opts.async Provision a new phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the provisioning of a new phone number. Check the phoneNumber's provisioningStatus for completion of this request. (default to false)
|
|
37093
37475
|
*/
|
|
37094
|
-
postRoutingSmsPhonenumbers(body
|
|
37095
|
-
opts = opts || {};
|
|
37096
|
-
|
|
37476
|
+
postRoutingSmsPhonenumbers(body) {
|
|
37097
37477
|
// verify the required parameter 'body' is set
|
|
37098
37478
|
if (body === undefined || body === null) {
|
|
37099
37479
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -37103,7 +37483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37103
37483
|
'/api/v2/routing/sms/phonenumbers',
|
|
37104
37484
|
'POST',
|
|
37105
37485
|
{ },
|
|
37106
|
-
{
|
|
37486
|
+
{ },
|
|
37107
37487
|
{ },
|
|
37108
37488
|
{ },
|
|
37109
37489
|
body,
|
|
@@ -37348,12 +37728,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37348
37728
|
*
|
|
37349
37729
|
* @param {String} addressId Address ID
|
|
37350
37730
|
* @param {Object} body SmsPhoneNumber
|
|
37351
|
-
* @param {Object} opts Optional parameters
|
|
37352
|
-
* @param {Boolean} opts.async Update an existing phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the update of a provisioned phone number. Check the phoneNumber's provisioningStatus for the progress of this request. (default to false)
|
|
37353
37731
|
*/
|
|
37354
|
-
putRoutingSmsPhonenumber(addressId, body
|
|
37355
|
-
opts = opts || {};
|
|
37356
|
-
|
|
37732
|
+
putRoutingSmsPhonenumber(addressId, body) {
|
|
37357
37733
|
// verify the required parameter 'addressId' is set
|
|
37358
37734
|
if (addressId === undefined || addressId === null) {
|
|
37359
37735
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -37367,7 +37743,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37367
37743
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
37368
37744
|
'PUT',
|
|
37369
37745
|
{ 'addressId': addressId },
|
|
37370
|
-
{
|
|
37746
|
+
{ },
|
|
37371
37747
|
{ },
|
|
37372
37748
|
{ },
|
|
37373
37749
|
body,
|
|
@@ -37533,7 +37909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37533
37909
|
/**
|
|
37534
37910
|
* SCIM service.
|
|
37535
37911
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37536
|
-
* @version
|
|
37912
|
+
* @version 140.0.0
|
|
37537
37913
|
*/
|
|
37538
37914
|
|
|
37539
37915
|
/**
|
|
@@ -38410,7 +38786,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38410
38786
|
/**
|
|
38411
38787
|
* Scripts service.
|
|
38412
38788
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38413
|
-
* @version
|
|
38789
|
+
* @version 140.0.0
|
|
38414
38790
|
*/
|
|
38415
38791
|
|
|
38416
38792
|
/**
|
|
@@ -38829,7 +39205,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38829
39205
|
/**
|
|
38830
39206
|
* Search service.
|
|
38831
39207
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38832
|
-
* @version
|
|
39208
|
+
* @version 140.0.0
|
|
38833
39209
|
*/
|
|
38834
39210
|
|
|
38835
39211
|
/**
|
|
@@ -39364,7 +39740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39364
39740
|
/**
|
|
39365
39741
|
* SpeechTextAnalytics service.
|
|
39366
39742
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39367
|
-
* @version
|
|
39743
|
+
* @version 140.0.0
|
|
39368
39744
|
*/
|
|
39369
39745
|
|
|
39370
39746
|
/**
|
|
@@ -40217,7 +40593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40217
40593
|
/**
|
|
40218
40594
|
* Stations service.
|
|
40219
40595
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40220
|
-
* @version
|
|
40596
|
+
* @version 140.0.0
|
|
40221
40597
|
*/
|
|
40222
40598
|
|
|
40223
40599
|
/**
|
|
@@ -40364,7 +40740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40364
40740
|
/**
|
|
40365
40741
|
* Suggest service.
|
|
40366
40742
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40367
|
-
* @version
|
|
40743
|
+
* @version 140.0.0
|
|
40368
40744
|
*/
|
|
40369
40745
|
|
|
40370
40746
|
/**
|
|
@@ -40503,7 +40879,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40503
40879
|
/**
|
|
40504
40880
|
* Telephony service.
|
|
40505
40881
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40506
|
-
* @version
|
|
40882
|
+
* @version 140.0.0
|
|
40507
40883
|
*/
|
|
40508
40884
|
|
|
40509
40885
|
/**
|
|
@@ -40611,7 +40987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40611
40987
|
/**
|
|
40612
40988
|
* TelephonyProvidersEdge service.
|
|
40613
40989
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40614
|
-
* @version
|
|
40990
|
+
* @version 140.0.0
|
|
40615
40991
|
*/
|
|
40616
40992
|
|
|
40617
40993
|
/**
|
|
@@ -44244,7 +44620,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44244
44620
|
/**
|
|
44245
44621
|
* Textbots service.
|
|
44246
44622
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44247
|
-
* @version
|
|
44623
|
+
* @version 140.0.0
|
|
44248
44624
|
*/
|
|
44249
44625
|
|
|
44250
44626
|
/**
|
|
@@ -44372,7 +44748,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44372
44748
|
/**
|
|
44373
44749
|
* Tokens service.
|
|
44374
44750
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44375
|
-
* @version
|
|
44751
|
+
* @version 140.0.0
|
|
44376
44752
|
*/
|
|
44377
44753
|
|
|
44378
44754
|
/**
|
|
@@ -44478,7 +44854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44478
44854
|
/**
|
|
44479
44855
|
* Uploads service.
|
|
44480
44856
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44481
|
-
* @version
|
|
44857
|
+
* @version 140.0.0
|
|
44482
44858
|
*/
|
|
44483
44859
|
|
|
44484
44860
|
/**
|
|
@@ -44629,7 +45005,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44629
45005
|
/**
|
|
44630
45006
|
* Usage service.
|
|
44631
45007
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44632
|
-
* @version
|
|
45008
|
+
* @version 140.0.0
|
|
44633
45009
|
*/
|
|
44634
45010
|
|
|
44635
45011
|
/**
|
|
@@ -44700,7 +45076,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44700
45076
|
/**
|
|
44701
45077
|
* UserRecordings service.
|
|
44702
45078
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44703
|
-
* @version
|
|
45079
|
+
* @version 140.0.0
|
|
44704
45080
|
*/
|
|
44705
45081
|
|
|
44706
45082
|
/**
|
|
@@ -44884,7 +45260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44884
45260
|
/**
|
|
44885
45261
|
* Users service.
|
|
44886
45262
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44887
|
-
* @version
|
|
45263
|
+
* @version 140.0.0
|
|
44888
45264
|
*/
|
|
44889
45265
|
|
|
44890
45266
|
/**
|
|
@@ -45704,18 +46080,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45704
46080
|
/**
|
|
45705
46081
|
* Returns a listing of roles and permissions for a user.
|
|
45706
46082
|
*
|
|
45707
|
-
* @param {String}
|
|
46083
|
+
* @param {String} subjectId User ID
|
|
45708
46084
|
*/
|
|
45709
|
-
getUserRoles(
|
|
45710
|
-
// verify the required parameter '
|
|
45711
|
-
if (
|
|
45712
|
-
throw 'Missing the required parameter "
|
|
46085
|
+
getUserRoles(subjectId) {
|
|
46086
|
+
// verify the required parameter 'subjectId' is set
|
|
46087
|
+
if (subjectId === undefined || subjectId === null) {
|
|
46088
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
45713
46089
|
}
|
|
45714
46090
|
|
|
45715
46091
|
return this.apiClient.callApi(
|
|
45716
|
-
'/api/v2/users/{
|
|
46092
|
+
'/api/v2/users/{subjectId}/roles',
|
|
45717
46093
|
'GET',
|
|
45718
|
-
{ '
|
|
46094
|
+
{ 'subjectId': subjectId },
|
|
45719
46095
|
{ },
|
|
45720
46096
|
{ },
|
|
45721
46097
|
{ },
|
|
@@ -46968,13 +47344,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46968
47344
|
/**
|
|
46969
47345
|
* Sets the user's roles
|
|
46970
47346
|
*
|
|
46971
|
-
* @param {String}
|
|
47347
|
+
* @param {String} subjectId User ID
|
|
46972
47348
|
* @param {Array.<String>} body List of roles
|
|
46973
47349
|
*/
|
|
46974
|
-
putUserRoles(
|
|
46975
|
-
// verify the required parameter '
|
|
46976
|
-
if (
|
|
46977
|
-
throw 'Missing the required parameter "
|
|
47350
|
+
putUserRoles(subjectId, body) {
|
|
47351
|
+
// verify the required parameter 'subjectId' is set
|
|
47352
|
+
if (subjectId === undefined || subjectId === null) {
|
|
47353
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
46978
47354
|
}
|
|
46979
47355
|
// verify the required parameter 'body' is set
|
|
46980
47356
|
if (body === undefined || body === null) {
|
|
@@ -46982,9 +47358,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46982
47358
|
}
|
|
46983
47359
|
|
|
46984
47360
|
return this.apiClient.callApi(
|
|
46985
|
-
'/api/v2/users/{
|
|
47361
|
+
'/api/v2/users/{subjectId}/roles',
|
|
46986
47362
|
'PUT',
|
|
46987
|
-
{ '
|
|
47363
|
+
{ 'subjectId': subjectId },
|
|
46988
47364
|
{ },
|
|
46989
47365
|
{ },
|
|
46990
47366
|
{ },
|
|
@@ -47186,7 +47562,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47186
47562
|
/**
|
|
47187
47563
|
* Utilities service.
|
|
47188
47564
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47189
|
-
* @version
|
|
47565
|
+
* @version 140.0.0
|
|
47190
47566
|
*/
|
|
47191
47567
|
|
|
47192
47568
|
/**
|
|
@@ -47297,7 +47673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47297
47673
|
/**
|
|
47298
47674
|
* Voicemail service.
|
|
47299
47675
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47300
|
-
* @version
|
|
47676
|
+
* @version 140.0.0
|
|
47301
47677
|
*/
|
|
47302
47678
|
|
|
47303
47679
|
/**
|
|
@@ -47964,7 +48340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47964
48340
|
/**
|
|
47965
48341
|
* WebChat service.
|
|
47966
48342
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47967
|
-
* @version
|
|
48343
|
+
* @version 140.0.0
|
|
47968
48344
|
*/
|
|
47969
48345
|
|
|
47970
48346
|
/**
|
|
@@ -48508,7 +48884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48508
48884
|
/**
|
|
48509
48885
|
* WebDeployments service.
|
|
48510
48886
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48511
|
-
* @version
|
|
48887
|
+
* @version 140.0.0
|
|
48512
48888
|
*/
|
|
48513
48889
|
|
|
48514
48890
|
/**
|
|
@@ -48863,7 +49239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48863
49239
|
/**
|
|
48864
49240
|
* WebMessaging service.
|
|
48865
49241
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48866
|
-
* @version
|
|
49242
|
+
* @version 140.0.0
|
|
48867
49243
|
*/
|
|
48868
49244
|
|
|
48869
49245
|
/**
|
|
@@ -48909,7 +49285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48909
49285
|
/**
|
|
48910
49286
|
* Widgets service.
|
|
48911
49287
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48912
|
-
* @version
|
|
49288
|
+
* @version 140.0.0
|
|
48913
49289
|
*/
|
|
48914
49290
|
|
|
48915
49291
|
/**
|
|
@@ -49055,7 +49431,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49055
49431
|
/**
|
|
49056
49432
|
* WorkforceManagement service.
|
|
49057
49433
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49058
|
-
* @version
|
|
49434
|
+
* @version 140.0.0
|
|
49059
49435
|
*/
|
|
49060
49436
|
|
|
49061
49437
|
/**
|
|
@@ -53306,7 +53682,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53306
53682
|
* </pre>
|
|
53307
53683
|
* </p>
|
|
53308
53684
|
* @module purecloud-platform-client-v2/index
|
|
53309
|
-
* @version
|
|
53685
|
+
* @version 140.0.0
|
|
53310
53686
|
*/
|
|
53311
53687
|
class platformClient {
|
|
53312
53688
|
constructor() {
|