purecloud-platform-client-v2 206.0.0 → 207.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +100 -3
- package/dist/node/purecloud-platform-client-v2.js +675 -129
- package/dist/web-amd/purecloud-platform-client-v2.js +675 -129
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +236 -132
- package/dist/web-cjs/purecloud-platform-client-v2.js +236 -132
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +775 -270
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +7 -6
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +232 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -19
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +48 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -259,6 +259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
259
259
|
this.basePath;
|
|
260
260
|
this.authUrl;
|
|
261
261
|
this.config;
|
|
262
|
+
this.gateway = undefined;
|
|
262
263
|
this.logger = new Logger();
|
|
263
264
|
this.setEnvironment();
|
|
264
265
|
this.liveLoadConfig();
|
|
@@ -356,12 +357,72 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
356
357
|
: this.live_reload_config;
|
|
357
358
|
this.host = this.getConfigString('general', 'host') !== undefined ? this.getConfigString('general', 'host') : this.host;
|
|
358
359
|
|
|
360
|
+
if (this.getConfigString('gateway', 'host') !== undefined) {
|
|
361
|
+
let gateway = {
|
|
362
|
+
host: this.getConfigString('gateway', 'host')
|
|
363
|
+
};
|
|
364
|
+
if (this.getConfigString('gateway', 'protocol') !== undefined) gateway.protocol = this.getConfigString('gateway', 'protocol');
|
|
365
|
+
if (this.getConfigInt('gateway', 'port') !== undefined) gateway.port = this.getConfigInt('gateway', 'port');
|
|
366
|
+
if (this.getConfigString('gateway', 'path_params_login') !== undefined) gateway.path_params_login = this.getConfigString('gateway', 'path_params_login');
|
|
367
|
+
if (this.getConfigString('gateway', 'path_params_api') !== undefined) gateway.path_params_api = this.getConfigString('gateway', 'path_params_api');
|
|
368
|
+
if (this.getConfigString('gateway', 'username') !== undefined) gateway.username = this.getConfigString('gateway', 'username');
|
|
369
|
+
if (this.getConfigString('gateway', 'password') !== undefined) gateway.password = this.getConfigString('gateway', 'password');
|
|
370
|
+
this.setGateway(gateway);
|
|
371
|
+
} else {
|
|
372
|
+
this.setGateway();
|
|
373
|
+
}
|
|
374
|
+
|
|
359
375
|
this.setEnvironment();
|
|
360
376
|
|
|
361
377
|
// Update logging configs
|
|
362
378
|
this.logger.setLogger();
|
|
363
379
|
}
|
|
364
380
|
|
|
381
|
+
/**
|
|
382
|
+
* @description Sets the gateway used by the session
|
|
383
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
384
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
385
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
386
|
+
* @param {number} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater or equal to 0).
|
|
387
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
388
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
389
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
390
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
391
|
+
*/
|
|
392
|
+
setGateway(gateway) {
|
|
393
|
+
if (gateway) {
|
|
394
|
+
this.gateway = {
|
|
395
|
+
host: ''
|
|
396
|
+
};
|
|
397
|
+
|
|
398
|
+
if (gateway.protocol) this.gateway.protocol = gateway.protocol;
|
|
399
|
+
else this.gateway.protocol = 'https';
|
|
400
|
+
|
|
401
|
+
if (gateway.host) this.gateway.host = gateway.host;
|
|
402
|
+
else this.gateway.host = '';
|
|
403
|
+
|
|
404
|
+
if (gateway.port && gateway.port > -1) this.gateway.port = gateway.port;
|
|
405
|
+
else this.gateway.port = -1;
|
|
406
|
+
|
|
407
|
+
if (gateway.path_params_login) {
|
|
408
|
+
this.gateway.path_params_login = gateway.path_params_login;
|
|
409
|
+
// Strip trailing slash
|
|
410
|
+
this.gateway.path_params_login = this.gateway.path_params_login.replace(/\/+$/, '');
|
|
411
|
+
} else this.gateway.path_params_login = '';
|
|
412
|
+
|
|
413
|
+
if (gateway.path_params_api) {
|
|
414
|
+
this.gateway.path_params_api = gateway.path_params_api;
|
|
415
|
+
// Strip trailing slash
|
|
416
|
+
this.gateway.path_params_api = this.gateway.path_params_api.replace(/\/+$/, '');
|
|
417
|
+
} else this.gateway.path_params_api = '';
|
|
418
|
+
|
|
419
|
+
if (gateway.username) this.gateway.username = gateway.username;
|
|
420
|
+
if (gateway.password) this.gateway.password = gateway.password;
|
|
421
|
+
} else {
|
|
422
|
+
this.gateway = undefined;
|
|
423
|
+
}
|
|
424
|
+
}
|
|
425
|
+
|
|
365
426
|
setEnvironment(env) {
|
|
366
427
|
// Default value
|
|
367
428
|
if (env) this.environment = env;
|
|
@@ -379,6 +440,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
379
440
|
this.authUrl = `https://login.${this.environment}`;
|
|
380
441
|
}
|
|
381
442
|
|
|
443
|
+
getConfUrl(pathType, regionUrl) {
|
|
444
|
+
if (!this.gateway) return regionUrl;
|
|
445
|
+
if (!this.gateway.host) return regionUrl;
|
|
446
|
+
|
|
447
|
+
var url = this.gateway.protocol + '://' + this.gateway.host;
|
|
448
|
+
if (this.gateway.port > -1) url = url + ':' + this.gateway.port.toString();
|
|
449
|
+
if (pathType === 'login') {
|
|
450
|
+
if (this.gateway.path_params_login) {
|
|
451
|
+
if (this.gateway.path_params_login.startsWith('/')) url = url + this.gateway.path_params_login;
|
|
452
|
+
else url = url + '/' + this.gateway.path_params_login;
|
|
453
|
+
}
|
|
454
|
+
} else {
|
|
455
|
+
if (this.gateway.path_params_api) {
|
|
456
|
+
if (this.gateway.path_params_api.startsWith('/')) url = url + this.gateway.path_params_api;
|
|
457
|
+
else url = url + '/' + this.gateway.path_params_api;
|
|
458
|
+
}
|
|
459
|
+
}
|
|
460
|
+
return url;
|
|
461
|
+
}
|
|
462
|
+
|
|
382
463
|
getConfigString(section, key) {
|
|
383
464
|
if (this.config._sections[section]) return this.config._sections[section][key];
|
|
384
465
|
}
|
|
@@ -402,7 +483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
402
483
|
|
|
403
484
|
/**
|
|
404
485
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
486
|
+
* @version 207.0.0
|
|
406
487
|
*/
|
|
407
488
|
class ApiClient {
|
|
408
489
|
/**
|
|
@@ -600,6 +681,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
600
681
|
this.config.setEnvironment(environment);
|
|
601
682
|
}
|
|
602
683
|
|
|
684
|
+
/**
|
|
685
|
+
* @description Sets the gateway used by the session
|
|
686
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
687
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
688
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
689
|
+
* @param {string} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater than 0).
|
|
690
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
691
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
692
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
693
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
694
|
+
*/
|
|
695
|
+
setGateway(gateway) {
|
|
696
|
+
this.config.setGateway(gateway);
|
|
697
|
+
}
|
|
698
|
+
|
|
603
699
|
/**
|
|
604
700
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
605
701
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
@@ -664,6 +760,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
664
760
|
loginClientCredentialsGrant(clientId, clientSecret) {
|
|
665
761
|
this.clientId = clientId;
|
|
666
762
|
var authHeader = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
|
|
763
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
667
764
|
|
|
668
765
|
return new Promise((resolve, reject) => {
|
|
669
766
|
// Block browsers from using client credentials
|
|
@@ -676,7 +773,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
676
773
|
};
|
|
677
774
|
axios__default["default"]({
|
|
678
775
|
method: `POST`,
|
|
679
|
-
url:
|
|
776
|
+
url: `${loginBasePath}/oauth/token`,
|
|
680
777
|
headers: headers,
|
|
681
778
|
data: 'grant_type=client_credentials',
|
|
682
779
|
httpsAgent: this.proxyAgent
|
|
@@ -687,7 +784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
784
|
'trace',
|
|
688
785
|
response.status,
|
|
689
786
|
'POST',
|
|
690
|
-
|
|
787
|
+
`${loginBasePath}/oauth/token`,
|
|
691
788
|
headers,
|
|
692
789
|
response.headers,
|
|
693
790
|
{ grant_type: 'client_credentials' },
|
|
@@ -697,7 +794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
697
794
|
'debug',
|
|
698
795
|
response.status,
|
|
699
796
|
'POST',
|
|
700
|
-
|
|
797
|
+
`${loginBasePath}/oauth/token`,
|
|
701
798
|
headers,
|
|
702
799
|
undefined,
|
|
703
800
|
{ grant_type: 'client_credentials' },
|
|
@@ -721,7 +818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
721
818
|
'error',
|
|
722
819
|
error.response.status,
|
|
723
820
|
'POST',
|
|
724
|
-
|
|
821
|
+
`${loginBasePath}/oauth/token`,
|
|
725
822
|
headers,
|
|
726
823
|
error.response.headers,
|
|
727
824
|
{ grant_type: 'client_credentials' },
|
|
@@ -742,6 +839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
742
839
|
*/
|
|
743
840
|
loginSaml2BearerGrant(clientId, clientSecret, orgName, assertion) {
|
|
744
841
|
this.clientId = clientId;
|
|
842
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
745
843
|
return new Promise((resolve, reject) => {
|
|
746
844
|
if (typeof window !== 'undefined') {
|
|
747
845
|
reject(new Error('The saml2bearer grant is not supported in a browser.'));
|
|
@@ -767,7 +865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
767
865
|
'trace',
|
|
768
866
|
response.status,
|
|
769
867
|
'POST',
|
|
770
|
-
|
|
868
|
+
`${loginBasePath}/oauth/token`,
|
|
771
869
|
request.headers,
|
|
772
870
|
response.headers,
|
|
773
871
|
bodyParam,
|
|
@@ -777,7 +875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
777
875
|
'debug',
|
|
778
876
|
response.status,
|
|
779
877
|
'POST',
|
|
780
|
-
|
|
878
|
+
`${loginBasePath}/oauth/token`,
|
|
781
879
|
request.headers,
|
|
782
880
|
undefined,
|
|
783
881
|
bodyParam,
|
|
@@ -801,7 +899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
801
899
|
'error',
|
|
802
900
|
error.response.status,
|
|
803
901
|
'POST',
|
|
804
|
-
|
|
902
|
+
`${loginBasePath}/oauth/token`,
|
|
805
903
|
request.headers,
|
|
806
904
|
error.response.headers,
|
|
807
905
|
bodyParam,
|
|
@@ -822,10 +920,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
822
920
|
*/
|
|
823
921
|
authorizePKCEGrant(clientId, codeVerifier, authCode, redirectUri) {
|
|
824
922
|
this.clientId = clientId;
|
|
923
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
825
924
|
return new Promise((resolve, reject) => {
|
|
826
925
|
var request = axios__default["default"]({
|
|
827
926
|
method: `POST`,
|
|
828
|
-
url:
|
|
927
|
+
url: `${loginBasePath}/oauth/token`,
|
|
829
928
|
headers: {
|
|
830
929
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
831
930
|
},
|
|
@@ -852,7 +951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
852
951
|
'trace',
|
|
853
952
|
response.status,
|
|
854
953
|
'POST',
|
|
855
|
-
|
|
954
|
+
`${loginBasePath}/oauth/token`,
|
|
856
955
|
request.headers,
|
|
857
956
|
response.headers,
|
|
858
957
|
bodyParam,
|
|
@@ -862,7 +961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
862
961
|
'debug',
|
|
863
962
|
response.status,
|
|
864
963
|
'POST',
|
|
865
|
-
|
|
964
|
+
`${loginBasePath}/oauth/token`,
|
|
866
965
|
request.headers,
|
|
867
966
|
undefined,
|
|
868
967
|
bodyParam,
|
|
@@ -886,7 +985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
886
985
|
'error',
|
|
887
986
|
error.response.status,
|
|
888
987
|
'POST',
|
|
889
|
-
|
|
988
|
+
`${loginBasePath}/oauth/token`,
|
|
890
989
|
request.headers,
|
|
891
990
|
error.response.headers,
|
|
892
991
|
bodyParam,
|
|
@@ -1210,6 +1309,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1210
1309
|
* @param {function} reject - Promise reject callback
|
|
1211
1310
|
*/
|
|
1212
1311
|
_handleCodeAuthorizationResponse(request, bodyParam, resolve, reject) {
|
|
1312
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
1313
|
+
|
|
1213
1314
|
request
|
|
1214
1315
|
.then((response) => {
|
|
1215
1316
|
// Logging
|
|
@@ -1217,7 +1318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1217
1318
|
'trace',
|
|
1218
1319
|
response.status,
|
|
1219
1320
|
'POST',
|
|
1220
|
-
|
|
1321
|
+
`${loginBasePath}/oauth/token`,
|
|
1221
1322
|
request.headers,
|
|
1222
1323
|
response.headers,
|
|
1223
1324
|
bodyParam,
|
|
@@ -1227,7 +1328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1227
1328
|
'debug',
|
|
1228
1329
|
response.status,
|
|
1229
1330
|
'POST',
|
|
1230
|
-
|
|
1331
|
+
`${loginBasePath}/oauth/token`,
|
|
1231
1332
|
request.headers,
|
|
1232
1333
|
undefined,
|
|
1233
1334
|
bodyParam,
|
|
@@ -1253,7 +1354,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1253
1354
|
'error',
|
|
1254
1355
|
error.response.status,
|
|
1255
1356
|
'POST',
|
|
1256
|
-
|
|
1357
|
+
`${loginBasePath}/oauth/token`,
|
|
1257
1358
|
request.headers,
|
|
1258
1359
|
error.response.headers,
|
|
1259
1360
|
bodyParam,
|
|
@@ -1271,9 +1372,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1271
1372
|
* @param {object} data - data to url form encode
|
|
1272
1373
|
*/
|
|
1273
1374
|
_formAuthRequest(encodedData, data) {
|
|
1375
|
+
var loginBasePath = this.config.getConfUrl('login', `https://login.${this.config.environment}`);
|
|
1274
1376
|
var request = axios__default["default"]({
|
|
1275
1377
|
method: `POST`,
|
|
1276
|
-
url:
|
|
1378
|
+
url: `${loginBasePath}/oauth/token`,
|
|
1277
1379
|
headers: {
|
|
1278
1380
|
'Authorization': 'Basic ' + encodedData,
|
|
1279
1381
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
@@ -1462,7 +1564,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1462
1564
|
*/
|
|
1463
1565
|
_buildAuthUrl(path, query) {
|
|
1464
1566
|
if (!query) query = {};
|
|
1465
|
-
|
|
1567
|
+
var loginBasePath = this.config.getConfUrl('login', this.config.authUrl);
|
|
1568
|
+
return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
|
|
1466
1569
|
}
|
|
1467
1570
|
|
|
1468
1571
|
/**
|
|
@@ -1524,7 +1627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1524
1627
|
if (!path.match(/^\//)) {
|
|
1525
1628
|
path = `/${path}`;
|
|
1526
1629
|
}
|
|
1527
|
-
var url = this.config.basePath + path;
|
|
1630
|
+
var url = this.config.getConfUrl('api', this.config.basePath) + path;
|
|
1528
1631
|
url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
|
|
1529
1632
|
var value;
|
|
1530
1633
|
if (pathParams.hasOwnProperty(key)) {
|
|
@@ -1824,7 +1927,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1824
1927
|
/**
|
|
1825
1928
|
* AgentAssistants service.
|
|
1826
1929
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1827
|
-
* @version
|
|
1930
|
+
* @version 207.0.0
|
|
1828
1931
|
*/
|
|
1829
1932
|
|
|
1830
1933
|
/**
|
|
@@ -2200,7 +2303,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2200
2303
|
/**
|
|
2201
2304
|
* AgentCopilot service.
|
|
2202
2305
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2203
|
-
* @version
|
|
2306
|
+
* @version 207.0.0
|
|
2204
2307
|
*/
|
|
2205
2308
|
|
|
2206
2309
|
/**
|
|
@@ -2276,7 +2379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2276
2379
|
/**
|
|
2277
2380
|
* AgentUI service.
|
|
2278
2381
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2279
|
-
* @version
|
|
2382
|
+
* @version 207.0.0
|
|
2280
2383
|
*/
|
|
2281
2384
|
|
|
2282
2385
|
/**
|
|
@@ -2407,7 +2510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2407
2510
|
/**
|
|
2408
2511
|
* Alerting service.
|
|
2409
2512
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2410
|
-
* @version
|
|
2513
|
+
* @version 207.0.0
|
|
2411
2514
|
*/
|
|
2412
2515
|
|
|
2413
2516
|
/**
|
|
@@ -3068,7 +3171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3068
3171
|
/**
|
|
3069
3172
|
* Analytics service.
|
|
3070
3173
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3071
|
-
* @version
|
|
3174
|
+
* @version 207.0.0
|
|
3072
3175
|
*/
|
|
3073
3176
|
|
|
3074
3177
|
/**
|
|
@@ -3919,6 +4022,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3919
4022
|
* @param {Number} opts.pageSize (default to 25)
|
|
3920
4023
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
3921
4024
|
* @param {Object} opts.state Only list users of this state
|
|
4025
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
3922
4026
|
*/
|
|
3923
4027
|
getAnalyticsReportingDashboardsUsers(opts) {
|
|
3924
4028
|
opts = opts || {};
|
|
@@ -3928,7 +4032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3928
4032
|
'/api/v2/analytics/reporting/dashboards/users',
|
|
3929
4033
|
'GET',
|
|
3930
4034
|
{ },
|
|
3931
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
|
|
4035
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'],'deletedOnly': opts['deletedOnly'] },
|
|
3932
4036
|
{ },
|
|
3933
4037
|
{ },
|
|
3934
4038
|
null,
|
|
@@ -4050,6 +4154,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4050
4154
|
* @param {Number} opts.pageSize (default to 50)
|
|
4051
4155
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
4052
4156
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
4157
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
4053
4158
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
4054
4159
|
*/
|
|
4055
4160
|
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
@@ -4064,7 +4169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4064
4169
|
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
4065
4170
|
'GET',
|
|
4066
4171
|
{ 'userId': userId },
|
|
4067
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
|
|
4172
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'deletedOnly': opts['deletedOnly'],'name': opts['name'] },
|
|
4068
4173
|
{ },
|
|
4069
4174
|
{ },
|
|
4070
4175
|
null,
|
|
@@ -5154,7 +5259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5154
5259
|
}
|
|
5155
5260
|
|
|
5156
5261
|
/**
|
|
5157
|
-
* Bulk delete dashboards owned by other user(s)
|
|
5262
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
5158
5263
|
*
|
|
5159
5264
|
* @param {Array.<String>} body List of userIds
|
|
5160
5265
|
*/
|
|
@@ -5204,7 +5309,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5204
5309
|
}
|
|
5205
5310
|
|
|
5206
5311
|
/**
|
|
5207
|
-
* Bulk
|
|
5312
|
+
* Bulk soft delete dashboard configurations
|
|
5208
5313
|
*
|
|
5209
5314
|
* @param {Object} body
|
|
5210
5315
|
*/
|
|
@@ -5390,7 +5495,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5390
5495
|
* Query for task management aggregates
|
|
5391
5496
|
*
|
|
5392
5497
|
* @param {Object} body query
|
|
5393
|
-
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5394
5498
|
*/
|
|
5395
5499
|
postAnalyticsTaskmanagementAggregatesQuery(body) {
|
|
5396
5500
|
// verify the required parameter 'body' is set
|
|
@@ -5680,7 +5784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5680
5784
|
/**
|
|
5681
5785
|
* Architect service.
|
|
5682
5786
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5683
|
-
* @version
|
|
5787
|
+
* @version 207.0.0
|
|
5684
5788
|
*/
|
|
5685
5789
|
|
|
5686
5790
|
/**
|
|
@@ -7425,7 +7529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7425
7529
|
}
|
|
7426
7530
|
|
|
7427
7531
|
/**
|
|
7428
|
-
*
|
|
7532
|
+
* Get flow version configuration
|
|
7429
7533
|
*
|
|
7430
7534
|
* @param {String} flowId Flow ID
|
|
7431
7535
|
* @param {String} versionId Version ID
|
|
@@ -9802,7 +9906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9802
9906
|
/**
|
|
9803
9907
|
* Audit service.
|
|
9804
9908
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9805
|
-
* @version
|
|
9909
|
+
* @version 207.0.0
|
|
9806
9910
|
*/
|
|
9807
9911
|
|
|
9808
9912
|
/**
|
|
@@ -10003,7 +10107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10003
10107
|
/**
|
|
10004
10108
|
* Authorization service.
|
|
10005
10109
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10006
|
-
* @version
|
|
10110
|
+
* @version 207.0.0
|
|
10007
10111
|
*/
|
|
10008
10112
|
|
|
10009
10113
|
/**
|
|
@@ -11286,7 +11390,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11286
11390
|
/**
|
|
11287
11391
|
* Billing service.
|
|
11288
11392
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11289
|
-
* @version
|
|
11393
|
+
* @version 207.0.0
|
|
11290
11394
|
*/
|
|
11291
11395
|
|
|
11292
11396
|
/**
|
|
@@ -11366,7 +11470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11366
11470
|
/**
|
|
11367
11471
|
* CarrierServices service.
|
|
11368
11472
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11369
|
-
* @version
|
|
11473
|
+
* @version 207.0.0
|
|
11370
11474
|
*/
|
|
11371
11475
|
|
|
11372
11476
|
/**
|
|
@@ -11436,7 +11540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11436
11540
|
/**
|
|
11437
11541
|
* Chat service.
|
|
11438
11542
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11439
|
-
* @version
|
|
11543
|
+
* @version 207.0.0
|
|
11440
11544
|
*/
|
|
11441
11545
|
|
|
11442
11546
|
/**
|
|
@@ -12372,7 +12476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12372
12476
|
/**
|
|
12373
12477
|
* Coaching service.
|
|
12374
12478
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12375
|
-
* @version
|
|
12479
|
+
* @version 207.0.0
|
|
12376
12480
|
*/
|
|
12377
12481
|
|
|
12378
12482
|
/**
|
|
@@ -12949,7 +13053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12949
13053
|
/**
|
|
12950
13054
|
* ContentManagement service.
|
|
12951
13055
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12952
|
-
* @version
|
|
13056
|
+
* @version 207.0.0
|
|
12953
13057
|
*/
|
|
12954
13058
|
|
|
12955
13059
|
/**
|
|
@@ -13338,7 +13442,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13338
13442
|
* This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
|
|
13339
13443
|
* @param {String} sharedId Shared ID
|
|
13340
13444
|
* @param {Object} opts Optional parameters
|
|
13341
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
13342
13445
|
* @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
|
|
13343
13446
|
* @param {String} opts.contentType The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
|
|
13344
13447
|
* @param {Object} opts.expand Expand some document fields
|
|
@@ -13355,7 +13458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13355
13458
|
'/api/v2/contentmanagement/shared/{sharedId}',
|
|
13356
13459
|
'GET',
|
|
13357
13460
|
{ 'sharedId': sharedId },
|
|
13358
|
-
{ '
|
|
13461
|
+
{ 'disposition': opts['disposition'],'contentType': opts['contentType'],'expand': opts['expand'] },
|
|
13359
13462
|
{ },
|
|
13360
13463
|
{ },
|
|
13361
13464
|
null,
|
|
@@ -14031,7 +14134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14031
14134
|
/**
|
|
14032
14135
|
* Conversations service.
|
|
14033
14136
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14034
|
-
* @version
|
|
14137
|
+
* @version 207.0.0
|
|
14035
14138
|
*/
|
|
14036
14139
|
|
|
14037
14140
|
/**
|
|
@@ -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 207.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 207.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 207.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 207.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 207.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 207.0.0
|
|
21626
21730
|
*/
|
|
21627
21731
|
|
|
21628
21732
|
/**
|
|
@@ -21743,6 +21847,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21743
21847
|
);
|
|
21744
21848
|
}
|
|
21745
21849
|
|
|
21850
|
+
/**
|
|
21851
|
+
* Delete settings for CSV import
|
|
21852
|
+
*
|
|
21853
|
+
* @param {String} settingsId Settings id
|
|
21854
|
+
*/
|
|
21855
|
+
deleteExternalcontactsImportCsvSetting(settingsId) {
|
|
21856
|
+
// verify the required parameter 'settingsId' is set
|
|
21857
|
+
if (settingsId === undefined || settingsId === null) {
|
|
21858
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';
|
|
21859
|
+
}
|
|
21860
|
+
|
|
21861
|
+
return this.apiClient.callApi(
|
|
21862
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
21863
|
+
'DELETE',
|
|
21864
|
+
{ 'settingsId': settingsId },
|
|
21865
|
+
{ },
|
|
21866
|
+
{ },
|
|
21867
|
+
{ },
|
|
21868
|
+
null,
|
|
21869
|
+
['PureCloud OAuth'],
|
|
21870
|
+
['application/json'],
|
|
21871
|
+
['application/json']
|
|
21872
|
+
);
|
|
21873
|
+
}
|
|
21874
|
+
|
|
21746
21875
|
/**
|
|
21747
21876
|
* Delete an external organization
|
|
21748
21877
|
*
|
|
@@ -22210,6 +22339,107 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22210
22339
|
);
|
|
22211
22340
|
}
|
|
22212
22341
|
|
|
22342
|
+
/**
|
|
22343
|
+
* Get settings for CSV import
|
|
22344
|
+
*
|
|
22345
|
+
* @param {String} settingsId Settings id
|
|
22346
|
+
*/
|
|
22347
|
+
getExternalcontactsImportCsvSetting(settingsId) {
|
|
22348
|
+
// verify the required parameter 'settingsId' is set
|
|
22349
|
+
if (settingsId === undefined || settingsId === null) {
|
|
22350
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';
|
|
22351
|
+
}
|
|
22352
|
+
|
|
22353
|
+
return this.apiClient.callApi(
|
|
22354
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
22355
|
+
'GET',
|
|
22356
|
+
{ 'settingsId': settingsId },
|
|
22357
|
+
{ },
|
|
22358
|
+
{ },
|
|
22359
|
+
{ },
|
|
22360
|
+
null,
|
|
22361
|
+
['PureCloud OAuth'],
|
|
22362
|
+
['application/json'],
|
|
22363
|
+
['application/json']
|
|
22364
|
+
);
|
|
22365
|
+
}
|
|
22366
|
+
|
|
22367
|
+
/**
|
|
22368
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
22369
|
+
*
|
|
22370
|
+
* @param {Object} opts Optional parameters
|
|
22371
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22372
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22373
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
22374
|
+
*/
|
|
22375
|
+
getExternalcontactsImportCsvSettings(opts) {
|
|
22376
|
+
opts = opts || {};
|
|
22377
|
+
|
|
22378
|
+
|
|
22379
|
+
return this.apiClient.callApi(
|
|
22380
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
22381
|
+
'GET',
|
|
22382
|
+
{ },
|
|
22383
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'externalSettingsId': opts['externalSettingsId'] },
|
|
22384
|
+
{ },
|
|
22385
|
+
{ },
|
|
22386
|
+
null,
|
|
22387
|
+
['PureCloud OAuth'],
|
|
22388
|
+
['application/json'],
|
|
22389
|
+
['application/json']
|
|
22390
|
+
);
|
|
22391
|
+
}
|
|
22392
|
+
|
|
22393
|
+
/**
|
|
22394
|
+
* Get details for CSV upload
|
|
22395
|
+
*
|
|
22396
|
+
* @param {String} uploadId Upload id
|
|
22397
|
+
*/
|
|
22398
|
+
getExternalcontactsImportCsvUploadDetails(uploadId) {
|
|
22399
|
+
// verify the required parameter 'uploadId' is set
|
|
22400
|
+
if (uploadId === undefined || uploadId === null) {
|
|
22401
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';
|
|
22402
|
+
}
|
|
22403
|
+
|
|
22404
|
+
return this.apiClient.callApi(
|
|
22405
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details',
|
|
22406
|
+
'GET',
|
|
22407
|
+
{ 'uploadId': uploadId },
|
|
22408
|
+
{ },
|
|
22409
|
+
{ },
|
|
22410
|
+
{ },
|
|
22411
|
+
null,
|
|
22412
|
+
['PureCloud OAuth'],
|
|
22413
|
+
['application/json'],
|
|
22414
|
+
['application/json']
|
|
22415
|
+
);
|
|
22416
|
+
}
|
|
22417
|
+
|
|
22418
|
+
/**
|
|
22419
|
+
* Get preview for CSV upload
|
|
22420
|
+
*
|
|
22421
|
+
* @param {String} uploadId Upload id
|
|
22422
|
+
*/
|
|
22423
|
+
getExternalcontactsImportCsvUploadPreview(uploadId) {
|
|
22424
|
+
// verify the required parameter 'uploadId' is set
|
|
22425
|
+
if (uploadId === undefined || uploadId === null) {
|
|
22426
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';
|
|
22427
|
+
}
|
|
22428
|
+
|
|
22429
|
+
return this.apiClient.callApi(
|
|
22430
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview',
|
|
22431
|
+
'GET',
|
|
22432
|
+
{ 'uploadId': uploadId },
|
|
22433
|
+
{ },
|
|
22434
|
+
{ },
|
|
22435
|
+
{ },
|
|
22436
|
+
null,
|
|
22437
|
+
['PureCloud OAuth'],
|
|
22438
|
+
['application/json'],
|
|
22439
|
+
['application/json']
|
|
22440
|
+
);
|
|
22441
|
+
}
|
|
22442
|
+
|
|
22213
22443
|
/**
|
|
22214
22444
|
* Fetch an external organization
|
|
22215
22445
|
*
|
|
@@ -23274,6 +23504,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23274
23504
|
);
|
|
23275
23505
|
}
|
|
23276
23506
|
|
|
23507
|
+
/**
|
|
23508
|
+
* Create CSV import job
|
|
23509
|
+
*
|
|
23510
|
+
* @param {Object} body ImportRequest
|
|
23511
|
+
*/
|
|
23512
|
+
postExternalcontactsImportCsvJobs(body) {
|
|
23513
|
+
// verify the required parameter 'body' is set
|
|
23514
|
+
if (body === undefined || body === null) {
|
|
23515
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';
|
|
23516
|
+
}
|
|
23517
|
+
|
|
23518
|
+
return this.apiClient.callApi(
|
|
23519
|
+
'/api/v2/externalcontacts/import/csv/jobs',
|
|
23520
|
+
'POST',
|
|
23521
|
+
{ },
|
|
23522
|
+
{ },
|
|
23523
|
+
{ },
|
|
23524
|
+
{ },
|
|
23525
|
+
body,
|
|
23526
|
+
['PureCloud OAuth'],
|
|
23527
|
+
['application/json'],
|
|
23528
|
+
['application/json']
|
|
23529
|
+
);
|
|
23530
|
+
}
|
|
23531
|
+
|
|
23532
|
+
/**
|
|
23533
|
+
* Create settings for CSV import
|
|
23534
|
+
*
|
|
23535
|
+
* @param {Object} body Settings
|
|
23536
|
+
*/
|
|
23537
|
+
postExternalcontactsImportCsvSettings(body) {
|
|
23538
|
+
// verify the required parameter 'body' is set
|
|
23539
|
+
if (body === undefined || body === null) {
|
|
23540
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';
|
|
23541
|
+
}
|
|
23542
|
+
|
|
23543
|
+
return this.apiClient.callApi(
|
|
23544
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
23545
|
+
'POST',
|
|
23546
|
+
{ },
|
|
23547
|
+
{ },
|
|
23548
|
+
{ },
|
|
23549
|
+
{ },
|
|
23550
|
+
body,
|
|
23551
|
+
['PureCloud OAuth'],
|
|
23552
|
+
['application/json'],
|
|
23553
|
+
['application/json']
|
|
23554
|
+
);
|
|
23555
|
+
}
|
|
23556
|
+
|
|
23557
|
+
/**
|
|
23558
|
+
* Get url for CSV upload
|
|
23559
|
+
*
|
|
23560
|
+
* @param {Object} body UploadRequest
|
|
23561
|
+
*/
|
|
23562
|
+
postExternalcontactsImportCsvUploads(body) {
|
|
23563
|
+
// verify the required parameter 'body' is set
|
|
23564
|
+
if (body === undefined || body === null) {
|
|
23565
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';
|
|
23566
|
+
}
|
|
23567
|
+
|
|
23568
|
+
return this.apiClient.callApi(
|
|
23569
|
+
'/api/v2/externalcontacts/import/csv/uploads',
|
|
23570
|
+
'POST',
|
|
23571
|
+
{ },
|
|
23572
|
+
{ },
|
|
23573
|
+
{ },
|
|
23574
|
+
{ },
|
|
23575
|
+
body,
|
|
23576
|
+
['PureCloud OAuth'],
|
|
23577
|
+
['application/json'],
|
|
23578
|
+
['application/json']
|
|
23579
|
+
);
|
|
23580
|
+
}
|
|
23581
|
+
|
|
23277
23582
|
/**
|
|
23278
23583
|
* Merge two contacts into a new contact record
|
|
23279
23584
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -23560,6 +23865,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23560
23865
|
);
|
|
23561
23866
|
}
|
|
23562
23867
|
|
|
23868
|
+
/**
|
|
23869
|
+
* Update settings for CSV import
|
|
23870
|
+
*
|
|
23871
|
+
* @param {String} settingsId Settings id
|
|
23872
|
+
* @param {Object} body Settings
|
|
23873
|
+
*/
|
|
23874
|
+
putExternalcontactsImportCsvSetting(settingsId, body) {
|
|
23875
|
+
// verify the required parameter 'settingsId' is set
|
|
23876
|
+
if (settingsId === undefined || settingsId === null) {
|
|
23877
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';
|
|
23878
|
+
}
|
|
23879
|
+
// verify the required parameter 'body' is set
|
|
23880
|
+
if (body === undefined || body === null) {
|
|
23881
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';
|
|
23882
|
+
}
|
|
23883
|
+
|
|
23884
|
+
return this.apiClient.callApi(
|
|
23885
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
23886
|
+
'PUT',
|
|
23887
|
+
{ 'settingsId': settingsId },
|
|
23888
|
+
{ },
|
|
23889
|
+
{ },
|
|
23890
|
+
{ },
|
|
23891
|
+
body,
|
|
23892
|
+
['PureCloud OAuth'],
|
|
23893
|
+
['application/json'],
|
|
23894
|
+
['application/json']
|
|
23895
|
+
);
|
|
23896
|
+
}
|
|
23897
|
+
|
|
23563
23898
|
/**
|
|
23564
23899
|
* Update an external organization
|
|
23565
23900
|
*
|
|
@@ -23721,7 +24056,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23721
24056
|
/**
|
|
23722
24057
|
* Fax service.
|
|
23723
24058
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23724
|
-
* @version
|
|
24059
|
+
* @version 207.0.0
|
|
23725
24060
|
*/
|
|
23726
24061
|
|
|
23727
24062
|
/**
|
|
@@ -23936,7 +24271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23936
24271
|
/**
|
|
23937
24272
|
* Flows service.
|
|
23938
24273
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23939
|
-
* @version
|
|
24274
|
+
* @version 207.0.0
|
|
23940
24275
|
*/
|
|
23941
24276
|
|
|
23942
24277
|
/**
|
|
@@ -24119,7 +24454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24119
24454
|
/**
|
|
24120
24455
|
* Gamification service.
|
|
24121
24456
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24122
|
-
* @version
|
|
24457
|
+
* @version 207.0.0
|
|
24123
24458
|
*/
|
|
24124
24459
|
|
|
24125
24460
|
/**
|
|
@@ -26205,7 +26540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26205
26540
|
/**
|
|
26206
26541
|
* GeneralDataProtectionRegulation service.
|
|
26207
26542
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26208
|
-
* @version
|
|
26543
|
+
* @version 207.0.0
|
|
26209
26544
|
*/
|
|
26210
26545
|
|
|
26211
26546
|
/**
|
|
@@ -26335,7 +26670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26335
26670
|
/**
|
|
26336
26671
|
* Geolocation service.
|
|
26337
26672
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26338
|
-
* @version
|
|
26673
|
+
* @version 207.0.0
|
|
26339
26674
|
*/
|
|
26340
26675
|
|
|
26341
26676
|
/**
|
|
@@ -26466,7 +26801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26466
26801
|
/**
|
|
26467
26802
|
* Greetings service.
|
|
26468
26803
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26469
|
-
* @version
|
|
26804
|
+
* @version 207.0.0
|
|
26470
26805
|
*/
|
|
26471
26806
|
|
|
26472
26807
|
/**
|
|
@@ -26921,7 +27256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26921
27256
|
/**
|
|
26922
27257
|
* Groups service.
|
|
26923
27258
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26924
|
-
* @version
|
|
27259
|
+
* @version 207.0.0
|
|
26925
27260
|
*/
|
|
26926
27261
|
|
|
26927
27262
|
/**
|
|
@@ -27440,7 +27775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27440
27775
|
/**
|
|
27441
27776
|
* IdentityProvider service.
|
|
27442
27777
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27443
|
-
* @version
|
|
27778
|
+
* @version 207.0.0
|
|
27444
27779
|
*/
|
|
27445
27780
|
|
|
27446
27781
|
/**
|
|
@@ -28301,7 +28636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28301
28636
|
/**
|
|
28302
28637
|
* InfrastructureAsCode service.
|
|
28303
28638
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28304
|
-
* @version
|
|
28639
|
+
* @version 207.0.0
|
|
28305
28640
|
*/
|
|
28306
28641
|
|
|
28307
28642
|
/**
|
|
@@ -28468,7 +28803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28468
28803
|
/**
|
|
28469
28804
|
* Integrations service.
|
|
28470
28805
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28471
|
-
* @version
|
|
28806
|
+
* @version 207.0.0
|
|
28472
28807
|
*/
|
|
28473
28808
|
|
|
28474
28809
|
/**
|
|
@@ -30890,7 +31225,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30890
31225
|
/**
|
|
30891
31226
|
* Journey service.
|
|
30892
31227
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30893
|
-
* @version
|
|
31228
|
+
* @version 207.0.0
|
|
30894
31229
|
*/
|
|
30895
31230
|
|
|
30896
31231
|
/**
|
|
@@ -31984,7 +32319,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31984
32319
|
* Get an Event Definition
|
|
31985
32320
|
*
|
|
31986
32321
|
* @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
32322
|
*/
|
|
31989
32323
|
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
31990
32324
|
// verify the required parameter 'eventDefinitionId' is set
|
|
@@ -32009,7 +32343,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32009
32343
|
/**
|
|
32010
32344
|
* Get a list of Event Definitions
|
|
32011
32345
|
*
|
|
32012
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32013
32346
|
*/
|
|
32014
32347
|
getJourneyViewsEventdefinitions() {
|
|
32015
32348
|
|
|
@@ -32662,7 +32995,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32662
32995
|
* True indicates a valid encoding
|
|
32663
32996
|
* @param {Object} opts Optional parameters
|
|
32664
32997
|
* @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
32998
|
*/
|
|
32667
32999
|
postJourneyViewsEncodingsValidate(opts) {
|
|
32668
33000
|
opts = opts || {};
|
|
@@ -32723,7 +33055,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32723
33055
|
/**
|
|
32724
33056
|
* Knowledge service.
|
|
32725
33057
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
32726
|
-
* @version
|
|
33058
|
+
* @version 207.0.0
|
|
32727
33059
|
*/
|
|
32728
33060
|
|
|
32729
33061
|
/**
|
|
@@ -33061,7 +33393,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33061
33393
|
*
|
|
33062
33394
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33063
33395
|
* @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
33396
|
*/
|
|
33066
33397
|
deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId) {
|
|
33067
33398
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33092,7 +33423,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33092
33423
|
*
|
|
33093
33424
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33094
33425
|
* @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
33426
|
*/
|
|
33097
33427
|
deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId) {
|
|
33098
33428
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33123,7 +33453,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33123
33453
|
*
|
|
33124
33454
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33125
33455
|
* @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
33456
|
*/
|
|
33128
33457
|
deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
33129
33458
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -33250,7 +33579,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33250
33579
|
* Get sync options available for a knowledge-connect integration
|
|
33251
33580
|
*
|
|
33252
33581
|
* @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
33582
|
*/
|
|
33255
33583
|
getKnowledgeIntegrationOptions(integrationId) {
|
|
33256
33584
|
// verify the required parameter 'integrationId' is set
|
|
@@ -34197,7 +34525,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34197
34525
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
34198
34526
|
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
34199
34527
|
* @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
34528
|
*/
|
|
34202
34529
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
34203
34530
|
opts = opts || {};
|
|
@@ -34225,7 +34552,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34225
34552
|
* Get ids of operation creator users and oauth clients
|
|
34226
34553
|
*
|
|
34227
34554
|
* @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
34555
|
*/
|
|
34230
34556
|
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
34231
34557
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -34290,7 +34616,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34290
34616
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
34291
34617
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
34292
34618
|
* @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
34619
|
*/
|
|
34295
34620
|
getKnowledgeKnowledgebaseSources(knowledgeBaseId, opts) {
|
|
34296
34621
|
opts = opts || {};
|
|
@@ -34321,7 +34646,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34321
34646
|
* @param {String} sourceId Source ID
|
|
34322
34647
|
* @param {Object} opts Optional parameters
|
|
34323
34648
|
* @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
34649
|
*/
|
|
34326
34650
|
getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34327
34651
|
opts = opts || {};
|
|
@@ -34356,7 +34680,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34356
34680
|
* @param {String} sourceId Source ID
|
|
34357
34681
|
* @param {Object} opts Optional parameters
|
|
34358
34682
|
* @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
34683
|
*/
|
|
34361
34684
|
getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, opts) {
|
|
34362
34685
|
opts = opts || {};
|
|
@@ -34389,7 +34712,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34389
34712
|
*
|
|
34390
34713
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
34391
34714
|
* @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
34715
|
*/
|
|
34394
34716
|
getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
34395
34717
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -35105,7 +35427,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35105
35427
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
35106
35428
|
* @param {String} syncJobId Synchronization job ID
|
|
35107
35429
|
* @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
35430
|
*/
|
|
35110
35431
|
patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId, body) {
|
|
35111
35432
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36327,7 +36648,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36327
36648
|
*
|
|
36328
36649
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36329
36650
|
* @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
36651
|
*/
|
|
36332
36652
|
postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId, body) {
|
|
36333
36653
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36358,7 +36678,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36358
36678
|
*
|
|
36359
36679
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36360
36680
|
* @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
36681
|
*/
|
|
36363
36682
|
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36364
36683
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36389,7 +36708,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36389
36708
|
*
|
|
36390
36709
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36391
36710
|
* @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
36711
|
*/
|
|
36394
36712
|
postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId, body) {
|
|
36395
36713
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36420,7 +36738,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36420
36738
|
*
|
|
36421
36739
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36422
36740
|
* @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
36741
|
*/
|
|
36425
36742
|
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
36426
36743
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36451,7 +36768,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36451
36768
|
*
|
|
36452
36769
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36453
36770
|
* @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
36771
|
*/
|
|
36456
36772
|
postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId, body) {
|
|
36457
36773
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36539,7 +36855,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36539
36855
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36540
36856
|
* @param {String} sourceId Source ID
|
|
36541
36857
|
* @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
36858
|
*/
|
|
36544
36859
|
putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, body) {
|
|
36545
36860
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36575,7 +36890,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36575
36890
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36576
36891
|
* @param {String} sourceId Source ID
|
|
36577
36892
|
* @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
36893
|
*/
|
|
36580
36894
|
putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, body) {
|
|
36581
36895
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36611,7 +36925,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36611
36925
|
/**
|
|
36612
36926
|
* LanguageUnderstanding service.
|
|
36613
36927
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
36614
|
-
* @version
|
|
36928
|
+
* @version 207.0.0
|
|
36615
36929
|
*/
|
|
36616
36930
|
|
|
36617
36931
|
/**
|
|
@@ -37645,7 +37959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37645
37959
|
/**
|
|
37646
37960
|
* Languages service.
|
|
37647
37961
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
37648
|
-
* @version
|
|
37962
|
+
* @version 207.0.0
|
|
37649
37963
|
*/
|
|
37650
37964
|
|
|
37651
37965
|
/**
|
|
@@ -37867,7 +38181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37867
38181
|
/**
|
|
37868
38182
|
* Learning service.
|
|
37869
38183
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
37870
|
-
* @version
|
|
38184
|
+
* @version 207.0.0
|
|
37871
38185
|
*/
|
|
37872
38186
|
|
|
37873
38187
|
/**
|
|
@@ -38896,7 +39210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38896
39210
|
/**
|
|
38897
39211
|
* License service.
|
|
38898
39212
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
38899
|
-
* @version
|
|
39213
|
+
* @version 207.0.0
|
|
38900
39214
|
*/
|
|
38901
39215
|
|
|
38902
39216
|
/**
|
|
@@ -39134,7 +39448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39134
39448
|
/**
|
|
39135
39449
|
* Locations service.
|
|
39136
39450
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39137
|
-
* @version
|
|
39451
|
+
* @version 207.0.0
|
|
39138
39452
|
*/
|
|
39139
39453
|
|
|
39140
39454
|
/**
|
|
@@ -39370,7 +39684,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39370
39684
|
/**
|
|
39371
39685
|
* LogCapture service.
|
|
39372
39686
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39373
|
-
* @version
|
|
39687
|
+
* @version 207.0.0
|
|
39374
39688
|
*/
|
|
39375
39689
|
|
|
39376
39690
|
/**
|
|
@@ -39570,7 +39884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39570
39884
|
/**
|
|
39571
39885
|
* Messaging service.
|
|
39572
39886
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
39573
|
-
* @version
|
|
39887
|
+
* @version 207.0.0
|
|
39574
39888
|
*/
|
|
39575
39889
|
|
|
39576
39890
|
/**
|
|
@@ -39929,7 +40243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39929
40243
|
/**
|
|
39930
40244
|
* MobileDevices service.
|
|
39931
40245
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
39932
|
-
* @version
|
|
40246
|
+
* @version 207.0.0
|
|
39933
40247
|
*/
|
|
39934
40248
|
|
|
39935
40249
|
/**
|
|
@@ -40080,7 +40394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40080
40394
|
/**
|
|
40081
40395
|
* Notifications service.
|
|
40082
40396
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40083
|
-
* @version
|
|
40397
|
+
* @version 207.0.0
|
|
40084
40398
|
*/
|
|
40085
40399
|
|
|
40086
40400
|
/**
|
|
@@ -40313,7 +40627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40313
40627
|
/**
|
|
40314
40628
|
* OAuth service.
|
|
40315
40629
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40316
|
-
* @version
|
|
40630
|
+
* @version 207.0.0
|
|
40317
40631
|
*/
|
|
40318
40632
|
|
|
40319
40633
|
/**
|
|
@@ -40679,7 +40993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40679
40993
|
/**
|
|
40680
40994
|
* Objects service.
|
|
40681
40995
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
40682
|
-
* @version
|
|
40996
|
+
* @version 207.0.0
|
|
40683
40997
|
*/
|
|
40684
40998
|
|
|
40685
40999
|
/**
|
|
@@ -40949,7 +41263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40949
41263
|
/**
|
|
40950
41264
|
* OperationalEvents service.
|
|
40951
41265
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
40952
|
-
* @version
|
|
41266
|
+
* @version 207.0.0
|
|
40953
41267
|
*/
|
|
40954
41268
|
|
|
40955
41269
|
/**
|
|
@@ -41015,7 +41329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41015
41329
|
/**
|
|
41016
41330
|
* Organization service.
|
|
41017
41331
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41018
|
-
* @version
|
|
41332
|
+
* @version 207.0.0
|
|
41019
41333
|
*/
|
|
41020
41334
|
|
|
41021
41335
|
/**
|
|
@@ -41557,7 +41871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41557
41871
|
/**
|
|
41558
41872
|
* OrganizationAuthorization service.
|
|
41559
41873
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
41560
|
-
* @version
|
|
41874
|
+
* @version 207.0.0
|
|
41561
41875
|
*/
|
|
41562
41876
|
|
|
41563
41877
|
/**
|
|
@@ -42194,6 +42508,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42194
42508
|
);
|
|
42195
42509
|
}
|
|
42196
42510
|
|
|
42511
|
+
/**
|
|
42512
|
+
* Get Customer Care organization ids.
|
|
42513
|
+
*
|
|
42514
|
+
*/
|
|
42515
|
+
getOrgauthorizationTrusteesCare() {
|
|
42516
|
+
|
|
42517
|
+
return this.apiClient.callApi(
|
|
42518
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
42519
|
+
'GET',
|
|
42520
|
+
{ },
|
|
42521
|
+
{ },
|
|
42522
|
+
{ },
|
|
42523
|
+
{ },
|
|
42524
|
+
null,
|
|
42525
|
+
['PureCloud OAuth'],
|
|
42526
|
+
['application/json'],
|
|
42527
|
+
['application/json']
|
|
42528
|
+
);
|
|
42529
|
+
}
|
|
42530
|
+
|
|
42197
42531
|
/**
|
|
42198
42532
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
42199
42533
|
*
|
|
@@ -42581,6 +42915,33 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42581
42915
|
);
|
|
42582
42916
|
}
|
|
42583
42917
|
|
|
42918
|
+
/**
|
|
42919
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
42920
|
+
*
|
|
42921
|
+
* @param {Object} opts Optional parameters
|
|
42922
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
42923
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
42924
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
42925
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
42926
|
+
*/
|
|
42927
|
+
postOrgauthorizationTrusteesCare(opts) {
|
|
42928
|
+
opts = opts || {};
|
|
42929
|
+
|
|
42930
|
+
|
|
42931
|
+
return this.apiClient.callApi(
|
|
42932
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
42933
|
+
'POST',
|
|
42934
|
+
{ },
|
|
42935
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'],'assignFullAccess': opts['assignFullAccess'],'allowTrustedUserAccess': opts['allowTrustedUserAccess'] },
|
|
42936
|
+
{ },
|
|
42937
|
+
{ },
|
|
42938
|
+
null,
|
|
42939
|
+
['PureCloud OAuth'],
|
|
42940
|
+
['application/json'],
|
|
42941
|
+
['application/json']
|
|
42942
|
+
);
|
|
42943
|
+
}
|
|
42944
|
+
|
|
42584
42945
|
/**
|
|
42585
42946
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
42586
42947
|
*
|
|
@@ -42904,7 +43265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42904
43265
|
/**
|
|
42905
43266
|
* Outbound service.
|
|
42906
43267
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
42907
|
-
* @version
|
|
43268
|
+
* @version 207.0.0
|
|
42908
43269
|
*/
|
|
42909
43270
|
|
|
42910
43271
|
/**
|
|
@@ -45881,6 +46242,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45881
46242
|
);
|
|
45882
46243
|
}
|
|
45883
46244
|
|
|
46245
|
+
/**
|
|
46246
|
+
* Start the campaign
|
|
46247
|
+
*
|
|
46248
|
+
* @param {String} campaignId Campaign ID
|
|
46249
|
+
*/
|
|
46250
|
+
postOutboundCampaignStart(campaignId) {
|
|
46251
|
+
// verify the required parameter 'campaignId' is set
|
|
46252
|
+
if (campaignId === undefined || campaignId === null) {
|
|
46253
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';
|
|
46254
|
+
}
|
|
46255
|
+
|
|
46256
|
+
return this.apiClient.callApi(
|
|
46257
|
+
'/api/v2/outbound/campaigns/{campaignId}/start',
|
|
46258
|
+
'POST',
|
|
46259
|
+
{ 'campaignId': campaignId },
|
|
46260
|
+
{ },
|
|
46261
|
+
{ },
|
|
46262
|
+
{ },
|
|
46263
|
+
null,
|
|
46264
|
+
['PureCloud OAuth'],
|
|
46265
|
+
['application/json'],
|
|
46266
|
+
['application/json']
|
|
46267
|
+
);
|
|
46268
|
+
}
|
|
46269
|
+
|
|
46270
|
+
/**
|
|
46271
|
+
* Stop the campaign
|
|
46272
|
+
*
|
|
46273
|
+
* @param {String} campaignId Campaign ID
|
|
46274
|
+
*/
|
|
46275
|
+
postOutboundCampaignStop(campaignId) {
|
|
46276
|
+
// verify the required parameter 'campaignId' is set
|
|
46277
|
+
if (campaignId === undefined || campaignId === null) {
|
|
46278
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';
|
|
46279
|
+
}
|
|
46280
|
+
|
|
46281
|
+
return this.apiClient.callApi(
|
|
46282
|
+
'/api/v2/outbound/campaigns/{campaignId}/stop',
|
|
46283
|
+
'POST',
|
|
46284
|
+
{ 'campaignId': campaignId },
|
|
46285
|
+
{ },
|
|
46286
|
+
{ },
|
|
46287
|
+
{ },
|
|
46288
|
+
null,
|
|
46289
|
+
['PureCloud OAuth'],
|
|
46290
|
+
['application/json'],
|
|
46291
|
+
['application/json']
|
|
46292
|
+
);
|
|
46293
|
+
}
|
|
46294
|
+
|
|
45884
46295
|
/**
|
|
45885
46296
|
* Create Campaign Rule
|
|
45886
46297
|
*
|
|
@@ -46580,6 +46991,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46580
46991
|
);
|
|
46581
46992
|
}
|
|
46582
46993
|
|
|
46994
|
+
/**
|
|
46995
|
+
* Start the campaign
|
|
46996
|
+
* Documented permissions are applicable based on campaign type.
|
|
46997
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
46998
|
+
*/
|
|
46999
|
+
postOutboundMessagingcampaignStart(messagingCampaignId) {
|
|
47000
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
47001
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
47002
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';
|
|
47003
|
+
}
|
|
47004
|
+
|
|
47005
|
+
return this.apiClient.callApi(
|
|
47006
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start',
|
|
47007
|
+
'POST',
|
|
47008
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
47009
|
+
{ },
|
|
47010
|
+
{ },
|
|
47011
|
+
{ },
|
|
47012
|
+
null,
|
|
47013
|
+
['PureCloud OAuth'],
|
|
47014
|
+
['application/json'],
|
|
47015
|
+
['application/json']
|
|
47016
|
+
);
|
|
47017
|
+
}
|
|
47018
|
+
|
|
47019
|
+
/**
|
|
47020
|
+
* Stop the campaign
|
|
47021
|
+
* Documented permissions are applicable based on campaign type.
|
|
47022
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
47023
|
+
*/
|
|
47024
|
+
postOutboundMessagingcampaignStop(messagingCampaignId) {
|
|
47025
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
47026
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
47027
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';
|
|
47028
|
+
}
|
|
47029
|
+
|
|
47030
|
+
return this.apiClient.callApi(
|
|
47031
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop',
|
|
47032
|
+
'POST',
|
|
47033
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
47034
|
+
{ },
|
|
47035
|
+
{ },
|
|
47036
|
+
{ },
|
|
47037
|
+
null,
|
|
47038
|
+
['PureCloud OAuth'],
|
|
47039
|
+
['application/json'],
|
|
47040
|
+
['application/json']
|
|
47041
|
+
);
|
|
47042
|
+
}
|
|
47043
|
+
|
|
46583
47044
|
/**
|
|
46584
47045
|
* Create a Messaging Campaign
|
|
46585
47046
|
*
|
|
@@ -47351,7 +47812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47351
47812
|
/**
|
|
47352
47813
|
* Presence service.
|
|
47353
47814
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47354
|
-
* @version
|
|
47815
|
+
* @version 207.0.0
|
|
47355
47816
|
*/
|
|
47356
47817
|
|
|
47357
47818
|
/**
|
|
@@ -48095,7 +48556,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48095
48556
|
/**
|
|
48096
48557
|
* ProcessAutomation service.
|
|
48097
48558
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48098
|
-
* @version
|
|
48559
|
+
* @version 207.0.0
|
|
48099
48560
|
*/
|
|
48100
48561
|
|
|
48101
48562
|
/**
|
|
@@ -48334,7 +48795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48334
48795
|
/**
|
|
48335
48796
|
* Quality service.
|
|
48336
48797
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48337
|
-
* @version
|
|
48798
|
+
* @version 207.0.0
|
|
48338
48799
|
*/
|
|
48339
48800
|
|
|
48340
48801
|
/**
|
|
@@ -50120,7 +50581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50120
50581
|
/**
|
|
50121
50582
|
* Recording service.
|
|
50122
50583
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50123
|
-
* @version
|
|
50584
|
+
* @version 207.0.0
|
|
50124
50585
|
*/
|
|
50125
50586
|
|
|
50126
50587
|
/**
|
|
@@ -51779,7 +52240,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51779
52240
|
/**
|
|
51780
52241
|
* ResponseManagement service.
|
|
51781
52242
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
51782
|
-
* @version
|
|
52243
|
+
* @version 207.0.0
|
|
51783
52244
|
*/
|
|
51784
52245
|
|
|
51785
52246
|
/**
|
|
@@ -52289,7 +52750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52289
52750
|
/**
|
|
52290
52751
|
* Routing service.
|
|
52291
52752
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52292
|
-
* @version
|
|
52753
|
+
* @version 207.0.0
|
|
52293
52754
|
*/
|
|
52294
52755
|
|
|
52295
52756
|
/**
|
|
@@ -56437,7 +56898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56437
56898
|
/**
|
|
56438
56899
|
* SCIM service.
|
|
56439
56900
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56440
|
-
* @version
|
|
56901
|
+
* @version 207.0.0
|
|
56441
56902
|
*/
|
|
56442
56903
|
|
|
56443
56904
|
/**
|
|
@@ -57314,7 +57775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57314
57775
|
/**
|
|
57315
57776
|
* ScreenRecording service.
|
|
57316
57777
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57317
|
-
* @version
|
|
57778
|
+
* @version 207.0.0
|
|
57318
57779
|
*/
|
|
57319
57780
|
|
|
57320
57781
|
/**
|
|
@@ -57359,7 +57820,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57359
57820
|
/**
|
|
57360
57821
|
* Scripts service.
|
|
57361
57822
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57362
|
-
* @version
|
|
57823
|
+
* @version 207.0.0
|
|
57363
57824
|
*/
|
|
57364
57825
|
|
|
57365
57826
|
/**
|
|
@@ -57803,7 +58264,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57803
58264
|
/**
|
|
57804
58265
|
* Search service.
|
|
57805
58266
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
57806
|
-
* @version
|
|
58267
|
+
* @version 207.0.0
|
|
57807
58268
|
*/
|
|
57808
58269
|
|
|
57809
58270
|
/**
|
|
@@ -58492,7 +58953,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58492
58953
|
/**
|
|
58493
58954
|
* Settings service.
|
|
58494
58955
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
58495
|
-
* @version
|
|
58956
|
+
* @version 207.0.0
|
|
58496
58957
|
*/
|
|
58497
58958
|
|
|
58498
58959
|
/**
|
|
@@ -58712,7 +59173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58712
59173
|
/**
|
|
58713
59174
|
* SpeechTextAnalytics service.
|
|
58714
59175
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
58715
|
-
* @version
|
|
59176
|
+
* @version 207.0.0
|
|
58716
59177
|
*/
|
|
58717
59178
|
|
|
58718
59179
|
/**
|
|
@@ -60047,7 +60508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60047
60508
|
/**
|
|
60048
60509
|
* Stations service.
|
|
60049
60510
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60050
|
-
* @version
|
|
60511
|
+
* @version 207.0.0
|
|
60051
60512
|
*/
|
|
60052
60513
|
|
|
60053
60514
|
/**
|
|
@@ -60149,7 +60610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60149
60610
|
/**
|
|
60150
60611
|
* Suggest service.
|
|
60151
60612
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60152
|
-
* @version
|
|
60613
|
+
* @version 207.0.0
|
|
60153
60614
|
*/
|
|
60154
60615
|
|
|
60155
60616
|
/**
|
|
@@ -60288,7 +60749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60288
60749
|
/**
|
|
60289
60750
|
* TaskManagement service.
|
|
60290
60751
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60291
|
-
* @version
|
|
60752
|
+
* @version 207.0.0
|
|
60292
60753
|
*/
|
|
60293
60754
|
|
|
60294
60755
|
/**
|
|
@@ -61952,7 +62413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61952
62413
|
/**
|
|
61953
62414
|
* Teams service.
|
|
61954
62415
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
61955
|
-
* @version
|
|
62416
|
+
* @version 207.0.0
|
|
61956
62417
|
*/
|
|
61957
62418
|
|
|
61958
62419
|
/**
|
|
@@ -62026,8 +62487,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62026
62487
|
* Get team
|
|
62027
62488
|
*
|
|
62028
62489
|
* @param {String} teamId Team ID
|
|
62490
|
+
* @param {Object} opts Optional parameters
|
|
62491
|
+
* @param {Object} opts.expand Expand the division name
|
|
62029
62492
|
*/
|
|
62030
|
-
getTeam(teamId) {
|
|
62493
|
+
getTeam(teamId, opts) {
|
|
62494
|
+
opts = opts || {};
|
|
62495
|
+
|
|
62031
62496
|
// verify the required parameter 'teamId' is set
|
|
62032
62497
|
if (teamId === undefined || teamId === null) {
|
|
62033
62498
|
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
@@ -62037,7 +62502,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62037
62502
|
'/api/v2/teams/{teamId}',
|
|
62038
62503
|
'GET',
|
|
62039
62504
|
{ 'teamId': teamId },
|
|
62040
|
-
{
|
|
62505
|
+
{ 'expand': opts['expand'] },
|
|
62041
62506
|
{ },
|
|
62042
62507
|
{ },
|
|
62043
62508
|
null,
|
|
@@ -62253,7 +62718,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62253
62718
|
/**
|
|
62254
62719
|
* Telephony service.
|
|
62255
62720
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62256
|
-
* @version
|
|
62721
|
+
* @version 207.0.0
|
|
62257
62722
|
*/
|
|
62258
62723
|
|
|
62259
62724
|
/**
|
|
@@ -62435,7 +62900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62435
62900
|
/**
|
|
62436
62901
|
* TelephonyProvidersEdge service.
|
|
62437
62902
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
62438
|
-
* @version
|
|
62903
|
+
* @version 207.0.0
|
|
62439
62904
|
*/
|
|
62440
62905
|
|
|
62441
62906
|
/**
|
|
@@ -65832,7 +66297,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65832
66297
|
/**
|
|
65833
66298
|
* Textbots service.
|
|
65834
66299
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
65835
|
-
* @version
|
|
66300
|
+
* @version 207.0.0
|
|
65836
66301
|
*/
|
|
65837
66302
|
|
|
65838
66303
|
/**
|
|
@@ -65960,7 +66425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65960
66425
|
/**
|
|
65961
66426
|
* Tokens service.
|
|
65962
66427
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
65963
|
-
* @version
|
|
66428
|
+
* @version 207.0.0
|
|
65964
66429
|
*/
|
|
65965
66430
|
|
|
65966
66431
|
/**
|
|
@@ -66114,7 +66579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66114
66579
|
/**
|
|
66115
66580
|
* Uploads service.
|
|
66116
66581
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66117
|
-
* @version
|
|
66582
|
+
* @version 207.0.0
|
|
66118
66583
|
*/
|
|
66119
66584
|
|
|
66120
66585
|
/**
|
|
@@ -66383,7 +66848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66383
66848
|
/**
|
|
66384
66849
|
* Usage service.
|
|
66385
66850
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
66386
|
-
* @version
|
|
66851
|
+
* @version 207.0.0
|
|
66387
66852
|
*/
|
|
66388
66853
|
|
|
66389
66854
|
/**
|
|
@@ -66598,7 +67063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66598
67063
|
/**
|
|
66599
67064
|
* UserRecordings service.
|
|
66600
67065
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
66601
|
-
* @version
|
|
67066
|
+
* @version 207.0.0
|
|
66602
67067
|
*/
|
|
66603
67068
|
|
|
66604
67069
|
/**
|
|
@@ -66813,7 +67278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66813
67278
|
/**
|
|
66814
67279
|
* Users service.
|
|
66815
67280
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
66816
|
-
* @version
|
|
67281
|
+
* @version 207.0.0
|
|
66817
67282
|
*/
|
|
66818
67283
|
|
|
66819
67284
|
/**
|
|
@@ -68128,6 +68593,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68128
68593
|
);
|
|
68129
68594
|
}
|
|
68130
68595
|
|
|
68596
|
+
/**
|
|
68597
|
+
* Get chats for a user
|
|
68598
|
+
*
|
|
68599
|
+
* @param {Object} opts Optional parameters
|
|
68600
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
68601
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
68602
|
+
* @param {String} opts.after The key to start after
|
|
68603
|
+
*/
|
|
68604
|
+
getUsersChatsMe(opts) {
|
|
68605
|
+
opts = opts || {};
|
|
68606
|
+
|
|
68607
|
+
|
|
68608
|
+
return this.apiClient.callApi(
|
|
68609
|
+
'/api/v2/users/chats/me',
|
|
68610
|
+
'GET',
|
|
68611
|
+
{ },
|
|
68612
|
+
{ 'excludeClosed': opts['excludeClosed'],'includePresence': opts['includePresence'],'after': opts['after'] },
|
|
68613
|
+
{ },
|
|
68614
|
+
{ },
|
|
68615
|
+
null,
|
|
68616
|
+
['PureCloud OAuth'],
|
|
68617
|
+
['application/json'],
|
|
68618
|
+
['application/json']
|
|
68619
|
+
);
|
|
68620
|
+
}
|
|
68621
|
+
|
|
68131
68622
|
/**
|
|
68132
68623
|
* Get list of Development Activities
|
|
68133
68624
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
@@ -69616,7 +70107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69616
70107
|
/**
|
|
69617
70108
|
* Utilities service.
|
|
69618
70109
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
69619
|
-
* @version
|
|
70110
|
+
* @version 207.0.0
|
|
69620
70111
|
*/
|
|
69621
70112
|
|
|
69622
70113
|
/**
|
|
@@ -69727,7 +70218,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69727
70218
|
/**
|
|
69728
70219
|
* Voicemail service.
|
|
69729
70220
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
69730
|
-
* @version
|
|
70221
|
+
* @version 207.0.0
|
|
69731
70222
|
*/
|
|
69732
70223
|
|
|
69733
70224
|
/**
|
|
@@ -70114,6 +70605,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70114
70605
|
);
|
|
70115
70606
|
}
|
|
70116
70607
|
|
|
70608
|
+
/**
|
|
70609
|
+
* Get a user's mailbox information
|
|
70610
|
+
*
|
|
70611
|
+
* @param {String} userId userId
|
|
70612
|
+
*/
|
|
70613
|
+
getVoicemailUserMailbox(userId) {
|
|
70614
|
+
// verify the required parameter 'userId' is set
|
|
70615
|
+
if (userId === undefined || userId === null) {
|
|
70616
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMailbox';
|
|
70617
|
+
}
|
|
70618
|
+
|
|
70619
|
+
return this.apiClient.callApi(
|
|
70620
|
+
'/api/v2/voicemail/users/{userId}/mailbox',
|
|
70621
|
+
'GET',
|
|
70622
|
+
{ 'userId': userId },
|
|
70623
|
+
{ },
|
|
70624
|
+
{ },
|
|
70625
|
+
{ },
|
|
70626
|
+
null,
|
|
70627
|
+
['PureCloud OAuth'],
|
|
70628
|
+
['application/json'],
|
|
70629
|
+
['application/json']
|
|
70630
|
+
);
|
|
70631
|
+
}
|
|
70632
|
+
|
|
70633
|
+
/**
|
|
70634
|
+
* List voicemail messages
|
|
70635
|
+
*
|
|
70636
|
+
* @param {String} userId User ID
|
|
70637
|
+
* @param {Object} opts Optional parameters
|
|
70638
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
70639
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
70640
|
+
*/
|
|
70641
|
+
getVoicemailUserMessages(userId, opts) {
|
|
70642
|
+
opts = opts || {};
|
|
70643
|
+
|
|
70644
|
+
// verify the required parameter 'userId' is set
|
|
70645
|
+
if (userId === undefined || userId === null) {
|
|
70646
|
+
throw 'Missing the required parameter "userId" when calling getVoicemailUserMessages';
|
|
70647
|
+
}
|
|
70648
|
+
|
|
70649
|
+
return this.apiClient.callApi(
|
|
70650
|
+
'/api/v2/voicemail/users/{userId}/messages',
|
|
70651
|
+
'GET',
|
|
70652
|
+
{ 'userId': userId },
|
|
70653
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
70654
|
+
{ },
|
|
70655
|
+
{ },
|
|
70656
|
+
null,
|
|
70657
|
+
['PureCloud OAuth'],
|
|
70658
|
+
['application/json'],
|
|
70659
|
+
['application/json']
|
|
70660
|
+
);
|
|
70661
|
+
}
|
|
70662
|
+
|
|
70117
70663
|
/**
|
|
70118
70664
|
* Get a user's voicemail policy
|
|
70119
70665
|
*
|
|
@@ -70394,7 +70940,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70394
70940
|
/**
|
|
70395
70941
|
* WebChat service.
|
|
70396
70942
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
70397
|
-
* @version
|
|
70943
|
+
* @version 207.0.0
|
|
70398
70944
|
*/
|
|
70399
70945
|
|
|
70400
70946
|
/**
|
|
@@ -70945,7 +71491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70945
71491
|
/**
|
|
70946
71492
|
* WebDeployments service.
|
|
70947
71493
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
70948
|
-
* @version
|
|
71494
|
+
* @version 207.0.0
|
|
70949
71495
|
*/
|
|
70950
71496
|
|
|
70951
71497
|
/**
|
|
@@ -71472,7 +72018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71472
72018
|
/**
|
|
71473
72019
|
* WebMessaging service.
|
|
71474
72020
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
71475
|
-
* @version
|
|
72021
|
+
* @version 207.0.0
|
|
71476
72022
|
*/
|
|
71477
72023
|
|
|
71478
72024
|
/**
|
|
@@ -71518,7 +72064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71518
72064
|
/**
|
|
71519
72065
|
* Widgets service.
|
|
71520
72066
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
71521
|
-
* @version
|
|
72067
|
+
* @version 207.0.0
|
|
71522
72068
|
*/
|
|
71523
72069
|
|
|
71524
72070
|
/**
|
|
@@ -71664,7 +72210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71664
72210
|
/**
|
|
71665
72211
|
* WorkforceManagement service.
|
|
71666
72212
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
71667
|
-
* @version
|
|
72213
|
+
* @version 207.0.0
|
|
71668
72214
|
*/
|
|
71669
72215
|
|
|
71670
72216
|
/**
|
|
@@ -78878,7 +79424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78878
79424
|
* </pre>
|
|
78879
79425
|
* </p>
|
|
78880
79426
|
* @module purecloud-platform-client-v2/index
|
|
78881
|
-
* @version
|
|
79427
|
+
* @version 207.0.0
|
|
78882
79428
|
*/
|
|
78883
79429
|
class platformClient {
|
|
78884
79430
|
constructor() {
|