purecloud-platform-client-v2 205.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 +102 -3
- package/dist/node/purecloud-platform-client-v2.js +1241 -133
- package/dist/web-amd/purecloud-platform-client-v2.js +1241 -133
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +384 -137
- package/dist/web-cjs/purecloud-platform-client-v2.js +384 -137
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1242 -275
- 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 +9 -5
- 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 +191 -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 +311 -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 +2 -2
- 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 +60 -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
|
/**
|
|
@@ -17780,7 +17883,6 @@ class ConversationsApi {
|
|
|
17780
17883
|
* @param {String} conversationId conversationId
|
|
17781
17884
|
* @param {String} participantId participantId
|
|
17782
17885
|
* @param {Object} body Parking update request
|
|
17783
|
-
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17784
17886
|
*/
|
|
17785
17887
|
patchConversationsEmailParticipantParkingstate(conversationId, participantId, body) {
|
|
17786
17888
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18728,9 +18830,10 @@ class ConversationsApi {
|
|
|
18728
18830
|
|
|
18729
18831
|
/**
|
|
18730
18832
|
* Suggestion feedback.
|
|
18731
|
-
*
|
|
18833
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
18732
18834
|
* @param {String} conversationId Conversation ID
|
|
18733
18835
|
* @param {Object} body SuggestionFeedback
|
|
18836
|
+
* @deprecated
|
|
18734
18837
|
*/
|
|
18735
18838
|
postConversationSuggestionsFeedback(conversationId, body) {
|
|
18736
18839
|
// verify the required parameter 'conversationId' is set
|
|
@@ -20020,8 +20123,12 @@ class ConversationsApi {
|
|
|
20020
20123
|
* Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
20021
20124
|
* @param {String} integrationId integrationId
|
|
20022
20125
|
* @param {Object} body NormalizedMessage
|
|
20126
|
+
* @param {Object} opts Optional parameters
|
|
20127
|
+
* @param {Boolean} opts.prefetchConversationId Indicates whether or not to prefetch conversationId (default to false)
|
|
20023
20128
|
*/
|
|
20024
|
-
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
20129
|
+
postConversationsMessageInboundOpenMessage(integrationId, body, opts) {
|
|
20130
|
+
opts = opts || {};
|
|
20131
|
+
|
|
20025
20132
|
// verify the required parameter 'integrationId' is set
|
|
20026
20133
|
if (integrationId === undefined || integrationId === null) {
|
|
20027
20134
|
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
@@ -20035,7 +20142,7 @@ class ConversationsApi {
|
|
|
20035
20142
|
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
20036
20143
|
'POST',
|
|
20037
20144
|
{ 'integrationId': integrationId },
|
|
20038
|
-
{
|
|
20145
|
+
{ 'prefetchConversationId': opts['prefetchConversationId'] },
|
|
20039
20146
|
{ },
|
|
20040
20147
|
{ },
|
|
20041
20148
|
body,
|
|
@@ -21172,7 +21279,7 @@ class DataExtensionsApi {
|
|
|
21172
21279
|
/**
|
|
21173
21280
|
* DataExtensions service.
|
|
21174
21281
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21175
|
-
* @version
|
|
21282
|
+
* @version 207.0.0
|
|
21176
21283
|
*/
|
|
21177
21284
|
|
|
21178
21285
|
/**
|
|
@@ -21258,7 +21365,7 @@ class DownloadsApi {
|
|
|
21258
21365
|
/**
|
|
21259
21366
|
* Downloads service.
|
|
21260
21367
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21261
|
-
* @version
|
|
21368
|
+
* @version 207.0.0
|
|
21262
21369
|
*/
|
|
21263
21370
|
|
|
21264
21371
|
/**
|
|
@@ -21310,7 +21417,7 @@ class EmailsApi {
|
|
|
21310
21417
|
/**
|
|
21311
21418
|
* Emails service.
|
|
21312
21419
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21313
|
-
* @version
|
|
21420
|
+
* @version 207.0.0
|
|
21314
21421
|
*/
|
|
21315
21422
|
|
|
21316
21423
|
/**
|
|
@@ -21375,7 +21482,7 @@ class EmployeeEngagementApi {
|
|
|
21375
21482
|
/**
|
|
21376
21483
|
* EmployeeEngagement service.
|
|
21377
21484
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21378
|
-
* @version
|
|
21485
|
+
* @version 207.0.0
|
|
21379
21486
|
*/
|
|
21380
21487
|
|
|
21381
21488
|
/**
|
|
@@ -21526,7 +21633,7 @@ class EventsApi {
|
|
|
21526
21633
|
/**
|
|
21527
21634
|
* Events service.
|
|
21528
21635
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21529
|
-
* @version
|
|
21636
|
+
* @version 207.0.0
|
|
21530
21637
|
*/
|
|
21531
21638
|
|
|
21532
21639
|
/**
|
|
@@ -21622,7 +21729,7 @@ class ExternalContactsApi {
|
|
|
21622
21729
|
/**
|
|
21623
21730
|
* ExternalContacts service.
|
|
21624
21731
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21625
|
-
* @version
|
|
21732
|
+
* @version 207.0.0
|
|
21626
21733
|
*/
|
|
21627
21734
|
|
|
21628
21735
|
/**
|
|
@@ -21743,6 +21850,31 @@ class ExternalContactsApi {
|
|
|
21743
21850
|
);
|
|
21744
21851
|
}
|
|
21745
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
|
+
|
|
21746
21878
|
/**
|
|
21747
21879
|
* Delete an external organization
|
|
21748
21880
|
*
|
|
@@ -22210,6 +22342,107 @@ class ExternalContactsApi {
|
|
|
22210
22342
|
);
|
|
22211
22343
|
}
|
|
22212
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
|
+
|
|
22213
22446
|
/**
|
|
22214
22447
|
* Fetch an external organization
|
|
22215
22448
|
*
|
|
@@ -23274,6 +23507,81 @@ class ExternalContactsApi {
|
|
|
23274
23507
|
);
|
|
23275
23508
|
}
|
|
23276
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
|
+
|
|
23277
23585
|
/**
|
|
23278
23586
|
* Merge two contacts into a new contact record
|
|
23279
23587
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -23560,6 +23868,36 @@ class ExternalContactsApi {
|
|
|
23560
23868
|
);
|
|
23561
23869
|
}
|
|
23562
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
|
+
|
|
23563
23901
|
/**
|
|
23564
23902
|
* Update an external organization
|
|
23565
23903
|
*
|
|
@@ -23721,7 +24059,7 @@ class FaxApi {
|
|
|
23721
24059
|
/**
|
|
23722
24060
|
* Fax service.
|
|
23723
24061
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23724
|
-
* @version
|
|
24062
|
+
* @version 207.0.0
|
|
23725
24063
|
*/
|
|
23726
24064
|
|
|
23727
24065
|
/**
|
|
@@ -23936,7 +24274,7 @@ class FlowsApi {
|
|
|
23936
24274
|
/**
|
|
23937
24275
|
* Flows service.
|
|
23938
24276
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23939
|
-
* @version
|
|
24277
|
+
* @version 207.0.0
|
|
23940
24278
|
*/
|
|
23941
24279
|
|
|
23942
24280
|
/**
|
|
@@ -24119,7 +24457,7 @@ class GamificationApi {
|
|
|
24119
24457
|
/**
|
|
24120
24458
|
* Gamification service.
|
|
24121
24459
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24122
|
-
* @version
|
|
24460
|
+
* @version 207.0.0
|
|
24123
24461
|
*/
|
|
24124
24462
|
|
|
24125
24463
|
/**
|
|
@@ -26205,7 +26543,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26205
26543
|
/**
|
|
26206
26544
|
* GeneralDataProtectionRegulation service.
|
|
26207
26545
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26208
|
-
* @version
|
|
26546
|
+
* @version 207.0.0
|
|
26209
26547
|
*/
|
|
26210
26548
|
|
|
26211
26549
|
/**
|
|
@@ -26335,7 +26673,7 @@ class GeolocationApi {
|
|
|
26335
26673
|
/**
|
|
26336
26674
|
* Geolocation service.
|
|
26337
26675
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26338
|
-
* @version
|
|
26676
|
+
* @version 207.0.0
|
|
26339
26677
|
*/
|
|
26340
26678
|
|
|
26341
26679
|
/**
|
|
@@ -26466,7 +26804,7 @@ class GreetingsApi {
|
|
|
26466
26804
|
/**
|
|
26467
26805
|
* Greetings service.
|
|
26468
26806
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26469
|
-
* @version
|
|
26807
|
+
* @version 207.0.0
|
|
26470
26808
|
*/
|
|
26471
26809
|
|
|
26472
26810
|
/**
|
|
@@ -26921,7 +27259,7 @@ class GroupsApi {
|
|
|
26921
27259
|
/**
|
|
26922
27260
|
* Groups service.
|
|
26923
27261
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26924
|
-
* @version
|
|
27262
|
+
* @version 207.0.0
|
|
26925
27263
|
*/
|
|
26926
27264
|
|
|
26927
27265
|
/**
|
|
@@ -27440,7 +27778,7 @@ class IdentityProviderApi {
|
|
|
27440
27778
|
/**
|
|
27441
27779
|
* IdentityProvider service.
|
|
27442
27780
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27443
|
-
* @version
|
|
27781
|
+
* @version 207.0.0
|
|
27444
27782
|
*/
|
|
27445
27783
|
|
|
27446
27784
|
/**
|
|
@@ -28301,7 +28639,7 @@ class InfrastructureAsCodeApi {
|
|
|
28301
28639
|
/**
|
|
28302
28640
|
* InfrastructureAsCode service.
|
|
28303
28641
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28304
|
-
* @version
|
|
28642
|
+
* @version 207.0.0
|
|
28305
28643
|
*/
|
|
28306
28644
|
|
|
28307
28645
|
/**
|
|
@@ -28468,7 +28806,7 @@ class IntegrationsApi {
|
|
|
28468
28806
|
/**
|
|
28469
28807
|
* Integrations service.
|
|
28470
28808
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28471
|
-
* @version
|
|
28809
|
+
* @version 207.0.0
|
|
28472
28810
|
*/
|
|
28473
28811
|
|
|
28474
28812
|
/**
|
|
@@ -30890,7 +31228,7 @@ class JourneyApi {
|
|
|
30890
31228
|
/**
|
|
30891
31229
|
* Journey service.
|
|
30892
31230
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30893
|
-
* @version
|
|
31231
|
+
* @version 207.0.0
|
|
30894
31232
|
*/
|
|
30895
31233
|
|
|
30896
31234
|
/**
|
|
@@ -31737,6 +32075,81 @@ class JourneyApi {
|
|
|
31737
32075
|
);
|
|
31738
32076
|
}
|
|
31739
32077
|
|
|
32078
|
+
/**
|
|
32079
|
+
* Get a Chart by ID
|
|
32080
|
+
* returns the latest version
|
|
32081
|
+
* @param {String} viewId viewId
|
|
32082
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
32083
|
+
* @param {String} chartId chartId
|
|
32084
|
+
*/
|
|
32085
|
+
getJourneyViewVersionChart(viewId, journeyViewVersion, chartId) {
|
|
32086
|
+
// verify the required parameter 'viewId' is set
|
|
32087
|
+
if (viewId === undefined || viewId === null) {
|
|
32088
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';
|
|
32089
|
+
}
|
|
32090
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
32091
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
32092
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChart';
|
|
32093
|
+
}
|
|
32094
|
+
// verify the required parameter 'chartId' is set
|
|
32095
|
+
if (chartId === undefined || chartId === null) {
|
|
32096
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionChart';
|
|
32097
|
+
}
|
|
32098
|
+
|
|
32099
|
+
return this.apiClient.callApi(
|
|
32100
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}',
|
|
32101
|
+
'GET',
|
|
32102
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'chartId': chartId },
|
|
32103
|
+
{ },
|
|
32104
|
+
{ },
|
|
32105
|
+
{ },
|
|
32106
|
+
null,
|
|
32107
|
+
['PureCloud OAuth'],
|
|
32108
|
+
['application/json'],
|
|
32109
|
+
['application/json']
|
|
32110
|
+
);
|
|
32111
|
+
}
|
|
32112
|
+
|
|
32113
|
+
/**
|
|
32114
|
+
* Get a Chart by ID and version
|
|
32115
|
+
*
|
|
32116
|
+
* @param {String} viewId viewId
|
|
32117
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
32118
|
+
* @param {String} chartId chartId
|
|
32119
|
+
* @param {String} chartVersion chartVersion
|
|
32120
|
+
*/
|
|
32121
|
+
getJourneyViewVersionChartVersion(viewId, journeyViewVersion, chartId, chartVersion) {
|
|
32122
|
+
// verify the required parameter 'viewId' is set
|
|
32123
|
+
if (viewId === undefined || viewId === null) {
|
|
32124
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';
|
|
32125
|
+
}
|
|
32126
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
32127
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
32128
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChartVersion';
|
|
32129
|
+
}
|
|
32130
|
+
// verify the required parameter 'chartId' is set
|
|
32131
|
+
if (chartId === undefined || chartId === null) {
|
|
32132
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';
|
|
32133
|
+
}
|
|
32134
|
+
// verify the required parameter 'chartVersion' is set
|
|
32135
|
+
if (chartVersion === undefined || chartVersion === null) {
|
|
32136
|
+
throw 'Missing the required parameter "chartVersion" when calling getJourneyViewVersionChartVersion';
|
|
32137
|
+
}
|
|
32138
|
+
|
|
32139
|
+
return this.apiClient.callApi(
|
|
32140
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}',
|
|
32141
|
+
'GET',
|
|
32142
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'chartId': chartId,'chartVersion': chartVersion },
|
|
32143
|
+
{ },
|
|
32144
|
+
{ },
|
|
32145
|
+
{ },
|
|
32146
|
+
null,
|
|
32147
|
+
['PureCloud OAuth'],
|
|
32148
|
+
['application/json'],
|
|
32149
|
+
['application/json']
|
|
32150
|
+
);
|
|
32151
|
+
}
|
|
32152
|
+
|
|
31740
32153
|
/**
|
|
31741
32154
|
* Get the job for a journey view version.
|
|
31742
32155
|
* used for long descriptions
|
|
@@ -31807,6 +32220,46 @@ class JourneyApi {
|
|
|
31807
32220
|
);
|
|
31808
32221
|
}
|
|
31809
32222
|
|
|
32223
|
+
/**
|
|
32224
|
+
* Get the chart result associated with a journey view job.
|
|
32225
|
+
*
|
|
32226
|
+
* @param {String} viewId Journey View Id
|
|
32227
|
+
* @param {String} journeyVersionId Journey View Version
|
|
32228
|
+
* @param {String} jobId JobId
|
|
32229
|
+
* @param {String} chartId ChartId
|
|
32230
|
+
*/
|
|
32231
|
+
getJourneyViewVersionJobResultsChart(viewId, journeyVersionId, jobId, chartId) {
|
|
32232
|
+
// verify the required parameter 'viewId' is set
|
|
32233
|
+
if (viewId === undefined || viewId === null) {
|
|
32234
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';
|
|
32235
|
+
}
|
|
32236
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
32237
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
32238
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobResultsChart';
|
|
32239
|
+
}
|
|
32240
|
+
// verify the required parameter 'jobId' is set
|
|
32241
|
+
if (jobId === undefined || jobId === null) {
|
|
32242
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';
|
|
32243
|
+
}
|
|
32244
|
+
// verify the required parameter 'chartId' is set
|
|
32245
|
+
if (chartId === undefined || chartId === null) {
|
|
32246
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionJobResultsChart';
|
|
32247
|
+
}
|
|
32248
|
+
|
|
32249
|
+
return this.apiClient.callApi(
|
|
32250
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}',
|
|
32251
|
+
'GET',
|
|
32252
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId,'chartId': chartId },
|
|
32253
|
+
{ },
|
|
32254
|
+
{ },
|
|
32255
|
+
{ },
|
|
32256
|
+
null,
|
|
32257
|
+
['PureCloud OAuth'],
|
|
32258
|
+
['application/json'],
|
|
32259
|
+
['application/json']
|
|
32260
|
+
);
|
|
32261
|
+
}
|
|
32262
|
+
|
|
31810
32263
|
/**
|
|
31811
32264
|
* Get the latest job of a journey view version.
|
|
31812
32265
|
* used for long descriptions
|
|
@@ -31869,7 +32322,6 @@ class JourneyApi {
|
|
|
31869
32322
|
* Get an Event Definition
|
|
31870
32323
|
*
|
|
31871
32324
|
* @param {String} eventDefinitionId Event Definition ID
|
|
31872
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31873
32325
|
*/
|
|
31874
32326
|
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
31875
32327
|
// verify the required parameter 'eventDefinitionId' is set
|
|
@@ -31894,7 +32346,6 @@ class JourneyApi {
|
|
|
31894
32346
|
/**
|
|
31895
32347
|
* Get a list of Event Definitions
|
|
31896
32348
|
*
|
|
31897
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31898
32349
|
*/
|
|
31899
32350
|
getJourneyViewsEventdefinitions() {
|
|
31900
32351
|
|
|
@@ -32084,6 +32535,46 @@ class JourneyApi {
|
|
|
32084
32535
|
);
|
|
32085
32536
|
}
|
|
32086
32537
|
|
|
32538
|
+
/**
|
|
32539
|
+
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
32540
|
+
* used for long descriptions
|
|
32541
|
+
* @param {String} viewId Journey View Id
|
|
32542
|
+
* @param {String} journeyVersionId Journey View Version
|
|
32543
|
+
* @param {String} jobId JobId
|
|
32544
|
+
* @param {Object} body journeyViewJob
|
|
32545
|
+
*/
|
|
32546
|
+
patchJourneyViewVersionJob(viewId, journeyVersionId, jobId, body) {
|
|
32547
|
+
// verify the required parameter 'viewId' is set
|
|
32548
|
+
if (viewId === undefined || viewId === null) {
|
|
32549
|
+
throw 'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';
|
|
32550
|
+
}
|
|
32551
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
32552
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
32553
|
+
throw 'Missing the required parameter "journeyVersionId" when calling patchJourneyViewVersionJob';
|
|
32554
|
+
}
|
|
32555
|
+
// verify the required parameter 'jobId' is set
|
|
32556
|
+
if (jobId === undefined || jobId === null) {
|
|
32557
|
+
throw 'Missing the required parameter "jobId" when calling patchJourneyViewVersionJob';
|
|
32558
|
+
}
|
|
32559
|
+
// verify the required parameter 'body' is set
|
|
32560
|
+
if (body === undefined || body === null) {
|
|
32561
|
+
throw 'Missing the required parameter "body" when calling patchJourneyViewVersionJob';
|
|
32562
|
+
}
|
|
32563
|
+
|
|
32564
|
+
return this.apiClient.callApi(
|
|
32565
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}',
|
|
32566
|
+
'PATCH',
|
|
32567
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
|
|
32568
|
+
{ },
|
|
32569
|
+
{ },
|
|
32570
|
+
{ },
|
|
32571
|
+
body,
|
|
32572
|
+
['PureCloud OAuth'],
|
|
32573
|
+
['application/json'],
|
|
32574
|
+
['application/json']
|
|
32575
|
+
);
|
|
32576
|
+
}
|
|
32577
|
+
|
|
32087
32578
|
/**
|
|
32088
32579
|
* Query for journey aggregates asynchronously
|
|
32089
32580
|
*
|
|
@@ -32507,7 +32998,6 @@ class JourneyApi {
|
|
|
32507
32998
|
* True indicates a valid encoding
|
|
32508
32999
|
* @param {Object} opts Optional parameters
|
|
32509
33000
|
* @param {Array.<Object>} opts.body
|
|
32510
|
-
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32511
33001
|
*/
|
|
32512
33002
|
postJourneyViewsEncodingsValidate(opts) {
|
|
32513
33003
|
opts = opts || {};
|
|
@@ -32527,13 +33017,48 @@ class JourneyApi {
|
|
|
32527
33017
|
);
|
|
32528
33018
|
}
|
|
32529
33019
|
|
|
33020
|
+
/**
|
|
33021
|
+
* Update a Journey View by ID and version
|
|
33022
|
+
* does not create a new version
|
|
33023
|
+
* @param {String} viewId viewId
|
|
33024
|
+
* @param {String} versionId versionId
|
|
33025
|
+
* @param {Object} body JourneyView
|
|
33026
|
+
*/
|
|
33027
|
+
putJourneyViewVersion(viewId, versionId, body) {
|
|
33028
|
+
// verify the required parameter 'viewId' is set
|
|
33029
|
+
if (viewId === undefined || viewId === null) {
|
|
33030
|
+
throw 'Missing the required parameter "viewId" when calling putJourneyViewVersion';
|
|
33031
|
+
}
|
|
33032
|
+
// verify the required parameter 'versionId' is set
|
|
33033
|
+
if (versionId === undefined || versionId === null) {
|
|
33034
|
+
throw 'Missing the required parameter "versionId" when calling putJourneyViewVersion';
|
|
33035
|
+
}
|
|
33036
|
+
// verify the required parameter 'body' is set
|
|
33037
|
+
if (body === undefined || body === null) {
|
|
33038
|
+
throw 'Missing the required parameter "body" when calling putJourneyViewVersion';
|
|
33039
|
+
}
|
|
33040
|
+
|
|
33041
|
+
return this.apiClient.callApi(
|
|
33042
|
+
'/api/v2/journey/views/{viewId}/versions/{versionId}',
|
|
33043
|
+
'PUT',
|
|
33044
|
+
{ 'viewId': viewId,'versionId': versionId },
|
|
33045
|
+
{ },
|
|
33046
|
+
{ },
|
|
33047
|
+
{ },
|
|
33048
|
+
body,
|
|
33049
|
+
['PureCloud OAuth'],
|
|
33050
|
+
['application/json'],
|
|
33051
|
+
['application/json']
|
|
33052
|
+
);
|
|
33053
|
+
}
|
|
33054
|
+
|
|
32530
33055
|
}
|
|
32531
33056
|
|
|
32532
33057
|
class KnowledgeApi {
|
|
32533
33058
|
/**
|
|
32534
33059
|
* Knowledge service.
|
|
32535
33060
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
32536
|
-
* @version
|
|
33061
|
+
* @version 207.0.0
|
|
32537
33062
|
*/
|
|
32538
33063
|
|
|
32539
33064
|
/**
|
|
@@ -32871,7 +33396,6 @@ class KnowledgeApi {
|
|
|
32871
33396
|
*
|
|
32872
33397
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32873
33398
|
* @param {String} sourceId Source ID
|
|
32874
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32875
33399
|
*/
|
|
32876
33400
|
deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId) {
|
|
32877
33401
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -32902,7 +33426,6 @@ class KnowledgeApi {
|
|
|
32902
33426
|
*
|
|
32903
33427
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32904
33428
|
* @param {String} sourceId Source ID
|
|
32905
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32906
33429
|
*/
|
|
32907
33430
|
deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId) {
|
|
32908
33431
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -32933,7 +33456,6 @@ class KnowledgeApi {
|
|
|
32933
33456
|
*
|
|
32934
33457
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32935
33458
|
* @param {String} syncJobId Synchronization job ID
|
|
32936
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32937
33459
|
*/
|
|
32938
33460
|
deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
32939
33461
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33060,7 +33582,6 @@ class KnowledgeApi {
|
|
|
33060
33582
|
* Get sync options available for a knowledge-connect integration
|
|
33061
33583
|
*
|
|
33062
33584
|
* @param {String} integrationId Integration ID
|
|
33063
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33064
33585
|
*/
|
|
33065
33586
|
getKnowledgeIntegrationOptions(integrationId) {
|
|
33066
33587
|
// verify the required parameter 'integrationId' is set
|
|
@@ -34007,7 +34528,6 @@ class KnowledgeApi {
|
|
|
34007
34528
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
34008
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
|
|
34009
34530
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
34010
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34011
34531
|
*/
|
|
34012
34532
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
34013
34533
|
opts = opts || {};
|
|
@@ -34035,7 +34555,6 @@ class KnowledgeApi {
|
|
|
34035
34555
|
* Get ids of operation creator users and oauth clients
|
|
34036
34556
|
*
|
|
34037
34557
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34038
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34039
34558
|
*/
|
|
34040
34559
|
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
34041
34560
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -34100,7 +34619,6 @@ class KnowledgeApi {
|
|
|
34100
34619
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
34101
34620
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34102
34621
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
34103
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34104
34622
|
*/
|
|
34105
34623
|
getKnowledgeKnowledgebaseSources(knowledgeBaseId, opts) {
|
|
34106
34624
|
opts = opts || {};
|
|
@@ -34131,7 +34649,6 @@ class KnowledgeApi {
|
|
|
34131
34649
|
* @param {String} sourceId Source ID
|
|
34132
34650
|
* @param {Object} opts Optional parameters
|
|
34133
34651
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34134
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34135
34652
|
*/
|
|
34136
34653
|
getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34137
34654
|
opts = opts || {};
|
|
@@ -34166,7 +34683,6 @@ class KnowledgeApi {
|
|
|
34166
34683
|
* @param {String} sourceId Source ID
|
|
34167
34684
|
* @param {Object} opts Optional parameters
|
|
34168
34685
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34169
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34170
34686
|
*/
|
|
34171
34687
|
getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34172
34688
|
opts = opts || {};
|
|
@@ -34199,7 +34715,6 @@ class KnowledgeApi {
|
|
|
34199
34715
|
*
|
|
34200
34716
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34201
34717
|
* @param {String} syncJobId Synchronization job ID
|
|
34202
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34203
34718
|
*/
|
|
34204
34719
|
getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
34205
34720
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -34915,7 +35430,6 @@ class KnowledgeApi {
|
|
|
34915
35430
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34916
35431
|
* @param {String} syncJobId Synchronization job ID
|
|
34917
35432
|
* @param {Object} body
|
|
34918
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34919
35433
|
*/
|
|
34920
35434
|
patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId, body) {
|
|
34921
35435
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36137,7 +36651,6 @@ class KnowledgeApi {
|
|
|
36137
36651
|
*
|
|
36138
36652
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36139
36653
|
* @param {Object} body
|
|
36140
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36141
36654
|
*/
|
|
36142
36655
|
postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId, body) {
|
|
36143
36656
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36168,7 +36681,6 @@ class KnowledgeApi {
|
|
|
36168
36681
|
*
|
|
36169
36682
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36170
36683
|
* @param {String} sourceId Source ID
|
|
36171
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36172
36684
|
*/
|
|
36173
36685
|
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36174
36686
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36199,7 +36711,6 @@ class KnowledgeApi {
|
|
|
36199
36711
|
*
|
|
36200
36712
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36201
36713
|
* @param {Object} body
|
|
36202
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36203
36714
|
*/
|
|
36204
36715
|
postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId, body) {
|
|
36205
36716
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36230,7 +36741,6 @@ class KnowledgeApi {
|
|
|
36230
36741
|
*
|
|
36231
36742
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36232
36743
|
* @param {String} sourceId Source ID
|
|
36233
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36234
36744
|
*/
|
|
36235
36745
|
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36236
36746
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36261,7 +36771,6 @@ class KnowledgeApi {
|
|
|
36261
36771
|
*
|
|
36262
36772
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36263
36773
|
* @param {Object} body
|
|
36264
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36265
36774
|
*/
|
|
36266
36775
|
postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId, body) {
|
|
36267
36776
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36349,7 +36858,6 @@ class KnowledgeApi {
|
|
|
36349
36858
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36350
36859
|
* @param {String} sourceId Source ID
|
|
36351
36860
|
* @param {Object} body
|
|
36352
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36353
36861
|
*/
|
|
36354
36862
|
putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, body) {
|
|
36355
36863
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36385,7 +36893,6 @@ class KnowledgeApi {
|
|
|
36385
36893
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36386
36894
|
* @param {String} sourceId Source ID
|
|
36387
36895
|
* @param {Object} body
|
|
36388
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36389
36896
|
*/
|
|
36390
36897
|
putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, body) {
|
|
36391
36898
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36421,7 +36928,7 @@ class LanguageUnderstandingApi {
|
|
|
36421
36928
|
/**
|
|
36422
36929
|
* LanguageUnderstanding service.
|
|
36423
36930
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
36424
|
-
* @version
|
|
36931
|
+
* @version 207.0.0
|
|
36425
36932
|
*/
|
|
36426
36933
|
|
|
36427
36934
|
/**
|
|
@@ -37455,7 +37962,7 @@ class LanguagesApi {
|
|
|
37455
37962
|
/**
|
|
37456
37963
|
* Languages service.
|
|
37457
37964
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
37458
|
-
* @version
|
|
37965
|
+
* @version 207.0.0
|
|
37459
37966
|
*/
|
|
37460
37967
|
|
|
37461
37968
|
/**
|
|
@@ -37677,7 +38184,7 @@ class LearningApi {
|
|
|
37677
38184
|
/**
|
|
37678
38185
|
* Learning service.
|
|
37679
38186
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
37680
|
-
* @version
|
|
38187
|
+
* @version 207.0.0
|
|
37681
38188
|
*/
|
|
37682
38189
|
|
|
37683
38190
|
/**
|
|
@@ -38706,7 +39213,7 @@ class LicenseApi {
|
|
|
38706
39213
|
/**
|
|
38707
39214
|
* License service.
|
|
38708
39215
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
38709
|
-
* @version
|
|
39216
|
+
* @version 207.0.0
|
|
38710
39217
|
*/
|
|
38711
39218
|
|
|
38712
39219
|
/**
|
|
@@ -38944,7 +39451,7 @@ class LocationsApi {
|
|
|
38944
39451
|
/**
|
|
38945
39452
|
* Locations service.
|
|
38946
39453
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
38947
|
-
* @version
|
|
39454
|
+
* @version 207.0.0
|
|
38948
39455
|
*/
|
|
38949
39456
|
|
|
38950
39457
|
/**
|
|
@@ -39180,7 +39687,7 @@ class LogCaptureApi {
|
|
|
39180
39687
|
/**
|
|
39181
39688
|
* LogCapture service.
|
|
39182
39689
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39183
|
-
* @version
|
|
39690
|
+
* @version 207.0.0
|
|
39184
39691
|
*/
|
|
39185
39692
|
|
|
39186
39693
|
/**
|
|
@@ -39380,7 +39887,7 @@ class MessagingApi {
|
|
|
39380
39887
|
/**
|
|
39381
39888
|
* Messaging service.
|
|
39382
39889
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
39383
|
-
* @version
|
|
39890
|
+
* @version 207.0.0
|
|
39384
39891
|
*/
|
|
39385
39892
|
|
|
39386
39893
|
/**
|
|
@@ -39739,7 +40246,7 @@ class MobileDevicesApi {
|
|
|
39739
40246
|
/**
|
|
39740
40247
|
* MobileDevices service.
|
|
39741
40248
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
39742
|
-
* @version
|
|
40249
|
+
* @version 207.0.0
|
|
39743
40250
|
*/
|
|
39744
40251
|
|
|
39745
40252
|
/**
|
|
@@ -39890,7 +40397,7 @@ class NotificationsApi {
|
|
|
39890
40397
|
/**
|
|
39891
40398
|
* Notifications service.
|
|
39892
40399
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
39893
|
-
* @version
|
|
40400
|
+
* @version 207.0.0
|
|
39894
40401
|
*/
|
|
39895
40402
|
|
|
39896
40403
|
/**
|
|
@@ -40123,7 +40630,7 @@ class OAuthApi {
|
|
|
40123
40630
|
/**
|
|
40124
40631
|
* OAuth service.
|
|
40125
40632
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40126
|
-
* @version
|
|
40633
|
+
* @version 207.0.0
|
|
40127
40634
|
*/
|
|
40128
40635
|
|
|
40129
40636
|
/**
|
|
@@ -40489,7 +40996,7 @@ class ObjectsApi {
|
|
|
40489
40996
|
/**
|
|
40490
40997
|
* Objects service.
|
|
40491
40998
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
40492
|
-
* @version
|
|
40999
|
+
* @version 207.0.0
|
|
40493
41000
|
*/
|
|
40494
41001
|
|
|
40495
41002
|
/**
|
|
@@ -40759,7 +41266,7 @@ class OperationalEventsApi {
|
|
|
40759
41266
|
/**
|
|
40760
41267
|
* OperationalEvents service.
|
|
40761
41268
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
40762
|
-
* @version
|
|
41269
|
+
* @version 207.0.0
|
|
40763
41270
|
*/
|
|
40764
41271
|
|
|
40765
41272
|
/**
|
|
@@ -40825,7 +41332,7 @@ class OrganizationApi {
|
|
|
40825
41332
|
/**
|
|
40826
41333
|
* Organization service.
|
|
40827
41334
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
40828
|
-
* @version
|
|
41335
|
+
* @version 207.0.0
|
|
40829
41336
|
*/
|
|
40830
41337
|
|
|
40831
41338
|
/**
|
|
@@ -41367,7 +41874,7 @@ class OrganizationAuthorizationApi {
|
|
|
41367
41874
|
/**
|
|
41368
41875
|
* OrganizationAuthorization service.
|
|
41369
41876
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
41370
|
-
* @version
|
|
41877
|
+
* @version 207.0.0
|
|
41371
41878
|
*/
|
|
41372
41879
|
|
|
41373
41880
|
/**
|
|
@@ -42004,6 +42511,26 @@ class OrganizationAuthorizationApi {
|
|
|
42004
42511
|
);
|
|
42005
42512
|
}
|
|
42006
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
|
+
|
|
42007
42534
|
/**
|
|
42008
42535
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
42009
42536
|
*
|
|
@@ -42391,6 +42918,33 @@ class OrganizationAuthorizationApi {
|
|
|
42391
42918
|
);
|
|
42392
42919
|
}
|
|
42393
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
|
+
|
|
42394
42948
|
/**
|
|
42395
42949
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
42396
42950
|
*
|
|
@@ -42714,7 +43268,7 @@ class OutboundApi {
|
|
|
42714
43268
|
/**
|
|
42715
43269
|
* Outbound service.
|
|
42716
43270
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
42717
|
-
* @version
|
|
43271
|
+
* @version 207.0.0
|
|
42718
43272
|
*/
|
|
42719
43273
|
|
|
42720
43274
|
/**
|
|
@@ -45691,6 +46245,56 @@ class OutboundApi {
|
|
|
45691
46245
|
);
|
|
45692
46246
|
}
|
|
45693
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
|
+
|
|
45694
46298
|
/**
|
|
45695
46299
|
* Create Campaign Rule
|
|
45696
46300
|
*
|
|
@@ -46390,6 +46994,56 @@ class OutboundApi {
|
|
|
46390
46994
|
);
|
|
46391
46995
|
}
|
|
46392
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
|
+
|
|
46393
47047
|
/**
|
|
46394
47048
|
* Create a Messaging Campaign
|
|
46395
47049
|
*
|
|
@@ -47161,7 +47815,7 @@ class PresenceApi {
|
|
|
47161
47815
|
/**
|
|
47162
47816
|
* Presence service.
|
|
47163
47817
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47164
|
-
* @version
|
|
47818
|
+
* @version 207.0.0
|
|
47165
47819
|
*/
|
|
47166
47820
|
|
|
47167
47821
|
/**
|
|
@@ -47905,7 +48559,7 @@ class ProcessAutomationApi {
|
|
|
47905
48559
|
/**
|
|
47906
48560
|
* ProcessAutomation service.
|
|
47907
48561
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
47908
|
-
* @version
|
|
48562
|
+
* @version 207.0.0
|
|
47909
48563
|
*/
|
|
47910
48564
|
|
|
47911
48565
|
/**
|
|
@@ -48144,7 +48798,7 @@ class QualityApi {
|
|
|
48144
48798
|
/**
|
|
48145
48799
|
* Quality service.
|
|
48146
48800
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48147
|
-
* @version
|
|
48801
|
+
* @version 207.0.0
|
|
48148
48802
|
*/
|
|
48149
48803
|
|
|
48150
48804
|
/**
|
|
@@ -49930,7 +50584,7 @@ class RecordingApi {
|
|
|
49930
50584
|
/**
|
|
49931
50585
|
* Recording service.
|
|
49932
50586
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
49933
|
-
* @version
|
|
50587
|
+
* @version 207.0.0
|
|
49934
50588
|
*/
|
|
49935
50589
|
|
|
49936
50590
|
/**
|
|
@@ -51589,7 +52243,7 @@ class ResponseManagementApi {
|
|
|
51589
52243
|
/**
|
|
51590
52244
|
* ResponseManagement service.
|
|
51591
52245
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
51592
|
-
* @version
|
|
52246
|
+
* @version 207.0.0
|
|
51593
52247
|
*/
|
|
51594
52248
|
|
|
51595
52249
|
/**
|
|
@@ -52099,7 +52753,7 @@ class RoutingApi {
|
|
|
52099
52753
|
/**
|
|
52100
52754
|
* Routing service.
|
|
52101
52755
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52102
|
-
* @version
|
|
52756
|
+
* @version 207.0.0
|
|
52103
52757
|
*/
|
|
52104
52758
|
|
|
52105
52759
|
/**
|
|
@@ -56247,7 +56901,7 @@ class SCIMApi {
|
|
|
56247
56901
|
/**
|
|
56248
56902
|
* SCIM service.
|
|
56249
56903
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56250
|
-
* @version
|
|
56904
|
+
* @version 207.0.0
|
|
56251
56905
|
*/
|
|
56252
56906
|
|
|
56253
56907
|
/**
|
|
@@ -57124,7 +57778,7 @@ class ScreenRecordingApi {
|
|
|
57124
57778
|
/**
|
|
57125
57779
|
* ScreenRecording service.
|
|
57126
57780
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57127
|
-
* @version
|
|
57781
|
+
* @version 207.0.0
|
|
57128
57782
|
*/
|
|
57129
57783
|
|
|
57130
57784
|
/**
|
|
@@ -57169,7 +57823,7 @@ class ScriptsApi {
|
|
|
57169
57823
|
/**
|
|
57170
57824
|
* Scripts service.
|
|
57171
57825
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57172
|
-
* @version
|
|
57826
|
+
* @version 207.0.0
|
|
57173
57827
|
*/
|
|
57174
57828
|
|
|
57175
57829
|
/**
|
|
@@ -57613,7 +58267,7 @@ class SearchApi {
|
|
|
57613
58267
|
/**
|
|
57614
58268
|
* Search service.
|
|
57615
58269
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
57616
|
-
* @version
|
|
58270
|
+
* @version 207.0.0
|
|
57617
58271
|
*/
|
|
57618
58272
|
|
|
57619
58273
|
/**
|
|
@@ -58302,7 +58956,7 @@ class SettingsApi {
|
|
|
58302
58956
|
/**
|
|
58303
58957
|
* Settings service.
|
|
58304
58958
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
58305
|
-
* @version
|
|
58959
|
+
* @version 207.0.0
|
|
58306
58960
|
*/
|
|
58307
58961
|
|
|
58308
58962
|
/**
|
|
@@ -58522,7 +59176,7 @@ class SpeechTextAnalyticsApi {
|
|
|
58522
59176
|
/**
|
|
58523
59177
|
* SpeechTextAnalytics service.
|
|
58524
59178
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
58525
|
-
* @version
|
|
59179
|
+
* @version 207.0.0
|
|
58526
59180
|
*/
|
|
58527
59181
|
|
|
58528
59182
|
/**
|
|
@@ -59857,7 +60511,7 @@ class StationsApi {
|
|
|
59857
60511
|
/**
|
|
59858
60512
|
* Stations service.
|
|
59859
60513
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
59860
|
-
* @version
|
|
60514
|
+
* @version 207.0.0
|
|
59861
60515
|
*/
|
|
59862
60516
|
|
|
59863
60517
|
/**
|
|
@@ -59959,7 +60613,7 @@ class SuggestApi {
|
|
|
59959
60613
|
/**
|
|
59960
60614
|
* Suggest service.
|
|
59961
60615
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
59962
|
-
* @version
|
|
60616
|
+
* @version 207.0.0
|
|
59963
60617
|
*/
|
|
59964
60618
|
|
|
59965
60619
|
/**
|
|
@@ -60098,7 +60752,7 @@ class TaskManagementApi {
|
|
|
60098
60752
|
/**
|
|
60099
60753
|
* TaskManagement service.
|
|
60100
60754
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60101
|
-
* @version
|
|
60755
|
+
* @version 207.0.0
|
|
60102
60756
|
*/
|
|
60103
60757
|
|
|
60104
60758
|
/**
|
|
@@ -60213,6 +60867,66 @@ class TaskManagementApi {
|
|
|
60213
60867
|
);
|
|
60214
60868
|
}
|
|
60215
60869
|
|
|
60870
|
+
/**
|
|
60871
|
+
* Delete a rule
|
|
60872
|
+
*
|
|
60873
|
+
* @param {String} worktypeId Worktype id
|
|
60874
|
+
* @param {String} ruleId ruleId
|
|
60875
|
+
*/
|
|
60876
|
+
deleteTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId, ruleId) {
|
|
60877
|
+
// verify the required parameter 'worktypeId' is set
|
|
60878
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
60879
|
+
throw 'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
60880
|
+
}
|
|
60881
|
+
// verify the required parameter 'ruleId' is set
|
|
60882
|
+
if (ruleId === undefined || ruleId === null) {
|
|
60883
|
+
throw 'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
60884
|
+
}
|
|
60885
|
+
|
|
60886
|
+
return this.apiClient.callApi(
|
|
60887
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}',
|
|
60888
|
+
'DELETE',
|
|
60889
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
60890
|
+
{ },
|
|
60891
|
+
{ },
|
|
60892
|
+
{ },
|
|
60893
|
+
null,
|
|
60894
|
+
['PureCloud OAuth'],
|
|
60895
|
+
['application/json'],
|
|
60896
|
+
['application/json']
|
|
60897
|
+
);
|
|
60898
|
+
}
|
|
60899
|
+
|
|
60900
|
+
/**
|
|
60901
|
+
* Delete a rule
|
|
60902
|
+
*
|
|
60903
|
+
* @param {String} worktypeId Worktype id
|
|
60904
|
+
* @param {String} ruleId ruleId
|
|
60905
|
+
*/
|
|
60906
|
+
deleteTaskmanagementWorktypeFlowsOncreateRule(worktypeId, ruleId) {
|
|
60907
|
+
// verify the required parameter 'worktypeId' is set
|
|
60908
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
60909
|
+
throw 'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';
|
|
60910
|
+
}
|
|
60911
|
+
// verify the required parameter 'ruleId' is set
|
|
60912
|
+
if (ruleId === undefined || ruleId === null) {
|
|
60913
|
+
throw 'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';
|
|
60914
|
+
}
|
|
60915
|
+
|
|
60916
|
+
return this.apiClient.callApi(
|
|
60917
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}',
|
|
60918
|
+
'DELETE',
|
|
60919
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
60920
|
+
{ },
|
|
60921
|
+
{ },
|
|
60922
|
+
{ },
|
|
60923
|
+
null,
|
|
60924
|
+
['PureCloud OAuth'],
|
|
60925
|
+
['application/json'],
|
|
60926
|
+
['application/json']
|
|
60927
|
+
);
|
|
60928
|
+
}
|
|
60929
|
+
|
|
60216
60930
|
/**
|
|
60217
60931
|
* Delete a status
|
|
60218
60932
|
*
|
|
@@ -60735,6 +61449,126 @@ class TaskManagementApi {
|
|
|
60735
61449
|
);
|
|
60736
61450
|
}
|
|
60737
61451
|
|
|
61452
|
+
/**
|
|
61453
|
+
* Get an attribute change rule
|
|
61454
|
+
*
|
|
61455
|
+
* @param {String} worktypeId Worktype id
|
|
61456
|
+
* @param {String} ruleId ruleId
|
|
61457
|
+
*/
|
|
61458
|
+
getTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId, ruleId) {
|
|
61459
|
+
// verify the required parameter 'worktypeId' is set
|
|
61460
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61461
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61462
|
+
}
|
|
61463
|
+
// verify the required parameter 'ruleId' is set
|
|
61464
|
+
if (ruleId === undefined || ruleId === null) {
|
|
61465
|
+
throw 'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61466
|
+
}
|
|
61467
|
+
|
|
61468
|
+
return this.apiClient.callApi(
|
|
61469
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}',
|
|
61470
|
+
'GET',
|
|
61471
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
61472
|
+
{ },
|
|
61473
|
+
{ },
|
|
61474
|
+
{ },
|
|
61475
|
+
null,
|
|
61476
|
+
['PureCloud OAuth'],
|
|
61477
|
+
['application/json'],
|
|
61478
|
+
['application/json']
|
|
61479
|
+
);
|
|
61480
|
+
}
|
|
61481
|
+
|
|
61482
|
+
/**
|
|
61483
|
+
* Get all attribute-change rules for a worktype
|
|
61484
|
+
*
|
|
61485
|
+
* @param {String} worktypeId Worktype id
|
|
61486
|
+
* @param {Object} opts Optional parameters
|
|
61487
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
61488
|
+
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
61489
|
+
*/
|
|
61490
|
+
getTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId, opts) {
|
|
61491
|
+
opts = opts || {};
|
|
61492
|
+
|
|
61493
|
+
// verify the required parameter 'worktypeId' is set
|
|
61494
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61495
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRules';
|
|
61496
|
+
}
|
|
61497
|
+
|
|
61498
|
+
return this.apiClient.callApi(
|
|
61499
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules',
|
|
61500
|
+
'GET',
|
|
61501
|
+
{ 'worktypeId': worktypeId },
|
|
61502
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
61503
|
+
{ },
|
|
61504
|
+
{ },
|
|
61505
|
+
null,
|
|
61506
|
+
['PureCloud OAuth'],
|
|
61507
|
+
['application/json'],
|
|
61508
|
+
['application/json']
|
|
61509
|
+
);
|
|
61510
|
+
}
|
|
61511
|
+
|
|
61512
|
+
/**
|
|
61513
|
+
* Get an on-create rule
|
|
61514
|
+
*
|
|
61515
|
+
* @param {String} worktypeId Worktype id
|
|
61516
|
+
* @param {String} ruleId ruleId
|
|
61517
|
+
*/
|
|
61518
|
+
getTaskmanagementWorktypeFlowsOncreateRule(worktypeId, ruleId) {
|
|
61519
|
+
// verify the required parameter 'worktypeId' is set
|
|
61520
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61521
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRule';
|
|
61522
|
+
}
|
|
61523
|
+
// verify the required parameter 'ruleId' is set
|
|
61524
|
+
if (ruleId === undefined || ruleId === null) {
|
|
61525
|
+
throw 'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsOncreateRule';
|
|
61526
|
+
}
|
|
61527
|
+
|
|
61528
|
+
return this.apiClient.callApi(
|
|
61529
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}',
|
|
61530
|
+
'GET',
|
|
61531
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
61532
|
+
{ },
|
|
61533
|
+
{ },
|
|
61534
|
+
{ },
|
|
61535
|
+
null,
|
|
61536
|
+
['PureCloud OAuth'],
|
|
61537
|
+
['application/json'],
|
|
61538
|
+
['application/json']
|
|
61539
|
+
);
|
|
61540
|
+
}
|
|
61541
|
+
|
|
61542
|
+
/**
|
|
61543
|
+
* Get all on-create rules for a worktype
|
|
61544
|
+
*
|
|
61545
|
+
* @param {String} worktypeId Worktype id
|
|
61546
|
+
* @param {Object} opts Optional parameters
|
|
61547
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
61548
|
+
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
61549
|
+
*/
|
|
61550
|
+
getTaskmanagementWorktypeFlowsOncreateRules(worktypeId, opts) {
|
|
61551
|
+
opts = opts || {};
|
|
61552
|
+
|
|
61553
|
+
// verify the required parameter 'worktypeId' is set
|
|
61554
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61555
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRules';
|
|
61556
|
+
}
|
|
61557
|
+
|
|
61558
|
+
return this.apiClient.callApi(
|
|
61559
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules',
|
|
61560
|
+
'GET',
|
|
61561
|
+
{ 'worktypeId': worktypeId },
|
|
61562
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
61563
|
+
{ },
|
|
61564
|
+
{ },
|
|
61565
|
+
null,
|
|
61566
|
+
['PureCloud OAuth'],
|
|
61567
|
+
['application/json'],
|
|
61568
|
+
['application/json']
|
|
61569
|
+
);
|
|
61570
|
+
}
|
|
61571
|
+
|
|
60738
61572
|
/**
|
|
60739
61573
|
* Get a listing of a worktype's attribute change history
|
|
60740
61574
|
*
|
|
@@ -61071,6 +61905,76 @@ class TaskManagementApi {
|
|
|
61071
61905
|
);
|
|
61072
61906
|
}
|
|
61073
61907
|
|
|
61908
|
+
/**
|
|
61909
|
+
* Update the attributes of a rule
|
|
61910
|
+
*
|
|
61911
|
+
* @param {String} worktypeId Worktype id
|
|
61912
|
+
* @param {String} ruleId ruleId
|
|
61913
|
+
* @param {Object} body Rule
|
|
61914
|
+
*/
|
|
61915
|
+
patchTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId, ruleId, body) {
|
|
61916
|
+
// verify the required parameter 'worktypeId' is set
|
|
61917
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61918
|
+
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61919
|
+
}
|
|
61920
|
+
// verify the required parameter 'ruleId' is set
|
|
61921
|
+
if (ruleId === undefined || ruleId === null) {
|
|
61922
|
+
throw 'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61923
|
+
}
|
|
61924
|
+
// verify the required parameter 'body' is set
|
|
61925
|
+
if (body === undefined || body === null) {
|
|
61926
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61927
|
+
}
|
|
61928
|
+
|
|
61929
|
+
return this.apiClient.callApi(
|
|
61930
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}',
|
|
61931
|
+
'PATCH',
|
|
61932
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
61933
|
+
{ },
|
|
61934
|
+
{ },
|
|
61935
|
+
{ },
|
|
61936
|
+
body,
|
|
61937
|
+
['PureCloud OAuth'],
|
|
61938
|
+
['application/json'],
|
|
61939
|
+
['application/json']
|
|
61940
|
+
);
|
|
61941
|
+
}
|
|
61942
|
+
|
|
61943
|
+
/**
|
|
61944
|
+
* Update the attributes of a rule
|
|
61945
|
+
*
|
|
61946
|
+
* @param {String} worktypeId Worktype id
|
|
61947
|
+
* @param {String} ruleId ruleId
|
|
61948
|
+
* @param {Object} body Rule
|
|
61949
|
+
*/
|
|
61950
|
+
patchTaskmanagementWorktypeFlowsOncreateRule(worktypeId, ruleId, body) {
|
|
61951
|
+
// verify the required parameter 'worktypeId' is set
|
|
61952
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61953
|
+
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';
|
|
61954
|
+
}
|
|
61955
|
+
// verify the required parameter 'ruleId' is set
|
|
61956
|
+
if (ruleId === undefined || ruleId === null) {
|
|
61957
|
+
throw 'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';
|
|
61958
|
+
}
|
|
61959
|
+
// verify the required parameter 'body' is set
|
|
61960
|
+
if (body === undefined || body === null) {
|
|
61961
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsOncreateRule';
|
|
61962
|
+
}
|
|
61963
|
+
|
|
61964
|
+
return this.apiClient.callApi(
|
|
61965
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}',
|
|
61966
|
+
'PATCH',
|
|
61967
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
61968
|
+
{ },
|
|
61969
|
+
{ },
|
|
61970
|
+
{ },
|
|
61971
|
+
body,
|
|
61972
|
+
['PureCloud OAuth'],
|
|
61973
|
+
['application/json'],
|
|
61974
|
+
['application/json']
|
|
61975
|
+
);
|
|
61976
|
+
}
|
|
61977
|
+
|
|
61074
61978
|
/**
|
|
61075
61979
|
* Update the attributes of a status
|
|
61076
61980
|
*
|
|
@@ -61336,6 +62240,66 @@ class TaskManagementApi {
|
|
|
61336
62240
|
);
|
|
61337
62241
|
}
|
|
61338
62242
|
|
|
62243
|
+
/**
|
|
62244
|
+
* Add an attribute-change rule to a worktype
|
|
62245
|
+
*
|
|
62246
|
+
* @param {String} worktypeId Worktype id
|
|
62247
|
+
* @param {Object} body Rule
|
|
62248
|
+
*/
|
|
62249
|
+
postTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId, body) {
|
|
62250
|
+
// verify the required parameter 'worktypeId' is set
|
|
62251
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
62252
|
+
throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';
|
|
62253
|
+
}
|
|
62254
|
+
// verify the required parameter 'body' is set
|
|
62255
|
+
if (body === undefined || body === null) {
|
|
62256
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';
|
|
62257
|
+
}
|
|
62258
|
+
|
|
62259
|
+
return this.apiClient.callApi(
|
|
62260
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules',
|
|
62261
|
+
'POST',
|
|
62262
|
+
{ 'worktypeId': worktypeId },
|
|
62263
|
+
{ },
|
|
62264
|
+
{ },
|
|
62265
|
+
{ },
|
|
62266
|
+
body,
|
|
62267
|
+
['PureCloud OAuth'],
|
|
62268
|
+
['application/json'],
|
|
62269
|
+
['application/json']
|
|
62270
|
+
);
|
|
62271
|
+
}
|
|
62272
|
+
|
|
62273
|
+
/**
|
|
62274
|
+
* Add an on-create rule to a worktype
|
|
62275
|
+
*
|
|
62276
|
+
* @param {String} worktypeId Worktype id
|
|
62277
|
+
* @param {Object} body Rule
|
|
62278
|
+
*/
|
|
62279
|
+
postTaskmanagementWorktypeFlowsOncreateRules(worktypeId, body) {
|
|
62280
|
+
// verify the required parameter 'worktypeId' is set
|
|
62281
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
62282
|
+
throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOncreateRules';
|
|
62283
|
+
}
|
|
62284
|
+
// verify the required parameter 'body' is set
|
|
62285
|
+
if (body === undefined || body === null) {
|
|
62286
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsOncreateRules';
|
|
62287
|
+
}
|
|
62288
|
+
|
|
62289
|
+
return this.apiClient.callApi(
|
|
62290
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules',
|
|
62291
|
+
'POST',
|
|
62292
|
+
{ 'worktypeId': worktypeId },
|
|
62293
|
+
{ },
|
|
62294
|
+
{ },
|
|
62295
|
+
{ },
|
|
62296
|
+
body,
|
|
62297
|
+
['PureCloud OAuth'],
|
|
62298
|
+
['application/json'],
|
|
62299
|
+
['application/json']
|
|
62300
|
+
);
|
|
62301
|
+
}
|
|
62302
|
+
|
|
61339
62303
|
/**
|
|
61340
62304
|
* Add a status to a worktype
|
|
61341
62305
|
*
|
|
@@ -61452,7 +62416,7 @@ class TeamsApi {
|
|
|
61452
62416
|
/**
|
|
61453
62417
|
* Teams service.
|
|
61454
62418
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
61455
|
-
* @version
|
|
62419
|
+
* @version 207.0.0
|
|
61456
62420
|
*/
|
|
61457
62421
|
|
|
61458
62422
|
/**
|
|
@@ -61526,8 +62490,12 @@ class TeamsApi {
|
|
|
61526
62490
|
* Get team
|
|
61527
62491
|
*
|
|
61528
62492
|
* @param {String} teamId Team ID
|
|
62493
|
+
* @param {Object} opts Optional parameters
|
|
62494
|
+
* @param {Object} opts.expand Expand the division name
|
|
61529
62495
|
*/
|
|
61530
|
-
getTeam(teamId) {
|
|
62496
|
+
getTeam(teamId, opts) {
|
|
62497
|
+
opts = opts || {};
|
|
62498
|
+
|
|
61531
62499
|
// verify the required parameter 'teamId' is set
|
|
61532
62500
|
if (teamId === undefined || teamId === null) {
|
|
61533
62501
|
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
@@ -61537,7 +62505,7 @@ class TeamsApi {
|
|
|
61537
62505
|
'/api/v2/teams/{teamId}',
|
|
61538
62506
|
'GET',
|
|
61539
62507
|
{ 'teamId': teamId },
|
|
61540
|
-
{
|
|
62508
|
+
{ 'expand': opts['expand'] },
|
|
61541
62509
|
{ },
|
|
61542
62510
|
{ },
|
|
61543
62511
|
null,
|
|
@@ -61753,7 +62721,7 @@ class TelephonyApi {
|
|
|
61753
62721
|
/**
|
|
61754
62722
|
* Telephony service.
|
|
61755
62723
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
61756
|
-
* @version
|
|
62724
|
+
* @version 207.0.0
|
|
61757
62725
|
*/
|
|
61758
62726
|
|
|
61759
62727
|
/**
|
|
@@ -61935,7 +62903,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
61935
62903
|
/**
|
|
61936
62904
|
* TelephonyProvidersEdge service.
|
|
61937
62905
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
61938
|
-
* @version
|
|
62906
|
+
* @version 207.0.0
|
|
61939
62907
|
*/
|
|
61940
62908
|
|
|
61941
62909
|
/**
|
|
@@ -65332,7 +66300,7 @@ class TextbotsApi {
|
|
|
65332
66300
|
/**
|
|
65333
66301
|
* Textbots service.
|
|
65334
66302
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
65335
|
-
* @version
|
|
66303
|
+
* @version 207.0.0
|
|
65336
66304
|
*/
|
|
65337
66305
|
|
|
65338
66306
|
/**
|
|
@@ -65460,7 +66428,7 @@ class TokensApi {
|
|
|
65460
66428
|
/**
|
|
65461
66429
|
* Tokens service.
|
|
65462
66430
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
65463
|
-
* @version
|
|
66431
|
+
* @version 207.0.0
|
|
65464
66432
|
*/
|
|
65465
66433
|
|
|
65466
66434
|
/**
|
|
@@ -65614,7 +66582,7 @@ class UploadsApi {
|
|
|
65614
66582
|
/**
|
|
65615
66583
|
* Uploads service.
|
|
65616
66584
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
65617
|
-
* @version
|
|
66585
|
+
* @version 207.0.0
|
|
65618
66586
|
*/
|
|
65619
66587
|
|
|
65620
66588
|
/**
|
|
@@ -65883,7 +66851,7 @@ class UsageApi {
|
|
|
65883
66851
|
/**
|
|
65884
66852
|
* Usage service.
|
|
65885
66853
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
65886
|
-
* @version
|
|
66854
|
+
* @version 207.0.0
|
|
65887
66855
|
*/
|
|
65888
66856
|
|
|
65889
66857
|
/**
|
|
@@ -66098,7 +67066,7 @@ class UserRecordingsApi {
|
|
|
66098
67066
|
/**
|
|
66099
67067
|
* UserRecordings service.
|
|
66100
67068
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
66101
|
-
* @version
|
|
67069
|
+
* @version 207.0.0
|
|
66102
67070
|
*/
|
|
66103
67071
|
|
|
66104
67072
|
/**
|
|
@@ -66313,7 +67281,7 @@ class UsersApi {
|
|
|
66313
67281
|
/**
|
|
66314
67282
|
* Users service.
|
|
66315
67283
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
66316
|
-
* @version
|
|
67284
|
+
* @version 207.0.0
|
|
66317
67285
|
*/
|
|
66318
67286
|
|
|
66319
67287
|
/**
|
|
@@ -67628,6 +68596,32 @@ class UsersApi {
|
|
|
67628
68596
|
);
|
|
67629
68597
|
}
|
|
67630
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
|
+
|
|
67631
68625
|
/**
|
|
67632
68626
|
* Get list of Development Activities
|
|
67633
68627
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
@@ -69116,7 +70110,7 @@ class UtilitiesApi {
|
|
|
69116
70110
|
/**
|
|
69117
70111
|
* Utilities service.
|
|
69118
70112
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
69119
|
-
* @version
|
|
70113
|
+
* @version 207.0.0
|
|
69120
70114
|
*/
|
|
69121
70115
|
|
|
69122
70116
|
/**
|
|
@@ -69227,7 +70221,7 @@ class VoicemailApi {
|
|
|
69227
70221
|
/**
|
|
69228
70222
|
* Voicemail service.
|
|
69229
70223
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
69230
|
-
* @version
|
|
70224
|
+
* @version 207.0.0
|
|
69231
70225
|
*/
|
|
69232
70226
|
|
|
69233
70227
|
/**
|
|
@@ -69614,6 +70608,61 @@ class VoicemailApi {
|
|
|
69614
70608
|
);
|
|
69615
70609
|
}
|
|
69616
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
|
+
|
|
69617
70666
|
/**
|
|
69618
70667
|
* Get a user's voicemail policy
|
|
69619
70668
|
*
|
|
@@ -69894,7 +70943,7 @@ class WebChatApi {
|
|
|
69894
70943
|
/**
|
|
69895
70944
|
* WebChat service.
|
|
69896
70945
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
69897
|
-
* @version
|
|
70946
|
+
* @version 207.0.0
|
|
69898
70947
|
*/
|
|
69899
70948
|
|
|
69900
70949
|
/**
|
|
@@ -70445,7 +71494,7 @@ class WebDeploymentsApi {
|
|
|
70445
71494
|
/**
|
|
70446
71495
|
* WebDeployments service.
|
|
70447
71496
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
70448
|
-
* @version
|
|
71497
|
+
* @version 207.0.0
|
|
70449
71498
|
*/
|
|
70450
71499
|
|
|
70451
71500
|
/**
|
|
@@ -70649,7 +71698,7 @@ class WebDeploymentsApi {
|
|
|
70649
71698
|
* View configuration drafts
|
|
70650
71699
|
*
|
|
70651
71700
|
* @param {Object} opts Optional parameters
|
|
70652
|
-
* @param {Boolean} opts.showOnlyPublished
|
|
71701
|
+
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
70653
71702
|
*/
|
|
70654
71703
|
getWebdeploymentsConfigurations(opts) {
|
|
70655
71704
|
opts = opts || {};
|
|
@@ -70972,7 +72021,7 @@ class WebMessagingApi {
|
|
|
70972
72021
|
/**
|
|
70973
72022
|
* WebMessaging service.
|
|
70974
72023
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
70975
|
-
* @version
|
|
72024
|
+
* @version 207.0.0
|
|
70976
72025
|
*/
|
|
70977
72026
|
|
|
70978
72027
|
/**
|
|
@@ -71018,7 +72067,7 @@ class WidgetsApi {
|
|
|
71018
72067
|
/**
|
|
71019
72068
|
* Widgets service.
|
|
71020
72069
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
71021
|
-
* @version
|
|
72070
|
+
* @version 207.0.0
|
|
71022
72071
|
*/
|
|
71023
72072
|
|
|
71024
72073
|
/**
|
|
@@ -71164,7 +72213,7 @@ class WorkforceManagementApi {
|
|
|
71164
72213
|
/**
|
|
71165
72214
|
* WorkforceManagement service.
|
|
71166
72215
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
71167
|
-
* @version
|
|
72216
|
+
* @version 207.0.0
|
|
71168
72217
|
*/
|
|
71169
72218
|
|
|
71170
72219
|
/**
|
|
@@ -75247,6 +76296,35 @@ class WorkforceManagementApi {
|
|
|
75247
76296
|
);
|
|
75248
76297
|
}
|
|
75249
76298
|
|
|
76299
|
+
/**
|
|
76300
|
+
* Updates agent work plan configuration
|
|
76301
|
+
*
|
|
76302
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
76303
|
+
* @param {Object} opts Optional parameters
|
|
76304
|
+
* @param {Object} opts.body body
|
|
76305
|
+
*/
|
|
76306
|
+
patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId, opts) {
|
|
76307
|
+
opts = opts || {};
|
|
76308
|
+
|
|
76309
|
+
// verify the required parameter 'managementUnitId' is set
|
|
76310
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
76311
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';
|
|
76312
|
+
}
|
|
76313
|
+
|
|
76314
|
+
return this.apiClient.callApi(
|
|
76315
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk',
|
|
76316
|
+
'PATCH',
|
|
76317
|
+
{ 'managementUnitId': managementUnitId },
|
|
76318
|
+
{ },
|
|
76319
|
+
{ },
|
|
76320
|
+
{ },
|
|
76321
|
+
opts['body'],
|
|
76322
|
+
['PureCloud OAuth'],
|
|
76323
|
+
['application/json'],
|
|
76324
|
+
['application/json']
|
|
76325
|
+
);
|
|
76326
|
+
}
|
|
76327
|
+
|
|
75250
76328
|
/**
|
|
75251
76329
|
* Updates a time off limit object.
|
|
75252
76330
|
* Updates time off limit object properties, but not daily values.
|
|
@@ -77167,6 +78245,36 @@ class WorkforceManagementApi {
|
|
|
77167
78245
|
);
|
|
77168
78246
|
}
|
|
77169
78247
|
|
|
78248
|
+
/**
|
|
78249
|
+
* Get agents work plans configuration
|
|
78250
|
+
*
|
|
78251
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78252
|
+
* @param {Object} opts Optional parameters
|
|
78253
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
78254
|
+
* @param {Object} opts.body body
|
|
78255
|
+
*/
|
|
78256
|
+
postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId, opts) {
|
|
78257
|
+
opts = opts || {};
|
|
78258
|
+
|
|
78259
|
+
// verify the required parameter 'managementUnitId' is set
|
|
78260
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
78261
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';
|
|
78262
|
+
}
|
|
78263
|
+
|
|
78264
|
+
return this.apiClient.callApi(
|
|
78265
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query',
|
|
78266
|
+
'POST',
|
|
78267
|
+
{ 'managementUnitId': managementUnitId },
|
|
78268
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
78269
|
+
{ },
|
|
78270
|
+
{ },
|
|
78271
|
+
opts['body'],
|
|
78272
|
+
['PureCloud OAuth'],
|
|
78273
|
+
['application/json'],
|
|
78274
|
+
['application/json']
|
|
78275
|
+
);
|
|
78276
|
+
}
|
|
78277
|
+
|
|
77170
78278
|
/**
|
|
77171
78279
|
* Query published schedules for given given time range for set of users
|
|
77172
78280
|
*
|
|
@@ -78319,7 +79427,7 @@ class WorkforceManagementApi {
|
|
|
78319
79427
|
* </pre>
|
|
78320
79428
|
* </p>
|
|
78321
79429
|
* @module purecloud-platform-client-v2/index
|
|
78322
|
-
* @version
|
|
79430
|
+
* @version 207.0.0
|
|
78323
79431
|
*/
|
|
78324
79432
|
class platformClient {
|
|
78325
79433
|
constructor() {
|