purecloud-platform-client-v2 221.0.0 → 222.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 +210 -95
- package/dist/web-amd/purecloud-platform-client-v2.js +210 -95
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +124 -95
- package/dist/web-cjs/purecloud-platform-client-v2.js +124 -95
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +448 -250
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +119 -7
- 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 +3 -3
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +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 +2 -2
- 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 +3 -2
- 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/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 +3 -2
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -892,7 +892,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
892
892
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
893
893
|
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];}}}]);}();/**
|
|
894
894
|
* @module purecloud-platform-client-v2/ApiClient
|
|
895
|
-
* @version
|
|
895
|
+
* @version 222.0.0
|
|
896
896
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
897
897
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
898
898
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1235,7 +1235,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1235
1235
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1236
1236
|
* AgentAssistants service.
|
|
1237
1237
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1238
|
-
* @version
|
|
1238
|
+
* @version 222.0.0
|
|
1239
1239
|
*//**
|
|
1240
1240
|
* Constructs a new AgentAssistantsApi.
|
|
1241
1241
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1336,7 +1336,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1336
1336
|
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(){/**
|
|
1337
1337
|
* AgentCopilot service.
|
|
1338
1338
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1339
|
-
* @version
|
|
1339
|
+
* @version 222.0.0
|
|
1340
1340
|
*//**
|
|
1341
1341
|
* Constructs a new AgentCopilotApi.
|
|
1342
1342
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1358,7 +1358,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1358
1358
|
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(){/**
|
|
1359
1359
|
* AgentUI service.
|
|
1360
1360
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1361
|
-
* @version
|
|
1361
|
+
* @version 222.0.0
|
|
1362
1362
|
*//**
|
|
1363
1363
|
* Constructs a new AgentUIApi.
|
|
1364
1364
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1392,7 +1392,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1392
1392
|
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(){/**
|
|
1393
1393
|
* Alerting service.
|
|
1394
1394
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1395
|
-
* @version
|
|
1395
|
+
* @version 222.0.0
|
|
1396
1396
|
*//**
|
|
1397
1397
|
* Constructs a new AlertingApi.
|
|
1398
1398
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1481,7 +1481,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1481
1481
|
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(){/**
|
|
1482
1482
|
* Analytics service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 222.0.0
|
|
1485
1485
|
*//**
|
|
1486
1486
|
* Constructs a new AnalyticsApi.
|
|
1487
1487
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -2149,7 +2149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2149
2149
|
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(){/**
|
|
2150
2150
|
* Architect service.
|
|
2151
2151
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2152
|
-
* @version
|
|
2152
|
+
* @version 222.0.0
|
|
2153
2153
|
*//**
|
|
2154
2154
|
* Constructs a new ArchitectApi.
|
|
2155
2155
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2715,10 +2715,11 @@ if(flowId===undefined||flowId===null){throw'Missing the required parameter "flow
|
|
|
2715
2715
|
* @param {Object} opts.secure Secure
|
|
2716
2716
|
* @param {Boolean} opts.deleted Include deleted (default to false)
|
|
2717
2717
|
* @param {Boolean} opts.includeSchemas Include variable schemas (default to false)
|
|
2718
|
+
* @param {Boolean} opts.virtualAgentEnabled Include/exclude virtual agent flows
|
|
2718
2719
|
* @param {String} opts.publishedAfter Published after
|
|
2719
2720
|
* @param {String} opts.publishedBefore Published before
|
|
2720
2721
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
2721
|
-
*/},{key:"getFlows",value:function getFlows(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows','GET',{},{'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name'],'description':opts['description'],'nameOrDescription':opts['nameOrDescription'],'publishVersionId':opts['publishVersionId'],'editableBy':opts['editableBy'],'lockedBy':opts['lockedBy'],'lockedByClientId':opts['lockedByClientId'],'secure':opts['secure'],'deleted':opts['deleted'],'includeSchemas':opts['includeSchemas'],'publishedAfter':opts['publishedAfter'],'publishedBefore':opts['publishedBefore'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2722
|
+
*/},{key:"getFlows",value:function getFlows(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows','GET',{},{'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name'],'description':opts['description'],'nameOrDescription':opts['nameOrDescription'],'publishVersionId':opts['publishVersionId'],'editableBy':opts['editableBy'],'lockedBy':opts['lockedBy'],'lockedByClientId':opts['lockedByClientId'],'secure':opts['secure'],'deleted':opts['deleted'],'includeSchemas':opts['includeSchemas'],'virtualAgentEnabled':opts['virtualAgentEnabled'],'publishedAfter':opts['publishedAfter'],'publishedBefore':opts['publishedBefore'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2722
2723
|
* Returns a specific datatable by id
|
|
2723
2724
|
* Given a datatableId returns the datatable object and schema associated with it.
|
|
2724
2725
|
* @param {String} datatableId id of datatable
|
|
@@ -3280,7 +3281,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3280
3281
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
3281
3282
|
* Audit service.
|
|
3282
3283
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3283
|
-
* @version
|
|
3284
|
+
* @version 222.0.0
|
|
3284
3285
|
*//**
|
|
3285
3286
|
* Constructs a new AuditApi.
|
|
3286
3287
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3330,7 +3331,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3330
3331
|
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(){/**
|
|
3331
3332
|
* Authorization service.
|
|
3332
3333
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3333
|
-
* @version
|
|
3334
|
+
* @version 222.0.0
|
|
3334
3335
|
*//**
|
|
3335
3336
|
* Constructs a new AuthorizationApi.
|
|
3336
3337
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3765,7 +3766,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3765
3766
|
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(){/**
|
|
3766
3767
|
* Billing service.
|
|
3767
3768
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3768
|
-
* @version
|
|
3769
|
+
* @version 222.0.0
|
|
3769
3770
|
*//**
|
|
3770
3771
|
* Constructs a new BillingApi.
|
|
3771
3772
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3842,7 +3843,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3842
3843
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var BusinessRulesApi=/*#__PURE__*/function(){/**
|
|
3843
3844
|
* BusinessRules service.
|
|
3844
3845
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
3845
|
-
* @version
|
|
3846
|
+
* @version 222.0.0
|
|
3846
3847
|
*//**
|
|
3847
3848
|
* Constructs a new BusinessRulesApi.
|
|
3848
3849
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -4090,7 +4091,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
4090
4091
|
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(){/**
|
|
4091
4092
|
* CarrierServices service.
|
|
4092
4093
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
4093
|
-
* @version
|
|
4094
|
+
* @version 222.0.0
|
|
4094
4095
|
*//**
|
|
4095
4096
|
* Constructs a new CarrierServicesApi.
|
|
4096
4097
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -4110,7 +4111,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
4110
4111
|
*/},{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(){/**
|
|
4111
4112
|
* Chat service.
|
|
4112
4113
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
4113
|
-
* @version
|
|
4114
|
+
* @version 222.0.0
|
|
4114
4115
|
*//**
|
|
4115
4116
|
* Constructs a new ChatApi.
|
|
4116
4117
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -4330,7 +4331,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4330
4331
|
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(){/**
|
|
4331
4332
|
* Coaching service.
|
|
4332
4333
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
4333
|
-
* @version
|
|
4334
|
+
* @version 222.0.0
|
|
4334
4335
|
*//**
|
|
4335
4336
|
* Constructs a new CoachingApi.
|
|
4336
4337
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4483,7 +4484,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4483
4484
|
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(){/**
|
|
4484
4485
|
* ContentManagement service.
|
|
4485
4486
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4486
|
-
* @version
|
|
4487
|
+
* @version 222.0.0
|
|
4487
4488
|
*//**
|
|
4488
4489
|
* Constructs a new ContentManagementApi.
|
|
4489
4490
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4765,7 +4766,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4765
4766
|
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(){/**
|
|
4766
4767
|
* Conversations service.
|
|
4767
4768
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4768
|
-
* @version
|
|
4769
|
+
* @version 222.0.0
|
|
4769
4770
|
*//**
|
|
4770
4771
|
* Constructs a new ConversationsApi.
|
|
4771
4772
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5222,7 +5223,7 @@ if(mediaId===undefined||mediaId===null){throw'Missing the required parameter "me
|
|
|
5222
5223
|
*
|
|
5223
5224
|
* @param {String} messageId messageId
|
|
5224
5225
|
* @param {Object} opts Optional parameters
|
|
5225
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
5226
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
5226
5227
|
*/},{key:"getConversationsMessageDetails",value:function getConversationsMessageDetails(messageId,opts){opts=opts||{};// verify the required parameter 'messageId' is set
|
|
5227
5228
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling getConversationsMessageDetails';}return this.apiClient.callApi('/api/v2/conversations/messages/{messageId}/details','GET',{'messageId':messageId},{'useNormalizedMessage':opts['useNormalizedMessage']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5228
5229
|
* Get conversation message
|
|
@@ -5230,7 +5231,7 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
5230
5231
|
* @param {String} conversationId conversationId
|
|
5231
5232
|
* @param {String} messageId messageId
|
|
5232
5233
|
* @param {Object} opts Optional parameters
|
|
5233
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
5234
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
5234
5235
|
*/},{key:"getConversationsMessageMessage",value:function getConversationsMessageMessage(conversationId,messageId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
5235
5236
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsMessageMessage';}// verify the required parameter 'messageId' is set
|
|
5236
5237
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling getConversationsMessageMessage';}return this.apiClient.callApi('/api/v2/conversations/messages/{conversationId}/messages/{messageId}','GET',{'conversationId':conversationId,'messageId':messageId},{'useNormalizedMessage':opts['useNormalizedMessage']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5282,11 +5283,22 @@ if(cachedMediaItemId===undefined||cachedMediaItemId===null){throw'Missing the re
|
|
|
5282
5283
|
* Get a list of Facebook Permissions
|
|
5283
5284
|
*
|
|
5284
5285
|
*/},{key:"getConversationsMessagingFacebookPermissions",value:function getConversationsMessagingFacebookPermissions(){return this.apiClient.callApi('/api/v2/conversations/messaging/facebook/permissions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5286
|
+
* Get Apple messaging integration identity resolution settings
|
|
5287
|
+
*
|
|
5288
|
+
* @param {String} integrationId Integration ID
|
|
5289
|
+
* getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5290
|
+
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
5291
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5285
5292
|
* Get Facebook messaging integration identity resolution settings
|
|
5286
5293
|
*
|
|
5287
5294
|
* @param {String} integrationId Integration ID
|
|
5288
5295
|
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
5289
5296
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5297
|
+
* Get an Instagram integration identity resolution settings
|
|
5298
|
+
*
|
|
5299
|
+
* @param {String} integrationId Integration ID
|
|
5300
|
+
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
5301
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5290
5302
|
* Get an open messaging integration Identity Resolution settings
|
|
5291
5303
|
*
|
|
5292
5304
|
* @param {String} integrationId Integration ID
|
|
@@ -5820,7 +5832,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5820
5832
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}// verify the required parameter 'body' is set
|
|
5821
5833
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5822
5834
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
5823
|
-
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the
|
|
5835
|
+
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the GET call on the integration with a createStatus of Completed. You can then run a GET on the integration to check if its status has been updated to Active.
|
|
5824
5836
|
* @param {String} integrationId Integration ID
|
|
5825
5837
|
* @param {Object} body WhatsAppEmbeddedSignupIntegrationActivationRequest
|
|
5826
5838
|
*/},{key:"patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId",value:function patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
@@ -6270,12 +6282,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6270
6282
|
*/},{key:"postConversationsKeyconfigurationsValidate",value:function postConversationsKeyconfigurationsValidate(body){// verify the required parameter 'body' is set
|
|
6271
6283
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';}return this.apiClient.callApi('/api/v2/conversations/keyconfigurations/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6272
6284
|
* Send message
|
|
6273
|
-
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId,
|
|
6285
|
+
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.
|
|
6274
6286
|
* @param {String} conversationId conversationId
|
|
6275
6287
|
* @param {String} communicationId communicationId
|
|
6276
6288
|
* @param {Object} body Message
|
|
6277
6289
|
* @param {Object} opts Optional parameters
|
|
6278
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
6290
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
6279
6291
|
*/},{key:"postConversationsMessageCommunicationMessages",value:function postConversationsMessageCommunicationMessages(conversationId,communicationId,body,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
6280
6292
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessages';}// verify the required parameter 'communicationId' is set
|
|
6281
6293
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessages';}// verify the required parameter 'body' is set
|
|
@@ -6333,7 +6345,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6333
6345
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
6334
6346
|
* @param {String} conversationId
|
|
6335
6347
|
* @param {Object} opts Optional parameters
|
|
6336
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
6348
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
6337
6349
|
* @param {Array.<String>} opts.body messageIds
|
|
6338
6350
|
*/},{key:"postConversationsMessageMessagesBulk",value:function postConversationsMessageMessagesBulk(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
6339
6351
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsMessageMessagesBulk';}return this.apiClient.callApi('/api/v2/conversations/messages/{conversationId}/messages/bulk','POST',{'conversationId':conversationId},{'useNormalizedMessage':opts['useNormalizedMessage']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -6566,6 +6578,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6566
6578
|
*/},{key:"putConversationsMessageRecordingstate",value:function putConversationsMessageRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
6567
6579
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';}// verify the required parameter 'body' is set
|
|
6568
6580
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/messages/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6581
|
+
* Create an identity resolution settings for a Apple messaging integration
|
|
6582
|
+
*
|
|
6583
|
+
* @param {String} integrationId Integration ID
|
|
6584
|
+
* @param {Object} body IdentityResolutionConfig
|
|
6585
|
+
* putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6586
|
+
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
6587
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';}// verify the required parameter 'body' is set
|
|
6588
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}','PUT',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6569
6589
|
* Create an identity resolution settings for a Facebook messaging integration
|
|
6570
6590
|
*
|
|
6571
6591
|
* @param {String} integrationId Integration ID
|
|
@@ -6573,6 +6593,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6573
6593
|
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
6574
6594
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';}// verify the required parameter 'body' is set
|
|
6575
6595
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}','PUT',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6596
|
+
* Create identity resolution settings for an Instagram messaging integration
|
|
6597
|
+
*
|
|
6598
|
+
* @param {String} integrationId Integration ID
|
|
6599
|
+
* @param {Object} body IdentityResolutionConfig
|
|
6600
|
+
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
6601
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';}// verify the required parameter 'body' is set
|
|
6602
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}','PUT',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6576
6603
|
* Update an open messaging integration Identity Resolution settings
|
|
6577
6604
|
*
|
|
6578
6605
|
* @param {String} integrationId Integration ID
|
|
@@ -6626,7 +6653,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6626
6653
|
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(){/**
|
|
6627
6654
|
* DataExtensions service.
|
|
6628
6655
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6629
|
-
* @version
|
|
6656
|
+
* @version 222.0.0
|
|
6630
6657
|
*//**
|
|
6631
6658
|
* Constructs a new DataExtensionsApi.
|
|
6632
6659
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6647,7 +6674,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6647
6674
|
*/},{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(){/**
|
|
6648
6675
|
* DataPrivacy service.
|
|
6649
6676
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
6650
|
-
* @version
|
|
6677
|
+
* @version 222.0.0
|
|
6651
6678
|
*//**
|
|
6652
6679
|
* Constructs a new DataPrivacyApi.
|
|
6653
6680
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -6687,7 +6714,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6687
6714
|
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(){/**
|
|
6688
6715
|
* Downloads service.
|
|
6689
6716
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6690
|
-
* @version
|
|
6717
|
+
* @version 222.0.0
|
|
6691
6718
|
*//**
|
|
6692
6719
|
* Constructs a new DownloadsApi.
|
|
6693
6720
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6706,7 +6733,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6706
6733
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
6707
6734
|
* Emails service.
|
|
6708
6735
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6709
|
-
* @version
|
|
6736
|
+
* @version 222.0.0
|
|
6710
6737
|
*//**
|
|
6711
6738
|
* Constructs a new EmailsApi.
|
|
6712
6739
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6735,7 +6762,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6735
6762
|
*/},{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(){/**
|
|
6736
6763
|
* EmployeeEngagement service.
|
|
6737
6764
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6738
|
-
* @version
|
|
6765
|
+
* @version 222.0.0
|
|
6739
6766
|
*//**
|
|
6740
6767
|
* Constructs a new EmployeeEngagementApi.
|
|
6741
6768
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6773,7 +6800,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6773
6800
|
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(){/**
|
|
6774
6801
|
* Events service.
|
|
6775
6802
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6776
|
-
* @version
|
|
6803
|
+
* @version 222.0.0
|
|
6777
6804
|
*//**
|
|
6778
6805
|
* Constructs a new EventsApi.
|
|
6779
6806
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6798,7 +6825,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6798
6825
|
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(){/**
|
|
6799
6826
|
* ExternalContacts service.
|
|
6800
6827
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6801
|
-
* @version
|
|
6828
|
+
* @version 222.0.0
|
|
6802
6829
|
*//**
|
|
6803
6830
|
* Constructs a new ExternalContactsApi.
|
|
6804
6831
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6949,7 +6976,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
6949
6976
|
* Get a list of schemas.
|
|
6950
6977
|
*
|
|
6951
6978
|
*/},{key:"getExternalcontactsContactsSchemas",value:function getExternalcontactsContactsSchemas(){return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6952
|
-
* Get
|
|
6979
|
+
* Get a specific named core type.
|
|
6953
6980
|
*
|
|
6954
6981
|
* @param {String} coreTypeName Name of the core type
|
|
6955
6982
|
*/},{key:"getExternalcontactsContactsSchemasCoretype",value:function getExternalcontactsContactsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
@@ -7109,7 +7136,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
7109
7136
|
* Get a list of schemas.
|
|
7110
7137
|
*
|
|
7111
7138
|
*/},{key:"getExternalcontactsOrganizationsSchemas",value:function getExternalcontactsOrganizationsSchemas(){return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7112
|
-
* Get
|
|
7139
|
+
* Get a specific named core type.
|
|
7113
7140
|
*
|
|
7114
7141
|
* @param {String} coreTypeName Name of the core type
|
|
7115
7142
|
*/},{key:"getExternalcontactsOrganizationsSchemasCoretype",value:function getExternalcontactsOrganizationsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
@@ -7533,7 +7560,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
7533
7560
|
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(){/**
|
|
7534
7561
|
* Fax service.
|
|
7535
7562
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
7536
|
-
* @version
|
|
7563
|
+
* @version 222.0.0
|
|
7537
7564
|
*//**
|
|
7538
7565
|
* Constructs a new FaxApi.
|
|
7539
7566
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -7582,7 +7609,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7582
7609
|
*/},{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(){/**
|
|
7583
7610
|
* Flows service.
|
|
7584
7611
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
7585
|
-
* @version
|
|
7612
|
+
* @version 222.0.0
|
|
7586
7613
|
*//**
|
|
7587
7614
|
* Constructs a new FlowsApi.
|
|
7588
7615
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -7630,7 +7657,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7630
7657
|
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(){/**
|
|
7631
7658
|
* Gamification service.
|
|
7632
7659
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
7633
|
-
* @version
|
|
7660
|
+
* @version 222.0.0
|
|
7634
7661
|
*//**
|
|
7635
7662
|
* Constructs a new GamificationApi.
|
|
7636
7663
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -8283,7 +8310,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8283
8310
|
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(){/**
|
|
8284
8311
|
* GeneralDataProtectionRegulation service.
|
|
8285
8312
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
8286
|
-
* @version
|
|
8313
|
+
* @version 222.0.0
|
|
8287
8314
|
*//**
|
|
8288
8315
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
8289
8316
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -8318,7 +8345,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
8318
8345
|
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(){/**
|
|
8319
8346
|
* Geolocation service.
|
|
8320
8347
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
8321
|
-
* @version
|
|
8348
|
+
* @version 222.0.0
|
|
8322
8349
|
*//**
|
|
8323
8350
|
* Constructs a new GeolocationApi.
|
|
8324
8351
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -8352,7 +8379,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
8352
8379
|
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(){/**
|
|
8353
8380
|
* Greetings service.
|
|
8354
8381
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
8355
|
-
* @version
|
|
8382
|
+
* @version 222.0.0
|
|
8356
8383
|
*//**
|
|
8357
8384
|
* Constructs a new GreetingsApi.
|
|
8358
8385
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -8459,7 +8486,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
8459
8486
|
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(){/**
|
|
8460
8487
|
* Groups service.
|
|
8461
8488
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
8462
|
-
* @version
|
|
8489
|
+
* @version 222.0.0
|
|
8463
8490
|
*//**
|
|
8464
8491
|
* Constructs a new GroupsApi.
|
|
8465
8492
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -8592,7 +8619,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
8592
8619
|
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(){/**
|
|
8593
8620
|
* IdentityProvider service.
|
|
8594
8621
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
8595
|
-
* @version
|
|
8622
|
+
* @version 222.0.0
|
|
8596
8623
|
*//**
|
|
8597
8624
|
* Constructs a new IdentityProviderApi.
|
|
8598
8625
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -8748,7 +8775,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8748
8775
|
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(){/**
|
|
8749
8776
|
* InfrastructureAsCode service.
|
|
8750
8777
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
8751
|
-
* @version
|
|
8778
|
+
* @version 222.0.0
|
|
8752
8779
|
*//**
|
|
8753
8780
|
* Constructs a new InfrastructureAsCodeApi.
|
|
8754
8781
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -8802,7 +8829,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
8802
8829
|
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(){/**
|
|
8803
8830
|
* Integrations service.
|
|
8804
8831
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8805
|
-
* @version
|
|
8832
|
+
* @version 222.0.0
|
|
8806
8833
|
*//**
|
|
8807
8834
|
* Constructs a new IntegrationsApi.
|
|
8808
8835
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -9441,7 +9468,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
9441
9468
|
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(){/**
|
|
9442
9469
|
* Journey service.
|
|
9443
9470
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
9444
|
-
* @version
|
|
9471
|
+
* @version 222.0.0
|
|
9445
9472
|
*//**
|
|
9446
9473
|
* Constructs a new JourneyApi.
|
|
9447
9474
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -9921,7 +9948,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
9921
9948
|
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(){/**
|
|
9922
9949
|
* Knowledge service.
|
|
9923
9950
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
9924
|
-
* @version
|
|
9951
|
+
* @version 222.0.0
|
|
9925
9952
|
*//**
|
|
9926
9953
|
* Constructs a new KnowledgeApi.
|
|
9927
9954
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -10984,7 +11011,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
10984
11011
|
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(){/**
|
|
10985
11012
|
* LanguageUnderstanding service.
|
|
10986
11013
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
10987
|
-
* @version
|
|
11014
|
+
* @version 222.0.0
|
|
10988
11015
|
*//**
|
|
10989
11016
|
* Constructs a new LanguageUnderstandingApi.
|
|
10990
11017
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -11243,7 +11270,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
11243
11270
|
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(){/**
|
|
11244
11271
|
* Languages service.
|
|
11245
11272
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
11246
|
-
* @version
|
|
11273
|
+
* @version 222.0.0
|
|
11247
11274
|
*//**
|
|
11248
11275
|
* Constructs a new LanguagesApi.
|
|
11249
11276
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -11298,7 +11325,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
11298
11325
|
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(){/**
|
|
11299
11326
|
* Learning service.
|
|
11300
11327
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
11301
|
-
* @version
|
|
11328
|
+
* @version 222.0.0
|
|
11302
11329
|
*//**
|
|
11303
11330
|
* Constructs a new LearningApi.
|
|
11304
11331
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -11569,7 +11596,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
11569
11596
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
11570
11597
|
* License service.
|
|
11571
11598
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
11572
|
-
* @version
|
|
11599
|
+
* @version 222.0.0
|
|
11573
11600
|
*//**
|
|
11574
11601
|
* Constructs a new LicenseApi.
|
|
11575
11602
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -11623,7 +11650,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
11623
11650
|
*/},{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(){/**
|
|
11624
11651
|
* Locations service.
|
|
11625
11652
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
11626
|
-
* @version
|
|
11653
|
+
* @version 222.0.0
|
|
11627
11654
|
*//**
|
|
11628
11655
|
* Constructs a new LocationsApi.
|
|
11629
11656
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -11682,7 +11709,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11682
11709
|
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(){/**
|
|
11683
11710
|
* LogCapture service.
|
|
11684
11711
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
11685
|
-
* @version
|
|
11712
|
+
* @version 222.0.0
|
|
11686
11713
|
*//**
|
|
11687
11714
|
* Constructs a new LogCaptureApi.
|
|
11688
11715
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -11732,7 +11759,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
11732
11759
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
11733
11760
|
* Messaging service.
|
|
11734
11761
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
11735
|
-
* @version
|
|
11762
|
+
* @version 222.0.0
|
|
11736
11763
|
*//**
|
|
11737
11764
|
* Constructs a new MessagingApi.
|
|
11738
11765
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -11822,7 +11849,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11822
11849
|
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(){/**
|
|
11823
11850
|
* MobileDevices service.
|
|
11824
11851
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
11825
|
-
* @version
|
|
11852
|
+
* @version 222.0.0
|
|
11826
11853
|
*//**
|
|
11827
11854
|
* Constructs a new MobileDevicesApi.
|
|
11828
11855
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -11861,7 +11888,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11861
11888
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
11862
11889
|
* Notifications service.
|
|
11863
11890
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
11864
|
-
* @version
|
|
11891
|
+
* @version 222.0.0
|
|
11865
11892
|
*//**
|
|
11866
11893
|
* Constructs a new NotificationsApi.
|
|
11867
11894
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -11918,7 +11945,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
11918
11945
|
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(){/**
|
|
11919
11946
|
* OAuth service.
|
|
11920
11947
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
11921
|
-
* @version
|
|
11948
|
+
* @version 222.0.0
|
|
11922
11949
|
*//**
|
|
11923
11950
|
* Constructs a new OAuthApi.
|
|
11924
11951
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -12003,7 +12030,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12003
12030
|
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(){/**
|
|
12004
12031
|
* Objects service.
|
|
12005
12032
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
12006
|
-
* @version
|
|
12033
|
+
* @version 222.0.0
|
|
12007
12034
|
*//**
|
|
12008
12035
|
* Constructs a new ObjectsApi.
|
|
12009
12036
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -12089,7 +12116,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
12089
12116
|
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(){/**
|
|
12090
12117
|
* OperationalEvents service.
|
|
12091
12118
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
12092
|
-
* @version
|
|
12119
|
+
* @version 222.0.0
|
|
12093
12120
|
*//**
|
|
12094
12121
|
* Constructs a new OperationalEventsApi.
|
|
12095
12122
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -12120,7 +12147,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
12120
12147
|
*/},{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(){/**
|
|
12121
12148
|
* Organization service.
|
|
12122
12149
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
12123
|
-
* @version
|
|
12150
|
+
* @version 222.0.0
|
|
12124
12151
|
*//**
|
|
12125
12152
|
* Constructs a new OrganizationApi.
|
|
12126
12153
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -12225,7 +12252,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12225
12252
|
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(){/**
|
|
12226
12253
|
* OrganizationAuthorization service.
|
|
12227
12254
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
12228
|
-
* @version
|
|
12255
|
+
* @version 222.0.0
|
|
12229
12256
|
*//**
|
|
12230
12257
|
* Constructs a new OrganizationAuthorizationApi.
|
|
12231
12258
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -12559,7 +12586,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
12559
12586
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
12560
12587
|
* Outbound service.
|
|
12561
12588
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
12562
|
-
* @version
|
|
12589
|
+
* @version 222.0.0
|
|
12563
12590
|
*//**
|
|
12564
12591
|
* Constructs a new OutboundApi.
|
|
12565
12592
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -13690,7 +13717,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13690
13717
|
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(){/**
|
|
13691
13718
|
* Presence service.
|
|
13692
13719
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
13693
|
-
* @version
|
|
13720
|
+
* @version 222.0.0
|
|
13694
13721
|
*//**
|
|
13695
13722
|
* Constructs a new PresenceApi.
|
|
13696
13723
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -13863,7 +13890,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13863
13890
|
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(){/**
|
|
13864
13891
|
* ProcessAutomation service.
|
|
13865
13892
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
13866
|
-
* @version
|
|
13893
|
+
* @version 222.0.0
|
|
13867
13894
|
*//**
|
|
13868
13895
|
* Constructs a new ProcessAutomationApi.
|
|
13869
13896
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -13926,7 +13953,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
13926
13953
|
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(){/**
|
|
13927
13954
|
* Quality service.
|
|
13928
13955
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
13929
|
-
* @version
|
|
13956
|
+
* @version 222.0.0
|
|
13930
13957
|
*//**
|
|
13931
13958
|
* Constructs a new QualityApi.
|
|
13932
13959
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -14404,7 +14431,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
14404
14431
|
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(){/**
|
|
14405
14432
|
* Recording service.
|
|
14406
14433
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
14407
|
-
* @version
|
|
14434
|
+
* @version 222.0.0
|
|
14408
14435
|
*//**
|
|
14409
14436
|
* Constructs a new RecordingApi.
|
|
14410
14437
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -14803,7 +14830,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14803
14830
|
*/},{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(){/**
|
|
14804
14831
|
* ResponseManagement service.
|
|
14805
14832
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
14806
|
-
* @version
|
|
14833
|
+
* @version 222.0.0
|
|
14807
14834
|
*//**
|
|
14808
14835
|
* Constructs a new ResponseManagementApi.
|
|
14809
14836
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -14924,7 +14951,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
14924
14951
|
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(){/**
|
|
14925
14952
|
* Routing service.
|
|
14926
14953
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
14927
|
-
* @version
|
|
14954
|
+
* @version 222.0.0
|
|
14928
14955
|
*//**
|
|
14929
14956
|
* Constructs a new RoutingApi.
|
|
14930
14957
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -15972,7 +15999,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15972
15999
|
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(){/**
|
|
15973
16000
|
* SCIM service.
|
|
15974
16001
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
15975
|
-
* @version
|
|
16002
|
+
* @version 222.0.0
|
|
15976
16003
|
*//**
|
|
15977
16004
|
* Constructs a new SCIMApi.
|
|
15978
16005
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -16197,7 +16224,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16197
16224
|
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(){/**
|
|
16198
16225
|
* ScreenRecording service.
|
|
16199
16226
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
16200
|
-
* @version
|
|
16227
|
+
* @version 222.0.0
|
|
16201
16228
|
*//**
|
|
16202
16229
|
* Constructs a new ScreenRecordingApi.
|
|
16203
16230
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -16212,7 +16239,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16212
16239
|
*/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(){/**
|
|
16213
16240
|
* Scripts service.
|
|
16214
16241
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
16215
|
-
* @version
|
|
16242
|
+
* @version 222.0.0
|
|
16216
16243
|
*//**
|
|
16217
16244
|
* Constructs a new ScriptsApi.
|
|
16218
16245
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -16358,7 +16385,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
16358
16385
|
*/},{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(){/**
|
|
16359
16386
|
* Search service.
|
|
16360
16387
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
16361
|
-
* @version
|
|
16388
|
+
* @version 222.0.0
|
|
16362
16389
|
*//**
|
|
16363
16390
|
* Constructs a new SearchApi.
|
|
16364
16391
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -16530,7 +16557,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16530
16557
|
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(){/**
|
|
16531
16558
|
* Settings service.
|
|
16532
16559
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
16533
|
-
* @version
|
|
16560
|
+
* @version 222.0.0
|
|
16534
16561
|
*//**
|
|
16535
16562
|
* Constructs a new SettingsApi.
|
|
16536
16563
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -16602,7 +16629,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
16602
16629
|
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(){/**
|
|
16603
16630
|
* SocialMedia service.
|
|
16604
16631
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
16605
|
-
* @version
|
|
16632
|
+
* @version 222.0.0
|
|
16606
16633
|
*//**
|
|
16607
16634
|
* Constructs a new SocialMediaApi.
|
|
16608
16635
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -16939,7 +16966,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16939
16966
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PUT',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
16940
16967
|
* SpeechTextAnalytics service.
|
|
16941
16968
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
16942
|
-
* @version
|
|
16969
|
+
* @version 222.0.0
|
|
16943
16970
|
*//**
|
|
16944
16971
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
16945
16972
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -17260,7 +17287,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
17260
17287
|
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(){/**
|
|
17261
17288
|
* Stations service.
|
|
17262
17289
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
17263
|
-
* @version
|
|
17290
|
+
* @version 222.0.0
|
|
17264
17291
|
*//**
|
|
17265
17292
|
* Constructs a new StationsApi.
|
|
17266
17293
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -17292,7 +17319,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
17292
17319
|
*/},{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(){/**
|
|
17293
17320
|
* Suggest service.
|
|
17294
17321
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
17295
|
-
* @version
|
|
17322
|
+
* @version 222.0.0
|
|
17296
17323
|
*//**
|
|
17297
17324
|
* Constructs a new SuggestApi.
|
|
17298
17325
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -17332,7 +17359,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17332
17359
|
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(){/**
|
|
17333
17360
|
* TaskManagement service.
|
|
17334
17361
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
17335
|
-
* @version
|
|
17362
|
+
* @version 222.0.0
|
|
17336
17363
|
*//**
|
|
17337
17364
|
* Constructs a new TaskManagementApi.
|
|
17338
17365
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -17540,7 +17567,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
17540
17567
|
* Get a list of schemas.
|
|
17541
17568
|
*
|
|
17542
17569
|
*/},{key:"getTaskmanagementWorkitemsSchemas",value:function getTaskmanagementWorkitemsSchemas(){return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17543
|
-
* Get
|
|
17570
|
+
* Get a specific named core type.
|
|
17544
17571
|
*
|
|
17545
17572
|
* @param {String} coreTypeName Name of the core type
|
|
17546
17573
|
*/},{key:"getTaskmanagementWorkitemsSchemasCoretype",value:function getTaskmanagementWorkitemsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
@@ -17840,7 +17867,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
17840
17867
|
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(){/**
|
|
17841
17868
|
* Teams service.
|
|
17842
17869
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
17843
|
-
* @version
|
|
17870
|
+
* @version 222.0.0
|
|
17844
17871
|
*//**
|
|
17845
17872
|
* Constructs a new TeamsApi.
|
|
17846
17873
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -17920,7 +17947,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17920
17947
|
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(){/**
|
|
17921
17948
|
* Telephony service.
|
|
17922
17949
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
17923
|
-
* @version
|
|
17950
|
+
* @version 222.0.0
|
|
17924
17951
|
*//**
|
|
17925
17952
|
* Constructs a new TelephonyApi.
|
|
17926
17953
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -17967,7 +17994,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
17967
17994
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
17968
17995
|
* TelephonyProvidersEdge service.
|
|
17969
17996
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
17970
|
-
* @version
|
|
17997
|
+
* @version 222.0.0
|
|
17971
17998
|
*//**
|
|
17972
17999
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
17973
18000
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -18803,7 +18830,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
18803
18830
|
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(){/**
|
|
18804
18831
|
* Textbots service.
|
|
18805
18832
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
18806
|
-
* @version
|
|
18833
|
+
* @version 222.0.0
|
|
18807
18834
|
*//**
|
|
18808
18835
|
* Constructs a new TextbotsApi.
|
|
18809
18836
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -18817,8 +18844,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18817
18844
|
* @param {Array.<String>} opts.botType Bot types
|
|
18818
18845
|
* @param {String} opts.botName Bot name
|
|
18819
18846
|
* @param {Array.<String>} opts.botId Bot IDs. Maximum of 50
|
|
18847
|
+
* @param {Boolean} opts.virtualAgentEnabled Include or exclude virtual agent flows, only applies to GenesysBotFlows or GenesysDigitalBotFlows
|
|
18820
18848
|
* @param {Number} opts.pageSize The maximum results to return. Maximum of 100 (default to 25)
|
|
18821
|
-
*/return _createClass(TextbotsApi,[{key:"getTextbotsBotsSearch",value:function getTextbotsBotsSearch(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/textbots/bots/search','GET',{},{'botType':this.apiClient.buildCollectionParam(opts['botType'],'multi'),'botName':opts['botName'],'botId':this.apiClient.buildCollectionParam(opts['botId'],'multi'),'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18849
|
+
*/return _createClass(TextbotsApi,[{key:"getTextbotsBotsSearch",value:function getTextbotsBotsSearch(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/textbots/bots/search','GET',{},{'botType':this.apiClient.buildCollectionParam(opts['botType'],'multi'),'botName':opts['botName'],'botId':this.apiClient.buildCollectionParam(opts['botId'],'multi'),'virtualAgentEnabled':opts['virtualAgentEnabled'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18822
18850
|
* Issue a bot flow turn event
|
|
18823
18851
|
* Send a turn event to an executing bot flow and produce the next action to take.
|
|
18824
18852
|
* @param {String} sessionId The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions'
|
|
@@ -18838,7 +18866,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
18838
18866
|
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(){/**
|
|
18839
18867
|
* Tokens service.
|
|
18840
18868
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
18841
|
-
* @version
|
|
18869
|
+
* @version 222.0.0
|
|
18842
18870
|
*//**
|
|
18843
18871
|
* Constructs a new TokensApi.
|
|
18844
18872
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -18872,7 +18900,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18872
18900
|
*/},{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(){/**
|
|
18873
18901
|
* Uploads service.
|
|
18874
18902
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
18875
|
-
* @version
|
|
18903
|
+
* @version 222.0.0
|
|
18876
18904
|
*//**
|
|
18877
18905
|
* Constructs a new UploadsApi.
|
|
18878
18906
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -18940,7 +18968,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18940
18968
|
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(){/**
|
|
18941
18969
|
* Usage service.
|
|
18942
18970
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
18943
|
-
* @version
|
|
18971
|
+
* @version 222.0.0
|
|
18944
18972
|
*//**
|
|
18945
18973
|
* Constructs a new UsageApi.
|
|
18946
18974
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -18994,7 +19022,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18994
19022
|
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(){/**
|
|
18995
19023
|
* UserRecordings service.
|
|
18996
19024
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
18997
|
-
* @version
|
|
19025
|
+
* @version 222.0.0
|
|
18998
19026
|
*//**
|
|
18999
19027
|
* Constructs a new UserRecordingsApi.
|
|
19000
19028
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -19051,7 +19079,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
19051
19079
|
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(){/**
|
|
19052
19080
|
* Users service.
|
|
19053
19081
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
19054
|
-
* @version
|
|
19082
|
+
* @version 222.0.0
|
|
19055
19083
|
*//**
|
|
19056
19084
|
* Constructs a new UsersApi.
|
|
19057
19085
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -19778,7 +19806,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
19778
19806
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
19779
19807
|
* Utilities service.
|
|
19780
19808
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
19781
|
-
* @version
|
|
19809
|
+
* @version 222.0.0
|
|
19782
19810
|
*//**
|
|
19783
19811
|
* Constructs a new UtilitiesApi.
|
|
19784
19812
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -19805,7 +19833,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19805
19833
|
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(){/**
|
|
19806
19834
|
* Voicemail service.
|
|
19807
19835
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
19808
|
-
* @version
|
|
19836
|
+
* @version 222.0.0
|
|
19809
19837
|
*//**
|
|
19810
19838
|
* Constructs a new VoicemailApi.
|
|
19811
19839
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -19967,7 +19995,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19967
19995
|
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(){/**
|
|
19968
19996
|
* WebChat service.
|
|
19969
19997
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
19970
|
-
* @version
|
|
19998
|
+
* @version 222.0.0
|
|
19971
19999
|
*//**
|
|
19972
20000
|
* Constructs a new WebChatApi.
|
|
19973
20001
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -20111,7 +20139,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20111
20139
|
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(){/**
|
|
20112
20140
|
* WebDeployments service.
|
|
20113
20141
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
20114
|
-
* @version
|
|
20142
|
+
* @version 222.0.0
|
|
20115
20143
|
*//**
|
|
20116
20144
|
* Constructs a new WebDeploymentsApi.
|
|
20117
20145
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -20244,7 +20272,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
20244
20272
|
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(){/**
|
|
20245
20273
|
* WebMessaging service.
|
|
20246
20274
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
20247
|
-
* @version
|
|
20275
|
+
* @version 222.0.0
|
|
20248
20276
|
*//**
|
|
20249
20277
|
* Constructs a new WebMessagingApi.
|
|
20250
20278
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -20260,7 +20288,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20260
20288
|
*/return _createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
20261
20289
|
* Widgets service.
|
|
20262
20290
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
20263
|
-
* @version
|
|
20291
|
+
* @version 222.0.0
|
|
20264
20292
|
*//**
|
|
20265
20293
|
* Constructs a new WidgetsApi.
|
|
20266
20294
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -20300,7 +20328,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
20300
20328
|
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(){/**
|
|
20301
20329
|
* WorkforceManagement service.
|
|
20302
20330
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
20303
|
-
* @version
|
|
20331
|
+
* @version 222.0.0
|
|
20304
20332
|
*//**
|
|
20305
20333
|
* Constructs a new WorkforceManagementApi.
|
|
20306
20334
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -21064,10 +21092,11 @@ if(weekId===undefined||weekId===null){throw'Missing the required parameter "week
|
|
|
21064
21092
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
21065
21093
|
* @param {Object} opts Optional parameters
|
|
21066
21094
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
21095
|
+
* @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
|
|
21067
21096
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
21068
21097
|
*/},{key:"getWorkforcemanagementManagementunitWeekShifttrades",value:function getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
21069
21098
|
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
21070
|
-
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades','GET',{'managementUnitId':managementUnitId,'weekDateId':weekDateId},{'evaluateMatches':opts['evaluateMatches'],'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21099
|
+
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades','GET',{'managementUnitId':managementUnitId,'weekDateId':weekDateId},{'evaluateMatches':opts['evaluateMatches'],'includeCrossWeekShifts':opts['includeCrossWeekShifts'],'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21071
21100
|
* Get a work plan
|
|
21072
21101
|
*
|
|
21073
21102
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -22121,7 +22150,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
22121
22150
|
* </pre>
|
|
22122
22151
|
* </p>
|
|
22123
22152
|
* @module purecloud-platform-client-v2/index
|
|
22124
|
-
* @version
|
|
22153
|
+
* @version 222.0.0
|
|
22125
22154
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
22126
22155
|
* The ApiClient constructor.
|
|
22127
22156
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|