purecloud-platform-client-v2 206.0.0 → 207.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 +100 -3
- package/dist/node/purecloud-platform-client-v2.js +675 -129
- package/dist/web-amd/purecloud-platform-client-v2.js +675 -129
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +236 -132
- package/dist/web-cjs/purecloud-platform-client-v2.js +236 -132
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +775 -270
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +7 -6
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +232 -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 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -19
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +48 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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 +7 -3
- 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 +27 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -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/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -262,6 +262,7 @@ class Configuration {
|
|
|
262
262
|
this.basePath;
|
|
263
263
|
this.authUrl;
|
|
264
264
|
this.config;
|
|
265
|
+
this.gateway = undefined;
|
|
265
266
|
this.logger = new Logger();
|
|
266
267
|
this.setEnvironment();
|
|
267
268
|
this.liveLoadConfig();
|
|
@@ -359,12 +360,72 @@ class Configuration {
|
|
|
359
360
|
: this.live_reload_config;
|
|
360
361
|
this.host = this.getConfigString('general', 'host') !== undefined ? this.getConfigString('general', 'host') : this.host;
|
|
361
362
|
|
|
363
|
+
if (this.getConfigString('gateway', 'host') !== undefined) {
|
|
364
|
+
let gateway = {
|
|
365
|
+
host: this.getConfigString('gateway', 'host')
|
|
366
|
+
};
|
|
367
|
+
if (this.getConfigString('gateway', 'protocol') !== undefined) gateway.protocol = this.getConfigString('gateway', 'protocol');
|
|
368
|
+
if (this.getConfigInt('gateway', 'port') !== undefined) gateway.port = this.getConfigInt('gateway', 'port');
|
|
369
|
+
if (this.getConfigString('gateway', 'path_params_login') !== undefined) gateway.path_params_login = this.getConfigString('gateway', 'path_params_login');
|
|
370
|
+
if (this.getConfigString('gateway', 'path_params_api') !== undefined) gateway.path_params_api = this.getConfigString('gateway', 'path_params_api');
|
|
371
|
+
if (this.getConfigString('gateway', 'username') !== undefined) gateway.username = this.getConfigString('gateway', 'username');
|
|
372
|
+
if (this.getConfigString('gateway', 'password') !== undefined) gateway.password = this.getConfigString('gateway', 'password');
|
|
373
|
+
this.setGateway(gateway);
|
|
374
|
+
} else {
|
|
375
|
+
this.setGateway();
|
|
376
|
+
}
|
|
377
|
+
|
|
362
378
|
this.setEnvironment();
|
|
363
379
|
|
|
364
380
|
// Update logging configs
|
|
365
381
|
this.logger.setLogger();
|
|
366
382
|
}
|
|
367
383
|
|
|
384
|
+
/**
|
|
385
|
+
* @description Sets the gateway used by the session
|
|
386
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
387
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
388
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
389
|
+
* @param {number} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater or equal to 0).
|
|
390
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
391
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
392
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
393
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
394
|
+
*/
|
|
395
|
+
setGateway(gateway) {
|
|
396
|
+
if (gateway) {
|
|
397
|
+
this.gateway = {
|
|
398
|
+
host: ''
|
|
399
|
+
};
|
|
400
|
+
|
|
401
|
+
if (gateway.protocol) this.gateway.protocol = gateway.protocol;
|
|
402
|
+
else this.gateway.protocol = 'https';
|
|
403
|
+
|
|
404
|
+
if (gateway.host) this.gateway.host = gateway.host;
|
|
405
|
+
else this.gateway.host = '';
|
|
406
|
+
|
|
407
|
+
if (gateway.port && gateway.port > -1) this.gateway.port = gateway.port;
|
|
408
|
+
else this.gateway.port = -1;
|
|
409
|
+
|
|
410
|
+
if (gateway.path_params_login) {
|
|
411
|
+
this.gateway.path_params_login = gateway.path_params_login;
|
|
412
|
+
// Strip trailing slash
|
|
413
|
+
this.gateway.path_params_login = this.gateway.path_params_login.replace(/\/+$/, '');
|
|
414
|
+
} else this.gateway.path_params_login = '';
|
|
415
|
+
|
|
416
|
+
if (gateway.path_params_api) {
|
|
417
|
+
this.gateway.path_params_api = gateway.path_params_api;
|
|
418
|
+
// Strip trailing slash
|
|
419
|
+
this.gateway.path_params_api = this.gateway.path_params_api.replace(/\/+$/, '');
|
|
420
|
+
} else this.gateway.path_params_api = '';
|
|
421
|
+
|
|
422
|
+
if (gateway.username) this.gateway.username = gateway.username;
|
|
423
|
+
if (gateway.password) this.gateway.password = gateway.password;
|
|
424
|
+
} else {
|
|
425
|
+
this.gateway = undefined;
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
|
|
368
429
|
setEnvironment(env) {
|
|
369
430
|
// Default value
|
|
370
431
|
if (env) this.environment = env;
|
|
@@ -382,6 +443,26 @@ class Configuration {
|
|
|
382
443
|
this.authUrl = `https://login.${this.environment}`;
|
|
383
444
|
}
|
|
384
445
|
|
|
446
|
+
getConfUrl(pathType, regionUrl) {
|
|
447
|
+
if (!this.gateway) return regionUrl;
|
|
448
|
+
if (!this.gateway.host) return regionUrl;
|
|
449
|
+
|
|
450
|
+
var url = this.gateway.protocol + '://' + this.gateway.host;
|
|
451
|
+
if (this.gateway.port > -1) url = url + ':' + this.gateway.port.toString();
|
|
452
|
+
if (pathType === 'login') {
|
|
453
|
+
if (this.gateway.path_params_login) {
|
|
454
|
+
if (this.gateway.path_params_login.startsWith('/')) url = url + this.gateway.path_params_login;
|
|
455
|
+
else url = url + '/' + this.gateway.path_params_login;
|
|
456
|
+
}
|
|
457
|
+
} else {
|
|
458
|
+
if (this.gateway.path_params_api) {
|
|
459
|
+
if (this.gateway.path_params_api.startsWith('/')) url = url + this.gateway.path_params_api;
|
|
460
|
+
else url = url + '/' + this.gateway.path_params_api;
|
|
461
|
+
}
|
|
462
|
+
}
|
|
463
|
+
return url;
|
|
464
|
+
}
|
|
465
|
+
|
|
385
466
|
getConfigString(section, key) {
|
|
386
467
|
if (this.config._sections[section]) return this.config._sections[section][key];
|
|
387
468
|
}
|
|
@@ -405,7 +486,7 @@ class Configuration {
|
|
|
405
486
|
|
|
406
487
|
/**
|
|
407
488
|
* @module purecloud-platform-client-v2/ApiClient
|
|
408
|
-
* @version
|
|
489
|
+
* @version 207.0.0
|
|
409
490
|
*/
|
|
410
491
|
class ApiClient {
|
|
411
492
|
/**
|
|
@@ -603,6 +684,21 @@ class ApiClient {
|
|
|
603
684
|
this.config.setEnvironment(environment);
|
|
604
685
|
}
|
|
605
686
|
|
|
687
|
+
/**
|
|
688
|
+
* @description Sets the gateway used by the session
|
|
689
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
690
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
691
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
692
|
+
* @param {string} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater than 0).
|
|
693
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
694
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
695
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
696
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
697
|
+
*/
|
|
698
|
+
setGateway(gateway) {
|
|
699
|
+
this.config.setGateway(gateway);
|
|
700
|
+
}
|
|
701
|
+
|
|
606
702
|
/**
|
|
607
703
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
608
704
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
@@ -667,6 +763,7 @@ class ApiClient {
|
|
|
667
763
|
loginClientCredentialsGrant(clientId, clientSecret) {
|
|
668
764
|
this.clientId = clientId;
|
|
669
765
|
var authHeader = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
|
|
766
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
670
767
|
|
|
671
768
|
return new Promise((resolve, reject) => {
|
|
672
769
|
// Block browsers from using client credentials
|
|
@@ -679,7 +776,7 @@ class ApiClient {
|
|
|
679
776
|
};
|
|
680
777
|
axios__default["default"]({
|
|
681
778
|
method: `POST`,
|
|
682
|
-
url:
|
|
779
|
+
url: `${loginBasePath}/oauth/token`,
|
|
683
780
|
headers: headers,
|
|
684
781
|
data: 'grant_type=client_credentials',
|
|
685
782
|
httpsAgent: this.proxyAgent
|
|
@@ -690,7 +787,7 @@ class ApiClient {
|
|
|
690
787
|
'trace',
|
|
691
788
|
response.status,
|
|
692
789
|
'POST',
|
|
693
|
-
|
|
790
|
+
`${loginBasePath}/oauth/token`,
|
|
694
791
|
headers,
|
|
695
792
|
response.headers,
|
|
696
793
|
{ grant_type: 'client_credentials' },
|
|
@@ -700,7 +797,7 @@ class ApiClient {
|
|
|
700
797
|
'debug',
|
|
701
798
|
response.status,
|
|
702
799
|
'POST',
|
|
703
|
-
|
|
800
|
+
`${loginBasePath}/oauth/token`,
|
|
704
801
|
headers,
|
|
705
802
|
undefined,
|
|
706
803
|
{ grant_type: 'client_credentials' },
|
|
@@ -724,7 +821,7 @@ class ApiClient {
|
|
|
724
821
|
'error',
|
|
725
822
|
error.response.status,
|
|
726
823
|
'POST',
|
|
727
|
-
|
|
824
|
+
`${loginBasePath}/oauth/token`,
|
|
728
825
|
headers,
|
|
729
826
|
error.response.headers,
|
|
730
827
|
{ grant_type: 'client_credentials' },
|
|
@@ -745,6 +842,7 @@ class ApiClient {
|
|
|
745
842
|
*/
|
|
746
843
|
loginSaml2BearerGrant(clientId, clientSecret, orgName, assertion) {
|
|
747
844
|
this.clientId = clientId;
|
|
845
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
748
846
|
return new Promise((resolve, reject) => {
|
|
749
847
|
if (typeof window !== 'undefined') {
|
|
750
848
|
reject(new Error('The saml2bearer grant is not supported in a browser.'));
|
|
@@ -770,7 +868,7 @@ class ApiClient {
|
|
|
770
868
|
'trace',
|
|
771
869
|
response.status,
|
|
772
870
|
'POST',
|
|
773
|
-
|
|
871
|
+
`${loginBasePath}/oauth/token`,
|
|
774
872
|
request.headers,
|
|
775
873
|
response.headers,
|
|
776
874
|
bodyParam,
|
|
@@ -780,7 +878,7 @@ class ApiClient {
|
|
|
780
878
|
'debug',
|
|
781
879
|
response.status,
|
|
782
880
|
'POST',
|
|
783
|
-
|
|
881
|
+
`${loginBasePath}/oauth/token`,
|
|
784
882
|
request.headers,
|
|
785
883
|
undefined,
|
|
786
884
|
bodyParam,
|
|
@@ -804,7 +902,7 @@ class ApiClient {
|
|
|
804
902
|
'error',
|
|
805
903
|
error.response.status,
|
|
806
904
|
'POST',
|
|
807
|
-
|
|
905
|
+
`${loginBasePath}/oauth/token`,
|
|
808
906
|
request.headers,
|
|
809
907
|
error.response.headers,
|
|
810
908
|
bodyParam,
|
|
@@ -825,10 +923,11 @@ class ApiClient {
|
|
|
825
923
|
*/
|
|
826
924
|
authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
|
|
827
925
|
this.clientId = clientId;
|
|
926
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
828
927
|
return new Promise((resolve, reject) => {
|
|
829
928
|
var request = axios__default["default"]({
|
|
830
929
|
method: `POST`,
|
|
831
|
-
url:
|
|
930
|
+
url: `${loginBasePath}/oauth/token`,
|
|
832
931
|
headers: {
|
|
833
932
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
834
933
|
},
|
|
@@ -855,7 +954,7 @@ class ApiClient {
|
|
|
855
954
|
'trace',
|
|
856
955
|
response.status,
|
|
857
956
|
'POST',
|
|
858
|
-
|
|
957
|
+
`${loginBasePath}/oauth/token`,
|
|
859
958
|
request.headers,
|
|
860
959
|
response.headers,
|
|
861
960
|
bodyParam,
|
|
@@ -865,7 +964,7 @@ class ApiClient {
|
|
|
865
964
|
'debug',
|
|
866
965
|
response.status,
|
|
867
966
|
'POST',
|
|
868
|
-
|
|
967
|
+
`${loginBasePath}/oauth/token`,
|
|
869
968
|
request.headers,
|
|
870
969
|
undefined,
|
|
871
970
|
bodyParam,
|
|
@@ -889,7 +988,7 @@ class ApiClient {
|
|
|
889
988
|
'error',
|
|
890
989
|
error.response.status,
|
|
891
990
|
'POST',
|
|
892
|
-
|
|
991
|
+
`${loginBasePath}/oauth/token`,
|
|
893
992
|
request.headers,
|
|
894
993
|
error.response.headers,
|
|
895
994
|
bodyParam,
|
|
@@ -1213,6 +1312,8 @@ class ApiClient {
|
|
|
1213
1312
|
* @param {function} reject - Promise reject callback
|
|
1214
1313
|
*/
|
|
1215
1314
|
_handleCodeAuthorizationResponse(request, bodyParam, resolve, reject) {
|
|
1315
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
1316
|
+
|
|
1216
1317
|
request
|
|
1217
1318
|
.then((response) => {
|
|
1218
1319
|
// Logging
|
|
@@ -1220,7 +1321,7 @@ class ApiClient {
|
|
|
1220
1321
|
'trace',
|
|
1221
1322
|
response.status,
|
|
1222
1323
|
'POST',
|
|
1223
|
-
|
|
1324
|
+
`${loginBasePath}/oauth/token`,
|
|
1224
1325
|
request.headers,
|
|
1225
1326
|
response.headers,
|
|
1226
1327
|
bodyParam,
|
|
@@ -1230,7 +1331,7 @@ class ApiClient {
|
|
|
1230
1331
|
'debug',
|
|
1231
1332
|
response.status,
|
|
1232
1333
|
'POST',
|
|
1233
|
-
|
|
1334
|
+
`${loginBasePath}/oauth/token`,
|
|
1234
1335
|
request.headers,
|
|
1235
1336
|
undefined,
|
|
1236
1337
|
bodyParam,
|
|
@@ -1256,7 +1357,7 @@ class ApiClient {
|
|
|
1256
1357
|
'error',
|
|
1257
1358
|
error.response.status,
|
|
1258
1359
|
'POST',
|
|
1259
|
-
|
|
1360
|
+
`${loginBasePath}/oauth/token`,
|
|
1260
1361
|
request.headers,
|
|
1261
1362
|
error.response.headers,
|
|
1262
1363
|
bodyParam,
|
|
@@ -1274,9 +1375,10 @@ class ApiClient {
|
|
|
1274
1375
|
* @param {object} data - data to url form encode
|
|
1275
1376
|
*/
|
|
1276
1377
|
_formAuthRequest(encodedData, data) {
|
|
1378
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
1277
1379
|
var request = axios__default["default"]({
|
|
1278
1380
|
method: `POST`,
|
|
1279
|
-
url:
|
|
1381
|
+
url: `${loginBasePath}/oauth/token`,
|
|
1280
1382
|
headers: {
|
|
1281
1383
|
'Authorization': 'Basic ' + encodedData,
|
|
1282
1384
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
@@ -1465,7 +1567,8 @@ class ApiClient {
|
|
|
1465
1567
|
*/
|
|
1466
1568
|
_buildAuthUrl(path, query) {
|
|
1467
1569
|
if (!query) query = {};
|
|
1468
|
-
|
|
1570
|
+
var loginBasePath = this.config.getConfUrl('login', this.config.authUrl);
|
|
1571
|
+
return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
|
|
1469
1572
|
}
|
|
1470
1573
|
|
|
1471
1574
|
/**
|
|
@@ -1527,7 +1630,7 @@ class ApiClient {
|
|
|
1527
1630
|
if (!path.match(/^\//)) {
|
|
1528
1631
|
path = `/${path}`;
|
|
1529
1632
|
}
|
|
1530
|
-
var url = this.config.basePath + path;
|
|
1633
|
+
var url = this.config.getConfUrl('api', this.config.basePath) + path;
|
|
1531
1634
|
url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
|
|
1532
1635
|
var value;
|
|
1533
1636
|
if (pathParams.hasOwnProperty(key)) {
|
|
@@ -1827,7 +1930,7 @@ class AgentAssistantsApi {
|
|
|
1827
1930
|
/**
|
|
1828
1931
|
* AgentAssistants service.
|
|
1829
1932
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1830
|
-
* @version
|
|
1933
|
+
* @version 207.0.0
|
|
1831
1934
|
*/
|
|
1832
1935
|
|
|
1833
1936
|
/**
|
|
@@ -2203,7 +2306,7 @@ class AgentCopilotApi {
|
|
|
2203
2306
|
/**
|
|
2204
2307
|
* AgentCopilot service.
|
|
2205
2308
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2206
|
-
* @version
|
|
2309
|
+
* @version 207.0.0
|
|
2207
2310
|
*/
|
|
2208
2311
|
|
|
2209
2312
|
/**
|
|
@@ -2279,7 +2382,7 @@ class AgentUIApi {
|
|
|
2279
2382
|
/**
|
|
2280
2383
|
* AgentUI service.
|
|
2281
2384
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2282
|
-
* @version
|
|
2385
|
+
* @version 207.0.0
|
|
2283
2386
|
*/
|
|
2284
2387
|
|
|
2285
2388
|
/**
|
|
@@ -2410,7 +2513,7 @@ class AlertingApi {
|
|
|
2410
2513
|
/**
|
|
2411
2514
|
* Alerting service.
|
|
2412
2515
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2413
|
-
* @version
|
|
2516
|
+
* @version 207.0.0
|
|
2414
2517
|
*/
|
|
2415
2518
|
|
|
2416
2519
|
/**
|
|
@@ -3071,7 +3174,7 @@ class AnalyticsApi {
|
|
|
3071
3174
|
/**
|
|
3072
3175
|
* Analytics service.
|
|
3073
3176
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3074
|
-
* @version
|
|
3177
|
+
* @version 207.0.0
|
|
3075
3178
|
*/
|
|
3076
3179
|
|
|
3077
3180
|
/**
|
|
@@ -3922,6 +4025,7 @@ class AnalyticsApi {
|
|
|
3922
4025
|
* @param {Number} opts.pageSize (default to 25)
|
|
3923
4026
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
3924
4027
|
* @param {Object} opts.state Only list users of this state
|
|
4028
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
3925
4029
|
*/
|
|
3926
4030
|
getAnalyticsReportingDashboardsUsers(opts) {
|
|
3927
4031
|
opts = opts || {};
|
|
@@ -3931,7 +4035,7 @@ class AnalyticsApi {
|
|
|
3931
4035
|
'/api/v2/analytics/reporting/dashboards/users',
|
|
3932
4036
|
'GET',
|
|
3933
4037
|
{ },
|
|
3934
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
|
|
4038
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'],'deletedOnly': opts['deletedOnly'] },
|
|
3935
4039
|
{ },
|
|
3936
4040
|
{ },
|
|
3937
4041
|
null,
|
|
@@ -4053,6 +4157,7 @@ class AnalyticsApi {
|
|
|
4053
4157
|
* @param {Number} opts.pageSize (default to 50)
|
|
4054
4158
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
4055
4159
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
4160
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
4056
4161
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
4057
4162
|
*/
|
|
4058
4163
|
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
@@ -4067,7 +4172,7 @@ class AnalyticsApi {
|
|
|
4067
4172
|
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
4068
4173
|
'GET',
|
|
4069
4174
|
{ 'userId': userId },
|
|
4070
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
|
|
4175
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'deletedOnly': opts['deletedOnly'],'name': opts['name'] },
|
|
4071
4176
|
{ },
|
|
4072
4177
|
{ },
|
|
4073
4178
|
null,
|
|
@@ -5157,7 +5262,7 @@ class AnalyticsApi {
|
|
|
5157
5262
|
}
|
|
5158
5263
|
|
|
5159
5264
|
/**
|
|
5160
|
-
* Bulk delete dashboards owned by other user(s)
|
|
5265
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
5161
5266
|
*
|
|
5162
5267
|
* @param {Array.<String>} body List of userIds
|
|
5163
5268
|
*/
|
|
@@ -5207,7 +5312,7 @@ class AnalyticsApi {
|
|
|
5207
5312
|
}
|
|
5208
5313
|
|
|
5209
5314
|
/**
|
|
5210
|
-
* Bulk
|
|
5315
|
+
* Bulk soft delete dashboard configurations
|
|
5211
5316
|
*
|
|
5212
5317
|
* @param {Object} body
|
|
5213
5318
|
*/
|
|
@@ -5393,7 +5498,6 @@ class AnalyticsApi {
|
|
|
5393
5498
|
* Query for task management aggregates
|
|
5394
5499
|
*
|
|
5395
5500
|
* @param {Object} body query
|
|
5396
|
-
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5397
5501
|
*/
|
|
5398
5502
|
postAnalyticsTaskmanagementAggregatesQuery(body) {
|
|
5399
5503
|
// verify the required parameter 'body' is set
|
|
@@ -5683,7 +5787,7 @@ class ArchitectApi {
|
|
|
5683
5787
|
/**
|
|
5684
5788
|
* Architect service.
|
|
5685
5789
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5686
|
-
* @version
|
|
5790
|
+
* @version 207.0.0
|
|
5687
5791
|
*/
|
|
5688
5792
|
|
|
5689
5793
|
/**
|
|
@@ -7428,7 +7532,7 @@ class ArchitectApi {
|
|
|
7428
7532
|
}
|
|
7429
7533
|
|
|
7430
7534
|
/**
|
|
7431
|
-
*
|
|
7535
|
+
* Get flow version configuration
|
|
7432
7536
|
*
|
|
7433
7537
|
* @param {String} flowId Flow ID
|
|
7434
7538
|
* @param {String} versionId Version ID
|
|
@@ -9805,7 +9909,7 @@ class AuditApi {
|
|
|
9805
9909
|
/**
|
|
9806
9910
|
* Audit service.
|
|
9807
9911
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9808
|
-
* @version
|
|
9912
|
+
* @version 207.0.0
|
|
9809
9913
|
*/
|
|
9810
9914
|
|
|
9811
9915
|
/**
|
|
@@ -10006,7 +10110,7 @@ class AuthorizationApi {
|
|
|
10006
10110
|
/**
|
|
10007
10111
|
* Authorization service.
|
|
10008
10112
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10009
|
-
* @version
|
|
10113
|
+
* @version 207.0.0
|
|
10010
10114
|
*/
|
|
10011
10115
|
|
|
10012
10116
|
/**
|
|
@@ -11289,7 +11393,7 @@ class BillingApi {
|
|
|
11289
11393
|
/**
|
|
11290
11394
|
* Billing service.
|
|
11291
11395
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11292
|
-
* @version
|
|
11396
|
+
* @version 207.0.0
|
|
11293
11397
|
*/
|
|
11294
11398
|
|
|
11295
11399
|
/**
|
|
@@ -11369,7 +11473,7 @@ class CarrierServicesApi {
|
|
|
11369
11473
|
/**
|
|
11370
11474
|
* CarrierServices service.
|
|
11371
11475
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11372
|
-
* @version
|
|
11476
|
+
* @version 207.0.0
|
|
11373
11477
|
*/
|
|
11374
11478
|
|
|
11375
11479
|
/**
|
|
@@ -11439,7 +11543,7 @@ class ChatApi {
|
|
|
11439
11543
|
/**
|
|
11440
11544
|
* Chat service.
|
|
11441
11545
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11442
|
-
* @version
|
|
11546
|
+
* @version 207.0.0
|
|
11443
11547
|
*/
|
|
11444
11548
|
|
|
11445
11549
|
/**
|
|
@@ -12375,7 +12479,7 @@ class CoachingApi {
|
|
|
12375
12479
|
/**
|
|
12376
12480
|
* Coaching service.
|
|
12377
12481
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12378
|
-
* @version
|
|
12482
|
+
* @version 207.0.0
|
|
12379
12483
|
*/
|
|
12380
12484
|
|
|
12381
12485
|
/**
|
|
@@ -12952,7 +13056,7 @@ class ContentManagementApi {
|
|
|
12952
13056
|
/**
|
|
12953
13057
|
* ContentManagement service.
|
|
12954
13058
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12955
|
-
* @version
|
|
13059
|
+
* @version 207.0.0
|
|
12956
13060
|
*/
|
|
12957
13061
|
|
|
12958
13062
|
/**
|
|
@@ -13341,7 +13445,6 @@ class ContentManagementApi {
|
|
|
13341
13445
|
* This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
|
|
13342
13446
|
* @param {String} sharedId Shared ID
|
|
13343
13447
|
* @param {Object} opts Optional parameters
|
|
13344
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
13345
13448
|
* @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
|
|
13346
13449
|
* @param {String} opts.contentType The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
|
|
13347
13450
|
* @param {Object} opts.expand Expand some document fields
|
|
@@ -13358,7 +13461,7 @@ class ContentManagementApi {
|
|
|
13358
13461
|
'/api/v2/contentmanagement/shared/{sharedId}',
|
|
13359
13462
|
'GET',
|
|
13360
13463
|
{ 'sharedId': sharedId },
|
|
13361
|
-
{ '
|
|
13464
|
+
{ 'disposition': opts['disposition'],'contentType': opts['contentType'],'expand': opts['expand'] },
|
|
13362
13465
|
{ },
|
|
13363
13466
|
{ },
|
|
13364
13467
|
null,
|
|
@@ -14034,7 +14137,7 @@ class ConversationsApi {
|
|
|
14034
14137
|
/**
|
|
14035
14138
|
* Conversations service.
|
|
14036
14139
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14037
|
-
* @version
|
|
14140
|
+
* @version 207.0.0
|
|
14038
14141
|
*/
|
|
14039
14142
|
|
|
14040
14143
|
/**
|
|
@@ -18727,9 +18830,10 @@ class ConversationsApi {
|
|
|
18727
18830
|
|
|
18728
18831
|
/**
|
|
18729
18832
|
* Suggestion feedback.
|
|
18730
|
-
*
|
|
18833
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
18731
18834
|
* @param {String} conversationId Conversation ID
|
|
18732
18835
|
* @param {Object} body SuggestionFeedback
|
|
18836
|
+
* @deprecated
|
|
18733
18837
|
*/
|
|
18734
18838
|
postConversationSuggestionsFeedback(conversationId, body) {
|
|
18735
18839
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21175,7 +21279,7 @@ class DataExtensionsApi {
|
|
|
21175
21279
|
/**
|
|
21176
21280
|
* DataExtensions service.
|
|
21177
21281
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21178
|
-
* @version
|
|
21282
|
+
* @version 207.0.0
|
|
21179
21283
|
*/
|
|
21180
21284
|
|
|
21181
21285
|
/**
|
|
@@ -21261,7 +21365,7 @@ class DownloadsApi {
|
|
|
21261
21365
|
/**
|
|
21262
21366
|
* Downloads service.
|
|
21263
21367
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21264
|
-
* @version
|
|
21368
|
+
* @version 207.0.0
|
|
21265
21369
|
*/
|
|
21266
21370
|
|
|
21267
21371
|
/**
|
|
@@ -21313,7 +21417,7 @@ class EmailsApi {
|
|
|
21313
21417
|
/**
|
|
21314
21418
|
* Emails service.
|
|
21315
21419
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21316
|
-
* @version
|
|
21420
|
+
* @version 207.0.0
|
|
21317
21421
|
*/
|
|
21318
21422
|
|
|
21319
21423
|
/**
|
|
@@ -21378,7 +21482,7 @@ class EmployeeEngagementApi {
|
|
|
21378
21482
|
/**
|
|
21379
21483
|
* EmployeeEngagement service.
|
|
21380
21484
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21381
|
-
* @version
|
|
21485
|
+
* @version 207.0.0
|
|
21382
21486
|
*/
|
|
21383
21487
|
|
|
21384
21488
|
/**
|
|
@@ -21529,7 +21633,7 @@ class EventsApi {
|
|
|
21529
21633
|
/**
|
|
21530
21634
|
* Events service.
|
|
21531
21635
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21532
|
-
* @version
|
|
21636
|
+
* @version 207.0.0
|
|
21533
21637
|
*/
|
|
21534
21638
|
|
|
21535
21639
|
/**
|
|
@@ -21625,7 +21729,7 @@ class ExternalContactsApi {
|
|
|
21625
21729
|
/**
|
|
21626
21730
|
* ExternalContacts service.
|
|
21627
21731
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21628
|
-
* @version
|
|
21732
|
+
* @version 207.0.0
|
|
21629
21733
|
*/
|
|
21630
21734
|
|
|
21631
21735
|
/**
|
|
@@ -21746,6 +21850,31 @@ class ExternalContactsApi {
|
|
|
21746
21850
|
);
|
|
21747
21851
|
}
|
|
21748
21852
|
|
|
21853
|
+
/**
|
|
21854
|
+
* Delete settings for CSV import
|
|
21855
|
+
*
|
|
21856
|
+
* @param {String} settingsId Settings id
|
|
21857
|
+
*/
|
|
21858
|
+
deleteExternalcontactsImportCsvSetting(settingsId) {
|
|
21859
|
+
// verify the required parameter 'settingsId' is set
|
|
21860
|
+
if (settingsId === undefined || settingsId === null) {
|
|
21861
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';
|
|
21862
|
+
}
|
|
21863
|
+
|
|
21864
|
+
return this.apiClient.callApi(
|
|
21865
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
21866
|
+
'DELETE',
|
|
21867
|
+
{ 'settingsId': settingsId },
|
|
21868
|
+
{ },
|
|
21869
|
+
{ },
|
|
21870
|
+
{ },
|
|
21871
|
+
null,
|
|
21872
|
+
['PureCloud OAuth'],
|
|
21873
|
+
['application/json'],
|
|
21874
|
+
['application/json']
|
|
21875
|
+
);
|
|
21876
|
+
}
|
|
21877
|
+
|
|
21749
21878
|
/**
|
|
21750
21879
|
* Delete an external organization
|
|
21751
21880
|
*
|
|
@@ -22213,6 +22342,107 @@ class ExternalContactsApi {
|
|
|
22213
22342
|
);
|
|
22214
22343
|
}
|
|
22215
22344
|
|
|
22345
|
+
/**
|
|
22346
|
+
* Get settings for CSV import
|
|
22347
|
+
*
|
|
22348
|
+
* @param {String} settingsId Settings id
|
|
22349
|
+
*/
|
|
22350
|
+
getExternalcontactsImportCsvSetting(settingsId) {
|
|
22351
|
+
// verify the required parameter 'settingsId' is set
|
|
22352
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22353
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';
|
|
22354
|
+
}
|
|
22355
|
+
|
|
22356
|
+
return this.apiClient.callApi(
|
|
22357
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
22358
|
+
'GET',
|
|
22359
|
+
{ 'settingsId': settingsId },
|
|
22360
|
+
{ },
|
|
22361
|
+
{ },
|
|
22362
|
+
{ },
|
|
22363
|
+
null,
|
|
22364
|
+
['PureCloud OAuth'],
|
|
22365
|
+
['application/json'],
|
|
22366
|
+
['application/json']
|
|
22367
|
+
);
|
|
22368
|
+
}
|
|
22369
|
+
|
|
22370
|
+
/**
|
|
22371
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
22372
|
+
*
|
|
22373
|
+
* @param {Object} opts Optional parameters
|
|
22374
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22375
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22376
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
22377
|
+
*/
|
|
22378
|
+
getExternalcontactsImportCsvSettings(opts) {
|
|
22379
|
+
opts = opts || {};
|
|
22380
|
+
|
|
22381
|
+
|
|
22382
|
+
return this.apiClient.callApi(
|
|
22383
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
22384
|
+
'GET',
|
|
22385
|
+
{ },
|
|
22386
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'externalSettingsId': opts['externalSettingsId'] },
|
|
22387
|
+
{ },
|
|
22388
|
+
{ },
|
|
22389
|
+
null,
|
|
22390
|
+
['PureCloud OAuth'],
|
|
22391
|
+
['application/json'],
|
|
22392
|
+
['application/json']
|
|
22393
|
+
);
|
|
22394
|
+
}
|
|
22395
|
+
|
|
22396
|
+
/**
|
|
22397
|
+
* Get details for CSV upload
|
|
22398
|
+
*
|
|
22399
|
+
* @param {String} uploadId Upload id
|
|
22400
|
+
*/
|
|
22401
|
+
getExternalcontactsImportCsvUploadDetails(uploadId) {
|
|
22402
|
+
// verify the required parameter 'uploadId' is set
|
|
22403
|
+
if (uploadId === undefined || uploadId === null) {
|
|
22404
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';
|
|
22405
|
+
}
|
|
22406
|
+
|
|
22407
|
+
return this.apiClient.callApi(
|
|
22408
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details',
|
|
22409
|
+
'GET',
|
|
22410
|
+
{ 'uploadId': uploadId },
|
|
22411
|
+
{ },
|
|
22412
|
+
{ },
|
|
22413
|
+
{ },
|
|
22414
|
+
null,
|
|
22415
|
+
['PureCloud OAuth'],
|
|
22416
|
+
['application/json'],
|
|
22417
|
+
['application/json']
|
|
22418
|
+
);
|
|
22419
|
+
}
|
|
22420
|
+
|
|
22421
|
+
/**
|
|
22422
|
+
* Get preview for CSV upload
|
|
22423
|
+
*
|
|
22424
|
+
* @param {String} uploadId Upload id
|
|
22425
|
+
*/
|
|
22426
|
+
getExternalcontactsImportCsvUploadPreview(uploadId) {
|
|
22427
|
+
// verify the required parameter 'uploadId' is set
|
|
22428
|
+
if (uploadId === undefined || uploadId === null) {
|
|
22429
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';
|
|
22430
|
+
}
|
|
22431
|
+
|
|
22432
|
+
return this.apiClient.callApi(
|
|
22433
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview',
|
|
22434
|
+
'GET',
|
|
22435
|
+
{ 'uploadId': uploadId },
|
|
22436
|
+
{ },
|
|
22437
|
+
{ },
|
|
22438
|
+
{ },
|
|
22439
|
+
null,
|
|
22440
|
+
['PureCloud OAuth'],
|
|
22441
|
+
['application/json'],
|
|
22442
|
+
['application/json']
|
|
22443
|
+
);
|
|
22444
|
+
}
|
|
22445
|
+
|
|
22216
22446
|
/**
|
|
22217
22447
|
* Fetch an external organization
|
|
22218
22448
|
*
|
|
@@ -23277,6 +23507,81 @@ class ExternalContactsApi {
|
|
|
23277
23507
|
);
|
|
23278
23508
|
}
|
|
23279
23509
|
|
|
23510
|
+
/**
|
|
23511
|
+
* Create CSV import job
|
|
23512
|
+
*
|
|
23513
|
+
* @param {Object} body ImportRequest
|
|
23514
|
+
*/
|
|
23515
|
+
postExternalcontactsImportCsvJobs(body) {
|
|
23516
|
+
// verify the required parameter 'body' is set
|
|
23517
|
+
if (body === undefined || body === null) {
|
|
23518
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';
|
|
23519
|
+
}
|
|
23520
|
+
|
|
23521
|
+
return this.apiClient.callApi(
|
|
23522
|
+
'/api/v2/externalcontacts/import/csv/jobs',
|
|
23523
|
+
'POST',
|
|
23524
|
+
{ },
|
|
23525
|
+
{ },
|
|
23526
|
+
{ },
|
|
23527
|
+
{ },
|
|
23528
|
+
body,
|
|
23529
|
+
['PureCloud OAuth'],
|
|
23530
|
+
['application/json'],
|
|
23531
|
+
['application/json']
|
|
23532
|
+
);
|
|
23533
|
+
}
|
|
23534
|
+
|
|
23535
|
+
/**
|
|
23536
|
+
* Create settings for CSV import
|
|
23537
|
+
*
|
|
23538
|
+
* @param {Object} body Settings
|
|
23539
|
+
*/
|
|
23540
|
+
postExternalcontactsImportCsvSettings(body) {
|
|
23541
|
+
// verify the required parameter 'body' is set
|
|
23542
|
+
if (body === undefined || body === null) {
|
|
23543
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';
|
|
23544
|
+
}
|
|
23545
|
+
|
|
23546
|
+
return this.apiClient.callApi(
|
|
23547
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
23548
|
+
'POST',
|
|
23549
|
+
{ },
|
|
23550
|
+
{ },
|
|
23551
|
+
{ },
|
|
23552
|
+
{ },
|
|
23553
|
+
body,
|
|
23554
|
+
['PureCloud OAuth'],
|
|
23555
|
+
['application/json'],
|
|
23556
|
+
['application/json']
|
|
23557
|
+
);
|
|
23558
|
+
}
|
|
23559
|
+
|
|
23560
|
+
/**
|
|
23561
|
+
* Get url for CSV upload
|
|
23562
|
+
*
|
|
23563
|
+
* @param {Object} body UploadRequest
|
|
23564
|
+
*/
|
|
23565
|
+
postExternalcontactsImportCsvUploads(body) {
|
|
23566
|
+
// verify the required parameter 'body' is set
|
|
23567
|
+
if (body === undefined || body === null) {
|
|
23568
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';
|
|
23569
|
+
}
|
|
23570
|
+
|
|
23571
|
+
return this.apiClient.callApi(
|
|
23572
|
+
'/api/v2/externalcontacts/import/csv/uploads',
|
|
23573
|
+
'POST',
|
|
23574
|
+
{ },
|
|
23575
|
+
{ },
|
|
23576
|
+
{ },
|
|
23577
|
+
{ },
|
|
23578
|
+
body,
|
|
23579
|
+
['PureCloud OAuth'],
|
|
23580
|
+
['application/json'],
|
|
23581
|
+
['application/json']
|
|
23582
|
+
);
|
|
23583
|
+
}
|
|
23584
|
+
|
|
23280
23585
|
/**
|
|
23281
23586
|
* Merge two contacts into a new contact record
|
|
23282
23587
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -23563,6 +23868,36 @@ class ExternalContactsApi {
|
|
|
23563
23868
|
);
|
|
23564
23869
|
}
|
|
23565
23870
|
|
|
23871
|
+
/**
|
|
23872
|
+
* Update settings for CSV import
|
|
23873
|
+
*
|
|
23874
|
+
* @param {String} settingsId Settings id
|
|
23875
|
+
* @param {Object} body Settings
|
|
23876
|
+
*/
|
|
23877
|
+
putExternalcontactsImportCsvSetting(settingsId, body) {
|
|
23878
|
+
// verify the required parameter 'settingsId' is set
|
|
23879
|
+
if (settingsId === undefined || settingsId === null) {
|
|
23880
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';
|
|
23881
|
+
}
|
|
23882
|
+
// verify the required parameter 'body' is set
|
|
23883
|
+
if (body === undefined || body === null) {
|
|
23884
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';
|
|
23885
|
+
}
|
|
23886
|
+
|
|
23887
|
+
return this.apiClient.callApi(
|
|
23888
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
23889
|
+
'PUT',
|
|
23890
|
+
{ 'settingsId': settingsId },
|
|
23891
|
+
{ },
|
|
23892
|
+
{ },
|
|
23893
|
+
{ },
|
|
23894
|
+
body,
|
|
23895
|
+
['PureCloud OAuth'],
|
|
23896
|
+
['application/json'],
|
|
23897
|
+
['application/json']
|
|
23898
|
+
);
|
|
23899
|
+
}
|
|
23900
|
+
|
|
23566
23901
|
/**
|
|
23567
23902
|
* Update an external organization
|
|
23568
23903
|
*
|
|
@@ -23724,7 +24059,7 @@ class FaxApi {
|
|
|
23724
24059
|
/**
|
|
23725
24060
|
* Fax service.
|
|
23726
24061
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23727
|
-
* @version
|
|
24062
|
+
* @version 207.0.0
|
|
23728
24063
|
*/
|
|
23729
24064
|
|
|
23730
24065
|
/**
|
|
@@ -23939,7 +24274,7 @@ class FlowsApi {
|
|
|
23939
24274
|
/**
|
|
23940
24275
|
* Flows service.
|
|
23941
24276
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23942
|
-
* @version
|
|
24277
|
+
* @version 207.0.0
|
|
23943
24278
|
*/
|
|
23944
24279
|
|
|
23945
24280
|
/**
|
|
@@ -24122,7 +24457,7 @@ class GamificationApi {
|
|
|
24122
24457
|
/**
|
|
24123
24458
|
* Gamification service.
|
|
24124
24459
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24125
|
-
* @version
|
|
24460
|
+
* @version 207.0.0
|
|
24126
24461
|
*/
|
|
24127
24462
|
|
|
24128
24463
|
/**
|
|
@@ -26208,7 +26543,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26208
26543
|
/**
|
|
26209
26544
|
* GeneralDataProtectionRegulation service.
|
|
26210
26545
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26211
|
-
* @version
|
|
26546
|
+
* @version 207.0.0
|
|
26212
26547
|
*/
|
|
26213
26548
|
|
|
26214
26549
|
/**
|
|
@@ -26338,7 +26673,7 @@ class GeolocationApi {
|
|
|
26338
26673
|
/**
|
|
26339
26674
|
* Geolocation service.
|
|
26340
26675
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26341
|
-
* @version
|
|
26676
|
+
* @version 207.0.0
|
|
26342
26677
|
*/
|
|
26343
26678
|
|
|
26344
26679
|
/**
|
|
@@ -26469,7 +26804,7 @@ class GreetingsApi {
|
|
|
26469
26804
|
/**
|
|
26470
26805
|
* Greetings service.
|
|
26471
26806
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26472
|
-
* @version
|
|
26807
|
+
* @version 207.0.0
|
|
26473
26808
|
*/
|
|
26474
26809
|
|
|
26475
26810
|
/**
|
|
@@ -26924,7 +27259,7 @@ class GroupsApi {
|
|
|
26924
27259
|
/**
|
|
26925
27260
|
* Groups service.
|
|
26926
27261
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26927
|
-
* @version
|
|
27262
|
+
* @version 207.0.0
|
|
26928
27263
|
*/
|
|
26929
27264
|
|
|
26930
27265
|
/**
|
|
@@ -27443,7 +27778,7 @@ class IdentityProviderApi {
|
|
|
27443
27778
|
/**
|
|
27444
27779
|
* IdentityProvider service.
|
|
27445
27780
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27446
|
-
* @version
|
|
27781
|
+
* @version 207.0.0
|
|
27447
27782
|
*/
|
|
27448
27783
|
|
|
27449
27784
|
/**
|
|
@@ -28304,7 +28639,7 @@ class InfrastructureAsCodeApi {
|
|
|
28304
28639
|
/**
|
|
28305
28640
|
* InfrastructureAsCode service.
|
|
28306
28641
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28307
|
-
* @version
|
|
28642
|
+
* @version 207.0.0
|
|
28308
28643
|
*/
|
|
28309
28644
|
|
|
28310
28645
|
/**
|
|
@@ -28471,7 +28806,7 @@ class IntegrationsApi {
|
|
|
28471
28806
|
/**
|
|
28472
28807
|
* Integrations service.
|
|
28473
28808
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28474
|
-
* @version
|
|
28809
|
+
* @version 207.0.0
|
|
28475
28810
|
*/
|
|
28476
28811
|
|
|
28477
28812
|
/**
|
|
@@ -30893,7 +31228,7 @@ class JourneyApi {
|
|
|
30893
31228
|
/**
|
|
30894
31229
|
* Journey service.
|
|
30895
31230
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30896
|
-
* @version
|
|
31231
|
+
* @version 207.0.0
|
|
30897
31232
|
*/
|
|
30898
31233
|
|
|
30899
31234
|
/**
|
|
@@ -31987,7 +32322,6 @@ class JourneyApi {
|
|
|
31987
32322
|
* Get an Event Definition
|
|
31988
32323
|
*
|
|
31989
32324
|
* @param {String} eventDefinitionId Event Definition ID
|
|
31990
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31991
32325
|
*/
|
|
31992
32326
|
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
31993
32327
|
// verify the required parameter 'eventDefinitionId' is set
|
|
@@ -32012,7 +32346,6 @@ class JourneyApi {
|
|
|
32012
32346
|
/**
|
|
32013
32347
|
* Get a list of Event Definitions
|
|
32014
32348
|
*
|
|
32015
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32016
32349
|
*/
|
|
32017
32350
|
getJourneyViewsEventdefinitions() {
|
|
32018
32351
|
|
|
@@ -32665,7 +32998,6 @@ class JourneyApi {
|
|
|
32665
32998
|
* True indicates a valid encoding
|
|
32666
32999
|
* @param {Object} opts Optional parameters
|
|
32667
33000
|
* @param {Array.<Object>} opts.body
|
|
32668
|
-
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32669
33001
|
*/
|
|
32670
33002
|
postJourneyViewsEncodingsValidate(opts) {
|
|
32671
33003
|
opts = opts || {};
|
|
@@ -32726,7 +33058,7 @@ class KnowledgeApi {
|
|
|
32726
33058
|
/**
|
|
32727
33059
|
* Knowledge service.
|
|
32728
33060
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
32729
|
-
* @version
|
|
33061
|
+
* @version 207.0.0
|
|
32730
33062
|
*/
|
|
32731
33063
|
|
|
32732
33064
|
/**
|
|
@@ -33064,7 +33396,6 @@ class KnowledgeApi {
|
|
|
33064
33396
|
*
|
|
33065
33397
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33066
33398
|
* @param {String} sourceId Source ID
|
|
33067
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33068
33399
|
*/
|
|
33069
33400
|
deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId) {
|
|
33070
33401
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33095,7 +33426,6 @@ class KnowledgeApi {
|
|
|
33095
33426
|
*
|
|
33096
33427
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33097
33428
|
* @param {String} sourceId Source ID
|
|
33098
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33099
33429
|
*/
|
|
33100
33430
|
deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId) {
|
|
33101
33431
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33126,7 +33456,6 @@ class KnowledgeApi {
|
|
|
33126
33456
|
*
|
|
33127
33457
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33128
33458
|
* @param {String} syncJobId Synchronization job ID
|
|
33129
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33130
33459
|
*/
|
|
33131
33460
|
deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
33132
33461
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33253,7 +33582,6 @@ class KnowledgeApi {
|
|
|
33253
33582
|
* Get sync options available for a knowledge-connect integration
|
|
33254
33583
|
*
|
|
33255
33584
|
* @param {String} integrationId Integration ID
|
|
33256
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33257
33585
|
*/
|
|
33258
33586
|
getKnowledgeIntegrationOptions(integrationId) {
|
|
33259
33587
|
// verify the required parameter 'integrationId' is set
|
|
@@ -34200,7 +34528,6 @@ class KnowledgeApi {
|
|
|
34200
34528
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
34201
34529
|
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
34202
34530
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
34203
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34204
34531
|
*/
|
|
34205
34532
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
34206
34533
|
opts = opts || {};
|
|
@@ -34228,7 +34555,6 @@ class KnowledgeApi {
|
|
|
34228
34555
|
* Get ids of operation creator users and oauth clients
|
|
34229
34556
|
*
|
|
34230
34557
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34231
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34232
34558
|
*/
|
|
34233
34559
|
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
34234
34560
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -34293,7 +34619,6 @@ class KnowledgeApi {
|
|
|
34293
34619
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
34294
34620
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34295
34621
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
34296
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34297
34622
|
*/
|
|
34298
34623
|
getKnowledgeKnowledgebaseSources(knowledgeBaseId, opts) {
|
|
34299
34624
|
opts = opts || {};
|
|
@@ -34324,7 +34649,6 @@ class KnowledgeApi {
|
|
|
34324
34649
|
* @param {String} sourceId Source ID
|
|
34325
34650
|
* @param {Object} opts Optional parameters
|
|
34326
34651
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34327
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34328
34652
|
*/
|
|
34329
34653
|
getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34330
34654
|
opts = opts || {};
|
|
@@ -34359,7 +34683,6 @@ class KnowledgeApi {
|
|
|
34359
34683
|
* @param {String} sourceId Source ID
|
|
34360
34684
|
* @param {Object} opts Optional parameters
|
|
34361
34685
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34362
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34363
34686
|
*/
|
|
34364
34687
|
getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34365
34688
|
opts = opts || {};
|
|
@@ -34392,7 +34715,6 @@ class KnowledgeApi {
|
|
|
34392
34715
|
*
|
|
34393
34716
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34394
34717
|
* @param {String} syncJobId Synchronization job ID
|
|
34395
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34396
34718
|
*/
|
|
34397
34719
|
getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
34398
34720
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -35108,7 +35430,6 @@ class KnowledgeApi {
|
|
|
35108
35430
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
35109
35431
|
* @param {String} syncJobId Synchronization job ID
|
|
35110
35432
|
* @param {Object} body
|
|
35111
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35112
35433
|
*/
|
|
35113
35434
|
patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId, body) {
|
|
35114
35435
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36330,7 +36651,6 @@ class KnowledgeApi {
|
|
|
36330
36651
|
*
|
|
36331
36652
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36332
36653
|
* @param {Object} body
|
|
36333
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36334
36654
|
*/
|
|
36335
36655
|
postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId, body) {
|
|
36336
36656
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36361,7 +36681,6 @@ class KnowledgeApi {
|
|
|
36361
36681
|
*
|
|
36362
36682
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36363
36683
|
* @param {String} sourceId Source ID
|
|
36364
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36365
36684
|
*/
|
|
36366
36685
|
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36367
36686
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36392,7 +36711,6 @@ class KnowledgeApi {
|
|
|
36392
36711
|
*
|
|
36393
36712
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36394
36713
|
* @param {Object} body
|
|
36395
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36396
36714
|
*/
|
|
36397
36715
|
postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId, body) {
|
|
36398
36716
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36423,7 +36741,6 @@ class KnowledgeApi {
|
|
|
36423
36741
|
*
|
|
36424
36742
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36425
36743
|
* @param {String} sourceId Source ID
|
|
36426
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36427
36744
|
*/
|
|
36428
36745
|
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36429
36746
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36454,7 +36771,6 @@ class KnowledgeApi {
|
|
|
36454
36771
|
*
|
|
36455
36772
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36456
36773
|
* @param {Object} body
|
|
36457
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36458
36774
|
*/
|
|
36459
36775
|
postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId, body) {
|
|
36460
36776
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36542,7 +36858,6 @@ class KnowledgeApi {
|
|
|
36542
36858
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36543
36859
|
* @param {String} sourceId Source ID
|
|
36544
36860
|
* @param {Object} body
|
|
36545
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36546
36861
|
*/
|
|
36547
36862
|
putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, body) {
|
|
36548
36863
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36578,7 +36893,6 @@ class KnowledgeApi {
|
|
|
36578
36893
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36579
36894
|
* @param {String} sourceId Source ID
|
|
36580
36895
|
* @param {Object} body
|
|
36581
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36582
36896
|
*/
|
|
36583
36897
|
putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, body) {
|
|
36584
36898
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36614,7 +36928,7 @@ class LanguageUnderstandingApi {
|
|
|
36614
36928
|
/**
|
|
36615
36929
|
* LanguageUnderstanding service.
|
|
36616
36930
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
36617
|
-
* @version
|
|
36931
|
+
* @version 207.0.0
|
|
36618
36932
|
*/
|
|
36619
36933
|
|
|
36620
36934
|
/**
|
|
@@ -37648,7 +37962,7 @@ class LanguagesApi {
|
|
|
37648
37962
|
/**
|
|
37649
37963
|
* Languages service.
|
|
37650
37964
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
37651
|
-
* @version
|
|
37965
|
+
* @version 207.0.0
|
|
37652
37966
|
*/
|
|
37653
37967
|
|
|
37654
37968
|
/**
|
|
@@ -37870,7 +38184,7 @@ class LearningApi {
|
|
|
37870
38184
|
/**
|
|
37871
38185
|
* Learning service.
|
|
37872
38186
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
37873
|
-
* @version
|
|
38187
|
+
* @version 207.0.0
|
|
37874
38188
|
*/
|
|
37875
38189
|
|
|
37876
38190
|
/**
|
|
@@ -38899,7 +39213,7 @@ class LicenseApi {
|
|
|
38899
39213
|
/**
|
|
38900
39214
|
* License service.
|
|
38901
39215
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
38902
|
-
* @version
|
|
39216
|
+
* @version 207.0.0
|
|
38903
39217
|
*/
|
|
38904
39218
|
|
|
38905
39219
|
/**
|
|
@@ -39137,7 +39451,7 @@ class LocationsApi {
|
|
|
39137
39451
|
/**
|
|
39138
39452
|
* Locations service.
|
|
39139
39453
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39140
|
-
* @version
|
|
39454
|
+
* @version 207.0.0
|
|
39141
39455
|
*/
|
|
39142
39456
|
|
|
39143
39457
|
/**
|
|
@@ -39373,7 +39687,7 @@ class LogCaptureApi {
|
|
|
39373
39687
|
/**
|
|
39374
39688
|
* LogCapture service.
|
|
39375
39689
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39376
|
-
* @version
|
|
39690
|
+
* @version 207.0.0
|
|
39377
39691
|
*/
|
|
39378
39692
|
|
|
39379
39693
|
/**
|
|
@@ -39573,7 +39887,7 @@ class MessagingApi {
|
|
|
39573
39887
|
/**
|
|
39574
39888
|
* Messaging service.
|
|
39575
39889
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
39576
|
-
* @version
|
|
39890
|
+
* @version 207.0.0
|
|
39577
39891
|
*/
|
|
39578
39892
|
|
|
39579
39893
|
/**
|
|
@@ -39932,7 +40246,7 @@ class MobileDevicesApi {
|
|
|
39932
40246
|
/**
|
|
39933
40247
|
* MobileDevices service.
|
|
39934
40248
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
39935
|
-
* @version
|
|
40249
|
+
* @version 207.0.0
|
|
39936
40250
|
*/
|
|
39937
40251
|
|
|
39938
40252
|
/**
|
|
@@ -40083,7 +40397,7 @@ class NotificationsApi {
|
|
|
40083
40397
|
/**
|
|
40084
40398
|
* Notifications service.
|
|
40085
40399
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40086
|
-
* @version
|
|
40400
|
+
* @version 207.0.0
|
|
40087
40401
|
*/
|
|
40088
40402
|
|
|
40089
40403
|
/**
|
|
@@ -40316,7 +40630,7 @@ class OAuthApi {
|
|
|
40316
40630
|
/**
|
|
40317
40631
|
* OAuth service.
|
|
40318
40632
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40319
|
-
* @version
|
|
40633
|
+
* @version 207.0.0
|
|
40320
40634
|
*/
|
|
40321
40635
|
|
|
40322
40636
|
/**
|
|
@@ -40682,7 +40996,7 @@ class ObjectsApi {
|
|
|
40682
40996
|
/**
|
|
40683
40997
|
* Objects service.
|
|
40684
40998
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
40685
|
-
* @version
|
|
40999
|
+
* @version 207.0.0
|
|
40686
41000
|
*/
|
|
40687
41001
|
|
|
40688
41002
|
/**
|
|
@@ -40952,7 +41266,7 @@ class OperationalEventsApi {
|
|
|
40952
41266
|
/**
|
|
40953
41267
|
* OperationalEvents service.
|
|
40954
41268
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
40955
|
-
* @version
|
|
41269
|
+
* @version 207.0.0
|
|
40956
41270
|
*/
|
|
40957
41271
|
|
|
40958
41272
|
/**
|
|
@@ -41018,7 +41332,7 @@ class OrganizationApi {
|
|
|
41018
41332
|
/**
|
|
41019
41333
|
* Organization service.
|
|
41020
41334
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41021
|
-
* @version
|
|
41335
|
+
* @version 207.0.0
|
|
41022
41336
|
*/
|
|
41023
41337
|
|
|
41024
41338
|
/**
|
|
@@ -41560,7 +41874,7 @@ class OrganizationAuthorizationApi {
|
|
|
41560
41874
|
/**
|
|
41561
41875
|
* OrganizationAuthorization service.
|
|
41562
41876
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
41563
|
-
* @version
|
|
41877
|
+
* @version 207.0.0
|
|
41564
41878
|
*/
|
|
41565
41879
|
|
|
41566
41880
|
/**
|
|
@@ -42197,6 +42511,26 @@ class OrganizationAuthorizationApi {
|
|
|
42197
42511
|
);
|
|
42198
42512
|
}
|
|
42199
42513
|
|
|
42514
|
+
/**
|
|
42515
|
+
* Get Customer Care organization ids.
|
|
42516
|
+
*
|
|
42517
|
+
*/
|
|
42518
|
+
getOrgauthorizationTrusteesCare() {
|
|
42519
|
+
|
|
42520
|
+
return this.apiClient.callApi(
|
|
42521
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
42522
|
+
'GET',
|
|
42523
|
+
{ },
|
|
42524
|
+
{ },
|
|
42525
|
+
{ },
|
|
42526
|
+
{ },
|
|
42527
|
+
null,
|
|
42528
|
+
['PureCloud OAuth'],
|
|
42529
|
+
['application/json'],
|
|
42530
|
+
['application/json']
|
|
42531
|
+
);
|
|
42532
|
+
}
|
|
42533
|
+
|
|
42200
42534
|
/**
|
|
42201
42535
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
42202
42536
|
*
|
|
@@ -42584,6 +42918,33 @@ class OrganizationAuthorizationApi {
|
|
|
42584
42918
|
);
|
|
42585
42919
|
}
|
|
42586
42920
|
|
|
42921
|
+
/**
|
|
42922
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
42923
|
+
*
|
|
42924
|
+
* @param {Object} opts Optional parameters
|
|
42925
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
42926
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
42927
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
42928
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
42929
|
+
*/
|
|
42930
|
+
postOrgauthorizationTrusteesCare(opts) {
|
|
42931
|
+
opts = opts || {};
|
|
42932
|
+
|
|
42933
|
+
|
|
42934
|
+
return this.apiClient.callApi(
|
|
42935
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
42936
|
+
'POST',
|
|
42937
|
+
{ },
|
|
42938
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'],'assignFullAccess': opts['assignFullAccess'],'allowTrustedUserAccess': opts['allowTrustedUserAccess'] },
|
|
42939
|
+
{ },
|
|
42940
|
+
{ },
|
|
42941
|
+
null,
|
|
42942
|
+
['PureCloud OAuth'],
|
|
42943
|
+
['application/json'],
|
|
42944
|
+
['application/json']
|
|
42945
|
+
);
|
|
42946
|
+
}
|
|
42947
|
+
|
|
42587
42948
|
/**
|
|
42588
42949
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
42589
42950
|
*
|
|
@@ -42907,7 +43268,7 @@ class OutboundApi {
|
|
|
42907
43268
|
/**
|
|
42908
43269
|
* Outbound service.
|
|
42909
43270
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
42910
|
-
* @version
|
|
43271
|
+
* @version 207.0.0
|
|
42911
43272
|
*/
|
|
42912
43273
|
|
|
42913
43274
|
/**
|
|
@@ -45884,6 +46245,56 @@ class OutboundApi {
|
|
|
45884
46245
|
);
|
|
45885
46246
|
}
|
|
45886
46247
|
|
|
46248
|
+
/**
|
|
46249
|
+
* Start the campaign
|
|
46250
|
+
*
|
|
46251
|
+
* @param {String} campaignId Campaign ID
|
|
46252
|
+
*/
|
|
46253
|
+
postOutboundCampaignStart(campaignId) {
|
|
46254
|
+
// verify the required parameter 'campaignId' is set
|
|
46255
|
+
if (campaignId === undefined || campaignId === null) {
|
|
46256
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';
|
|
46257
|
+
}
|
|
46258
|
+
|
|
46259
|
+
return this.apiClient.callApi(
|
|
46260
|
+
'/api/v2/outbound/campaigns/{campaignId}/start',
|
|
46261
|
+
'POST',
|
|
46262
|
+
{ 'campaignId': campaignId },
|
|
46263
|
+
{ },
|
|
46264
|
+
{ },
|
|
46265
|
+
{ },
|
|
46266
|
+
null,
|
|
46267
|
+
['PureCloud OAuth'],
|
|
46268
|
+
['application/json'],
|
|
46269
|
+
['application/json']
|
|
46270
|
+
);
|
|
46271
|
+
}
|
|
46272
|
+
|
|
46273
|
+
/**
|
|
46274
|
+
* Stop the campaign
|
|
46275
|
+
*
|
|
46276
|
+
* @param {String} campaignId Campaign ID
|
|
46277
|
+
*/
|
|
46278
|
+
postOutboundCampaignStop(campaignId) {
|
|
46279
|
+
// verify the required parameter 'campaignId' is set
|
|
46280
|
+
if (campaignId === undefined || campaignId === null) {
|
|
46281
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';
|
|
46282
|
+
}
|
|
46283
|
+
|
|
46284
|
+
return this.apiClient.callApi(
|
|
46285
|
+
'/api/v2/outbound/campaigns/{campaignId}/stop',
|
|
46286
|
+
'POST',
|
|
46287
|
+
{ 'campaignId': campaignId },
|
|
46288
|
+
{ },
|
|
46289
|
+
{ },
|
|
46290
|
+
{ },
|
|
46291
|
+
null,
|
|
46292
|
+
['PureCloud OAuth'],
|
|
46293
|
+
['application/json'],
|
|
46294
|
+
['application/json']
|
|
46295
|
+
);
|
|
46296
|
+
}
|
|
46297
|
+
|
|
45887
46298
|
/**
|
|
45888
46299
|
* Create Campaign Rule
|
|
45889
46300
|
*
|
|
@@ -46583,6 +46994,56 @@ class OutboundApi {
|
|
|
46583
46994
|
);
|
|
46584
46995
|
}
|
|
46585
46996
|
|
|
46997
|
+
/**
|
|
46998
|
+
* Start the campaign
|
|
46999
|
+
* Documented permissions are applicable based on campaign type.
|
|
47000
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
47001
|
+
*/
|
|
47002
|
+
postOutboundMessagingcampaignStart(messagingCampaignId) {
|
|
47003
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
47004
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
47005
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';
|
|
47006
|
+
}
|
|
47007
|
+
|
|
47008
|
+
return this.apiClient.callApi(
|
|
47009
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start',
|
|
47010
|
+
'POST',
|
|
47011
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
47012
|
+
{ },
|
|
47013
|
+
{ },
|
|
47014
|
+
{ },
|
|
47015
|
+
null,
|
|
47016
|
+
['PureCloud OAuth'],
|
|
47017
|
+
['application/json'],
|
|
47018
|
+
['application/json']
|
|
47019
|
+
);
|
|
47020
|
+
}
|
|
47021
|
+
|
|
47022
|
+
/**
|
|
47023
|
+
* Stop the campaign
|
|
47024
|
+
* Documented permissions are applicable based on campaign type.
|
|
47025
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
47026
|
+
*/
|
|
47027
|
+
postOutboundMessagingcampaignStop(messagingCampaignId) {
|
|
47028
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
47029
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
47030
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';
|
|
47031
|
+
}
|
|
47032
|
+
|
|
47033
|
+
return this.apiClient.callApi(
|
|
47034
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop',
|
|
47035
|
+
'POST',
|
|
47036
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
47037
|
+
{ },
|
|
47038
|
+
{ },
|
|
47039
|
+
{ },
|
|
47040
|
+
null,
|
|
47041
|
+
['PureCloud OAuth'],
|
|
47042
|
+
['application/json'],
|
|
47043
|
+
['application/json']
|
|
47044
|
+
);
|
|
47045
|
+
}
|
|
47046
|
+
|
|
46586
47047
|
/**
|
|
46587
47048
|
* Create a Messaging Campaign
|
|
46588
47049
|
*
|
|
@@ -47354,7 +47815,7 @@ class PresenceApi {
|
|
|
47354
47815
|
/**
|
|
47355
47816
|
* Presence service.
|
|
47356
47817
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47357
|
-
* @version
|
|
47818
|
+
* @version 207.0.0
|
|
47358
47819
|
*/
|
|
47359
47820
|
|
|
47360
47821
|
/**
|
|
@@ -48098,7 +48559,7 @@ class ProcessAutomationApi {
|
|
|
48098
48559
|
/**
|
|
48099
48560
|
* ProcessAutomation service.
|
|
48100
48561
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48101
|
-
* @version
|
|
48562
|
+
* @version 207.0.0
|
|
48102
48563
|
*/
|
|
48103
48564
|
|
|
48104
48565
|
/**
|
|
@@ -48337,7 +48798,7 @@ class QualityApi {
|
|
|
48337
48798
|
/**
|
|
48338
48799
|
* Quality service.
|
|
48339
48800
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48340
|
-
* @version
|
|
48801
|
+
* @version 207.0.0
|
|
48341
48802
|
*/
|
|
48342
48803
|
|
|
48343
48804
|
/**
|
|
@@ -50123,7 +50584,7 @@ class RecordingApi {
|
|
|
50123
50584
|
/**
|
|
50124
50585
|
* Recording service.
|
|
50125
50586
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50126
|
-
* @version
|
|
50587
|
+
* @version 207.0.0
|
|
50127
50588
|
*/
|
|
50128
50589
|
|
|
50129
50590
|
/**
|
|
@@ -51782,7 +52243,7 @@ class ResponseManagementApi {
|
|
|
51782
52243
|
/**
|
|
51783
52244
|
* ResponseManagement service.
|
|
51784
52245
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
51785
|
-
* @version
|
|
52246
|
+
* @version 207.0.0
|
|
51786
52247
|
*/
|
|
51787
52248
|
|
|
51788
52249
|
/**
|
|
@@ -52292,7 +52753,7 @@ class RoutingApi {
|
|
|
52292
52753
|
/**
|
|
52293
52754
|
* Routing service.
|
|
52294
52755
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52295
|
-
* @version
|
|
52756
|
+
* @version 207.0.0
|
|
52296
52757
|
*/
|
|
52297
52758
|
|
|
52298
52759
|
/**
|
|
@@ -56440,7 +56901,7 @@ class SCIMApi {
|
|
|
56440
56901
|
/**
|
|
56441
56902
|
* SCIM service.
|
|
56442
56903
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56443
|
-
* @version
|
|
56904
|
+
* @version 207.0.0
|
|
56444
56905
|
*/
|
|
56445
56906
|
|
|
56446
56907
|
/**
|
|
@@ -57317,7 +57778,7 @@ class ScreenRecordingApi {
|
|
|
57317
57778
|
/**
|
|
57318
57779
|
* ScreenRecording service.
|
|
57319
57780
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57320
|
-
* @version
|
|
57781
|
+
* @version 207.0.0
|
|
57321
57782
|
*/
|
|
57322
57783
|
|
|
57323
57784
|
/**
|
|
@@ -57362,7 +57823,7 @@ class ScriptsApi {
|
|
|
57362
57823
|
/**
|
|
57363
57824
|
* Scripts service.
|
|
57364
57825
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57365
|
-
* @version
|
|
57826
|
+
* @version 207.0.0
|
|
57366
57827
|
*/
|
|
57367
57828
|
|
|
57368
57829
|
/**
|
|
@@ -57806,7 +58267,7 @@ class SearchApi {
|
|
|
57806
58267
|
/**
|
|
57807
58268
|
* Search service.
|
|
57808
58269
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
57809
|
-
* @version
|
|
58270
|
+
* @version 207.0.0
|
|
57810
58271
|
*/
|
|
57811
58272
|
|
|
57812
58273
|
/**
|
|
@@ -58495,7 +58956,7 @@ class SettingsApi {
|
|
|
58495
58956
|
/**
|
|
58496
58957
|
* Settings service.
|
|
58497
58958
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
58498
|
-
* @version
|
|
58959
|
+
* @version 207.0.0
|
|
58499
58960
|
*/
|
|
58500
58961
|
|
|
58501
58962
|
/**
|
|
@@ -58715,7 +59176,7 @@ class SpeechTextAnalyticsApi {
|
|
|
58715
59176
|
/**
|
|
58716
59177
|
* SpeechTextAnalytics service.
|
|
58717
59178
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
58718
|
-
* @version
|
|
59179
|
+
* @version 207.0.0
|
|
58719
59180
|
*/
|
|
58720
59181
|
|
|
58721
59182
|
/**
|
|
@@ -60050,7 +60511,7 @@ class StationsApi {
|
|
|
60050
60511
|
/**
|
|
60051
60512
|
* Stations service.
|
|
60052
60513
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60053
|
-
* @version
|
|
60514
|
+
* @version 207.0.0
|
|
60054
60515
|
*/
|
|
60055
60516
|
|
|
60056
60517
|
/**
|
|
@@ -60152,7 +60613,7 @@ class SuggestApi {
|
|
|
60152
60613
|
/**
|
|
60153
60614
|
* Suggest service.
|
|
60154
60615
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60155
|
-
* @version
|
|
60616
|
+
* @version 207.0.0
|
|
60156
60617
|
*/
|
|
60157
60618
|
|
|
60158
60619
|
/**
|
|
@@ -60291,7 +60752,7 @@ class TaskManagementApi {
|
|
|
60291
60752
|
/**
|
|
60292
60753
|
* TaskManagement service.
|
|
60293
60754
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60294
|
-
* @version
|
|
60755
|
+
* @version 207.0.0
|
|
60295
60756
|
*/
|
|
60296
60757
|
|
|
60297
60758
|
/**
|
|
@@ -61955,7 +62416,7 @@ class TeamsApi {
|
|
|
61955
62416
|
/**
|
|
61956
62417
|
* Teams service.
|
|
61957
62418
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
61958
|
-
* @version
|
|
62419
|
+
* @version 207.0.0
|
|
61959
62420
|
*/
|
|
61960
62421
|
|
|
61961
62422
|
/**
|
|
@@ -62029,8 +62490,12 @@ class TeamsApi {
|
|
|
62029
62490
|
* Get team
|
|
62030
62491
|
*
|
|
62031
62492
|
* @param {String} teamId Team ID
|
|
62493
|
+
* @param {Object} opts Optional parameters
|
|
62494
|
+
* @param {Object} opts.expand Expand the division name
|
|
62032
62495
|
*/
|
|
62033
|
-
getTeam(teamId) {
|
|
62496
|
+
getTeam(teamId, opts) {
|
|
62497
|
+
opts = opts || {};
|
|
62498
|
+
|
|
62034
62499
|
// verify the required parameter 'teamId' is set
|
|
62035
62500
|
if (teamId === undefined || teamId === null) {
|
|
62036
62501
|
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
@@ -62040,7 +62505,7 @@ class TeamsApi {
|
|
|
62040
62505
|
'/api/v2/teams/{teamId}',
|
|
62041
62506
|
'GET',
|
|
62042
62507
|
{ 'teamId': teamId },
|
|
62043
|
-
{
|
|
62508
|
+
{ 'expand': opts['expand'] },
|
|
62044
62509
|
{ },
|
|
62045
62510
|
{ },
|
|
62046
62511
|
null,
|
|
@@ -62256,7 +62721,7 @@ class TelephonyApi {
|
|
|
62256
62721
|
/**
|
|
62257
62722
|
* Telephony service.
|
|
62258
62723
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62259
|
-
* @version
|
|
62724
|
+
* @version 207.0.0
|
|
62260
62725
|
*/
|
|
62261
62726
|
|
|
62262
62727
|
/**
|
|
@@ -62438,7 +62903,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
62438
62903
|
/**
|
|
62439
62904
|
* TelephonyProvidersEdge service.
|
|
62440
62905
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
62441
|
-
* @version
|
|
62906
|
+
* @version 207.0.0
|
|
62442
62907
|
*/
|
|
62443
62908
|
|
|
62444
62909
|
/**
|
|
@@ -65835,7 +66300,7 @@ class TextbotsApi {
|
|
|
65835
66300
|
/**
|
|
65836
66301
|
* Textbots service.
|
|
65837
66302
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
65838
|
-
* @version
|
|
66303
|
+
* @version 207.0.0
|
|
65839
66304
|
*/
|
|
65840
66305
|
|
|
65841
66306
|
/**
|
|
@@ -65963,7 +66428,7 @@ class TokensApi {
|
|
|
65963
66428
|
/**
|
|
65964
66429
|
* Tokens service.
|
|
65965
66430
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
65966
|
-
* @version
|
|
66431
|
+
* @version 207.0.0
|
|
65967
66432
|
*/
|
|
65968
66433
|
|
|
65969
66434
|
/**
|
|
@@ -66117,7 +66582,7 @@ class UploadsApi {
|
|
|
66117
66582
|
/**
|
|
66118
66583
|
* Uploads service.
|
|
66119
66584
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66120
|
-
* @version
|
|
66585
|
+
* @version 207.0.0
|
|
66121
66586
|
*/
|
|
66122
66587
|
|
|
66123
66588
|
/**
|
|
@@ -66386,7 +66851,7 @@ class UsageApi {
|
|
|
66386
66851
|
/**
|
|
66387
66852
|
* Usage service.
|
|
66388
66853
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
66389
|
-
* @version
|
|
66854
|
+
* @version 207.0.0
|
|
66390
66855
|
*/
|
|
66391
66856
|
|
|
66392
66857
|
/**
|
|
@@ -66601,7 +67066,7 @@ class UserRecordingsApi {
|
|
|
66601
67066
|
/**
|
|
66602
67067
|
* UserRecordings service.
|
|
66603
67068
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
66604
|
-
* @version
|
|
67069
|
+
* @version 207.0.0
|
|
66605
67070
|
*/
|
|
66606
67071
|
|
|
66607
67072
|
/**
|
|
@@ -66816,7 +67281,7 @@ class UsersApi {
|
|
|
66816
67281
|
/**
|
|
66817
67282
|
* Users service.
|
|
66818
67283
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
66819
|
-
* @version
|
|
67284
|
+
* @version 207.0.0
|
|
66820
67285
|
*/
|
|
66821
67286
|
|
|
66822
67287
|
/**
|
|
@@ -68131,6 +68596,32 @@ class UsersApi {
|
|
|
68131
68596
|
);
|
|
68132
68597
|
}
|
|
68133
68598
|
|
|
68599
|
+
/**
|
|
68600
|
+
* Get chats for a user
|
|
68601
|
+
*
|
|
68602
|
+
* @param {Object} opts Optional parameters
|
|
68603
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
68604
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
68605
|
+
* @param {String} opts.after The key to start after
|
|
68606
|
+
*/
|
|
68607
|
+
getUsersChatsMe(opts) {
|
|
68608
|
+
opts = opts || {};
|
|
68609
|
+
|
|
68610
|
+
|
|
68611
|
+
return this.apiClient.callApi(
|
|
68612
|
+
'/api/v2/users/chats/me',
|
|
68613
|
+
'GET',
|
|
68614
|
+
{ },
|
|
68615
|
+
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
|
|
68616
|
+
{ },
|
|
68617
|
+
{ },
|
|
68618
|
+
null,
|
|
68619
|
+
['PureCloud OAuth'],
|
|
68620
|
+
['application/json'],
|
|
68621
|
+
['application/json']
|
|
68622
|
+
);
|
|
68623
|
+
}
|
|
68624
|
+
|
|
68134
68625
|
/**
|
|
68135
68626
|
* Get list of Development Activities
|
|
68136
68627
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
@@ -69619,7 +70110,7 @@ class UtilitiesApi {
|
|
|
69619
70110
|
/**
|
|
69620
70111
|
* Utilities service.
|
|
69621
70112
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
69622
|
-
* @version
|
|
70113
|
+
* @version 207.0.0
|
|
69623
70114
|
*/
|
|
69624
70115
|
|
|
69625
70116
|
/**
|
|
@@ -69730,7 +70221,7 @@ class VoicemailApi {
|
|
|
69730
70221
|
/**
|
|
69731
70222
|
* Voicemail service.
|
|
69732
70223
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
69733
|
-
* @version
|
|
70224
|
+
* @version 207.0.0
|
|
69734
70225
|
*/
|
|
69735
70226
|
|
|
69736
70227
|
/**
|
|
@@ -70117,6 +70608,61 @@ class VoicemailApi {
|
|
|
70117
70608
|
);
|
|
70118
70609
|
}
|
|
70119
70610
|
|
|
70611
|
+
/**
|
|
70612
|
+
* Get a user's mailbox information
|
|
70613
|
+
*
|
|
70614
|
+
* @param {String} userId userId
|
|
70615
|
+
*/
|
|
70616
|
+
getVoicemailUserMailbox(userId) {
|
|
70617
|
+
// verify the required parameter 'userId' is set
|
|
70618
|
+
if (userId === undefined || userId === null) {
|
|
70619
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMailbox';
|
|
70620
|
+
}
|
|
70621
|
+
|
|
70622
|
+
return this.apiClient.callApi(
|
|
70623
|
+
'/api/v2/voicemail/users/{userId}/mailbox',
|
|
70624
|
+
'GET',
|
|
70625
|
+
{ 'userId': userId },
|
|
70626
|
+
{ },
|
|
70627
|
+
{ },
|
|
70628
|
+
{ },
|
|
70629
|
+
null,
|
|
70630
|
+
['PureCloud OAuth'],
|
|
70631
|
+
['application/json'],
|
|
70632
|
+
['application/json']
|
|
70633
|
+
);
|
|
70634
|
+
}
|
|
70635
|
+
|
|
70636
|
+
/**
|
|
70637
|
+
* List voicemail messages
|
|
70638
|
+
*
|
|
70639
|
+
* @param {String} userId User ID
|
|
70640
|
+
* @param {Object} opts Optional parameters
|
|
70641
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
70642
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
70643
|
+
*/
|
|
70644
|
+
getVoicemailUserMessages(userId, opts) {
|
|
70645
|
+
opts = opts || {};
|
|
70646
|
+
|
|
70647
|
+
// verify the required parameter 'userId' is set
|
|
70648
|
+
if (userId === undefined || userId === null) {
|
|
70649
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMessages';
|
|
70650
|
+
}
|
|
70651
|
+
|
|
70652
|
+
return this.apiClient.callApi(
|
|
70653
|
+
'/api/v2/voicemail/users/{userId}/messages',
|
|
70654
|
+
'GET',
|
|
70655
|
+
{ 'userId': userId },
|
|
70656
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
70657
|
+
{ },
|
|
70658
|
+
{ },
|
|
70659
|
+
null,
|
|
70660
|
+
['PureCloud OAuth'],
|
|
70661
|
+
['application/json'],
|
|
70662
|
+
['application/json']
|
|
70663
|
+
);
|
|
70664
|
+
}
|
|
70665
|
+
|
|
70120
70666
|
/**
|
|
70121
70667
|
* Get a user's voicemail policy
|
|
70122
70668
|
*
|
|
@@ -70397,7 +70943,7 @@ class WebChatApi {
|
|
|
70397
70943
|
/**
|
|
70398
70944
|
* WebChat service.
|
|
70399
70945
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
70400
|
-
* @version
|
|
70946
|
+
* @version 207.0.0
|
|
70401
70947
|
*/
|
|
70402
70948
|
|
|
70403
70949
|
/**
|
|
@@ -70948,7 +71494,7 @@ class WebDeploymentsApi {
|
|
|
70948
71494
|
/**
|
|
70949
71495
|
* WebDeployments service.
|
|
70950
71496
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
70951
|
-
* @version
|
|
71497
|
+
* @version 207.0.0
|
|
70952
71498
|
*/
|
|
70953
71499
|
|
|
70954
71500
|
/**
|
|
@@ -71475,7 +72021,7 @@ class WebMessagingApi {
|
|
|
71475
72021
|
/**
|
|
71476
72022
|
* WebMessaging service.
|
|
71477
72023
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
71478
|
-
* @version
|
|
72024
|
+
* @version 207.0.0
|
|
71479
72025
|
*/
|
|
71480
72026
|
|
|
71481
72027
|
/**
|
|
@@ -71521,7 +72067,7 @@ class WidgetsApi {
|
|
|
71521
72067
|
/**
|
|
71522
72068
|
* Widgets service.
|
|
71523
72069
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
71524
|
-
* @version
|
|
72070
|
+
* @version 207.0.0
|
|
71525
72071
|
*/
|
|
71526
72072
|
|
|
71527
72073
|
/**
|
|
@@ -71667,7 +72213,7 @@ class WorkforceManagementApi {
|
|
|
71667
72213
|
/**
|
|
71668
72214
|
* WorkforceManagement service.
|
|
71669
72215
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
71670
|
-
* @version
|
|
72216
|
+
* @version 207.0.0
|
|
71671
72217
|
*/
|
|
71672
72218
|
|
|
71673
72219
|
/**
|
|
@@ -78881,7 +79427,7 @@ class WorkforceManagementApi {
|
|
|
78881
79427
|
* </pre>
|
|
78882
79428
|
* </p>
|
|
78883
79429
|
* @module purecloud-platform-client-v2/index
|
|
78884
|
-
* @version
|
|
79430
|
+
* @version 207.0.0
|
|
78885
79431
|
*/
|
|
78886
79432
|
class platformClient {
|
|
78887
79433
|
constructor() {
|