purecloud-platform-client-v2 191.0.0 → 192.1.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +448 -170
- package/dist/web-amd/purecloud-platform-client-v2.js +448 -170
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +211 -128
- package/dist/web-cjs/purecloud-platform-client-v2.js +259 -163
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +528 -258
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +127 -39
- 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 +61 -16
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +45 -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 +3 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +22 -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 +4 -3
- 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 +3 -3
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
- 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 +79 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -22
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +8 -3
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -5
- 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 +5 -3
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -847,7 +847,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
847
847
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
848
848
|
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:"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];}}}]);}();/**
|
|
849
849
|
* @module purecloud-platform-client-v2/ApiClient
|
|
850
|
-
* @version
|
|
850
|
+
* @version 192.1.0
|
|
851
851
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
852
852
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
853
853
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1159,7 +1159,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1159
1159
|
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 AlertingApi=/*#__PURE__*/function(){/**
|
|
1160
1160
|
* Alerting service.
|
|
1161
1161
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1162
|
-
* @version
|
|
1162
|
+
* @version 192.1.0
|
|
1163
1163
|
*/ /**
|
|
1164
1164
|
* Constructs a new AlertingApi.
|
|
1165
1165
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1316,7 +1316,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1316
1316
|
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(){/**
|
|
1317
1317
|
* Analytics service.
|
|
1318
1318
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1319
|
-
* @version
|
|
1319
|
+
* @version 192.1.0
|
|
1320
1320
|
*/ /**
|
|
1321
1321
|
* Constructs a new AnalyticsApi.
|
|
1322
1322
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1966,7 +1966,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
1966
1966
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';}return this.apiClient.callApi('/api/v2/analytics/reporting/schedules/{scheduleId}','PUT',{'scheduleId':scheduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
1967
1967
|
* Architect service.
|
|
1968
1968
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
1969
|
-
* @version
|
|
1969
|
+
* @version 192.1.0
|
|
1970
1970
|
*/ /**
|
|
1971
1971
|
* Constructs a new ArchitectApi.
|
|
1972
1972
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3082,7 +3082,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3082
3082
|
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(){/**
|
|
3083
3083
|
* Audit service.
|
|
3084
3084
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3085
|
-
* @version
|
|
3085
|
+
* @version 192.1.0
|
|
3086
3086
|
*/ /**
|
|
3087
3087
|
* Constructs a new AuditApi.
|
|
3088
3088
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3124,7 +3124,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3124
3124
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtime';}return this.apiClient.callApi('/api/v2/audits/query/realtime','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
3125
3125
|
* Authorization service.
|
|
3126
3126
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3127
|
-
* @version
|
|
3127
|
+
* @version 192.1.0
|
|
3128
3128
|
*/ /**
|
|
3129
3129
|
* Constructs a new AuthorizationApi.
|
|
3130
3130
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3281,11 +3281,15 @@ if(roleId===undefined||roleId===null){throw'Missing the required parameter "role
|
|
|
3281
3281
|
* Returns a listing of roles and permissions for a user.
|
|
3282
3282
|
*
|
|
3283
3283
|
* @param {String} subjectId Subject ID (user or group)
|
|
3284
|
-
|
|
3285
|
-
|
|
3284
|
+
* @param {Object} opts Optional parameters
|
|
3285
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
3286
|
+
*/},{key:"getAuthorizationSubject",value:function getAuthorizationSubject(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
3287
|
+
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling getAuthorizationSubject';}return this.apiClient.callApi('/api/v2/authorization/subjects/{subjectId}','GET',{'subjectId':subjectId},{'includeDuplicates':opts['includeDuplicates']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3286
3288
|
* Returns a listing of roles and permissions for the currently authenticated user.
|
|
3287
3289
|
*
|
|
3288
|
-
|
|
3290
|
+
* @param {Object} opts Optional parameters
|
|
3291
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
3292
|
+
*/},{key:"getAuthorizationSubjectsMe",value:function getAuthorizationSubjectsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/subjects/me','GET',{},{'includeDuplicates':opts['includeDuplicates']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3289
3293
|
* Get the count of roles granted to a list of subjects
|
|
3290
3294
|
*
|
|
3291
3295
|
* @param {Object} opts Optional parameters
|
|
@@ -3435,7 +3439,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3435
3439
|
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(){/**
|
|
3436
3440
|
* Billing service.
|
|
3437
3441
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3438
|
-
* @version
|
|
3442
|
+
* @version 192.1.0
|
|
3439
3443
|
*/ /**
|
|
3440
3444
|
* Constructs a new BillingApi.
|
|
3441
3445
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3459,7 +3463,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3459
3463
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3460
3464
|
* CarrierServices service.
|
|
3461
3465
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3462
|
-
* @version
|
|
3466
|
+
* @version 192.1.0
|
|
3463
3467
|
*/ /**
|
|
3464
3468
|
* Constructs a new CarrierServicesApi.
|
|
3465
3469
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3479,7 +3483,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3479
3483
|
*/},{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(){/**
|
|
3480
3484
|
* Chat service.
|
|
3481
3485
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3482
|
-
* @version
|
|
3486
|
+
* @version 192.1.0
|
|
3483
3487
|
*/ /**
|
|
3484
3488
|
* Constructs a new ChatApi.
|
|
3485
3489
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3494,6 +3498,13 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3494
3498
|
*/return _createClass(ChatApi,[{key:"deleteChatsRoomMessage",value:function deleteChatsRoomMessage(roomJid,messageId){// verify the required parameter 'roomJid' is set
|
|
3495
3499
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';}// verify the required parameter 'messageId' is set
|
|
3496
3500
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling deleteChatsRoomMessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages/{messageId}','DELETE',{'roomJid':roomJid,'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3501
|
+
* Remove a pinned message from a room
|
|
3502
|
+
*
|
|
3503
|
+
* @param {String} roomJid roomJid
|
|
3504
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
3505
|
+
*/},{key:"deleteChatsRoomMessagesPin",value:function deleteChatsRoomMessagesPin(roomJid,pinnedMessageId){// verify the required parameter 'roomJid' is set
|
|
3506
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';}// verify the required parameter 'pinnedMessageId' is set
|
|
3507
|
+
if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomMessagesPin';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}','DELETE',{'roomJid':roomJid,'pinnedMessageId':pinnedMessageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3497
3508
|
* Remove a user from a room.
|
|
3498
3509
|
*
|
|
3499
3510
|
* @param {String} roomJid roomJid
|
|
@@ -3501,13 +3512,6 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
3501
3512
|
*/},{key:"deleteChatsRoomParticipant",value:function deleteChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
3502
3513
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
3503
3514
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{userId}','DELETE',{'roomJid':roomJid,'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3504
|
-
* Remove a pinned message from a room
|
|
3505
|
-
*
|
|
3506
|
-
* @param {String} roomJid roomJid
|
|
3507
|
-
* @param {String} pinnedMessageId pinnedMessageId
|
|
3508
|
-
*/},{key:"deleteChatsRoomPinnedmessage",value:function deleteChatsRoomPinnedmessage(roomJid,pinnedMessageId){// verify the required parameter 'roomJid' is set
|
|
3509
|
-
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomPinnedmessage';}// verify the required parameter 'pinnedMessageId' is set
|
|
3510
|
-
if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomPinnedmessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/pinnedmessages/{pinnedMessageId}','DELETE',{'roomJid':roomJid,'pinnedMessageId':pinnedMessageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3511
3515
|
* Delete a message to a user
|
|
3512
3516
|
*
|
|
3513
3517
|
* @param {String} userId userId
|
|
@@ -3515,6 +3519,14 @@ if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the requir
|
|
|
3515
3519
|
*/},{key:"deleteChatsUserMessage",value:function deleteChatsUserMessage(userId,messageId){// verify the required parameter 'userId' is set
|
|
3516
3520
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
3517
3521
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling deleteChatsUserMessage';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/{messageId}','DELETE',{'userId':userId,'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3522
|
+
* Remove a pinned message from a 1on1
|
|
3523
|
+
*
|
|
3524
|
+
* @param {String} userId userId
|
|
3525
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
3526
|
+
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3527
|
+
*/},{key:"deleteChatsUserMessagesPin",value:function deleteChatsUserMessagesPin(userId,pinnedMessageId){// verify the required parameter 'userId' is set
|
|
3528
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';}// verify the required parameter 'pinnedMessageId' is set
|
|
3529
|
+
if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsUserMessagesPin';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}','DELETE',{'userId':userId,'pinnedMessageId':pinnedMessageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3518
3530
|
* Get a message
|
|
3519
3531
|
*
|
|
3520
3532
|
* @param {String} messageId messageId
|
|
@@ -3565,6 +3577,12 @@ if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "ro
|
|
|
3565
3577
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
3566
3578
|
*/},{key:"getChatsThreadMessages",value:function getChatsThreadMessages(threadId,opts){opts=opts||{};// verify the required parameter 'threadId' is set
|
|
3567
3579
|
if(threadId===undefined||threadId===null){throw'Missing the required parameter "threadId" when calling getChatsThreadMessages';}return this.apiClient.callApi('/api/v2/chats/threads/{threadId}/messages','GET',{'threadId':threadId},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3580
|
+
* Get information for a 1on1
|
|
3581
|
+
*
|
|
3582
|
+
* @param {String} userId userId
|
|
3583
|
+
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3584
|
+
*/},{key:"getChatsUser",value:function getChatsUser(userId){// verify the required parameter 'userId' is set
|
|
3585
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUser';}return this.apiClient.callApi('/api/v2/chats/users/{userId}','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3568
3586
|
* Get messages by id(s) from a 1on1
|
|
3569
3587
|
*
|
|
3570
3588
|
* @param {String} userId userId
|
|
@@ -3632,6 +3650,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3632
3650
|
*/},{key:"postChatsRoomMessages",value:function postChatsRoomMessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
3633
3651
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomMessages';}// verify the required parameter 'body' is set
|
|
3634
3652
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRoomMessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages','POST',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3653
|
+
* Add pinned messages for a room, up to a maximum of 5 pinned messages
|
|
3654
|
+
*
|
|
3655
|
+
* @param {String} roomJid roomJid
|
|
3656
|
+
* @param {Object} body Pinned Message Ids
|
|
3657
|
+
*/},{key:"postChatsRoomMessagesPins",value:function postChatsRoomMessagesPins(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
3658
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';}// verify the required parameter 'body' is set
|
|
3659
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRoomMessagesPins';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages/pins','POST',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3635
3660
|
* Join a room
|
|
3636
3661
|
*
|
|
3637
3662
|
* @param {String} roomJid roomJid
|
|
@@ -3639,13 +3664,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3639
3664
|
*/},{key:"postChatsRoomParticipant",value:function postChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
3640
3665
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
3641
3666
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{userId}','POST',{'roomJid':roomJid,'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3642
|
-
* Add pinned messages for a room, up to a maximum of 5 pinned messages
|
|
3643
|
-
*
|
|
3644
|
-
* @param {String} roomJid roomJid
|
|
3645
|
-
* @param {Object} body Pinned Message Ids
|
|
3646
|
-
*/},{key:"postChatsRoomPinnedmessages",value:function postChatsRoomPinnedmessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
3647
|
-
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomPinnedmessages';}// verify the required parameter 'body' is set
|
|
3648
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRoomPinnedmessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/pinnedmessages','POST',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3649
3667
|
* Create an adhoc room
|
|
3650
3668
|
*
|
|
3651
3669
|
* @param {Object} body Room properties
|
|
@@ -3658,6 +3676,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3658
3676
|
*/},{key:"postChatsUserMessages",value:function postChatsUserMessages(userId,body){// verify the required parameter 'userId' is set
|
|
3659
3677
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessages';}// verify the required parameter 'body' is set
|
|
3660
3678
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsUserMessages';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3679
|
+
* Add pinned messages for a 1on1, up to a maximum of 5 pinned messages
|
|
3680
|
+
*
|
|
3681
|
+
* @param {String} userId userId
|
|
3682
|
+
* @param {Object} body Pinned Message Ids
|
|
3683
|
+
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3684
|
+
*/},{key:"postChatsUserMessagesPins",value:function postChatsUserMessagesPins(userId,body){// verify the required parameter 'userId' is set
|
|
3685
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessagesPins';}// verify the required parameter 'body' is set
|
|
3686
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsUserMessagesPins';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/pins','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3661
3687
|
* Update reactions to a message
|
|
3662
3688
|
*
|
|
3663
3689
|
* @param {String} messageId messageId
|
|
@@ -3672,7 +3698,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3672
3698
|
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(){/**
|
|
3673
3699
|
* Coaching service.
|
|
3674
3700
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3675
|
-
* @version
|
|
3701
|
+
* @version 192.1.0
|
|
3676
3702
|
*/ /**
|
|
3677
3703
|
* Constructs a new CoachingApi.
|
|
3678
3704
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -3825,7 +3851,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3825
3851
|
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(){/**
|
|
3826
3852
|
* ContentManagement service.
|
|
3827
3853
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
3828
|
-
* @version
|
|
3854
|
+
* @version 192.1.0
|
|
3829
3855
|
*/ /**
|
|
3830
3856
|
* Constructs a new ContentManagementApi.
|
|
3831
3857
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4108,7 +4134,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4108
4134
|
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(){/**
|
|
4109
4135
|
* Conversations service.
|
|
4110
4136
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4111
|
-
* @version
|
|
4137
|
+
* @version 192.1.0
|
|
4112
4138
|
*/ /**
|
|
4113
4139
|
* Constructs a new ConversationsApi.
|
|
4114
4140
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -4427,29 +4453,32 @@ if(participantId===undefined||participantId===null){throw'Missing the required p
|
|
|
4427
4453
|
*/},{key:"getConversationsCobrowsesession",value:function getConversationsCobrowsesession(conversationId){// verify the required parameter 'conversationId' is set
|
|
4428
4454
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesession';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4429
4455
|
* Get the wrap-up for this conversation communication.
|
|
4430
|
-
*
|
|
4456
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4431
4457
|
* @param {String} conversationId conversationId
|
|
4432
4458
|
* @param {String} participantId participantId
|
|
4433
4459
|
* @param {String} communicationId communicationId
|
|
4434
4460
|
* @param {Object} opts Optional parameters
|
|
4435
4461
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
4462
|
+
* @deprecated
|
|
4436
4463
|
*/},{key:"getConversationsCobrowsesessionParticipantCommunicationWrapup",value:function getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4437
4464
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
4438
4465
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
4439
4466
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup','GET',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{'provisional':opts['provisional']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4440
4467
|
* Get the wrap-up for this conversation participant.
|
|
4441
|
-
*
|
|
4468
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4442
4469
|
* @param {String} conversationId conversationId
|
|
4443
4470
|
* @param {String} participantId participantId
|
|
4444
4471
|
* @param {Object} opts Optional parameters
|
|
4445
4472
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
4473
|
+
* @deprecated
|
|
4446
4474
|
*/},{key:"getConversationsCobrowsesessionParticipantWrapup",value:function getConversationsCobrowsesessionParticipantWrapup(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4447
4475
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantWrapup';}// verify the required parameter 'participantId' is set
|
|
4448
4476
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantWrapup';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup','GET',{'conversationId':conversationId,'participantId':participantId},{'provisional':opts['provisional']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4449
4477
|
* Get list of wrapup codes for this conversation participant
|
|
4450
|
-
*
|
|
4478
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4451
4479
|
* @param {String} conversationId conversationId
|
|
4452
4480
|
* @param {String} participantId participantId
|
|
4481
|
+
* @deprecated
|
|
4453
4482
|
*/},{key:"getConversationsCobrowsesessionParticipantWrapupcodes",value:function getConversationsCobrowsesessionParticipantWrapupcodes(conversationId,participantId){// verify the required parameter 'conversationId' is set
|
|
4454
4483
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantWrapupcodes';}// verify the required parameter 'participantId' is set
|
|
4455
4484
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantWrapupcodes';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes','GET',{'conversationId':conversationId,'participantId':participantId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4722,12 +4751,13 @@ if(messageSettingId===undefined||messageSettingId===null){throw'Missing the requ
|
|
|
4722
4751
|
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
4723
4752
|
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
4724
4753
|
*/},{key:"getConversationsMessagingSettingsDefault",value:function getConversationsMessagingSettingsDefault(){return this.apiClient.callApi('/api/v2/conversations/messaging/settings/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4725
|
-
* Get a list of Messaging Stickers
|
|
4726
|
-
*
|
|
4754
|
+
* Get a list of Messaging Stickers (Deprecated)
|
|
4755
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
4727
4756
|
* @param {Object} messengerType Messenger Type
|
|
4728
4757
|
* @param {Object} opts Optional parameters
|
|
4729
4758
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
4730
4759
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
4760
|
+
* @deprecated
|
|
4731
4761
|
*/},{key:"getConversationsMessagingSticker",value:function getConversationsMessagingSticker(messengerType,opts){opts=opts||{};// verify the required parameter 'messengerType' is set
|
|
4732
4762
|
if(messengerType===undefined||messengerType===null){throw'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker';}return this.apiClient.callApi('/api/v2/conversations/messaging/stickers/{messengerType}','GET',{'messengerType':messengerType},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4733
4763
|
* Get a list of Supported Content profiles
|
|
@@ -4748,12 +4778,13 @@ if(supportedContentId===undefined||supportedContentId===null){throw'Missing the
|
|
|
4748
4778
|
* Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
|
|
4749
4779
|
*/},{key:"getConversationsMessagingThreadingtimeline",value:function getConversationsMessagingThreadingtimeline(){return this.apiClient.callApi('/api/v2/conversations/messaging/threadingtimeline','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4750
4780
|
* Get the wrap-up for this conversation communication.
|
|
4751
|
-
*
|
|
4781
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4752
4782
|
* @param {String} conversationId conversationId
|
|
4753
4783
|
* @param {String} participantId participantId
|
|
4754
4784
|
* @param {String} communicationId communicationId
|
|
4755
4785
|
* @param {Object} opts Optional parameters
|
|
4756
4786
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
4787
|
+
* @deprecated
|
|
4757
4788
|
*/},{key:"getConversationsScreenshareParticipantCommunicationWrapup",value:function getConversationsScreenshareParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4758
4789
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsScreenshareParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
4759
4790
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsScreenshareParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
@@ -4820,6 +4851,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4820
4851
|
*/},{key:"patchConversationSecureattributes",value:function patchConversationSecureattributes(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
4821
4852
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';}// verify the required parameter 'body' is set
|
|
4822
4853
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationSecureattributes';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/secureattributes','PATCH',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4854
|
+
* Update the utilization label on a conversation. When there is no value provided, the system default label is applied
|
|
4855
|
+
*
|
|
4856
|
+
* @param {String} conversationId conversation ID
|
|
4857
|
+
* @param {Object} body Conversation Utilization Label
|
|
4858
|
+
* patchConversationUtilizationlabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4859
|
+
*/},{key:"patchConversationUtilizationlabel",value:function patchConversationUtilizationlabel(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
4860
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationUtilizationlabel';}// verify the required parameter 'body' is set
|
|
4861
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationUtilizationlabel';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/utilizationlabel','PATCH',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4823
4862
|
* Update after-call work for this conversation communication.
|
|
4824
4863
|
*
|
|
4825
4864
|
* @param {String} conversationId conversationId
|
|
@@ -4954,36 +4993,40 @@ if(participantId===undefined||participantId===null){throw'Missing the required p
|
|
|
4954
4993
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling patchConversationsChatParticipantCommunication';}// verify the required parameter 'body' is set
|
|
4955
4994
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsChatParticipantCommunication';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}','PATCH',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4956
4995
|
* Update a conversation by disconnecting all of the participants
|
|
4957
|
-
*
|
|
4996
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4958
4997
|
* @param {String} conversationId conversationId
|
|
4959
4998
|
* @param {Object} body Conversation
|
|
4999
|
+
* @deprecated
|
|
4960
5000
|
*/},{key:"patchConversationsCobrowsesession",value:function patchConversationsCobrowsesession(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
4961
5001
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesession';}// verify the required parameter 'body' is set
|
|
4962
5002
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsCobrowsesession';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}','PATCH',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4963
5003
|
* Update conversation participant
|
|
4964
|
-
*
|
|
5004
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4965
5005
|
* @param {String} conversationId conversationId
|
|
4966
5006
|
* @param {String} participantId participantId
|
|
4967
5007
|
* @param {Object} opts Optional parameters
|
|
4968
5008
|
* @param {Object} opts.body
|
|
5009
|
+
* @deprecated
|
|
4969
5010
|
*/},{key:"patchConversationsCobrowsesessionParticipant",value:function patchConversationsCobrowsesessionParticipant(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4970
5011
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipant';}// verify the required parameter 'participantId' is set
|
|
4971
5012
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipant';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}','PATCH',{'conversationId':conversationId,'participantId':participantId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4972
5013
|
* Update the attributes on a conversation participant.
|
|
4973
|
-
*
|
|
5014
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4974
5015
|
* @param {String} conversationId conversationId
|
|
4975
5016
|
* @param {String} participantId participantId
|
|
4976
5017
|
* @param {Object} opts Optional parameters
|
|
4977
5018
|
* @param {Object} opts.body
|
|
5019
|
+
* @deprecated
|
|
4978
5020
|
*/},{key:"patchConversationsCobrowsesessionParticipantAttributes",value:function patchConversationsCobrowsesessionParticipantAttributes(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4979
5021
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipantAttributes';}// verify the required parameter 'participantId' is set
|
|
4980
5022
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipantAttributes';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes','PATCH',{'conversationId':conversationId,'participantId':participantId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4981
5023
|
* Update conversation participant's communication by disconnecting it.
|
|
4982
|
-
*
|
|
5024
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4983
5025
|
* @param {String} conversationId conversationId
|
|
4984
5026
|
* @param {String} participantId participantId
|
|
4985
5027
|
* @param {String} communicationId communicationId
|
|
4986
5028
|
* @param {Object} body Participant
|
|
5029
|
+
* @deprecated
|
|
4987
5030
|
*/},{key:"patchConversationsCobrowsesessionParticipantCommunication",value:function patchConversationsCobrowsesessionParticipantCommunication(conversationId,participantId,communicationId,body){// verify the required parameter 'conversationId' is set
|
|
4988
5031
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipantCommunication';}// verify the required parameter 'participantId' is set
|
|
4989
5032
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipantCommunication';}// verify the required parameter 'communicationId' is set
|
|
@@ -5438,22 +5481,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5438
5481
|
*/},{key:"postConversationsChats",value:function postConversationsChats(body){// verify the required parameter 'body' is set
|
|
5439
5482
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsChats';}return this.apiClient.callApi('/api/v2/conversations/chats','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5440
5483
|
* Apply wrap-up for this conversation communication
|
|
5441
|
-
*
|
|
5484
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
5442
5485
|
* @param {String} conversationId conversationId
|
|
5443
5486
|
* @param {String} participantId participantId
|
|
5444
5487
|
* @param {String} communicationId communicationId
|
|
5445
5488
|
* @param {Object} opts Optional parameters
|
|
5446
5489
|
* @param {Object} opts.body Wrap-up
|
|
5490
|
+
* @deprecated
|
|
5447
5491
|
*/},{key:"postConversationsCobrowsesessionParticipantCommunicationWrapup",value:function postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
5448
5492
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
5449
5493
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
5450
5494
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup','POST',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5451
5495
|
* Replace this participant with the specified user and/or address
|
|
5452
|
-
*
|
|
5496
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
5453
5497
|
* @param {String} conversationId conversationId
|
|
5454
5498
|
* @param {String} participantId participantId
|
|
5455
5499
|
* @param {Object} opts Optional parameters
|
|
5456
5500
|
* @param {Object} opts.body
|
|
5501
|
+
* @deprecated
|
|
5457
5502
|
*/},{key:"postConversationsCobrowsesessionParticipantReplace",value:function postConversationsCobrowsesessionParticipantReplace(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
5458
5503
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsCobrowsesessionParticipantReplace';}// verify the required parameter 'participantId' is set
|
|
5459
5504
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsCobrowsesessionParticipantReplace';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5617,8 +5662,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5617
5662
|
*/},{key:"postConversationsMessagesAgentless",value:function postConversationsMessagesAgentless(body){// verify the required parameter 'body' is set
|
|
5618
5663
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagesAgentless';}return this.apiClient.callApi('/api/v2/conversations/messages/agentless','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5619
5664
|
* Send an inbound Open Message
|
|
5620
|
-
*
|
|
5665
|
+
* [This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
5621
5666
|
* @param {Object} body NormalizedMessage
|
|
5667
|
+
* @deprecated
|
|
5622
5668
|
*/},{key:"postConversationsMessagesInboundOpen",value:function postConversationsMessagesInboundOpen(body){// verify the required parameter 'body' is set
|
|
5623
5669
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagesInboundOpen';}return this.apiClient.callApi('/api/v2/conversations/messages/inbound/open','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5624
5670
|
* Create a Facebook Integration
|
|
@@ -5675,12 +5721,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5675
5721
|
*/},{key:"postConversationsParticipantsAttributesSearch",value:function postConversationsParticipantsAttributesSearch(body){// verify the required parameter 'body' is set
|
|
5676
5722
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsParticipantsAttributesSearch';}return this.apiClient.callApi('/api/v2/conversations/participants/attributes/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5677
5723
|
* Apply wrap-up for this conversation communication
|
|
5678
|
-
*
|
|
5724
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
5679
5725
|
* @param {String} conversationId conversationId
|
|
5680
5726
|
* @param {String} participantId participantId
|
|
5681
5727
|
* @param {String} communicationId communicationId
|
|
5682
5728
|
* @param {Object} opts Optional parameters
|
|
5683
5729
|
* @param {Object} opts.body Wrap-up
|
|
5730
|
+
* @deprecated
|
|
5684
5731
|
*/},{key:"postConversationsScreenshareParticipantCommunicationWrapup",value:function postConversationsScreenshareParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
5685
5732
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsScreenshareParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
5686
5733
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsScreenshareParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
@@ -5825,9 +5872,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5825
5872
|
*/},{key:"putConversationsMessagingThreadingtimeline",value:function putConversationsMessagingThreadingtimeline(body){// verify the required parameter 'body' is set
|
|
5826
5873
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingThreadingtimeline';}return this.apiClient.callApi('/api/v2/conversations/messaging/threadingtimeline','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5827
5874
|
* Update a conversation by setting its recording state
|
|
5828
|
-
*
|
|
5875
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
5829
5876
|
* @param {String} conversationId conversationId
|
|
5830
5877
|
* @param {Object} body SetRecordingState
|
|
5878
|
+
* @deprecated
|
|
5831
5879
|
*/},{key:"putConversationsScreenshareRecordingstate",value:function putConversationsScreenshareRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
5832
5880
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';}// verify the required parameter 'body' is set
|
|
5833
5881
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/screenshares/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5847,7 +5895,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5847
5895
|
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(){/**
|
|
5848
5896
|
* DataExtensions service.
|
|
5849
5897
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
5850
|
-
* @version
|
|
5898
|
+
* @version 192.1.0
|
|
5851
5899
|
*/ /**
|
|
5852
5900
|
* Constructs a new DataExtensionsApi.
|
|
5853
5901
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -5868,7 +5916,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5868
5916
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
5869
5917
|
* Downloads service.
|
|
5870
5918
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
5871
|
-
* @version
|
|
5919
|
+
* @version 192.1.0
|
|
5872
5920
|
*/ /**
|
|
5873
5921
|
* Constructs a new DownloadsApi.
|
|
5874
5922
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -5887,7 +5935,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5887
5935
|
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(){/**
|
|
5888
5936
|
* Emails service.
|
|
5889
5937
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
5890
|
-
* @version
|
|
5938
|
+
* @version 192.1.0
|
|
5891
5939
|
*/ /**
|
|
5892
5940
|
* Constructs a new EmailsApi.
|
|
5893
5941
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -5905,7 +5953,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
5905
5953
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
5906
5954
|
* Events service.
|
|
5907
5955
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
5908
|
-
* @version
|
|
5956
|
+
* @version 192.1.0
|
|
5909
5957
|
*/ /**
|
|
5910
5958
|
* Constructs a new EventsApi.
|
|
5911
5959
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -5930,7 +5978,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5930
5978
|
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(){/**
|
|
5931
5979
|
* ExternalContacts service.
|
|
5932
5980
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
5933
|
-
* @version
|
|
5981
|
+
* @version 192.1.0
|
|
5934
5982
|
*/ /**
|
|
5935
5983
|
* Constructs a new ExternalContactsApi.
|
|
5936
5984
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6385,7 +6433,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6385
6433
|
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(){/**
|
|
6386
6434
|
* Fax service.
|
|
6387
6435
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6388
|
-
* @version
|
|
6436
|
+
* @version 192.1.0
|
|
6389
6437
|
*/ /**
|
|
6390
6438
|
* Constructs a new FaxApi.
|
|
6391
6439
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6414,6 +6462,9 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
6414
6462
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
6415
6463
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
6416
6464
|
*/},{key:"getFaxDocuments",value:function getFaxDocuments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/documents','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6465
|
+
* Get organization config for given organization
|
|
6466
|
+
*
|
|
6467
|
+
*/},{key:"getFaxSettings",value:function getFaxSettings(){return this.apiClient.callApi('/api/v2/fax/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6417
6468
|
* Get fax summary
|
|
6418
6469
|
*
|
|
6419
6470
|
*/},{key:"getFaxSummary",value:function getFaxSummary(){return this.apiClient.callApi('/api/v2/fax/summary','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -6423,10 +6474,15 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
6423
6474
|
* @param {Object} body Document
|
|
6424
6475
|
*/},{key:"putFaxDocument",value:function putFaxDocument(documentId,body){// verify the required parameter 'documentId' is set
|
|
6425
6476
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling putFaxDocument';}// verify the required parameter 'body' is set
|
|
6426
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFaxDocument';}return this.apiClient.callApi('/api/v2/fax/documents/{documentId}','PUT',{'documentId':documentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
6477
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFaxDocument';}return this.apiClient.callApi('/api/v2/fax/documents/{documentId}','PUT',{'documentId':documentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6478
|
+
* Update/write organization config for given organization
|
|
6479
|
+
*
|
|
6480
|
+
* @param {Object} opts Optional parameters
|
|
6481
|
+
* @param {Object} opts.body
|
|
6482
|
+
*/},{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(){/**
|
|
6427
6483
|
* Flows service.
|
|
6428
6484
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6429
|
-
* @version
|
|
6485
|
+
* @version 192.1.0
|
|
6430
6486
|
*/ /**
|
|
6431
6487
|
* Constructs a new FlowsApi.
|
|
6432
6488
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6475,7 +6531,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6475
6531
|
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(){/**
|
|
6476
6532
|
* Gamification service.
|
|
6477
6533
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6478
|
-
* @version
|
|
6534
|
+
* @version 192.1.0
|
|
6479
6535
|
*/ /**
|
|
6480
6536
|
* Constructs a new GamificationApi.
|
|
6481
6537
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7015,7 +7071,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7015
7071
|
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(){/**
|
|
7016
7072
|
* GeneralDataProtectionRegulation service.
|
|
7017
7073
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7018
|
-
* @version
|
|
7074
|
+
* @version 192.1.0
|
|
7019
7075
|
*/ /**
|
|
7020
7076
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7021
7077
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7050,7 +7106,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7050
7106
|
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(){/**
|
|
7051
7107
|
* Geolocation service.
|
|
7052
7108
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7053
|
-
* @version
|
|
7109
|
+
* @version 192.1.0
|
|
7054
7110
|
*/ /**
|
|
7055
7111
|
* Constructs a new GeolocationApi.
|
|
7056
7112
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7084,7 +7140,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7084
7140
|
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(){/**
|
|
7085
7141
|
* Greetings service.
|
|
7086
7142
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7087
|
-
* @version
|
|
7143
|
+
* @version 192.1.0
|
|
7088
7144
|
*/ /**
|
|
7089
7145
|
* Constructs a new GreetingsApi.
|
|
7090
7146
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7191,7 +7247,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7191
7247
|
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(){/**
|
|
7192
7248
|
* Groups service.
|
|
7193
7249
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7194
|
-
* @version
|
|
7250
|
+
* @version 192.1.0
|
|
7195
7251
|
*/ /**
|
|
7196
7252
|
* Constructs a new GroupsApi.
|
|
7197
7253
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7324,7 +7380,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7324
7380
|
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(){/**
|
|
7325
7381
|
* IdentityProvider service.
|
|
7326
7382
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7327
|
-
* @version
|
|
7383
|
+
* @version 192.1.0
|
|
7328
7384
|
*/ /**
|
|
7329
7385
|
* Constructs a new IdentityProviderApi.
|
|
7330
7386
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7480,7 +7536,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7480
7536
|
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(){/**
|
|
7481
7537
|
* InfrastructureAsCode service.
|
|
7482
7538
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7483
|
-
* @version
|
|
7539
|
+
* @version 192.1.0
|
|
7484
7540
|
*/ /**
|
|
7485
7541
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7486
7542
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7534,7 +7590,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7534
7590
|
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(){/**
|
|
7535
7591
|
* Integrations service.
|
|
7536
7592
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7537
|
-
* @version
|
|
7593
|
+
* @version 192.1.0
|
|
7538
7594
|
*/ /**
|
|
7539
7595
|
* Constructs a new IntegrationsApi.
|
|
7540
7596
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -7744,7 +7800,7 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
7744
7800
|
* @param {String} opts.previousPage Previous page token
|
|
7745
7801
|
*/},{key:"getIntegrationsClientapps",value:function getIntegrationsClientapps(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/clientapps','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7746
7802
|
* UC integration client application configuration.
|
|
7747
|
-
* This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
7803
|
+
* Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
7748
7804
|
* @param {Object} opts Optional parameters
|
|
7749
7805
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
7750
7806
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -7752,6 +7808,7 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
7752
7808
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
7753
7809
|
* @param {String} opts.nextPage next page token
|
|
7754
7810
|
* @param {String} opts.previousPage Previous page token
|
|
7811
|
+
* @deprecated
|
|
7755
7812
|
*/},{key:"getIntegrationsClientappsUnifiedcommunications",value:function getIntegrationsClientappsUnifiedcommunications(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/clientapps/unifiedcommunications','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7756
7813
|
* Get a single credential with sensitive fields redacted
|
|
7757
7814
|
*
|
|
@@ -8144,7 +8201,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8144
8201
|
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(){/**
|
|
8145
8202
|
* Journey service.
|
|
8146
8203
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8147
|
-
* @version
|
|
8204
|
+
* @version 192.1.0
|
|
8148
8205
|
*/ /**
|
|
8149
8206
|
* Constructs a new JourneyApi.
|
|
8150
8207
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8480,7 +8537,6 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
8480
8537
|
*
|
|
8481
8538
|
* @param {Object} opts Optional parameters
|
|
8482
8539
|
* @param {Object} opts.body
|
|
8483
|
-
* postJourneyFlowsPathsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8484
8540
|
*/},{key:"postJourneyFlowsPathsQuery",value:function postJourneyFlowsPathsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/flows/paths/query','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8485
8541
|
* Create an outcome.
|
|
8486
8542
|
*
|
|
@@ -8533,7 +8589,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8533
8589
|
*/},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
8534
8590
|
* Knowledge service.
|
|
8535
8591
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8536
|
-
* @version
|
|
8592
|
+
* @version 192.1.0
|
|
8537
8593
|
*/ /**
|
|
8538
8594
|
* Constructs a new KnowledgeApi.
|
|
8539
8595
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -9445,7 +9501,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9445
9501
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
9446
9502
|
* LanguageUnderstanding service.
|
|
9447
9503
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9448
|
-
* @version
|
|
9504
|
+
* @version 192.1.0
|
|
9449
9505
|
*/ /**
|
|
9450
9506
|
* Constructs a new LanguageUnderstandingApi.
|
|
9451
9507
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -9611,6 +9667,10 @@ if(minerId===undefined||minerId===null){throw'Missing the required parameter "mi
|
|
|
9611
9667
|
* @param {Object} opts Optional parameters
|
|
9612
9668
|
* @param {String} opts.minerType Type of miner, either intent or topic
|
|
9613
9669
|
*/},{key:"getLanguageunderstandingMiners",value:function getLanguageunderstandingMiners(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/languageunderstanding/miners','GET',{},{'minerType':opts['minerType']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9670
|
+
* Get Organization Configuration
|
|
9671
|
+
*
|
|
9672
|
+
* getLanguageunderstandingSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9673
|
+
*/},{key:"getLanguageunderstandingSettings",value:function getLanguageunderstandingSettings(){return this.apiClient.callApi('/api/v2/languageunderstanding/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9614
9674
|
* Update an NLU Domain.
|
|
9615
9675
|
*
|
|
9616
9676
|
* @param {String} domainId ID of the NLU domain.
|
|
@@ -9701,7 +9761,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
9701
9761
|
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(){/**
|
|
9702
9762
|
* Languages service.
|
|
9703
9763
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
9704
|
-
* @version
|
|
9764
|
+
* @version 192.1.0
|
|
9705
9765
|
*/ /**
|
|
9706
9766
|
* Constructs a new LanguagesApi.
|
|
9707
9767
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -9756,7 +9816,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9756
9816
|
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(){/**
|
|
9757
9817
|
* Learning service.
|
|
9758
9818
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
9759
|
-
* @version
|
|
9819
|
+
* @version 192.1.0
|
|
9760
9820
|
*/ /**
|
|
9761
9821
|
* Constructs a new LearningApi.
|
|
9762
9822
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -9985,7 +10045,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
9985
10045
|
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(){/**
|
|
9986
10046
|
* License service.
|
|
9987
10047
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
9988
|
-
* @version
|
|
10048
|
+
* @version 192.1.0
|
|
9989
10049
|
*/ /**
|
|
9990
10050
|
* Constructs a new LicenseApi.
|
|
9991
10051
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10039,7 +10099,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10039
10099
|
*/},{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(){/**
|
|
10040
10100
|
* Locations service.
|
|
10041
10101
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10042
|
-
* @version
|
|
10102
|
+
* @version 192.1.0
|
|
10043
10103
|
*/ /**
|
|
10044
10104
|
* Constructs a new LocationsApi.
|
|
10045
10105
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10098,7 +10158,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10098
10158
|
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(){/**
|
|
10099
10159
|
* LogCapture service.
|
|
10100
10160
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10101
|
-
* @version
|
|
10161
|
+
* @version 192.1.0
|
|
10102
10162
|
*/ /**
|
|
10103
10163
|
* Constructs a new LogCaptureApi.
|
|
10104
10164
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10148,7 +10208,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10148
10208
|
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(){/**
|
|
10149
10209
|
* Messaging service.
|
|
10150
10210
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10151
|
-
* @version
|
|
10211
|
+
* @version 192.1.0
|
|
10152
10212
|
*/ /**
|
|
10153
10213
|
* Constructs a new MessagingApi.
|
|
10154
10214
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10238,7 +10298,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10238
10298
|
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(){/**
|
|
10239
10299
|
* MobileDevices service.
|
|
10240
10300
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10241
|
-
* @version
|
|
10301
|
+
* @version 192.1.0
|
|
10242
10302
|
*/ /**
|
|
10243
10303
|
* Constructs a new MobileDevicesApi.
|
|
10244
10304
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10277,7 +10337,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10277
10337
|
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(){/**
|
|
10278
10338
|
* Notifications service.
|
|
10279
10339
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10280
|
-
* @version
|
|
10340
|
+
* @version 192.1.0
|
|
10281
10341
|
*/ /**
|
|
10282
10342
|
* Constructs a new NotificationsApi.
|
|
10283
10343
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10334,7 +10394,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10334
10394
|
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(){/**
|
|
10335
10395
|
* OAuth service.
|
|
10336
10396
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10337
|
-
* @version
|
|
10397
|
+
* @version 192.1.0
|
|
10338
10398
|
*/ /**
|
|
10339
10399
|
* Constructs a new OAuthApi.
|
|
10340
10400
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10419,7 +10479,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10419
10479
|
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(){/**
|
|
10420
10480
|
* Objects service.
|
|
10421
10481
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10422
|
-
* @version
|
|
10482
|
+
* @version 192.1.0
|
|
10423
10483
|
*/ /**
|
|
10424
10484
|
* Constructs a new ObjectsApi.
|
|
10425
10485
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -10490,7 +10550,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
10490
10550
|
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(){/**
|
|
10491
10551
|
* OperationalEvents service.
|
|
10492
10552
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
10493
|
-
* @version
|
|
10553
|
+
* @version 192.1.0
|
|
10494
10554
|
*/ /**
|
|
10495
10555
|
* Constructs a new OperationalEventsApi.
|
|
10496
10556
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -10508,7 +10568,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
10508
10568
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
10509
10569
|
* Organization service.
|
|
10510
10570
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
10511
|
-
* @version
|
|
10571
|
+
* @version 192.1.0
|
|
10512
10572
|
*/ /**
|
|
10513
10573
|
* Constructs a new OrganizationApi.
|
|
10514
10574
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10610,7 +10670,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10610
10670
|
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(){/**
|
|
10611
10671
|
* OrganizationAuthorization service.
|
|
10612
10672
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10613
|
-
* @version
|
|
10673
|
+
* @version 192.1.0
|
|
10614
10674
|
*/ /**
|
|
10615
10675
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10616
10676
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -10933,7 +10993,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
10933
10993
|
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(){/**
|
|
10934
10994
|
* Outbound service.
|
|
10935
10995
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
10936
|
-
* @version
|
|
10996
|
+
* @version 192.1.0
|
|
10937
10997
|
*/ /**
|
|
10938
10998
|
* Constructs a new OutboundApi.
|
|
10939
10999
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -11628,8 +11688,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11628
11688
|
* @param {Object} body AttemptLimits
|
|
11629
11689
|
*/},{key:"postOutboundAttemptlimits",value:function postOutboundAttemptlimits(body){// verify the required parameter 'body' is set
|
|
11630
11690
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundAttemptlimits';}return this.apiClient.callApi('/api/v2/outbound/attemptlimits','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11631
|
-
* Retrieves audits for dialer.
|
|
11632
|
-
*
|
|
11691
|
+
* Retrieves audits for dialer. (Deprecated)
|
|
11692
|
+
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
11633
11693
|
* @param {Object} body AuditSearch
|
|
11634
11694
|
* @param {Object} opts Optional parameters
|
|
11635
11695
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -11637,6 +11697,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11637
11697
|
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
11638
11698
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
11639
11699
|
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
11700
|
+
* @deprecated
|
|
11640
11701
|
*/},{key:"postOutboundAudits",value:function postOutboundAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11641
11702
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundAudits';}return this.apiClient.callApi('/api/v2/outbound/audits','POST',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'facetsOnly':opts['facetsOnly']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11642
11703
|
* Create callable time set
|
|
@@ -11971,7 +12032,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11971
12032
|
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(){/**
|
|
11972
12033
|
* Presence service.
|
|
11973
12034
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
11974
|
-
* @version
|
|
12035
|
+
* @version 192.1.0
|
|
11975
12036
|
*/ /**
|
|
11976
12037
|
* Constructs a new PresenceApi.
|
|
11977
12038
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12144,7 +12205,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12144
12205
|
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(){/**
|
|
12145
12206
|
* ProcessAutomation service.
|
|
12146
12207
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12147
|
-
* @version
|
|
12208
|
+
* @version 192.1.0
|
|
12148
12209
|
*/ /**
|
|
12149
12210
|
* Constructs a new ProcessAutomationApi.
|
|
12150
12211
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12207,7 +12268,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12207
12268
|
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(){/**
|
|
12208
12269
|
* Quality service.
|
|
12209
12270
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12210
|
-
* @version
|
|
12271
|
+
* @version 192.1.0
|
|
12211
12272
|
*/ /**
|
|
12212
12273
|
* Constructs a new QualityApi.
|
|
12213
12274
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -12302,7 +12363,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12302
12363
|
*/},{key:"getQualityCalibration",value:function getQualityCalibration(calibrationId,opts){opts=opts||{};// verify the required parameter 'calibrationId' is set
|
|
12303
12364
|
if(calibrationId===undefined||calibrationId===null){throw'Missing the required parameter "calibrationId" when calling getQualityCalibration';}return this.apiClient.callApi('/api/v2/quality/calibrations/{calibrationId}','GET',{'calibrationId':calibrationId},{'calibratorId':opts['calibratorId'],'conversationId':opts['conversationId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12304
12365
|
* Get the list of calibrations
|
|
12305
|
-
*
|
|
12366
|
+
* NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
|
|
12306
12367
|
* @param {String} calibratorId user id of calibrator
|
|
12307
12368
|
* @param {Object} opts Optional parameters
|
|
12308
12369
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -12345,7 +12406,7 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
12345
12406
|
*/},{key:"getQualityConversationsAuditsQueryTransactionIdResults",value:function getQualityConversationsAuditsQueryTransactionIdResults(transactionId,opts){opts=opts||{};// verify the required parameter 'transactionId' is set
|
|
12346
12407
|
if(transactionId===undefined||transactionId===null){throw'Missing the required parameter "transactionId" when calling getQualityConversationsAuditsQueryTransactionIdResults';}return this.apiClient.callApi('/api/v2/quality/conversations/audits/query/{transactionId}/results','GET',{'transactionId':transactionId},{'cursor':opts['cursor'],'pageSize':opts['pageSize'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12347
12408
|
* Queries Evaluations and returns a paged list
|
|
12348
|
-
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
12409
|
+
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch.
|
|
12349
12410
|
* @param {Object} opts Optional parameters
|
|
12350
12411
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
12351
12412
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -12678,7 +12739,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
12678
12739
|
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(){/**
|
|
12679
12740
|
* Recording service.
|
|
12680
12741
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
12681
|
-
* @version
|
|
12742
|
+
* @version 192.1.0
|
|
12682
12743
|
*/ /**
|
|
12683
12744
|
* Constructs a new RecordingApi.
|
|
12684
12745
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -12925,7 +12986,6 @@ if(retentionThresholdDays===undefined||retentionThresholdDays===null){throw'Miss
|
|
|
12925
12986
|
*/},{key:"getRecordingsScreensessions",value:function getRecordingsScreensessions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/screensessions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12926
12987
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
12927
12988
|
*
|
|
12928
|
-
* getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12929
12989
|
*/},{key:"getRecordingsScreensessionsDetails",value:function getRecordingsScreensessionsDetails(){return this.apiClient.callApi('/api/v2/recordings/screensessions/details','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12930
12990
|
* Patch a media retention policy
|
|
12931
12991
|
*
|
|
@@ -13090,7 +13150,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13090
13150
|
*/},{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(){/**
|
|
13091
13151
|
* ResponseManagement service.
|
|
13092
13152
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
13093
|
-
* @version
|
|
13153
|
+
* @version 192.1.0
|
|
13094
13154
|
*/ /**
|
|
13095
13155
|
* Constructs a new ResponseManagementApi.
|
|
13096
13156
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13211,7 +13271,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13211
13271
|
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(){/**
|
|
13212
13272
|
* Routing service.
|
|
13213
13273
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13214
|
-
* @version
|
|
13274
|
+
* @version 192.1.0
|
|
13215
13275
|
*/ /**
|
|
13216
13276
|
* Constructs a new RoutingApi.
|
|
13217
13277
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14186,7 +14246,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14186
14246
|
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(){/**
|
|
14187
14247
|
* SCIM service.
|
|
14188
14248
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14189
|
-
* @version
|
|
14249
|
+
* @version 192.1.0
|
|
14190
14250
|
*/ /**
|
|
14191
14251
|
* Constructs a new SCIMApi.
|
|
14192
14252
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -14411,7 +14471,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14411
14471
|
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(){/**
|
|
14412
14472
|
* ScreenRecording service.
|
|
14413
14473
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
14414
|
-
* @version
|
|
14474
|
+
* @version 192.1.0
|
|
14415
14475
|
*/ /**
|
|
14416
14476
|
* Constructs a new ScreenRecordingApi.
|
|
14417
14477
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -14426,7 +14486,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14426
14486
|
*/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(){/**
|
|
14427
14487
|
* Scripts service.
|
|
14428
14488
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
14429
|
-
* @version
|
|
14489
|
+
* @version 192.1.0
|
|
14430
14490
|
*/ /**
|
|
14431
14491
|
* Constructs a new ScriptsApi.
|
|
14432
14492
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -14562,7 +14622,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
14562
14622
|
*/},{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(){/**
|
|
14563
14623
|
* Search service.
|
|
14564
14624
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
14565
|
-
* @version
|
|
14625
|
+
* @version 192.1.0
|
|
14566
14626
|
*/ /**
|
|
14567
14627
|
* Constructs a new SearchApi.
|
|
14568
14628
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -14722,7 +14782,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14722
14782
|
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(){/**
|
|
14723
14783
|
* Settings service.
|
|
14724
14784
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
14725
|
-
* @version
|
|
14785
|
+
* @version 192.1.0
|
|
14726
14786
|
*/ /**
|
|
14727
14787
|
* Constructs a new SettingsApi.
|
|
14728
14788
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -14750,7 +14810,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14750
14810
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';}return this.apiClient.callApi('/api/v2/settings/executiondata','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
14751
14811
|
* SpeechTextAnalytics service.
|
|
14752
14812
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
14753
|
-
* @version
|
|
14813
|
+
* @version 192.1.0
|
|
14754
14814
|
*/ /**
|
|
14755
14815
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
14756
14816
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -14881,7 +14941,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
14881
14941
|
*
|
|
14882
14942
|
* @param {Object} opts Optional parameters
|
|
14883
14943
|
* @param {String} opts.nextPage The key for listing the next page
|
|
14884
|
-
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
14944
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 500. (default to 20)
|
|
14885
14945
|
* @param {Object} opts.state Topic state. Defaults to latest
|
|
14886
14946
|
* @param {String} opts.name Case insensitive partial name to filter by
|
|
14887
14947
|
* @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
@@ -14994,7 +15054,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
14994
15054
|
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(){/**
|
|
14995
15055
|
* Stations service.
|
|
14996
15056
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
14997
|
-
* @version
|
|
15057
|
+
* @version 192.1.0
|
|
14998
15058
|
*/ /**
|
|
14999
15059
|
* Constructs a new StationsApi.
|
|
15000
15060
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -15026,7 +15086,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
15026
15086
|
*/},{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(){/**
|
|
15027
15087
|
* Suggest service.
|
|
15028
15088
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
15029
|
-
* @version
|
|
15089
|
+
* @version 192.1.0
|
|
15030
15090
|
*/ /**
|
|
15031
15091
|
* Constructs a new SuggestApi.
|
|
15032
15092
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -15066,7 +15126,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15066
15126
|
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(){/**
|
|
15067
15127
|
* TaskManagement service.
|
|
15068
15128
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
15069
|
-
* @version
|
|
15129
|
+
* @version 192.1.0
|
|
15070
15130
|
*/ /**
|
|
15071
15131
|
* Constructs a new TaskManagementApi.
|
|
15072
15132
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -15200,6 +15260,18 @@ if(workitemId===undefined||workitemId===null){throw'Missing the required paramet
|
|
|
15200
15260
|
* getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15201
15261
|
*/},{key:"getTaskmanagementWorkitemWrapups",value:function getTaskmanagementWorkitemWrapups(workitemId,opts){opts=opts||{};// verify the required parameter 'workitemId' is set
|
|
15202
15262
|
if(workitemId===undefined||workitemId===null){throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemWrapups';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/{workitemId}/wrapups','GET',{'workitemId':workitemId},{'expands':opts['expands'],'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15263
|
+
* Get the workitem query job associated with the job id.
|
|
15264
|
+
*
|
|
15265
|
+
* @param {String} jobId jobId
|
|
15266
|
+
* getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15267
|
+
*/},{key:"getTaskmanagementWorkitemsQueryJob",value:function getTaskmanagementWorkitemsQueryJob(jobId){// verify the required parameter 'jobId' is set
|
|
15268
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJob';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/query/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15269
|
+
* Get results from for workitem query job
|
|
15270
|
+
*
|
|
15271
|
+
* @param {String} jobId jobId
|
|
15272
|
+
* getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15273
|
+
*/},{key:"getTaskmanagementWorkitemsQueryJobResults",value:function getTaskmanagementWorkitemsQueryJobResults(jobId){// verify the required parameter 'jobId' is set
|
|
15274
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJobResults';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15203
15275
|
* Get a schema
|
|
15204
15276
|
*
|
|
15205
15277
|
* @param {String} schemaId Schema ID
|
|
@@ -15378,6 +15450,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15378
15450
|
* postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15379
15451
|
*/},{key:"postTaskmanagementWorkitemsQuery",value:function postTaskmanagementWorkitemsQuery(body){// verify the required parameter 'body' is set
|
|
15380
15452
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQuery';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15453
|
+
* Create a workitem query job
|
|
15454
|
+
*
|
|
15455
|
+
* @param {Object} body WorkitemQueryJobCreate
|
|
15456
|
+
* postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15457
|
+
*/},{key:"postTaskmanagementWorkitemsQueryJobs",value:function postTaskmanagementWorkitemsQueryJobs(body){// verify the required parameter 'body' is set
|
|
15458
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQueryJobs';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/query/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15381
15459
|
* Create a schema
|
|
15382
15460
|
*
|
|
15383
15461
|
* @param {Object} body Schema
|
|
@@ -15414,7 +15492,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15414
15492
|
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(){/**
|
|
15415
15493
|
* Teams service.
|
|
15416
15494
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
15417
|
-
* @version
|
|
15495
|
+
* @version 192.1.0
|
|
15418
15496
|
*/ /**
|
|
15419
15497
|
* Constructs a new TeamsApi.
|
|
15420
15498
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -15493,7 +15571,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15493
15571
|
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(){/**
|
|
15494
15572
|
* Telephony service.
|
|
15495
15573
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
15496
|
-
* @version
|
|
15574
|
+
* @version 192.1.0
|
|
15497
15575
|
*/ /**
|
|
15498
15576
|
* Constructs a new TelephonyApi.
|
|
15499
15577
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -15540,7 +15618,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
15540
15618
|
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(){/**
|
|
15541
15619
|
* TelephonyProvidersEdge service.
|
|
15542
15620
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
15543
|
-
* @version
|
|
15621
|
+
* @version 192.1.0
|
|
15544
15622
|
*/ /**
|
|
15545
15623
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
15546
15624
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -15718,10 +15796,6 @@ if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edge
|
|
|
15718
15796
|
* @param {Boolean} opts.managed Filter by managed
|
|
15719
15797
|
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
15720
15798
|
*/},{key:"getTelephonyProvidersEdges",value:function getTelephonyProvidersEdges(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'site.id':opts['siteId'],'edgeGroup.id':opts['edgeGroupId'],'sortBy':opts['sortBy'],'managed':opts['managed'],'showCloudMedia':opts['showCloudMedia']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15721
|
-
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
15722
|
-
*
|
|
15723
|
-
* @deprecated
|
|
15724
|
-
*/},{key:"getTelephonyProvidersEdgesAvailablelanguages",value:function getTelephonyProvidersEdgesAvailablelanguages(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/availablelanguages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15725
15799
|
* Get the list of certificate authorities.
|
|
15726
15800
|
*
|
|
15727
15801
|
*/},{key:"getTelephonyProvidersEdgesCertificateauthorities",value:function getTelephonyProvidersEdgesCertificateauthorities(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/certificateauthorities','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16354,7 +16428,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
16354
16428
|
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(){/**
|
|
16355
16429
|
* Textbots service.
|
|
16356
16430
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
16357
|
-
* @version
|
|
16431
|
+
* @version 192.1.0
|
|
16358
16432
|
*/ /**
|
|
16359
16433
|
* Constructs a new TextbotsApi.
|
|
16360
16434
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -16389,7 +16463,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
16389
16463
|
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(){/**
|
|
16390
16464
|
* Tokens service.
|
|
16391
16465
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
16392
|
-
* @version
|
|
16466
|
+
* @version 192.1.0
|
|
16393
16467
|
*/ /**
|
|
16394
16468
|
* Constructs a new TokensApi.
|
|
16395
16469
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -16423,7 +16497,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16423
16497
|
*/},{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(){/**
|
|
16424
16498
|
* Uploads service.
|
|
16425
16499
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
16426
|
-
* @version
|
|
16500
|
+
* @version 192.1.0
|
|
16427
16501
|
*/ /**
|
|
16428
16502
|
* Constructs a new UploadsApi.
|
|
16429
16503
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -16489,7 +16563,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16489
16563
|
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(){/**
|
|
16490
16564
|
* Usage service.
|
|
16491
16565
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
16492
|
-
* @version
|
|
16566
|
+
* @version 192.1.0
|
|
16493
16567
|
*/ /**
|
|
16494
16568
|
* Constructs a new UsageApi.
|
|
16495
16569
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -16519,8 +16593,11 @@ if(executionId===undefined||executionId===null){throw'Missing the required param
|
|
|
16519
16593
|
* Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
|
|
16520
16594
|
*
|
|
16521
16595
|
* @param {String} executionId ID of the search execution
|
|
16522
|
-
|
|
16523
|
-
|
|
16596
|
+
* @param {Object} opts Optional parameters
|
|
16597
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned
|
|
16598
|
+
* @param {Number} opts.pageSize The max number of entities to be returned per request. Maximum page size of 1000
|
|
16599
|
+
*/},{key:"getUsageSimplesearchExecutionIdResults",value:function getUsageSimplesearchExecutionIdResults(executionId,opts){opts=opts||{};// verify the required parameter 'executionId' is set
|
|
16600
|
+
if(executionId===undefined||executionId===null){throw'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';}return this.apiClient.callApi('/api/v2/usage/simplesearch/{executionId}/results','GET',{'executionId':executionId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16524
16601
|
* Query for OAuth client API usage
|
|
16525
16602
|
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
16526
16603
|
* @param {String} clientId Client ID
|
|
@@ -16540,7 +16617,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16540
16617
|
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(){/**
|
|
16541
16618
|
* UserRecordings service.
|
|
16542
16619
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
16543
|
-
* @version
|
|
16620
|
+
* @version 192.1.0
|
|
16544
16621
|
*/ /**
|
|
16545
16622
|
* Constructs a new UserRecordingsApi.
|
|
16546
16623
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -16589,7 +16666,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
16589
16666
|
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(){/**
|
|
16590
16667
|
* Users service.
|
|
16591
16668
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
16592
|
-
* @version
|
|
16669
|
+
* @version 192.1.0
|
|
16593
16670
|
*/ /**
|
|
16594
16671
|
* Constructs a new UsersApi.
|
|
16595
16672
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -16712,11 +16789,15 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
16712
16789
|
* Returns a listing of roles and permissions for a user.
|
|
16713
16790
|
*
|
|
16714
16791
|
* @param {String} subjectId Subject ID (user or group)
|
|
16715
|
-
|
|
16716
|
-
|
|
16792
|
+
* @param {Object} opts Optional parameters
|
|
16793
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
16794
|
+
*/},{key:"getAuthorizationSubject",value:function getAuthorizationSubject(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
16795
|
+
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling getAuthorizationSubject';}return this.apiClient.callApi('/api/v2/authorization/subjects/{subjectId}','GET',{'subjectId':subjectId},{'includeDuplicates':opts['includeDuplicates']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16717
16796
|
* Returns a listing of roles and permissions for the currently authenticated user.
|
|
16718
16797
|
*
|
|
16719
|
-
|
|
16798
|
+
* @param {Object} opts Optional parameters
|
|
16799
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
16800
|
+
*/},{key:"getAuthorizationSubjectsMe",value:function getAuthorizationSubjectsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/subjects/me','GET',{},{'includeDuplicates':opts['includeDuplicates']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16720
16801
|
* Fetch field config for an entity type
|
|
16721
16802
|
*
|
|
16722
16803
|
* @param {Object} type Field type
|
|
@@ -17248,7 +17329,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
17248
17329
|
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(){/**
|
|
17249
17330
|
* Utilities service.
|
|
17250
17331
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
17251
|
-
* @version
|
|
17332
|
+
* @version 192.1.0
|
|
17252
17333
|
*/ /**
|
|
17253
17334
|
* Constructs a new UtilitiesApi.
|
|
17254
17335
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -17275,7 +17356,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17275
17356
|
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(){/**
|
|
17276
17357
|
* Voicemail service.
|
|
17277
17358
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
17278
|
-
* @version
|
|
17359
|
+
* @version 192.1.0
|
|
17279
17360
|
*/ /**
|
|
17280
17361
|
* Constructs a new VoicemailApi.
|
|
17281
17362
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -17424,7 +17505,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17424
17505
|
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(){/**
|
|
17425
17506
|
* WebChat service.
|
|
17426
17507
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
17427
|
-
* @version
|
|
17508
|
+
* @version 192.1.0
|
|
17428
17509
|
*/ /**
|
|
17429
17510
|
* Constructs a new WebChatApi.
|
|
17430
17511
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -17459,9 +17540,10 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17459
17540
|
* @deprecated
|
|
17460
17541
|
*/},{key:"getWebchatDeployments",value:function getWebchatDeployments(){return this.apiClient.callApi('/api/v2/webchat/deployments','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17461
17542
|
* Get a media request in the conversation
|
|
17462
|
-
*
|
|
17543
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
17463
17544
|
* @param {String} conversationId conversationId
|
|
17464
17545
|
* @param {String} mediaRequestId mediaRequestId
|
|
17546
|
+
* @deprecated
|
|
17465
17547
|
*/},{key:"getWebchatGuestConversationMediarequest",value:function getWebchatGuestConversationMediarequest(conversationId,mediaRequestId){// verify the required parameter 'conversationId' is set
|
|
17466
17548
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequest';}// verify the required parameter 'mediaRequestId' is set
|
|
17467
17549
|
if(mediaRequestId===undefined||mediaRequestId===null){throw'Missing the required parameter "mediaRequestId" when calling getWebchatGuestConversationMediarequest';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}','GET',{'conversationId':conversationId,'mediaRequestId':mediaRequestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -17507,10 +17589,11 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
17507
17589
|
*
|
|
17508
17590
|
*/},{key:"getWebchatSettings",value:function getWebchatSettings(){return this.apiClient.callApi('/api/v2/webchat/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17509
17591
|
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
17510
|
-
*
|
|
17592
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
17511
17593
|
* @param {String} conversationId conversationId
|
|
17512
17594
|
* @param {String} mediaRequestId mediaRequestId
|
|
17513
17595
|
* @param {Object} body Request
|
|
17596
|
+
* @deprecated
|
|
17514
17597
|
*/},{key:"patchWebchatGuestConversationMediarequest",value:function patchWebchatGuestConversationMediarequest(conversationId,mediaRequestId,body){// verify the required parameter 'conversationId' is set
|
|
17515
17598
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchWebchatGuestConversationMediarequest';}// verify the required parameter 'mediaRequestId' is set
|
|
17516
17599
|
if(mediaRequestId===undefined||mediaRequestId===null){throw'Missing the required parameter "mediaRequestId" when calling patchWebchatGuestConversationMediarequest';}// verify the required parameter 'body' is set
|
|
@@ -17557,7 +17640,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17557
17640
|
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(){/**
|
|
17558
17641
|
* WebDeployments service.
|
|
17559
17642
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
17560
|
-
* @version
|
|
17643
|
+
* @version 192.1.0
|
|
17561
17644
|
*/ /**
|
|
17562
17645
|
* Constructs a new WebDeploymentsApi.
|
|
17563
17646
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -17678,7 +17761,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17678
17761
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
17679
17762
|
* WebMessaging service.
|
|
17680
17763
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
17681
|
-
* @version
|
|
17764
|
+
* @version 192.1.0
|
|
17682
17765
|
*/ /**
|
|
17683
17766
|
* Constructs a new WebMessagingApi.
|
|
17684
17767
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -17694,7 +17777,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
17694
17777
|
*/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(){/**
|
|
17695
17778
|
* Widgets service.
|
|
17696
17779
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
17697
|
-
* @version
|
|
17780
|
+
* @version 192.1.0
|
|
17698
17781
|
*/ /**
|
|
17699
17782
|
* Constructs a new WidgetsApi.
|
|
17700
17783
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -17729,7 +17812,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17729
17812
|
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(){/**
|
|
17730
17813
|
* WorkforceManagement service.
|
|
17731
17814
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
17732
|
-
* @version
|
|
17815
|
+
* @version 192.1.0
|
|
17733
17816
|
*/ /**
|
|
17734
17817
|
* Constructs a new WorkforceManagementApi.
|
|
17735
17818
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -19207,7 +19290,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
19207
19290
|
* </pre>
|
|
19208
19291
|
* </p>
|
|
19209
19292
|
* @module purecloud-platform-client-v2/index
|
|
19210
|
-
* @version
|
|
19293
|
+
* @version 192.1.0
|
|
19211
19294
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
19212
19295
|
* The ApiClient constructor.
|
|
19213
19296
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|