purecloud-platform-client-v2 206.0.0 → 208.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +100 -3
- package/dist/node/purecloud-platform-client-v2.js +979 -173
- package/dist/web-amd/purecloud-platform-client-v2.js +979 -173
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +341 -176
- package/dist/web-cjs/purecloud-platform-client-v2.js +358 -179
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1646 -606
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +7 -6
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +234 -8
- 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 +31 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +136 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +5 -21
- 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 +12 -12
- 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 +55 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +55 -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 +38 -12
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -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 208.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 208.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 208.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 208.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 208.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 208.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 208.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 208.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 208.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 208.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 208.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 208.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 208.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 208.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 208.0.0
|
|
14035
14138
|
*/
|
|
14036
14139
|
|
|
14037
14140
|
/**
|
|
@@ -18724,9 +18827,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18724
18827
|
|
|
18725
18828
|
/**
|
|
18726
18829
|
* Suggestion feedback.
|
|
18727
|
-
*
|
|
18830
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
18728
18831
|
* @param {String} conversationId Conversation ID
|
|
18729
18832
|
* @param {Object} body SuggestionFeedback
|
|
18833
|
+
* @deprecated
|
|
18730
18834
|
*/
|
|
18731
18835
|
postConversationSuggestionsFeedback(conversationId, body) {
|
|
18732
18836
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21172,7 +21276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21172
21276
|
/**
|
|
21173
21277
|
* DataExtensions service.
|
|
21174
21278
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21175
|
-
* @version
|
|
21279
|
+
* @version 208.0.0
|
|
21176
21280
|
*/
|
|
21177
21281
|
|
|
21178
21282
|
/**
|
|
@@ -21258,7 +21362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21258
21362
|
/**
|
|
21259
21363
|
* Downloads service.
|
|
21260
21364
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21261
|
-
* @version
|
|
21365
|
+
* @version 208.0.0
|
|
21262
21366
|
*/
|
|
21263
21367
|
|
|
21264
21368
|
/**
|
|
@@ -21310,7 +21414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21310
21414
|
/**
|
|
21311
21415
|
* Emails service.
|
|
21312
21416
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21313
|
-
* @version
|
|
21417
|
+
* @version 208.0.0
|
|
21314
21418
|
*/
|
|
21315
21419
|
|
|
21316
21420
|
/**
|
|
@@ -21375,7 +21479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21375
21479
|
/**
|
|
21376
21480
|
* EmployeeEngagement service.
|
|
21377
21481
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21378
|
-
* @version
|
|
21482
|
+
* @version 208.0.0
|
|
21379
21483
|
*/
|
|
21380
21484
|
|
|
21381
21485
|
/**
|
|
@@ -21526,7 +21630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21526
21630
|
/**
|
|
21527
21631
|
* Events service.
|
|
21528
21632
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21529
|
-
* @version
|
|
21633
|
+
* @version 208.0.0
|
|
21530
21634
|
*/
|
|
21531
21635
|
|
|
21532
21636
|
/**
|
|
@@ -21622,7 +21726,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21622
21726
|
/**
|
|
21623
21727
|
* ExternalContacts service.
|
|
21624
21728
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21625
|
-
* @version
|
|
21729
|
+
* @version 208.0.0
|
|
21626
21730
|
*/
|
|
21627
21731
|
|
|
21628
21732
|
/**
|
|
@@ -21721,7 +21825,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21721
21825
|
* Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
|
|
21722
21826
|
*
|
|
21723
21827
|
* @param {String} externalSourceId External Source ID
|
|
21724
|
-
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21725
21828
|
*/
|
|
21726
21829
|
deleteExternalcontactsExternalsource(externalSourceId) {
|
|
21727
21830
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -21743,6 +21846,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21743
21846
|
);
|
|
21744
21847
|
}
|
|
21745
21848
|
|
|
21849
|
+
/**
|
|
21850
|
+
* Delete settings for CSV import
|
|
21851
|
+
*
|
|
21852
|
+
* @param {String} settingsId Settings id
|
|
21853
|
+
*/
|
|
21854
|
+
deleteExternalcontactsImportCsvSetting(settingsId) {
|
|
21855
|
+
// verify the required parameter 'settingsId' is set
|
|
21856
|
+
if (settingsId === undefined || settingsId === null) {
|
|
21857
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';
|
|
21858
|
+
}
|
|
21859
|
+
|
|
21860
|
+
return this.apiClient.callApi(
|
|
21861
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
21862
|
+
'DELETE',
|
|
21863
|
+
{ 'settingsId': settingsId },
|
|
21864
|
+
{ },
|
|
21865
|
+
{ },
|
|
21866
|
+
{ },
|
|
21867
|
+
null,
|
|
21868
|
+
['PureCloud OAuth'],
|
|
21869
|
+
['application/json'],
|
|
21870
|
+
['application/json']
|
|
21871
|
+
);
|
|
21872
|
+
}
|
|
21873
|
+
|
|
21746
21874
|
/**
|
|
21747
21875
|
* Delete an external organization
|
|
21748
21876
|
*
|
|
@@ -22004,7 +22132,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22004
22132
|
*
|
|
22005
22133
|
* @param {String} contactId ExternalContact ID
|
|
22006
22134
|
* @param {Object} opts Optional parameters
|
|
22007
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22135
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22008
22136
|
*/
|
|
22009
22137
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
22010
22138
|
opts = opts || {};
|
|
@@ -22160,7 +22288,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22160
22288
|
* Fetch an External Source
|
|
22161
22289
|
*
|
|
22162
22290
|
* @param {String} externalSourceId External Source ID
|
|
22163
|
-
* getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22164
22291
|
*/
|
|
22165
22292
|
getExternalcontactsExternalsource(externalSourceId) {
|
|
22166
22293
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -22190,7 +22317,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22190
22317
|
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
22191
22318
|
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
22192
22319
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
22193
|
-
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22194
22320
|
*/
|
|
22195
22321
|
getExternalcontactsExternalsources(opts) {
|
|
22196
22322
|
opts = opts || {};
|
|
@@ -22210,12 +22336,113 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22210
22336
|
);
|
|
22211
22337
|
}
|
|
22212
22338
|
|
|
22339
|
+
/**
|
|
22340
|
+
* Get settings for CSV import
|
|
22341
|
+
*
|
|
22342
|
+
* @param {String} settingsId Settings id
|
|
22343
|
+
*/
|
|
22344
|
+
getExternalcontactsImportCsvSetting(settingsId) {
|
|
22345
|
+
// verify the required parameter 'settingsId' is set
|
|
22346
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22347
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';
|
|
22348
|
+
}
|
|
22349
|
+
|
|
22350
|
+
return this.apiClient.callApi(
|
|
22351
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
22352
|
+
'GET',
|
|
22353
|
+
{ 'settingsId': settingsId },
|
|
22354
|
+
{ },
|
|
22355
|
+
{ },
|
|
22356
|
+
{ },
|
|
22357
|
+
null,
|
|
22358
|
+
['PureCloud OAuth'],
|
|
22359
|
+
['application/json'],
|
|
22360
|
+
['application/json']
|
|
22361
|
+
);
|
|
22362
|
+
}
|
|
22363
|
+
|
|
22364
|
+
/**
|
|
22365
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
22366
|
+
*
|
|
22367
|
+
* @param {Object} opts Optional parameters
|
|
22368
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22369
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22370
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
22371
|
+
*/
|
|
22372
|
+
getExternalcontactsImportCsvSettings(opts) {
|
|
22373
|
+
opts = opts || {};
|
|
22374
|
+
|
|
22375
|
+
|
|
22376
|
+
return this.apiClient.callApi(
|
|
22377
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
22378
|
+
'GET',
|
|
22379
|
+
{ },
|
|
22380
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'externalSettingsId': opts['externalSettingsId'] },
|
|
22381
|
+
{ },
|
|
22382
|
+
{ },
|
|
22383
|
+
null,
|
|
22384
|
+
['PureCloud OAuth'],
|
|
22385
|
+
['application/json'],
|
|
22386
|
+
['application/json']
|
|
22387
|
+
);
|
|
22388
|
+
}
|
|
22389
|
+
|
|
22390
|
+
/**
|
|
22391
|
+
* Get details for CSV upload
|
|
22392
|
+
*
|
|
22393
|
+
* @param {String} uploadId Upload id
|
|
22394
|
+
*/
|
|
22395
|
+
getExternalcontactsImportCsvUploadDetails(uploadId) {
|
|
22396
|
+
// verify the required parameter 'uploadId' is set
|
|
22397
|
+
if (uploadId === undefined || uploadId === null) {
|
|
22398
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';
|
|
22399
|
+
}
|
|
22400
|
+
|
|
22401
|
+
return this.apiClient.callApi(
|
|
22402
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details',
|
|
22403
|
+
'GET',
|
|
22404
|
+
{ 'uploadId': uploadId },
|
|
22405
|
+
{ },
|
|
22406
|
+
{ },
|
|
22407
|
+
{ },
|
|
22408
|
+
null,
|
|
22409
|
+
['PureCloud OAuth'],
|
|
22410
|
+
['application/json'],
|
|
22411
|
+
['application/json']
|
|
22412
|
+
);
|
|
22413
|
+
}
|
|
22414
|
+
|
|
22415
|
+
/**
|
|
22416
|
+
* Get preview for CSV upload
|
|
22417
|
+
*
|
|
22418
|
+
* @param {String} uploadId Upload id
|
|
22419
|
+
*/
|
|
22420
|
+
getExternalcontactsImportCsvUploadPreview(uploadId) {
|
|
22421
|
+
// verify the required parameter 'uploadId' is set
|
|
22422
|
+
if (uploadId === undefined || uploadId === null) {
|
|
22423
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';
|
|
22424
|
+
}
|
|
22425
|
+
|
|
22426
|
+
return this.apiClient.callApi(
|
|
22427
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview',
|
|
22428
|
+
'GET',
|
|
22429
|
+
{ 'uploadId': uploadId },
|
|
22430
|
+
{ },
|
|
22431
|
+
{ },
|
|
22432
|
+
{ },
|
|
22433
|
+
null,
|
|
22434
|
+
['PureCloud OAuth'],
|
|
22435
|
+
['application/json'],
|
|
22436
|
+
['application/json']
|
|
22437
|
+
);
|
|
22438
|
+
}
|
|
22439
|
+
|
|
22213
22440
|
/**
|
|
22214
22441
|
* Fetch an external organization
|
|
22215
22442
|
*
|
|
22216
22443
|
* @param {String} externalOrganizationId External Organization ID
|
|
22217
22444
|
* @param {Object} opts Optional parameters
|
|
22218
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22445
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22219
22446
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
22220
22447
|
*/
|
|
22221
22448
|
getExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
@@ -23223,7 +23450,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23223
23450
|
* Create an External Source
|
|
23224
23451
|
*
|
|
23225
23452
|
* @param {Object} body External Source
|
|
23226
|
-
* postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23227
23453
|
*/
|
|
23228
23454
|
postExternalcontactsExternalsources(body) {
|
|
23229
23455
|
// verify the required parameter 'body' is set
|
|
@@ -23274,6 +23500,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23274
23500
|
);
|
|
23275
23501
|
}
|
|
23276
23502
|
|
|
23503
|
+
/**
|
|
23504
|
+
* Create CSV import job
|
|
23505
|
+
*
|
|
23506
|
+
* @param {Object} body ImportRequest
|
|
23507
|
+
*/
|
|
23508
|
+
postExternalcontactsImportCsvJobs(body) {
|
|
23509
|
+
// verify the required parameter 'body' is set
|
|
23510
|
+
if (body === undefined || body === null) {
|
|
23511
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';
|
|
23512
|
+
}
|
|
23513
|
+
|
|
23514
|
+
return this.apiClient.callApi(
|
|
23515
|
+
'/api/v2/externalcontacts/import/csv/jobs',
|
|
23516
|
+
'POST',
|
|
23517
|
+
{ },
|
|
23518
|
+
{ },
|
|
23519
|
+
{ },
|
|
23520
|
+
{ },
|
|
23521
|
+
body,
|
|
23522
|
+
['PureCloud OAuth'],
|
|
23523
|
+
['application/json'],
|
|
23524
|
+
['application/json']
|
|
23525
|
+
);
|
|
23526
|
+
}
|
|
23527
|
+
|
|
23528
|
+
/**
|
|
23529
|
+
* Create settings for CSV import
|
|
23530
|
+
*
|
|
23531
|
+
* @param {Object} body Settings
|
|
23532
|
+
*/
|
|
23533
|
+
postExternalcontactsImportCsvSettings(body) {
|
|
23534
|
+
// verify the required parameter 'body' is set
|
|
23535
|
+
if (body === undefined || body === null) {
|
|
23536
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';
|
|
23537
|
+
}
|
|
23538
|
+
|
|
23539
|
+
return this.apiClient.callApi(
|
|
23540
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
23541
|
+
'POST',
|
|
23542
|
+
{ },
|
|
23543
|
+
{ },
|
|
23544
|
+
{ },
|
|
23545
|
+
{ },
|
|
23546
|
+
body,
|
|
23547
|
+
['PureCloud OAuth'],
|
|
23548
|
+
['application/json'],
|
|
23549
|
+
['application/json']
|
|
23550
|
+
);
|
|
23551
|
+
}
|
|
23552
|
+
|
|
23553
|
+
/**
|
|
23554
|
+
* Get url for CSV upload
|
|
23555
|
+
*
|
|
23556
|
+
* @param {Object} body UploadRequest
|
|
23557
|
+
*/
|
|
23558
|
+
postExternalcontactsImportCsvUploads(body) {
|
|
23559
|
+
// verify the required parameter 'body' is set
|
|
23560
|
+
if (body === undefined || body === null) {
|
|
23561
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';
|
|
23562
|
+
}
|
|
23563
|
+
|
|
23564
|
+
return this.apiClient.callApi(
|
|
23565
|
+
'/api/v2/externalcontacts/import/csv/uploads',
|
|
23566
|
+
'POST',
|
|
23567
|
+
{ },
|
|
23568
|
+
{ },
|
|
23569
|
+
{ },
|
|
23570
|
+
{ },
|
|
23571
|
+
body,
|
|
23572
|
+
['PureCloud OAuth'],
|
|
23573
|
+
['application/json'],
|
|
23574
|
+
['application/json']
|
|
23575
|
+
);
|
|
23576
|
+
}
|
|
23577
|
+
|
|
23277
23578
|
/**
|
|
23278
23579
|
* Merge two contacts into a new contact record
|
|
23279
23580
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -23534,7 +23835,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23534
23835
|
*
|
|
23535
23836
|
* @param {String} externalSourceId External Source ID
|
|
23536
23837
|
* @param {Object} body External Source
|
|
23537
|
-
* putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23538
23838
|
*/
|
|
23539
23839
|
putExternalcontactsExternalsource(externalSourceId, body) {
|
|
23540
23840
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -23560,6 +23860,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23560
23860
|
);
|
|
23561
23861
|
}
|
|
23562
23862
|
|
|
23863
|
+
/**
|
|
23864
|
+
* Update settings for CSV import
|
|
23865
|
+
*
|
|
23866
|
+
* @param {String} settingsId Settings id
|
|
23867
|
+
* @param {Object} body Settings
|
|
23868
|
+
*/
|
|
23869
|
+
putExternalcontactsImportCsvSetting(settingsId, body) {
|
|
23870
|
+
// verify the required parameter 'settingsId' is set
|
|
23871
|
+
if (settingsId === undefined || settingsId === null) {
|
|
23872
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';
|
|
23873
|
+
}
|
|
23874
|
+
// verify the required parameter 'body' is set
|
|
23875
|
+
if (body === undefined || body === null) {
|
|
23876
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';
|
|
23877
|
+
}
|
|
23878
|
+
|
|
23879
|
+
return this.apiClient.callApi(
|
|
23880
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
23881
|
+
'PUT',
|
|
23882
|
+
{ 'settingsId': settingsId },
|
|
23883
|
+
{ },
|
|
23884
|
+
{ },
|
|
23885
|
+
{ },
|
|
23886
|
+
body,
|
|
23887
|
+
['PureCloud OAuth'],
|
|
23888
|
+
['application/json'],
|
|
23889
|
+
['application/json']
|
|
23890
|
+
);
|
|
23891
|
+
}
|
|
23892
|
+
|
|
23563
23893
|
/**
|
|
23564
23894
|
* Update an external organization
|
|
23565
23895
|
*
|
|
@@ -23721,7 +24051,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23721
24051
|
/**
|
|
23722
24052
|
* Fax service.
|
|
23723
24053
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23724
|
-
* @version
|
|
24054
|
+
* @version 208.0.0
|
|
23725
24055
|
*/
|
|
23726
24056
|
|
|
23727
24057
|
/**
|
|
@@ -23936,7 +24266,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23936
24266
|
/**
|
|
23937
24267
|
* Flows service.
|
|
23938
24268
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23939
|
-
* @version
|
|
24269
|
+
* @version 208.0.0
|
|
23940
24270
|
*/
|
|
23941
24271
|
|
|
23942
24272
|
/**
|
|
@@ -24119,7 +24449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24119
24449
|
/**
|
|
24120
24450
|
* Gamification service.
|
|
24121
24451
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24122
|
-
* @version
|
|
24452
|
+
* @version 208.0.0
|
|
24123
24453
|
*/
|
|
24124
24454
|
|
|
24125
24455
|
/**
|
|
@@ -26205,7 +26535,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26205
26535
|
/**
|
|
26206
26536
|
* GeneralDataProtectionRegulation service.
|
|
26207
26537
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26208
|
-
* @version
|
|
26538
|
+
* @version 208.0.0
|
|
26209
26539
|
*/
|
|
26210
26540
|
|
|
26211
26541
|
/**
|
|
@@ -26335,7 +26665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26335
26665
|
/**
|
|
26336
26666
|
* Geolocation service.
|
|
26337
26667
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26338
|
-
* @version
|
|
26668
|
+
* @version 208.0.0
|
|
26339
26669
|
*/
|
|
26340
26670
|
|
|
26341
26671
|
/**
|
|
@@ -26466,7 +26796,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26466
26796
|
/**
|
|
26467
26797
|
* Greetings service.
|
|
26468
26798
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26469
|
-
* @version
|
|
26799
|
+
* @version 208.0.0
|
|
26470
26800
|
*/
|
|
26471
26801
|
|
|
26472
26802
|
/**
|
|
@@ -26921,7 +27251,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26921
27251
|
/**
|
|
26922
27252
|
* Groups service.
|
|
26923
27253
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26924
|
-
* @version
|
|
27254
|
+
* @version 208.0.0
|
|
26925
27255
|
*/
|
|
26926
27256
|
|
|
26927
27257
|
/**
|
|
@@ -27440,7 +27770,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27440
27770
|
/**
|
|
27441
27771
|
* IdentityProvider service.
|
|
27442
27772
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27443
|
-
* @version
|
|
27773
|
+
* @version 208.0.0
|
|
27444
27774
|
*/
|
|
27445
27775
|
|
|
27446
27776
|
/**
|
|
@@ -28301,7 +28631,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28301
28631
|
/**
|
|
28302
28632
|
* InfrastructureAsCode service.
|
|
28303
28633
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28304
|
-
* @version
|
|
28634
|
+
* @version 208.0.0
|
|
28305
28635
|
*/
|
|
28306
28636
|
|
|
28307
28637
|
/**
|
|
@@ -28468,7 +28798,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28468
28798
|
/**
|
|
28469
28799
|
* Integrations service.
|
|
28470
28800
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28471
|
-
* @version
|
|
28801
|
+
* @version 208.0.0
|
|
28472
28802
|
*/
|
|
28473
28803
|
|
|
28474
28804
|
/**
|
|
@@ -28762,8 +29092,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28762
29092
|
*
|
|
28763
29093
|
* @param {String} actionId actionId
|
|
28764
29094
|
* @param {String} fileName Name of schema file to be retrieved for this draft.
|
|
29095
|
+
* @param {Object} opts Optional parameters
|
|
29096
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
28765
29097
|
*/
|
|
28766
|
-
getIntegrationsActionDraftSchema(actionId, fileName) {
|
|
29098
|
+
getIntegrationsActionDraftSchema(actionId, fileName, opts) {
|
|
29099
|
+
opts = opts || {};
|
|
29100
|
+
|
|
28767
29101
|
// verify the required parameter 'actionId' is set
|
|
28768
29102
|
if (actionId === undefined || actionId === null) {
|
|
28769
29103
|
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';
|
|
@@ -28777,7 +29111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28777
29111
|
'/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}',
|
|
28778
29112
|
'GET',
|
|
28779
29113
|
{ 'actionId': actionId,'fileName': fileName },
|
|
28780
|
-
{
|
|
29114
|
+
{ 'flatten': opts['flatten'] },
|
|
28781
29115
|
{ },
|
|
28782
29116
|
{ },
|
|
28783
29117
|
null,
|
|
@@ -28873,8 +29207,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28873
29207
|
*
|
|
28874
29208
|
* @param {String} actionId actionId
|
|
28875
29209
|
* @param {String} fileName Name of schema file to be retrieved for this action.
|
|
29210
|
+
* @param {Object} opts Optional parameters
|
|
29211
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
28876
29212
|
*/
|
|
28877
|
-
getIntegrationsActionSchema(actionId, fileName) {
|
|
29213
|
+
getIntegrationsActionSchema(actionId, fileName, opts) {
|
|
29214
|
+
opts = opts || {};
|
|
29215
|
+
|
|
28878
29216
|
// verify the required parameter 'actionId' is set
|
|
28879
29217
|
if (actionId === undefined || actionId === null) {
|
|
28880
29218
|
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';
|
|
@@ -28888,7 +29226,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28888
29226
|
'/api/v2/integrations/actions/{actionId}/schemas/{fileName}',
|
|
28889
29227
|
'GET',
|
|
28890
29228
|
{ 'actionId': actionId,'fileName': fileName },
|
|
28891
|
-
{
|
|
29229
|
+
{ 'flatten': opts['flatten'] },
|
|
28892
29230
|
{ },
|
|
28893
29231
|
{ },
|
|
28894
29232
|
null,
|
|
@@ -30425,8 +30763,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30425
30763
|
*
|
|
30426
30764
|
* @param {String} actionId actionId
|
|
30427
30765
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30766
|
+
* @param {Object} opts Optional parameters
|
|
30767
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30428
30768
|
*/
|
|
30429
|
-
postIntegrationsActionDraftTest(actionId, body) {
|
|
30769
|
+
postIntegrationsActionDraftTest(actionId, body, opts) {
|
|
30770
|
+
opts = opts || {};
|
|
30771
|
+
|
|
30430
30772
|
// verify the required parameter 'actionId' is set
|
|
30431
30773
|
if (actionId === undefined || actionId === null) {
|
|
30432
30774
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';
|
|
@@ -30440,7 +30782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30440
30782
|
'/api/v2/integrations/actions/{actionId}/draft/test',
|
|
30441
30783
|
'POST',
|
|
30442
30784
|
{ 'actionId': actionId },
|
|
30443
|
-
{
|
|
30785
|
+
{ 'flatten': opts['flatten'] },
|
|
30444
30786
|
{ },
|
|
30445
30787
|
{ },
|
|
30446
30788
|
body,
|
|
@@ -30455,8 +30797,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30455
30797
|
*
|
|
30456
30798
|
* @param {String} actionId actionId
|
|
30457
30799
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30800
|
+
* @param {Object} opts Optional parameters
|
|
30801
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30458
30802
|
*/
|
|
30459
|
-
postIntegrationsActionExecute(actionId, body) {
|
|
30803
|
+
postIntegrationsActionExecute(actionId, body, opts) {
|
|
30804
|
+
opts = opts || {};
|
|
30805
|
+
|
|
30460
30806
|
// verify the required parameter 'actionId' is set
|
|
30461
30807
|
if (actionId === undefined || actionId === null) {
|
|
30462
30808
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';
|
|
@@ -30470,7 +30816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30470
30816
|
'/api/v2/integrations/actions/{actionId}/execute',
|
|
30471
30817
|
'POST',
|
|
30472
30818
|
{ 'actionId': actionId },
|
|
30473
|
-
{
|
|
30819
|
+
{ 'flatten': opts['flatten'] },
|
|
30474
30820
|
{ },
|
|
30475
30821
|
{ },
|
|
30476
30822
|
body,
|
|
@@ -30485,8 +30831,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30485
30831
|
*
|
|
30486
30832
|
* @param {String} actionId actionId
|
|
30487
30833
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30834
|
+
* @param {Object} opts Optional parameters
|
|
30835
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30488
30836
|
*/
|
|
30489
|
-
postIntegrationsActionTest(actionId, body) {
|
|
30837
|
+
postIntegrationsActionTest(actionId, body, opts) {
|
|
30838
|
+
opts = opts || {};
|
|
30839
|
+
|
|
30490
30840
|
// verify the required parameter 'actionId' is set
|
|
30491
30841
|
if (actionId === undefined || actionId === null) {
|
|
30492
30842
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionTest';
|
|
@@ -30500,7 +30850,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30500
30850
|
'/api/v2/integrations/actions/{actionId}/test',
|
|
30501
30851
|
'POST',
|
|
30502
30852
|
{ 'actionId': actionId },
|
|
30503
|
-
{
|
|
30853
|
+
{ 'flatten': opts['flatten'] },
|
|
30504
30854
|
{ },
|
|
30505
30855
|
{ },
|
|
30506
30856
|
body,
|
|
@@ -30890,7 +31240,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30890
31240
|
/**
|
|
30891
31241
|
* Journey service.
|
|
30892
31242
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30893
|
-
* @version
|
|
31243
|
+
* @version 208.0.0
|
|
30894
31244
|
*/
|
|
30895
31245
|
|
|
30896
31246
|
/**
|
|
@@ -31059,6 +31409,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31059
31409
|
);
|
|
31060
31410
|
}
|
|
31061
31411
|
|
|
31412
|
+
/**
|
|
31413
|
+
* Delete the Schedule of a JourneyView
|
|
31414
|
+
* used for long descriptions
|
|
31415
|
+
* @param {String} viewId Journey View Id
|
|
31416
|
+
*/
|
|
31417
|
+
deleteJourneyViewSchedules(viewId) {
|
|
31418
|
+
// verify the required parameter 'viewId' is set
|
|
31419
|
+
if (viewId === undefined || viewId === null) {
|
|
31420
|
+
throw 'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';
|
|
31421
|
+
}
|
|
31422
|
+
|
|
31423
|
+
return this.apiClient.callApi(
|
|
31424
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
31425
|
+
'DELETE',
|
|
31426
|
+
{ 'viewId': viewId },
|
|
31427
|
+
{ },
|
|
31428
|
+
{ },
|
|
31429
|
+
{ },
|
|
31430
|
+
null,
|
|
31431
|
+
['PureCloud OAuth'],
|
|
31432
|
+
['application/json'],
|
|
31433
|
+
['application/json']
|
|
31434
|
+
);
|
|
31435
|
+
}
|
|
31436
|
+
|
|
31062
31437
|
/**
|
|
31063
31438
|
* Get status for async query for journey aggregates
|
|
31064
31439
|
*
|
|
@@ -31707,6 +32082,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31707
32082
|
);
|
|
31708
32083
|
}
|
|
31709
32084
|
|
|
32085
|
+
/**
|
|
32086
|
+
* Get the Schedule for a JourneyView
|
|
32087
|
+
* used for long descriptions
|
|
32088
|
+
* @param {String} viewId Journey View Id
|
|
32089
|
+
*/
|
|
32090
|
+
getJourneyViewSchedules(viewId) {
|
|
32091
|
+
// verify the required parameter 'viewId' is set
|
|
32092
|
+
if (viewId === undefined || viewId === null) {
|
|
32093
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewSchedules';
|
|
32094
|
+
}
|
|
32095
|
+
|
|
32096
|
+
return this.apiClient.callApi(
|
|
32097
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
32098
|
+
'GET',
|
|
32099
|
+
{ 'viewId': viewId },
|
|
32100
|
+
{ },
|
|
32101
|
+
{ },
|
|
32102
|
+
{ },
|
|
32103
|
+
null,
|
|
32104
|
+
['PureCloud OAuth'],
|
|
32105
|
+
['application/json'],
|
|
32106
|
+
['application/json']
|
|
32107
|
+
);
|
|
32108
|
+
}
|
|
32109
|
+
|
|
31710
32110
|
/**
|
|
31711
32111
|
* Get a Journey View by ID and version
|
|
31712
32112
|
*
|
|
@@ -31984,7 +32384,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31984
32384
|
* Get an Event Definition
|
|
31985
32385
|
*
|
|
31986
32386
|
* @param {String} eventDefinitionId Event Definition ID
|
|
31987
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31988
32387
|
*/
|
|
31989
32388
|
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
31990
32389
|
// verify the required parameter 'eventDefinitionId' is set
|
|
@@ -32009,7 +32408,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32009
32408
|
/**
|
|
32010
32409
|
* Get a list of Event Definitions
|
|
32011
32410
|
*
|
|
32012
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32013
32411
|
*/
|
|
32014
32412
|
getJourneyViewsEventdefinitions() {
|
|
32015
32413
|
|
|
@@ -32054,6 +32452,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32054
32452
|
);
|
|
32055
32453
|
}
|
|
32056
32454
|
|
|
32455
|
+
/**
|
|
32456
|
+
* Get the journey schedules for an organization.
|
|
32457
|
+
*
|
|
32458
|
+
* @param {Object} opts Optional parameters
|
|
32459
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
32460
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
32461
|
+
*/
|
|
32462
|
+
getJourneyViewsSchedules(opts) {
|
|
32463
|
+
opts = opts || {};
|
|
32464
|
+
|
|
32465
|
+
|
|
32466
|
+
return this.apiClient.callApi(
|
|
32467
|
+
'/api/v2/journey/views/schedules',
|
|
32468
|
+
'GET',
|
|
32469
|
+
{ },
|
|
32470
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
32471
|
+
{ },
|
|
32472
|
+
{ },
|
|
32473
|
+
null,
|
|
32474
|
+
['PureCloud OAuth'],
|
|
32475
|
+
['application/json'],
|
|
32476
|
+
['application/json']
|
|
32477
|
+
);
|
|
32478
|
+
}
|
|
32479
|
+
|
|
32057
32480
|
/**
|
|
32058
32481
|
* Update single action map.
|
|
32059
32482
|
*
|
|
@@ -32572,6 +32995,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32572
32995
|
);
|
|
32573
32996
|
}
|
|
32574
32997
|
|
|
32998
|
+
/**
|
|
32999
|
+
* Add a new Schedule to a JourneyView
|
|
33000
|
+
*
|
|
33001
|
+
* @param {String} viewId Journey View Id
|
|
33002
|
+
* @param {Object} body journeyViewSchedule
|
|
33003
|
+
*/
|
|
33004
|
+
postJourneyViewSchedules(viewId, body) {
|
|
33005
|
+
// verify the required parameter 'viewId' is set
|
|
33006
|
+
if (viewId === undefined || viewId === null) {
|
|
33007
|
+
throw 'Missing the required parameter "viewId" when calling postJourneyViewSchedules';
|
|
33008
|
+
}
|
|
33009
|
+
// verify the required parameter 'body' is set
|
|
33010
|
+
if (body === undefined || body === null) {
|
|
33011
|
+
throw 'Missing the required parameter "body" when calling postJourneyViewSchedules';
|
|
33012
|
+
}
|
|
33013
|
+
|
|
33014
|
+
return this.apiClient.callApi(
|
|
33015
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
33016
|
+
'POST',
|
|
33017
|
+
{ 'viewId': viewId },
|
|
33018
|
+
{ },
|
|
33019
|
+
{ },
|
|
33020
|
+
{ },
|
|
33021
|
+
body,
|
|
33022
|
+
['PureCloud OAuth'],
|
|
33023
|
+
['application/json'],
|
|
33024
|
+
['application/json']
|
|
33025
|
+
);
|
|
33026
|
+
}
|
|
33027
|
+
|
|
32575
33028
|
/**
|
|
32576
33029
|
* Submit a job request for a journey view version.
|
|
32577
33030
|
* used for long descriptions
|
|
@@ -32662,7 +33115,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32662
33115
|
* True indicates a valid encoding
|
|
32663
33116
|
* @param {Object} opts Optional parameters
|
|
32664
33117
|
* @param {Array.<Object>} opts.body
|
|
32665
|
-
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32666
33118
|
*/
|
|
32667
33119
|
postJourneyViewsEncodingsValidate(opts) {
|
|
32668
33120
|
opts = opts || {};
|
|
@@ -32682,6 +33134,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32682
33134
|
);
|
|
32683
33135
|
}
|
|
32684
33136
|
|
|
33137
|
+
/**
|
|
33138
|
+
* Update the Schedule for a JourneyView
|
|
33139
|
+
* used for long descriptions
|
|
33140
|
+
* @param {String} viewId Journey View Id
|
|
33141
|
+
* @param {Object} body journeyViewSchedule
|
|
33142
|
+
*/
|
|
33143
|
+
putJourneyViewSchedules(viewId, body) {
|
|
33144
|
+
// verify the required parameter 'viewId' is set
|
|
33145
|
+
if (viewId === undefined || viewId === null) {
|
|
33146
|
+
throw 'Missing the required parameter "viewId" when calling putJourneyViewSchedules';
|
|
33147
|
+
}
|
|
33148
|
+
// verify the required parameter 'body' is set
|
|
33149
|
+
if (body === undefined || body === null) {
|
|
33150
|
+
throw 'Missing the required parameter "body" when calling putJourneyViewSchedules';
|
|
33151
|
+
}
|
|
33152
|
+
|
|
33153
|
+
return this.apiClient.callApi(
|
|
33154
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
33155
|
+
'PUT',
|
|
33156
|
+
{ 'viewId': viewId },
|
|
33157
|
+
{ },
|
|
33158
|
+
{ },
|
|
33159
|
+
{ },
|
|
33160
|
+
body,
|
|
33161
|
+
['PureCloud OAuth'],
|
|
33162
|
+
['application/json'],
|
|
33163
|
+
['application/json']
|
|
33164
|
+
);
|
|
33165
|
+
}
|
|
33166
|
+
|
|
32685
33167
|
/**
|
|
32686
33168
|
* Update a Journey View by ID and version
|
|
32687
33169
|
* does not create a new version
|
|
@@ -32723,7 +33205,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32723
33205
|
/**
|
|
32724
33206
|
* Knowledge service.
|
|
32725
33207
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
32726
|
-
* @version
|
|
33208
|
+
* @version 208.0.0
|
|
32727
33209
|
*/
|
|
32728
33210
|
|
|
32729
33211
|
/**
|
|
@@ -33061,7 +33543,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33061
33543
|
*
|
|
33062
33544
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33063
33545
|
* @param {String} sourceId Source ID
|
|
33064
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33065
33546
|
*/
|
|
33066
33547
|
deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId) {
|
|
33067
33548
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33092,7 +33573,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33092
33573
|
*
|
|
33093
33574
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33094
33575
|
* @param {String} sourceId Source ID
|
|
33095
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33096
33576
|
*/
|
|
33097
33577
|
deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId) {
|
|
33098
33578
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33123,7 +33603,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33123
33603
|
*
|
|
33124
33604
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33125
33605
|
* @param {String} syncJobId Synchronization job ID
|
|
33126
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33127
33606
|
*/
|
|
33128
33607
|
deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
33129
33608
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33250,7 +33729,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33250
33729
|
* Get sync options available for a knowledge-connect integration
|
|
33251
33730
|
*
|
|
33252
33731
|
* @param {String} integrationId Integration ID
|
|
33253
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33254
33732
|
*/
|
|
33255
33733
|
getKnowledgeIntegrationOptions(integrationId) {
|
|
33256
33734
|
// verify the required parameter 'integrationId' is set
|
|
@@ -33486,6 +33964,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33486
33964
|
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
33487
33965
|
* @param {Object} opts Optional parameters
|
|
33488
33966
|
* @param {Object} opts.documentState The state of the document.
|
|
33967
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
33489
33968
|
*/
|
|
33490
33969
|
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
33491
33970
|
opts = opts || {};
|
|
@@ -33507,7 +33986,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33507
33986
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
33508
33987
|
'GET',
|
|
33509
33988
|
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
33510
|
-
{ 'documentState': opts['documentState'] },
|
|
33989
|
+
{ 'documentState': opts['documentState'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33511
33990
|
{ },
|
|
33512
33991
|
{ },
|
|
33513
33992
|
null,
|
|
@@ -33527,6 +34006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33527
34006
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
33528
34007
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
33529
34008
|
* @param {Object} opts.documentState The state of the document.
|
|
34009
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
33530
34010
|
*/
|
|
33531
34011
|
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
33532
34012
|
opts = opts || {};
|
|
@@ -33544,7 +34024,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33544
34024
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
33545
34025
|
'GET',
|
|
33546
34026
|
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
33547
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
34027
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33548
34028
|
{ },
|
|
33549
34029
|
{ },
|
|
33550
34030
|
null,
|
|
@@ -34197,7 +34677,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34197
34677
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
34198
34678
|
* @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
|
|
34199
34679
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
34200
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34201
34680
|
*/
|
|
34202
34681
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
34203
34682
|
opts = opts || {};
|
|
@@ -34225,7 +34704,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34225
34704
|
* Get ids of operation creator users and oauth clients
|
|
34226
34705
|
*
|
|
34227
34706
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34228
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34229
34707
|
*/
|
|
34230
34708
|
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
34231
34709
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -34290,7 +34768,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34290
34768
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
34291
34769
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34292
34770
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
34293
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34294
34771
|
*/
|
|
34295
34772
|
getKnowledgeKnowledgebaseSources(knowledgeBaseId, opts) {
|
|
34296
34773
|
opts = opts || {};
|
|
@@ -34321,7 +34798,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34321
34798
|
* @param {String} sourceId Source ID
|
|
34322
34799
|
* @param {Object} opts Optional parameters
|
|
34323
34800
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34324
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34325
34801
|
*/
|
|
34326
34802
|
getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34327
34803
|
opts = opts || {};
|
|
@@ -34356,7 +34832,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34356
34832
|
* @param {String} sourceId Source ID
|
|
34357
34833
|
* @param {Object} opts Optional parameters
|
|
34358
34834
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34359
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34360
34835
|
*/
|
|
34361
34836
|
getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34362
34837
|
opts = opts || {};
|
|
@@ -34389,7 +34864,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34389
34864
|
*
|
|
34390
34865
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34391
34866
|
* @param {String} syncJobId Synchronization job ID
|
|
34392
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34393
34867
|
*/
|
|
34394
34868
|
getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
34395
34869
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -35105,7 +35579,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35105
35579
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
35106
35580
|
* @param {String} syncJobId Synchronization job ID
|
|
35107
35581
|
* @param {Object} body
|
|
35108
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35109
35582
|
*/
|
|
35110
35583
|
patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId, body) {
|
|
35111
35584
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36327,7 +36800,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36327
36800
|
*
|
|
36328
36801
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36329
36802
|
* @param {Object} body
|
|
36330
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36331
36803
|
*/
|
|
36332
36804
|
postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId, body) {
|
|
36333
36805
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36358,7 +36830,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36358
36830
|
*
|
|
36359
36831
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36360
36832
|
* @param {String} sourceId Source ID
|
|
36361
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36362
36833
|
*/
|
|
36363
36834
|
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36364
36835
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36389,7 +36860,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36389
36860
|
*
|
|
36390
36861
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36391
36862
|
* @param {Object} body
|
|
36392
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36393
36863
|
*/
|
|
36394
36864
|
postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId, body) {
|
|
36395
36865
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36420,7 +36890,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36420
36890
|
*
|
|
36421
36891
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36422
36892
|
* @param {String} sourceId Source ID
|
|
36423
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36424
36893
|
*/
|
|
36425
36894
|
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36426
36895
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36451,7 +36920,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36451
36920
|
*
|
|
36452
36921
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36453
36922
|
* @param {Object} body
|
|
36454
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36455
36923
|
*/
|
|
36456
36924
|
postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId, body) {
|
|
36457
36925
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36539,7 +37007,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36539
37007
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36540
37008
|
* @param {String} sourceId Source ID
|
|
36541
37009
|
* @param {Object} body
|
|
36542
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36543
37010
|
*/
|
|
36544
37011
|
putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, body) {
|
|
36545
37012
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36575,7 +37042,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36575
37042
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36576
37043
|
* @param {String} sourceId Source ID
|
|
36577
37044
|
* @param {Object} body
|
|
36578
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36579
37045
|
*/
|
|
36580
37046
|
putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, body) {
|
|
36581
37047
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36611,7 +37077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36611
37077
|
/**
|
|
36612
37078
|
* LanguageUnderstanding service.
|
|
36613
37079
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
36614
|
-
* @version
|
|
37080
|
+
* @version 208.0.0
|
|
36615
37081
|
*/
|
|
36616
37082
|
|
|
36617
37083
|
/**
|
|
@@ -37645,7 +38111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37645
38111
|
/**
|
|
37646
38112
|
* Languages service.
|
|
37647
38113
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
37648
|
-
* @version
|
|
38114
|
+
* @version 208.0.0
|
|
37649
38115
|
*/
|
|
37650
38116
|
|
|
37651
38117
|
/**
|
|
@@ -37867,7 +38333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37867
38333
|
/**
|
|
37868
38334
|
* Learning service.
|
|
37869
38335
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
37870
|
-
* @version
|
|
38336
|
+
* @version 208.0.0
|
|
37871
38337
|
*/
|
|
37872
38338
|
|
|
37873
38339
|
/**
|
|
@@ -38896,7 +39362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38896
39362
|
/**
|
|
38897
39363
|
* License service.
|
|
38898
39364
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
38899
|
-
* @version
|
|
39365
|
+
* @version 208.0.0
|
|
38900
39366
|
*/
|
|
38901
39367
|
|
|
38902
39368
|
/**
|
|
@@ -39134,7 +39600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39134
39600
|
/**
|
|
39135
39601
|
* Locations service.
|
|
39136
39602
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39137
|
-
* @version
|
|
39603
|
+
* @version 208.0.0
|
|
39138
39604
|
*/
|
|
39139
39605
|
|
|
39140
39606
|
/**
|
|
@@ -39370,7 +39836,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39370
39836
|
/**
|
|
39371
39837
|
* LogCapture service.
|
|
39372
39838
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39373
|
-
* @version
|
|
39839
|
+
* @version 208.0.0
|
|
39374
39840
|
*/
|
|
39375
39841
|
|
|
39376
39842
|
/**
|
|
@@ -39570,7 +40036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39570
40036
|
/**
|
|
39571
40037
|
* Messaging service.
|
|
39572
40038
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
39573
|
-
* @version
|
|
40039
|
+
* @version 208.0.0
|
|
39574
40040
|
*/
|
|
39575
40041
|
|
|
39576
40042
|
/**
|
|
@@ -39929,7 +40395,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39929
40395
|
/**
|
|
39930
40396
|
* MobileDevices service.
|
|
39931
40397
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
39932
|
-
* @version
|
|
40398
|
+
* @version 208.0.0
|
|
39933
40399
|
*/
|
|
39934
40400
|
|
|
39935
40401
|
/**
|
|
@@ -40080,7 +40546,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40080
40546
|
/**
|
|
40081
40547
|
* Notifications service.
|
|
40082
40548
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40083
|
-
* @version
|
|
40549
|
+
* @version 208.0.0
|
|
40084
40550
|
*/
|
|
40085
40551
|
|
|
40086
40552
|
/**
|
|
@@ -40313,7 +40779,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40313
40779
|
/**
|
|
40314
40780
|
* OAuth service.
|
|
40315
40781
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40316
|
-
* @version
|
|
40782
|
+
* @version 208.0.0
|
|
40317
40783
|
*/
|
|
40318
40784
|
|
|
40319
40785
|
/**
|
|
@@ -40679,7 +41145,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40679
41145
|
/**
|
|
40680
41146
|
* Objects service.
|
|
40681
41147
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
40682
|
-
* @version
|
|
41148
|
+
* @version 208.0.0
|
|
40683
41149
|
*/
|
|
40684
41150
|
|
|
40685
41151
|
/**
|
|
@@ -40949,7 +41415,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40949
41415
|
/**
|
|
40950
41416
|
* OperationalEvents service.
|
|
40951
41417
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
40952
|
-
* @version
|
|
41418
|
+
* @version 208.0.0
|
|
40953
41419
|
*/
|
|
40954
41420
|
|
|
40955
41421
|
/**
|
|
@@ -41015,7 +41481,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41015
41481
|
/**
|
|
41016
41482
|
* Organization service.
|
|
41017
41483
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41018
|
-
* @version
|
|
41484
|
+
* @version 208.0.0
|
|
41019
41485
|
*/
|
|
41020
41486
|
|
|
41021
41487
|
/**
|
|
@@ -41557,7 +42023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41557
42023
|
/**
|
|
41558
42024
|
* OrganizationAuthorization service.
|
|
41559
42025
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
41560
|
-
* @version
|
|
42026
|
+
* @version 208.0.0
|
|
41561
42027
|
*/
|
|
41562
42028
|
|
|
41563
42029
|
/**
|
|
@@ -42194,6 +42660,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42194
42660
|
);
|
|
42195
42661
|
}
|
|
42196
42662
|
|
|
42663
|
+
/**
|
|
42664
|
+
* Get Customer Care organization ids.
|
|
42665
|
+
*
|
|
42666
|
+
*/
|
|
42667
|
+
getOrgauthorizationTrusteesCare() {
|
|
42668
|
+
|
|
42669
|
+
return this.apiClient.callApi(
|
|
42670
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
42671
|
+
'GET',
|
|
42672
|
+
{ },
|
|
42673
|
+
{ },
|
|
42674
|
+
{ },
|
|
42675
|
+
{ },
|
|
42676
|
+
null,
|
|
42677
|
+
['PureCloud OAuth'],
|
|
42678
|
+
['application/json'],
|
|
42679
|
+
['application/json']
|
|
42680
|
+
);
|
|
42681
|
+
}
|
|
42682
|
+
|
|
42197
42683
|
/**
|
|
42198
42684
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
42199
42685
|
*
|
|
@@ -42581,6 +43067,33 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42581
43067
|
);
|
|
42582
43068
|
}
|
|
42583
43069
|
|
|
43070
|
+
/**
|
|
43071
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
43072
|
+
*
|
|
43073
|
+
* @param {Object} opts Optional parameters
|
|
43074
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
43075
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
43076
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
43077
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
43078
|
+
*/
|
|
43079
|
+
postOrgauthorizationTrusteesCare(opts) {
|
|
43080
|
+
opts = opts || {};
|
|
43081
|
+
|
|
43082
|
+
|
|
43083
|
+
return this.apiClient.callApi(
|
|
43084
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
43085
|
+
'POST',
|
|
43086
|
+
{ },
|
|
43087
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'],'assignFullAccess': opts['assignFullAccess'],'allowTrustedUserAccess': opts['allowTrustedUserAccess'] },
|
|
43088
|
+
{ },
|
|
43089
|
+
{ },
|
|
43090
|
+
null,
|
|
43091
|
+
['PureCloud OAuth'],
|
|
43092
|
+
['application/json'],
|
|
43093
|
+
['application/json']
|
|
43094
|
+
);
|
|
43095
|
+
}
|
|
43096
|
+
|
|
42584
43097
|
/**
|
|
42585
43098
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
42586
43099
|
*
|
|
@@ -42904,7 +43417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42904
43417
|
/**
|
|
42905
43418
|
* Outbound service.
|
|
42906
43419
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
42907
|
-
* @version
|
|
43420
|
+
* @version 208.0.0
|
|
42908
43421
|
*/
|
|
42909
43422
|
|
|
42910
43423
|
/**
|
|
@@ -45881,6 +46394,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45881
46394
|
);
|
|
45882
46395
|
}
|
|
45883
46396
|
|
|
46397
|
+
/**
|
|
46398
|
+
* Start the campaign
|
|
46399
|
+
*
|
|
46400
|
+
* @param {String} campaignId Campaign ID
|
|
46401
|
+
*/
|
|
46402
|
+
postOutboundCampaignStart(campaignId) {
|
|
46403
|
+
// verify the required parameter 'campaignId' is set
|
|
46404
|
+
if (campaignId === undefined || campaignId === null) {
|
|
46405
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';
|
|
46406
|
+
}
|
|
46407
|
+
|
|
46408
|
+
return this.apiClient.callApi(
|
|
46409
|
+
'/api/v2/outbound/campaigns/{campaignId}/start',
|
|
46410
|
+
'POST',
|
|
46411
|
+
{ 'campaignId': campaignId },
|
|
46412
|
+
{ },
|
|
46413
|
+
{ },
|
|
46414
|
+
{ },
|
|
46415
|
+
null,
|
|
46416
|
+
['PureCloud OAuth'],
|
|
46417
|
+
['application/json'],
|
|
46418
|
+
['application/json']
|
|
46419
|
+
);
|
|
46420
|
+
}
|
|
46421
|
+
|
|
46422
|
+
/**
|
|
46423
|
+
* Stop the campaign
|
|
46424
|
+
*
|
|
46425
|
+
* @param {String} campaignId Campaign ID
|
|
46426
|
+
*/
|
|
46427
|
+
postOutboundCampaignStop(campaignId) {
|
|
46428
|
+
// verify the required parameter 'campaignId' is set
|
|
46429
|
+
if (campaignId === undefined || campaignId === null) {
|
|
46430
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';
|
|
46431
|
+
}
|
|
46432
|
+
|
|
46433
|
+
return this.apiClient.callApi(
|
|
46434
|
+
'/api/v2/outbound/campaigns/{campaignId}/stop',
|
|
46435
|
+
'POST',
|
|
46436
|
+
{ 'campaignId': campaignId },
|
|
46437
|
+
{ },
|
|
46438
|
+
{ },
|
|
46439
|
+
{ },
|
|
46440
|
+
null,
|
|
46441
|
+
['PureCloud OAuth'],
|
|
46442
|
+
['application/json'],
|
|
46443
|
+
['application/json']
|
|
46444
|
+
);
|
|
46445
|
+
}
|
|
46446
|
+
|
|
45884
46447
|
/**
|
|
45885
46448
|
* Create Campaign Rule
|
|
45886
46449
|
*
|
|
@@ -46580,6 +47143,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46580
47143
|
);
|
|
46581
47144
|
}
|
|
46582
47145
|
|
|
47146
|
+
/**
|
|
47147
|
+
* Start the campaign
|
|
47148
|
+
* Documented permissions are applicable based on campaign type.
|
|
47149
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
47150
|
+
*/
|
|
47151
|
+
postOutboundMessagingcampaignStart(messagingCampaignId) {
|
|
47152
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
47153
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
47154
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';
|
|
47155
|
+
}
|
|
47156
|
+
|
|
47157
|
+
return this.apiClient.callApi(
|
|
47158
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start',
|
|
47159
|
+
'POST',
|
|
47160
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
47161
|
+
{ },
|
|
47162
|
+
{ },
|
|
47163
|
+
{ },
|
|
47164
|
+
null,
|
|
47165
|
+
['PureCloud OAuth'],
|
|
47166
|
+
['application/json'],
|
|
47167
|
+
['application/json']
|
|
47168
|
+
);
|
|
47169
|
+
}
|
|
47170
|
+
|
|
47171
|
+
/**
|
|
47172
|
+
* Stop the campaign
|
|
47173
|
+
* Documented permissions are applicable based on campaign type.
|
|
47174
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
47175
|
+
*/
|
|
47176
|
+
postOutboundMessagingcampaignStop(messagingCampaignId) {
|
|
47177
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
47178
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
47179
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';
|
|
47180
|
+
}
|
|
47181
|
+
|
|
47182
|
+
return this.apiClient.callApi(
|
|
47183
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop',
|
|
47184
|
+
'POST',
|
|
47185
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
47186
|
+
{ },
|
|
47187
|
+
{ },
|
|
47188
|
+
{ },
|
|
47189
|
+
null,
|
|
47190
|
+
['PureCloud OAuth'],
|
|
47191
|
+
['application/json'],
|
|
47192
|
+
['application/json']
|
|
47193
|
+
);
|
|
47194
|
+
}
|
|
47195
|
+
|
|
46583
47196
|
/**
|
|
46584
47197
|
* Create a Messaging Campaign
|
|
46585
47198
|
*
|
|
@@ -47351,7 +47964,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47351
47964
|
/**
|
|
47352
47965
|
* Presence service.
|
|
47353
47966
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47354
|
-
* @version
|
|
47967
|
+
* @version 208.0.0
|
|
47355
47968
|
*/
|
|
47356
47969
|
|
|
47357
47970
|
/**
|
|
@@ -48095,7 +48708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48095
48708
|
/**
|
|
48096
48709
|
* ProcessAutomation service.
|
|
48097
48710
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48098
|
-
* @version
|
|
48711
|
+
* @version 208.0.0
|
|
48099
48712
|
*/
|
|
48100
48713
|
|
|
48101
48714
|
/**
|
|
@@ -48334,7 +48947,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48334
48947
|
/**
|
|
48335
48948
|
* Quality service.
|
|
48336
48949
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48337
|
-
* @version
|
|
48950
|
+
* @version 208.0.0
|
|
48338
48951
|
*/
|
|
48339
48952
|
|
|
48340
48953
|
/**
|
|
@@ -50120,7 +50733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50120
50733
|
/**
|
|
50121
50734
|
* Recording service.
|
|
50122
50735
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50123
|
-
* @version
|
|
50736
|
+
* @version 208.0.0
|
|
50124
50737
|
*/
|
|
50125
50738
|
|
|
50126
50739
|
/**
|
|
@@ -51779,7 +52392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51779
52392
|
/**
|
|
51780
52393
|
* ResponseManagement service.
|
|
51781
52394
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
51782
|
-
* @version
|
|
52395
|
+
* @version 208.0.0
|
|
51783
52396
|
*/
|
|
51784
52397
|
|
|
51785
52398
|
/**
|
|
@@ -52289,7 +52902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52289
52902
|
/**
|
|
52290
52903
|
* Routing service.
|
|
52291
52904
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52292
|
-
* @version
|
|
52905
|
+
* @version 208.0.0
|
|
52293
52906
|
*/
|
|
52294
52907
|
|
|
52295
52908
|
/**
|
|
@@ -52874,7 +53487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52874
53487
|
}
|
|
52875
53488
|
|
|
52876
53489
|
/**
|
|
52877
|
-
* Remove routing language from user
|
|
53490
|
+
* Remove a routing language from a user
|
|
52878
53491
|
*
|
|
52879
53492
|
* @param {String} userId User ID
|
|
52880
53493
|
* @param {String} languageId languageId
|
|
@@ -52904,7 +53517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52904
53517
|
}
|
|
52905
53518
|
|
|
52906
53519
|
/**
|
|
52907
|
-
* Remove routing skill from user
|
|
53520
|
+
* Remove a routing skill from a user
|
|
52908
53521
|
*
|
|
52909
53522
|
* @param {String} userId User ID
|
|
52910
53523
|
* @param {String} skillId skillId
|
|
@@ -54683,7 +55296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54683
55296
|
}
|
|
54684
55297
|
|
|
54685
55298
|
/**
|
|
54686
|
-
* List routing
|
|
55299
|
+
* List routing languages assigned to a user
|
|
54687
55300
|
*
|
|
54688
55301
|
* @param {String} userId User ID
|
|
54689
55302
|
* @param {Object} opts Optional parameters
|
|
@@ -54714,7 +55327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54714
55327
|
}
|
|
54715
55328
|
|
|
54716
55329
|
/**
|
|
54717
|
-
* List routing skills
|
|
55330
|
+
* List routing skills assigned to a user
|
|
54718
55331
|
*
|
|
54719
55332
|
* @param {String} userId User ID
|
|
54720
55333
|
* @param {Object} opts Optional parameters
|
|
@@ -55176,7 +55789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55176
55789
|
}
|
|
55177
55790
|
|
|
55178
55791
|
/**
|
|
55179
|
-
* Update routing language proficiency
|
|
55792
|
+
* Update an assigned routing language's proficiency
|
|
55180
55793
|
*
|
|
55181
55794
|
* @param {String} userId User ID
|
|
55182
55795
|
* @param {String} languageId languageId
|
|
@@ -55211,7 +55824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55211
55824
|
}
|
|
55212
55825
|
|
|
55213
55826
|
/**
|
|
55214
|
-
*
|
|
55827
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
55215
55828
|
*
|
|
55216
55829
|
* @param {String} userId User ID
|
|
55217
55830
|
* @param {Array.<Object>} body Language
|
|
@@ -55241,7 +55854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55241
55854
|
}
|
|
55242
55855
|
|
|
55243
55856
|
/**
|
|
55244
|
-
*
|
|
55857
|
+
* Assign multiple routing skills to a user
|
|
55245
55858
|
*
|
|
55246
55859
|
* @param {String} userId User ID
|
|
55247
55860
|
* @param {Array.<Object>} body Skill
|
|
@@ -55937,7 +56550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55937
56550
|
}
|
|
55938
56551
|
|
|
55939
56552
|
/**
|
|
55940
|
-
*
|
|
56553
|
+
* Assign a routing language to a user
|
|
55941
56554
|
*
|
|
55942
56555
|
* @param {String} userId User ID
|
|
55943
56556
|
* @param {Object} body Language
|
|
@@ -55967,7 +56580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55967
56580
|
}
|
|
55968
56581
|
|
|
55969
56582
|
/**
|
|
55970
|
-
*
|
|
56583
|
+
* Assign a routing skill to a user
|
|
55971
56584
|
*
|
|
55972
56585
|
* @param {String} userId User ID
|
|
55973
56586
|
* @param {Object} body Skill
|
|
@@ -56367,7 +56980,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56367
56980
|
}
|
|
56368
56981
|
|
|
56369
56982
|
/**
|
|
56370
|
-
* Update routing skill proficiency
|
|
56983
|
+
* Update an assigned routing skill's proficiency
|
|
56371
56984
|
*
|
|
56372
56985
|
* @param {String} userId User ID
|
|
56373
56986
|
* @param {String} skillId skillId
|
|
@@ -56402,7 +57015,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56402
57015
|
}
|
|
56403
57016
|
|
|
56404
57017
|
/**
|
|
56405
|
-
*
|
|
57018
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
56406
57019
|
*
|
|
56407
57020
|
* @param {String} userId User ID
|
|
56408
57021
|
* @param {Array.<Object>} body Skill
|
|
@@ -56437,7 +57050,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56437
57050
|
/**
|
|
56438
57051
|
* SCIM service.
|
|
56439
57052
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56440
|
-
* @version
|
|
57053
|
+
* @version 208.0.0
|
|
56441
57054
|
*/
|
|
56442
57055
|
|
|
56443
57056
|
/**
|
|
@@ -57314,7 +57927,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57314
57927
|
/**
|
|
57315
57928
|
* ScreenRecording service.
|
|
57316
57929
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57317
|
-
* @version
|
|
57930
|
+
* @version 208.0.0
|
|
57318
57931
|
*/
|
|
57319
57932
|
|
|
57320
57933
|
/**
|
|
@@ -57359,7 +57972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57359
57972
|
/**
|
|
57360
57973
|
* Scripts service.
|
|
57361
57974
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57362
|
-
* @version
|
|
57975
|
+
* @version 208.0.0
|
|
57363
57976
|
*/
|
|
57364
57977
|
|
|
57365
57978
|
/**
|
|
@@ -57803,7 +58416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57803
58416
|
/**
|
|
57804
58417
|
* Search service.
|
|
57805
58418
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
57806
|
-
* @version
|
|
58419
|
+
* @version 208.0.0
|
|
57807
58420
|
*/
|
|
57808
58421
|
|
|
57809
58422
|
/**
|
|
@@ -57986,6 +58599,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57986
58599
|
);
|
|
57987
58600
|
}
|
|
57988
58601
|
|
|
58602
|
+
/**
|
|
58603
|
+
* Search sites using the q64 value returned from a previous search
|
|
58604
|
+
*
|
|
58605
|
+
* @param {String} q64 q64
|
|
58606
|
+
* @param {Object} opts Optional parameters
|
|
58607
|
+
* @param {Array.<String>} opts.expand expand
|
|
58608
|
+
*/
|
|
58609
|
+
getTelephonyProvidersEdgesSitesSearch(q64, opts) {
|
|
58610
|
+
opts = opts || {};
|
|
58611
|
+
|
|
58612
|
+
// verify the required parameter 'q64' is set
|
|
58613
|
+
if (q64 === undefined || q64 === null) {
|
|
58614
|
+
throw 'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';
|
|
58615
|
+
}
|
|
58616
|
+
|
|
58617
|
+
return this.apiClient.callApi(
|
|
58618
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
58619
|
+
'GET',
|
|
58620
|
+
{ },
|
|
58621
|
+
{ 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
58622
|
+
{ },
|
|
58623
|
+
{ },
|
|
58624
|
+
null,
|
|
58625
|
+
['PureCloud OAuth'],
|
|
58626
|
+
['application/json'],
|
|
58627
|
+
['application/json']
|
|
58628
|
+
);
|
|
58629
|
+
}
|
|
58630
|
+
|
|
57989
58631
|
/**
|
|
57990
58632
|
* Search users using the q64 value returned from a previous search
|
|
57991
58633
|
*
|
|
@@ -58359,6 +59001,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58359
59001
|
);
|
|
58360
59002
|
}
|
|
58361
59003
|
|
|
59004
|
+
/**
|
|
59005
|
+
* Search sites
|
|
59006
|
+
*
|
|
59007
|
+
* @param {Object} body Search request options
|
|
59008
|
+
*/
|
|
59009
|
+
postTelephonyProvidersEdgesSitesSearch(body) {
|
|
59010
|
+
// verify the required parameter 'body' is set
|
|
59011
|
+
if (body === undefined || body === null) {
|
|
59012
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';
|
|
59013
|
+
}
|
|
59014
|
+
|
|
59015
|
+
return this.apiClient.callApi(
|
|
59016
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
59017
|
+
'POST',
|
|
59018
|
+
{ },
|
|
59019
|
+
{ },
|
|
59020
|
+
{ },
|
|
59021
|
+
{ },
|
|
59022
|
+
body,
|
|
59023
|
+
['PureCloud OAuth'],
|
|
59024
|
+
['application/json'],
|
|
59025
|
+
['application/json']
|
|
59026
|
+
);
|
|
59027
|
+
}
|
|
59028
|
+
|
|
58362
59029
|
/**
|
|
58363
59030
|
* Search users
|
|
58364
59031
|
*
|
|
@@ -58492,7 +59159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58492
59159
|
/**
|
|
58493
59160
|
* Settings service.
|
|
58494
59161
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
58495
|
-
* @version
|
|
59162
|
+
* @version 208.0.0
|
|
58496
59163
|
*/
|
|
58497
59164
|
|
|
58498
59165
|
/**
|
|
@@ -58712,7 +59379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58712
59379
|
/**
|
|
58713
59380
|
* SpeechTextAnalytics service.
|
|
58714
59381
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
58715
|
-
* @version
|
|
59382
|
+
* @version 208.0.0
|
|
58716
59383
|
*/
|
|
58717
59384
|
|
|
58718
59385
|
/**
|
|
@@ -59531,13 +60198,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59531
60198
|
}
|
|
59532
60199
|
|
|
59533
60200
|
/**
|
|
59534
|
-
* Translate
|
|
60201
|
+
* Translate a single interaction recording (or an email conversation)
|
|
59535
60202
|
*
|
|
59536
60203
|
* @param {String} languageId Target translation language
|
|
59537
60204
|
* @param {String} conversationId Conversation id
|
|
59538
60205
|
* @param {Object} opts Optional parameters
|
|
59539
|
-
* @param {String} opts.communicationId Communication id associated with the conversation
|
|
59540
|
-
* @param {String} opts.recordingId Recording id associated with the communication
|
|
60206
|
+
* @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
|
|
60207
|
+
* @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
|
|
59541
60208
|
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59542
60209
|
*/
|
|
59543
60210
|
getSpeechandtextanalyticsTranslationsLanguageConversation(languageId, conversationId, opts) {
|
|
@@ -60047,7 +60714,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60047
60714
|
/**
|
|
60048
60715
|
* Stations service.
|
|
60049
60716
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60050
|
-
* @version
|
|
60717
|
+
* @version 208.0.0
|
|
60051
60718
|
*/
|
|
60052
60719
|
|
|
60053
60720
|
/**
|
|
@@ -60149,7 +60816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60149
60816
|
/**
|
|
60150
60817
|
* Suggest service.
|
|
60151
60818
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60152
|
-
* @version
|
|
60819
|
+
* @version 208.0.0
|
|
60153
60820
|
*/
|
|
60154
60821
|
|
|
60155
60822
|
/**
|
|
@@ -60288,7 +60955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60288
60955
|
/**
|
|
60289
60956
|
* TaskManagement service.
|
|
60290
60957
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60291
|
-
* @version
|
|
60958
|
+
* @version 208.0.0
|
|
60292
60959
|
*/
|
|
60293
60960
|
|
|
60294
60961
|
/**
|
|
@@ -61952,7 +62619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61952
62619
|
/**
|
|
61953
62620
|
* Teams service.
|
|
61954
62621
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
61955
|
-
* @version
|
|
62622
|
+
* @version 208.0.0
|
|
61956
62623
|
*/
|
|
61957
62624
|
|
|
61958
62625
|
/**
|
|
@@ -62026,8 +62693,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62026
62693
|
* Get team
|
|
62027
62694
|
*
|
|
62028
62695
|
* @param {String} teamId Team ID
|
|
62696
|
+
* @param {Object} opts Optional parameters
|
|
62697
|
+
* @param {Object} opts.expand Expand the division name
|
|
62029
62698
|
*/
|
|
62030
|
-
getTeam(teamId) {
|
|
62699
|
+
getTeam(teamId, opts) {
|
|
62700
|
+
opts = opts || {};
|
|
62701
|
+
|
|
62031
62702
|
// verify the required parameter 'teamId' is set
|
|
62032
62703
|
if (teamId === undefined || teamId === null) {
|
|
62033
62704
|
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
@@ -62037,7 +62708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62037
62708
|
'/api/v2/teams/{teamId}',
|
|
62038
62709
|
'GET',
|
|
62039
62710
|
{ 'teamId': teamId },
|
|
62040
|
-
{
|
|
62711
|
+
{ 'expand': opts['expand'] },
|
|
62041
62712
|
{ },
|
|
62042
62713
|
{ },
|
|
62043
62714
|
null,
|
|
@@ -62253,7 +62924,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62253
62924
|
/**
|
|
62254
62925
|
* Telephony service.
|
|
62255
62926
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62256
|
-
* @version
|
|
62927
|
+
* @version 208.0.0
|
|
62257
62928
|
*/
|
|
62258
62929
|
|
|
62259
62930
|
/**
|
|
@@ -62435,7 +63106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62435
63106
|
/**
|
|
62436
63107
|
* TelephonyProvidersEdge service.
|
|
62437
63108
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
62438
|
-
* @version
|
|
63109
|
+
* @version 208.0.0
|
|
62439
63110
|
*/
|
|
62440
63111
|
|
|
62441
63112
|
/**
|
|
@@ -64412,6 +65083,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64412
65083
|
);
|
|
64413
65084
|
}
|
|
64414
65085
|
|
|
65086
|
+
/**
|
|
65087
|
+
* Search sites using the q64 value returned from a previous search
|
|
65088
|
+
*
|
|
65089
|
+
* @param {String} q64 q64
|
|
65090
|
+
* @param {Object} opts Optional parameters
|
|
65091
|
+
* @param {Array.<String>} opts.expand expand
|
|
65092
|
+
*/
|
|
65093
|
+
getTelephonyProvidersEdgesSitesSearch(q64, opts) {
|
|
65094
|
+
opts = opts || {};
|
|
65095
|
+
|
|
65096
|
+
// verify the required parameter 'q64' is set
|
|
65097
|
+
if (q64 === undefined || q64 === null) {
|
|
65098
|
+
throw 'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';
|
|
65099
|
+
}
|
|
65100
|
+
|
|
65101
|
+
return this.apiClient.callApi(
|
|
65102
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
65103
|
+
'GET',
|
|
65104
|
+
{ },
|
|
65105
|
+
{ 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
65106
|
+
{ },
|
|
65107
|
+
{ },
|
|
65108
|
+
null,
|
|
65109
|
+
['PureCloud OAuth'],
|
|
65110
|
+
['application/json'],
|
|
65111
|
+
['application/json']
|
|
65112
|
+
);
|
|
65113
|
+
}
|
|
65114
|
+
|
|
64415
65115
|
/**
|
|
64416
65116
|
* Get a list of Edge-compatible time zones
|
|
64417
65117
|
*
|
|
@@ -65341,6 +66041,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65341
66041
|
);
|
|
65342
66042
|
}
|
|
65343
66043
|
|
|
66044
|
+
/**
|
|
66045
|
+
* Search sites
|
|
66046
|
+
*
|
|
66047
|
+
* @param {Object} body Search request options
|
|
66048
|
+
*/
|
|
66049
|
+
postTelephonyProvidersEdgesSitesSearch(body) {
|
|
66050
|
+
// verify the required parameter 'body' is set
|
|
66051
|
+
if (body === undefined || body === null) {
|
|
66052
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';
|
|
66053
|
+
}
|
|
66054
|
+
|
|
66055
|
+
return this.apiClient.callApi(
|
|
66056
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
66057
|
+
'POST',
|
|
66058
|
+
{ },
|
|
66059
|
+
{ },
|
|
66060
|
+
{ },
|
|
66061
|
+
{ },
|
|
66062
|
+
body,
|
|
66063
|
+
['PureCloud OAuth'],
|
|
66064
|
+
['application/json'],
|
|
66065
|
+
['application/json']
|
|
66066
|
+
);
|
|
66067
|
+
}
|
|
66068
|
+
|
|
65344
66069
|
/**
|
|
65345
66070
|
* Create a Trunk Base Settings object
|
|
65346
66071
|
*
|
|
@@ -65832,7 +66557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65832
66557
|
/**
|
|
65833
66558
|
* Textbots service.
|
|
65834
66559
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
65835
|
-
* @version
|
|
66560
|
+
* @version 208.0.0
|
|
65836
66561
|
*/
|
|
65837
66562
|
|
|
65838
66563
|
/**
|
|
@@ -65960,7 +66685,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65960
66685
|
/**
|
|
65961
66686
|
* Tokens service.
|
|
65962
66687
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
65963
|
-
* @version
|
|
66688
|
+
* @version 208.0.0
|
|
65964
66689
|
*/
|
|
65965
66690
|
|
|
65966
66691
|
/**
|
|
@@ -66114,7 +66839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66114
66839
|
/**
|
|
66115
66840
|
* Uploads service.
|
|
66116
66841
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66117
|
-
* @version
|
|
66842
|
+
* @version 208.0.0
|
|
66118
66843
|
*/
|
|
66119
66844
|
|
|
66120
66845
|
/**
|
|
@@ -66383,7 +67108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66383
67108
|
/**
|
|
66384
67109
|
* Usage service.
|
|
66385
67110
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
66386
|
-
* @version
|
|
67111
|
+
* @version 208.0.0
|
|
66387
67112
|
*/
|
|
66388
67113
|
|
|
66389
67114
|
/**
|
|
@@ -66598,7 +67323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66598
67323
|
/**
|
|
66599
67324
|
* UserRecordings service.
|
|
66600
67325
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
66601
|
-
* @version
|
|
67326
|
+
* @version 208.0.0
|
|
66602
67327
|
*/
|
|
66603
67328
|
|
|
66604
67329
|
/**
|
|
@@ -66813,7 +67538,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66813
67538
|
/**
|
|
66814
67539
|
* Users service.
|
|
66815
67540
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
66816
|
-
* @version
|
|
67541
|
+
* @version 208.0.0
|
|
66817
67542
|
*/
|
|
66818
67543
|
|
|
66819
67544
|
/**
|
|
@@ -66984,7 +67709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66984
67709
|
}
|
|
66985
67710
|
|
|
66986
67711
|
/**
|
|
66987
|
-
* Remove routing language from user
|
|
67712
|
+
* Remove a routing language from a user
|
|
66988
67713
|
*
|
|
66989
67714
|
* @param {String} userId User ID
|
|
66990
67715
|
* @param {String} languageId languageId
|
|
@@ -67014,7 +67739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67014
67739
|
}
|
|
67015
67740
|
|
|
67016
67741
|
/**
|
|
67017
|
-
* Remove routing skill from user
|
|
67742
|
+
* Remove a routing skill from a user
|
|
67018
67743
|
*
|
|
67019
67744
|
* @param {String} userId User ID
|
|
67020
67745
|
* @param {String} skillId skillId
|
|
@@ -67846,7 +68571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67846
68571
|
}
|
|
67847
68572
|
|
|
67848
68573
|
/**
|
|
67849
|
-
* List routing
|
|
68574
|
+
* List routing languages assigned to a user
|
|
67850
68575
|
*
|
|
67851
68576
|
* @param {String} userId User ID
|
|
67852
68577
|
* @param {Object} opts Optional parameters
|
|
@@ -67877,7 +68602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67877
68602
|
}
|
|
67878
68603
|
|
|
67879
68604
|
/**
|
|
67880
|
-
* List routing skills
|
|
68605
|
+
* List routing skills assigned to a user
|
|
67881
68606
|
*
|
|
67882
68607
|
* @param {String} userId User ID
|
|
67883
68608
|
* @param {Object} opts Optional parameters
|
|
@@ -68128,6 +68853,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68128
68853
|
);
|
|
68129
68854
|
}
|
|
68130
68855
|
|
|
68856
|
+
/**
|
|
68857
|
+
* Get chats for a user
|
|
68858
|
+
*
|
|
68859
|
+
* @param {Object} opts Optional parameters
|
|
68860
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
68861
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
68862
|
+
* @param {String} opts.after The key to start after
|
|
68863
|
+
*/
|
|
68864
|
+
getUsersChatsMe(opts) {
|
|
68865
|
+
opts = opts || {};
|
|
68866
|
+
|
|
68867
|
+
|
|
68868
|
+
return this.apiClient.callApi(
|
|
68869
|
+
'/api/v2/users/chats/me',
|
|
68870
|
+
'GET',
|
|
68871
|
+
{ },
|
|
68872
|
+
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
|
|
68873
|
+
{ },
|
|
68874
|
+
{ },
|
|
68875
|
+
null,
|
|
68876
|
+
['PureCloud OAuth'],
|
|
68877
|
+
['application/json'],
|
|
68878
|
+
['application/json']
|
|
68879
|
+
);
|
|
68880
|
+
}
|
|
68881
|
+
|
|
68131
68882
|
/**
|
|
68132
68883
|
* Get list of Development Activities
|
|
68133
68884
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
@@ -68447,7 +69198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68447
69198
|
}
|
|
68448
69199
|
|
|
68449
69200
|
/**
|
|
68450
|
-
* Update routing language proficiency
|
|
69201
|
+
* Update an assigned routing language's proficiency
|
|
68451
69202
|
*
|
|
68452
69203
|
* @param {String} userId User ID
|
|
68453
69204
|
* @param {String} languageId languageId
|
|
@@ -68482,7 +69233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68482
69233
|
}
|
|
68483
69234
|
|
|
68484
69235
|
/**
|
|
68485
|
-
*
|
|
69236
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
68486
69237
|
*
|
|
68487
69238
|
* @param {String} userId User ID
|
|
68488
69239
|
* @param {Array.<Object>} body Language
|
|
@@ -68512,7 +69263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68512
69263
|
}
|
|
68513
69264
|
|
|
68514
69265
|
/**
|
|
68515
|
-
*
|
|
69266
|
+
* Assign multiple routing skills to a user
|
|
68516
69267
|
*
|
|
68517
69268
|
* @param {String} userId User ID
|
|
68518
69269
|
* @param {Array.<Object>} body Skill
|
|
@@ -68949,7 +69700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68949
69700
|
}
|
|
68950
69701
|
|
|
68951
69702
|
/**
|
|
68952
|
-
*
|
|
69703
|
+
* Assign a routing language to a user
|
|
68953
69704
|
*
|
|
68954
69705
|
* @param {String} userId User ID
|
|
68955
69706
|
* @param {Object} body Language
|
|
@@ -68979,7 +69730,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68979
69730
|
}
|
|
68980
69731
|
|
|
68981
69732
|
/**
|
|
68982
|
-
*
|
|
69733
|
+
* Assign a routing skill to a user
|
|
68983
69734
|
*
|
|
68984
69735
|
* @param {String} userId User ID
|
|
68985
69736
|
* @param {Object} body Skill
|
|
@@ -69391,7 +70142,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69391
70142
|
}
|
|
69392
70143
|
|
|
69393
70144
|
/**
|
|
69394
|
-
* Update routing skill proficiency
|
|
70145
|
+
* Update an assigned routing skill's proficiency
|
|
69395
70146
|
*
|
|
69396
70147
|
* @param {String} userId User ID
|
|
69397
70148
|
* @param {String} skillId skillId
|
|
@@ -69426,7 +70177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69426
70177
|
}
|
|
69427
70178
|
|
|
69428
70179
|
/**
|
|
69429
|
-
*
|
|
70180
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
69430
70181
|
*
|
|
69431
70182
|
* @param {String} userId User ID
|
|
69432
70183
|
* @param {Array.<Object>} body Skill
|
|
@@ -69616,7 +70367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69616
70367
|
/**
|
|
69617
70368
|
* Utilities service.
|
|
69618
70369
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
69619
|
-
* @version
|
|
70370
|
+
* @version 208.0.0
|
|
69620
70371
|
*/
|
|
69621
70372
|
|
|
69622
70373
|
/**
|
|
@@ -69727,7 +70478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69727
70478
|
/**
|
|
69728
70479
|
* Voicemail service.
|
|
69729
70480
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
69730
|
-
* @version
|
|
70481
|
+
* @version 208.0.0
|
|
69731
70482
|
*/
|
|
69732
70483
|
|
|
69733
70484
|
/**
|
|
@@ -70114,6 +70865,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70114
70865
|
);
|
|
70115
70866
|
}
|
|
70116
70867
|
|
|
70868
|
+
/**
|
|
70869
|
+
* Get a user's mailbox information
|
|
70870
|
+
*
|
|
70871
|
+
* @param {String} userId userId
|
|
70872
|
+
*/
|
|
70873
|
+
getVoicemailUserMailbox(userId) {
|
|
70874
|
+
// verify the required parameter 'userId' is set
|
|
70875
|
+
if (userId === undefined || userId === null) {
|
|
70876
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMailbox';
|
|
70877
|
+
}
|
|
70878
|
+
|
|
70879
|
+
return this.apiClient.callApi(
|
|
70880
|
+
'/api/v2/voicemail/users/{userId}/mailbox',
|
|
70881
|
+
'GET',
|
|
70882
|
+
{ 'userId': userId },
|
|
70883
|
+
{ },
|
|
70884
|
+
{ },
|
|
70885
|
+
{ },
|
|
70886
|
+
null,
|
|
70887
|
+
['PureCloud OAuth'],
|
|
70888
|
+
['application/json'],
|
|
70889
|
+
['application/json']
|
|
70890
|
+
);
|
|
70891
|
+
}
|
|
70892
|
+
|
|
70893
|
+
/**
|
|
70894
|
+
* List voicemail messages
|
|
70895
|
+
*
|
|
70896
|
+
* @param {String} userId User ID
|
|
70897
|
+
* @param {Object} opts Optional parameters
|
|
70898
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
70899
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
70900
|
+
*/
|
|
70901
|
+
getVoicemailUserMessages(userId, opts) {
|
|
70902
|
+
opts = opts || {};
|
|
70903
|
+
|
|
70904
|
+
// verify the required parameter 'userId' is set
|
|
70905
|
+
if (userId === undefined || userId === null) {
|
|
70906
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMessages';
|
|
70907
|
+
}
|
|
70908
|
+
|
|
70909
|
+
return this.apiClient.callApi(
|
|
70910
|
+
'/api/v2/voicemail/users/{userId}/messages',
|
|
70911
|
+
'GET',
|
|
70912
|
+
{ 'userId': userId },
|
|
70913
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
70914
|
+
{ },
|
|
70915
|
+
{ },
|
|
70916
|
+
null,
|
|
70917
|
+
['PureCloud OAuth'],
|
|
70918
|
+
['application/json'],
|
|
70919
|
+
['application/json']
|
|
70920
|
+
);
|
|
70921
|
+
}
|
|
70922
|
+
|
|
70117
70923
|
/**
|
|
70118
70924
|
* Get a user's voicemail policy
|
|
70119
70925
|
*
|
|
@@ -70394,7 +71200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70394
71200
|
/**
|
|
70395
71201
|
* WebChat service.
|
|
70396
71202
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
70397
|
-
* @version
|
|
71203
|
+
* @version 208.0.0
|
|
70398
71204
|
*/
|
|
70399
71205
|
|
|
70400
71206
|
/**
|
|
@@ -70945,7 +71751,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70945
71751
|
/**
|
|
70946
71752
|
* WebDeployments service.
|
|
70947
71753
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
70948
|
-
* @version
|
|
71754
|
+
* @version 208.0.0
|
|
70949
71755
|
*/
|
|
70950
71756
|
|
|
70951
71757
|
/**
|
|
@@ -71472,7 +72278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71472
72278
|
/**
|
|
71473
72279
|
* WebMessaging service.
|
|
71474
72280
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
71475
|
-
* @version
|
|
72281
|
+
* @version 208.0.0
|
|
71476
72282
|
*/
|
|
71477
72283
|
|
|
71478
72284
|
/**
|
|
@@ -71518,7 +72324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71518
72324
|
/**
|
|
71519
72325
|
* Widgets service.
|
|
71520
72326
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
71521
|
-
* @version
|
|
72327
|
+
* @version 208.0.0
|
|
71522
72328
|
*/
|
|
71523
72329
|
|
|
71524
72330
|
/**
|
|
@@ -71664,7 +72470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71664
72470
|
/**
|
|
71665
72471
|
* WorkforceManagement service.
|
|
71666
72472
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
71667
|
-
* @version
|
|
72473
|
+
* @version 208.0.0
|
|
71668
72474
|
*/
|
|
71669
72475
|
|
|
71670
72476
|
/**
|
|
@@ -78878,7 +79684,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78878
79684
|
* </pre>
|
|
78879
79685
|
* </p>
|
|
78880
79686
|
* @module purecloud-platform-client-v2/index
|
|
78881
|
-
* @version
|
|
79687
|
+
* @version 208.0.0
|
|
78882
79688
|
*/
|
|
78883
79689
|
class platformClient {
|
|
78884
79690
|
constructor() {
|