purecloud-platform-client-v2 236.0.0 → 238.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 +455 -87
- package/dist/web-amd/purecloud-platform-client-v2.js +455 -87
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +189 -88
- package/dist/web-cjs/purecloud-platform-client-v2.js +189 -88
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +538 -337
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.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 -3
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -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 +27 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +294 -0
- 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 +51 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -6519,7 +6519,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6519
6519
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6520
6520
|
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];}}}]);}();/**
|
|
6521
6521
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6522
|
-
* @version
|
|
6522
|
+
* @version 238.0.0
|
|
6523
6523
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6524
6524
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6525
6525
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6681,7 +6681,7 @@ if(error.response){_this7.config.logger.log('error',error.response.status,'POST'
|
|
|
6681
6681
|
* @param {string} code - code verifier used to generate the code challenge
|
|
6682
6682
|
*/},{key:"computePKCECodeChallenge",value:function computePKCECodeChallenge(code){if(code.length<43||code.length>128){throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");}// Check for window
|
|
6683
6683
|
{// browser
|
|
6684
|
-
var utf8=new TextEncoder().encode(code);return new Promise(function(resolve,reject){window.crypto.subtle.digest("SHA-256",utf8).then(function(hashBuffer){var hashBase64=
|
|
6684
|
+
var utf8=new TextEncoder().encode(code);return new Promise(function(resolve,reject){window.crypto.subtle.digest("SHA-256",utf8).then(function(hashBuffer){var hashBase64=btoa(String.fromCharCode.apply(String,_toConsumableArray(new Uint8Array(hashBuffer))));var hashBase64Url=hashBase64.replaceAll("+","-").replaceAll("/","_");hashBase64Url=hashBase64Url.split("=")[0];resolve(hashBase64Url);})["catch"](function(error){// Handle failure
|
|
6685
6685
|
return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
6686
6686
|
* @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
6687
6687
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
@@ -6875,7 +6875,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6875
6875
|
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 AIStudioApi=/*#__PURE__*/function(){/**
|
|
6876
6876
|
* AIStudio service.
|
|
6877
6877
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
6878
|
-
* @version
|
|
6878
|
+
* @version 238.0.0
|
|
6879
6879
|
*//**
|
|
6880
6880
|
* Constructs a new AIStudioApi.
|
|
6881
6881
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -7026,7 +7026,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
7026
7026
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsSummariesSetting';}return this.apiClient.callApi('/api/v2/conversations/summaries/settings/{summarySettingId}','PUT',{'summarySettingId':summarySettingId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
7027
7027
|
* AgentAssistants service.
|
|
7028
7028
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
7029
|
-
* @version
|
|
7029
|
+
* @version 238.0.0
|
|
7030
7030
|
*//**
|
|
7031
7031
|
* Constructs a new AgentAssistantsApi.
|
|
7032
7032
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -7157,7 +7157,7 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
7157
7157
|
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(){/**
|
|
7158
7158
|
* AgentCopilot service.
|
|
7159
7159
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
7160
|
-
* @version
|
|
7160
|
+
* @version 238.0.0
|
|
7161
7161
|
*//**
|
|
7162
7162
|
* Constructs a new AgentCopilotApi.
|
|
7163
7163
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -7184,7 +7184,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
7184
7184
|
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(){/**
|
|
7185
7185
|
* AgentUI service.
|
|
7186
7186
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
7187
|
-
* @version
|
|
7187
|
+
* @version 238.0.0
|
|
7188
7188
|
*//**
|
|
7189
7189
|
* Constructs a new AgentUIApi.
|
|
7190
7190
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -7218,7 +7218,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
7218
7218
|
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(){/**
|
|
7219
7219
|
* Alerting service.
|
|
7220
7220
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
7221
|
-
* @version
|
|
7221
|
+
* @version 238.0.0
|
|
7222
7222
|
*//**
|
|
7223
7223
|
* Constructs a new AlertingApi.
|
|
7224
7224
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -7307,7 +7307,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
7307
7307
|
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(){/**
|
|
7308
7308
|
* Analytics service.
|
|
7309
7309
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7310
|
-
* @version
|
|
7310
|
+
* @version 238.0.0
|
|
7311
7311
|
*//**
|
|
7312
7312
|
* Constructs a new AnalyticsApi.
|
|
7313
7313
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -8083,7 +8083,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8083
8083
|
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(){/**
|
|
8084
8084
|
* Architect service.
|
|
8085
8085
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8086
|
-
* @version
|
|
8086
|
+
* @version 238.0.0
|
|
8087
8087
|
*//**
|
|
8088
8088
|
* Constructs a new ArchitectApi.
|
|
8089
8089
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -9217,7 +9217,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
9217
9217
|
if(flowOutcomeId===undefined||flowOutcomeId===null||flowOutcomeId===''){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(){/**
|
|
9218
9218
|
* Audit service.
|
|
9219
9219
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9220
|
-
* @version
|
|
9220
|
+
* @version 238.0.0
|
|
9221
9221
|
*//**
|
|
9222
9222
|
* Constructs a new AuditApi.
|
|
9223
9223
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -9267,7 +9267,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9267
9267
|
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(){/**
|
|
9268
9268
|
* Authorization service.
|
|
9269
9269
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9270
|
-
* @version
|
|
9270
|
+
* @version 238.0.0
|
|
9271
9271
|
*//**
|
|
9272
9272
|
* Constructs a new AuthorizationApi.
|
|
9273
9273
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -9702,7 +9702,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
9702
9702
|
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(){/**
|
|
9703
9703
|
* Billing service.
|
|
9704
9704
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9705
|
-
* @version
|
|
9705
|
+
* @version 238.0.0
|
|
9706
9706
|
*//**
|
|
9707
9707
|
* Constructs a new BillingApi.
|
|
9708
9708
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -9779,7 +9779,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
9779
9779
|
if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){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 BusinessRulesApi=/*#__PURE__*/function(){/**
|
|
9780
9780
|
* BusinessRules service.
|
|
9781
9781
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
9782
|
-
* @version
|
|
9782
|
+
* @version 238.0.0
|
|
9783
9783
|
*//**
|
|
9784
9784
|
* Constructs a new BusinessRulesApi.
|
|
9785
9785
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -10000,7 +10000,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
10000
10000
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putBusinessrulesSchema';}return this.apiClient.callApi('/api/v2/businessrules/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
10001
10001
|
* CarrierServices service.
|
|
10002
10002
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10003
|
-
* @version
|
|
10003
|
+
* @version 238.0.0
|
|
10004
10004
|
*//**
|
|
10005
10005
|
* Constructs a new CarrierServicesApi.
|
|
10006
10006
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -10020,7 +10020,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
10020
10020
|
*/},{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(){/**
|
|
10021
10021
|
* Chat service.
|
|
10022
10022
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10023
|
-
* @version
|
|
10023
|
+
* @version 238.0.0
|
|
10024
10024
|
*//**
|
|
10025
10025
|
* Constructs a new ChatApi.
|
|
10026
10026
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -10251,7 +10251,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10251
10251
|
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(){/**
|
|
10252
10252
|
* Coaching service.
|
|
10253
10253
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10254
|
-
* @version
|
|
10254
|
+
* @version 238.0.0
|
|
10255
10255
|
*//**
|
|
10256
10256
|
* Constructs a new CoachingApi.
|
|
10257
10257
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -10414,7 +10414,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10414
10414
|
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(){/**
|
|
10415
10415
|
* ContentManagement service.
|
|
10416
10416
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10417
|
-
* @version
|
|
10417
|
+
* @version 238.0.0
|
|
10418
10418
|
*//**
|
|
10419
10419
|
* Constructs a new ContentManagementApi.
|
|
10420
10420
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -10696,7 +10696,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
10696
10696
|
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(){/**
|
|
10697
10697
|
* Conversations service.
|
|
10698
10698
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10699
|
-
* @version
|
|
10699
|
+
* @version 238.0.0
|
|
10700
10700
|
*//**
|
|
10701
10701
|
* Constructs a new ConversationsApi.
|
|
10702
10702
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -11496,7 +11496,6 @@ if(communicationId===undefined||communicationId===null||communicationId===''){th
|
|
|
11496
11496
|
* Gets a record for a given meetingId
|
|
11497
11497
|
*
|
|
11498
11498
|
* @param {String} meetingId meetingId
|
|
11499
|
-
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11500
11499
|
*/},{key:"getConversationsVideosMeeting",value:function getConversationsVideosMeeting(meetingId){// verify the required parameter 'meetingId' is set
|
|
11501
11500
|
if(meetingId===undefined||meetingId===null||meetingId===''){throw'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';}return this.apiClient.callApi('/api/v2/conversations/videos/meetings/{meetingId}','GET',{'meetingId':meetingId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11502
11501
|
* Update a participant.
|
|
@@ -12625,7 +12624,6 @@ if(communicationId===undefined||communicationId===null||communicationId===''){th
|
|
|
12625
12624
|
* Generate a meetingId for a given conferenceId
|
|
12626
12625
|
*
|
|
12627
12626
|
* @param {Object} body MeetingIdRequest
|
|
12628
|
-
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12629
12627
|
*/},{key:"postConversationsVideosMeetings",value:function postConversationsVideosMeetings(body){// verify the required parameter 'body' is set
|
|
12630
12628
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsVideosMeetings';}return this.apiClient.callApi('/api/v2/conversations/videos/meetings','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12631
12629
|
* Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
@@ -12799,7 +12797,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
12799
12797
|
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(){/**
|
|
12800
12798
|
* DataExtensions service.
|
|
12801
12799
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
12802
|
-
* @version
|
|
12800
|
+
* @version 238.0.0
|
|
12803
12801
|
*//**
|
|
12804
12802
|
* Constructs a new DataExtensionsApi.
|
|
12805
12803
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -12820,7 +12818,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
12820
12818
|
*/},{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(){/**
|
|
12821
12819
|
* DataPrivacy service.
|
|
12822
12820
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
12823
|
-
* @version
|
|
12821
|
+
* @version 238.0.0
|
|
12824
12822
|
*//**
|
|
12825
12823
|
* Constructs a new DataPrivacyApi.
|
|
12826
12824
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -12860,7 +12858,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12860
12858
|
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(){/**
|
|
12861
12859
|
* Downloads service.
|
|
12862
12860
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
12863
|
-
* @version
|
|
12861
|
+
* @version 238.0.0
|
|
12864
12862
|
*//**
|
|
12865
12863
|
* Constructs a new DownloadsApi.
|
|
12866
12864
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -12879,7 +12877,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12879
12877
|
if(downloadId===undefined||downloadId===null||downloadId===''){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(){/**
|
|
12880
12878
|
* Emails service.
|
|
12881
12879
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
12882
|
-
* @version
|
|
12880
|
+
* @version 238.0.0
|
|
12883
12881
|
*//**
|
|
12884
12882
|
* Constructs a new EmailsApi.
|
|
12885
12883
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -12908,7 +12906,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
12908
12906
|
*/},{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(){/**
|
|
12909
12907
|
* EmployeeEngagement service.
|
|
12910
12908
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
12911
|
-
* @version
|
|
12909
|
+
* @version 238.0.0
|
|
12912
12910
|
*//**
|
|
12913
12911
|
* Constructs a new EmployeeEngagementApi.
|
|
12914
12912
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -12946,7 +12944,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12946
12944
|
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(){/**
|
|
12947
12945
|
* Events service.
|
|
12948
12946
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
12949
|
-
* @version
|
|
12947
|
+
* @version 238.0.0
|
|
12950
12948
|
*//**
|
|
12951
12949
|
* Constructs a new EventsApi.
|
|
12952
12950
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -12971,7 +12969,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12971
12969
|
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(){/**
|
|
12972
12970
|
* ExternalContacts service.
|
|
12973
12971
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
12974
|
-
* @version
|
|
12972
|
+
* @version 238.0.0
|
|
12975
12973
|
*//**
|
|
12976
12974
|
* Constructs a new ExternalContactsApi.
|
|
12977
12975
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -13721,7 +13719,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
13721
13719
|
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(){/**
|
|
13722
13720
|
* Fax service.
|
|
13723
13721
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
13724
|
-
* @version
|
|
13722
|
+
* @version 238.0.0
|
|
13725
13723
|
*//**
|
|
13726
13724
|
* Constructs a new FaxApi.
|
|
13727
13725
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -13770,7 +13768,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13770
13768
|
*/},{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(){/**
|
|
13771
13769
|
* Flows service.
|
|
13772
13770
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
13773
|
-
* @version
|
|
13771
|
+
* @version 238.0.0
|
|
13774
13772
|
*//**
|
|
13775
13773
|
* Constructs a new FlowsApi.
|
|
13776
13774
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -13824,7 +13822,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13824
13822
|
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(){/**
|
|
13825
13823
|
* Gamification service.
|
|
13826
13824
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
13827
|
-
* @version
|
|
13825
|
+
* @version 238.0.0
|
|
13828
13826
|
*//**
|
|
13829
13827
|
* Constructs a new GamificationApi.
|
|
13830
13828
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -14495,7 +14493,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14495
14493
|
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(){/**
|
|
14496
14494
|
* GeneralDataProtectionRegulation service.
|
|
14497
14495
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
14498
|
-
* @version
|
|
14496
|
+
* @version 238.0.0
|
|
14499
14497
|
*//**
|
|
14500
14498
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
14501
14499
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -14530,7 +14528,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
14530
14528
|
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(){/**
|
|
14531
14529
|
* Geolocation service.
|
|
14532
14530
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
14533
|
-
* @version
|
|
14531
|
+
* @version 238.0.0
|
|
14534
14532
|
*//**
|
|
14535
14533
|
* Constructs a new GeolocationApi.
|
|
14536
14534
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -14564,7 +14562,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
14564
14562
|
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(){/**
|
|
14565
14563
|
* Greetings service.
|
|
14566
14564
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
14567
|
-
* @version
|
|
14565
|
+
* @version 238.0.0
|
|
14568
14566
|
*//**
|
|
14569
14567
|
* Constructs a new GreetingsApi.
|
|
14570
14568
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -14692,7 +14690,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
14692
14690
|
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(){/**
|
|
14693
14691
|
* Groups service.
|
|
14694
14692
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
14695
|
-
* @version
|
|
14693
|
+
* @version 238.0.0
|
|
14696
14694
|
*//**
|
|
14697
14695
|
* Constructs a new GroupsApi.
|
|
14698
14696
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -14825,7 +14823,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
14825
14823
|
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(){/**
|
|
14826
14824
|
* IdentityProvider service.
|
|
14827
14825
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
14828
|
-
* @version
|
|
14826
|
+
* @version 238.0.0
|
|
14829
14827
|
*//**
|
|
14830
14828
|
* Constructs a new IdentityProviderApi.
|
|
14831
14829
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -14981,7 +14979,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14981
14979
|
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(){/**
|
|
14982
14980
|
* InfrastructureAsCode service.
|
|
14983
14981
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
14984
|
-
* @version
|
|
14982
|
+
* @version 238.0.0
|
|
14985
14983
|
*//**
|
|
14986
14984
|
* Constructs a new InfrastructureAsCodeApi.
|
|
14987
14985
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -15035,7 +15033,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
15035
15033
|
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(){/**
|
|
15036
15034
|
* Integrations service.
|
|
15037
15035
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
15038
|
-
* @version
|
|
15036
|
+
* @version 238.0.0
|
|
15039
15037
|
*//**
|
|
15040
15038
|
* Constructs a new IntegrationsApi.
|
|
15041
15039
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -15725,7 +15723,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
15725
15723
|
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(){/**
|
|
15726
15724
|
* Journey service.
|
|
15727
15725
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
15728
|
-
* @version
|
|
15726
|
+
* @version 238.0.0
|
|
15729
15727
|
*//**
|
|
15730
15728
|
* Constructs a new JourneyApi.
|
|
15731
15729
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -16234,7 +16232,7 @@ if(versionId===undefined||versionId===null||versionId===''){throw'Missing the re
|
|
|
16234
16232
|
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(){/**
|
|
16235
16233
|
* Knowledge service.
|
|
16236
16234
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
16237
|
-
* @version
|
|
16235
|
+
* @version 238.0.0
|
|
16238
16236
|
*//**
|
|
16239
16237
|
* Constructs a new KnowledgeApi.
|
|
16240
16238
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -17062,7 +17060,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
17062
17060
|
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(){/**
|
|
17063
17061
|
* LanguageUnderstanding service.
|
|
17064
17062
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
17065
|
-
* @version
|
|
17063
|
+
* @version 238.0.0
|
|
17066
17064
|
*//**
|
|
17067
17065
|
* Constructs a new LanguageUnderstandingApi.
|
|
17068
17066
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -17371,7 +17369,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
17371
17369
|
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(){/**
|
|
17372
17370
|
* Languages service.
|
|
17373
17371
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
17374
|
-
* @version
|
|
17372
|
+
* @version 238.0.0
|
|
17375
17373
|
*//**
|
|
17376
17374
|
* Constructs a new LanguagesApi.
|
|
17377
17375
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -17426,7 +17424,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
17426
17424
|
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(){/**
|
|
17427
17425
|
* Learning service.
|
|
17428
17426
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
17429
|
-
* @version
|
|
17427
|
+
* @version 238.0.0
|
|
17430
17428
|
*//**
|
|
17431
17429
|
* Constructs a new LearningApi.
|
|
17432
17430
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -17655,6 +17653,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17655
17653
|
* @param {Object} opts.body The request body
|
|
17656
17654
|
*/},{key:"postLearningModulePublish",value:function postLearningModulePublish(moduleId,opts){opts=opts||{};// verify the required parameter 'moduleId' is set
|
|
17657
17655
|
if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the required parameter "moduleId" when calling postLearningModulePublish';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/publish','POST',{'moduleId':moduleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17656
|
+
* Migrate a legacy learning module rule to a users rule.
|
|
17657
|
+
*
|
|
17658
|
+
* @param {String} moduleId The ID of the learning module
|
|
17659
|
+
* postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17660
|
+
*/},{key:"postLearningModuleRuleMigrate",value:function postLearningModuleRuleMigrate(moduleId){// verify the required parameter 'moduleId' is set
|
|
17661
|
+
if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the required parameter "moduleId" when calling postLearningModuleRuleMigrate';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule/migrate','POST',{'moduleId':moduleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17658
17662
|
* Create a new learning module
|
|
17659
17663
|
* This will create a new unpublished learning module with the specified fields.
|
|
17660
17664
|
* @param {Object} body The learning module to be created
|
|
@@ -17709,7 +17713,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
17709
17713
|
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},{'assign':opts['assign']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
17710
17714
|
* License service.
|
|
17711
17715
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
17712
|
-
* @version
|
|
17716
|
+
* @version 238.0.0
|
|
17713
17717
|
*//**
|
|
17714
17718
|
* Constructs a new LicenseApi.
|
|
17715
17719
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -17763,7 +17767,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
17763
17767
|
*/},{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(){/**
|
|
17764
17768
|
* Locations service.
|
|
17765
17769
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
17766
|
-
* @version
|
|
17770
|
+
* @version 238.0.0
|
|
17767
17771
|
*//**
|
|
17768
17772
|
* Constructs a new LocationsApi.
|
|
17769
17773
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -17822,7 +17826,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17822
17826
|
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(){/**
|
|
17823
17827
|
* LogCapture service.
|
|
17824
17828
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
17825
|
-
* @version
|
|
17829
|
+
* @version 238.0.0
|
|
17826
17830
|
*//**
|
|
17827
17831
|
* Constructs a new LogCaptureApi.
|
|
17828
17832
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -17871,7 +17875,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
17871
17875
|
if(userId===undefined||userId===null||userId===''){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(){/**
|
|
17872
17876
|
* Messaging service.
|
|
17873
17877
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
17874
|
-
* @version
|
|
17878
|
+
* @version 238.0.0
|
|
17875
17879
|
*//**
|
|
17876
17880
|
* Constructs a new MessagingApi.
|
|
17877
17881
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -17961,7 +17965,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17961
17965
|
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(){/**
|
|
17962
17966
|
* MobileDevices service.
|
|
17963
17967
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
17964
|
-
* @version
|
|
17968
|
+
* @version 238.0.0
|
|
17965
17969
|
*//**
|
|
17966
17970
|
* Constructs a new MobileDevicesApi.
|
|
17967
17971
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -18000,7 +18004,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18000
18004
|
if(deviceId===undefined||deviceId===null||deviceId===''){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(){/**
|
|
18001
18005
|
* Notifications service.
|
|
18002
18006
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
18003
|
-
* @version
|
|
18007
|
+
* @version 238.0.0
|
|
18004
18008
|
*//**
|
|
18005
18009
|
* Constructs a new NotificationsApi.
|
|
18006
18010
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -18057,7 +18061,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
18057
18061
|
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(){/**
|
|
18058
18062
|
* OAuth service.
|
|
18059
18063
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
18060
|
-
* @version
|
|
18064
|
+
* @version 238.0.0
|
|
18061
18065
|
*//**
|
|
18062
18066
|
* Constructs a new OAuthApi.
|
|
18063
18067
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -18142,7 +18146,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
18142
18146
|
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(){/**
|
|
18143
18147
|
* Objects service.
|
|
18144
18148
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
18145
|
-
* @version
|
|
18149
|
+
* @version 238.0.0
|
|
18146
18150
|
*//**
|
|
18147
18151
|
* Constructs a new ObjectsApi.
|
|
18148
18152
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -18228,7 +18232,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
18228
18232
|
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(){/**
|
|
18229
18233
|
* OperationalEvents service.
|
|
18230
18234
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
18231
|
-
* @version
|
|
18235
|
+
* @version 238.0.0
|
|
18232
18236
|
*//**
|
|
18233
18237
|
* Constructs a new OperationalEventsApi.
|
|
18234
18238
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -18259,7 +18263,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
18259
18263
|
*/},{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(){/**
|
|
18260
18264
|
* Organization service.
|
|
18261
18265
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
18262
|
-
* @version
|
|
18266
|
+
* @version 238.0.0
|
|
18263
18267
|
*//**
|
|
18264
18268
|
* Constructs a new OrganizationApi.
|
|
18265
18269
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -18364,7 +18368,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18364
18368
|
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(){/**
|
|
18365
18369
|
* OrganizationAuthorization service.
|
|
18366
18370
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
18367
|
-
* @version
|
|
18371
|
+
* @version 238.0.0
|
|
18368
18372
|
*//**
|
|
18369
18373
|
* Constructs a new OrganizationAuthorizationApi.
|
|
18370
18374
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -18698,7 +18702,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
18698
18702
|
if(trusteeUserId===undefined||trusteeUserId===null||trusteeUserId===''){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(){/**
|
|
18699
18703
|
* Outbound service.
|
|
18700
18704
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
18701
|
-
* @version
|
|
18705
|
+
* @version 238.0.0
|
|
18702
18706
|
*//**
|
|
18703
18707
|
* Constructs a new OutboundApi.
|
|
18704
18708
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -19854,7 +19858,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19854
19858
|
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(){/**
|
|
19855
19859
|
* Presence service.
|
|
19856
19860
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
19857
|
-
* @version
|
|
19861
|
+
* @version 238.0.0
|
|
19858
19862
|
*//**
|
|
19859
19863
|
* Constructs a new PresenceApi.
|
|
19860
19864
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -20027,7 +20031,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20027
20031
|
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(){/**
|
|
20028
20032
|
* ProcessAutomation service.
|
|
20029
20033
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
20030
|
-
* @version
|
|
20034
|
+
* @version 238.0.0
|
|
20031
20035
|
*//**
|
|
20032
20036
|
* Constructs a new ProcessAutomationApi.
|
|
20033
20037
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -20090,7 +20094,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
20090
20094
|
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(){/**
|
|
20091
20095
|
* Quality service.
|
|
20092
20096
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
20093
|
-
* @version
|
|
20097
|
+
* @version 238.0.0
|
|
20094
20098
|
*//**
|
|
20095
20099
|
* Constructs a new QualityApi.
|
|
20096
20100
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -20580,7 +20584,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
20580
20584
|
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(){/**
|
|
20581
20585
|
* Recording service.
|
|
20582
20586
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
20583
|
-
* @version
|
|
20587
|
+
* @version 238.0.0
|
|
20584
20588
|
*//**
|
|
20585
20589
|
* Constructs a new RecordingApi.
|
|
20586
20590
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -20979,7 +20983,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20979
20983
|
*/},{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(){/**
|
|
20980
20984
|
* ResponseManagement service.
|
|
20981
20985
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
20982
|
-
* @version
|
|
20986
|
+
* @version 238.0.0
|
|
20983
20987
|
*//**
|
|
20984
20988
|
* Constructs a new ResponseManagementApi.
|
|
20985
20989
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -21100,7 +21104,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
21100
21104
|
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(){/**
|
|
21101
21105
|
* Routing service.
|
|
21102
21106
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
21103
|
-
* @version
|
|
21107
|
+
* @version 238.0.0
|
|
21104
21108
|
*//**
|
|
21105
21109
|
* Constructs a new RoutingApi.
|
|
21106
21110
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -22191,7 +22195,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22191
22195
|
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(){/**
|
|
22192
22196
|
* SCIM service.
|
|
22193
22197
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
22194
|
-
* @version
|
|
22198
|
+
* @version 238.0.0
|
|
22195
22199
|
*//**
|
|
22196
22200
|
* Constructs a new SCIMApi.
|
|
22197
22201
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -22416,7 +22420,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22416
22420
|
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(){/**
|
|
22417
22421
|
* ScreenRecording service.
|
|
22418
22422
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
22419
|
-
* @version
|
|
22423
|
+
* @version 238.0.0
|
|
22420
22424
|
*//**
|
|
22421
22425
|
* Constructs a new ScreenRecordingApi.
|
|
22422
22426
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -22431,7 +22435,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22431
22435
|
*/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(){/**
|
|
22432
22436
|
* Scripts service.
|
|
22433
22437
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
22434
|
-
* @version
|
|
22438
|
+
* @version 238.0.0
|
|
22435
22439
|
*//**
|
|
22436
22440
|
* Constructs a new ScriptsApi.
|
|
22437
22441
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -22577,7 +22581,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
22577
22581
|
*/},{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(){/**
|
|
22578
22582
|
* Search service.
|
|
22579
22583
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
22580
|
-
* @version
|
|
22584
|
+
* @version 238.0.0
|
|
22581
22585
|
*//**
|
|
22582
22586
|
* Constructs a new SearchApi.
|
|
22583
22587
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -22736,7 +22740,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22736
22740
|
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(){/**
|
|
22737
22741
|
* Settings service.
|
|
22738
22742
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
22739
|
-
* @version
|
|
22743
|
+
* @version 238.0.0
|
|
22740
22744
|
*//**
|
|
22741
22745
|
* Constructs a new SettingsApi.
|
|
22742
22746
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -22808,7 +22812,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
22808
22812
|
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(){/**
|
|
22809
22813
|
* SocialMedia service.
|
|
22810
22814
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
22811
|
-
* @version
|
|
22815
|
+
* @version 238.0.0
|
|
22812
22816
|
*//**
|
|
22813
22817
|
* Constructs a new SocialMediaApi.
|
|
22814
22818
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -23223,7 +23227,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
23223
23227
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null||twitterIngestionRuleId===''){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(){/**
|
|
23224
23228
|
* SpeechTextAnalytics service.
|
|
23225
23229
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
23226
|
-
* @version
|
|
23230
|
+
* @version 238.0.0
|
|
23227
23231
|
*//**
|
|
23228
23232
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
23229
23233
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -23593,7 +23597,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
23593
23597
|
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(){/**
|
|
23594
23598
|
* Stations service.
|
|
23595
23599
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
23596
|
-
* @version
|
|
23600
|
+
* @version 238.0.0
|
|
23597
23601
|
*//**
|
|
23598
23602
|
* Constructs a new StationsApi.
|
|
23599
23603
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -23625,7 +23629,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
23625
23629
|
*/},{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(){/**
|
|
23626
23630
|
* Suggest service.
|
|
23627
23631
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
23628
|
-
* @version
|
|
23632
|
+
* @version 238.0.0
|
|
23629
23633
|
*//**
|
|
23630
23634
|
* Constructs a new SuggestApi.
|
|
23631
23635
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -23665,7 +23669,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23665
23669
|
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(){/**
|
|
23666
23670
|
* TaskManagement service.
|
|
23667
23671
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
23668
|
-
* @version
|
|
23672
|
+
* @version 238.0.0
|
|
23669
23673
|
*//**
|
|
23670
23674
|
* Constructs a new TaskManagementApi.
|
|
23671
23675
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -24173,7 +24177,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
24173
24177
|
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(){/**
|
|
24174
24178
|
* Teams service.
|
|
24175
24179
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
24176
|
-
* @version
|
|
24180
|
+
* @version 238.0.0
|
|
24177
24181
|
*//**
|
|
24178
24182
|
* Constructs a new TeamsApi.
|
|
24179
24183
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -24253,7 +24257,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24253
24257
|
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(){/**
|
|
24254
24258
|
* Telephony service.
|
|
24255
24259
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
24256
|
-
* @version
|
|
24260
|
+
* @version 238.0.0
|
|
24257
24261
|
*//**
|
|
24258
24262
|
* Constructs a new TelephonyApi.
|
|
24259
24263
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -24324,7 +24328,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24324
24328
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyAgentsGreetingsMe';}return this.apiClient.callApi('/api/v2/telephony/agents/greetings/me','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
24325
24329
|
* TelephonyProvidersEdge service.
|
|
24326
24330
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
24327
|
-
* @version
|
|
24331
|
+
* @version 238.0.0
|
|
24328
24332
|
*//**
|
|
24329
24333
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
24330
24334
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -25172,7 +25176,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
25172
25176
|
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(){/**
|
|
25173
25177
|
* Textbots service.
|
|
25174
25178
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
25175
|
-
* @version
|
|
25179
|
+
* @version 238.0.0
|
|
25176
25180
|
*//**
|
|
25177
25181
|
* Constructs a new TextbotsApi.
|
|
25178
25182
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -25208,7 +25212,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
25208
25212
|
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(){/**
|
|
25209
25213
|
* Tokens service.
|
|
25210
25214
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
25211
|
-
* @version
|
|
25215
|
+
* @version 238.0.0
|
|
25212
25216
|
*//**
|
|
25213
25217
|
* Constructs a new TokensApi.
|
|
25214
25218
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -25242,7 +25246,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
25242
25246
|
*/},{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(){/**
|
|
25243
25247
|
* Uploads service.
|
|
25244
25248
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
25245
|
-
* @version
|
|
25249
|
+
* @version 238.0.0
|
|
25246
25250
|
*//**
|
|
25247
25251
|
* Constructs a new UploadsApi.
|
|
25248
25252
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -25310,7 +25314,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25310
25314
|
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(){/**
|
|
25311
25315
|
* Usage service.
|
|
25312
25316
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
25313
|
-
* @version
|
|
25317
|
+
* @version 238.0.0
|
|
25314
25318
|
*//**
|
|
25315
25319
|
* Constructs a new UsageApi.
|
|
25316
25320
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -25394,7 +25398,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25394
25398
|
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(){/**
|
|
25395
25399
|
* UserRecordings service.
|
|
25396
25400
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
25397
|
-
* @version
|
|
25401
|
+
* @version 238.0.0
|
|
25398
25402
|
*//**
|
|
25399
25403
|
* Constructs a new UserRecordingsApi.
|
|
25400
25404
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -25442,7 +25446,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
25442
25446
|
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(){/**
|
|
25443
25447
|
* Users service.
|
|
25444
25448
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
25445
|
-
* @version
|
|
25449
|
+
* @version 238.0.0
|
|
25446
25450
|
*//**
|
|
25447
25451
|
* Constructs a new UsersApi.
|
|
25448
25452
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -26183,10 +26187,93 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
26183
26187
|
*/},{key:"putUserVerifier",value:function putUserVerifier(userId,verifierId,body){// verify the required parameter 'userId' is set
|
|
26184
26188
|
if(userId===undefined||userId===null||userId===''){throw'Missing the required parameter "userId" when calling putUserVerifier';}// verify the required parameter 'verifierId' is set
|
|
26185
26189
|
if(verifierId===undefined||verifierId===null||verifierId===''){throw'Missing the required parameter "verifierId" when calling putUserVerifier';}// verify the required parameter 'body' is set
|
|
26186
|
-
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
|
|
26190
|
+
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 UsersRulesApi=/*#__PURE__*/function(){/**
|
|
26191
|
+
* UsersRules service.
|
|
26192
|
+
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
26193
|
+
* @version 238.0.0
|
|
26194
|
+
*//**
|
|
26195
|
+
* Constructs a new UsersRulesApi.
|
|
26196
|
+
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
26197
|
+
* @class
|
|
26198
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
26199
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
26200
|
+
*/function UsersRulesApi(apiClient){_classCallCheck(this,UsersRulesApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
26201
|
+
* Delete an existing users rule
|
|
26202
|
+
*
|
|
26203
|
+
* @param {String} ruleId The id of the rule
|
|
26204
|
+
* deleteUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26205
|
+
*/return _createClass(UsersRulesApi,[{key:"deleteUsersRule",value:function deleteUsersRule(ruleId){// verify the required parameter 'ruleId' is set
|
|
26206
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling deleteUsersRule';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}','DELETE',{'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26207
|
+
* Get a users rule
|
|
26208
|
+
*
|
|
26209
|
+
* @param {String} ruleId The ID of the rule to retrieve
|
|
26210
|
+
* getUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26211
|
+
*/},{key:"getUsersRule",value:function getUsersRule(ruleId){// verify the required parameter 'ruleId' is set
|
|
26212
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling getUsersRule';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}','GET',{'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26213
|
+
* Get dependent of a users rule
|
|
26214
|
+
*
|
|
26215
|
+
* @param {String} ruleId The ID of the rule for which to retrieve dependents
|
|
26216
|
+
* @param {Object} ruleType The type of the dependent
|
|
26217
|
+
* @param {String} typeId The type ID of the dependent
|
|
26218
|
+
* getUsersRuleDependentTypeId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26219
|
+
*/},{key:"getUsersRuleDependentTypeId",value:function getUsersRuleDependentTypeId(ruleId,ruleType,typeId){// verify the required parameter 'ruleId' is set
|
|
26220
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling getUsersRuleDependentTypeId';}// verify the required parameter 'ruleType' is set
|
|
26221
|
+
if(ruleType===undefined||ruleType===null||ruleType===''){throw'Missing the required parameter "ruleType" when calling getUsersRuleDependentTypeId';}// verify the required parameter 'typeId' is set
|
|
26222
|
+
if(typeId===undefined||typeId===null||typeId===''){throw'Missing the required parameter "typeId" when calling getUsersRuleDependentTypeId';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}/dependents/{ruleType}/{typeId}','GET',{'ruleId':ruleId,'ruleType':ruleType,'typeId':typeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26223
|
+
* Get dependents for a users rule
|
|
26224
|
+
*
|
|
26225
|
+
* @param {String} ruleId The ID of the rule for which to retrieve dependents
|
|
26226
|
+
* @param {Object} opts Optional parameters
|
|
26227
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
26228
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
26229
|
+
* @param {Object} opts.sortOrder Sort order for dependents (by last run date, then created date) (default to descending)
|
|
26230
|
+
* getUsersRuleDependents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26231
|
+
*/},{key:"getUsersRuleDependents",value:function getUsersRuleDependents(ruleId,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
26232
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling getUsersRuleDependents';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}/dependents','GET',{'ruleId':ruleId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26233
|
+
* Get the list of users rules
|
|
26234
|
+
*
|
|
26235
|
+
* @param {Array.<String>} types The types of the rule
|
|
26236
|
+
* @param {Object} opts Optional parameters
|
|
26237
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
26238
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
26239
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
26240
|
+
* @param {String} opts.searchTerm a search term for finding a rule by name
|
|
26241
|
+
* @param {Object} opts.sortOrder sort rules by name, ascending, descending (default to ascending)
|
|
26242
|
+
* getUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26243
|
+
*/},{key:"getUsersRules",value:function getUsersRules(types,opts){opts=opts||{};// verify the required parameter 'types' is set
|
|
26244
|
+
if(types===undefined||types===null){throw'Missing the required parameter "types" when calling getUsersRules';}return this.apiClient.callApi('/api/v2/users/rules','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'types':this.apiClient.buildCollectionParam(types,'multi'),'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'searchTerm':opts['searchTerm'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26245
|
+
* Get the settings for a specific users rule type
|
|
26246
|
+
*
|
|
26247
|
+
* @param {Object} ruleType The type of the rule
|
|
26248
|
+
* getUsersRulesSetting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26249
|
+
*/},{key:"getUsersRulesSetting",value:function getUsersRulesSetting(ruleType){// verify the required parameter 'ruleType' is set
|
|
26250
|
+
if(ruleType===undefined||ruleType===null||ruleType===''){throw'Missing the required parameter "ruleType" when calling getUsersRulesSetting';}return this.apiClient.callApi('/api/v2/users/rules/settings/{ruleType}','GET',{'ruleType':ruleType},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26251
|
+
* Update an existing users rule
|
|
26252
|
+
* This will update an existing users rule with the specified fields.
|
|
26253
|
+
* @param {String} ruleId The ID of the rule to update
|
|
26254
|
+
* @param {Object} body updateRuleRequest
|
|
26255
|
+
* patchUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26256
|
+
*/},{key:"patchUsersRule",value:function patchUsersRule(ruleId,body){// verify the required parameter 'ruleId' is set
|
|
26257
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling patchUsersRule';}// verify the required parameter 'body' is set
|
|
26258
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUsersRule';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}','PATCH',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26259
|
+
* Create a new rule
|
|
26260
|
+
* This will create a new rule with the specified fields.
|
|
26261
|
+
* @param {Object} body usersRulesCreateRuleRequest
|
|
26262
|
+
* postUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26263
|
+
*/},{key:"postUsersRules",value:function postUsersRules(body){// verify the required parameter 'body' is set
|
|
26264
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsersRules';}return this.apiClient.callApi('/api/v2/users/rules','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26265
|
+
* Query the result of a users rule
|
|
26266
|
+
* This will query the result of a rule.
|
|
26267
|
+
* @param {Object} body usersRulesQueryRuleRequest
|
|
26268
|
+
* @param {Object} opts Optional parameters
|
|
26269
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
26270
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
26271
|
+
* postUsersRulesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26272
|
+
*/},{key:"postUsersRulesQuery",value:function postUsersRulesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
26273
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsersRulesQuery';}return this.apiClient.callApi('/api/v2/users/rules/query','POST',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
26187
26274
|
* Utilities service.
|
|
26188
26275
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
26189
|
-
* @version
|
|
26276
|
+
* @version 238.0.0
|
|
26190
26277
|
*//**
|
|
26191
26278
|
* Constructs a new UtilitiesApi.
|
|
26192
26279
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -26213,7 +26300,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26213
26300
|
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(){/**
|
|
26214
26301
|
* Voicemail service.
|
|
26215
26302
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
26216
|
-
* @version
|
|
26303
|
+
* @version 238.0.0
|
|
26217
26304
|
*//**
|
|
26218
26305
|
* Constructs a new VoicemailApi.
|
|
26219
26306
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -26375,7 +26462,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
26375
26462
|
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(){/**
|
|
26376
26463
|
* WebChat service.
|
|
26377
26464
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
26378
|
-
* @version
|
|
26465
|
+
* @version 238.0.0
|
|
26379
26466
|
*//**
|
|
26380
26467
|
* Constructs a new WebChatApi.
|
|
26381
26468
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -26522,7 +26609,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26522
26609
|
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(){/**
|
|
26523
26610
|
* WebDeployments service.
|
|
26524
26611
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
26525
|
-
* @version
|
|
26612
|
+
* @version 238.0.0
|
|
26526
26613
|
*//**
|
|
26527
26614
|
* Constructs a new WebDeploymentsApi.
|
|
26528
26615
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -26655,7 +26742,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
26655
26742
|
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(){/**
|
|
26656
26743
|
* WebMessaging service.
|
|
26657
26744
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
26658
|
-
* @version
|
|
26745
|
+
* @version 238.0.0
|
|
26659
26746
|
*//**
|
|
26660
26747
|
* Constructs a new WebMessagingApi.
|
|
26661
26748
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -26696,7 +26783,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
26696
26783
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWebmessagingDeploymentPushdevice';}return this.apiClient.callApi('/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}','POST',{'deploymentId':deploymentId,'tokenId':tokenId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
26697
26784
|
* Widgets service.
|
|
26698
26785
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
26699
|
-
* @version
|
|
26786
|
+
* @version 238.0.0
|
|
26700
26787
|
*//**
|
|
26701
26788
|
* Constructs a new WidgetsApi.
|
|
26702
26789
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -26736,7 +26823,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
26736
26823
|
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(){/**
|
|
26737
26824
|
* WorkforceManagement service.
|
|
26738
26825
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
26739
|
-
* @version
|
|
26826
|
+
* @version 238.0.0
|
|
26740
26827
|
*//**
|
|
26741
26828
|
* Constructs a new WorkforceManagementApi.
|
|
26742
26829
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -26914,6 +27001,11 @@ if(explanationId===undefined||explanationId===null||explanationId===''){throw'Mi
|
|
|
26914
27001
|
* @param {String} agentId The ID of the agent to look up
|
|
26915
27002
|
*/},{key:"getWorkforcemanagementAgentManagementunit",value:function getWorkforcemanagementAgentManagementunit(agentId){// verify the required parameter 'agentId' is set
|
|
26916
27003
|
if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentManagementunit';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/{agentId}/managementunit','GET',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
27004
|
+
* Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status
|
|
27005
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
27006
|
+
* @param {String} jobId ID of the job to get
|
|
27007
|
+
*/},{key:"getWorkforcemanagementAgentsMeAdherenceHistoricalJob",value:function getWorkforcemanagementAgentsMeAdherenceHistoricalJob(jobId){// verify the required parameter 'jobId' is set
|
|
27008
|
+
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAgentsMeAdherenceHistoricalJob';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26917
27009
|
* Get the management unit to which the currently logged in agent belongs
|
|
26918
27010
|
*
|
|
26919
27011
|
*/},{key:"getWorkforcemanagementAgentsMeManagementunit",value:function getWorkforcemanagementAgentsMeManagementunit(){return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/managementunit','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -27959,6 +28051,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27959
28051
|
* @param {Object} body body
|
|
27960
28052
|
*/},{key:"postWorkforcemanagementAgentsIntegrationsHrisQuery",value:function postWorkforcemanagementAgentsIntegrationsHrisQuery(body){// verify the required parameter 'body' is set
|
|
27961
28053
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsIntegrationsHrisQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/integrations/hris/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
28054
|
+
* Request an agent historical adherence report
|
|
28055
|
+
* The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
|
|
28056
|
+
* @param {Object} opts Optional parameters
|
|
28057
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities.
|
|
28058
|
+
* @param {Object} opts.body body
|
|
28059
|
+
*/},{key:"postWorkforcemanagementAgentsMeAdherenceHistoricalJobs",value:function postWorkforcemanagementAgentsMeAdherenceHistoricalJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/adherence/historical/jobs','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
27962
28060
|
* Get agent possible work shifts for requested time frame
|
|
27963
28061
|
*
|
|
27964
28062
|
* @param {Object} body body
|
|
@@ -28697,7 +28795,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
28697
28795
|
* </pre>
|
|
28698
28796
|
* </p>
|
|
28699
28797
|
* @module purecloud-platform-client-v2/index
|
|
28700
|
-
* @version
|
|
28798
|
+
* @version 238.0.0
|
|
28701
28799
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
28702
28800
|
* The ApiClient constructor.
|
|
28703
28801
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -28930,6 +29028,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
28930
29028
|
* The UsersApi service constructor.
|
|
28931
29029
|
* @property {module:purecloud-platform-client-v2/api/UsersApi}
|
|
28932
29030
|
*/this.UsersApi=UsersApi;/**
|
|
29031
|
+
* The UsersRulesApi service constructor.
|
|
29032
|
+
* @property {module:purecloud-platform-client-v2/api/UsersRulesApi}
|
|
29033
|
+
*/this.UsersRulesApi=UsersRulesApi;/**
|
|
28933
29034
|
* The UtilitiesApi service constructor.
|
|
28934
29035
|
* @property {module:purecloud-platform-client-v2/api/UtilitiesApi}
|
|
28935
29036
|
*/this.UtilitiesApi=UtilitiesApi;/**
|