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
|
@@ -259,6 +259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
259
259
|
this.basePath;
|
|
260
260
|
this.authUrl;
|
|
261
261
|
this.config;
|
|
262
|
+
this.gateway = undefined;
|
|
262
263
|
this.logger = new Logger();
|
|
263
264
|
this.setEnvironment();
|
|
264
265
|
this.liveLoadConfig();
|
|
@@ -356,12 +357,72 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
356
357
|
: this.live_reload_config;
|
|
357
358
|
this.host = this.getConfigString('general', 'host') !== undefined ? this.getConfigString('general', 'host') : this.host;
|
|
358
359
|
|
|
360
|
+
if (this.getConfigString('gateway', 'host') !== undefined) {
|
|
361
|
+
let gateway = {
|
|
362
|
+
host: this.getConfigString('gateway', 'host')
|
|
363
|
+
};
|
|
364
|
+
if (this.getConfigString('gateway', 'protocol') !== undefined) gateway.protocol = this.getConfigString('gateway', 'protocol');
|
|
365
|
+
if (this.getConfigInt('gateway', 'port') !== undefined) gateway.port = this.getConfigInt('gateway', 'port');
|
|
366
|
+
if (this.getConfigString('gateway', 'path_params_login') !== undefined) gateway.path_params_login = this.getConfigString('gateway', 'path_params_login');
|
|
367
|
+
if (this.getConfigString('gateway', 'path_params_api') !== undefined) gateway.path_params_api = this.getConfigString('gateway', 'path_params_api');
|
|
368
|
+
if (this.getConfigString('gateway', 'username') !== undefined) gateway.username = this.getConfigString('gateway', 'username');
|
|
369
|
+
if (this.getConfigString('gateway', 'password') !== undefined) gateway.password = this.getConfigString('gateway', 'password');
|
|
370
|
+
this.setGateway(gateway);
|
|
371
|
+
} else {
|
|
372
|
+
this.setGateway();
|
|
373
|
+
}
|
|
374
|
+
|
|
359
375
|
this.setEnvironment();
|
|
360
376
|
|
|
361
377
|
// Update logging configs
|
|
362
378
|
this.logger.setLogger();
|
|
363
379
|
}
|
|
364
380
|
|
|
381
|
+
/**
|
|
382
|
+
* @description Sets the gateway used by the session
|
|
383
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
384
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
385
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
386
|
+
* @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).
|
|
387
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
388
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
389
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
390
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
391
|
+
*/
|
|
392
|
+
setGateway(gateway) {
|
|
393
|
+
if (gateway) {
|
|
394
|
+
this.gateway = {
|
|
395
|
+
host: ''
|
|
396
|
+
};
|
|
397
|
+
|
|
398
|
+
if (gateway.protocol) this.gateway.protocol = gateway.protocol;
|
|
399
|
+
else this.gateway.protocol = 'https';
|
|
400
|
+
|
|
401
|
+
if (gateway.host) this.gateway.host = gateway.host;
|
|
402
|
+
else this.gateway.host = '';
|
|
403
|
+
|
|
404
|
+
if (gateway.port && gateway.port > -1) this.gateway.port = gateway.port;
|
|
405
|
+
else this.gateway.port = -1;
|
|
406
|
+
|
|
407
|
+
if (gateway.path_params_login) {
|
|
408
|
+
this.gateway.path_params_login = gateway.path_params_login;
|
|
409
|
+
// Strip trailing slash
|
|
410
|
+
this.gateway.path_params_login = this.gateway.path_params_login.replace(/\/+$/, '');
|
|
411
|
+
} else this.gateway.path_params_login = '';
|
|
412
|
+
|
|
413
|
+
if (gateway.path_params_api) {
|
|
414
|
+
this.gateway.path_params_api = gateway.path_params_api;
|
|
415
|
+
// Strip trailing slash
|
|
416
|
+
this.gateway.path_params_api = this.gateway.path_params_api.replace(/\/+$/, '');
|
|
417
|
+
} else this.gateway.path_params_api = '';
|
|
418
|
+
|
|
419
|
+
if (gateway.username) this.gateway.username = gateway.username;
|
|
420
|
+
if (gateway.password) this.gateway.password = gateway.password;
|
|
421
|
+
} else {
|
|
422
|
+
this.gateway = undefined;
|
|
423
|
+
}
|
|
424
|
+
}
|
|
425
|
+
|
|
365
426
|
setEnvironment(env) {
|
|
366
427
|
// Default value
|
|
367
428
|
if (env) this.environment = env;
|
|
@@ -379,6 +440,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
379
440
|
this.authUrl = `https://login.${this.environment}`;
|
|
380
441
|
}
|
|
381
442
|
|
|
443
|
+
getConfUrl(pathType, regionUrl) {
|
|
444
|
+
if (!this.gateway) return regionUrl;
|
|
445
|
+
if (!this.gateway.host) return regionUrl;
|
|
446
|
+
|
|
447
|
+
var url = this.gateway.protocol + '://' + this.gateway.host;
|
|
448
|
+
if (this.gateway.port > -1) url = url + ':' + this.gateway.port.toString();
|
|
449
|
+
if (pathType === 'login') {
|
|
450
|
+
if (this.gateway.path_params_login) {
|
|
451
|
+
if (this.gateway.path_params_login.startsWith('/')) url = url + this.gateway.path_params_login;
|
|
452
|
+
else url = url + '/' + this.gateway.path_params_login;
|
|
453
|
+
}
|
|
454
|
+
} else {
|
|
455
|
+
if (this.gateway.path_params_api) {
|
|
456
|
+
if (this.gateway.path_params_api.startsWith('/')) url = url + this.gateway.path_params_api;
|
|
457
|
+
else url = url + '/' + this.gateway.path_params_api;
|
|
458
|
+
}
|
|
459
|
+
}
|
|
460
|
+
return url;
|
|
461
|
+
}
|
|
462
|
+
|
|
382
463
|
getConfigString(section, key) {
|
|
383
464
|
if (this.config._sections[section]) return this.config._sections[section][key];
|
|
384
465
|
}
|
|
@@ -402,7 +483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
402
483
|
|
|
403
484
|
/**
|
|
404
485
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
486
|
+
* @version 207.0.0
|
|
406
487
|
*/
|
|
407
488
|
class ApiClient {
|
|
408
489
|
/**
|
|
@@ -600,6 +681,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
600
681
|
this.config.setEnvironment(environment);
|
|
601
682
|
}
|
|
602
683
|
|
|
684
|
+
/**
|
|
685
|
+
* @description Sets the gateway used by the session
|
|
686
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
687
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
688
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
689
|
+
* @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).
|
|
690
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
691
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
692
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
693
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
694
|
+
*/
|
|
695
|
+
setGateway(gateway) {
|
|
696
|
+
this.config.setGateway(gateway);
|
|
697
|
+
}
|
|
698
|
+
|
|
603
699
|
/**
|
|
604
700
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
605
701
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
@@ -664,6 +760,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
664
760
|
loginClientCredentialsGrant(clientId, clientSecret) {
|
|
665
761
|
this.clientId = clientId;
|
|
666
762
|
var authHeader = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
|
|
763
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
667
764
|
|
|
668
765
|
return new Promise((resolve, reject) => {
|
|
669
766
|
// Block browsers from using client credentials
|
|
@@ -676,7 +773,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
676
773
|
};
|
|
677
774
|
axios__default["default"]({
|
|
678
775
|
method: `POST`,
|
|
679
|
-
url:
|
|
776
|
+
url: `${loginBasePath}/oauth/token`,
|
|
680
777
|
headers: headers,
|
|
681
778
|
data: 'grant_type=client_credentials',
|
|
682
779
|
httpsAgent: this.proxyAgent
|
|
@@ -687,7 +784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
784
|
'trace',
|
|
688
785
|
response.status,
|
|
689
786
|
'POST',
|
|
690
|
-
|
|
787
|
+
`${loginBasePath}/oauth/token`,
|
|
691
788
|
headers,
|
|
692
789
|
response.headers,
|
|
693
790
|
{ grant_type: 'client_credentials' },
|
|
@@ -697,7 +794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
697
794
|
'debug',
|
|
698
795
|
response.status,
|
|
699
796
|
'POST',
|
|
700
|
-
|
|
797
|
+
`${loginBasePath}/oauth/token`,
|
|
701
798
|
headers,
|
|
702
799
|
undefined,
|
|
703
800
|
{ grant_type: 'client_credentials' },
|
|
@@ -721,7 +818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
721
818
|
'error',
|
|
722
819
|
error.response.status,
|
|
723
820
|
'POST',
|
|
724
|
-
|
|
821
|
+
`${loginBasePath}/oauth/token`,
|
|
725
822
|
headers,
|
|
726
823
|
error.response.headers,
|
|
727
824
|
{ grant_type: 'client_credentials' },
|
|
@@ -742,6 +839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
742
839
|
*/
|
|
743
840
|
loginSaml2BearerGrant(clientId, clientSecret, orgName, assertion) {
|
|
744
841
|
this.clientId = clientId;
|
|
842
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
745
843
|
return new Promise((resolve, reject) => {
|
|
746
844
|
if (typeof window !== 'undefined') {
|
|
747
845
|
reject(new Error('The saml2bearer grant is not supported in a browser.'));
|
|
@@ -767,7 +865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
767
865
|
'trace',
|
|
768
866
|
response.status,
|
|
769
867
|
'POST',
|
|
770
|
-
|
|
868
|
+
`${loginBasePath}/oauth/token`,
|
|
771
869
|
request.headers,
|
|
772
870
|
response.headers,
|
|
773
871
|
bodyParam,
|
|
@@ -777,7 +875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
777
875
|
'debug',
|
|
778
876
|
response.status,
|
|
779
877
|
'POST',
|
|
780
|
-
|
|
878
|
+
`${loginBasePath}/oauth/token`,
|
|
781
879
|
request.headers,
|
|
782
880
|
undefined,
|
|
783
881
|
bodyParam,
|
|
@@ -801,7 +899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
801
899
|
'error',
|
|
802
900
|
error.response.status,
|
|
803
901
|
'POST',
|
|
804
|
-
|
|
902
|
+
`${loginBasePath}/oauth/token`,
|
|
805
903
|
request.headers,
|
|
806
904
|
error.response.headers,
|
|
807
905
|
bodyParam,
|
|
@@ -822,10 +920,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
822
920
|
*/
|
|
823
921
|
authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
|
|
824
922
|
this.clientId = clientId;
|
|
923
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
825
924
|
return new Promise((resolve, reject) => {
|
|
826
925
|
var request = axios__default["default"]({
|
|
827
926
|
method: `POST`,
|
|
828
|
-
url:
|
|
927
|
+
url: `${loginBasePath}/oauth/token`,
|
|
829
928
|
headers: {
|
|
830
929
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
831
930
|
},
|
|
@@ -852,7 +951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
852
951
|
'trace',
|
|
853
952
|
response.status,
|
|
854
953
|
'POST',
|
|
855
|
-
|
|
954
|
+
`${loginBasePath}/oauth/token`,
|
|
856
955
|
request.headers,
|
|
857
956
|
response.headers,
|
|
858
957
|
bodyParam,
|
|
@@ -862,7 +961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
862
961
|
'debug',
|
|
863
962
|
response.status,
|
|
864
963
|
'POST',
|
|
865
|
-
|
|
964
|
+
`${loginBasePath}/oauth/token`,
|
|
866
965
|
request.headers,
|
|
867
966
|
undefined,
|
|
868
967
|
bodyParam,
|
|
@@ -886,7 +985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
886
985
|
'error',
|
|
887
986
|
error.response.status,
|
|
888
987
|
'POST',
|
|
889
|
-
|
|
988
|
+
`${loginBasePath}/oauth/token`,
|
|
890
989
|
request.headers,
|
|
891
990
|
error.response.headers,
|
|
892
991
|
bodyParam,
|
|
@@ -1210,6 +1309,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1210
1309
|
* @param {function} reject - Promise reject callback
|
|
1211
1310
|
*/
|
|
1212
1311
|
_handleCodeAuthorizationResponse(request, bodyParam, resolve, reject) {
|
|
1312
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
1313
|
+
|
|
1213
1314
|
request
|
|
1214
1315
|
.then((response) => {
|
|
1215
1316
|
// Logging
|
|
@@ -1217,7 +1318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1217
1318
|
'trace',
|
|
1218
1319
|
response.status,
|
|
1219
1320
|
'POST',
|
|
1220
|
-
|
|
1321
|
+
`${loginBasePath}/oauth/token`,
|
|
1221
1322
|
request.headers,
|
|
1222
1323
|
response.headers,
|
|
1223
1324
|
bodyParam,
|
|
@@ -1227,7 +1328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1227
1328
|
'debug',
|
|
1228
1329
|
response.status,
|
|
1229
1330
|
'POST',
|
|
1230
|
-
|
|
1331
|
+
`${loginBasePath}/oauth/token`,
|
|
1231
1332
|
request.headers,
|
|
1232
1333
|
undefined,
|
|
1233
1334
|
bodyParam,
|
|
@@ -1253,7 +1354,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1253
1354
|
'error',
|
|
1254
1355
|
error.response.status,
|
|
1255
1356
|
'POST',
|
|
1256
|
-
|
|
1357
|
+
`${loginBasePath}/oauth/token`,
|
|
1257
1358
|
request.headers,
|
|
1258
1359
|
error.response.headers,
|
|
1259
1360
|
bodyParam,
|
|
@@ -1271,9 +1372,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1271
1372
|
* @param {object} data - data to url form encode
|
|
1272
1373
|
*/
|
|
1273
1374
|
_formAuthRequest(encodedData, data) {
|
|
1375
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
1274
1376
|
var request = axios__default["default"]({
|
|
1275
1377
|
method: `POST`,
|
|
1276
|
-
url:
|
|
1378
|
+
url: `${loginBasePath}/oauth/token`,
|
|
1277
1379
|
headers: {
|
|
1278
1380
|
'Authorization': 'Basic ' + encodedData,
|
|
1279
1381
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
@@ -1462,7 +1564,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1462
1564
|
*/
|
|
1463
1565
|
_buildAuthUrl(path, query) {
|
|
1464
1566
|
if (!query) query = {};
|
|
1465
|
-
|
|
1567
|
+
var loginBasePath = this.config.getConfUrl('login', this.config.authUrl);
|
|
1568
|
+
return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
|
|
1466
1569
|
}
|
|
1467
1570
|
|
|
1468
1571
|
/**
|
|
@@ -1524,7 +1627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1524
1627
|
if (!path.match(/^\//)) {
|
|
1525
1628
|
path = `/${path}`;
|
|
1526
1629
|
}
|
|
1527
|
-
var url = this.config.basePath + path;
|
|
1630
|
+
var url = this.config.getConfUrl('api', this.config.basePath) + path;
|
|
1528
1631
|
url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
|
|
1529
1632
|
var value;
|
|
1530
1633
|
if (pathParams.hasOwnProperty(key)) {
|
|
@@ -1824,7 +1927,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1824
1927
|
/**
|
|
1825
1928
|
* AgentAssistants service.
|
|
1826
1929
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1827
|
-
* @version
|
|
1930
|
+
* @version 207.0.0
|
|
1828
1931
|
*/
|
|
1829
1932
|
|
|
1830
1933
|
/**
|
|
@@ -2200,7 +2303,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2200
2303
|
/**
|
|
2201
2304
|
* AgentCopilot service.
|
|
2202
2305
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2203
|
-
* @version
|
|
2306
|
+
* @version 207.0.0
|
|
2204
2307
|
*/
|
|
2205
2308
|
|
|
2206
2309
|
/**
|
|
@@ -2276,7 +2379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2276
2379
|
/**
|
|
2277
2380
|
* AgentUI service.
|
|
2278
2381
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2279
|
-
* @version
|
|
2382
|
+
* @version 207.0.0
|
|
2280
2383
|
*/
|
|
2281
2384
|
|
|
2282
2385
|
/**
|
|
@@ -2407,7 +2510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2407
2510
|
/**
|
|
2408
2511
|
* Alerting service.
|
|
2409
2512
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2410
|
-
* @version
|
|
2513
|
+
* @version 207.0.0
|
|
2411
2514
|
*/
|
|
2412
2515
|
|
|
2413
2516
|
/**
|
|
@@ -3068,7 +3171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3068
3171
|
/**
|
|
3069
3172
|
* Analytics service.
|
|
3070
3173
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3071
|
-
* @version
|
|
3174
|
+
* @version 207.0.0
|
|
3072
3175
|
*/
|
|
3073
3176
|
|
|
3074
3177
|
/**
|
|
@@ -3919,6 +4022,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3919
4022
|
* @param {Number} opts.pageSize (default to 25)
|
|
3920
4023
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
3921
4024
|
* @param {Object} opts.state Only list users of this state
|
|
4025
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
3922
4026
|
*/
|
|
3923
4027
|
getAnalyticsReportingDashboardsUsers(opts) {
|
|
3924
4028
|
opts = opts || {};
|
|
@@ -3928,7 +4032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3928
4032
|
'/api/v2/analytics/reporting/dashboards/users',
|
|
3929
4033
|
'GET',
|
|
3930
4034
|
{ },
|
|
3931
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
|
|
4035
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'],'deletedOnly': opts['deletedOnly'] },
|
|
3932
4036
|
{ },
|
|
3933
4037
|
{ },
|
|
3934
4038
|
null,
|
|
@@ -4050,6 +4154,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4050
4154
|
* @param {Number} opts.pageSize (default to 50)
|
|
4051
4155
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
4052
4156
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
4157
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
4053
4158
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
4054
4159
|
*/
|
|
4055
4160
|
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
@@ -4064,7 +4169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4064
4169
|
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
4065
4170
|
'GET',
|
|
4066
4171
|
{ 'userId': userId },
|
|
4067
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
|
|
4172
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'deletedOnly': opts['deletedOnly'],'name': opts['name'] },
|
|
4068
4173
|
{ },
|
|
4069
4174
|
{ },
|
|
4070
4175
|
null,
|
|
@@ -5154,7 +5259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5154
5259
|
}
|
|
5155
5260
|
|
|
5156
5261
|
/**
|
|
5157
|
-
* Bulk delete dashboards owned by other user(s)
|
|
5262
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
5158
5263
|
*
|
|
5159
5264
|
* @param {Array.<String>} body List of userIds
|
|
5160
5265
|
*/
|
|
@@ -5204,7 +5309,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5204
5309
|
}
|
|
5205
5310
|
|
|
5206
5311
|
/**
|
|
5207
|
-
* Bulk
|
|
5312
|
+
* Bulk soft delete dashboard configurations
|
|
5208
5313
|
*
|
|
5209
5314
|
* @param {Object} body
|
|
5210
5315
|
*/
|
|
@@ -5390,7 +5495,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5390
5495
|
* Query for task management aggregates
|
|
5391
5496
|
*
|
|
5392
5497
|
* @param {Object} body query
|
|
5393
|
-
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5394
5498
|
*/
|
|
5395
5499
|
postAnalyticsTaskmanagementAggregatesQuery(body) {
|
|
5396
5500
|
// verify the required parameter 'body' is set
|
|
@@ -5680,7 +5784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5680
5784
|
/**
|
|
5681
5785
|
* Architect service.
|
|
5682
5786
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5683
|
-
* @version
|
|
5787
|
+
* @version 207.0.0
|
|
5684
5788
|
*/
|
|
5685
5789
|
|
|
5686
5790
|
/**
|
|
@@ -7425,7 +7529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7425
7529
|
}
|
|
7426
7530
|
|
|
7427
7531
|
/**
|
|
7428
|
-
*
|
|
7532
|
+
* Get flow version configuration
|
|
7429
7533
|
*
|
|
7430
7534
|
* @param {String} flowId Flow ID
|
|
7431
7535
|
* @param {String} versionId Version ID
|
|
@@ -9802,7 +9906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9802
9906
|
/**
|
|
9803
9907
|
* Audit service.
|
|
9804
9908
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9805
|
-
* @version
|
|
9909
|
+
* @version 207.0.0
|
|
9806
9910
|
*/
|
|
9807
9911
|
|
|
9808
9912
|
/**
|
|
@@ -10003,7 +10107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10003
10107
|
/**
|
|
10004
10108
|
* Authorization service.
|
|
10005
10109
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10006
|
-
* @version
|
|
10110
|
+
* @version 207.0.0
|
|
10007
10111
|
*/
|
|
10008
10112
|
|
|
10009
10113
|
/**
|
|
@@ -11286,7 +11390,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11286
11390
|
/**
|
|
11287
11391
|
* Billing service.
|
|
11288
11392
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11289
|
-
* @version
|
|
11393
|
+
* @version 207.0.0
|
|
11290
11394
|
*/
|
|
11291
11395
|
|
|
11292
11396
|
/**
|
|
@@ -11366,7 +11470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11366
11470
|
/**
|
|
11367
11471
|
* CarrierServices service.
|
|
11368
11472
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11369
|
-
* @version
|
|
11473
|
+
* @version 207.0.0
|
|
11370
11474
|
*/
|
|
11371
11475
|
|
|
11372
11476
|
/**
|
|
@@ -11436,7 +11540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11436
11540
|
/**
|
|
11437
11541
|
* Chat service.
|
|
11438
11542
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11439
|
-
* @version
|
|
11543
|
+
* @version 207.0.0
|
|
11440
11544
|
*/
|
|
11441
11545
|
|
|
11442
11546
|
/**
|
|
@@ -12372,7 +12476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12372
12476
|
/**
|
|
12373
12477
|
* Coaching service.
|
|
12374
12478
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12375
|
-
* @version
|
|
12479
|
+
* @version 207.0.0
|
|
12376
12480
|
*/
|
|
12377
12481
|
|
|
12378
12482
|
/**
|
|
@@ -12949,7 +13053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12949
13053
|
/**
|
|
12950
13054
|
* ContentManagement service.
|
|
12951
13055
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12952
|
-
* @version
|
|
13056
|
+
* @version 207.0.0
|
|
12953
13057
|
*/
|
|
12954
13058
|
|
|
12955
13059
|
/**
|
|
@@ -13338,7 +13442,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13338
13442
|
* 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.
|
|
13339
13443
|
* @param {String} sharedId Shared ID
|
|
13340
13444
|
* @param {Object} opts Optional parameters
|
|
13341
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
13342
13445
|
* @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
|
|
13343
13446
|
* @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
|
|
13344
13447
|
* @param {Object} opts.expand Expand some document fields
|
|
@@ -13355,7 +13458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13355
13458
|
'/api/v2/contentmanagement/shared/{sharedId}',
|
|
13356
13459
|
'GET',
|
|
13357
13460
|
{ 'sharedId': sharedId },
|
|
13358
|
-
{ '
|
|
13461
|
+
{ 'disposition': opts['disposition'],'contentType': opts['contentType'],'expand': opts['expand'] },
|
|
13359
13462
|
{ },
|
|
13360
13463
|
{ },
|
|
13361
13464
|
null,
|
|
@@ -14031,7 +14134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14031
14134
|
/**
|
|
14032
14135
|
* Conversations service.
|
|
14033
14136
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14034
|
-
* @version
|
|
14137
|
+
* @version 207.0.0
|
|
14035
14138
|
*/
|
|
14036
14139
|
|
|
14037
14140
|
/**
|
|
@@ -17777,7 +17880,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17777
17880
|
* @param {String} conversationId conversationId
|
|
17778
17881
|
* @param {String} participantId participantId
|
|
17779
17882
|
* @param {Object} body Parking update request
|
|
17780
|
-
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17781
17883
|
*/
|
|
17782
17884
|
patchConversationsEmailParticipantParkingstate(conversationId, participantId, body) {
|
|
17783
17885
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18725,9 +18827,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18725
18827
|
|
|
18726
18828
|
/**
|
|
18727
18829
|
* Suggestion feedback.
|
|
18728
|
-
*
|
|
18830
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
18729
18831
|
* @param {String} conversationId Conversation ID
|
|
18730
18832
|
* @param {Object} body SuggestionFeedback
|
|
18833
|
+
* @deprecated
|
|
18731
18834
|
*/
|
|
18732
18835
|
postConversationSuggestionsFeedback(conversationId, body) {
|
|
18733
18836
|
// verify the required parameter 'conversationId' is set
|
|
@@ -20017,8 +20120,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20017
20120
|
* 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.
|
|
20018
20121
|
* @param {String} integrationId integrationId
|
|
20019
20122
|
* @param {Object} body NormalizedMessage
|
|
20123
|
+
* @param {Object} opts Optional parameters
|
|
20124
|
+
* @param {Boolean} opts.prefetchConversationId Indicates whether or not to prefetch conversationId (default to false)
|
|
20020
20125
|
*/
|
|
20021
|
-
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
20126
|
+
postConversationsMessageInboundOpenMessage(integrationId, body, opts) {
|
|
20127
|
+
opts = opts || {};
|
|
20128
|
+
|
|
20022
20129
|
// verify the required parameter 'integrationId' is set
|
|
20023
20130
|
if (integrationId === undefined || integrationId === null) {
|
|
20024
20131
|
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
@@ -20032,7 +20139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20032
20139
|
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
20033
20140
|
'POST',
|
|
20034
20141
|
{ 'integrationId': integrationId },
|
|
20035
|
-
{
|
|
20142
|
+
{ 'prefetchConversationId': opts['prefetchConversationId'] },
|
|
20036
20143
|
{ },
|
|
20037
20144
|
{ },
|
|
20038
20145
|
body,
|
|
@@ -21169,7 +21276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21169
21276
|
/**
|
|
21170
21277
|
* DataExtensions service.
|
|
21171
21278
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21172
|
-
* @version
|
|
21279
|
+
* @version 207.0.0
|
|
21173
21280
|
*/
|
|
21174
21281
|
|
|
21175
21282
|
/**
|
|
@@ -21255,7 +21362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21255
21362
|
/**
|
|
21256
21363
|
* Downloads service.
|
|
21257
21364
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21258
|
-
* @version
|
|
21365
|
+
* @version 207.0.0
|
|
21259
21366
|
*/
|
|
21260
21367
|
|
|
21261
21368
|
/**
|
|
@@ -21307,7 +21414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21307
21414
|
/**
|
|
21308
21415
|
* Emails service.
|
|
21309
21416
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21310
|
-
* @version
|
|
21417
|
+
* @version 207.0.0
|
|
21311
21418
|
*/
|
|
21312
21419
|
|
|
21313
21420
|
/**
|
|
@@ -21372,7 +21479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21372
21479
|
/**
|
|
21373
21480
|
* EmployeeEngagement service.
|
|
21374
21481
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21375
|
-
* @version
|
|
21482
|
+
* @version 207.0.0
|
|
21376
21483
|
*/
|
|
21377
21484
|
|
|
21378
21485
|
/**
|
|
@@ -21523,7 +21630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21523
21630
|
/**
|
|
21524
21631
|
* Events service.
|
|
21525
21632
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21526
|
-
* @version
|
|
21633
|
+
* @version 207.0.0
|
|
21527
21634
|
*/
|
|
21528
21635
|
|
|
21529
21636
|
/**
|
|
@@ -21619,7 +21726,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21619
21726
|
/**
|
|
21620
21727
|
* ExternalContacts service.
|
|
21621
21728
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21622
|
-
* @version
|
|
21729
|
+
* @version 207.0.0
|
|
21623
21730
|
*/
|
|
21624
21731
|
|
|
21625
21732
|
/**
|
|
@@ -21740,6 +21847,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21740
21847
|
);
|
|
21741
21848
|
}
|
|
21742
21849
|
|
|
21850
|
+
/**
|
|
21851
|
+
* Delete settings for CSV import
|
|
21852
|
+
*
|
|
21853
|
+
* @param {String} settingsId Settings id
|
|
21854
|
+
*/
|
|
21855
|
+
deleteExternalcontactsImportCsvSetting(settingsId) {
|
|
21856
|
+
// verify the required parameter 'settingsId' is set
|
|
21857
|
+
if (settingsId === undefined || settingsId === null) {
|
|
21858
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';
|
|
21859
|
+
}
|
|
21860
|
+
|
|
21861
|
+
return this.apiClient.callApi(
|
|
21862
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
21863
|
+
'DELETE',
|
|
21864
|
+
{ 'settingsId': settingsId },
|
|
21865
|
+
{ },
|
|
21866
|
+
{ },
|
|
21867
|
+
{ },
|
|
21868
|
+
null,
|
|
21869
|
+
['PureCloud OAuth'],
|
|
21870
|
+
['application/json'],
|
|
21871
|
+
['application/json']
|
|
21872
|
+
);
|
|
21873
|
+
}
|
|
21874
|
+
|
|
21743
21875
|
/**
|
|
21744
21876
|
* Delete an external organization
|
|
21745
21877
|
*
|
|
@@ -22207,6 +22339,107 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22207
22339
|
);
|
|
22208
22340
|
}
|
|
22209
22341
|
|
|
22342
|
+
/**
|
|
22343
|
+
* Get settings for CSV import
|
|
22344
|
+
*
|
|
22345
|
+
* @param {String} settingsId Settings id
|
|
22346
|
+
*/
|
|
22347
|
+
getExternalcontactsImportCsvSetting(settingsId) {
|
|
22348
|
+
// verify the required parameter 'settingsId' is set
|
|
22349
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22350
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';
|
|
22351
|
+
}
|
|
22352
|
+
|
|
22353
|
+
return this.apiClient.callApi(
|
|
22354
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
22355
|
+
'GET',
|
|
22356
|
+
{ 'settingsId': settingsId },
|
|
22357
|
+
{ },
|
|
22358
|
+
{ },
|
|
22359
|
+
{ },
|
|
22360
|
+
null,
|
|
22361
|
+
['PureCloud OAuth'],
|
|
22362
|
+
['application/json'],
|
|
22363
|
+
['application/json']
|
|
22364
|
+
);
|
|
22365
|
+
}
|
|
22366
|
+
|
|
22367
|
+
/**
|
|
22368
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
22369
|
+
*
|
|
22370
|
+
* @param {Object} opts Optional parameters
|
|
22371
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22372
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22373
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
22374
|
+
*/
|
|
22375
|
+
getExternalcontactsImportCsvSettings(opts) {
|
|
22376
|
+
opts = opts || {};
|
|
22377
|
+
|
|
22378
|
+
|
|
22379
|
+
return this.apiClient.callApi(
|
|
22380
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
22381
|
+
'GET',
|
|
22382
|
+
{ },
|
|
22383
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'externalSettingsId': opts['externalSettingsId'] },
|
|
22384
|
+
{ },
|
|
22385
|
+
{ },
|
|
22386
|
+
null,
|
|
22387
|
+
['PureCloud OAuth'],
|
|
22388
|
+
['application/json'],
|
|
22389
|
+
['application/json']
|
|
22390
|
+
);
|
|
22391
|
+
}
|
|
22392
|
+
|
|
22393
|
+
/**
|
|
22394
|
+
* Get details for CSV upload
|
|
22395
|
+
*
|
|
22396
|
+
* @param {String} uploadId Upload id
|
|
22397
|
+
*/
|
|
22398
|
+
getExternalcontactsImportCsvUploadDetails(uploadId) {
|
|
22399
|
+
// verify the required parameter 'uploadId' is set
|
|
22400
|
+
if (uploadId === undefined || uploadId === null) {
|
|
22401
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';
|
|
22402
|
+
}
|
|
22403
|
+
|
|
22404
|
+
return this.apiClient.callApi(
|
|
22405
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details',
|
|
22406
|
+
'GET',
|
|
22407
|
+
{ 'uploadId': uploadId },
|
|
22408
|
+
{ },
|
|
22409
|
+
{ },
|
|
22410
|
+
{ },
|
|
22411
|
+
null,
|
|
22412
|
+
['PureCloud OAuth'],
|
|
22413
|
+
['application/json'],
|
|
22414
|
+
['application/json']
|
|
22415
|
+
);
|
|
22416
|
+
}
|
|
22417
|
+
|
|
22418
|
+
/**
|
|
22419
|
+
* Get preview for CSV upload
|
|
22420
|
+
*
|
|
22421
|
+
* @param {String} uploadId Upload id
|
|
22422
|
+
*/
|
|
22423
|
+
getExternalcontactsImportCsvUploadPreview(uploadId) {
|
|
22424
|
+
// verify the required parameter 'uploadId' is set
|
|
22425
|
+
if (uploadId === undefined || uploadId === null) {
|
|
22426
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';
|
|
22427
|
+
}
|
|
22428
|
+
|
|
22429
|
+
return this.apiClient.callApi(
|
|
22430
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview',
|
|
22431
|
+
'GET',
|
|
22432
|
+
{ 'uploadId': uploadId },
|
|
22433
|
+
{ },
|
|
22434
|
+
{ },
|
|
22435
|
+
{ },
|
|
22436
|
+
null,
|
|
22437
|
+
['PureCloud OAuth'],
|
|
22438
|
+
['application/json'],
|
|
22439
|
+
['application/json']
|
|
22440
|
+
);
|
|
22441
|
+
}
|
|
22442
|
+
|
|
22210
22443
|
/**
|
|
22211
22444
|
* Fetch an external organization
|
|
22212
22445
|
*
|
|
@@ -23271,6 +23504,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23271
23504
|
);
|
|
23272
23505
|
}
|
|
23273
23506
|
|
|
23507
|
+
/**
|
|
23508
|
+
* Create CSV import job
|
|
23509
|
+
*
|
|
23510
|
+
* @param {Object} body ImportRequest
|
|
23511
|
+
*/
|
|
23512
|
+
postExternalcontactsImportCsvJobs(body) {
|
|
23513
|
+
// verify the required parameter 'body' is set
|
|
23514
|
+
if (body === undefined || body === null) {
|
|
23515
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';
|
|
23516
|
+
}
|
|
23517
|
+
|
|
23518
|
+
return this.apiClient.callApi(
|
|
23519
|
+
'/api/v2/externalcontacts/import/csv/jobs',
|
|
23520
|
+
'POST',
|
|
23521
|
+
{ },
|
|
23522
|
+
{ },
|
|
23523
|
+
{ },
|
|
23524
|
+
{ },
|
|
23525
|
+
body,
|
|
23526
|
+
['PureCloud OAuth'],
|
|
23527
|
+
['application/json'],
|
|
23528
|
+
['application/json']
|
|
23529
|
+
);
|
|
23530
|
+
}
|
|
23531
|
+
|
|
23532
|
+
/**
|
|
23533
|
+
* Create settings for CSV import
|
|
23534
|
+
*
|
|
23535
|
+
* @param {Object} body Settings
|
|
23536
|
+
*/
|
|
23537
|
+
postExternalcontactsImportCsvSettings(body) {
|
|
23538
|
+
// verify the required parameter 'body' is set
|
|
23539
|
+
if (body === undefined || body === null) {
|
|
23540
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';
|
|
23541
|
+
}
|
|
23542
|
+
|
|
23543
|
+
return this.apiClient.callApi(
|
|
23544
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
23545
|
+
'POST',
|
|
23546
|
+
{ },
|
|
23547
|
+
{ },
|
|
23548
|
+
{ },
|
|
23549
|
+
{ },
|
|
23550
|
+
body,
|
|
23551
|
+
['PureCloud OAuth'],
|
|
23552
|
+
['application/json'],
|
|
23553
|
+
['application/json']
|
|
23554
|
+
);
|
|
23555
|
+
}
|
|
23556
|
+
|
|
23557
|
+
/**
|
|
23558
|
+
* Get url for CSV upload
|
|
23559
|
+
*
|
|
23560
|
+
* @param {Object} body UploadRequest
|
|
23561
|
+
*/
|
|
23562
|
+
postExternalcontactsImportCsvUploads(body) {
|
|
23563
|
+
// verify the required parameter 'body' is set
|
|
23564
|
+
if (body === undefined || body === null) {
|
|
23565
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';
|
|
23566
|
+
}
|
|
23567
|
+
|
|
23568
|
+
return this.apiClient.callApi(
|
|
23569
|
+
'/api/v2/externalcontacts/import/csv/uploads',
|
|
23570
|
+
'POST',
|
|
23571
|
+
{ },
|
|
23572
|
+
{ },
|
|
23573
|
+
{ },
|
|
23574
|
+
{ },
|
|
23575
|
+
body,
|
|
23576
|
+
['PureCloud OAuth'],
|
|
23577
|
+
['application/json'],
|
|
23578
|
+
['application/json']
|
|
23579
|
+
);
|
|
23580
|
+
}
|
|
23581
|
+
|
|
23274
23582
|
/**
|
|
23275
23583
|
* Merge two contacts into a new contact record
|
|
23276
23584
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -23557,6 +23865,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23557
23865
|
);
|
|
23558
23866
|
}
|
|
23559
23867
|
|
|
23868
|
+
/**
|
|
23869
|
+
* Update settings for CSV import
|
|
23870
|
+
*
|
|
23871
|
+
* @param {String} settingsId Settings id
|
|
23872
|
+
* @param {Object} body Settings
|
|
23873
|
+
*/
|
|
23874
|
+
putExternalcontactsImportCsvSetting(settingsId, body) {
|
|
23875
|
+
// verify the required parameter 'settingsId' is set
|
|
23876
|
+
if (settingsId === undefined || settingsId === null) {
|
|
23877
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';
|
|
23878
|
+
}
|
|
23879
|
+
// verify the required parameter 'body' is set
|
|
23880
|
+
if (body === undefined || body === null) {
|
|
23881
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';
|
|
23882
|
+
}
|
|
23883
|
+
|
|
23884
|
+
return this.apiClient.callApi(
|
|
23885
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
23886
|
+
'PUT',
|
|
23887
|
+
{ 'settingsId': settingsId },
|
|
23888
|
+
{ },
|
|
23889
|
+
{ },
|
|
23890
|
+
{ },
|
|
23891
|
+
body,
|
|
23892
|
+
['PureCloud OAuth'],
|
|
23893
|
+
['application/json'],
|
|
23894
|
+
['application/json']
|
|
23895
|
+
);
|
|
23896
|
+
}
|
|
23897
|
+
|
|
23560
23898
|
/**
|
|
23561
23899
|
* Update an external organization
|
|
23562
23900
|
*
|
|
@@ -23718,7 +24056,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23718
24056
|
/**
|
|
23719
24057
|
* Fax service.
|
|
23720
24058
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23721
|
-
* @version
|
|
24059
|
+
* @version 207.0.0
|
|
23722
24060
|
*/
|
|
23723
24061
|
|
|
23724
24062
|
/**
|
|
@@ -23933,7 +24271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23933
24271
|
/**
|
|
23934
24272
|
* Flows service.
|
|
23935
24273
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23936
|
-
* @version
|
|
24274
|
+
* @version 207.0.0
|
|
23937
24275
|
*/
|
|
23938
24276
|
|
|
23939
24277
|
/**
|
|
@@ -24116,7 +24454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24116
24454
|
/**
|
|
24117
24455
|
* Gamification service.
|
|
24118
24456
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24119
|
-
* @version
|
|
24457
|
+
* @version 207.0.0
|
|
24120
24458
|
*/
|
|
24121
24459
|
|
|
24122
24460
|
/**
|
|
@@ -26202,7 +26540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26202
26540
|
/**
|
|
26203
26541
|
* GeneralDataProtectionRegulation service.
|
|
26204
26542
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26205
|
-
* @version
|
|
26543
|
+
* @version 207.0.0
|
|
26206
26544
|
*/
|
|
26207
26545
|
|
|
26208
26546
|
/**
|
|
@@ -26332,7 +26670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26332
26670
|
/**
|
|
26333
26671
|
* Geolocation service.
|
|
26334
26672
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26335
|
-
* @version
|
|
26673
|
+
* @version 207.0.0
|
|
26336
26674
|
*/
|
|
26337
26675
|
|
|
26338
26676
|
/**
|
|
@@ -26463,7 +26801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26463
26801
|
/**
|
|
26464
26802
|
* Greetings service.
|
|
26465
26803
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26466
|
-
* @version
|
|
26804
|
+
* @version 207.0.0
|
|
26467
26805
|
*/
|
|
26468
26806
|
|
|
26469
26807
|
/**
|
|
@@ -26918,7 +27256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26918
27256
|
/**
|
|
26919
27257
|
* Groups service.
|
|
26920
27258
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26921
|
-
* @version
|
|
27259
|
+
* @version 207.0.0
|
|
26922
27260
|
*/
|
|
26923
27261
|
|
|
26924
27262
|
/**
|
|
@@ -27437,7 +27775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27437
27775
|
/**
|
|
27438
27776
|
* IdentityProvider service.
|
|
27439
27777
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27440
|
-
* @version
|
|
27778
|
+
* @version 207.0.0
|
|
27441
27779
|
*/
|
|
27442
27780
|
|
|
27443
27781
|
/**
|
|
@@ -28298,7 +28636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28298
28636
|
/**
|
|
28299
28637
|
* InfrastructureAsCode service.
|
|
28300
28638
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28301
|
-
* @version
|
|
28639
|
+
* @version 207.0.0
|
|
28302
28640
|
*/
|
|
28303
28641
|
|
|
28304
28642
|
/**
|
|
@@ -28465,7 +28803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28465
28803
|
/**
|
|
28466
28804
|
* Integrations service.
|
|
28467
28805
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28468
|
-
* @version
|
|
28806
|
+
* @version 207.0.0
|
|
28469
28807
|
*/
|
|
28470
28808
|
|
|
28471
28809
|
/**
|
|
@@ -30887,7 +31225,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30887
31225
|
/**
|
|
30888
31226
|
* Journey service.
|
|
30889
31227
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30890
|
-
* @version
|
|
31228
|
+
* @version 207.0.0
|
|
30891
31229
|
*/
|
|
30892
31230
|
|
|
30893
31231
|
/**
|
|
@@ -31734,6 +32072,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31734
32072
|
);
|
|
31735
32073
|
}
|
|
31736
32074
|
|
|
32075
|
+
/**
|
|
32076
|
+
* Get a Chart by ID
|
|
32077
|
+
* returns the latest version
|
|
32078
|
+
* @param {String} viewId viewId
|
|
32079
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
32080
|
+
* @param {String} chartId chartId
|
|
32081
|
+
*/
|
|
32082
|
+
getJourneyViewVersionChart(viewId, journeyViewVersion, chartId) {
|
|
32083
|
+
// verify the required parameter 'viewId' is set
|
|
32084
|
+
if (viewId === undefined || viewId === null) {
|
|
32085
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';
|
|
32086
|
+
}
|
|
32087
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
32088
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
32089
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChart';
|
|
32090
|
+
}
|
|
32091
|
+
// verify the required parameter 'chartId' is set
|
|
32092
|
+
if (chartId === undefined || chartId === null) {
|
|
32093
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionChart';
|
|
32094
|
+
}
|
|
32095
|
+
|
|
32096
|
+
return this.apiClient.callApi(
|
|
32097
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}',
|
|
32098
|
+
'GET',
|
|
32099
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'chartId': chartId },
|
|
32100
|
+
{ },
|
|
32101
|
+
{ },
|
|
32102
|
+
{ },
|
|
32103
|
+
null,
|
|
32104
|
+
['PureCloud OAuth'],
|
|
32105
|
+
['application/json'],
|
|
32106
|
+
['application/json']
|
|
32107
|
+
);
|
|
32108
|
+
}
|
|
32109
|
+
|
|
32110
|
+
/**
|
|
32111
|
+
* Get a Chart by ID and version
|
|
32112
|
+
*
|
|
32113
|
+
* @param {String} viewId viewId
|
|
32114
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
32115
|
+
* @param {String} chartId chartId
|
|
32116
|
+
* @param {String} chartVersion chartVersion
|
|
32117
|
+
*/
|
|
32118
|
+
getJourneyViewVersionChartVersion(viewId, journeyViewVersion, chartId, chartVersion) {
|
|
32119
|
+
// verify the required parameter 'viewId' is set
|
|
32120
|
+
if (viewId === undefined || viewId === null) {
|
|
32121
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';
|
|
32122
|
+
}
|
|
32123
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
32124
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
32125
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChartVersion';
|
|
32126
|
+
}
|
|
32127
|
+
// verify the required parameter 'chartId' is set
|
|
32128
|
+
if (chartId === undefined || chartId === null) {
|
|
32129
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';
|
|
32130
|
+
}
|
|
32131
|
+
// verify the required parameter 'chartVersion' is set
|
|
32132
|
+
if (chartVersion === undefined || chartVersion === null) {
|
|
32133
|
+
throw 'Missing the required parameter "chartVersion" when calling getJourneyViewVersionChartVersion';
|
|
32134
|
+
}
|
|
32135
|
+
|
|
32136
|
+
return this.apiClient.callApi(
|
|
32137
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}',
|
|
32138
|
+
'GET',
|
|
32139
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'chartId': chartId,'chartVersion': chartVersion },
|
|
32140
|
+
{ },
|
|
32141
|
+
{ },
|
|
32142
|
+
{ },
|
|
32143
|
+
null,
|
|
32144
|
+
['PureCloud OAuth'],
|
|
32145
|
+
['application/json'],
|
|
32146
|
+
['application/json']
|
|
32147
|
+
);
|
|
32148
|
+
}
|
|
32149
|
+
|
|
31737
32150
|
/**
|
|
31738
32151
|
* Get the job for a journey view version.
|
|
31739
32152
|
* used for long descriptions
|
|
@@ -31804,6 +32217,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31804
32217
|
);
|
|
31805
32218
|
}
|
|
31806
32219
|
|
|
32220
|
+
/**
|
|
32221
|
+
* Get the chart result associated with a journey view job.
|
|
32222
|
+
*
|
|
32223
|
+
* @param {String} viewId Journey View Id
|
|
32224
|
+
* @param {String} journeyVersionId Journey View Version
|
|
32225
|
+
* @param {String} jobId JobId
|
|
32226
|
+
* @param {String} chartId ChartId
|
|
32227
|
+
*/
|
|
32228
|
+
getJourneyViewVersionJobResultsChart(viewId, journeyVersionId, jobId, chartId) {
|
|
32229
|
+
// verify the required parameter 'viewId' is set
|
|
32230
|
+
if (viewId === undefined || viewId === null) {
|
|
32231
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';
|
|
32232
|
+
}
|
|
32233
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
32234
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
32235
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobResultsChart';
|
|
32236
|
+
}
|
|
32237
|
+
// verify the required parameter 'jobId' is set
|
|
32238
|
+
if (jobId === undefined || jobId === null) {
|
|
32239
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';
|
|
32240
|
+
}
|
|
32241
|
+
// verify the required parameter 'chartId' is set
|
|
32242
|
+
if (chartId === undefined || chartId === null) {
|
|
32243
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionJobResultsChart';
|
|
32244
|
+
}
|
|
32245
|
+
|
|
32246
|
+
return this.apiClient.callApi(
|
|
32247
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}',
|
|
32248
|
+
'GET',
|
|
32249
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId,'chartId': chartId },
|
|
32250
|
+
{ },
|
|
32251
|
+
{ },
|
|
32252
|
+
{ },
|
|
32253
|
+
null,
|
|
32254
|
+
['PureCloud OAuth'],
|
|
32255
|
+
['application/json'],
|
|
32256
|
+
['application/json']
|
|
32257
|
+
);
|
|
32258
|
+
}
|
|
32259
|
+
|
|
31807
32260
|
/**
|
|
31808
32261
|
* Get the latest job of a journey view version.
|
|
31809
32262
|
* used for long descriptions
|
|
@@ -31866,7 +32319,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31866
32319
|
* Get an Event Definition
|
|
31867
32320
|
*
|
|
31868
32321
|
* @param {String} eventDefinitionId Event Definition ID
|
|
31869
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31870
32322
|
*/
|
|
31871
32323
|
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
31872
32324
|
// verify the required parameter 'eventDefinitionId' is set
|
|
@@ -31891,7 +32343,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31891
32343
|
/**
|
|
31892
32344
|
* Get a list of Event Definitions
|
|
31893
32345
|
*
|
|
31894
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31895
32346
|
*/
|
|
31896
32347
|
getJourneyViewsEventdefinitions() {
|
|
31897
32348
|
|
|
@@ -32081,6 +32532,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32081
32532
|
);
|
|
32082
32533
|
}
|
|
32083
32534
|
|
|
32535
|
+
/**
|
|
32536
|
+
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
32537
|
+
* used for long descriptions
|
|
32538
|
+
* @param {String} viewId Journey View Id
|
|
32539
|
+
* @param {String} journeyVersionId Journey View Version
|
|
32540
|
+
* @param {String} jobId JobId
|
|
32541
|
+
* @param {Object} body journeyViewJob
|
|
32542
|
+
*/
|
|
32543
|
+
patchJourneyViewVersionJob(viewId, journeyVersionId, jobId, body) {
|
|
32544
|
+
// verify the required parameter 'viewId' is set
|
|
32545
|
+
if (viewId === undefined || viewId === null) {
|
|
32546
|
+
throw 'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';
|
|
32547
|
+
}
|
|
32548
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
32549
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
32550
|
+
throw 'Missing the required parameter "journeyVersionId" when calling patchJourneyViewVersionJob';
|
|
32551
|
+
}
|
|
32552
|
+
// verify the required parameter 'jobId' is set
|
|
32553
|
+
if (jobId === undefined || jobId === null) {
|
|
32554
|
+
throw 'Missing the required parameter "jobId" when calling patchJourneyViewVersionJob';
|
|
32555
|
+
}
|
|
32556
|
+
// verify the required parameter 'body' is set
|
|
32557
|
+
if (body === undefined || body === null) {
|
|
32558
|
+
throw 'Missing the required parameter "body" when calling patchJourneyViewVersionJob';
|
|
32559
|
+
}
|
|
32560
|
+
|
|
32561
|
+
return this.apiClient.callApi(
|
|
32562
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}',
|
|
32563
|
+
'PATCH',
|
|
32564
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
|
|
32565
|
+
{ },
|
|
32566
|
+
{ },
|
|
32567
|
+
{ },
|
|
32568
|
+
body,
|
|
32569
|
+
['PureCloud OAuth'],
|
|
32570
|
+
['application/json'],
|
|
32571
|
+
['application/json']
|
|
32572
|
+
);
|
|
32573
|
+
}
|
|
32574
|
+
|
|
32084
32575
|
/**
|
|
32085
32576
|
* Query for journey aggregates asynchronously
|
|
32086
32577
|
*
|
|
@@ -32504,7 +32995,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32504
32995
|
* True indicates a valid encoding
|
|
32505
32996
|
* @param {Object} opts Optional parameters
|
|
32506
32997
|
* @param {Array.<Object>} opts.body
|
|
32507
|
-
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32508
32998
|
*/
|
|
32509
32999
|
postJourneyViewsEncodingsValidate(opts) {
|
|
32510
33000
|
opts = opts || {};
|
|
@@ -32524,13 +33014,48 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32524
33014
|
);
|
|
32525
33015
|
}
|
|
32526
33016
|
|
|
33017
|
+
/**
|
|
33018
|
+
* Update a Journey View by ID and version
|
|
33019
|
+
* does not create a new version
|
|
33020
|
+
* @param {String} viewId viewId
|
|
33021
|
+
* @param {String} versionId versionId
|
|
33022
|
+
* @param {Object} body JourneyView
|
|
33023
|
+
*/
|
|
33024
|
+
putJourneyViewVersion(viewId, versionId, body) {
|
|
33025
|
+
// verify the required parameter 'viewId' is set
|
|
33026
|
+
if (viewId === undefined || viewId === null) {
|
|
33027
|
+
throw 'Missing the required parameter "viewId" when calling putJourneyViewVersion';
|
|
33028
|
+
}
|
|
33029
|
+
// verify the required parameter 'versionId' is set
|
|
33030
|
+
if (versionId === undefined || versionId === null) {
|
|
33031
|
+
throw 'Missing the required parameter "versionId" when calling putJourneyViewVersion';
|
|
33032
|
+
}
|
|
33033
|
+
// verify the required parameter 'body' is set
|
|
33034
|
+
if (body === undefined || body === null) {
|
|
33035
|
+
throw 'Missing the required parameter "body" when calling putJourneyViewVersion';
|
|
33036
|
+
}
|
|
33037
|
+
|
|
33038
|
+
return this.apiClient.callApi(
|
|
33039
|
+
'/api/v2/journey/views/{viewId}/versions/{versionId}',
|
|
33040
|
+
'PUT',
|
|
33041
|
+
{ 'viewId': viewId,'versionId': versionId },
|
|
33042
|
+
{ },
|
|
33043
|
+
{ },
|
|
33044
|
+
{ },
|
|
33045
|
+
body,
|
|
33046
|
+
['PureCloud OAuth'],
|
|
33047
|
+
['application/json'],
|
|
33048
|
+
['application/json']
|
|
33049
|
+
);
|
|
33050
|
+
}
|
|
33051
|
+
|
|
32527
33052
|
}
|
|
32528
33053
|
|
|
32529
33054
|
class KnowledgeApi {
|
|
32530
33055
|
/**
|
|
32531
33056
|
* Knowledge service.
|
|
32532
33057
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
32533
|
-
* @version
|
|
33058
|
+
* @version 207.0.0
|
|
32534
33059
|
*/
|
|
32535
33060
|
|
|
32536
33061
|
/**
|
|
@@ -32868,7 +33393,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32868
33393
|
*
|
|
32869
33394
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32870
33395
|
* @param {String} sourceId Source ID
|
|
32871
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32872
33396
|
*/
|
|
32873
33397
|
deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId) {
|
|
32874
33398
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -32899,7 +33423,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32899
33423
|
*
|
|
32900
33424
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32901
33425
|
* @param {String} sourceId Source ID
|
|
32902
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32903
33426
|
*/
|
|
32904
33427
|
deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId) {
|
|
32905
33428
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -32930,7 +33453,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32930
33453
|
*
|
|
32931
33454
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32932
33455
|
* @param {String} syncJobId Synchronization job ID
|
|
32933
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32934
33456
|
*/
|
|
32935
33457
|
deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
32936
33458
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33057,7 +33579,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33057
33579
|
* Get sync options available for a knowledge-connect integration
|
|
33058
33580
|
*
|
|
33059
33581
|
* @param {String} integrationId Integration ID
|
|
33060
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33061
33582
|
*/
|
|
33062
33583
|
getKnowledgeIntegrationOptions(integrationId) {
|
|
33063
33584
|
// verify the required parameter 'integrationId' is set
|
|
@@ -34004,7 +34525,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34004
34525
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
34005
34526
|
* @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
|
|
34006
34527
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
34007
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34008
34528
|
*/
|
|
34009
34529
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
34010
34530
|
opts = opts || {};
|
|
@@ -34032,7 +34552,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34032
34552
|
* Get ids of operation creator users and oauth clients
|
|
34033
34553
|
*
|
|
34034
34554
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34035
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34036
34555
|
*/
|
|
34037
34556
|
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
34038
34557
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -34097,7 +34616,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34097
34616
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
34098
34617
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34099
34618
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
34100
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34101
34619
|
*/
|
|
34102
34620
|
getKnowledgeKnowledgebaseSources(knowledgeBaseId, opts) {
|
|
34103
34621
|
opts = opts || {};
|
|
@@ -34128,7 +34646,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34128
34646
|
* @param {String} sourceId Source ID
|
|
34129
34647
|
* @param {Object} opts Optional parameters
|
|
34130
34648
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34131
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34132
34649
|
*/
|
|
34133
34650
|
getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34134
34651
|
opts = opts || {};
|
|
@@ -34163,7 +34680,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34163
34680
|
* @param {String} sourceId Source ID
|
|
34164
34681
|
* @param {Object} opts Optional parameters
|
|
34165
34682
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34166
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34167
34683
|
*/
|
|
34168
34684
|
getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34169
34685
|
opts = opts || {};
|
|
@@ -34196,7 +34712,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34196
34712
|
*
|
|
34197
34713
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34198
34714
|
* @param {String} syncJobId Synchronization job ID
|
|
34199
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34200
34715
|
*/
|
|
34201
34716
|
getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
34202
34717
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -34912,7 +35427,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34912
35427
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34913
35428
|
* @param {String} syncJobId Synchronization job ID
|
|
34914
35429
|
* @param {Object} body
|
|
34915
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34916
35430
|
*/
|
|
34917
35431
|
patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId, body) {
|
|
34918
35432
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36134,7 +36648,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36134
36648
|
*
|
|
36135
36649
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36136
36650
|
* @param {Object} body
|
|
36137
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36138
36651
|
*/
|
|
36139
36652
|
postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId, body) {
|
|
36140
36653
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36165,7 +36678,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36165
36678
|
*
|
|
36166
36679
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36167
36680
|
* @param {String} sourceId Source ID
|
|
36168
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36169
36681
|
*/
|
|
36170
36682
|
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36171
36683
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36196,7 +36708,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36196
36708
|
*
|
|
36197
36709
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36198
36710
|
* @param {Object} body
|
|
36199
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36200
36711
|
*/
|
|
36201
36712
|
postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId, body) {
|
|
36202
36713
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36227,7 +36738,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36227
36738
|
*
|
|
36228
36739
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36229
36740
|
* @param {String} sourceId Source ID
|
|
36230
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36231
36741
|
*/
|
|
36232
36742
|
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36233
36743
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36258,7 +36768,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36258
36768
|
*
|
|
36259
36769
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36260
36770
|
* @param {Object} body
|
|
36261
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36262
36771
|
*/
|
|
36263
36772
|
postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId, body) {
|
|
36264
36773
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36346,7 +36855,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36346
36855
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36347
36856
|
* @param {String} sourceId Source ID
|
|
36348
36857
|
* @param {Object} body
|
|
36349
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36350
36858
|
*/
|
|
36351
36859
|
putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, body) {
|
|
36352
36860
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36382,7 +36890,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36382
36890
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36383
36891
|
* @param {String} sourceId Source ID
|
|
36384
36892
|
* @param {Object} body
|
|
36385
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36386
36893
|
*/
|
|
36387
36894
|
putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, body) {
|
|
36388
36895
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36418,7 +36925,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36418
36925
|
/**
|
|
36419
36926
|
* LanguageUnderstanding service.
|
|
36420
36927
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
36421
|
-
* @version
|
|
36928
|
+
* @version 207.0.0
|
|
36422
36929
|
*/
|
|
36423
36930
|
|
|
36424
36931
|
/**
|
|
@@ -37452,7 +37959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37452
37959
|
/**
|
|
37453
37960
|
* Languages service.
|
|
37454
37961
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
37455
|
-
* @version
|
|
37962
|
+
* @version 207.0.0
|
|
37456
37963
|
*/
|
|
37457
37964
|
|
|
37458
37965
|
/**
|
|
@@ -37674,7 +38181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37674
38181
|
/**
|
|
37675
38182
|
* Learning service.
|
|
37676
38183
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
37677
|
-
* @version
|
|
38184
|
+
* @version 207.0.0
|
|
37678
38185
|
*/
|
|
37679
38186
|
|
|
37680
38187
|
/**
|
|
@@ -38703,7 +39210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38703
39210
|
/**
|
|
38704
39211
|
* License service.
|
|
38705
39212
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
38706
|
-
* @version
|
|
39213
|
+
* @version 207.0.0
|
|
38707
39214
|
*/
|
|
38708
39215
|
|
|
38709
39216
|
/**
|
|
@@ -38941,7 +39448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38941
39448
|
/**
|
|
38942
39449
|
* Locations service.
|
|
38943
39450
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
38944
|
-
* @version
|
|
39451
|
+
* @version 207.0.0
|
|
38945
39452
|
*/
|
|
38946
39453
|
|
|
38947
39454
|
/**
|
|
@@ -39177,7 +39684,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39177
39684
|
/**
|
|
39178
39685
|
* LogCapture service.
|
|
39179
39686
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39180
|
-
* @version
|
|
39687
|
+
* @version 207.0.0
|
|
39181
39688
|
*/
|
|
39182
39689
|
|
|
39183
39690
|
/**
|
|
@@ -39377,7 +39884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39377
39884
|
/**
|
|
39378
39885
|
* Messaging service.
|
|
39379
39886
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
39380
|
-
* @version
|
|
39887
|
+
* @version 207.0.0
|
|
39381
39888
|
*/
|
|
39382
39889
|
|
|
39383
39890
|
/**
|
|
@@ -39736,7 +40243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39736
40243
|
/**
|
|
39737
40244
|
* MobileDevices service.
|
|
39738
40245
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
39739
|
-
* @version
|
|
40246
|
+
* @version 207.0.0
|
|
39740
40247
|
*/
|
|
39741
40248
|
|
|
39742
40249
|
/**
|
|
@@ -39887,7 +40394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39887
40394
|
/**
|
|
39888
40395
|
* Notifications service.
|
|
39889
40396
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
39890
|
-
* @version
|
|
40397
|
+
* @version 207.0.0
|
|
39891
40398
|
*/
|
|
39892
40399
|
|
|
39893
40400
|
/**
|
|
@@ -40120,7 +40627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40120
40627
|
/**
|
|
40121
40628
|
* OAuth service.
|
|
40122
40629
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40123
|
-
* @version
|
|
40630
|
+
* @version 207.0.0
|
|
40124
40631
|
*/
|
|
40125
40632
|
|
|
40126
40633
|
/**
|
|
@@ -40486,7 +40993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40486
40993
|
/**
|
|
40487
40994
|
* Objects service.
|
|
40488
40995
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
40489
|
-
* @version
|
|
40996
|
+
* @version 207.0.0
|
|
40490
40997
|
*/
|
|
40491
40998
|
|
|
40492
40999
|
/**
|
|
@@ -40756,7 +41263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40756
41263
|
/**
|
|
40757
41264
|
* OperationalEvents service.
|
|
40758
41265
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
40759
|
-
* @version
|
|
41266
|
+
* @version 207.0.0
|
|
40760
41267
|
*/
|
|
40761
41268
|
|
|
40762
41269
|
/**
|
|
@@ -40822,7 +41329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40822
41329
|
/**
|
|
40823
41330
|
* Organization service.
|
|
40824
41331
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
40825
|
-
* @version
|
|
41332
|
+
* @version 207.0.0
|
|
40826
41333
|
*/
|
|
40827
41334
|
|
|
40828
41335
|
/**
|
|
@@ -41364,7 +41871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41364
41871
|
/**
|
|
41365
41872
|
* OrganizationAuthorization service.
|
|
41366
41873
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
41367
|
-
* @version
|
|
41874
|
+
* @version 207.0.0
|
|
41368
41875
|
*/
|
|
41369
41876
|
|
|
41370
41877
|
/**
|
|
@@ -42001,6 +42508,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42001
42508
|
);
|
|
42002
42509
|
}
|
|
42003
42510
|
|
|
42511
|
+
/**
|
|
42512
|
+
* Get Customer Care organization ids.
|
|
42513
|
+
*
|
|
42514
|
+
*/
|
|
42515
|
+
getOrgauthorizationTrusteesCare() {
|
|
42516
|
+
|
|
42517
|
+
return this.apiClient.callApi(
|
|
42518
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
42519
|
+
'GET',
|
|
42520
|
+
{ },
|
|
42521
|
+
{ },
|
|
42522
|
+
{ },
|
|
42523
|
+
{ },
|
|
42524
|
+
null,
|
|
42525
|
+
['PureCloud OAuth'],
|
|
42526
|
+
['application/json'],
|
|
42527
|
+
['application/json']
|
|
42528
|
+
);
|
|
42529
|
+
}
|
|
42530
|
+
|
|
42004
42531
|
/**
|
|
42005
42532
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
42006
42533
|
*
|
|
@@ -42388,6 +42915,33 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42388
42915
|
);
|
|
42389
42916
|
}
|
|
42390
42917
|
|
|
42918
|
+
/**
|
|
42919
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
42920
|
+
*
|
|
42921
|
+
* @param {Object} opts Optional parameters
|
|
42922
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
42923
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
42924
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
42925
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
42926
|
+
*/
|
|
42927
|
+
postOrgauthorizationTrusteesCare(opts) {
|
|
42928
|
+
opts = opts || {};
|
|
42929
|
+
|
|
42930
|
+
|
|
42931
|
+
return this.apiClient.callApi(
|
|
42932
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
42933
|
+
'POST',
|
|
42934
|
+
{ },
|
|
42935
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'],'assignFullAccess': opts['assignFullAccess'],'allowTrustedUserAccess': opts['allowTrustedUserAccess'] },
|
|
42936
|
+
{ },
|
|
42937
|
+
{ },
|
|
42938
|
+
null,
|
|
42939
|
+
['PureCloud OAuth'],
|
|
42940
|
+
['application/json'],
|
|
42941
|
+
['application/json']
|
|
42942
|
+
);
|
|
42943
|
+
}
|
|
42944
|
+
|
|
42391
42945
|
/**
|
|
42392
42946
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
42393
42947
|
*
|
|
@@ -42711,7 +43265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42711
43265
|
/**
|
|
42712
43266
|
* Outbound service.
|
|
42713
43267
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
42714
|
-
* @version
|
|
43268
|
+
* @version 207.0.0
|
|
42715
43269
|
*/
|
|
42716
43270
|
|
|
42717
43271
|
/**
|
|
@@ -45688,6 +46242,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45688
46242
|
);
|
|
45689
46243
|
}
|
|
45690
46244
|
|
|
46245
|
+
/**
|
|
46246
|
+
* Start the campaign
|
|
46247
|
+
*
|
|
46248
|
+
* @param {String} campaignId Campaign ID
|
|
46249
|
+
*/
|
|
46250
|
+
postOutboundCampaignStart(campaignId) {
|
|
46251
|
+
// verify the required parameter 'campaignId' is set
|
|
46252
|
+
if (campaignId === undefined || campaignId === null) {
|
|
46253
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';
|
|
46254
|
+
}
|
|
46255
|
+
|
|
46256
|
+
return this.apiClient.callApi(
|
|
46257
|
+
'/api/v2/outbound/campaigns/{campaignId}/start',
|
|
46258
|
+
'POST',
|
|
46259
|
+
{ 'campaignId': campaignId },
|
|
46260
|
+
{ },
|
|
46261
|
+
{ },
|
|
46262
|
+
{ },
|
|
46263
|
+
null,
|
|
46264
|
+
['PureCloud OAuth'],
|
|
46265
|
+
['application/json'],
|
|
46266
|
+
['application/json']
|
|
46267
|
+
);
|
|
46268
|
+
}
|
|
46269
|
+
|
|
46270
|
+
/**
|
|
46271
|
+
* Stop the campaign
|
|
46272
|
+
*
|
|
46273
|
+
* @param {String} campaignId Campaign ID
|
|
46274
|
+
*/
|
|
46275
|
+
postOutboundCampaignStop(campaignId) {
|
|
46276
|
+
// verify the required parameter 'campaignId' is set
|
|
46277
|
+
if (campaignId === undefined || campaignId === null) {
|
|
46278
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';
|
|
46279
|
+
}
|
|
46280
|
+
|
|
46281
|
+
return this.apiClient.callApi(
|
|
46282
|
+
'/api/v2/outbound/campaigns/{campaignId}/stop',
|
|
46283
|
+
'POST',
|
|
46284
|
+
{ 'campaignId': campaignId },
|
|
46285
|
+
{ },
|
|
46286
|
+
{ },
|
|
46287
|
+
{ },
|
|
46288
|
+
null,
|
|
46289
|
+
['PureCloud OAuth'],
|
|
46290
|
+
['application/json'],
|
|
46291
|
+
['application/json']
|
|
46292
|
+
);
|
|
46293
|
+
}
|
|
46294
|
+
|
|
45691
46295
|
/**
|
|
45692
46296
|
* Create Campaign Rule
|
|
45693
46297
|
*
|
|
@@ -46387,6 +46991,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46387
46991
|
);
|
|
46388
46992
|
}
|
|
46389
46993
|
|
|
46994
|
+
/**
|
|
46995
|
+
* Start the campaign
|
|
46996
|
+
* Documented permissions are applicable based on campaign type.
|
|
46997
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
46998
|
+
*/
|
|
46999
|
+
postOutboundMessagingcampaignStart(messagingCampaignId) {
|
|
47000
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
47001
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
47002
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';
|
|
47003
|
+
}
|
|
47004
|
+
|
|
47005
|
+
return this.apiClient.callApi(
|
|
47006
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start',
|
|
47007
|
+
'POST',
|
|
47008
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
47009
|
+
{ },
|
|
47010
|
+
{ },
|
|
47011
|
+
{ },
|
|
47012
|
+
null,
|
|
47013
|
+
['PureCloud OAuth'],
|
|
47014
|
+
['application/json'],
|
|
47015
|
+
['application/json']
|
|
47016
|
+
);
|
|
47017
|
+
}
|
|
47018
|
+
|
|
47019
|
+
/**
|
|
47020
|
+
* Stop the campaign
|
|
47021
|
+
* Documented permissions are applicable based on campaign type.
|
|
47022
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
47023
|
+
*/
|
|
47024
|
+
postOutboundMessagingcampaignStop(messagingCampaignId) {
|
|
47025
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
47026
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
47027
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';
|
|
47028
|
+
}
|
|
47029
|
+
|
|
47030
|
+
return this.apiClient.callApi(
|
|
47031
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop',
|
|
47032
|
+
'POST',
|
|
47033
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
47034
|
+
{ },
|
|
47035
|
+
{ },
|
|
47036
|
+
{ },
|
|
47037
|
+
null,
|
|
47038
|
+
['PureCloud OAuth'],
|
|
47039
|
+
['application/json'],
|
|
47040
|
+
['application/json']
|
|
47041
|
+
);
|
|
47042
|
+
}
|
|
47043
|
+
|
|
46390
47044
|
/**
|
|
46391
47045
|
* Create a Messaging Campaign
|
|
46392
47046
|
*
|
|
@@ -47158,7 +47812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47158
47812
|
/**
|
|
47159
47813
|
* Presence service.
|
|
47160
47814
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47161
|
-
* @version
|
|
47815
|
+
* @version 207.0.0
|
|
47162
47816
|
*/
|
|
47163
47817
|
|
|
47164
47818
|
/**
|
|
@@ -47902,7 +48556,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47902
48556
|
/**
|
|
47903
48557
|
* ProcessAutomation service.
|
|
47904
48558
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
47905
|
-
* @version
|
|
48559
|
+
* @version 207.0.0
|
|
47906
48560
|
*/
|
|
47907
48561
|
|
|
47908
48562
|
/**
|
|
@@ -48141,7 +48795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48141
48795
|
/**
|
|
48142
48796
|
* Quality service.
|
|
48143
48797
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48144
|
-
* @version
|
|
48798
|
+
* @version 207.0.0
|
|
48145
48799
|
*/
|
|
48146
48800
|
|
|
48147
48801
|
/**
|
|
@@ -49927,7 +50581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49927
50581
|
/**
|
|
49928
50582
|
* Recording service.
|
|
49929
50583
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
49930
|
-
* @version
|
|
50584
|
+
* @version 207.0.0
|
|
49931
50585
|
*/
|
|
49932
50586
|
|
|
49933
50587
|
/**
|
|
@@ -51586,7 +52240,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51586
52240
|
/**
|
|
51587
52241
|
* ResponseManagement service.
|
|
51588
52242
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
51589
|
-
* @version
|
|
52243
|
+
* @version 207.0.0
|
|
51590
52244
|
*/
|
|
51591
52245
|
|
|
51592
52246
|
/**
|
|
@@ -52096,7 +52750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52096
52750
|
/**
|
|
52097
52751
|
* Routing service.
|
|
52098
52752
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52099
|
-
* @version
|
|
52753
|
+
* @version 207.0.0
|
|
52100
52754
|
*/
|
|
52101
52755
|
|
|
52102
52756
|
/**
|
|
@@ -56244,7 +56898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56244
56898
|
/**
|
|
56245
56899
|
* SCIM service.
|
|
56246
56900
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56247
|
-
* @version
|
|
56901
|
+
* @version 207.0.0
|
|
56248
56902
|
*/
|
|
56249
56903
|
|
|
56250
56904
|
/**
|
|
@@ -57121,7 +57775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57121
57775
|
/**
|
|
57122
57776
|
* ScreenRecording service.
|
|
57123
57777
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57124
|
-
* @version
|
|
57778
|
+
* @version 207.0.0
|
|
57125
57779
|
*/
|
|
57126
57780
|
|
|
57127
57781
|
/**
|
|
@@ -57166,7 +57820,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57166
57820
|
/**
|
|
57167
57821
|
* Scripts service.
|
|
57168
57822
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57169
|
-
* @version
|
|
57823
|
+
* @version 207.0.0
|
|
57170
57824
|
*/
|
|
57171
57825
|
|
|
57172
57826
|
/**
|
|
@@ -57610,7 +58264,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57610
58264
|
/**
|
|
57611
58265
|
* Search service.
|
|
57612
58266
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
57613
|
-
* @version
|
|
58267
|
+
* @version 207.0.0
|
|
57614
58268
|
*/
|
|
57615
58269
|
|
|
57616
58270
|
/**
|
|
@@ -58299,7 +58953,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58299
58953
|
/**
|
|
58300
58954
|
* Settings service.
|
|
58301
58955
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
58302
|
-
* @version
|
|
58956
|
+
* @version 207.0.0
|
|
58303
58957
|
*/
|
|
58304
58958
|
|
|
58305
58959
|
/**
|
|
@@ -58519,7 +59173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58519
59173
|
/**
|
|
58520
59174
|
* SpeechTextAnalytics service.
|
|
58521
59175
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
58522
|
-
* @version
|
|
59176
|
+
* @version 207.0.0
|
|
58523
59177
|
*/
|
|
58524
59178
|
|
|
58525
59179
|
/**
|
|
@@ -59854,7 +60508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59854
60508
|
/**
|
|
59855
60509
|
* Stations service.
|
|
59856
60510
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
59857
|
-
* @version
|
|
60511
|
+
* @version 207.0.0
|
|
59858
60512
|
*/
|
|
59859
60513
|
|
|
59860
60514
|
/**
|
|
@@ -59956,7 +60610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59956
60610
|
/**
|
|
59957
60611
|
* Suggest service.
|
|
59958
60612
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
59959
|
-
* @version
|
|
60613
|
+
* @version 207.0.0
|
|
59960
60614
|
*/
|
|
59961
60615
|
|
|
59962
60616
|
/**
|
|
@@ -60095,7 +60749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60095
60749
|
/**
|
|
60096
60750
|
* TaskManagement service.
|
|
60097
60751
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60098
|
-
* @version
|
|
60752
|
+
* @version 207.0.0
|
|
60099
60753
|
*/
|
|
60100
60754
|
|
|
60101
60755
|
/**
|
|
@@ -60210,6 +60864,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60210
60864
|
);
|
|
60211
60865
|
}
|
|
60212
60866
|
|
|
60867
|
+
/**
|
|
60868
|
+
* Delete a rule
|
|
60869
|
+
*
|
|
60870
|
+
* @param {String} worktypeId Worktype id
|
|
60871
|
+
* @param {String} ruleId ruleId
|
|
60872
|
+
*/
|
|
60873
|
+
deleteTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId, ruleId) {
|
|
60874
|
+
// verify the required parameter 'worktypeId' is set
|
|
60875
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
60876
|
+
throw 'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
60877
|
+
}
|
|
60878
|
+
// verify the required parameter 'ruleId' is set
|
|
60879
|
+
if (ruleId === undefined || ruleId === null) {
|
|
60880
|
+
throw 'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
60881
|
+
}
|
|
60882
|
+
|
|
60883
|
+
return this.apiClient.callApi(
|
|
60884
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}',
|
|
60885
|
+
'DELETE',
|
|
60886
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
60887
|
+
{ },
|
|
60888
|
+
{ },
|
|
60889
|
+
{ },
|
|
60890
|
+
null,
|
|
60891
|
+
['PureCloud OAuth'],
|
|
60892
|
+
['application/json'],
|
|
60893
|
+
['application/json']
|
|
60894
|
+
);
|
|
60895
|
+
}
|
|
60896
|
+
|
|
60897
|
+
/**
|
|
60898
|
+
* Delete a rule
|
|
60899
|
+
*
|
|
60900
|
+
* @param {String} worktypeId Worktype id
|
|
60901
|
+
* @param {String} ruleId ruleId
|
|
60902
|
+
*/
|
|
60903
|
+
deleteTaskmanagementWorktypeFlowsOncreateRule(worktypeId, ruleId) {
|
|
60904
|
+
// verify the required parameter 'worktypeId' is set
|
|
60905
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
60906
|
+
throw 'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';
|
|
60907
|
+
}
|
|
60908
|
+
// verify the required parameter 'ruleId' is set
|
|
60909
|
+
if (ruleId === undefined || ruleId === null) {
|
|
60910
|
+
throw 'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';
|
|
60911
|
+
}
|
|
60912
|
+
|
|
60913
|
+
return this.apiClient.callApi(
|
|
60914
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}',
|
|
60915
|
+
'DELETE',
|
|
60916
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
60917
|
+
{ },
|
|
60918
|
+
{ },
|
|
60919
|
+
{ },
|
|
60920
|
+
null,
|
|
60921
|
+
['PureCloud OAuth'],
|
|
60922
|
+
['application/json'],
|
|
60923
|
+
['application/json']
|
|
60924
|
+
);
|
|
60925
|
+
}
|
|
60926
|
+
|
|
60213
60927
|
/**
|
|
60214
60928
|
* Delete a status
|
|
60215
60929
|
*
|
|
@@ -60732,6 +61446,126 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60732
61446
|
);
|
|
60733
61447
|
}
|
|
60734
61448
|
|
|
61449
|
+
/**
|
|
61450
|
+
* Get an attribute change rule
|
|
61451
|
+
*
|
|
61452
|
+
* @param {String} worktypeId Worktype id
|
|
61453
|
+
* @param {String} ruleId ruleId
|
|
61454
|
+
*/
|
|
61455
|
+
getTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId, ruleId) {
|
|
61456
|
+
// verify the required parameter 'worktypeId' is set
|
|
61457
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61458
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61459
|
+
}
|
|
61460
|
+
// verify the required parameter 'ruleId' is set
|
|
61461
|
+
if (ruleId === undefined || ruleId === null) {
|
|
61462
|
+
throw 'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61463
|
+
}
|
|
61464
|
+
|
|
61465
|
+
return this.apiClient.callApi(
|
|
61466
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}',
|
|
61467
|
+
'GET',
|
|
61468
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
61469
|
+
{ },
|
|
61470
|
+
{ },
|
|
61471
|
+
{ },
|
|
61472
|
+
null,
|
|
61473
|
+
['PureCloud OAuth'],
|
|
61474
|
+
['application/json'],
|
|
61475
|
+
['application/json']
|
|
61476
|
+
);
|
|
61477
|
+
}
|
|
61478
|
+
|
|
61479
|
+
/**
|
|
61480
|
+
* Get all attribute-change rules for a worktype
|
|
61481
|
+
*
|
|
61482
|
+
* @param {String} worktypeId Worktype id
|
|
61483
|
+
* @param {Object} opts Optional parameters
|
|
61484
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
61485
|
+
* @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)
|
|
61486
|
+
*/
|
|
61487
|
+
getTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId, opts) {
|
|
61488
|
+
opts = opts || {};
|
|
61489
|
+
|
|
61490
|
+
// verify the required parameter 'worktypeId' is set
|
|
61491
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61492
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRules';
|
|
61493
|
+
}
|
|
61494
|
+
|
|
61495
|
+
return this.apiClient.callApi(
|
|
61496
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules',
|
|
61497
|
+
'GET',
|
|
61498
|
+
{ 'worktypeId': worktypeId },
|
|
61499
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
61500
|
+
{ },
|
|
61501
|
+
{ },
|
|
61502
|
+
null,
|
|
61503
|
+
['PureCloud OAuth'],
|
|
61504
|
+
['application/json'],
|
|
61505
|
+
['application/json']
|
|
61506
|
+
);
|
|
61507
|
+
}
|
|
61508
|
+
|
|
61509
|
+
/**
|
|
61510
|
+
* Get an on-create rule
|
|
61511
|
+
*
|
|
61512
|
+
* @param {String} worktypeId Worktype id
|
|
61513
|
+
* @param {String} ruleId ruleId
|
|
61514
|
+
*/
|
|
61515
|
+
getTaskmanagementWorktypeFlowsOncreateRule(worktypeId, ruleId) {
|
|
61516
|
+
// verify the required parameter 'worktypeId' is set
|
|
61517
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61518
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRule';
|
|
61519
|
+
}
|
|
61520
|
+
// verify the required parameter 'ruleId' is set
|
|
61521
|
+
if (ruleId === undefined || ruleId === null) {
|
|
61522
|
+
throw 'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsOncreateRule';
|
|
61523
|
+
}
|
|
61524
|
+
|
|
61525
|
+
return this.apiClient.callApi(
|
|
61526
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}',
|
|
61527
|
+
'GET',
|
|
61528
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
61529
|
+
{ },
|
|
61530
|
+
{ },
|
|
61531
|
+
{ },
|
|
61532
|
+
null,
|
|
61533
|
+
['PureCloud OAuth'],
|
|
61534
|
+
['application/json'],
|
|
61535
|
+
['application/json']
|
|
61536
|
+
);
|
|
61537
|
+
}
|
|
61538
|
+
|
|
61539
|
+
/**
|
|
61540
|
+
* Get all on-create rules for a worktype
|
|
61541
|
+
*
|
|
61542
|
+
* @param {String} worktypeId Worktype id
|
|
61543
|
+
* @param {Object} opts Optional parameters
|
|
61544
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
61545
|
+
* @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)
|
|
61546
|
+
*/
|
|
61547
|
+
getTaskmanagementWorktypeFlowsOncreateRules(worktypeId, opts) {
|
|
61548
|
+
opts = opts || {};
|
|
61549
|
+
|
|
61550
|
+
// verify the required parameter 'worktypeId' is set
|
|
61551
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61552
|
+
throw 'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRules';
|
|
61553
|
+
}
|
|
61554
|
+
|
|
61555
|
+
return this.apiClient.callApi(
|
|
61556
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules',
|
|
61557
|
+
'GET',
|
|
61558
|
+
{ 'worktypeId': worktypeId },
|
|
61559
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
61560
|
+
{ },
|
|
61561
|
+
{ },
|
|
61562
|
+
null,
|
|
61563
|
+
['PureCloud OAuth'],
|
|
61564
|
+
['application/json'],
|
|
61565
|
+
['application/json']
|
|
61566
|
+
);
|
|
61567
|
+
}
|
|
61568
|
+
|
|
60735
61569
|
/**
|
|
60736
61570
|
* Get a listing of a worktype's attribute change history
|
|
60737
61571
|
*
|
|
@@ -61068,6 +61902,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61068
61902
|
);
|
|
61069
61903
|
}
|
|
61070
61904
|
|
|
61905
|
+
/**
|
|
61906
|
+
* Update the attributes of a rule
|
|
61907
|
+
*
|
|
61908
|
+
* @param {String} worktypeId Worktype id
|
|
61909
|
+
* @param {String} ruleId ruleId
|
|
61910
|
+
* @param {Object} body Rule
|
|
61911
|
+
*/
|
|
61912
|
+
patchTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId, ruleId, body) {
|
|
61913
|
+
// verify the required parameter 'worktypeId' is set
|
|
61914
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61915
|
+
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61916
|
+
}
|
|
61917
|
+
// verify the required parameter 'ruleId' is set
|
|
61918
|
+
if (ruleId === undefined || ruleId === null) {
|
|
61919
|
+
throw 'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61920
|
+
}
|
|
61921
|
+
// verify the required parameter 'body' is set
|
|
61922
|
+
if (body === undefined || body === null) {
|
|
61923
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';
|
|
61924
|
+
}
|
|
61925
|
+
|
|
61926
|
+
return this.apiClient.callApi(
|
|
61927
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}',
|
|
61928
|
+
'PATCH',
|
|
61929
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
61930
|
+
{ },
|
|
61931
|
+
{ },
|
|
61932
|
+
{ },
|
|
61933
|
+
body,
|
|
61934
|
+
['PureCloud OAuth'],
|
|
61935
|
+
['application/json'],
|
|
61936
|
+
['application/json']
|
|
61937
|
+
);
|
|
61938
|
+
}
|
|
61939
|
+
|
|
61940
|
+
/**
|
|
61941
|
+
* Update the attributes of a rule
|
|
61942
|
+
*
|
|
61943
|
+
* @param {String} worktypeId Worktype id
|
|
61944
|
+
* @param {String} ruleId ruleId
|
|
61945
|
+
* @param {Object} body Rule
|
|
61946
|
+
*/
|
|
61947
|
+
patchTaskmanagementWorktypeFlowsOncreateRule(worktypeId, ruleId, body) {
|
|
61948
|
+
// verify the required parameter 'worktypeId' is set
|
|
61949
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
61950
|
+
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';
|
|
61951
|
+
}
|
|
61952
|
+
// verify the required parameter 'ruleId' is set
|
|
61953
|
+
if (ruleId === undefined || ruleId === null) {
|
|
61954
|
+
throw 'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';
|
|
61955
|
+
}
|
|
61956
|
+
// verify the required parameter 'body' is set
|
|
61957
|
+
if (body === undefined || body === null) {
|
|
61958
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsOncreateRule';
|
|
61959
|
+
}
|
|
61960
|
+
|
|
61961
|
+
return this.apiClient.callApi(
|
|
61962
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}',
|
|
61963
|
+
'PATCH',
|
|
61964
|
+
{ 'worktypeId': worktypeId,'ruleId': ruleId },
|
|
61965
|
+
{ },
|
|
61966
|
+
{ },
|
|
61967
|
+
{ },
|
|
61968
|
+
body,
|
|
61969
|
+
['PureCloud OAuth'],
|
|
61970
|
+
['application/json'],
|
|
61971
|
+
['application/json']
|
|
61972
|
+
);
|
|
61973
|
+
}
|
|
61974
|
+
|
|
61071
61975
|
/**
|
|
61072
61976
|
* Update the attributes of a status
|
|
61073
61977
|
*
|
|
@@ -61333,6 +62237,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61333
62237
|
);
|
|
61334
62238
|
}
|
|
61335
62239
|
|
|
62240
|
+
/**
|
|
62241
|
+
* Add an attribute-change rule to a worktype
|
|
62242
|
+
*
|
|
62243
|
+
* @param {String} worktypeId Worktype id
|
|
62244
|
+
* @param {Object} body Rule
|
|
62245
|
+
*/
|
|
62246
|
+
postTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId, body) {
|
|
62247
|
+
// verify the required parameter 'worktypeId' is set
|
|
62248
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
62249
|
+
throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';
|
|
62250
|
+
}
|
|
62251
|
+
// verify the required parameter 'body' is set
|
|
62252
|
+
if (body === undefined || body === null) {
|
|
62253
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';
|
|
62254
|
+
}
|
|
62255
|
+
|
|
62256
|
+
return this.apiClient.callApi(
|
|
62257
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules',
|
|
62258
|
+
'POST',
|
|
62259
|
+
{ 'worktypeId': worktypeId },
|
|
62260
|
+
{ },
|
|
62261
|
+
{ },
|
|
62262
|
+
{ },
|
|
62263
|
+
body,
|
|
62264
|
+
['PureCloud OAuth'],
|
|
62265
|
+
['application/json'],
|
|
62266
|
+
['application/json']
|
|
62267
|
+
);
|
|
62268
|
+
}
|
|
62269
|
+
|
|
62270
|
+
/**
|
|
62271
|
+
* Add an on-create rule to a worktype
|
|
62272
|
+
*
|
|
62273
|
+
* @param {String} worktypeId Worktype id
|
|
62274
|
+
* @param {Object} body Rule
|
|
62275
|
+
*/
|
|
62276
|
+
postTaskmanagementWorktypeFlowsOncreateRules(worktypeId, body) {
|
|
62277
|
+
// verify the required parameter 'worktypeId' is set
|
|
62278
|
+
if (worktypeId === undefined || worktypeId === null) {
|
|
62279
|
+
throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOncreateRules';
|
|
62280
|
+
}
|
|
62281
|
+
// verify the required parameter 'body' is set
|
|
62282
|
+
if (body === undefined || body === null) {
|
|
62283
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsOncreateRules';
|
|
62284
|
+
}
|
|
62285
|
+
|
|
62286
|
+
return this.apiClient.callApi(
|
|
62287
|
+
'/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules',
|
|
62288
|
+
'POST',
|
|
62289
|
+
{ 'worktypeId': worktypeId },
|
|
62290
|
+
{ },
|
|
62291
|
+
{ },
|
|
62292
|
+
{ },
|
|
62293
|
+
body,
|
|
62294
|
+
['PureCloud OAuth'],
|
|
62295
|
+
['application/json'],
|
|
62296
|
+
['application/json']
|
|
62297
|
+
);
|
|
62298
|
+
}
|
|
62299
|
+
|
|
61336
62300
|
/**
|
|
61337
62301
|
* Add a status to a worktype
|
|
61338
62302
|
*
|
|
@@ -61449,7 +62413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61449
62413
|
/**
|
|
61450
62414
|
* Teams service.
|
|
61451
62415
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
61452
|
-
* @version
|
|
62416
|
+
* @version 207.0.0
|
|
61453
62417
|
*/
|
|
61454
62418
|
|
|
61455
62419
|
/**
|
|
@@ -61523,8 +62487,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61523
62487
|
* Get team
|
|
61524
62488
|
*
|
|
61525
62489
|
* @param {String} teamId Team ID
|
|
62490
|
+
* @param {Object} opts Optional parameters
|
|
62491
|
+
* @param {Object} opts.expand Expand the division name
|
|
61526
62492
|
*/
|
|
61527
|
-
getTeam(teamId) {
|
|
62493
|
+
getTeam(teamId, opts) {
|
|
62494
|
+
opts = opts || {};
|
|
62495
|
+
|
|
61528
62496
|
// verify the required parameter 'teamId' is set
|
|
61529
62497
|
if (teamId === undefined || teamId === null) {
|
|
61530
62498
|
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
@@ -61534,7 +62502,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61534
62502
|
'/api/v2/teams/{teamId}',
|
|
61535
62503
|
'GET',
|
|
61536
62504
|
{ 'teamId': teamId },
|
|
61537
|
-
{
|
|
62505
|
+
{ 'expand': opts['expand'] },
|
|
61538
62506
|
{ },
|
|
61539
62507
|
{ },
|
|
61540
62508
|
null,
|
|
@@ -61750,7 +62718,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61750
62718
|
/**
|
|
61751
62719
|
* Telephony service.
|
|
61752
62720
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
61753
|
-
* @version
|
|
62721
|
+
* @version 207.0.0
|
|
61754
62722
|
*/
|
|
61755
62723
|
|
|
61756
62724
|
/**
|
|
@@ -61932,7 +62900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61932
62900
|
/**
|
|
61933
62901
|
* TelephonyProvidersEdge service.
|
|
61934
62902
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
61935
|
-
* @version
|
|
62903
|
+
* @version 207.0.0
|
|
61936
62904
|
*/
|
|
61937
62905
|
|
|
61938
62906
|
/**
|
|
@@ -65329,7 +66297,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65329
66297
|
/**
|
|
65330
66298
|
* Textbots service.
|
|
65331
66299
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
65332
|
-
* @version
|
|
66300
|
+
* @version 207.0.0
|
|
65333
66301
|
*/
|
|
65334
66302
|
|
|
65335
66303
|
/**
|
|
@@ -65457,7 +66425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65457
66425
|
/**
|
|
65458
66426
|
* Tokens service.
|
|
65459
66427
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
65460
|
-
* @version
|
|
66428
|
+
* @version 207.0.0
|
|
65461
66429
|
*/
|
|
65462
66430
|
|
|
65463
66431
|
/**
|
|
@@ -65611,7 +66579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65611
66579
|
/**
|
|
65612
66580
|
* Uploads service.
|
|
65613
66581
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
65614
|
-
* @version
|
|
66582
|
+
* @version 207.0.0
|
|
65615
66583
|
*/
|
|
65616
66584
|
|
|
65617
66585
|
/**
|
|
@@ -65880,7 +66848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65880
66848
|
/**
|
|
65881
66849
|
* Usage service.
|
|
65882
66850
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
65883
|
-
* @version
|
|
66851
|
+
* @version 207.0.0
|
|
65884
66852
|
*/
|
|
65885
66853
|
|
|
65886
66854
|
/**
|
|
@@ -66095,7 +67063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66095
67063
|
/**
|
|
66096
67064
|
* UserRecordings service.
|
|
66097
67065
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
66098
|
-
* @version
|
|
67066
|
+
* @version 207.0.0
|
|
66099
67067
|
*/
|
|
66100
67068
|
|
|
66101
67069
|
/**
|
|
@@ -66310,7 +67278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66310
67278
|
/**
|
|
66311
67279
|
* Users service.
|
|
66312
67280
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
66313
|
-
* @version
|
|
67281
|
+
* @version 207.0.0
|
|
66314
67282
|
*/
|
|
66315
67283
|
|
|
66316
67284
|
/**
|
|
@@ -67625,6 +68593,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67625
68593
|
);
|
|
67626
68594
|
}
|
|
67627
68595
|
|
|
68596
|
+
/**
|
|
68597
|
+
* Get chats for a user
|
|
68598
|
+
*
|
|
68599
|
+
* @param {Object} opts Optional parameters
|
|
68600
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
68601
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
68602
|
+
* @param {String} opts.after The key to start after
|
|
68603
|
+
*/
|
|
68604
|
+
getUsersChatsMe(opts) {
|
|
68605
|
+
opts = opts || {};
|
|
68606
|
+
|
|
68607
|
+
|
|
68608
|
+
return this.apiClient.callApi(
|
|
68609
|
+
'/api/v2/users/chats/me',
|
|
68610
|
+
'GET',
|
|
68611
|
+
{ },
|
|
68612
|
+
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
|
|
68613
|
+
{ },
|
|
68614
|
+
{ },
|
|
68615
|
+
null,
|
|
68616
|
+
['PureCloud OAuth'],
|
|
68617
|
+
['application/json'],
|
|
68618
|
+
['application/json']
|
|
68619
|
+
);
|
|
68620
|
+
}
|
|
68621
|
+
|
|
67628
68622
|
/**
|
|
67629
68623
|
* Get list of Development Activities
|
|
67630
68624
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
@@ -69113,7 +70107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69113
70107
|
/**
|
|
69114
70108
|
* Utilities service.
|
|
69115
70109
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
69116
|
-
* @version
|
|
70110
|
+
* @version 207.0.0
|
|
69117
70111
|
*/
|
|
69118
70112
|
|
|
69119
70113
|
/**
|
|
@@ -69224,7 +70218,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69224
70218
|
/**
|
|
69225
70219
|
* Voicemail service.
|
|
69226
70220
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
69227
|
-
* @version
|
|
70221
|
+
* @version 207.0.0
|
|
69228
70222
|
*/
|
|
69229
70223
|
|
|
69230
70224
|
/**
|
|
@@ -69611,6 +70605,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69611
70605
|
);
|
|
69612
70606
|
}
|
|
69613
70607
|
|
|
70608
|
+
/**
|
|
70609
|
+
* Get a user's mailbox information
|
|
70610
|
+
*
|
|
70611
|
+
* @param {String} userId userId
|
|
70612
|
+
*/
|
|
70613
|
+
getVoicemailUserMailbox(userId) {
|
|
70614
|
+
// verify the required parameter 'userId' is set
|
|
70615
|
+
if (userId === undefined || userId === null) {
|
|
70616
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMailbox';
|
|
70617
|
+
}
|
|
70618
|
+
|
|
70619
|
+
return this.apiClient.callApi(
|
|
70620
|
+
'/api/v2/voicemail/users/{userId}/mailbox',
|
|
70621
|
+
'GET',
|
|
70622
|
+
{ 'userId': userId },
|
|
70623
|
+
{ },
|
|
70624
|
+
{ },
|
|
70625
|
+
{ },
|
|
70626
|
+
null,
|
|
70627
|
+
['PureCloud OAuth'],
|
|
70628
|
+
['application/json'],
|
|
70629
|
+
['application/json']
|
|
70630
|
+
);
|
|
70631
|
+
}
|
|
70632
|
+
|
|
70633
|
+
/**
|
|
70634
|
+
* List voicemail messages
|
|
70635
|
+
*
|
|
70636
|
+
* @param {String} userId User ID
|
|
70637
|
+
* @param {Object} opts Optional parameters
|
|
70638
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
70639
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
70640
|
+
*/
|
|
70641
|
+
getVoicemailUserMessages(userId, opts) {
|
|
70642
|
+
opts = opts || {};
|
|
70643
|
+
|
|
70644
|
+
// verify the required parameter 'userId' is set
|
|
70645
|
+
if (userId === undefined || userId === null) {
|
|
70646
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMessages';
|
|
70647
|
+
}
|
|
70648
|
+
|
|
70649
|
+
return this.apiClient.callApi(
|
|
70650
|
+
'/api/v2/voicemail/users/{userId}/messages',
|
|
70651
|
+
'GET',
|
|
70652
|
+
{ 'userId': userId },
|
|
70653
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
70654
|
+
{ },
|
|
70655
|
+
{ },
|
|
70656
|
+
null,
|
|
70657
|
+
['PureCloud OAuth'],
|
|
70658
|
+
['application/json'],
|
|
70659
|
+
['application/json']
|
|
70660
|
+
);
|
|
70661
|
+
}
|
|
70662
|
+
|
|
69614
70663
|
/**
|
|
69615
70664
|
* Get a user's voicemail policy
|
|
69616
70665
|
*
|
|
@@ -69891,7 +70940,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69891
70940
|
/**
|
|
69892
70941
|
* WebChat service.
|
|
69893
70942
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
69894
|
-
* @version
|
|
70943
|
+
* @version 207.0.0
|
|
69895
70944
|
*/
|
|
69896
70945
|
|
|
69897
70946
|
/**
|
|
@@ -70442,7 +71491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70442
71491
|
/**
|
|
70443
71492
|
* WebDeployments service.
|
|
70444
71493
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
70445
|
-
* @version
|
|
71494
|
+
* @version 207.0.0
|
|
70446
71495
|
*/
|
|
70447
71496
|
|
|
70448
71497
|
/**
|
|
@@ -70646,7 +71695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70646
71695
|
* View configuration drafts
|
|
70647
71696
|
*
|
|
70648
71697
|
* @param {Object} opts Optional parameters
|
|
70649
|
-
* @param {Boolean} opts.showOnlyPublished
|
|
71698
|
+
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
70650
71699
|
*/
|
|
70651
71700
|
getWebdeploymentsConfigurations(opts) {
|
|
70652
71701
|
opts = opts || {};
|
|
@@ -70969,7 +72018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70969
72018
|
/**
|
|
70970
72019
|
* WebMessaging service.
|
|
70971
72020
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
70972
|
-
* @version
|
|
72021
|
+
* @version 207.0.0
|
|
70973
72022
|
*/
|
|
70974
72023
|
|
|
70975
72024
|
/**
|
|
@@ -71015,7 +72064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71015
72064
|
/**
|
|
71016
72065
|
* Widgets service.
|
|
71017
72066
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
71018
|
-
* @version
|
|
72067
|
+
* @version 207.0.0
|
|
71019
72068
|
*/
|
|
71020
72069
|
|
|
71021
72070
|
/**
|
|
@@ -71161,7 +72210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71161
72210
|
/**
|
|
71162
72211
|
* WorkforceManagement service.
|
|
71163
72212
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
71164
|
-
* @version
|
|
72213
|
+
* @version 207.0.0
|
|
71165
72214
|
*/
|
|
71166
72215
|
|
|
71167
72216
|
/**
|
|
@@ -75244,6 +76293,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75244
76293
|
);
|
|
75245
76294
|
}
|
|
75246
76295
|
|
|
76296
|
+
/**
|
|
76297
|
+
* Updates agent work plan configuration
|
|
76298
|
+
*
|
|
76299
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
76300
|
+
* @param {Object} opts Optional parameters
|
|
76301
|
+
* @param {Object} opts.body body
|
|
76302
|
+
*/
|
|
76303
|
+
patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId, opts) {
|
|
76304
|
+
opts = opts || {};
|
|
76305
|
+
|
|
76306
|
+
// verify the required parameter 'managementUnitId' is set
|
|
76307
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
76308
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';
|
|
76309
|
+
}
|
|
76310
|
+
|
|
76311
|
+
return this.apiClient.callApi(
|
|
76312
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk',
|
|
76313
|
+
'PATCH',
|
|
76314
|
+
{ 'managementUnitId': managementUnitId },
|
|
76315
|
+
{ },
|
|
76316
|
+
{ },
|
|
76317
|
+
{ },
|
|
76318
|
+
opts['body'],
|
|
76319
|
+
['PureCloud OAuth'],
|
|
76320
|
+
['application/json'],
|
|
76321
|
+
['application/json']
|
|
76322
|
+
);
|
|
76323
|
+
}
|
|
76324
|
+
|
|
75247
76325
|
/**
|
|
75248
76326
|
* Updates a time off limit object.
|
|
75249
76327
|
* Updates time off limit object properties, but not daily values.
|
|
@@ -77164,6 +78242,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77164
78242
|
);
|
|
77165
78243
|
}
|
|
77166
78244
|
|
|
78245
|
+
/**
|
|
78246
|
+
* Get agents work plans configuration
|
|
78247
|
+
*
|
|
78248
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78249
|
+
* @param {Object} opts Optional parameters
|
|
78250
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
78251
|
+
* @param {Object} opts.body body
|
|
78252
|
+
*/
|
|
78253
|
+
postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId, opts) {
|
|
78254
|
+
opts = opts || {};
|
|
78255
|
+
|
|
78256
|
+
// verify the required parameter 'managementUnitId' is set
|
|
78257
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
78258
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';
|
|
78259
|
+
}
|
|
78260
|
+
|
|
78261
|
+
return this.apiClient.callApi(
|
|
78262
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query',
|
|
78263
|
+
'POST',
|
|
78264
|
+
{ 'managementUnitId': managementUnitId },
|
|
78265
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
78266
|
+
{ },
|
|
78267
|
+
{ },
|
|
78268
|
+
opts['body'],
|
|
78269
|
+
['PureCloud OAuth'],
|
|
78270
|
+
['application/json'],
|
|
78271
|
+
['application/json']
|
|
78272
|
+
);
|
|
78273
|
+
}
|
|
78274
|
+
|
|
77167
78275
|
/**
|
|
77168
78276
|
* Query published schedules for given given time range for set of users
|
|
77169
78277
|
*
|
|
@@ -78316,7 +79424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78316
79424
|
* </pre>
|
|
78317
79425
|
* </p>
|
|
78318
79426
|
* @module purecloud-platform-client-v2/index
|
|
78319
|
-
* @version
|
|
79427
|
+
* @version 207.0.0
|
|
78320
79428
|
*/
|
|
78321
79429
|
class platformClient {
|
|
78322
79430
|
constructor() {
|