purecloud-platform-client-v2 174.0.0 → 176.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 +804 -77
- package/dist/web-amd/purecloud-platform-client-v2.js +804 -77
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +804 -77
- package/dist/web-cjs/purecloud-platform-client-v2.js +804 -77
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +296 -7
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +120 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +605 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +7 -3
- 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/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- 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 +3 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +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 +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 176.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1485,7 +1485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1485
1485
|
/**
|
|
1486
1486
|
* Alerting service.
|
|
1487
1487
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1488
|
-
* @version
|
|
1488
|
+
* @version 176.0.0
|
|
1489
1489
|
*/
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
@@ -2135,7 +2135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2135
2135
|
/**
|
|
2136
2136
|
* Analytics service.
|
|
2137
2137
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2138
|
-
* @version
|
|
2138
|
+
* @version 176.0.0
|
|
2139
2139
|
*/
|
|
2140
2140
|
|
|
2141
2141
|
/**
|
|
@@ -4581,7 +4581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4581
4581
|
/**
|
|
4582
4582
|
* Architect service.
|
|
4583
4583
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4584
|
-
* @version
|
|
4584
|
+
* @version 176.0.0
|
|
4585
4585
|
*/
|
|
4586
4586
|
|
|
4587
4587
|
/**
|
|
@@ -6274,6 +6274,125 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6274
6274
|
);
|
|
6275
6275
|
}
|
|
6276
6276
|
|
|
6277
|
+
/**
|
|
6278
|
+
* Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
|
|
6279
|
+
*
|
|
6280
|
+
* @param {String} flowId Flow ID.
|
|
6281
|
+
* @param {String} versionId Version ID.
|
|
6282
|
+
* @param {Object} opts Optional parameters
|
|
6283
|
+
* @param {Object} opts.language Language to filter for
|
|
6284
|
+
*/
|
|
6285
|
+
getFlowVersionHealth(flowId, versionId, opts) {
|
|
6286
|
+
opts = opts || {};
|
|
6287
|
+
|
|
6288
|
+
// verify the required parameter 'flowId' is set
|
|
6289
|
+
if (flowId === undefined || flowId === null) {
|
|
6290
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionHealth';
|
|
6291
|
+
}
|
|
6292
|
+
// verify the required parameter 'versionId' is set
|
|
6293
|
+
if (versionId === undefined || versionId === null) {
|
|
6294
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionHealth';
|
|
6295
|
+
}
|
|
6296
|
+
|
|
6297
|
+
return this.apiClient.callApi(
|
|
6298
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/health',
|
|
6299
|
+
'GET',
|
|
6300
|
+
{ 'flowId': flowId,'versionId': versionId },
|
|
6301
|
+
{ 'language': opts['language'] },
|
|
6302
|
+
{ },
|
|
6303
|
+
{ },
|
|
6304
|
+
null,
|
|
6305
|
+
['PureCloud OAuth'],
|
|
6306
|
+
['application/json'],
|
|
6307
|
+
['application/json']
|
|
6308
|
+
);
|
|
6309
|
+
}
|
|
6310
|
+
|
|
6311
|
+
/**
|
|
6312
|
+
* Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.
|
|
6313
|
+
*
|
|
6314
|
+
* @param {String} flowId Flow ID.
|
|
6315
|
+
* @param {String} versionId Version ID.
|
|
6316
|
+
* @param {String} intentId Intent ID.
|
|
6317
|
+
* @param {Object} language Language to filter for
|
|
6318
|
+
*/
|
|
6319
|
+
getFlowVersionIntentHealth(flowId, versionId, intentId, language) {
|
|
6320
|
+
// verify the required parameter 'flowId' is set
|
|
6321
|
+
if (flowId === undefined || flowId === null) {
|
|
6322
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';
|
|
6323
|
+
}
|
|
6324
|
+
// verify the required parameter 'versionId' is set
|
|
6325
|
+
if (versionId === undefined || versionId === null) {
|
|
6326
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';
|
|
6327
|
+
}
|
|
6328
|
+
// verify the required parameter 'intentId' is set
|
|
6329
|
+
if (intentId === undefined || intentId === null) {
|
|
6330
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';
|
|
6331
|
+
}
|
|
6332
|
+
// verify the required parameter 'language' is set
|
|
6333
|
+
if (language === undefined || language === null) {
|
|
6334
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentHealth';
|
|
6335
|
+
}
|
|
6336
|
+
|
|
6337
|
+
return this.apiClient.callApi(
|
|
6338
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health',
|
|
6339
|
+
'GET',
|
|
6340
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId },
|
|
6341
|
+
{ 'language': language },
|
|
6342
|
+
{ },
|
|
6343
|
+
{ },
|
|
6344
|
+
null,
|
|
6345
|
+
['PureCloud OAuth'],
|
|
6346
|
+
['application/json'],
|
|
6347
|
+
['application/json']
|
|
6348
|
+
);
|
|
6349
|
+
}
|
|
6350
|
+
|
|
6351
|
+
/**
|
|
6352
|
+
* Get health metrics associated with a specific utterance of an intent.
|
|
6353
|
+
*
|
|
6354
|
+
* @param {String} flowId Flow ID.
|
|
6355
|
+
* @param {String} versionId Version ID.
|
|
6356
|
+
* @param {String} intentId Intent ID.
|
|
6357
|
+
* @param {String} utteranceId Utterance ID.
|
|
6358
|
+
* @param {Object} language Language to filter for
|
|
6359
|
+
*/
|
|
6360
|
+
getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language) {
|
|
6361
|
+
// verify the required parameter 'flowId' is set
|
|
6362
|
+
if (flowId === undefined || flowId === null) {
|
|
6363
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6364
|
+
}
|
|
6365
|
+
// verify the required parameter 'versionId' is set
|
|
6366
|
+
if (versionId === undefined || versionId === null) {
|
|
6367
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6368
|
+
}
|
|
6369
|
+
// verify the required parameter 'intentId' is set
|
|
6370
|
+
if (intentId === undefined || intentId === null) {
|
|
6371
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6372
|
+
}
|
|
6373
|
+
// verify the required parameter 'utteranceId' is set
|
|
6374
|
+
if (utteranceId === undefined || utteranceId === null) {
|
|
6375
|
+
throw 'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6376
|
+
}
|
|
6377
|
+
// verify the required parameter 'language' is set
|
|
6378
|
+
if (language === undefined || language === null) {
|
|
6379
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';
|
|
6380
|
+
}
|
|
6381
|
+
|
|
6382
|
+
return this.apiClient.callApi(
|
|
6383
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health',
|
|
6384
|
+
'GET',
|
|
6385
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId,'utteranceId': utteranceId },
|
|
6386
|
+
{ 'language': language },
|
|
6387
|
+
{ },
|
|
6388
|
+
{ },
|
|
6389
|
+
null,
|
|
6390
|
+
['PureCloud OAuth'],
|
|
6391
|
+
['application/json'],
|
|
6392
|
+
['application/json']
|
|
6393
|
+
);
|
|
6394
|
+
}
|
|
6395
|
+
|
|
6277
6396
|
/**
|
|
6278
6397
|
* Get flow version list
|
|
6279
6398
|
*
|
|
@@ -8262,7 +8381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8262
8381
|
/**
|
|
8263
8382
|
* Audit service.
|
|
8264
8383
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8265
|
-
* @version
|
|
8384
|
+
* @version 176.0.0
|
|
8266
8385
|
*/
|
|
8267
8386
|
|
|
8268
8387
|
/**
|
|
@@ -8433,7 +8552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8433
8552
|
/**
|
|
8434
8553
|
* Authorization service.
|
|
8435
8554
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8436
|
-
* @version
|
|
8555
|
+
* @version 176.0.0
|
|
8437
8556
|
*/
|
|
8438
8557
|
|
|
8439
8558
|
/**
|
|
@@ -9664,7 +9783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9664
9783
|
/**
|
|
9665
9784
|
* Billing service.
|
|
9666
9785
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9667
|
-
* @version
|
|
9786
|
+
* @version 176.0.0
|
|
9668
9787
|
*/
|
|
9669
9788
|
|
|
9670
9789
|
/**
|
|
@@ -9744,7 +9863,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9744
9863
|
/**
|
|
9745
9864
|
* CarrierServices service.
|
|
9746
9865
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9747
|
-
* @version
|
|
9866
|
+
* @version 176.0.0
|
|
9748
9867
|
*/
|
|
9749
9868
|
|
|
9750
9869
|
/**
|
|
@@ -9814,7 +9933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9814
9933
|
/**
|
|
9815
9934
|
* Chat service.
|
|
9816
9935
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9817
|
-
* @version
|
|
9936
|
+
* @version 176.0.0
|
|
9818
9937
|
*/
|
|
9819
9938
|
|
|
9820
9939
|
/**
|
|
@@ -9829,6 +9948,130 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9829
9948
|
}
|
|
9830
9949
|
|
|
9831
9950
|
|
|
9951
|
+
/**
|
|
9952
|
+
* Delete a message in a room
|
|
9953
|
+
*
|
|
9954
|
+
* @param {String} roomJid roomId
|
|
9955
|
+
* @param {String} messageId messageId
|
|
9956
|
+
* deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9957
|
+
*/
|
|
9958
|
+
deleteChatsRoomMessage(roomJid, messageId) {
|
|
9959
|
+
// verify the required parameter 'roomJid' is set
|
|
9960
|
+
if (roomJid === undefined || roomJid === null) {
|
|
9961
|
+
throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';
|
|
9962
|
+
}
|
|
9963
|
+
// verify the required parameter 'messageId' is set
|
|
9964
|
+
if (messageId === undefined || messageId === null) {
|
|
9965
|
+
throw 'Missing the required parameter "messageId" when calling deleteChatsRoomMessage';
|
|
9966
|
+
}
|
|
9967
|
+
|
|
9968
|
+
return this.apiClient.callApi(
|
|
9969
|
+
'/api/v2/chats/rooms/{roomJid}/messages/{messageId}',
|
|
9970
|
+
'DELETE',
|
|
9971
|
+
{ 'roomJid': roomJid,'messageId': messageId },
|
|
9972
|
+
{ },
|
|
9973
|
+
{ },
|
|
9974
|
+
{ },
|
|
9975
|
+
null,
|
|
9976
|
+
['PureCloud OAuth'],
|
|
9977
|
+
['application/json'],
|
|
9978
|
+
['application/json']
|
|
9979
|
+
);
|
|
9980
|
+
}
|
|
9981
|
+
|
|
9982
|
+
/**
|
|
9983
|
+
* Remove a user from a room.
|
|
9984
|
+
*
|
|
9985
|
+
* @param {String} roomJid roomJid
|
|
9986
|
+
* @param {String} userId userId
|
|
9987
|
+
* deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9988
|
+
*/
|
|
9989
|
+
deleteChatsRoomParticipant(roomJid, userId) {
|
|
9990
|
+
// verify the required parameter 'roomJid' is set
|
|
9991
|
+
if (roomJid === undefined || roomJid === null) {
|
|
9992
|
+
throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';
|
|
9993
|
+
}
|
|
9994
|
+
// verify the required parameter 'userId' is set
|
|
9995
|
+
if (userId === undefined || userId === null) {
|
|
9996
|
+
throw 'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';
|
|
9997
|
+
}
|
|
9998
|
+
|
|
9999
|
+
return this.apiClient.callApi(
|
|
10000
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{userId}',
|
|
10001
|
+
'DELETE',
|
|
10002
|
+
{ 'roomJid': roomJid,'userId': userId },
|
|
10003
|
+
{ },
|
|
10004
|
+
{ },
|
|
10005
|
+
{ },
|
|
10006
|
+
null,
|
|
10007
|
+
['PureCloud OAuth'],
|
|
10008
|
+
['application/json'],
|
|
10009
|
+
['application/json']
|
|
10010
|
+
);
|
|
10011
|
+
}
|
|
10012
|
+
|
|
10013
|
+
/**
|
|
10014
|
+
* Remove a pinned message from a room
|
|
10015
|
+
*
|
|
10016
|
+
* @param {String} roomJid roomJid
|
|
10017
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
10018
|
+
* deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10019
|
+
*/
|
|
10020
|
+
deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) {
|
|
10021
|
+
// verify the required parameter 'roomJid' is set
|
|
10022
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10023
|
+
throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomPinnedmessage';
|
|
10024
|
+
}
|
|
10025
|
+
// verify the required parameter 'pinnedMessageId' is set
|
|
10026
|
+
if (pinnedMessageId === undefined || pinnedMessageId === null) {
|
|
10027
|
+
throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomPinnedmessage';
|
|
10028
|
+
}
|
|
10029
|
+
|
|
10030
|
+
return this.apiClient.callApi(
|
|
10031
|
+
'/api/v2/chats/rooms/{roomJid}/pinnedmessages/{pinnedMessageId}',
|
|
10032
|
+
'DELETE',
|
|
10033
|
+
{ 'roomJid': roomJid,'pinnedMessageId': pinnedMessageId },
|
|
10034
|
+
{ },
|
|
10035
|
+
{ },
|
|
10036
|
+
{ },
|
|
10037
|
+
null,
|
|
10038
|
+
['PureCloud OAuth'],
|
|
10039
|
+
['application/json'],
|
|
10040
|
+
['application/json']
|
|
10041
|
+
);
|
|
10042
|
+
}
|
|
10043
|
+
|
|
10044
|
+
/**
|
|
10045
|
+
* Delete a message to a user
|
|
10046
|
+
*
|
|
10047
|
+
* @param {String} userId userId
|
|
10048
|
+
* @param {String} messageId messageId
|
|
10049
|
+
* deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10050
|
+
*/
|
|
10051
|
+
deleteChatsUserMessage(userId, messageId) {
|
|
10052
|
+
// verify the required parameter 'userId' is set
|
|
10053
|
+
if (userId === undefined || userId === null) {
|
|
10054
|
+
throw 'Missing the required parameter "userId" when calling deleteChatsUserMessage';
|
|
10055
|
+
}
|
|
10056
|
+
// verify the required parameter 'messageId' is set
|
|
10057
|
+
if (messageId === undefined || messageId === null) {
|
|
10058
|
+
throw 'Missing the required parameter "messageId" when calling deleteChatsUserMessage';
|
|
10059
|
+
}
|
|
10060
|
+
|
|
10061
|
+
return this.apiClient.callApi(
|
|
10062
|
+
'/api/v2/chats/users/{userId}/messages/{messageId}',
|
|
10063
|
+
'DELETE',
|
|
10064
|
+
{ 'userId': userId,'messageId': messageId },
|
|
10065
|
+
{ },
|
|
10066
|
+
{ },
|
|
10067
|
+
{ },
|
|
10068
|
+
null,
|
|
10069
|
+
['PureCloud OAuth'],
|
|
10070
|
+
['application/json'],
|
|
10071
|
+
['application/json']
|
|
10072
|
+
);
|
|
10073
|
+
}
|
|
10074
|
+
|
|
9832
10075
|
/**
|
|
9833
10076
|
* Get Chat Settings.
|
|
9834
10077
|
* This route is deprecated, please use /chats/settings instead
|
|
@@ -9850,6 +10093,127 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9850
10093
|
);
|
|
9851
10094
|
}
|
|
9852
10095
|
|
|
10096
|
+
/**
|
|
10097
|
+
* Get a message
|
|
10098
|
+
*
|
|
10099
|
+
* @param {String} messageId messageId
|
|
10100
|
+
* getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10101
|
+
*/
|
|
10102
|
+
getChatsMessage(messageId) {
|
|
10103
|
+
// verify the required parameter 'messageId' is set
|
|
10104
|
+
if (messageId === undefined || messageId === null) {
|
|
10105
|
+
throw 'Missing the required parameter "messageId" when calling getChatsMessage';
|
|
10106
|
+
}
|
|
10107
|
+
|
|
10108
|
+
return this.apiClient.callApi(
|
|
10109
|
+
'/api/v2/chats/messages/{messageId}',
|
|
10110
|
+
'GET',
|
|
10111
|
+
{ 'messageId': messageId },
|
|
10112
|
+
{ },
|
|
10113
|
+
{ },
|
|
10114
|
+
{ },
|
|
10115
|
+
null,
|
|
10116
|
+
['PureCloud OAuth'],
|
|
10117
|
+
['application/json'],
|
|
10118
|
+
['application/json']
|
|
10119
|
+
);
|
|
10120
|
+
}
|
|
10121
|
+
|
|
10122
|
+
/**
|
|
10123
|
+
* Get a room
|
|
10124
|
+
*
|
|
10125
|
+
* @param {String} roomJid roomJid
|
|
10126
|
+
* getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10127
|
+
*/
|
|
10128
|
+
getChatsRoom(roomJid) {
|
|
10129
|
+
// verify the required parameter 'roomJid' is set
|
|
10130
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10131
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoom';
|
|
10132
|
+
}
|
|
10133
|
+
|
|
10134
|
+
return this.apiClient.callApi(
|
|
10135
|
+
'/api/v2/chats/rooms/{roomJid}',
|
|
10136
|
+
'GET',
|
|
10137
|
+
{ 'roomJid': roomJid },
|
|
10138
|
+
{ },
|
|
10139
|
+
{ },
|
|
10140
|
+
{ },
|
|
10141
|
+
null,
|
|
10142
|
+
['PureCloud OAuth'],
|
|
10143
|
+
['application/json'],
|
|
10144
|
+
['application/json']
|
|
10145
|
+
);
|
|
10146
|
+
}
|
|
10147
|
+
|
|
10148
|
+
/**
|
|
10149
|
+
* Get messages by id(s) from a room
|
|
10150
|
+
*
|
|
10151
|
+
* @param {String} roomJid roomJid
|
|
10152
|
+
* @param {String} messageIds messageIds, comma separated
|
|
10153
|
+
* getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10154
|
+
*/
|
|
10155
|
+
getChatsRoomMessage(roomJid, messageIds) {
|
|
10156
|
+
// verify the required parameter 'roomJid' is set
|
|
10157
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10158
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomMessage';
|
|
10159
|
+
}
|
|
10160
|
+
// verify the required parameter 'messageIds' is set
|
|
10161
|
+
if (messageIds === undefined || messageIds === null) {
|
|
10162
|
+
throw 'Missing the required parameter "messageIds" when calling getChatsRoomMessage';
|
|
10163
|
+
}
|
|
10164
|
+
|
|
10165
|
+
return this.apiClient.callApi(
|
|
10166
|
+
'/api/v2/chats/rooms/{roomJid}/messages/{messageIds}',
|
|
10167
|
+
'GET',
|
|
10168
|
+
{ 'roomJid': roomJid,'messageIds': messageIds },
|
|
10169
|
+
{ },
|
|
10170
|
+
{ },
|
|
10171
|
+
{ },
|
|
10172
|
+
null,
|
|
10173
|
+
['PureCloud OAuth'],
|
|
10174
|
+
['application/json'],
|
|
10175
|
+
['application/json']
|
|
10176
|
+
);
|
|
10177
|
+
}
|
|
10178
|
+
|
|
10179
|
+
/**
|
|
10180
|
+
* Get a room's message history
|
|
10181
|
+
*
|
|
10182
|
+
* @param {String} roomJid roomJid
|
|
10183
|
+
* @param {Object} opts Optional parameters
|
|
10184
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10185
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10186
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
10187
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10188
|
+
* @param {String} opts.nextPage next page token
|
|
10189
|
+
* @param {String} opts.previousPage Previous page token
|
|
10190
|
+
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10191
|
+
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10192
|
+
* @param {String} opts.after The beginning date for messages to retrieve
|
|
10193
|
+
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10194
|
+
*/
|
|
10195
|
+
getChatsRoomMessages(roomJid, opts) {
|
|
10196
|
+
opts = opts || {};
|
|
10197
|
+
|
|
10198
|
+
// verify the required parameter 'roomJid' is set
|
|
10199
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10200
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomMessages';
|
|
10201
|
+
}
|
|
10202
|
+
|
|
10203
|
+
return this.apiClient.callApi(
|
|
10204
|
+
'/api/v2/chats/rooms/{roomJid}/messages',
|
|
10205
|
+
'GET',
|
|
10206
|
+
{ 'roomJid': roomJid },
|
|
10207
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10208
|
+
{ },
|
|
10209
|
+
{ },
|
|
10210
|
+
null,
|
|
10211
|
+
['PureCloud OAuth'],
|
|
10212
|
+
['application/json'],
|
|
10213
|
+
['application/json']
|
|
10214
|
+
);
|
|
10215
|
+
}
|
|
10216
|
+
|
|
9853
10217
|
/**
|
|
9854
10218
|
* Get Chat Settings.
|
|
9855
10219
|
*
|
|
@@ -9870,6 +10234,113 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9870
10234
|
);
|
|
9871
10235
|
}
|
|
9872
10236
|
|
|
10237
|
+
/**
|
|
10238
|
+
* Get history by thread
|
|
10239
|
+
*
|
|
10240
|
+
* @param {String} threadId threadId
|
|
10241
|
+
* @param {Object} opts Optional parameters
|
|
10242
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10243
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10244
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
10245
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10246
|
+
* @param {String} opts.nextPage next page token
|
|
10247
|
+
* @param {String} opts.previousPage Previous page token
|
|
10248
|
+
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10249
|
+
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10250
|
+
* @param {String} opts.after The beginning date for messages to retrieve
|
|
10251
|
+
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10252
|
+
*/
|
|
10253
|
+
getChatsThreadMessages(threadId, opts) {
|
|
10254
|
+
opts = opts || {};
|
|
10255
|
+
|
|
10256
|
+
// verify the required parameter 'threadId' is set
|
|
10257
|
+
if (threadId === undefined || threadId === null) {
|
|
10258
|
+
throw 'Missing the required parameter "threadId" when calling getChatsThreadMessages';
|
|
10259
|
+
}
|
|
10260
|
+
|
|
10261
|
+
return this.apiClient.callApi(
|
|
10262
|
+
'/api/v2/chats/threads/{threadId}/messages',
|
|
10263
|
+
'GET',
|
|
10264
|
+
{ 'threadId': threadId },
|
|
10265
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10266
|
+
{ },
|
|
10267
|
+
{ },
|
|
10268
|
+
null,
|
|
10269
|
+
['PureCloud OAuth'],
|
|
10270
|
+
['application/json'],
|
|
10271
|
+
['application/json']
|
|
10272
|
+
);
|
|
10273
|
+
}
|
|
10274
|
+
|
|
10275
|
+
/**
|
|
10276
|
+
* Get messages by id(s) from a 1on1
|
|
10277
|
+
*
|
|
10278
|
+
* @param {String} userId userId
|
|
10279
|
+
* @param {String} messageIds messageIds, comma separated
|
|
10280
|
+
* getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10281
|
+
*/
|
|
10282
|
+
getChatsUserMessage(userId, messageIds) {
|
|
10283
|
+
// verify the required parameter 'userId' is set
|
|
10284
|
+
if (userId === undefined || userId === null) {
|
|
10285
|
+
throw 'Missing the required parameter "userId" when calling getChatsUserMessage';
|
|
10286
|
+
}
|
|
10287
|
+
// verify the required parameter 'messageIds' is set
|
|
10288
|
+
if (messageIds === undefined || messageIds === null) {
|
|
10289
|
+
throw 'Missing the required parameter "messageIds" when calling getChatsUserMessage';
|
|
10290
|
+
}
|
|
10291
|
+
|
|
10292
|
+
return this.apiClient.callApi(
|
|
10293
|
+
'/api/v2/chats/users/{userId}/messages/{messageIds}',
|
|
10294
|
+
'GET',
|
|
10295
|
+
{ 'userId': userId,'messageIds': messageIds },
|
|
10296
|
+
{ },
|
|
10297
|
+
{ },
|
|
10298
|
+
{ },
|
|
10299
|
+
null,
|
|
10300
|
+
['PureCloud OAuth'],
|
|
10301
|
+
['application/json'],
|
|
10302
|
+
['application/json']
|
|
10303
|
+
);
|
|
10304
|
+
}
|
|
10305
|
+
|
|
10306
|
+
/**
|
|
10307
|
+
* Get 1on1 History between a user
|
|
10308
|
+
*
|
|
10309
|
+
* @param {String} userId userId
|
|
10310
|
+
* @param {Object} opts Optional parameters
|
|
10311
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10312
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10313
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
10314
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10315
|
+
* @param {String} opts.nextPage next page token
|
|
10316
|
+
* @param {String} opts.previousPage Previous page token
|
|
10317
|
+
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10318
|
+
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10319
|
+
* @param {String} opts.after The beginning date for messages to retrieve
|
|
10320
|
+
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10321
|
+
*/
|
|
10322
|
+
getChatsUserMessages(userId, opts) {
|
|
10323
|
+
opts = opts || {};
|
|
10324
|
+
|
|
10325
|
+
// verify the required parameter 'userId' is set
|
|
10326
|
+
if (userId === undefined || userId === null) {
|
|
10327
|
+
throw 'Missing the required parameter "userId" when calling getChatsUserMessages';
|
|
10328
|
+
}
|
|
10329
|
+
|
|
10330
|
+
return this.apiClient.callApi(
|
|
10331
|
+
'/api/v2/chats/users/{userId}/messages',
|
|
10332
|
+
'GET',
|
|
10333
|
+
{ 'userId': userId },
|
|
10334
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10335
|
+
{ },
|
|
10336
|
+
{ },
|
|
10337
|
+
null,
|
|
10338
|
+
['PureCloud OAuth'],
|
|
10339
|
+
['application/json'],
|
|
10340
|
+
['application/json']
|
|
10341
|
+
);
|
|
10342
|
+
}
|
|
10343
|
+
|
|
9873
10344
|
/**
|
|
9874
10345
|
* Patch Chat Settings.
|
|
9875
10346
|
* This route is deprecated, please use /chats/settings instead
|
|
@@ -9896,6 +10367,73 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9896
10367
|
);
|
|
9897
10368
|
}
|
|
9898
10369
|
|
|
10370
|
+
/**
|
|
10371
|
+
* Set properties for a room
|
|
10372
|
+
*
|
|
10373
|
+
* @param {String} roomJid roomJid
|
|
10374
|
+
* @param {Object} body Room properties
|
|
10375
|
+
* patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10376
|
+
*/
|
|
10377
|
+
patchChatsRoom(roomJid, body) {
|
|
10378
|
+
// verify the required parameter 'roomJid' is set
|
|
10379
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10380
|
+
throw 'Missing the required parameter "roomJid" when calling patchChatsRoom';
|
|
10381
|
+
}
|
|
10382
|
+
// verify the required parameter 'body' is set
|
|
10383
|
+
if (body === undefined || body === null) {
|
|
10384
|
+
throw 'Missing the required parameter "body" when calling patchChatsRoom';
|
|
10385
|
+
}
|
|
10386
|
+
|
|
10387
|
+
return this.apiClient.callApi(
|
|
10388
|
+
'/api/v2/chats/rooms/{roomJid}',
|
|
10389
|
+
'PATCH',
|
|
10390
|
+
{ 'roomJid': roomJid },
|
|
10391
|
+
{ },
|
|
10392
|
+
{ },
|
|
10393
|
+
{ },
|
|
10394
|
+
body,
|
|
10395
|
+
['PureCloud OAuth'],
|
|
10396
|
+
['application/json'],
|
|
10397
|
+
['application/json']
|
|
10398
|
+
);
|
|
10399
|
+
}
|
|
10400
|
+
|
|
10401
|
+
/**
|
|
10402
|
+
* Edit a message in a room
|
|
10403
|
+
*
|
|
10404
|
+
* @param {String} roomJid roomId
|
|
10405
|
+
* @param {String} messageId messageId
|
|
10406
|
+
* @param {Object} body messageBody
|
|
10407
|
+
* patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10408
|
+
*/
|
|
10409
|
+
patchChatsRoomMessage(roomJid, messageId, body) {
|
|
10410
|
+
// verify the required parameter 'roomJid' is set
|
|
10411
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10412
|
+
throw 'Missing the required parameter "roomJid" when calling patchChatsRoomMessage';
|
|
10413
|
+
}
|
|
10414
|
+
// verify the required parameter 'messageId' is set
|
|
10415
|
+
if (messageId === undefined || messageId === null) {
|
|
10416
|
+
throw 'Missing the required parameter "messageId" when calling patchChatsRoomMessage';
|
|
10417
|
+
}
|
|
10418
|
+
// verify the required parameter 'body' is set
|
|
10419
|
+
if (body === undefined || body === null) {
|
|
10420
|
+
throw 'Missing the required parameter "body" when calling patchChatsRoomMessage';
|
|
10421
|
+
}
|
|
10422
|
+
|
|
10423
|
+
return this.apiClient.callApi(
|
|
10424
|
+
'/api/v2/chats/rooms/{roomJid}/messages/{messageId}',
|
|
10425
|
+
'PATCH',
|
|
10426
|
+
{ 'roomJid': roomJid,'messageId': messageId },
|
|
10427
|
+
{ },
|
|
10428
|
+
{ },
|
|
10429
|
+
{ },
|
|
10430
|
+
body,
|
|
10431
|
+
['PureCloud OAuth'],
|
|
10432
|
+
['application/json'],
|
|
10433
|
+
['application/json']
|
|
10434
|
+
);
|
|
10435
|
+
}
|
|
10436
|
+
|
|
9899
10437
|
/**
|
|
9900
10438
|
* Patch Chat Settings.
|
|
9901
10439
|
*
|
|
@@ -9921,6 +10459,191 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9921
10459
|
);
|
|
9922
10460
|
}
|
|
9923
10461
|
|
|
10462
|
+
/**
|
|
10463
|
+
* Edit a message to a user
|
|
10464
|
+
*
|
|
10465
|
+
* @param {String} userId userId
|
|
10466
|
+
* @param {String} messageId messageId
|
|
10467
|
+
* @param {Object} body message body
|
|
10468
|
+
* patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10469
|
+
*/
|
|
10470
|
+
patchChatsUserMessage(userId, messageId, body) {
|
|
10471
|
+
// verify the required parameter 'userId' is set
|
|
10472
|
+
if (userId === undefined || userId === null) {
|
|
10473
|
+
throw 'Missing the required parameter "userId" when calling patchChatsUserMessage';
|
|
10474
|
+
}
|
|
10475
|
+
// verify the required parameter 'messageId' is set
|
|
10476
|
+
if (messageId === undefined || messageId === null) {
|
|
10477
|
+
throw 'Missing the required parameter "messageId" when calling patchChatsUserMessage';
|
|
10478
|
+
}
|
|
10479
|
+
// verify the required parameter 'body' is set
|
|
10480
|
+
if (body === undefined || body === null) {
|
|
10481
|
+
throw 'Missing the required parameter "body" when calling patchChatsUserMessage';
|
|
10482
|
+
}
|
|
10483
|
+
|
|
10484
|
+
return this.apiClient.callApi(
|
|
10485
|
+
'/api/v2/chats/users/{userId}/messages/{messageId}',
|
|
10486
|
+
'PATCH',
|
|
10487
|
+
{ 'userId': userId,'messageId': messageId },
|
|
10488
|
+
{ },
|
|
10489
|
+
{ },
|
|
10490
|
+
{ },
|
|
10491
|
+
body,
|
|
10492
|
+
['PureCloud OAuth'],
|
|
10493
|
+
['application/json'],
|
|
10494
|
+
['application/json']
|
|
10495
|
+
);
|
|
10496
|
+
}
|
|
10497
|
+
|
|
10498
|
+
/**
|
|
10499
|
+
* Send a message to a room
|
|
10500
|
+
*
|
|
10501
|
+
* @param {String} roomJid roomId
|
|
10502
|
+
* @param {Object} body messageBody
|
|
10503
|
+
* postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10504
|
+
*/
|
|
10505
|
+
postChatsRoomMessages(roomJid, body) {
|
|
10506
|
+
// verify the required parameter 'roomJid' is set
|
|
10507
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10508
|
+
throw 'Missing the required parameter "roomJid" when calling postChatsRoomMessages';
|
|
10509
|
+
}
|
|
10510
|
+
// verify the required parameter 'body' is set
|
|
10511
|
+
if (body === undefined || body === null) {
|
|
10512
|
+
throw 'Missing the required parameter "body" when calling postChatsRoomMessages';
|
|
10513
|
+
}
|
|
10514
|
+
|
|
10515
|
+
return this.apiClient.callApi(
|
|
10516
|
+
'/api/v2/chats/rooms/{roomJid}/messages',
|
|
10517
|
+
'POST',
|
|
10518
|
+
{ 'roomJid': roomJid },
|
|
10519
|
+
{ },
|
|
10520
|
+
{ },
|
|
10521
|
+
{ },
|
|
10522
|
+
body,
|
|
10523
|
+
['PureCloud OAuth'],
|
|
10524
|
+
['application/json'],
|
|
10525
|
+
['application/json']
|
|
10526
|
+
);
|
|
10527
|
+
}
|
|
10528
|
+
|
|
10529
|
+
/**
|
|
10530
|
+
* Join a room
|
|
10531
|
+
*
|
|
10532
|
+
* @param {String} roomJid roomJid
|
|
10533
|
+
* @param {String} userId userId
|
|
10534
|
+
* postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10535
|
+
*/
|
|
10536
|
+
postChatsRoomParticipant(roomJid, userId) {
|
|
10537
|
+
// verify the required parameter 'roomJid' is set
|
|
10538
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10539
|
+
throw 'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';
|
|
10540
|
+
}
|
|
10541
|
+
// verify the required parameter 'userId' is set
|
|
10542
|
+
if (userId === undefined || userId === null) {
|
|
10543
|
+
throw 'Missing the required parameter "userId" when calling postChatsRoomParticipant';
|
|
10544
|
+
}
|
|
10545
|
+
|
|
10546
|
+
return this.apiClient.callApi(
|
|
10547
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{userId}',
|
|
10548
|
+
'POST',
|
|
10549
|
+
{ 'roomJid': roomJid,'userId': userId },
|
|
10550
|
+
{ },
|
|
10551
|
+
{ },
|
|
10552
|
+
{ },
|
|
10553
|
+
null,
|
|
10554
|
+
['PureCloud OAuth'],
|
|
10555
|
+
['application/json'],
|
|
10556
|
+
['application/json']
|
|
10557
|
+
);
|
|
10558
|
+
}
|
|
10559
|
+
|
|
10560
|
+
/**
|
|
10561
|
+
* Add pinned messages for a room, up to a maximum of 5 pinned messages
|
|
10562
|
+
*
|
|
10563
|
+
* @param {String} roomJid roomJid
|
|
10564
|
+
* @param {Object} body Pinned Message Ids
|
|
10565
|
+
* postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10566
|
+
*/
|
|
10567
|
+
postChatsRoomPinnedmessages(roomJid, body) {
|
|
10568
|
+
// verify the required parameter 'roomJid' is set
|
|
10569
|
+
if (roomJid === undefined || roomJid === null) {
|
|
10570
|
+
throw 'Missing the required parameter "roomJid" when calling postChatsRoomPinnedmessages';
|
|
10571
|
+
}
|
|
10572
|
+
// verify the required parameter 'body' is set
|
|
10573
|
+
if (body === undefined || body === null) {
|
|
10574
|
+
throw 'Missing the required parameter "body" when calling postChatsRoomPinnedmessages';
|
|
10575
|
+
}
|
|
10576
|
+
|
|
10577
|
+
return this.apiClient.callApi(
|
|
10578
|
+
'/api/v2/chats/rooms/{roomJid}/pinnedmessages',
|
|
10579
|
+
'POST',
|
|
10580
|
+
{ 'roomJid': roomJid },
|
|
10581
|
+
{ },
|
|
10582
|
+
{ },
|
|
10583
|
+
{ },
|
|
10584
|
+
body,
|
|
10585
|
+
['PureCloud OAuth'],
|
|
10586
|
+
['application/json'],
|
|
10587
|
+
['application/json']
|
|
10588
|
+
);
|
|
10589
|
+
}
|
|
10590
|
+
|
|
10591
|
+
/**
|
|
10592
|
+
* Create an adhoc room
|
|
10593
|
+
*
|
|
10594
|
+
* @param {Object} opts Optional parameters
|
|
10595
|
+
* @param {Object} opts.body Room properties
|
|
10596
|
+
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10597
|
+
*/
|
|
10598
|
+
postChatsRooms(opts) {
|
|
10599
|
+
opts = opts || {};
|
|
10600
|
+
|
|
10601
|
+
|
|
10602
|
+
return this.apiClient.callApi(
|
|
10603
|
+
'/api/v2/chats/rooms',
|
|
10604
|
+
'POST',
|
|
10605
|
+
{ },
|
|
10606
|
+
{ },
|
|
10607
|
+
{ },
|
|
10608
|
+
{ },
|
|
10609
|
+
opts['body'],
|
|
10610
|
+
['PureCloud OAuth'],
|
|
10611
|
+
['application/json'],
|
|
10612
|
+
['application/json']
|
|
10613
|
+
);
|
|
10614
|
+
}
|
|
10615
|
+
|
|
10616
|
+
/**
|
|
10617
|
+
* Send a message to a user
|
|
10618
|
+
*
|
|
10619
|
+
* @param {String} userId userId
|
|
10620
|
+
* @param {Object} body message body
|
|
10621
|
+
* postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10622
|
+
*/
|
|
10623
|
+
postChatsUserMessages(userId, body) {
|
|
10624
|
+
// verify the required parameter 'userId' is set
|
|
10625
|
+
if (userId === undefined || userId === null) {
|
|
10626
|
+
throw 'Missing the required parameter "userId" when calling postChatsUserMessages';
|
|
10627
|
+
}
|
|
10628
|
+
// verify the required parameter 'body' is set
|
|
10629
|
+
if (body === undefined || body === null) {
|
|
10630
|
+
throw 'Missing the required parameter "body" when calling postChatsUserMessages';
|
|
10631
|
+
}
|
|
10632
|
+
|
|
10633
|
+
return this.apiClient.callApi(
|
|
10634
|
+
'/api/v2/chats/users/{userId}/messages',
|
|
10635
|
+
'POST',
|
|
10636
|
+
{ 'userId': userId },
|
|
10637
|
+
{ },
|
|
10638
|
+
{ },
|
|
10639
|
+
{ },
|
|
10640
|
+
body,
|
|
10641
|
+
['PureCloud OAuth'],
|
|
10642
|
+
['application/json'],
|
|
10643
|
+
['application/json']
|
|
10644
|
+
);
|
|
10645
|
+
}
|
|
10646
|
+
|
|
9924
10647
|
/**
|
|
9925
10648
|
* Update Chat Settings.
|
|
9926
10649
|
* This route is deprecated, please use /chats/settings instead
|
|
@@ -9978,7 +10701,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9978
10701
|
/**
|
|
9979
10702
|
* Coaching service.
|
|
9980
10703
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9981
|
-
* @version
|
|
10704
|
+
* @version 176.0.0
|
|
9982
10705
|
*/
|
|
9983
10706
|
|
|
9984
10707
|
/**
|
|
@@ -10555,7 +11278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10555
11278
|
/**
|
|
10556
11279
|
* ContentManagement service.
|
|
10557
11280
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10558
|
-
* @version
|
|
11281
|
+
* @version 176.0.0
|
|
10559
11282
|
*/
|
|
10560
11283
|
|
|
10561
11284
|
/**
|
|
@@ -11698,7 +12421,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11698
12421
|
/**
|
|
11699
12422
|
* Conversations service.
|
|
11700
12423
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11701
|
-
* @version
|
|
12424
|
+
* @version 176.0.0
|
|
11702
12425
|
*/
|
|
11703
12426
|
|
|
11704
12427
|
/**
|
|
@@ -18782,7 +19505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18782
19505
|
/**
|
|
18783
19506
|
* DataExtensions service.
|
|
18784
19507
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
18785
|
-
* @version
|
|
19508
|
+
* @version 176.0.0
|
|
18786
19509
|
*/
|
|
18787
19510
|
|
|
18788
19511
|
/**
|
|
@@ -18868,7 +19591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18868
19591
|
/**
|
|
18869
19592
|
* Downloads service.
|
|
18870
19593
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
18871
|
-
* @version
|
|
19594
|
+
* @version 176.0.0
|
|
18872
19595
|
*/
|
|
18873
19596
|
|
|
18874
19597
|
/**
|
|
@@ -18920,7 +19643,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18920
19643
|
/**
|
|
18921
19644
|
* Emails service.
|
|
18922
19645
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
18923
|
-
* @version
|
|
19646
|
+
* @version 176.0.0
|
|
18924
19647
|
*/
|
|
18925
19648
|
|
|
18926
19649
|
/**
|
|
@@ -18985,7 +19708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18985
19708
|
/**
|
|
18986
19709
|
* Events service.
|
|
18987
19710
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
18988
|
-
* @version
|
|
19711
|
+
* @version 176.0.0
|
|
18989
19712
|
*/
|
|
18990
19713
|
|
|
18991
19714
|
/**
|
|
@@ -19081,7 +19804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19081
19804
|
/**
|
|
19082
19805
|
* ExternalContacts service.
|
|
19083
19806
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19084
|
-
* @version
|
|
19807
|
+
* @version 176.0.0
|
|
19085
19808
|
*/
|
|
19086
19809
|
|
|
19087
19810
|
/**
|
|
@@ -21039,7 +21762,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21039
21762
|
/**
|
|
21040
21763
|
* Fax service.
|
|
21041
21764
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21042
|
-
* @version
|
|
21765
|
+
* @version 176.0.0
|
|
21043
21766
|
*/
|
|
21044
21767
|
|
|
21045
21768
|
/**
|
|
@@ -21210,7 +21933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21210
21933
|
/**
|
|
21211
21934
|
* Flows service.
|
|
21212
21935
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
21213
|
-
* @version
|
|
21936
|
+
* @version 176.0.0
|
|
21214
21937
|
*/
|
|
21215
21938
|
|
|
21216
21939
|
/**
|
|
@@ -21394,7 +22117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21394
22117
|
/**
|
|
21395
22118
|
* Gamification service.
|
|
21396
22119
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
21397
|
-
* @version
|
|
22120
|
+
* @version 176.0.0
|
|
21398
22121
|
*/
|
|
21399
22122
|
|
|
21400
22123
|
/**
|
|
@@ -23480,7 +24203,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23480
24203
|
/**
|
|
23481
24204
|
* GeneralDataProtectionRegulation service.
|
|
23482
24205
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
23483
|
-
* @version
|
|
24206
|
+
* @version 176.0.0
|
|
23484
24207
|
*/
|
|
23485
24208
|
|
|
23486
24209
|
/**
|
|
@@ -23610,7 +24333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23610
24333
|
/**
|
|
23611
24334
|
* Geolocation service.
|
|
23612
24335
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
23613
|
-
* @version
|
|
24336
|
+
* @version 176.0.0
|
|
23614
24337
|
*/
|
|
23615
24338
|
|
|
23616
24339
|
/**
|
|
@@ -23741,7 +24464,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23741
24464
|
/**
|
|
23742
24465
|
* Greetings service.
|
|
23743
24466
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
23744
|
-
* @version
|
|
24467
|
+
* @version 176.0.0
|
|
23745
24468
|
*/
|
|
23746
24469
|
|
|
23747
24470
|
/**
|
|
@@ -24196,7 +24919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24196
24919
|
/**
|
|
24197
24920
|
* Groups service.
|
|
24198
24921
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
24199
|
-
* @version
|
|
24922
|
+
* @version 176.0.0
|
|
24200
24923
|
*/
|
|
24201
24924
|
|
|
24202
24925
|
/**
|
|
@@ -24715,7 +25438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24715
25438
|
/**
|
|
24716
25439
|
* IdentityProvider service.
|
|
24717
25440
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
24718
|
-
* @version
|
|
25441
|
+
* @version 176.0.0
|
|
24719
25442
|
*/
|
|
24720
25443
|
|
|
24721
25444
|
/**
|
|
@@ -25471,7 +26194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25471
26194
|
/**
|
|
25472
26195
|
* InfrastructureAsCode service.
|
|
25473
26196
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
25474
|
-
* @version
|
|
26197
|
+
* @version 176.0.0
|
|
25475
26198
|
*/
|
|
25476
26199
|
|
|
25477
26200
|
/**
|
|
@@ -25638,7 +26361,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25638
26361
|
/**
|
|
25639
26362
|
* Integrations service.
|
|
25640
26363
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
25641
|
-
* @version
|
|
26364
|
+
* @version 176.0.0
|
|
25642
26365
|
*/
|
|
25643
26366
|
|
|
25644
26367
|
/**
|
|
@@ -27600,7 +28323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27600
28323
|
/**
|
|
27601
28324
|
* Journey service.
|
|
27602
28325
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
27603
|
-
* @version
|
|
28326
|
+
* @version 176.0.0
|
|
27604
28327
|
*/
|
|
27605
28328
|
|
|
27606
28329
|
/**
|
|
@@ -28764,7 +29487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28764
29487
|
/**
|
|
28765
29488
|
* Knowledge service.
|
|
28766
29489
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
28767
|
-
* @version
|
|
29490
|
+
* @version 176.0.0
|
|
28768
29491
|
*/
|
|
28769
29492
|
|
|
28770
29493
|
/**
|
|
@@ -31585,7 +32308,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31585
32308
|
/**
|
|
31586
32309
|
* LanguageUnderstanding service.
|
|
31587
32310
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
31588
|
-
* @version
|
|
32311
|
+
* @version 176.0.0
|
|
31589
32312
|
*/
|
|
31590
32313
|
|
|
31591
32314
|
/**
|
|
@@ -32598,7 +33321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32598
33321
|
/**
|
|
32599
33322
|
* Languages service.
|
|
32600
33323
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
32601
|
-
* @version
|
|
33324
|
+
* @version 176.0.0
|
|
32602
33325
|
*/
|
|
32603
33326
|
|
|
32604
33327
|
/**
|
|
@@ -32820,7 +33543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32820
33543
|
/**
|
|
32821
33544
|
* Learning service.
|
|
32822
33545
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
32823
|
-
* @version
|
|
33546
|
+
* @version 176.0.0
|
|
32824
33547
|
*/
|
|
32825
33548
|
|
|
32826
33549
|
/**
|
|
@@ -33463,8 +34186,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33463
34186
|
* Publish a Learning module
|
|
33464
34187
|
*
|
|
33465
34188
|
* @param {String} moduleId The ID of the learning module
|
|
34189
|
+
* @param {Object} opts Optional parameters
|
|
34190
|
+
* @param {Object} opts.body The request body
|
|
33466
34191
|
*/
|
|
33467
|
-
postLearningModulePublish(moduleId) {
|
|
34192
|
+
postLearningModulePublish(moduleId, opts) {
|
|
34193
|
+
opts = opts || {};
|
|
34194
|
+
|
|
33468
34195
|
// verify the required parameter 'moduleId' is set
|
|
33469
34196
|
if (moduleId === undefined || moduleId === null) {
|
|
33470
34197
|
throw 'Missing the required parameter "moduleId" when calling postLearningModulePublish';
|
|
@@ -33477,7 +34204,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33477
34204
|
{ },
|
|
33478
34205
|
{ },
|
|
33479
34206
|
{ },
|
|
33480
|
-
|
|
34207
|
+
opts['body'],
|
|
33481
34208
|
['PureCloud OAuth'],
|
|
33482
34209
|
['application/json'],
|
|
33483
34210
|
['application/json']
|
|
@@ -33635,7 +34362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33635
34362
|
/**
|
|
33636
34363
|
* License service.
|
|
33637
34364
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
33638
|
-
* @version
|
|
34365
|
+
* @version 176.0.0
|
|
33639
34366
|
*/
|
|
33640
34367
|
|
|
33641
34368
|
/**
|
|
@@ -33873,7 +34600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33873
34600
|
/**
|
|
33874
34601
|
* Locations service.
|
|
33875
34602
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
33876
|
-
* @version
|
|
34603
|
+
* @version 176.0.0
|
|
33877
34604
|
*/
|
|
33878
34605
|
|
|
33879
34606
|
/**
|
|
@@ -34109,7 +34836,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34109
34836
|
/**
|
|
34110
34837
|
* Messaging service.
|
|
34111
34838
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34112
|
-
* @version
|
|
34839
|
+
* @version 176.0.0
|
|
34113
34840
|
*/
|
|
34114
34841
|
|
|
34115
34842
|
/**
|
|
@@ -34468,7 +35195,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34468
35195
|
/**
|
|
34469
35196
|
* MobileDevices service.
|
|
34470
35197
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
34471
|
-
* @version
|
|
35198
|
+
* @version 176.0.0
|
|
34472
35199
|
*/
|
|
34473
35200
|
|
|
34474
35201
|
/**
|
|
@@ -34619,7 +35346,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34619
35346
|
/**
|
|
34620
35347
|
* Notifications service.
|
|
34621
35348
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
34622
|
-
* @version
|
|
35349
|
+
* @version 176.0.0
|
|
34623
35350
|
*/
|
|
34624
35351
|
|
|
34625
35352
|
/**
|
|
@@ -34852,7 +35579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34852
35579
|
/**
|
|
34853
35580
|
* OAuth service.
|
|
34854
35581
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
34855
|
-
* @version
|
|
35582
|
+
* @version 176.0.0
|
|
34856
35583
|
*/
|
|
34857
35584
|
|
|
34858
35585
|
/**
|
|
@@ -35218,7 +35945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35218
35945
|
/**
|
|
35219
35946
|
* Objects service.
|
|
35220
35947
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
35221
|
-
* @version
|
|
35948
|
+
* @version 176.0.0
|
|
35222
35949
|
*/
|
|
35223
35950
|
|
|
35224
35951
|
/**
|
|
@@ -35489,7 +36216,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35489
36216
|
/**
|
|
35490
36217
|
* Organization service.
|
|
35491
36218
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
35492
|
-
* @version
|
|
36219
|
+
* @version 176.0.0
|
|
35493
36220
|
*/
|
|
35494
36221
|
|
|
35495
36222
|
/**
|
|
@@ -35944,7 +36671,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35944
36671
|
/**
|
|
35945
36672
|
* OrganizationAuthorization service.
|
|
35946
36673
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
35947
|
-
* @version
|
|
36674
|
+
* @version 176.0.0
|
|
35948
36675
|
*/
|
|
35949
36676
|
|
|
35950
36677
|
/**
|
|
@@ -37291,7 +38018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37291
38018
|
/**
|
|
37292
38019
|
* Outbound service.
|
|
37293
38020
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
37294
|
-
* @version
|
|
38021
|
+
* @version 176.0.0
|
|
37295
38022
|
*/
|
|
37296
38023
|
|
|
37297
38024
|
/**
|
|
@@ -40913,7 +41640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40913
41640
|
/**
|
|
40914
41641
|
* Presence service.
|
|
40915
41642
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
40916
|
-
* @version
|
|
41643
|
+
* @version 176.0.0
|
|
40917
41644
|
*/
|
|
40918
41645
|
|
|
40919
41646
|
/**
|
|
@@ -41652,7 +42379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41652
42379
|
/**
|
|
41653
42380
|
* ProcessAutomation service.
|
|
41654
42381
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
41655
|
-
* @version
|
|
42382
|
+
* @version 176.0.0
|
|
41656
42383
|
*/
|
|
41657
42384
|
|
|
41658
42385
|
/**
|
|
@@ -41891,7 +42618,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41891
42618
|
/**
|
|
41892
42619
|
* Quality service.
|
|
41893
42620
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
41894
|
-
* @version
|
|
42621
|
+
* @version 176.0.0
|
|
41895
42622
|
*/
|
|
41896
42623
|
|
|
41897
42624
|
/**
|
|
@@ -43645,7 +44372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43645
44372
|
/**
|
|
43646
44373
|
* Recording service.
|
|
43647
44374
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
43648
|
-
* @version
|
|
44375
|
+
* @version 176.0.0
|
|
43649
44376
|
*/
|
|
43650
44377
|
|
|
43651
44378
|
/**
|
|
@@ -45282,7 +46009,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45282
46009
|
/**
|
|
45283
46010
|
* ResponseManagement service.
|
|
45284
46011
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
45285
|
-
* @version
|
|
46012
|
+
* @version 176.0.0
|
|
45286
46013
|
*/
|
|
45287
46014
|
|
|
45288
46015
|
/**
|
|
@@ -45767,7 +46494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45767
46494
|
/**
|
|
45768
46495
|
* Routing service.
|
|
45769
46496
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
45770
|
-
* @version
|
|
46497
|
+
* @version 176.0.0
|
|
45771
46498
|
*/
|
|
45772
46499
|
|
|
45773
46500
|
/**
|
|
@@ -47825,8 +48552,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47825
48552
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47826
48553
|
* @param {Object} opts.sortBy Sort by (default to name)
|
|
47827
48554
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
47828
|
-
* @param {Array.<String>} opts.id Filter by wrapup code ID(s)
|
|
47829
48555
|
* @param {String} opts.name Wrapup code's name ('Sort by' param is ignored unless this field is provided)
|
|
48556
|
+
* @param {Array.<String>} opts.id Filter by wrapup code ID(s)
|
|
47830
48557
|
* @param {Array.<String>} opts.divisionId Filter by division ID(s)
|
|
47831
48558
|
*/
|
|
47832
48559
|
getRoutingWrapupcodes(opts) {
|
|
@@ -47837,7 +48564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47837
48564
|
'/api/v2/routing/wrapupcodes',
|
|
47838
48565
|
'GET',
|
|
47839
48566
|
{ },
|
|
47840
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'
|
|
48567
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
47841
48568
|
{ },
|
|
47842
48569
|
{ },
|
|
47843
48570
|
null,
|
|
@@ -49475,7 +50202,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49475
50202
|
/**
|
|
49476
50203
|
* SCIM service.
|
|
49477
50204
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
49478
|
-
* @version
|
|
50205
|
+
* @version 176.0.0
|
|
49479
50206
|
*/
|
|
49480
50207
|
|
|
49481
50208
|
/**
|
|
@@ -50352,7 +51079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50352
51079
|
/**
|
|
50353
51080
|
* Scripts service.
|
|
50354
51081
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
50355
|
-
* @version
|
|
51082
|
+
* @version 176.0.0
|
|
50356
51083
|
*/
|
|
50357
51084
|
|
|
50358
51085
|
/**
|
|
@@ -50796,7 +51523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50796
51523
|
/**
|
|
50797
51524
|
* Search service.
|
|
50798
51525
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
50799
|
-
* @version
|
|
51526
|
+
* @version 176.0.0
|
|
50800
51527
|
*/
|
|
50801
51528
|
|
|
50802
51529
|
/**
|
|
@@ -51485,7 +52212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51485
52212
|
/**
|
|
51486
52213
|
* Settings service.
|
|
51487
52214
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
51488
|
-
* @version
|
|
52215
|
+
* @version 176.0.0
|
|
51489
52216
|
*/
|
|
51490
52217
|
|
|
51491
52218
|
/**
|
|
@@ -51550,7 +52277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51550
52277
|
/**
|
|
51551
52278
|
* SpeechTextAnalytics service.
|
|
51552
52279
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
51553
|
-
* @version
|
|
52280
|
+
* @version 176.0.0
|
|
51554
52281
|
*/
|
|
51555
52282
|
|
|
51556
52283
|
/**
|
|
@@ -52533,7 +53260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52533
53260
|
/**
|
|
52534
53261
|
* Stations service.
|
|
52535
53262
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
52536
|
-
* @version
|
|
53263
|
+
* @version 176.0.0
|
|
52537
53264
|
*/
|
|
52538
53265
|
|
|
52539
53266
|
/**
|
|
@@ -52635,7 +53362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52635
53362
|
/**
|
|
52636
53363
|
* Suggest service.
|
|
52637
53364
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
52638
|
-
* @version
|
|
53365
|
+
* @version 176.0.0
|
|
52639
53366
|
*/
|
|
52640
53367
|
|
|
52641
53368
|
/**
|
|
@@ -52774,7 +53501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52774
53501
|
/**
|
|
52775
53502
|
* TaskManagement service.
|
|
52776
53503
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
52777
|
-
* @version
|
|
53504
|
+
* @version 176.0.0
|
|
52778
53505
|
*/
|
|
52779
53506
|
|
|
52780
53507
|
/**
|
|
@@ -54055,7 +54782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54055
54782
|
/**
|
|
54056
54783
|
* Teams service.
|
|
54057
54784
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
54058
|
-
* @version
|
|
54785
|
+
* @version 176.0.0
|
|
54059
54786
|
*/
|
|
54060
54787
|
|
|
54061
54788
|
/**
|
|
@@ -54357,7 +55084,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54357
55084
|
/**
|
|
54358
55085
|
* Telephony service.
|
|
54359
55086
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
54360
|
-
* @version
|
|
55087
|
+
* @version 176.0.0
|
|
54361
55088
|
*/
|
|
54362
55089
|
|
|
54363
55090
|
/**
|
|
@@ -54485,7 +55212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54485
55212
|
/**
|
|
54486
55213
|
* TelephonyProvidersEdge service.
|
|
54487
55214
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
54488
|
-
* @version
|
|
55215
|
+
* @version 176.0.0
|
|
54489
55216
|
*/
|
|
54490
55217
|
|
|
54491
55218
|
/**
|
|
@@ -57774,7 +58501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57774
58501
|
/**
|
|
57775
58502
|
* Textbots service.
|
|
57776
58503
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
57777
|
-
* @version
|
|
58504
|
+
* @version 176.0.0
|
|
57778
58505
|
*/
|
|
57779
58506
|
|
|
57780
58507
|
/**
|
|
@@ -57902,7 +58629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57902
58629
|
/**
|
|
57903
58630
|
* Tokens service.
|
|
57904
58631
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
57905
|
-
* @version
|
|
58632
|
+
* @version 176.0.0
|
|
57906
58633
|
*/
|
|
57907
58634
|
|
|
57908
58635
|
/**
|
|
@@ -58058,7 +58785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58058
58785
|
/**
|
|
58059
58786
|
* Uploads service.
|
|
58060
58787
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
58061
|
-
* @version
|
|
58788
|
+
* @version 176.0.0
|
|
58062
58789
|
*/
|
|
58063
58790
|
|
|
58064
58791
|
/**
|
|
@@ -58234,7 +58961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58234
58961
|
/**
|
|
58235
58962
|
* Usage service.
|
|
58236
58963
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
58237
|
-
* @version
|
|
58964
|
+
* @version 176.0.0
|
|
58238
58965
|
*/
|
|
58239
58966
|
|
|
58240
58967
|
/**
|
|
@@ -58444,7 +59171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58444
59171
|
/**
|
|
58445
59172
|
* UserRecordings service.
|
|
58446
59173
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
58447
|
-
* @version
|
|
59174
|
+
* @version 176.0.0
|
|
58448
59175
|
*/
|
|
58449
59176
|
|
|
58450
59177
|
/**
|
|
@@ -58629,7 +59356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58629
59356
|
/**
|
|
58630
59357
|
* Users service.
|
|
58631
59358
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
58632
|
-
* @version
|
|
59359
|
+
* @version 176.0.0
|
|
58633
59360
|
*/
|
|
58634
59361
|
|
|
58635
59362
|
/**
|
|
@@ -61190,7 +61917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61190
61917
|
/**
|
|
61191
61918
|
* Utilities service.
|
|
61192
61919
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
61193
|
-
* @version
|
|
61920
|
+
* @version 176.0.0
|
|
61194
61921
|
*/
|
|
61195
61922
|
|
|
61196
61923
|
/**
|
|
@@ -61301,7 +62028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61301
62028
|
/**
|
|
61302
62029
|
* Voicemail service.
|
|
61303
62030
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
61304
|
-
* @version
|
|
62031
|
+
* @version 176.0.0
|
|
61305
62032
|
*/
|
|
61306
62033
|
|
|
61307
62034
|
/**
|
|
@@ -61968,7 +62695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61968
62695
|
/**
|
|
61969
62696
|
* WebChat service.
|
|
61970
62697
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
61971
|
-
* @version
|
|
62698
|
+
* @version 176.0.0
|
|
61972
62699
|
*/
|
|
61973
62700
|
|
|
61974
62701
|
/**
|
|
@@ -62517,7 +63244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62517
63244
|
/**
|
|
62518
63245
|
* WebDeployments service.
|
|
62519
63246
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
62520
|
-
* @version
|
|
63247
|
+
* @version 176.0.0
|
|
62521
63248
|
*/
|
|
62522
63249
|
|
|
62523
63250
|
/**
|
|
@@ -63044,7 +63771,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63044
63771
|
/**
|
|
63045
63772
|
* WebMessaging service.
|
|
63046
63773
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
63047
|
-
* @version
|
|
63774
|
+
* @version 176.0.0
|
|
63048
63775
|
*/
|
|
63049
63776
|
|
|
63050
63777
|
/**
|
|
@@ -63090,7 +63817,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63090
63817
|
/**
|
|
63091
63818
|
* Widgets service.
|
|
63092
63819
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
63093
|
-
* @version
|
|
63820
|
+
* @version 176.0.0
|
|
63094
63821
|
*/
|
|
63095
63822
|
|
|
63096
63823
|
/**
|
|
@@ -63236,7 +63963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63236
63963
|
/**
|
|
63237
63964
|
* WorkforceManagement service.
|
|
63238
63965
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
63239
|
-
* @version
|
|
63966
|
+
* @version 176.0.0
|
|
63240
63967
|
*/
|
|
63241
63968
|
|
|
63242
63969
|
/**
|
|
@@ -68400,7 +69127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68400
69127
|
* </pre>
|
|
68401
69128
|
* </p>
|
|
68402
69129
|
* @module purecloud-platform-client-v2/index
|
|
68403
|
-
* @version
|
|
69130
|
+
* @version 176.0.0
|
|
68404
69131
|
*/
|
|
68405
69132
|
class platformClient {
|
|
68406
69133
|
constructor() {
|