purecloud-platform-client-v2 191.0.0 → 192.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +417 -168
- package/dist/web-amd/purecloud-platform-client-v2.js +417 -168
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +203 -126
- package/dist/web-cjs/purecloud-platform-client-v2.js +251 -161
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +438 -247
- 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 +30 -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 -1
- 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 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +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
|
@@ -4127,7 +4127,7 @@ var defaults = {
|
|
|
4127
4127
|
charset: 'utf-8',
|
|
4128
4128
|
charsetSentinel: false,
|
|
4129
4129
|
comma: false,
|
|
4130
|
-
decodeDotInKeys:
|
|
4130
|
+
decodeDotInKeys: false,
|
|
4131
4131
|
decoder: utils.decode,
|
|
4132
4132
|
delimiter: '&',
|
|
4133
4133
|
depth: 5,
|
|
@@ -4878,6 +4878,10 @@ var decode = function (str, decoder, charset) {
|
|
|
4878
4878
|
}
|
|
4879
4879
|
};
|
|
4880
4880
|
|
|
4881
|
+
var limit = 1024;
|
|
4882
|
+
|
|
4883
|
+
/* eslint operator-linebreak: [2, "before"] */
|
|
4884
|
+
|
|
4881
4885
|
var encode = function encode(str, defaultEncoder, charset, kind, format) {
|
|
4882
4886
|
// This code was originally written by Brian White (mscdex) for the io.js core querystring library.
|
|
4883
4887
|
// It has been adapted here for stricter adherence to RFC 3986
|
|
@@ -4899,45 +4903,54 @@ var encode = function encode(str, defaultEncoder, charset, kind, format) {
|
|
|
4899
4903
|
}
|
|
4900
4904
|
|
|
4901
4905
|
var out = '';
|
|
4902
|
-
for (var
|
|
4903
|
-
var
|
|
4904
|
-
|
|
4905
|
-
|
|
4906
|
-
|
|
4907
|
-
|
|
4908
|
-
|
|
4909
|
-
|
|
4910
|
-
|
|
4911
|
-
|
|
4912
|
-
|
|
4913
|
-
|
|
4914
|
-
|
|
4915
|
-
|
|
4916
|
-
|
|
4917
|
-
|
|
4906
|
+
for (var j = 0; j < string.length; j += limit) {
|
|
4907
|
+
var segment = string.length >= limit ? string.slice(j, j + limit) : string;
|
|
4908
|
+
var arr = [];
|
|
4909
|
+
|
|
4910
|
+
for (var i = 0; i < segment.length; ++i) {
|
|
4911
|
+
var c = segment.charCodeAt(i);
|
|
4912
|
+
if (
|
|
4913
|
+
c === 0x2D // -
|
|
4914
|
+
|| c === 0x2E // .
|
|
4915
|
+
|| c === 0x5F // _
|
|
4916
|
+
|| c === 0x7E // ~
|
|
4917
|
+
|| (c >= 0x30 && c <= 0x39) // 0-9
|
|
4918
|
+
|| (c >= 0x41 && c <= 0x5A) // a-z
|
|
4919
|
+
|| (c >= 0x61 && c <= 0x7A) // A-Z
|
|
4920
|
+
|| (format === formats.RFC1738 && (c === 0x28 || c === 0x29)) // ( )
|
|
4921
|
+
) {
|
|
4922
|
+
arr[arr.length] = segment.charAt(i);
|
|
4923
|
+
continue;
|
|
4924
|
+
}
|
|
4918
4925
|
|
|
4919
|
-
|
|
4920
|
-
|
|
4921
|
-
|
|
4922
|
-
|
|
4926
|
+
if (c < 0x80) {
|
|
4927
|
+
arr[arr.length] = hexTable[c];
|
|
4928
|
+
continue;
|
|
4929
|
+
}
|
|
4923
4930
|
|
|
4924
|
-
|
|
4925
|
-
|
|
4926
|
-
|
|
4927
|
-
|
|
4931
|
+
if (c < 0x800) {
|
|
4932
|
+
arr[arr.length] = hexTable[0xC0 | (c >> 6)]
|
|
4933
|
+
+ hexTable[0x80 | (c & 0x3F)];
|
|
4934
|
+
continue;
|
|
4935
|
+
}
|
|
4928
4936
|
|
|
4929
|
-
|
|
4930
|
-
|
|
4931
|
-
|
|
4937
|
+
if (c < 0xD800 || c >= 0xE000) {
|
|
4938
|
+
arr[arr.length] = hexTable[0xE0 | (c >> 12)]
|
|
4939
|
+
+ hexTable[0x80 | ((c >> 6) & 0x3F)]
|
|
4940
|
+
+ hexTable[0x80 | (c & 0x3F)];
|
|
4941
|
+
continue;
|
|
4942
|
+
}
|
|
4943
|
+
|
|
4944
|
+
i += 1;
|
|
4945
|
+
c = 0x10000 + (((c & 0x3FF) << 10) | (segment.charCodeAt(i) & 0x3FF));
|
|
4946
|
+
|
|
4947
|
+
arr[arr.length] = hexTable[0xF0 | (c >> 18)]
|
|
4948
|
+
+ hexTable[0x80 | ((c >> 12) & 0x3F)]
|
|
4949
|
+
+ hexTable[0x80 | ((c >> 6) & 0x3F)]
|
|
4950
|
+
+ hexTable[0x80 | (c & 0x3F)];
|
|
4932
4951
|
}
|
|
4933
4952
|
|
|
4934
|
-
|
|
4935
|
-
c = 0x10000 + (((c & 0x3FF) << 10) | (string.charCodeAt(i) & 0x3FF));
|
|
4936
|
-
/* eslint operator-linebreak: [2, "before"] */
|
|
4937
|
-
out += hexTable[0xF0 | (c >> 18)]
|
|
4938
|
-
+ hexTable[0x80 | ((c >> 12) & 0x3F)]
|
|
4939
|
-
+ hexTable[0x80 | ((c >> 6) & 0x3F)]
|
|
4940
|
-
+ hexTable[0x80 | (c & 0x3F)];
|
|
4953
|
+
out += arr.join('');
|
|
4941
4954
|
}
|
|
4942
4955
|
|
|
4943
4956
|
return out;
|
|
@@ -6033,7 +6046,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6033
6046
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6034
6047
|
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];}}}]);}();/**
|
|
6035
6048
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6036
|
-
* @version
|
|
6049
|
+
* @version 192.0.0
|
|
6037
6050
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6038
6051
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6039
6052
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6345,7 +6358,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6345
6358
|
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(){/**
|
|
6346
6359
|
* Alerting service.
|
|
6347
6360
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6348
|
-
* @version
|
|
6361
|
+
* @version 192.0.0
|
|
6349
6362
|
*/ /**
|
|
6350
6363
|
* Constructs a new AlertingApi.
|
|
6351
6364
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6502,7 +6515,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6502
6515
|
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(){/**
|
|
6503
6516
|
* Analytics service.
|
|
6504
6517
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6505
|
-
* @version
|
|
6518
|
+
* @version 192.0.0
|
|
6506
6519
|
*/ /**
|
|
6507
6520
|
* Constructs a new AnalyticsApi.
|
|
6508
6521
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7152,7 +7165,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
7152
7165
|
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(){/**
|
|
7153
7166
|
* Architect service.
|
|
7154
7167
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7155
|
-
* @version
|
|
7168
|
+
* @version 192.0.0
|
|
7156
7169
|
*/ /**
|
|
7157
7170
|
* Constructs a new ArchitectApi.
|
|
7158
7171
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8268,7 +8281,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8268
8281
|
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(){/**
|
|
8269
8282
|
* Audit service.
|
|
8270
8283
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8271
|
-
* @version
|
|
8284
|
+
* @version 192.0.0
|
|
8272
8285
|
*/ /**
|
|
8273
8286
|
* Constructs a new AuditApi.
|
|
8274
8287
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8310,7 +8323,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8310
8323
|
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(){/**
|
|
8311
8324
|
* Authorization service.
|
|
8312
8325
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8313
|
-
* @version
|
|
8326
|
+
* @version 192.0.0
|
|
8314
8327
|
*/ /**
|
|
8315
8328
|
* Constructs a new AuthorizationApi.
|
|
8316
8329
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8467,11 +8480,15 @@ if(roleId===undefined||roleId===null){throw'Missing the required parameter "role
|
|
|
8467
8480
|
* Returns a listing of roles and permissions for a user.
|
|
8468
8481
|
*
|
|
8469
8482
|
* @param {String} subjectId Subject ID (user or group)
|
|
8470
|
-
|
|
8471
|
-
|
|
8483
|
+
* @param {Object} opts Optional parameters
|
|
8484
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
8485
|
+
*/},{key:"getAuthorizationSubject",value:function getAuthorizationSubject(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
8486
|
+
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']);}/**
|
|
8472
8487
|
* Returns a listing of roles and permissions for the currently authenticated user.
|
|
8473
8488
|
*
|
|
8474
|
-
|
|
8489
|
+
* @param {Object} opts Optional parameters
|
|
8490
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
8491
|
+
*/},{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']);}/**
|
|
8475
8492
|
* Get the count of roles granted to a list of subjects
|
|
8476
8493
|
*
|
|
8477
8494
|
* @param {Object} opts Optional parameters
|
|
@@ -8621,7 +8638,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8621
8638
|
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(){/**
|
|
8622
8639
|
* Billing service.
|
|
8623
8640
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8624
|
-
* @version
|
|
8641
|
+
* @version 192.0.0
|
|
8625
8642
|
*/ /**
|
|
8626
8643
|
* Constructs a new BillingApi.
|
|
8627
8644
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8645,7 +8662,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8645
8662
|
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(){/**
|
|
8646
8663
|
* CarrierServices service.
|
|
8647
8664
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8648
|
-
* @version
|
|
8665
|
+
* @version 192.0.0
|
|
8649
8666
|
*/ /**
|
|
8650
8667
|
* Constructs a new CarrierServicesApi.
|
|
8651
8668
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8665,7 +8682,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8665
8682
|
*/},{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(){/**
|
|
8666
8683
|
* Chat service.
|
|
8667
8684
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8668
|
-
* @version
|
|
8685
|
+
* @version 192.0.0
|
|
8669
8686
|
*/ /**
|
|
8670
8687
|
* Constructs a new ChatApi.
|
|
8671
8688
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8680,6 +8697,13 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8680
8697
|
*/return _createClass(ChatApi,[{key:"deleteChatsRoomMessage",value:function deleteChatsRoomMessage(roomJid,messageId){// verify the required parameter 'roomJid' is set
|
|
8681
8698
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';}// verify the required parameter 'messageId' is set
|
|
8682
8699
|
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']);}/**
|
|
8700
|
+
* Remove a pinned message from a room
|
|
8701
|
+
*
|
|
8702
|
+
* @param {String} roomJid roomJid
|
|
8703
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
8704
|
+
*/},{key:"deleteChatsRoomMessagesPin",value:function deleteChatsRoomMessagesPin(roomJid,pinnedMessageId){// verify the required parameter 'roomJid' is set
|
|
8705
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';}// verify the required parameter 'pinnedMessageId' is set
|
|
8706
|
+
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']);}/**
|
|
8683
8707
|
* Remove a user from a room.
|
|
8684
8708
|
*
|
|
8685
8709
|
* @param {String} roomJid roomJid
|
|
@@ -8687,13 +8711,6 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
8687
8711
|
*/},{key:"deleteChatsRoomParticipant",value:function deleteChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
8688
8712
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
8689
8713
|
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']);}/**
|
|
8690
|
-
* Remove a pinned message from a room
|
|
8691
|
-
*
|
|
8692
|
-
* @param {String} roomJid roomJid
|
|
8693
|
-
* @param {String} pinnedMessageId pinnedMessageId
|
|
8694
|
-
*/},{key:"deleteChatsRoomPinnedmessage",value:function deleteChatsRoomPinnedmessage(roomJid,pinnedMessageId){// verify the required parameter 'roomJid' is set
|
|
8695
|
-
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomPinnedmessage';}// verify the required parameter 'pinnedMessageId' is set
|
|
8696
|
-
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']);}/**
|
|
8697
8714
|
* Delete a message to a user
|
|
8698
8715
|
*
|
|
8699
8716
|
* @param {String} userId userId
|
|
@@ -8701,6 +8718,14 @@ if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the requir
|
|
|
8701
8718
|
*/},{key:"deleteChatsUserMessage",value:function deleteChatsUserMessage(userId,messageId){// verify the required parameter 'userId' is set
|
|
8702
8719
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
8703
8720
|
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']);}/**
|
|
8721
|
+
* Remove a pinned message from a 1on1
|
|
8722
|
+
*
|
|
8723
|
+
* @param {String} userId userId
|
|
8724
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
8725
|
+
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8726
|
+
*/},{key:"deleteChatsUserMessagesPin",value:function deleteChatsUserMessagesPin(userId,pinnedMessageId){// verify the required parameter 'userId' is set
|
|
8727
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';}// verify the required parameter 'pinnedMessageId' is set
|
|
8728
|
+
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']);}/**
|
|
8704
8729
|
* Get a message
|
|
8705
8730
|
*
|
|
8706
8731
|
* @param {String} messageId messageId
|
|
@@ -8751,6 +8776,12 @@ if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "ro
|
|
|
8751
8776
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8752
8777
|
*/},{key:"getChatsThreadMessages",value:function getChatsThreadMessages(threadId,opts){opts=opts||{};// verify the required parameter 'threadId' is set
|
|
8753
8778
|
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']);}/**
|
|
8779
|
+
* Get information for a 1on1
|
|
8780
|
+
*
|
|
8781
|
+
* @param {String} userId userId
|
|
8782
|
+
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8783
|
+
*/},{key:"getChatsUser",value:function getChatsUser(userId){// verify the required parameter 'userId' is set
|
|
8784
|
+
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']);}/**
|
|
8754
8785
|
* Get messages by id(s) from a 1on1
|
|
8755
8786
|
*
|
|
8756
8787
|
* @param {String} userId userId
|
|
@@ -8818,6 +8849,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8818
8849
|
*/},{key:"postChatsRoomMessages",value:function postChatsRoomMessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8819
8850
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomMessages';}// verify the required parameter 'body' is set
|
|
8820
8851
|
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']);}/**
|
|
8852
|
+
* Add pinned messages for a room, up to a maximum of 5 pinned messages
|
|
8853
|
+
*
|
|
8854
|
+
* @param {String} roomJid roomJid
|
|
8855
|
+
* @param {Object} body Pinned Message Ids
|
|
8856
|
+
*/},{key:"postChatsRoomMessagesPins",value:function postChatsRoomMessagesPins(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8857
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';}// verify the required parameter 'body' is set
|
|
8858
|
+
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']);}/**
|
|
8821
8859
|
* Join a room
|
|
8822
8860
|
*
|
|
8823
8861
|
* @param {String} roomJid roomJid
|
|
@@ -8825,13 +8863,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8825
8863
|
*/},{key:"postChatsRoomParticipant",value:function postChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
8826
8864
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
8827
8865
|
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']);}/**
|
|
8828
|
-
* Add pinned messages for a room, up to a maximum of 5 pinned messages
|
|
8829
|
-
*
|
|
8830
|
-
* @param {String} roomJid roomJid
|
|
8831
|
-
* @param {Object} body Pinned Message Ids
|
|
8832
|
-
*/},{key:"postChatsRoomPinnedmessages",value:function postChatsRoomPinnedmessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8833
|
-
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomPinnedmessages';}// verify the required parameter 'body' is set
|
|
8834
|
-
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']);}/**
|
|
8835
8866
|
* Create an adhoc room
|
|
8836
8867
|
*
|
|
8837
8868
|
* @param {Object} body Room properties
|
|
@@ -8844,6 +8875,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8844
8875
|
*/},{key:"postChatsUserMessages",value:function postChatsUserMessages(userId,body){// verify the required parameter 'userId' is set
|
|
8845
8876
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessages';}// verify the required parameter 'body' is set
|
|
8846
8877
|
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']);}/**
|
|
8878
|
+
* Add pinned messages for a 1on1, up to a maximum of 5 pinned messages
|
|
8879
|
+
*
|
|
8880
|
+
* @param {String} userId userId
|
|
8881
|
+
* @param {Object} body Pinned Message Ids
|
|
8882
|
+
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8883
|
+
*/},{key:"postChatsUserMessagesPins",value:function postChatsUserMessagesPins(userId,body){// verify the required parameter 'userId' is set
|
|
8884
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessagesPins';}// verify the required parameter 'body' is set
|
|
8885
|
+
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']);}/**
|
|
8847
8886
|
* Update reactions to a message
|
|
8848
8887
|
*
|
|
8849
8888
|
* @param {String} messageId messageId
|
|
@@ -8858,7 +8897,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8858
8897
|
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(){/**
|
|
8859
8898
|
* Coaching service.
|
|
8860
8899
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8861
|
-
* @version
|
|
8900
|
+
* @version 192.0.0
|
|
8862
8901
|
*/ /**
|
|
8863
8902
|
* Constructs a new CoachingApi.
|
|
8864
8903
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9011,7 +9050,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9011
9050
|
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(){/**
|
|
9012
9051
|
* ContentManagement service.
|
|
9013
9052
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9014
|
-
* @version
|
|
9053
|
+
* @version 192.0.0
|
|
9015
9054
|
*/ /**
|
|
9016
9055
|
* Constructs a new ContentManagementApi.
|
|
9017
9056
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9294,7 +9333,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9294
9333
|
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(){/**
|
|
9295
9334
|
* Conversations service.
|
|
9296
9335
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9297
|
-
* @version
|
|
9336
|
+
* @version 192.0.0
|
|
9298
9337
|
*/ /**
|
|
9299
9338
|
* Constructs a new ConversationsApi.
|
|
9300
9339
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -9613,29 +9652,32 @@ if(participantId===undefined||participantId===null){throw'Missing the required p
|
|
|
9613
9652
|
*/},{key:"getConversationsCobrowsesession",value:function getConversationsCobrowsesession(conversationId){// verify the required parameter 'conversationId' is set
|
|
9614
9653
|
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']);}/**
|
|
9615
9654
|
* Get the wrap-up for this conversation communication.
|
|
9616
|
-
*
|
|
9655
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
9617
9656
|
* @param {String} conversationId conversationId
|
|
9618
9657
|
* @param {String} participantId participantId
|
|
9619
9658
|
* @param {String} communicationId communicationId
|
|
9620
9659
|
* @param {Object} opts Optional parameters
|
|
9621
9660
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
9661
|
+
* @deprecated
|
|
9622
9662
|
*/},{key:"getConversationsCobrowsesessionParticipantCommunicationWrapup",value:function getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
9623
9663
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
9624
9664
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
9625
9665
|
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']);}/**
|
|
9626
9666
|
* Get the wrap-up for this conversation participant.
|
|
9627
|
-
*
|
|
9667
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
9628
9668
|
* @param {String} conversationId conversationId
|
|
9629
9669
|
* @param {String} participantId participantId
|
|
9630
9670
|
* @param {Object} opts Optional parameters
|
|
9631
9671
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
9672
|
+
* @deprecated
|
|
9632
9673
|
*/},{key:"getConversationsCobrowsesessionParticipantWrapup",value:function getConversationsCobrowsesessionParticipantWrapup(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
9633
9674
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantWrapup';}// verify the required parameter 'participantId' is set
|
|
9634
9675
|
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']);}/**
|
|
9635
9676
|
* Get list of wrapup codes for this conversation participant
|
|
9636
|
-
*
|
|
9677
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
9637
9678
|
* @param {String} conversationId conversationId
|
|
9638
9679
|
* @param {String} participantId participantId
|
|
9680
|
+
* @deprecated
|
|
9639
9681
|
*/},{key:"getConversationsCobrowsesessionParticipantWrapupcodes",value:function getConversationsCobrowsesessionParticipantWrapupcodes(conversationId,participantId){// verify the required parameter 'conversationId' is set
|
|
9640
9682
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantWrapupcodes';}// verify the required parameter 'participantId' is set
|
|
9641
9683
|
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']);}/**
|
|
@@ -9908,12 +9950,13 @@ if(messageSettingId===undefined||messageSettingId===null){throw'Missing the requ
|
|
|
9908
9950
|
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
9909
9951
|
* 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.
|
|
9910
9952
|
*/},{key:"getConversationsMessagingSettingsDefault",value:function getConversationsMessagingSettingsDefault(){return this.apiClient.callApi('/api/v2/conversations/messaging/settings/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9911
|
-
* Get a list of Messaging Stickers
|
|
9912
|
-
*
|
|
9953
|
+
* Get a list of Messaging Stickers (Deprecated)
|
|
9954
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
9913
9955
|
* @param {Object} messengerType Messenger Type
|
|
9914
9956
|
* @param {Object} opts Optional parameters
|
|
9915
9957
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
9916
9958
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
9959
|
+
* @deprecated
|
|
9917
9960
|
*/},{key:"getConversationsMessagingSticker",value:function getConversationsMessagingSticker(messengerType,opts){opts=opts||{};// verify the required parameter 'messengerType' is set
|
|
9918
9961
|
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']);}/**
|
|
9919
9962
|
* Get a list of Supported Content profiles
|
|
@@ -9934,12 +9977,13 @@ if(supportedContentId===undefined||supportedContentId===null){throw'Missing the
|
|
|
9934
9977
|
* 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.
|
|
9935
9978
|
*/},{key:"getConversationsMessagingThreadingtimeline",value:function getConversationsMessagingThreadingtimeline(){return this.apiClient.callApi('/api/v2/conversations/messaging/threadingtimeline','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9936
9979
|
* Get the wrap-up for this conversation communication.
|
|
9937
|
-
*
|
|
9980
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
9938
9981
|
* @param {String} conversationId conversationId
|
|
9939
9982
|
* @param {String} participantId participantId
|
|
9940
9983
|
* @param {String} communicationId communicationId
|
|
9941
9984
|
* @param {Object} opts Optional parameters
|
|
9942
9985
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
9986
|
+
* @deprecated
|
|
9943
9987
|
*/},{key:"getConversationsScreenshareParticipantCommunicationWrapup",value:function getConversationsScreenshareParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
9944
9988
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsScreenshareParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
9945
9989
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsScreenshareParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
@@ -10140,36 +10184,40 @@ if(participantId===undefined||participantId===null){throw'Missing the required p
|
|
|
10140
10184
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling patchConversationsChatParticipantCommunication';}// verify the required parameter 'body' is set
|
|
10141
10185
|
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']);}/**
|
|
10142
10186
|
* Update a conversation by disconnecting all of the participants
|
|
10143
|
-
*
|
|
10187
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
10144
10188
|
* @param {String} conversationId conversationId
|
|
10145
10189
|
* @param {Object} body Conversation
|
|
10190
|
+
* @deprecated
|
|
10146
10191
|
*/},{key:"patchConversationsCobrowsesession",value:function patchConversationsCobrowsesession(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
10147
10192
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesession';}// verify the required parameter 'body' is set
|
|
10148
10193
|
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']);}/**
|
|
10149
10194
|
* Update conversation participant
|
|
10150
|
-
*
|
|
10195
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
10151
10196
|
* @param {String} conversationId conversationId
|
|
10152
10197
|
* @param {String} participantId participantId
|
|
10153
10198
|
* @param {Object} opts Optional parameters
|
|
10154
10199
|
* @param {Object} opts.body
|
|
10200
|
+
* @deprecated
|
|
10155
10201
|
*/},{key:"patchConversationsCobrowsesessionParticipant",value:function patchConversationsCobrowsesessionParticipant(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10156
10202
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipant';}// verify the required parameter 'participantId' is set
|
|
10157
10203
|
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']);}/**
|
|
10158
10204
|
* Update the attributes on a conversation participant.
|
|
10159
|
-
*
|
|
10205
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
10160
10206
|
* @param {String} conversationId conversationId
|
|
10161
10207
|
* @param {String} participantId participantId
|
|
10162
10208
|
* @param {Object} opts Optional parameters
|
|
10163
10209
|
* @param {Object} opts.body
|
|
10210
|
+
* @deprecated
|
|
10164
10211
|
*/},{key:"patchConversationsCobrowsesessionParticipantAttributes",value:function patchConversationsCobrowsesessionParticipantAttributes(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10165
10212
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipantAttributes';}// verify the required parameter 'participantId' is set
|
|
10166
10213
|
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']);}/**
|
|
10167
10214
|
* Update conversation participant's communication by disconnecting it.
|
|
10168
|
-
*
|
|
10215
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
10169
10216
|
* @param {String} conversationId conversationId
|
|
10170
10217
|
* @param {String} participantId participantId
|
|
10171
10218
|
* @param {String} communicationId communicationId
|
|
10172
10219
|
* @param {Object} body Participant
|
|
10220
|
+
* @deprecated
|
|
10173
10221
|
*/},{key:"patchConversationsCobrowsesessionParticipantCommunication",value:function patchConversationsCobrowsesessionParticipantCommunication(conversationId,participantId,communicationId,body){// verify the required parameter 'conversationId' is set
|
|
10174
10222
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipantCommunication';}// verify the required parameter 'participantId' is set
|
|
10175
10223
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipantCommunication';}// verify the required parameter 'communicationId' is set
|
|
@@ -10624,22 +10672,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10624
10672
|
*/},{key:"postConversationsChats",value:function postConversationsChats(body){// verify the required parameter 'body' is set
|
|
10625
10673
|
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']);}/**
|
|
10626
10674
|
* Apply wrap-up for this conversation communication
|
|
10627
|
-
*
|
|
10675
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
10628
10676
|
* @param {String} conversationId conversationId
|
|
10629
10677
|
* @param {String} participantId participantId
|
|
10630
10678
|
* @param {String} communicationId communicationId
|
|
10631
10679
|
* @param {Object} opts Optional parameters
|
|
10632
10680
|
* @param {Object} opts.body Wrap-up
|
|
10681
|
+
* @deprecated
|
|
10633
10682
|
*/},{key:"postConversationsCobrowsesessionParticipantCommunicationWrapup",value:function postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10634
10683
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
10635
10684
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
10636
10685
|
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']);}/**
|
|
10637
10686
|
* Replace this participant with the specified user and/or address
|
|
10638
|
-
*
|
|
10687
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
10639
10688
|
* @param {String} conversationId conversationId
|
|
10640
10689
|
* @param {String} participantId participantId
|
|
10641
10690
|
* @param {Object} opts Optional parameters
|
|
10642
10691
|
* @param {Object} opts.body
|
|
10692
|
+
* @deprecated
|
|
10643
10693
|
*/},{key:"postConversationsCobrowsesessionParticipantReplace",value:function postConversationsCobrowsesessionParticipantReplace(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10644
10694
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsCobrowsesessionParticipantReplace';}// verify the required parameter 'participantId' is set
|
|
10645
10695
|
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']);}/**
|
|
@@ -10803,8 +10853,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10803
10853
|
*/},{key:"postConversationsMessagesAgentless",value:function postConversationsMessagesAgentless(body){// verify the required parameter 'body' is set
|
|
10804
10854
|
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']);}/**
|
|
10805
10855
|
* Send an inbound Open Message
|
|
10806
|
-
*
|
|
10856
|
+
* [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.
|
|
10807
10857
|
* @param {Object} body NormalizedMessage
|
|
10858
|
+
* @deprecated
|
|
10808
10859
|
*/},{key:"postConversationsMessagesInboundOpen",value:function postConversationsMessagesInboundOpen(body){// verify the required parameter 'body' is set
|
|
10809
10860
|
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']);}/**
|
|
10810
10861
|
* Create a Facebook Integration
|
|
@@ -10861,12 +10912,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10861
10912
|
*/},{key:"postConversationsParticipantsAttributesSearch",value:function postConversationsParticipantsAttributesSearch(body){// verify the required parameter 'body' is set
|
|
10862
10913
|
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']);}/**
|
|
10863
10914
|
* Apply wrap-up for this conversation communication
|
|
10864
|
-
*
|
|
10915
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
10865
10916
|
* @param {String} conversationId conversationId
|
|
10866
10917
|
* @param {String} participantId participantId
|
|
10867
10918
|
* @param {String} communicationId communicationId
|
|
10868
10919
|
* @param {Object} opts Optional parameters
|
|
10869
10920
|
* @param {Object} opts.body Wrap-up
|
|
10921
|
+
* @deprecated
|
|
10870
10922
|
*/},{key:"postConversationsScreenshareParticipantCommunicationWrapup",value:function postConversationsScreenshareParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10871
10923
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsScreenshareParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
10872
10924
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsScreenshareParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
@@ -11011,9 +11063,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11011
11063
|
*/},{key:"putConversationsMessagingThreadingtimeline",value:function putConversationsMessagingThreadingtimeline(body){// verify the required parameter 'body' is set
|
|
11012
11064
|
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']);}/**
|
|
11013
11065
|
* Update a conversation by setting its recording state
|
|
11014
|
-
*
|
|
11066
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
11015
11067
|
* @param {String} conversationId conversationId
|
|
11016
11068
|
* @param {Object} body SetRecordingState
|
|
11069
|
+
* @deprecated
|
|
11017
11070
|
*/},{key:"putConversationsScreenshareRecordingstate",value:function putConversationsScreenshareRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
11018
11071
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';}// verify the required parameter 'body' is set
|
|
11019
11072
|
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']);}/**
|
|
@@ -11033,7 +11086,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11033
11086
|
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(){/**
|
|
11034
11087
|
* DataExtensions service.
|
|
11035
11088
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11036
|
-
* @version
|
|
11089
|
+
* @version 192.0.0
|
|
11037
11090
|
*/ /**
|
|
11038
11091
|
* Constructs a new DataExtensionsApi.
|
|
11039
11092
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11054,7 +11107,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11054
11107
|
*/},{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(){/**
|
|
11055
11108
|
* Downloads service.
|
|
11056
11109
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11057
|
-
* @version
|
|
11110
|
+
* @version 192.0.0
|
|
11058
11111
|
*/ /**
|
|
11059
11112
|
* Constructs a new DownloadsApi.
|
|
11060
11113
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11073,7 +11126,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11073
11126
|
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(){/**
|
|
11074
11127
|
* Emails service.
|
|
11075
11128
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11076
|
-
* @version
|
|
11129
|
+
* @version 192.0.0
|
|
11077
11130
|
*/ /**
|
|
11078
11131
|
* Constructs a new EmailsApi.
|
|
11079
11132
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11091,7 +11144,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11091
11144
|
*/},{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(){/**
|
|
11092
11145
|
* Events service.
|
|
11093
11146
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11094
|
-
* @version
|
|
11147
|
+
* @version 192.0.0
|
|
11095
11148
|
*/ /**
|
|
11096
11149
|
* Constructs a new EventsApi.
|
|
11097
11150
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11116,7 +11169,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11116
11169
|
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(){/**
|
|
11117
11170
|
* ExternalContacts service.
|
|
11118
11171
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11119
|
-
* @version
|
|
11172
|
+
* @version 192.0.0
|
|
11120
11173
|
*/ /**
|
|
11121
11174
|
* Constructs a new ExternalContactsApi.
|
|
11122
11175
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11571,7 +11624,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11571
11624
|
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(){/**
|
|
11572
11625
|
* Fax service.
|
|
11573
11626
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11574
|
-
* @version
|
|
11627
|
+
* @version 192.0.0
|
|
11575
11628
|
*/ /**
|
|
11576
11629
|
* Constructs a new FaxApi.
|
|
11577
11630
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11600,6 +11653,9 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
11600
11653
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11601
11654
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11602
11655
|
*/},{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']);}/**
|
|
11656
|
+
* Get organization config for given organization
|
|
11657
|
+
*
|
|
11658
|
+
*/},{key:"getFaxSettings",value:function getFaxSettings(){return this.apiClient.callApi('/api/v2/fax/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11603
11659
|
* Get fax summary
|
|
11604
11660
|
*
|
|
11605
11661
|
*/},{key:"getFaxSummary",value:function getFaxSummary(){return this.apiClient.callApi('/api/v2/fax/summary','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -11609,10 +11665,15 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
11609
11665
|
* @param {Object} body Document
|
|
11610
11666
|
*/},{key:"putFaxDocument",value:function putFaxDocument(documentId,body){// verify the required parameter 'documentId' is set
|
|
11611
11667
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling putFaxDocument';}// verify the required parameter 'body' is set
|
|
11612
|
-
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']);}
|
|
11668
|
+
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']);}/**
|
|
11669
|
+
* Update/write organization config for given organization
|
|
11670
|
+
*
|
|
11671
|
+
* @param {Object} opts Optional parameters
|
|
11672
|
+
* @param {Object} opts.body
|
|
11673
|
+
*/},{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(){/**
|
|
11613
11674
|
* Flows service.
|
|
11614
11675
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11615
|
-
* @version
|
|
11676
|
+
* @version 192.0.0
|
|
11616
11677
|
*/ /**
|
|
11617
11678
|
* Constructs a new FlowsApi.
|
|
11618
11679
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11661,7 +11722,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11661
11722
|
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(){/**
|
|
11662
11723
|
* Gamification service.
|
|
11663
11724
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11664
|
-
* @version
|
|
11725
|
+
* @version 192.0.0
|
|
11665
11726
|
*/ /**
|
|
11666
11727
|
* Constructs a new GamificationApi.
|
|
11667
11728
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12201,7 +12262,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12201
12262
|
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(){/**
|
|
12202
12263
|
* GeneralDataProtectionRegulation service.
|
|
12203
12264
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12204
|
-
* @version
|
|
12265
|
+
* @version 192.0.0
|
|
12205
12266
|
*/ /**
|
|
12206
12267
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12207
12268
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12236,7 +12297,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12236
12297
|
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(){/**
|
|
12237
12298
|
* Geolocation service.
|
|
12238
12299
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12239
|
-
* @version
|
|
12300
|
+
* @version 192.0.0
|
|
12240
12301
|
*/ /**
|
|
12241
12302
|
* Constructs a new GeolocationApi.
|
|
12242
12303
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12270,7 +12331,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12270
12331
|
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(){/**
|
|
12271
12332
|
* Greetings service.
|
|
12272
12333
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12273
|
-
* @version
|
|
12334
|
+
* @version 192.0.0
|
|
12274
12335
|
*/ /**
|
|
12275
12336
|
* Constructs a new GreetingsApi.
|
|
12276
12337
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12377,7 +12438,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12377
12438
|
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(){/**
|
|
12378
12439
|
* Groups service.
|
|
12379
12440
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12380
|
-
* @version
|
|
12441
|
+
* @version 192.0.0
|
|
12381
12442
|
*/ /**
|
|
12382
12443
|
* Constructs a new GroupsApi.
|
|
12383
12444
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12510,7 +12571,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12510
12571
|
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(){/**
|
|
12511
12572
|
* IdentityProvider service.
|
|
12512
12573
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12513
|
-
* @version
|
|
12574
|
+
* @version 192.0.0
|
|
12514
12575
|
*/ /**
|
|
12515
12576
|
* Constructs a new IdentityProviderApi.
|
|
12516
12577
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12666,7 +12727,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12666
12727
|
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(){/**
|
|
12667
12728
|
* InfrastructureAsCode service.
|
|
12668
12729
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12669
|
-
* @version
|
|
12730
|
+
* @version 192.0.0
|
|
12670
12731
|
*/ /**
|
|
12671
12732
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12672
12733
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12720,7 +12781,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12720
12781
|
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(){/**
|
|
12721
12782
|
* Integrations service.
|
|
12722
12783
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12723
|
-
* @version
|
|
12784
|
+
* @version 192.0.0
|
|
12724
12785
|
*/ /**
|
|
12725
12786
|
* Constructs a new IntegrationsApi.
|
|
12726
12787
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -12930,7 +12991,7 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
12930
12991
|
* @param {String} opts.previousPage Previous page token
|
|
12931
12992
|
*/},{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']);}/**
|
|
12932
12993
|
* UC integration client application configuration.
|
|
12933
|
-
* This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
12994
|
+
* 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.
|
|
12934
12995
|
* @param {Object} opts Optional parameters
|
|
12935
12996
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
12936
12997
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -12938,6 +12999,7 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
12938
12999
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
12939
13000
|
* @param {String} opts.nextPage next page token
|
|
12940
13001
|
* @param {String} opts.previousPage Previous page token
|
|
13002
|
+
* @deprecated
|
|
12941
13003
|
*/},{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']);}/**
|
|
12942
13004
|
* Get a single credential with sensitive fields redacted
|
|
12943
13005
|
*
|
|
@@ -13330,7 +13392,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13330
13392
|
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(){/**
|
|
13331
13393
|
* Journey service.
|
|
13332
13394
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13333
|
-
* @version
|
|
13395
|
+
* @version 192.0.0
|
|
13334
13396
|
*/ /**
|
|
13335
13397
|
* Constructs a new JourneyApi.
|
|
13336
13398
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13719,7 +13781,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13719
13781
|
*/},{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(){/**
|
|
13720
13782
|
* Knowledge service.
|
|
13721
13783
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13722
|
-
* @version
|
|
13784
|
+
* @version 192.0.0
|
|
13723
13785
|
*/ /**
|
|
13724
13786
|
* Constructs a new KnowledgeApi.
|
|
13725
13787
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14631,7 +14693,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14631
14693
|
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(){/**
|
|
14632
14694
|
* LanguageUnderstanding service.
|
|
14633
14695
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
14634
|
-
* @version
|
|
14696
|
+
* @version 192.0.0
|
|
14635
14697
|
*/ /**
|
|
14636
14698
|
* Constructs a new LanguageUnderstandingApi.
|
|
14637
14699
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14797,6 +14859,10 @@ if(minerId===undefined||minerId===null){throw'Missing the required parameter "mi
|
|
|
14797
14859
|
* @param {Object} opts Optional parameters
|
|
14798
14860
|
* @param {String} opts.minerType Type of miner, either intent or topic
|
|
14799
14861
|
*/},{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']);}/**
|
|
14862
|
+
* Get Organization Configuration
|
|
14863
|
+
*
|
|
14864
|
+
* getLanguageunderstandingSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14865
|
+
*/},{key:"getLanguageunderstandingSettings",value:function getLanguageunderstandingSettings(){return this.apiClient.callApi('/api/v2/languageunderstanding/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14800
14866
|
* Update an NLU Domain.
|
|
14801
14867
|
*
|
|
14802
14868
|
* @param {String} domainId ID of the NLU domain.
|
|
@@ -14887,7 +14953,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14887
14953
|
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(){/**
|
|
14888
14954
|
* Languages service.
|
|
14889
14955
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
14890
|
-
* @version
|
|
14956
|
+
* @version 192.0.0
|
|
14891
14957
|
*/ /**
|
|
14892
14958
|
* Constructs a new LanguagesApi.
|
|
14893
14959
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -14942,7 +15008,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14942
15008
|
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(){/**
|
|
14943
15009
|
* Learning service.
|
|
14944
15010
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
14945
|
-
* @version
|
|
15011
|
+
* @version 192.0.0
|
|
14946
15012
|
*/ /**
|
|
14947
15013
|
* Constructs a new LearningApi.
|
|
14948
15014
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15171,7 +15237,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15171
15237
|
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(){/**
|
|
15172
15238
|
* License service.
|
|
15173
15239
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15174
|
-
* @version
|
|
15240
|
+
* @version 192.0.0
|
|
15175
15241
|
*/ /**
|
|
15176
15242
|
* Constructs a new LicenseApi.
|
|
15177
15243
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15225,7 +15291,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15225
15291
|
*/},{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(){/**
|
|
15226
15292
|
* Locations service.
|
|
15227
15293
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15228
|
-
* @version
|
|
15294
|
+
* @version 192.0.0
|
|
15229
15295
|
*/ /**
|
|
15230
15296
|
* Constructs a new LocationsApi.
|
|
15231
15297
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15284,7 +15350,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15284
15350
|
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(){/**
|
|
15285
15351
|
* LogCapture service.
|
|
15286
15352
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15287
|
-
* @version
|
|
15353
|
+
* @version 192.0.0
|
|
15288
15354
|
*/ /**
|
|
15289
15355
|
* Constructs a new LogCaptureApi.
|
|
15290
15356
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15334,7 +15400,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15334
15400
|
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(){/**
|
|
15335
15401
|
* Messaging service.
|
|
15336
15402
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15337
|
-
* @version
|
|
15403
|
+
* @version 192.0.0
|
|
15338
15404
|
*/ /**
|
|
15339
15405
|
* Constructs a new MessagingApi.
|
|
15340
15406
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -15424,7 +15490,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15424
15490
|
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(){/**
|
|
15425
15491
|
* MobileDevices service.
|
|
15426
15492
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
15427
|
-
* @version
|
|
15493
|
+
* @version 192.0.0
|
|
15428
15494
|
*/ /**
|
|
15429
15495
|
* Constructs a new MobileDevicesApi.
|
|
15430
15496
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -15463,7 +15529,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15463
15529
|
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(){/**
|
|
15464
15530
|
* Notifications service.
|
|
15465
15531
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
15466
|
-
* @version
|
|
15532
|
+
* @version 192.0.0
|
|
15467
15533
|
*/ /**
|
|
15468
15534
|
* Constructs a new NotificationsApi.
|
|
15469
15535
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -15520,7 +15586,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
15520
15586
|
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(){/**
|
|
15521
15587
|
* OAuth service.
|
|
15522
15588
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
15523
|
-
* @version
|
|
15589
|
+
* @version 192.0.0
|
|
15524
15590
|
*/ /**
|
|
15525
15591
|
* Constructs a new OAuthApi.
|
|
15526
15592
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -15605,7 +15671,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
15605
15671
|
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(){/**
|
|
15606
15672
|
* Objects service.
|
|
15607
15673
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
15608
|
-
* @version
|
|
15674
|
+
* @version 192.0.0
|
|
15609
15675
|
*/ /**
|
|
15610
15676
|
* Constructs a new ObjectsApi.
|
|
15611
15677
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -15676,7 +15742,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15676
15742
|
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(){/**
|
|
15677
15743
|
* OperationalEvents service.
|
|
15678
15744
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
15679
|
-
* @version
|
|
15745
|
+
* @version 192.0.0
|
|
15680
15746
|
*/ /**
|
|
15681
15747
|
* Constructs a new OperationalEventsApi.
|
|
15682
15748
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -15694,7 +15760,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
15694
15760
|
*/},{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(){/**
|
|
15695
15761
|
* Organization service.
|
|
15696
15762
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
15697
|
-
* @version
|
|
15763
|
+
* @version 192.0.0
|
|
15698
15764
|
*/ /**
|
|
15699
15765
|
* Constructs a new OrganizationApi.
|
|
15700
15766
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15796,7 +15862,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15796
15862
|
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(){/**
|
|
15797
15863
|
* OrganizationAuthorization service.
|
|
15798
15864
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15799
|
-
* @version
|
|
15865
|
+
* @version 192.0.0
|
|
15800
15866
|
*/ /**
|
|
15801
15867
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15802
15868
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16119,7 +16185,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16119
16185
|
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(){/**
|
|
16120
16186
|
* Outbound service.
|
|
16121
16187
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16122
|
-
* @version
|
|
16188
|
+
* @version 192.0.0
|
|
16123
16189
|
*/ /**
|
|
16124
16190
|
* Constructs a new OutboundApi.
|
|
16125
16191
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -16814,8 +16880,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16814
16880
|
* @param {Object} body AttemptLimits
|
|
16815
16881
|
*/},{key:"postOutboundAttemptlimits",value:function postOutboundAttemptlimits(body){// verify the required parameter 'body' is set
|
|
16816
16882
|
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']);}/**
|
|
16817
|
-
* Retrieves audits for dialer.
|
|
16818
|
-
*
|
|
16883
|
+
* Retrieves audits for dialer. (Deprecated)
|
|
16884
|
+
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
16819
16885
|
* @param {Object} body AuditSearch
|
|
16820
16886
|
* @param {Object} opts Optional parameters
|
|
16821
16887
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -16823,6 +16889,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16823
16889
|
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
16824
16890
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
16825
16891
|
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
16892
|
+
* @deprecated
|
|
16826
16893
|
*/},{key:"postOutboundAudits",value:function postOutboundAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
16827
16894
|
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']);}/**
|
|
16828
16895
|
* Create callable time set
|
|
@@ -17157,7 +17224,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17157
17224
|
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(){/**
|
|
17158
17225
|
* Presence service.
|
|
17159
17226
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17160
|
-
* @version
|
|
17227
|
+
* @version 192.0.0
|
|
17161
17228
|
*/ /**
|
|
17162
17229
|
* Constructs a new PresenceApi.
|
|
17163
17230
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -17330,7 +17397,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17330
17397
|
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(){/**
|
|
17331
17398
|
* ProcessAutomation service.
|
|
17332
17399
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
17333
|
-
* @version
|
|
17400
|
+
* @version 192.0.0
|
|
17334
17401
|
*/ /**
|
|
17335
17402
|
* Constructs a new ProcessAutomationApi.
|
|
17336
17403
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -17393,7 +17460,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
17393
17460
|
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(){/**
|
|
17394
17461
|
* Quality service.
|
|
17395
17462
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
17396
|
-
* @version
|
|
17463
|
+
* @version 192.0.0
|
|
17397
17464
|
*/ /**
|
|
17398
17465
|
* Constructs a new QualityApi.
|
|
17399
17466
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -17488,7 +17555,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
17488
17555
|
*/},{key:"getQualityCalibration",value:function getQualityCalibration(calibrationId,opts){opts=opts||{};// verify the required parameter 'calibrationId' is set
|
|
17489
17556
|
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']);}/**
|
|
17490
17557
|
* Get the list of calibrations
|
|
17491
|
-
*
|
|
17558
|
+
* 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.
|
|
17492
17559
|
* @param {String} calibratorId user id of calibrator
|
|
17493
17560
|
* @param {Object} opts Optional parameters
|
|
17494
17561
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -17531,7 +17598,7 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
17531
17598
|
*/},{key:"getQualityConversationsAuditsQueryTransactionIdResults",value:function getQualityConversationsAuditsQueryTransactionIdResults(transactionId,opts){opts=opts||{};// verify the required parameter 'transactionId' is set
|
|
17532
17599
|
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']);}/**
|
|
17533
17600
|
* Queries Evaluations and returns a paged list
|
|
17534
|
-
* 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.
|
|
17601
|
+
* 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.
|
|
17535
17602
|
* @param {Object} opts Optional parameters
|
|
17536
17603
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
17537
17604
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -17864,7 +17931,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
17864
17931
|
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(){/**
|
|
17865
17932
|
* Recording service.
|
|
17866
17933
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
17867
|
-
* @version
|
|
17934
|
+
* @version 192.0.0
|
|
17868
17935
|
*/ /**
|
|
17869
17936
|
* Constructs a new RecordingApi.
|
|
17870
17937
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -18276,7 +18343,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18276
18343
|
*/},{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(){/**
|
|
18277
18344
|
* ResponseManagement service.
|
|
18278
18345
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
18279
|
-
* @version
|
|
18346
|
+
* @version 192.0.0
|
|
18280
18347
|
*/ /**
|
|
18281
18348
|
* Constructs a new ResponseManagementApi.
|
|
18282
18349
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -18397,7 +18464,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
18397
18464
|
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(){/**
|
|
18398
18465
|
* Routing service.
|
|
18399
18466
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
18400
|
-
* @version
|
|
18467
|
+
* @version 192.0.0
|
|
18401
18468
|
*/ /**
|
|
18402
18469
|
* Constructs a new RoutingApi.
|
|
18403
18470
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -19372,7 +19439,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19372
19439
|
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(){/**
|
|
19373
19440
|
* SCIM service.
|
|
19374
19441
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
19375
|
-
* @version
|
|
19442
|
+
* @version 192.0.0
|
|
19376
19443
|
*/ /**
|
|
19377
19444
|
* Constructs a new SCIMApi.
|
|
19378
19445
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -19597,7 +19664,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19597
19664
|
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(){/**
|
|
19598
19665
|
* ScreenRecording service.
|
|
19599
19666
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
19600
|
-
* @version
|
|
19667
|
+
* @version 192.0.0
|
|
19601
19668
|
*/ /**
|
|
19602
19669
|
* Constructs a new ScreenRecordingApi.
|
|
19603
19670
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -19612,7 +19679,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19612
19679
|
*/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(){/**
|
|
19613
19680
|
* Scripts service.
|
|
19614
19681
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
19615
|
-
* @version
|
|
19682
|
+
* @version 192.0.0
|
|
19616
19683
|
*/ /**
|
|
19617
19684
|
* Constructs a new ScriptsApi.
|
|
19618
19685
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -19748,7 +19815,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
19748
19815
|
*/},{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(){/**
|
|
19749
19816
|
* Search service.
|
|
19750
19817
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
19751
|
-
* @version
|
|
19818
|
+
* @version 192.0.0
|
|
19752
19819
|
*/ /**
|
|
19753
19820
|
* Constructs a new SearchApi.
|
|
19754
19821
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -19908,7 +19975,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19908
19975
|
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(){/**
|
|
19909
19976
|
* Settings service.
|
|
19910
19977
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
19911
|
-
* @version
|
|
19978
|
+
* @version 192.0.0
|
|
19912
19979
|
*/ /**
|
|
19913
19980
|
* Constructs a new SettingsApi.
|
|
19914
19981
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -19936,7 +20003,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19936
20003
|
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(){/**
|
|
19937
20004
|
* SpeechTextAnalytics service.
|
|
19938
20005
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
19939
|
-
* @version
|
|
20006
|
+
* @version 192.0.0
|
|
19940
20007
|
*/ /**
|
|
19941
20008
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
19942
20009
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20067,7 +20134,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20067
20134
|
*
|
|
20068
20135
|
* @param {Object} opts Optional parameters
|
|
20069
20136
|
* @param {String} opts.nextPage The key for listing the next page
|
|
20070
|
-
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
20137
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 500. (default to 20)
|
|
20071
20138
|
* @param {Object} opts.state Topic state. Defaults to latest
|
|
20072
20139
|
* @param {String} opts.name Case insensitive partial name to filter by
|
|
20073
20140
|
* @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
@@ -20180,7 +20247,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20180
20247
|
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(){/**
|
|
20181
20248
|
* Stations service.
|
|
20182
20249
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
20183
|
-
* @version
|
|
20250
|
+
* @version 192.0.0
|
|
20184
20251
|
*/ /**
|
|
20185
20252
|
* Constructs a new StationsApi.
|
|
20186
20253
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -20212,7 +20279,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
20212
20279
|
*/},{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(){/**
|
|
20213
20280
|
* Suggest service.
|
|
20214
20281
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
20215
|
-
* @version
|
|
20282
|
+
* @version 192.0.0
|
|
20216
20283
|
*/ /**
|
|
20217
20284
|
* Constructs a new SuggestApi.
|
|
20218
20285
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -20252,7 +20319,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20252
20319
|
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(){/**
|
|
20253
20320
|
* TaskManagement service.
|
|
20254
20321
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
20255
|
-
* @version
|
|
20322
|
+
* @version 192.0.0
|
|
20256
20323
|
*/ /**
|
|
20257
20324
|
* Constructs a new TaskManagementApi.
|
|
20258
20325
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -20386,6 +20453,18 @@ if(workitemId===undefined||workitemId===null){throw'Missing the required paramet
|
|
|
20386
20453
|
* getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20387
20454
|
*/},{key:"getTaskmanagementWorkitemWrapups",value:function getTaskmanagementWorkitemWrapups(workitemId,opts){opts=opts||{};// verify the required parameter 'workitemId' is set
|
|
20388
20455
|
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']);}/**
|
|
20456
|
+
* Get the workitem query job associated with the job id.
|
|
20457
|
+
*
|
|
20458
|
+
* @param {String} jobId jobId
|
|
20459
|
+
* getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20460
|
+
*/},{key:"getTaskmanagementWorkitemsQueryJob",value:function getTaskmanagementWorkitemsQueryJob(jobId){// verify the required parameter 'jobId' is set
|
|
20461
|
+
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']);}/**
|
|
20462
|
+
* Get results from for workitem query job
|
|
20463
|
+
*
|
|
20464
|
+
* @param {String} jobId jobId
|
|
20465
|
+
* getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20466
|
+
*/},{key:"getTaskmanagementWorkitemsQueryJobResults",value:function getTaskmanagementWorkitemsQueryJobResults(jobId){// verify the required parameter 'jobId' is set
|
|
20467
|
+
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']);}/**
|
|
20389
20468
|
* Get a schema
|
|
20390
20469
|
*
|
|
20391
20470
|
* @param {String} schemaId Schema ID
|
|
@@ -20564,6 +20643,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20564
20643
|
* postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20565
20644
|
*/},{key:"postTaskmanagementWorkitemsQuery",value:function postTaskmanagementWorkitemsQuery(body){// verify the required parameter 'body' is set
|
|
20566
20645
|
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']);}/**
|
|
20646
|
+
* Create a workitem query job
|
|
20647
|
+
*
|
|
20648
|
+
* @param {Object} body WorkitemQueryJobCreate
|
|
20649
|
+
* postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20650
|
+
*/},{key:"postTaskmanagementWorkitemsQueryJobs",value:function postTaskmanagementWorkitemsQueryJobs(body){// verify the required parameter 'body' is set
|
|
20651
|
+
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']);}/**
|
|
20567
20652
|
* Create a schema
|
|
20568
20653
|
*
|
|
20569
20654
|
* @param {Object} body Schema
|
|
@@ -20600,7 +20685,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
20600
20685
|
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(){/**
|
|
20601
20686
|
* Teams service.
|
|
20602
20687
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
20603
|
-
* @version
|
|
20688
|
+
* @version 192.0.0
|
|
20604
20689
|
*/ /**
|
|
20605
20690
|
* Constructs a new TeamsApi.
|
|
20606
20691
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -20679,7 +20764,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20679
20764
|
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(){/**
|
|
20680
20765
|
* Telephony service.
|
|
20681
20766
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
20682
|
-
* @version
|
|
20767
|
+
* @version 192.0.0
|
|
20683
20768
|
*/ /**
|
|
20684
20769
|
* Constructs a new TelephonyApi.
|
|
20685
20770
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -20726,7 +20811,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
20726
20811
|
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(){/**
|
|
20727
20812
|
* TelephonyProvidersEdge service.
|
|
20728
20813
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
20729
|
-
* @version
|
|
20814
|
+
* @version 192.0.0
|
|
20730
20815
|
*/ /**
|
|
20731
20816
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
20732
20817
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -20904,10 +20989,6 @@ if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edge
|
|
|
20904
20989
|
* @param {Boolean} opts.managed Filter by managed
|
|
20905
20990
|
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
20906
20991
|
*/},{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']);}/**
|
|
20907
|
-
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
20908
|
-
*
|
|
20909
|
-
* @deprecated
|
|
20910
|
-
*/},{key:"getTelephonyProvidersEdgesAvailablelanguages",value:function getTelephonyProvidersEdgesAvailablelanguages(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/availablelanguages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20911
20992
|
* Get the list of certificate authorities.
|
|
20912
20993
|
*
|
|
20913
20994
|
*/},{key:"getTelephonyProvidersEdgesCertificateauthorities",value:function getTelephonyProvidersEdgesCertificateauthorities(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/certificateauthorities','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -21540,7 +21621,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
21540
21621
|
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(){/**
|
|
21541
21622
|
* Textbots service.
|
|
21542
21623
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
21543
|
-
* @version
|
|
21624
|
+
* @version 192.0.0
|
|
21544
21625
|
*/ /**
|
|
21545
21626
|
* Constructs a new TextbotsApi.
|
|
21546
21627
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -21575,7 +21656,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
21575
21656
|
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(){/**
|
|
21576
21657
|
* Tokens service.
|
|
21577
21658
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
21578
|
-
* @version
|
|
21659
|
+
* @version 192.0.0
|
|
21579
21660
|
*/ /**
|
|
21580
21661
|
* Constructs a new TokensApi.
|
|
21581
21662
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -21609,7 +21690,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21609
21690
|
*/},{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(){/**
|
|
21610
21691
|
* Uploads service.
|
|
21611
21692
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
21612
|
-
* @version
|
|
21693
|
+
* @version 192.0.0
|
|
21613
21694
|
*/ /**
|
|
21614
21695
|
* Constructs a new UploadsApi.
|
|
21615
21696
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -21675,7 +21756,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21675
21756
|
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(){/**
|
|
21676
21757
|
* Usage service.
|
|
21677
21758
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
21678
|
-
* @version
|
|
21759
|
+
* @version 192.0.0
|
|
21679
21760
|
*/ /**
|
|
21680
21761
|
* Constructs a new UsageApi.
|
|
21681
21762
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -21705,8 +21786,11 @@ if(executionId===undefined||executionId===null){throw'Missing the required param
|
|
|
21705
21786
|
* Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
|
|
21706
21787
|
*
|
|
21707
21788
|
* @param {String} executionId ID of the search execution
|
|
21708
|
-
|
|
21709
|
-
|
|
21789
|
+
* @param {Object} opts Optional parameters
|
|
21790
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned
|
|
21791
|
+
* @param {Number} opts.pageSize The max number of entities to be returned per request. Maximum page size of 1000
|
|
21792
|
+
*/},{key:"getUsageSimplesearchExecutionIdResults",value:function getUsageSimplesearchExecutionIdResults(executionId,opts){opts=opts||{};// verify the required parameter 'executionId' is set
|
|
21793
|
+
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']);}/**
|
|
21710
21794
|
* Query for OAuth client API usage
|
|
21711
21795
|
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
21712
21796
|
* @param {String} clientId Client ID
|
|
@@ -21726,7 +21810,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21726
21810
|
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(){/**
|
|
21727
21811
|
* UserRecordings service.
|
|
21728
21812
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
21729
|
-
* @version
|
|
21813
|
+
* @version 192.0.0
|
|
21730
21814
|
*/ /**
|
|
21731
21815
|
* Constructs a new UserRecordingsApi.
|
|
21732
21816
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -21775,7 +21859,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
21775
21859
|
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(){/**
|
|
21776
21860
|
* Users service.
|
|
21777
21861
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
21778
|
-
* @version
|
|
21862
|
+
* @version 192.0.0
|
|
21779
21863
|
*/ /**
|
|
21780
21864
|
* Constructs a new UsersApi.
|
|
21781
21865
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -21898,11 +21982,15 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
21898
21982
|
* Returns a listing of roles and permissions for a user.
|
|
21899
21983
|
*
|
|
21900
21984
|
* @param {String} subjectId Subject ID (user or group)
|
|
21901
|
-
|
|
21902
|
-
|
|
21985
|
+
* @param {Object} opts Optional parameters
|
|
21986
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
21987
|
+
*/},{key:"getAuthorizationSubject",value:function getAuthorizationSubject(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
21988
|
+
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']);}/**
|
|
21903
21989
|
* Returns a listing of roles and permissions for the currently authenticated user.
|
|
21904
21990
|
*
|
|
21905
|
-
|
|
21991
|
+
* @param {Object} opts Optional parameters
|
|
21992
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
21993
|
+
*/},{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']);}/**
|
|
21906
21994
|
* Fetch field config for an entity type
|
|
21907
21995
|
*
|
|
21908
21996
|
* @param {Object} type Field type
|
|
@@ -22434,7 +22522,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
22434
22522
|
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(){/**
|
|
22435
22523
|
* Utilities service.
|
|
22436
22524
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
22437
|
-
* @version
|
|
22525
|
+
* @version 192.0.0
|
|
22438
22526
|
*/ /**
|
|
22439
22527
|
* Constructs a new UtilitiesApi.
|
|
22440
22528
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -22461,7 +22549,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22461
22549
|
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(){/**
|
|
22462
22550
|
* Voicemail service.
|
|
22463
22551
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
22464
|
-
* @version
|
|
22552
|
+
* @version 192.0.0
|
|
22465
22553
|
*/ /**
|
|
22466
22554
|
* Constructs a new VoicemailApi.
|
|
22467
22555
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -22610,7 +22698,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22610
22698
|
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(){/**
|
|
22611
22699
|
* WebChat service.
|
|
22612
22700
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
22613
|
-
* @version
|
|
22701
|
+
* @version 192.0.0
|
|
22614
22702
|
*/ /**
|
|
22615
22703
|
* Constructs a new WebChatApi.
|
|
22616
22704
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -22645,9 +22733,10 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22645
22733
|
* @deprecated
|
|
22646
22734
|
*/},{key:"getWebchatDeployments",value:function getWebchatDeployments(){return this.apiClient.callApi('/api/v2/webchat/deployments','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22647
22735
|
* Get a media request in the conversation
|
|
22648
|
-
*
|
|
22736
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
22649
22737
|
* @param {String} conversationId conversationId
|
|
22650
22738
|
* @param {String} mediaRequestId mediaRequestId
|
|
22739
|
+
* @deprecated
|
|
22651
22740
|
*/},{key:"getWebchatGuestConversationMediarequest",value:function getWebchatGuestConversationMediarequest(conversationId,mediaRequestId){// verify the required parameter 'conversationId' is set
|
|
22652
22741
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequest';}// verify the required parameter 'mediaRequestId' is set
|
|
22653
22742
|
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']);}/**
|
|
@@ -22693,10 +22782,11 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
22693
22782
|
*
|
|
22694
22783
|
*/},{key:"getWebchatSettings",value:function getWebchatSettings(){return this.apiClient.callApi('/api/v2/webchat/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22695
22784
|
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
22696
|
-
*
|
|
22785
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
22697
22786
|
* @param {String} conversationId conversationId
|
|
22698
22787
|
* @param {String} mediaRequestId mediaRequestId
|
|
22699
22788
|
* @param {Object} body Request
|
|
22789
|
+
* @deprecated
|
|
22700
22790
|
*/},{key:"patchWebchatGuestConversationMediarequest",value:function patchWebchatGuestConversationMediarequest(conversationId,mediaRequestId,body){// verify the required parameter 'conversationId' is set
|
|
22701
22791
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchWebchatGuestConversationMediarequest';}// verify the required parameter 'mediaRequestId' is set
|
|
22702
22792
|
if(mediaRequestId===undefined||mediaRequestId===null){throw'Missing the required parameter "mediaRequestId" when calling patchWebchatGuestConversationMediarequest';}// verify the required parameter 'body' is set
|
|
@@ -22743,7 +22833,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22743
22833
|
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(){/**
|
|
22744
22834
|
* WebDeployments service.
|
|
22745
22835
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
22746
|
-
* @version
|
|
22836
|
+
* @version 192.0.0
|
|
22747
22837
|
*/ /**
|
|
22748
22838
|
* Constructs a new WebDeploymentsApi.
|
|
22749
22839
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -22864,7 +22954,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22864
22954
|
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(){/**
|
|
22865
22955
|
* WebMessaging service.
|
|
22866
22956
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
22867
|
-
* @version
|
|
22957
|
+
* @version 192.0.0
|
|
22868
22958
|
*/ /**
|
|
22869
22959
|
* Constructs a new WebMessagingApi.
|
|
22870
22960
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -22880,7 +22970,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
22880
22970
|
*/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(){/**
|
|
22881
22971
|
* Widgets service.
|
|
22882
22972
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
22883
|
-
* @version
|
|
22973
|
+
* @version 192.0.0
|
|
22884
22974
|
*/ /**
|
|
22885
22975
|
* Constructs a new WidgetsApi.
|
|
22886
22976
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -22915,7 +23005,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22915
23005
|
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(){/**
|
|
22916
23006
|
* WorkforceManagement service.
|
|
22917
23007
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
22918
|
-
* @version
|
|
23008
|
+
* @version 192.0.0
|
|
22919
23009
|
*/ /**
|
|
22920
23010
|
* Constructs a new WorkforceManagementApi.
|
|
22921
23011
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -24393,7 +24483,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
24393
24483
|
* </pre>
|
|
24394
24484
|
* </p>
|
|
24395
24485
|
* @module purecloud-platform-client-v2/index
|
|
24396
|
-
* @version
|
|
24486
|
+
* @version 192.0.0
|
|
24397
24487
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
24398
24488
|
* The ApiClient constructor.
|
|
24399
24489
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|