purecloud-platform-client-v2 218.1.0 → 219.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1118 -100
- package/dist/web-amd/purecloud-platform-client-v2.js +1118 -100
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +349 -100
- package/dist/web-cjs/purecloud-platform-client-v2.js +349 -100
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +499 -8
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +54 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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 +396 -2
- 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 +366 -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 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- 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 +54 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +60 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -11
- 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 +6 -4
- 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/SocialMediaApi.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 +66 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- 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 +26 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -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 +7 -5
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -6458,7 +6458,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6458
6458
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6459
6459
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfUrl",value:function getConfUrl(pathType,regionUrl){if(!this.gateway)return regionUrl;if(!this.gateway.host)return regionUrl;var url=this.gateway.protocol+'://'+this.gateway.host;if(this.gateway.port>-1)url=url+':'+this.gateway.port.toString();if(pathType==='login'){if(this.gateway.path_params_login){if(this.gateway.path_params_login.startsWith('/'))url=url+this.gateway.path_params_login;else url=url+'/'+this.gateway.path_params_login;}}else{if(this.gateway.path_params_api){if(this.gateway.path_params_api.startsWith('/'))url=url+this.gateway.path_params_api;else url=url+'/'+this.gateway.path_params_api;}}return url;}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/**
|
|
6460
6460
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6461
|
-
* @version
|
|
6461
|
+
* @version 219.0.0
|
|
6462
6462
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6463
6463
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6464
6464
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6801,7 +6801,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6801
6801
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
6802
6802
|
* AgentAssistants service.
|
|
6803
6803
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
6804
|
-
* @version
|
|
6804
|
+
* @version 219.0.0
|
|
6805
6805
|
*//**
|
|
6806
6806
|
* Constructs a new AgentAssistantsApi.
|
|
6807
6807
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -6902,7 +6902,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
6902
6902
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantQueue';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/queues/{queueId}','PUT',{'assistantId':assistantId,'queueId':queueId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
6903
6903
|
* AgentCopilot service.
|
|
6904
6904
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
6905
|
-
* @version
|
|
6905
|
+
* @version 219.0.0
|
|
6906
6906
|
*//**
|
|
6907
6907
|
* Constructs a new AgentCopilotApi.
|
|
6908
6908
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -6924,7 +6924,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
6924
6924
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantCopilot';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/copilot','PUT',{'assistantId':assistantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentUIApi=/*#__PURE__*/function(){/**
|
|
6925
6925
|
* AgentUI service.
|
|
6926
6926
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6927
|
-
* @version
|
|
6927
|
+
* @version 219.0.0
|
|
6928
6928
|
*//**
|
|
6929
6929
|
* Constructs a new AgentUIApi.
|
|
6930
6930
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6958,7 +6958,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6958
6958
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
6959
6959
|
* Alerting service.
|
|
6960
6960
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6961
|
-
* @version
|
|
6961
|
+
* @version 219.0.0
|
|
6962
6962
|
*//**
|
|
6963
6963
|
* Constructs a new AlertingApi.
|
|
6964
6964
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -7047,7 +7047,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
7047
7047
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
7048
7048
|
* Analytics service.
|
|
7049
7049
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7050
|
-
* @version
|
|
7050
|
+
* @version 219.0.0
|
|
7051
7051
|
*//**
|
|
7052
7052
|
* Constructs a new AnalyticsApi.
|
|
7053
7053
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7715,7 +7715,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7715
7715
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
7716
7716
|
* Architect service.
|
|
7717
7717
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7718
|
-
* @version
|
|
7718
|
+
* @version 219.0.0
|
|
7719
7719
|
*//**
|
|
7720
7720
|
* Constructs a new ArchitectApi.
|
|
7721
7721
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8847,7 +8847,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8847
8847
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
8848
8848
|
* Audit service.
|
|
8849
8849
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8850
|
-
* @version
|
|
8850
|
+
* @version 219.0.0
|
|
8851
8851
|
*//**
|
|
8852
8852
|
* Constructs a new AuditApi.
|
|
8853
8853
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8897,7 +8897,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8897
8897
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
8898
8898
|
* Authorization service.
|
|
8899
8899
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8900
|
-
* @version
|
|
8900
|
+
* @version 219.0.0
|
|
8901
8901
|
*//**
|
|
8902
8902
|
* Constructs a new AuthorizationApi.
|
|
8903
8903
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8962,12 +8962,27 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
8962
8962
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
8963
8963
|
* @param {String} opts.name Search term to filter by division name
|
|
8964
8964
|
*/},{key:"getAuthorizationDivisions",value:function getAuthorizationDivisions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'objectCount':opts['objectCount'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8965
|
+
* Get a list of soft deleted divisions for the org
|
|
8966
|
+
*
|
|
8967
|
+
* @param {Object} opts Optional parameters
|
|
8968
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
8969
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
8970
|
+
*/},{key:"getAuthorizationDivisionsDeleted",value:function getAuthorizationDivisionsDeleted(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/deleted','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8965
8971
|
* Retrieve the home division for the organization.
|
|
8966
8972
|
* Will not include object counts.
|
|
8967
8973
|
*/},{key:"getAuthorizationDivisionsHome",value:function getAuthorizationDivisionsHome(){return this.apiClient.callApi('/api/v2/authorization/divisions/home','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8968
8974
|
* Returns the maximum allowed number of divisions.
|
|
8969
8975
|
*
|
|
8970
8976
|
*/},{key:"getAuthorizationDivisionsLimit",value:function getAuthorizationDivisionsLimit(){return this.apiClient.callApi('/api/v2/authorization/divisions/limit','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8977
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
8978
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
8979
|
+
* @param {Object} opts Optional parameters
|
|
8980
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
8981
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
8982
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
8983
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
8984
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
8985
|
+
*/},{key:"getAuthorizationDivisionsQuery",value:function getAuthorizationDivisionsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/query','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8971
8986
|
* Returns which divisions the current user has the given permission in.
|
|
8972
8987
|
* This route is deprecated, use authorization/divisionspermitted/paged/me instead.
|
|
8973
8988
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
@@ -9317,7 +9332,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
9317
9332
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
9318
9333
|
* Billing service.
|
|
9319
9334
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9320
|
-
* @version
|
|
9335
|
+
* @version 219.0.0
|
|
9321
9336
|
*//**
|
|
9322
9337
|
* Constructs a new BillingApi.
|
|
9323
9338
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -9341,7 +9356,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
9341
9356
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
9342
9357
|
* CarrierServices service.
|
|
9343
9358
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9344
|
-
* @version
|
|
9359
|
+
* @version 219.0.0
|
|
9345
9360
|
*//**
|
|
9346
9361
|
* Constructs a new CarrierServicesApi.
|
|
9347
9362
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -9361,7 +9376,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
9361
9376
|
*/},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
9362
9377
|
* Chat service.
|
|
9363
9378
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9364
|
-
* @version
|
|
9379
|
+
* @version 219.0.0
|
|
9365
9380
|
*//**
|
|
9366
9381
|
* Constructs a new ChatApi.
|
|
9367
9382
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -9579,7 +9594,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9579
9594
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
9580
9595
|
* Coaching service.
|
|
9581
9596
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9582
|
-
* @version
|
|
9597
|
+
* @version 219.0.0
|
|
9583
9598
|
*//**
|
|
9584
9599
|
* Constructs a new CoachingApi.
|
|
9585
9600
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9732,7 +9747,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9732
9747
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
9733
9748
|
* ContentManagement service.
|
|
9734
9749
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9735
|
-
* @version
|
|
9750
|
+
* @version 219.0.0
|
|
9736
9751
|
*//**
|
|
9737
9752
|
* Constructs a new ContentManagementApi.
|
|
9738
9753
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -10014,7 +10029,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
10014
10029
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
10015
10030
|
* Conversations service.
|
|
10016
10031
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10017
|
-
* @version
|
|
10032
|
+
* @version 219.0.0
|
|
10018
10033
|
*//**
|
|
10019
10034
|
* Constructs a new ConversationsApi.
|
|
10020
10035
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -11863,7 +11878,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11863
11878
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
11864
11879
|
* DataExtensions service.
|
|
11865
11880
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11866
|
-
* @version
|
|
11881
|
+
* @version 219.0.0
|
|
11867
11882
|
*//**
|
|
11868
11883
|
* Constructs a new DataExtensionsApi.
|
|
11869
11884
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11884,7 +11899,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11884
11899
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataPrivacyApi=/*#__PURE__*/function(){/**
|
|
11885
11900
|
* DataPrivacy service.
|
|
11886
11901
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
11887
|
-
* @version
|
|
11902
|
+
* @version 219.0.0
|
|
11888
11903
|
*//**
|
|
11889
11904
|
* Constructs a new DataPrivacyApi.
|
|
11890
11905
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -11924,7 +11939,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11924
11939
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
11925
11940
|
* Downloads service.
|
|
11926
11941
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11927
|
-
* @version
|
|
11942
|
+
* @version 219.0.0
|
|
11928
11943
|
*//**
|
|
11929
11944
|
* Constructs a new DownloadsApi.
|
|
11930
11945
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11943,7 +11958,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11943
11958
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
11944
11959
|
* Emails service.
|
|
11945
11960
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11946
|
-
* @version
|
|
11961
|
+
* @version 219.0.0
|
|
11947
11962
|
*//**
|
|
11948
11963
|
* Constructs a new EmailsApi.
|
|
11949
11964
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11972,7 +11987,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11972
11987
|
*/},{key:"patchEmailsSettingsThreading",value:function patchEmailsSettingsThreading(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings/threading','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
11973
11988
|
* EmployeeEngagement service.
|
|
11974
11989
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11975
|
-
* @version
|
|
11990
|
+
* @version 219.0.0
|
|
11976
11991
|
*//**
|
|
11977
11992
|
* Constructs a new EmployeeEngagementApi.
|
|
11978
11993
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -12010,7 +12025,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12010
12025
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
12011
12026
|
* Events service.
|
|
12012
12027
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
12013
|
-
* @version
|
|
12028
|
+
* @version 219.0.0
|
|
12014
12029
|
*//**
|
|
12015
12030
|
* Constructs a new EventsApi.
|
|
12016
12031
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -12035,7 +12050,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12035
12050
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
12036
12051
|
* ExternalContacts service.
|
|
12037
12052
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
12038
|
-
* @version
|
|
12053
|
+
* @version 219.0.0
|
|
12039
12054
|
*//**
|
|
12040
12055
|
* Constructs a new ExternalContactsApi.
|
|
12041
12056
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -12186,6 +12201,17 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
12186
12201
|
* Get a list of schemas.
|
|
12187
12202
|
*
|
|
12188
12203
|
*/},{key:"getExternalcontactsContactsSchemas",value:function getExternalcontactsContactsSchemas(){return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12204
|
+
* Get the core types from which all schemas are built.
|
|
12205
|
+
*
|
|
12206
|
+
* @param {String} coreTypeName Name of the core type
|
|
12207
|
+
*/},{key:"getExternalcontactsContactsSchemasCoretype",value:function getExternalcontactsContactsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
12208
|
+
if(coreTypeName===undefined||coreTypeName===null){throw'Missing the required parameter "coreTypeName" when calling getExternalcontactsContactsSchemasCoretype';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}','GET',{'coreTypeName':coreTypeName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12209
|
+
* Get the core types from which all schemas are built.
|
|
12210
|
+
*
|
|
12211
|
+
*/},{key:"getExternalcontactsContactsSchemasCoretypes",value:function getExternalcontactsContactsSchemasCoretypes(){return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas/coretypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12212
|
+
* Get quantitative limits on schemas
|
|
12213
|
+
*
|
|
12214
|
+
*/},{key:"getExternalcontactsContactsSchemasLimits",value:function getExternalcontactsContactsSchemasLimits(){return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12189
12215
|
* Fetch an External Source
|
|
12190
12216
|
*
|
|
12191
12217
|
* @param {String} externalSourceId External Source ID
|
|
@@ -12269,6 +12295,12 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
12269
12295
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
12270
12296
|
*/},{key:"getExternalcontactsOrganizationContacts",value:function getExternalcontactsOrganizationContacts(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
12271
12297
|
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts','GET',{'externalOrganizationId':externalOrganizationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'q':opts['q'],'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12298
|
+
* List the identifiers for an external organization
|
|
12299
|
+
*
|
|
12300
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
12301
|
+
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12302
|
+
*/},{key:"getExternalcontactsOrganizationIdentifiers",value:function getExternalcontactsOrganizationIdentifiers(externalOrganizationId){// verify the required parameter 'externalOrganizationId' is set
|
|
12303
|
+
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationIdentifiers';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers','GET',{'externalOrganizationId':externalOrganizationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12272
12304
|
* Fetch a note for an external organization
|
|
12273
12305
|
*
|
|
12274
12306
|
* @param {String} externalOrganizationId External Organization Id
|
|
@@ -12330,6 +12362,17 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
12330
12362
|
* Get a list of schemas.
|
|
12331
12363
|
*
|
|
12332
12364
|
*/},{key:"getExternalcontactsOrganizationsSchemas",value:function getExternalcontactsOrganizationsSchemas(){return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12365
|
+
* Get the core types from which all schemas are built.
|
|
12366
|
+
*
|
|
12367
|
+
* @param {String} coreTypeName Name of the core type
|
|
12368
|
+
*/},{key:"getExternalcontactsOrganizationsSchemasCoretype",value:function getExternalcontactsOrganizationsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
12369
|
+
if(coreTypeName===undefined||coreTypeName===null){throw'Missing the required parameter "coreTypeName" when calling getExternalcontactsOrganizationsSchemasCoretype';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}','GET',{'coreTypeName':coreTypeName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12370
|
+
* Get the core types from which all schemas are built.
|
|
12371
|
+
*
|
|
12372
|
+
*/},{key:"getExternalcontactsOrganizationsSchemasCoretypes",value:function getExternalcontactsOrganizationsSchemasCoretypes(){return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas/coretypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12373
|
+
* Get quantitative limits on schemas
|
|
12374
|
+
*
|
|
12375
|
+
*/},{key:"getExternalcontactsOrganizationsSchemasLimits",value:function getExternalcontactsOrganizationsSchemasLimits(){return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12333
12376
|
* Fetch a relationship
|
|
12334
12377
|
*
|
|
12335
12378
|
* @param {String} relationshipId Relationship Id
|
|
@@ -12408,6 +12451,14 @@ if(lookupVal===undefined||lookupVal===null){throw'Missing the required parameter
|
|
|
12408
12451
|
*/},{key:"patchExternalcontactsContactIdentifiers",value:function patchExternalcontactsContactIdentifiers(contactId,body){// verify the required parameter 'contactId' is set
|
|
12409
12452
|
if(contactId===undefined||contactId===null){throw'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';}// verify the required parameter 'body' is set
|
|
12410
12453
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/{contactId}/identifiers','PATCH',{'contactId':contactId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12454
|
+
* Claim or release identifiers for an external organization
|
|
12455
|
+
*
|
|
12456
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
12457
|
+
* @param {Object} body ClaimRequest
|
|
12458
|
+
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12459
|
+
*/},{key:"patchExternalcontactsOrganizationIdentifiers",value:function patchExternalcontactsOrganizationIdentifiers(externalOrganizationId,body){// verify the required parameter 'externalOrganizationId' is set
|
|
12460
|
+
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationIdentifiers';}// verify the required parameter 'body' is set
|
|
12461
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchExternalcontactsOrganizationIdentifiers';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers','PATCH',{'externalOrganizationId':externalOrganizationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12411
12462
|
* Bulk fetch contacts
|
|
12412
12463
|
*
|
|
12413
12464
|
* @param {Object} body Contact ids
|
|
@@ -12424,6 +12475,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12424
12475
|
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12425
12476
|
*/},{key:"postExternalcontactsBulkContactsDivisionviews",value:function postExternalcontactsBulkContactsDivisionviews(body){// verify the required parameter 'body' is set
|
|
12426
12477
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/contacts/divisionviews','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12478
|
+
* Bulk Enrich Contacts - Run up to 10 Enrich operations per request
|
|
12479
|
+
* See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
|
|
12480
|
+
* @param {Object} body Contact Enrich Requests
|
|
12481
|
+
* @param {Object} opts Optional parameters
|
|
12482
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
12483
|
+
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12484
|
+
*/},{key:"postExternalcontactsBulkContactsEnrich",value:function postExternalcontactsBulkContactsEnrich(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
12485
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsEnrich';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/contacts/enrich','POST',{},{'dryRun':opts['dryRun']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12427
12486
|
* Bulk remove contacts
|
|
12428
12487
|
*
|
|
12429
12488
|
* @param {Object} body Contact ids
|
|
@@ -12475,6 +12534,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12475
12534
|
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12476
12535
|
*/},{key:"postExternalcontactsBulkOrganizationsDivisionviews",value:function postExternalcontactsBulkOrganizationsDivisionviews(body){// verify the required parameter 'body' is set
|
|
12477
12536
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/organizations/divisionviews','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12537
|
+
* Bulk enrich external organizations - Run up to 10 Enrich operations per request
|
|
12538
|
+
* See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
|
|
12539
|
+
* @param {Object} body External Organization Enrich Requests
|
|
12540
|
+
* @param {Object} opts Optional parameters
|
|
12541
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
12542
|
+
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12543
|
+
*/},{key:"postExternalcontactsBulkOrganizationsEnrich",value:function postExternalcontactsBulkOrganizationsEnrich(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
12544
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsEnrich';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/organizations/enrich','POST',{},{'dryRun':opts['dryRun']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12478
12545
|
* Bulk remove organizations
|
|
12479
12546
|
*
|
|
12480
12547
|
* @param {Object} body Organization ids
|
|
@@ -12522,11 +12589,25 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
12522
12589
|
* @param {Object} body ExternalContact
|
|
12523
12590
|
*/},{key:"postExternalcontactsContacts",value:function postExternalcontactsContacts(body){// verify the required parameter 'body' is set
|
|
12524
12591
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12592
|
+
* Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
|
|
12593
|
+
* You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
|
|
12594
|
+
* @param {Object} body ContactEnrichRequest
|
|
12595
|
+
* @param {Object} opts Optional parameters
|
|
12596
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
12597
|
+
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12598
|
+
*/},{key:"postExternalcontactsContactsEnrich",value:function postExternalcontactsContactsEnrich(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
12599
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContactsEnrich';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/enrich','POST',{},{'dryRun':opts['dryRun']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12525
12600
|
* Create bulk export
|
|
12526
12601
|
*
|
|
12527
12602
|
* @param {Object} body Export
|
|
12528
12603
|
*/},{key:"postExternalcontactsContactsExports",value:function postExternalcontactsContactsExports(body){// verify the required parameter 'body' is set
|
|
12529
12604
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContactsExports';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/exports','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12605
|
+
* Merge up to 25 contacts into a new contact record
|
|
12606
|
+
* Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
|
|
12607
|
+
* @param {Object} body MergeRequest
|
|
12608
|
+
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12609
|
+
*/},{key:"postExternalcontactsContactsMerge",value:function postExternalcontactsContactsMerge(body){// verify the required parameter 'body' is set
|
|
12610
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContactsMerge';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/merge','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12530
12611
|
* Create a schema
|
|
12531
12612
|
*
|
|
12532
12613
|
* @param {Object} body Schema
|
|
@@ -12545,6 +12626,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12545
12626
|
* @deprecated
|
|
12546
12627
|
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
12547
12628
|
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12629
|
+
* Fetch a contact using an identifier type and value.
|
|
12630
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
12631
|
+
* @param {Object} identifier
|
|
12632
|
+
* @param {Object} opts Optional parameters
|
|
12633
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
12634
|
+
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12635
|
+
*/},{key:"postExternalcontactsIdentifierlookupContacts",value:function postExternalcontactsIdentifierlookupContacts(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
12636
|
+
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup/contacts','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12637
|
+
* Fetch an external organization using an identifier type and value.
|
|
12638
|
+
* This endpoint will only accept ExternalId type identifiers.
|
|
12639
|
+
* @param {Object} identifier
|
|
12640
|
+
* @param {Object} opts Optional parameters
|
|
12641
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
12642
|
+
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12643
|
+
*/},{key:"postExternalcontactsIdentifierlookupOrganizations",value:function postExternalcontactsIdentifierlookupOrganizations(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
12644
|
+
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupOrganizations';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup/organizations','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12548
12645
|
* Create CSV import job
|
|
12549
12646
|
*
|
|
12550
12647
|
* @param {Object} body ImportRequest
|
|
@@ -12571,8 +12668,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12571
12668
|
*/},{key:"postExternalcontactsImportSettings",value:function postExternalcontactsImportSettings(body){// verify the required parameter 'body' is set
|
|
12572
12669
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportSettings';}return this.apiClient.callApi('/api/v2/externalcontacts/import/settings','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12573
12670
|
* Merge two contacts into a new contact record
|
|
12574
|
-
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
12671
|
+
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
|
|
12575
12672
|
* @param {Object} body MergeRequest
|
|
12673
|
+
* @deprecated
|
|
12576
12674
|
*/},{key:"postExternalcontactsMergeContacts",value:function postExternalcontactsMergeContacts(body){// verify the required parameter 'body' is set
|
|
12577
12675
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/merge/contacts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12578
12676
|
* Create a note for an external organization
|
|
@@ -12587,6 +12685,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12587
12685
|
* @param {Object} body ExternalOrganization
|
|
12588
12686
|
*/},{key:"postExternalcontactsOrganizations",value:function postExternalcontactsOrganizations(body){// verify the required parameter 'body' is set
|
|
12589
12687
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsOrganizations';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12688
|
+
* Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
|
|
12689
|
+
* You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
|
|
12690
|
+
* @param {Object} body ExternalOrgEnrichRequest
|
|
12691
|
+
* @param {Object} opts Optional parameters
|
|
12692
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
12693
|
+
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12694
|
+
*/},{key:"postExternalcontactsOrganizationsEnrich",value:function postExternalcontactsOrganizationsEnrich(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
12695
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsOrganizationsEnrich';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/enrich','POST',{},{'dryRun':opts['dryRun']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12590
12696
|
* Create a schema
|
|
12591
12697
|
*
|
|
12592
12698
|
* @param {Object} body Schema
|
|
@@ -12694,7 +12800,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
12694
12800
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FaxApi=/*#__PURE__*/function(){/**
|
|
12695
12801
|
* Fax service.
|
|
12696
12802
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
12697
|
-
* @version
|
|
12803
|
+
* @version 219.0.0
|
|
12698
12804
|
*//**
|
|
12699
12805
|
* Constructs a new FaxApi.
|
|
12700
12806
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -12743,7 +12849,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12743
12849
|
*/},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
12744
12850
|
* Flows service.
|
|
12745
12851
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
12746
|
-
* @version
|
|
12852
|
+
* @version 219.0.0
|
|
12747
12853
|
*//**
|
|
12748
12854
|
* Constructs a new FlowsApi.
|
|
12749
12855
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12791,7 +12897,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12791
12897
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
12792
12898
|
* Gamification service.
|
|
12793
12899
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12794
|
-
* @version
|
|
12900
|
+
* @version 219.0.0
|
|
12795
12901
|
*//**
|
|
12796
12902
|
* Constructs a new GamificationApi.
|
|
12797
12903
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12804,6 +12910,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12804
12910
|
* @param {String} metricId Specifies the External Metric Definition ID
|
|
12805
12911
|
*/return _createClass(GamificationApi,[{key:"deleteEmployeeperformanceExternalmetricsDefinition",value:function deleteEmployeeperformanceExternalmetricsDefinition(metricId){// verify the required parameter 'metricId' is set
|
|
12806
12912
|
if(metricId===undefined||metricId===null){throw'Missing the required parameter "metricId" when calling deleteEmployeeperformanceExternalmetricsDefinition';}return this.apiClient.callApi('/api/v2/employeeperformance/externalmetrics/definitions/{metricId}','DELETE',{'metricId':metricId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12913
|
+
* Delete a Contest by Id
|
|
12914
|
+
*
|
|
12915
|
+
* @param {String} contestId The ID of the contest
|
|
12916
|
+
*/},{key:"deleteGamificationContest",value:function deleteGamificationContest(contestId){// verify the required parameter 'contestId' is set
|
|
12917
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling deleteGamificationContest';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}','DELETE',{'contestId':contestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12807
12918
|
* Get an External Metric Definition
|
|
12808
12919
|
*
|
|
12809
12920
|
* @param {String} metricId Specifies the External Metric Definition ID
|
|
@@ -12815,6 +12926,71 @@ if(metricId===undefined||metricId===null){throw'Missing the required parameter "
|
|
|
12815
12926
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
12816
12927
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12817
12928
|
*/},{key:"getEmployeeperformanceExternalmetricsDefinitions",value:function getEmployeeperformanceExternalmetricsDefinitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/employeeperformance/externalmetrics/definitions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12929
|
+
* Get a Contest by Id
|
|
12930
|
+
*
|
|
12931
|
+
* @param {String} contestId The ID of the contest
|
|
12932
|
+
*/},{key:"getGamificationContest",value:function getGamificationContest(contestId){// verify the required parameter 'contestId' is set
|
|
12933
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContest';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}','GET',{'contestId':contestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12934
|
+
* Get Contest Scores (Admin)
|
|
12935
|
+
*
|
|
12936
|
+
* @param {String} contestId The ID of the contest
|
|
12937
|
+
* @param {Object} opts Optional parameters
|
|
12938
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
12939
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
12940
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12941
|
+
* @param {Object} opts.returnsView Desired response results (default to All)
|
|
12942
|
+
*/},{key:"getGamificationContestAgentsScores",value:function getGamificationContestAgentsScores(contestId,opts){opts=opts||{};// verify the required parameter 'contestId' is set
|
|
12943
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestAgentsScores';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/agents/scores','GET',{'contestId':contestId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'workday':opts['workday'],'returnsView':opts['returnsView']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12944
|
+
* Get Contest Scores for the requesting Agent/Supervisor
|
|
12945
|
+
*
|
|
12946
|
+
* @param {String} contestId The ID of the contest
|
|
12947
|
+
* @param {Object} opts Optional parameters
|
|
12948
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
12949
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
12950
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12951
|
+
* @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
|
|
12952
|
+
*/},{key:"getGamificationContestAgentsScoresMe",value:function getGamificationContestAgentsScoresMe(contestId,opts){opts=opts||{};// verify the required parameter 'contestId' is set
|
|
12953
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresMe';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/agents/scores/me','GET',{'contestId':contestId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'workday':opts['workday'],'returnsView':opts['returnsView']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12954
|
+
* Get a Contest Score Trend (Average Trend)
|
|
12955
|
+
*
|
|
12956
|
+
* @param {String} contestId The ID of the contest
|
|
12957
|
+
*/},{key:"getGamificationContestAgentsScoresTrends",value:function getGamificationContestAgentsScoresTrends(contestId){// verify the required parameter 'contestId' is set
|
|
12958
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/agents/scores/trends','GET',{'contestId':contestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12959
|
+
* Get a Contest Score Trend for the requesting Agent
|
|
12960
|
+
*
|
|
12961
|
+
* @param {String} contestId The ID of the contest
|
|
12962
|
+
*/},{key:"getGamificationContestAgentsScoresTrendsMe",value:function getGamificationContestAgentsScoresTrendsMe(contestId){// verify the required parameter 'contestId' is set
|
|
12963
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/agents/scores/trends/me','GET',{'contestId':contestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12964
|
+
* Get a Contest Prize Image by Id
|
|
12965
|
+
*
|
|
12966
|
+
* @param {String} contestId The ID of the contest
|
|
12967
|
+
* @param {String} prizeImageId The ID of the prize image
|
|
12968
|
+
*/},{key:"getGamificationContestPrizeimage",value:function getGamificationContestPrizeimage(contestId,prizeImageId){// verify the required parameter 'contestId' is set
|
|
12969
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';}// verify the required parameter 'prizeImageId' is set
|
|
12970
|
+
if(prizeImageId===undefined||prizeImageId===null){throw'Missing the required parameter "prizeImageId" when calling getGamificationContestPrizeimage';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}','GET',{'contestId':contestId,'prizeImageId':prizeImageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12971
|
+
* Get a List of Contests (Admin)
|
|
12972
|
+
*
|
|
12973
|
+
* @param {Object} opts Optional parameters
|
|
12974
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
12975
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
12976
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12977
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12978
|
+
* @param {Array.<String>} opts.status
|
|
12979
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
12980
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
12981
|
+
*/},{key:"getGamificationContests",value:function getGamificationContests(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/gamification/contests','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'dateStart':opts['dateStart'],'dateEnd':opts['dateEnd'],'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12982
|
+
* Get a List of Contests (Agent/Supervisor)
|
|
12983
|
+
*
|
|
12984
|
+
* @param {Object} opts Optional parameters
|
|
12985
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
12986
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
12987
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12988
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12989
|
+
* @param {Array.<String>} opts.status
|
|
12990
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
12991
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
12992
|
+
* @param {Object} opts.view (default to participant)
|
|
12993
|
+
*/},{key:"getGamificationContestsMe",value:function getGamificationContestsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/gamification/contests/me','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'dateStart':opts['dateStart'],'dateEnd':opts['dateEnd'],'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'view':opts['view']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12818
12994
|
* Get insights summary
|
|
12819
12995
|
*
|
|
12820
12996
|
* @param {Object} filterType Filter type for the query request.
|
|
@@ -13258,6 +13434,13 @@ if(templateId===undefined||templateId===null){throw'Missing the required paramet
|
|
|
13258
13434
|
*/},{key:"patchEmployeeperformanceExternalmetricsDefinition",value:function patchEmployeeperformanceExternalmetricsDefinition(metricId,body){// verify the required parameter 'metricId' is set
|
|
13259
13435
|
if(metricId===undefined||metricId===null){throw'Missing the required parameter "metricId" when calling patchEmployeeperformanceExternalmetricsDefinition';}// verify the required parameter 'body' is set
|
|
13260
13436
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchEmployeeperformanceExternalmetricsDefinition';}return this.apiClient.callApi('/api/v2/employeeperformance/externalmetrics/definitions/{metricId}','PATCH',{'metricId':metricId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13437
|
+
* Finalize a Contest by Id
|
|
13438
|
+
*
|
|
13439
|
+
* @param {String} contestId The ID of the contest
|
|
13440
|
+
* @param {Object} body Finalize Contest
|
|
13441
|
+
*/},{key:"patchGamificationContest",value:function patchGamificationContest(contestId,body){// verify the required parameter 'contestId' is set
|
|
13442
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling patchGamificationContest';}// verify the required parameter 'body' is set
|
|
13443
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchGamificationContest';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}','PATCH',{'contestId':contestId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13261
13444
|
* Write External Metric Data
|
|
13262
13445
|
*
|
|
13263
13446
|
* @param {Object} opts Optional parameters
|
|
@@ -13268,6 +13451,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13268
13451
|
* @param {Object} opts Optional parameters
|
|
13269
13452
|
* @param {Object} opts.body The External Metric Definition to be created
|
|
13270
13453
|
*/},{key:"postEmployeeperformanceExternalmetricsDefinitions",value:function postEmployeeperformanceExternalmetricsDefinitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/employeeperformance/externalmetrics/definitions','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13454
|
+
* Creates a Contest
|
|
13455
|
+
*
|
|
13456
|
+
* @param {Object} body Create Contest
|
|
13457
|
+
*/},{key:"postGamificationContests",value:function postGamificationContests(body){// verify the required parameter 'body' is set
|
|
13458
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGamificationContests';}return this.apiClient.callApi('/api/v2/gamification/contests','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13459
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
13460
|
+
*
|
|
13461
|
+
* @param {Object} body query
|
|
13462
|
+
*/},{key:"postGamificationContestsUploadsPrizeimages",value:function postGamificationContestsUploadsPrizeimages(body){// verify the required parameter 'body' is set
|
|
13463
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';}return this.apiClient.callApi('/api/v2/gamification/contests/uploads/prizeimages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13271
13464
|
* Activate a performance profile
|
|
13272
13465
|
*
|
|
13273
13466
|
* @param {String} profileId performanceProfileId
|
|
@@ -13327,6 +13520,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13327
13520
|
* @param {Object} body The date range of work day.
|
|
13328
13521
|
*/},{key:"postGamificationProfilesUsersMeQuery",value:function postGamificationProfilesUsersMeQuery(body){// verify the required parameter 'body' is set
|
|
13329
13522
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';}return this.apiClient.callApi('/api/v2/gamification/profiles/users/me/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13523
|
+
* Update a Contest by Id
|
|
13524
|
+
*
|
|
13525
|
+
* @param {String} contestId The ID of the contest
|
|
13526
|
+
* @param {Object} body Contest
|
|
13527
|
+
*/},{key:"putGamificationContest",value:function putGamificationContest(contestId,body){// verify the required parameter 'contestId' is set
|
|
13528
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling putGamificationContest';}// verify the required parameter 'body' is set
|
|
13529
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGamificationContest';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}','PUT',{'contestId':contestId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13330
13530
|
* Updates a performance profile
|
|
13331
13531
|
*
|
|
13332
13532
|
* @param {String} profileId performanceProfileId
|
|
@@ -13350,7 +13550,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13350
13550
|
if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
13351
13551
|
* GeneralDataProtectionRegulation service.
|
|
13352
13552
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
13353
|
-
* @version
|
|
13553
|
+
* @version 219.0.0
|
|
13354
13554
|
*//**
|
|
13355
13555
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
13356
13556
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -13385,7 +13585,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
13385
13585
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
13386
13586
|
* Geolocation service.
|
|
13387
13587
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
13388
|
-
* @version
|
|
13588
|
+
* @version 219.0.0
|
|
13389
13589
|
*//**
|
|
13390
13590
|
* Constructs a new GeolocationApi.
|
|
13391
13591
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -13419,7 +13619,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
13419
13619
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
13420
13620
|
* Greetings service.
|
|
13421
13621
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
13422
|
-
* @version
|
|
13622
|
+
* @version 219.0.0
|
|
13423
13623
|
*//**
|
|
13424
13624
|
* Constructs a new GreetingsApi.
|
|
13425
13625
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -13526,7 +13726,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13526
13726
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
13527
13727
|
* Groups service.
|
|
13528
13728
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
13529
|
-
* @version
|
|
13729
|
+
* @version 219.0.0
|
|
13530
13730
|
*//**
|
|
13531
13731
|
* Constructs a new GroupsApi.
|
|
13532
13732
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -13659,7 +13859,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
13659
13859
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
13660
13860
|
* IdentityProvider service.
|
|
13661
13861
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
13662
|
-
* @version
|
|
13862
|
+
* @version 219.0.0
|
|
13663
13863
|
*//**
|
|
13664
13864
|
* Constructs a new IdentityProviderApi.
|
|
13665
13865
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13815,7 +14015,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13815
14015
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
13816
14016
|
* InfrastructureAsCode service.
|
|
13817
14017
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13818
|
-
* @version
|
|
14018
|
+
* @version 219.0.0
|
|
13819
14019
|
*//**
|
|
13820
14020
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13821
14021
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13869,7 +14069,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13869
14069
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
13870
14070
|
* Integrations service.
|
|
13871
14071
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13872
|
-
* @version
|
|
14072
|
+
* @version 219.0.0
|
|
13873
14073
|
*//**
|
|
13874
14074
|
* Constructs a new IntegrationsApi.
|
|
13875
14075
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -14508,7 +14708,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
14508
14708
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
14509
14709
|
* Journey service.
|
|
14510
14710
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
14511
|
-
* @version
|
|
14711
|
+
* @version 219.0.0
|
|
14512
14712
|
*//**
|
|
14513
14713
|
* Constructs a new JourneyApi.
|
|
14514
14714
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -14988,7 +15188,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
14988
15188
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','PUT',{'viewId':viewId,'versionId':versionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
14989
15189
|
* Knowledge service.
|
|
14990
15190
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14991
|
-
* @version
|
|
15191
|
+
* @version 219.0.0
|
|
14992
15192
|
*//**
|
|
14993
15193
|
* Constructs a new KnowledgeApi.
|
|
14994
15194
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -16051,7 +16251,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
16051
16251
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','PUT',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
16052
16252
|
* LanguageUnderstanding service.
|
|
16053
16253
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
16054
|
-
* @version
|
|
16254
|
+
* @version 219.0.0
|
|
16055
16255
|
*//**
|
|
16056
16256
|
* Constructs a new LanguageUnderstandingApi.
|
|
16057
16257
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -16310,7 +16510,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
16310
16510
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
16311
16511
|
* Languages service.
|
|
16312
16512
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
16313
|
-
* @version
|
|
16513
|
+
* @version 219.0.0
|
|
16314
16514
|
*//**
|
|
16315
16515
|
* Constructs a new LanguagesApi.
|
|
16316
16516
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -16365,7 +16565,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16365
16565
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LearningApi=/*#__PURE__*/function(){/**
|
|
16366
16566
|
* Learning service.
|
|
16367
16567
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
16368
|
-
* @version
|
|
16568
|
+
* @version 219.0.0
|
|
16369
16569
|
*//**
|
|
16370
16570
|
* Constructs a new LearningApi.
|
|
16371
16571
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -16636,7 +16836,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
16636
16836
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
16637
16837
|
* License service.
|
|
16638
16838
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
16639
|
-
* @version
|
|
16839
|
+
* @version 219.0.0
|
|
16640
16840
|
*//**
|
|
16641
16841
|
* Constructs a new LicenseApi.
|
|
16642
16842
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -16690,7 +16890,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
16690
16890
|
*/},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
16691
16891
|
* Locations service.
|
|
16692
16892
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
16693
|
-
* @version
|
|
16893
|
+
* @version 219.0.0
|
|
16694
16894
|
*//**
|
|
16695
16895
|
* Constructs a new LocationsApi.
|
|
16696
16896
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -16749,7 +16949,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16749
16949
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
16750
16950
|
* LogCapture service.
|
|
16751
16951
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
16752
|
-
* @version
|
|
16952
|
+
* @version 219.0.0
|
|
16753
16953
|
*//**
|
|
16754
16954
|
* Constructs a new LogCaptureApi.
|
|
16755
16955
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -16799,7 +16999,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16799
16999
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
16800
17000
|
* Messaging service.
|
|
16801
17001
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
16802
|
-
* @version
|
|
17002
|
+
* @version 219.0.0
|
|
16803
17003
|
*//**
|
|
16804
17004
|
* Constructs a new MessagingApi.
|
|
16805
17005
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16889,7 +17089,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16889
17089
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
16890
17090
|
* MobileDevices service.
|
|
16891
17091
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16892
|
-
* @version
|
|
17092
|
+
* @version 219.0.0
|
|
16893
17093
|
*//**
|
|
16894
17094
|
* Constructs a new MobileDevicesApi.
|
|
16895
17095
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16928,7 +17128,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16928
17128
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
16929
17129
|
* Notifications service.
|
|
16930
17130
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16931
|
-
* @version
|
|
17131
|
+
* @version 219.0.0
|
|
16932
17132
|
*//**
|
|
16933
17133
|
* Constructs a new NotificationsApi.
|
|
16934
17134
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16985,7 +17185,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
16985
17185
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
16986
17186
|
* OAuth service.
|
|
16987
17187
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16988
|
-
* @version
|
|
17188
|
+
* @version 219.0.0
|
|
16989
17189
|
*//**
|
|
16990
17190
|
* Constructs a new OAuthApi.
|
|
16991
17191
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -17070,7 +17270,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
17070
17270
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
17071
17271
|
* Objects service.
|
|
17072
17272
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
17073
|
-
* @version
|
|
17273
|
+
* @version 219.0.0
|
|
17074
17274
|
*//**
|
|
17075
17275
|
* Constructs a new ObjectsApi.
|
|
17076
17276
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -17105,12 +17305,27 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
17105
17305
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
17106
17306
|
* @param {String} opts.name Search term to filter by division name
|
|
17107
17307
|
*/},{key:"getAuthorizationDivisions",value:function getAuthorizationDivisions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'objectCount':opts['objectCount'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17308
|
+
* Get a list of soft deleted divisions for the org
|
|
17309
|
+
*
|
|
17310
|
+
* @param {Object} opts Optional parameters
|
|
17311
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17312
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
17313
|
+
*/},{key:"getAuthorizationDivisionsDeleted",value:function getAuthorizationDivisionsDeleted(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/deleted','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17108
17314
|
* Retrieve the home division for the organization.
|
|
17109
17315
|
* Will not include object counts.
|
|
17110
17316
|
*/},{key:"getAuthorizationDivisionsHome",value:function getAuthorizationDivisionsHome(){return this.apiClient.callApi('/api/v2/authorization/divisions/home','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17111
17317
|
* Returns the maximum allowed number of divisions.
|
|
17112
17318
|
*
|
|
17113
17319
|
*/},{key:"getAuthorizationDivisionsLimit",value:function getAuthorizationDivisionsLimit(){return this.apiClient.callApi('/api/v2/authorization/divisions/limit','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17320
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
17321
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
17322
|
+
* @param {Object} opts Optional parameters
|
|
17323
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
17324
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17325
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17326
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
17327
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
17328
|
+
*/},{key:"getAuthorizationDivisionsQuery",value:function getAuthorizationDivisionsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/query','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17114
17329
|
* Assign a list of objects to a division
|
|
17115
17330
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
17116
17331
|
* @param {String} divisionId Division ID
|
|
@@ -17141,7 +17356,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
17141
17356
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
17142
17357
|
* OperationalEvents service.
|
|
17143
17358
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
17144
|
-
* @version
|
|
17359
|
+
* @version 219.0.0
|
|
17145
17360
|
*//**
|
|
17146
17361
|
* Constructs a new OperationalEventsApi.
|
|
17147
17362
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -17172,7 +17387,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
17172
17387
|
*/},{key:"postUsageEventsQuery",value:function postUsageEventsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/usage/events/query','POST',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
17173
17388
|
* Organization service.
|
|
17174
17389
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
17175
|
-
* @version
|
|
17390
|
+
* @version 219.0.0
|
|
17176
17391
|
*//**
|
|
17177
17392
|
* Constructs a new OrganizationApi.
|
|
17178
17393
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -17277,7 +17492,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17277
17492
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
17278
17493
|
* OrganizationAuthorization service.
|
|
17279
17494
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
17280
|
-
* @version
|
|
17495
|
+
* @version 219.0.0
|
|
17281
17496
|
*//**
|
|
17282
17497
|
* Constructs a new OrganizationAuthorizationApi.
|
|
17283
17498
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -17611,7 +17826,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
17611
17826
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
17612
17827
|
* Outbound service.
|
|
17613
17828
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
17614
|
-
* @version
|
|
17829
|
+
* @version 219.0.0
|
|
17615
17830
|
*//**
|
|
17616
17831
|
* Constructs a new OutboundApi.
|
|
17617
17832
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -17719,6 +17934,13 @@ if(dncListId===undefined||dncListId===null){throw'Missing the required parameter
|
|
|
17719
17934
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
17720
17935
|
*/},{key:"deleteOutboundDnclistPhonenumbers",value:function deleteOutboundDnclistPhonenumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
17721
17936
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistPhonenumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/phonenumbers','DELETE',{'dncListId':dncListId},{'expiredOnly':opts['expiredOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17937
|
+
* Deletes all or expired whatsApp numbers from a DNC list.
|
|
17938
|
+
* This operation is only for Internal DNC lists of whatsApp numbers
|
|
17939
|
+
* @param {String} dncListId DncList ID
|
|
17940
|
+
* @param {Object} opts Optional parameters
|
|
17941
|
+
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC whatsApp numbers that are expired (default to false)
|
|
17942
|
+
*/},{key:"deleteOutboundDnclistWhatsappnumbers",value:function deleteOutboundDnclistWhatsappnumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
17943
|
+
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistWhatsappnumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers','DELETE',{'dncListId':dncListId},{'expiredOnly':opts['expiredOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17722
17944
|
* Delete File Specification Template
|
|
17723
17945
|
*
|
|
17724
17946
|
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
@@ -18339,6 +18561,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18339
18561
|
*/},{key:"patchOutboundDnclistPhonenumbers",value:function patchOutboundDnclistPhonenumbers(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
18340
18562
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistPhonenumbers';}// verify the required parameter 'body' is set
|
|
18341
18563
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchOutboundDnclistPhonenumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/phonenumbers','PATCH',{'dncListId':dncListId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18564
|
+
* Add entries to or delete entries from a DNC list.
|
|
18565
|
+
* Only Internal DNC lists may be deleted from
|
|
18566
|
+
* @param {String} dncListId DncList ID
|
|
18567
|
+
* @param {Object} body DNC whatsApp numbers
|
|
18568
|
+
*/},{key:"patchOutboundDnclistWhatsappnumbers",value:function patchOutboundDnclistWhatsappnumbers(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
18569
|
+
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistWhatsappnumbers';}// verify the required parameter 'body' is set
|
|
18570
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchOutboundDnclistWhatsappnumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers','PATCH',{'dncListId':dncListId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18342
18571
|
* Update the outbound settings for this organization
|
|
18343
18572
|
*
|
|
18344
18573
|
* @param {Object} body outboundSettings
|
|
@@ -18728,7 +18957,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18728
18957
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
18729
18958
|
* Presence service.
|
|
18730
18959
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
18731
|
-
* @version
|
|
18960
|
+
* @version 219.0.0
|
|
18732
18961
|
*//**
|
|
18733
18962
|
* Constructs a new PresenceApi.
|
|
18734
18963
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -18739,8 +18968,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18739
18968
|
* Delete a Presence Definition
|
|
18740
18969
|
*
|
|
18741
18970
|
* @param {String} definitionId Presence Definition ID
|
|
18742
|
-
*/return _createClass(PresenceApi,[{key:"
|
|
18743
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
18971
|
+
*/return _createClass(PresenceApi,[{key:"deletePresenceDefinition0",value:function deletePresenceDefinition0(definitionId){// verify the required parameter 'definitionId' is set
|
|
18972
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','DELETE',{'definitionId':definitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18744
18973
|
* Delete a Presence Source
|
|
18745
18974
|
*
|
|
18746
18975
|
* @param {String} sourceId Presence Source ID
|
|
@@ -18757,15 +18986,15 @@ if(presenceId===undefined||presenceId===null){throw'Missing the required paramet
|
|
|
18757
18986
|
* @param {String} definitionId Presence Definition ID
|
|
18758
18987
|
* @param {Object} opts Optional parameters
|
|
18759
18988
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
18760
|
-
*/},{key:"
|
|
18761
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
18989
|
+
*/},{key:"getPresenceDefinition0",value:function getPresenceDefinition0(definitionId,opts){opts=opts||{};// verify the required parameter 'definitionId' is set
|
|
18990
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling getPresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','GET',{'definitionId':definitionId},{'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18762
18991
|
* Get a list of Presence Definitions
|
|
18763
18992
|
*
|
|
18764
18993
|
* @param {Object} opts Optional parameters
|
|
18765
18994
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
18766
18995
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
18767
18996
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
18768
|
-
*/},{key:"
|
|
18997
|
+
*/},{key:"getPresenceDefinitions0",value:function getPresenceDefinitions0(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/presence/definitions','GET',{},{'deactivated':opts['deactivated'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18769
18998
|
* Get the presence settings
|
|
18770
18999
|
*
|
|
18771
19000
|
*/},{key:"getPresenceSettings",value:function getPresenceSettings(){return this.apiClient.callApi('/api/v2/presence/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -18847,8 +19076,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18847
19076
|
* Create a Presence Definition
|
|
18848
19077
|
*
|
|
18849
19078
|
* @param {Object} body The Presence Definition to create
|
|
18850
|
-
*/},{key:"
|
|
18851
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling
|
|
19079
|
+
*/},{key:"postPresenceDefinitions0",value:function postPresenceDefinitions0(body){// verify the required parameter 'body' is set
|
|
19080
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postPresenceDefinitions0';}return this.apiClient.callApi('/api/v2/presence/definitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18852
19081
|
* Create a Presence Source
|
|
18853
19082
|
*
|
|
18854
19083
|
* @param {Object} body The Presence Source to create
|
|
@@ -18864,9 +19093,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18864
19093
|
*
|
|
18865
19094
|
* @param {String} definitionId Presence Definition ID
|
|
18866
19095
|
* @param {Object} body The updated Presence Definition
|
|
18867
|
-
*/},{key:"
|
|
18868
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
18869
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling
|
|
19096
|
+
*/},{key:"putPresenceDefinition0",value:function putPresenceDefinition0(definitionId,body){// verify the required parameter 'definitionId' is set
|
|
19097
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling putPresenceDefinition0';}// verify the required parameter 'body' is set
|
|
19098
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putPresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','PUT',{'definitionId':definitionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18870
19099
|
* Update the presence settings
|
|
18871
19100
|
*
|
|
18872
19101
|
* @param {Object} body Presence Settings
|
|
@@ -18901,7 +19130,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18901
19130
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
18902
19131
|
* ProcessAutomation service.
|
|
18903
19132
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
18904
|
-
* @version
|
|
19133
|
+
* @version 219.0.0
|
|
18905
19134
|
*//**
|
|
18906
19135
|
* Constructs a new ProcessAutomationApi.
|
|
18907
19136
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -18964,7 +19193,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
18964
19193
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var QualityApi=/*#__PURE__*/function(){/**
|
|
18965
19194
|
* Quality service.
|
|
18966
19195
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
18967
|
-
* @version
|
|
19196
|
+
* @version 219.0.0
|
|
18968
19197
|
*//**
|
|
18969
19198
|
* Constructs a new QualityApi.
|
|
18970
19199
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -19442,7 +19671,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
19442
19671
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
19443
19672
|
* Recording service.
|
|
19444
19673
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
19445
|
-
* @version
|
|
19674
|
+
* @version 219.0.0
|
|
19446
19675
|
*//**
|
|
19447
19676
|
* Constructs a new RecordingApi.
|
|
19448
19677
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -19841,7 +20070,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19841
20070
|
*/},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
19842
20071
|
* ResponseManagement service.
|
|
19843
20072
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
19844
|
-
* @version
|
|
20073
|
+
* @version 219.0.0
|
|
19845
20074
|
*//**
|
|
19846
20075
|
* Constructs a new ResponseManagementApi.
|
|
19847
20076
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -19962,7 +20191,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
19962
20191
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
19963
20192
|
* Routing service.
|
|
19964
20193
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
19965
|
-
* @version
|
|
20194
|
+
* @version 219.0.0
|
|
19966
20195
|
*//**
|
|
19967
20196
|
* Constructs a new RoutingApi.
|
|
19968
20197
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20169,7 +20398,7 @@ if(domainName===undefined||domainName===null){throw'Missing the required paramet
|
|
|
20169
20398
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
20170
20399
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20171
20400
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
20172
|
-
* @param {String} opts.filter Optional search filter
|
|
20401
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
20173
20402
|
*/},{key:"getRoutingEmailDomains",value:function getRoutingEmailDomains(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/email/domains','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'excludeStatus':opts['excludeStatus'],'filter':opts['filter']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20174
20403
|
* Get domain
|
|
20175
20404
|
*
|
|
@@ -20189,8 +20418,10 @@ if(domainId===undefined||domainId===null){throw'Missing the required parameter "
|
|
|
20189
20418
|
* Get outbound domains
|
|
20190
20419
|
*
|
|
20191
20420
|
* @param {Object} opts Optional parameters
|
|
20192
|
-
* @param {
|
|
20193
|
-
|
|
20421
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
20422
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20423
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
20424
|
+
*/},{key:"getRoutingEmailOutboundDomains",value:function getRoutingEmailOutboundDomains(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/email/outbound/domains','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'filter':opts['filter']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20194
20425
|
* Get email setup
|
|
20195
20426
|
*
|
|
20196
20427
|
*/},{key:"getRoutingEmailSetup",value:function getRoutingEmailSetup(){return this.apiClient.callApi('/api/v2/routing/email/setup','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -21007,7 +21238,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21007
21238
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
21008
21239
|
* SCIM service.
|
|
21009
21240
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
21010
|
-
* @version
|
|
21241
|
+
* @version 219.0.0
|
|
21011
21242
|
*//**
|
|
21012
21243
|
* Constructs a new SCIMApi.
|
|
21013
21244
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -21232,7 +21463,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21232
21463
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
21233
21464
|
* ScreenRecording service.
|
|
21234
21465
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
21235
|
-
* @version
|
|
21466
|
+
* @version 219.0.0
|
|
21236
21467
|
*//**
|
|
21237
21468
|
* Constructs a new ScreenRecordingApi.
|
|
21238
21469
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -21247,7 +21478,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21247
21478
|
*/return _createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
21248
21479
|
* Scripts service.
|
|
21249
21480
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
21250
|
-
* @version
|
|
21481
|
+
* @version 219.0.0
|
|
21251
21482
|
*//**
|
|
21252
21483
|
* Constructs a new ScriptsApi.
|
|
21253
21484
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -21383,7 +21614,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
21383
21614
|
*/},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SearchApi=/*#__PURE__*/function(){/**
|
|
21384
21615
|
* Search service.
|
|
21385
21616
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
21386
|
-
* @version
|
|
21617
|
+
* @version 219.0.0
|
|
21387
21618
|
*//**
|
|
21388
21619
|
* Constructs a new SearchApi.
|
|
21389
21620
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -21555,7 +21786,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21555
21786
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
21556
21787
|
* Settings service.
|
|
21557
21788
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
21558
|
-
* @version
|
|
21789
|
+
* @version 219.0.0
|
|
21559
21790
|
*//**
|
|
21560
21791
|
* Constructs a new SettingsApi.
|
|
21561
21792
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -21616,7 +21847,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
21616
21847
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SocialMediaApi=/*#__PURE__*/function(){/**
|
|
21617
21848
|
* SocialMedia service.
|
|
21618
21849
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
21619
|
-
* @version
|
|
21850
|
+
* @version 219.0.0
|
|
21620
21851
|
*//**
|
|
21621
21852
|
* Constructs a new SocialMediaApi.
|
|
21622
21853
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -21953,7 +22184,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21953
22184
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PUT',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
21954
22185
|
* SpeechTextAnalytics service.
|
|
21955
22186
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
21956
|
-
* @version
|
|
22187
|
+
* @version 219.0.0
|
|
21957
22188
|
*//**
|
|
21958
22189
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
21959
22190
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -22276,7 +22507,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
22276
22507
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var StationsApi=/*#__PURE__*/function(){/**
|
|
22277
22508
|
* Stations service.
|
|
22278
22509
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
22279
|
-
* @version
|
|
22510
|
+
* @version 219.0.0
|
|
22280
22511
|
*//**
|
|
22281
22512
|
* Constructs a new StationsApi.
|
|
22282
22513
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -22308,7 +22539,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
22308
22539
|
*/},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
22309
22540
|
* Suggest service.
|
|
22310
22541
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
22311
|
-
* @version
|
|
22542
|
+
* @version 219.0.0
|
|
22312
22543
|
*//**
|
|
22313
22544
|
* Constructs a new SuggestApi.
|
|
22314
22545
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -22348,7 +22579,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22348
22579
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
22349
22580
|
* TaskManagement service.
|
|
22350
22581
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
22351
|
-
* @version
|
|
22582
|
+
* @version 219.0.0
|
|
22352
22583
|
*//**
|
|
22353
22584
|
* Constructs a new TaskManagementApi.
|
|
22354
22585
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -22562,6 +22793,17 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
22562
22793
|
* Get a list of schemas.
|
|
22563
22794
|
*
|
|
22564
22795
|
*/},{key:"getTaskmanagementWorkitemsSchemas",value:function getTaskmanagementWorkitemsSchemas(){return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22796
|
+
* Get the core types from which all schemas are built.
|
|
22797
|
+
*
|
|
22798
|
+
* @param {String} coreTypeName Name of the core type
|
|
22799
|
+
*/},{key:"getTaskmanagementWorkitemsSchemasCoretype",value:function getTaskmanagementWorkitemsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
22800
|
+
if(coreTypeName===undefined||coreTypeName===null){throw'Missing the required parameter "coreTypeName" when calling getTaskmanagementWorkitemsSchemasCoretype';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}','GET',{'coreTypeName':coreTypeName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22801
|
+
* Get the core types from which all schemas are built.
|
|
22802
|
+
*
|
|
22803
|
+
*/},{key:"getTaskmanagementWorkitemsSchemasCoretypes",value:function getTaskmanagementWorkitemsSchemasCoretypes(){return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/coretypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22804
|
+
* Get quantitative limits on schemas
|
|
22805
|
+
*
|
|
22806
|
+
*/},{key:"getTaskmanagementWorkitemsSchemasLimits",value:function getTaskmanagementWorkitemsSchemasLimits(){return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22565
22807
|
* Get a worktype
|
|
22566
22808
|
*
|
|
22567
22809
|
* @param {String} worktypeId Worktype id
|
|
@@ -22854,7 +23096,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
22854
23096
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
22855
23097
|
* Teams service.
|
|
22856
23098
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
22857
|
-
* @version
|
|
23099
|
+
* @version 219.0.0
|
|
22858
23100
|
*//**
|
|
22859
23101
|
* Constructs a new TeamsApi.
|
|
22860
23102
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -22934,7 +23176,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22934
23176
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
22935
23177
|
* Telephony service.
|
|
22936
23178
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
22937
|
-
* @version
|
|
23179
|
+
* @version 219.0.0
|
|
22938
23180
|
*//**
|
|
22939
23181
|
* Constructs a new TelephonyApi.
|
|
22940
23182
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -22981,7 +23223,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
22981
23223
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
22982
23224
|
* TelephonyProvidersEdge service.
|
|
22983
23225
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
22984
|
-
* @version
|
|
23226
|
+
* @version 219.0.0
|
|
22985
23227
|
*//**
|
|
22986
23228
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
22987
23229
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -23817,7 +24059,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
23817
24059
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
23818
24060
|
* Textbots service.
|
|
23819
24061
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
23820
|
-
* @version
|
|
24062
|
+
* @version 219.0.0
|
|
23821
24063
|
*//**
|
|
23822
24064
|
* Constructs a new TextbotsApi.
|
|
23823
24065
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -23852,7 +24094,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
23852
24094
|
if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TokensApi=/*#__PURE__*/function(){/**
|
|
23853
24095
|
* Tokens service.
|
|
23854
24096
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
23855
|
-
* @version
|
|
24097
|
+
* @version 219.0.0
|
|
23856
24098
|
*//**
|
|
23857
24099
|
* Constructs a new TokensApi.
|
|
23858
24100
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -23886,7 +24128,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23886
24128
|
*/},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
23887
24129
|
* Uploads service.
|
|
23888
24130
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
23889
|
-
* @version
|
|
24131
|
+
* @version 219.0.0
|
|
23890
24132
|
*//**
|
|
23891
24133
|
* Constructs a new UploadsApi.
|
|
23892
24134
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -23901,6 +24143,11 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23901
24143
|
*/return _createClass(UploadsApi,[{key:"getKnowledgeKnowledgebaseUploadsUrlsJob",value:function getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId,jobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
23902
24144
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}// verify the required parameter 'jobId' is set
|
|
23903
24145
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
24146
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
24147
|
+
*
|
|
24148
|
+
* @param {Object} body query
|
|
24149
|
+
*/},{key:"postGamificationContestsUploadsPrizeimages",value:function postGamificationContestsUploadsPrizeimages(body){// verify the required parameter 'body' is set
|
|
24150
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';}return this.apiClient.callApi('/api/v2/gamification/contests/uploads/prizeimages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23904
24151
|
* Create upload presigned URL for draft function package file.
|
|
23905
24152
|
*
|
|
23906
24153
|
* @param {String} actionId actionId
|
|
@@ -23949,7 +24196,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23949
24196
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsageApi=/*#__PURE__*/function(){/**
|
|
23950
24197
|
* Usage service.
|
|
23951
24198
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
23952
|
-
* @version
|
|
24199
|
+
* @version 219.0.0
|
|
23953
24200
|
*//**
|
|
23954
24201
|
* Constructs a new UsageApi.
|
|
23955
24202
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -24003,7 +24250,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24003
24250
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
24004
24251
|
* UserRecordings service.
|
|
24005
24252
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
24006
|
-
* @version
|
|
24253
|
+
* @version 219.0.0
|
|
24007
24254
|
*//**
|
|
24008
24255
|
* Constructs a new UserRecordingsApi.
|
|
24009
24256
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -24060,7 +24307,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
24060
24307
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsersApi=/*#__PURE__*/function(){/**
|
|
24061
24308
|
* Users service.
|
|
24062
24309
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
24063
|
-
* @version
|
|
24310
|
+
* @version 219.0.0
|
|
24064
24311
|
*//**
|
|
24065
24312
|
* Constructs a new UsersApi.
|
|
24066
24313
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -24787,7 +25034,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
24787
25034
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
24788
25035
|
* Utilities service.
|
|
24789
25036
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
24790
|
-
* @version
|
|
25037
|
+
* @version 219.0.0
|
|
24791
25038
|
*//**
|
|
24792
25039
|
* Constructs a new UtilitiesApi.
|
|
24793
25040
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -24814,7 +25061,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24814
25061
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
24815
25062
|
* Voicemail service.
|
|
24816
25063
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
24817
|
-
* @version
|
|
25064
|
+
* @version 219.0.0
|
|
24818
25065
|
*//**
|
|
24819
25066
|
* Constructs a new VoicemailApi.
|
|
24820
25067
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -24976,7 +25223,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
24976
25223
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
24977
25224
|
* WebChat service.
|
|
24978
25225
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
24979
|
-
* @version
|
|
25226
|
+
* @version 219.0.0
|
|
24980
25227
|
*//**
|
|
24981
25228
|
* Constructs a new WebChatApi.
|
|
24982
25229
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -25120,7 +25367,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25120
25367
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
25121
25368
|
* WebDeployments service.
|
|
25122
25369
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
25123
|
-
* @version
|
|
25370
|
+
* @version 219.0.0
|
|
25124
25371
|
*//**
|
|
25125
25372
|
* Constructs a new WebDeploymentsApi.
|
|
25126
25373
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -25255,7 +25502,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
25255
25502
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebdeploymentsDeploymentIdentityresolution';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}/identityresolution','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
25256
25503
|
* WebMessaging service.
|
|
25257
25504
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
25258
|
-
* @version
|
|
25505
|
+
* @version 219.0.0
|
|
25259
25506
|
*//**
|
|
25260
25507
|
* Constructs a new WebMessagingApi.
|
|
25261
25508
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -25271,7 +25518,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25271
25518
|
*/return _createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
25272
25519
|
* Widgets service.
|
|
25273
25520
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
25274
|
-
* @version
|
|
25521
|
+
* @version 219.0.0
|
|
25275
25522
|
*//**
|
|
25276
25523
|
* Constructs a new WidgetsApi.
|
|
25277
25524
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -25311,7 +25558,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
25311
25558
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
25312
25559
|
* WorkforceManagement service.
|
|
25313
25560
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
25314
|
-
* @version
|
|
25561
|
+
* @version 219.0.0
|
|
25315
25562
|
*//**
|
|
25316
25563
|
* Constructs a new WorkforceManagementApi.
|
|
25317
25564
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -25923,8 +26170,9 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
25923
26170
|
* Retrieves all delete job status for historical data
|
|
25924
26171
|
*
|
|
25925
26172
|
*/},{key:"getWorkforcemanagementHistoricaldataBulkRemoveJobs",value:function getWorkforcemanagementHistoricaldataBulkRemoveJobs(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
25926
|
-
* Retrieves delete job status for historical data imports of the organization
|
|
25927
|
-
*
|
|
26173
|
+
* Retrieves delete job status for historical data imports of the organization.
|
|
26174
|
+
* Deprecated: Please use GET /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
26175
|
+
* @deprecated
|
|
25928
26176
|
*/},{key:"getWorkforcemanagementHistoricaldataDeletejob",value:function getWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/deletejob','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
25929
26177
|
* Retrieves status of the historical data imports of the organization
|
|
25930
26178
|
*
|
|
@@ -26801,8 +27049,9 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
26801
27049
|
* @param {Object} opts Optional parameters
|
|
26802
27050
|
* @param {Object} opts.body body
|
|
26803
27051
|
*/},{key:"postWorkforcemanagementHistoricaldataBulkRemoveJobs",value:function postWorkforcemanagementHistoricaldataBulkRemoveJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26804
|
-
* Delete the entries of the historical data imports in the organization
|
|
26805
|
-
*
|
|
27052
|
+
* Delete the entries of the historical data imports in the organization.
|
|
27053
|
+
* Deprecated: Please use POST /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
27054
|
+
* @deprecated
|
|
26806
27055
|
*/},{key:"postWorkforcemanagementHistoricaldataDeletejob",value:function postWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/deletejob','POST',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26807
27056
|
* Trigger validation process for historical import
|
|
26808
27057
|
*
|
|
@@ -27130,7 +27379,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
27130
27379
|
* </pre>
|
|
27131
27380
|
* </p>
|
|
27132
27381
|
* @module purecloud-platform-client-v2/index
|
|
27133
|
-
* @version
|
|
27382
|
+
* @version 219.0.0
|
|
27134
27383
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
27135
27384
|
* The ApiClient constructor.
|
|
27136
27385
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|