purecloud-platform-client-v2 189.0.0 → 190.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 +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.js +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +300 -112
- package/dist/web-cjs/purecloud-platform-client-v2.js +385 -144
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +824 -453
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +86 -20
- 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 +13 -8
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +207 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +22 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -7
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +516 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -4120,15 +4120,18 @@ var isArray = Array.isArray;
|
|
|
4120
4120
|
|
|
4121
4121
|
var defaults = {
|
|
4122
4122
|
allowDots: false,
|
|
4123
|
+
allowEmptyArrays: false,
|
|
4123
4124
|
allowPrototypes: false,
|
|
4124
4125
|
allowSparse: false,
|
|
4125
4126
|
arrayLimit: 20,
|
|
4126
4127
|
charset: 'utf-8',
|
|
4127
4128
|
charsetSentinel: false,
|
|
4128
4129
|
comma: false,
|
|
4130
|
+
decodeDotInKeys: true,
|
|
4129
4131
|
decoder: utils.decode,
|
|
4130
4132
|
delimiter: '&',
|
|
4131
4133
|
depth: 5,
|
|
4134
|
+
duplicates: 'combine',
|
|
4132
4135
|
ignoreQueryPrefix: false,
|
|
4133
4136
|
interpretNumericEntities: false,
|
|
4134
4137
|
parameterLimit: 1000,
|
|
@@ -4216,9 +4219,10 @@ var parseValues = function parseQueryStringValues(str, options) {
|
|
|
4216
4219
|
val = isArray(val) ? [val] : val;
|
|
4217
4220
|
}
|
|
4218
4221
|
|
|
4219
|
-
|
|
4222
|
+
var existing = has.call(obj, key);
|
|
4223
|
+
if (existing && options.duplicates === 'combine') {
|
|
4220
4224
|
obj[key] = utils.combine(obj[key], val);
|
|
4221
|
-
} else {
|
|
4225
|
+
} else if (!existing || options.duplicates === 'last') {
|
|
4222
4226
|
obj[key] = val;
|
|
4223
4227
|
}
|
|
4224
4228
|
}
|
|
@@ -4234,24 +4238,25 @@ var parseObject = function (chain, val, options, valuesParsed) {
|
|
|
4234
4238
|
var root = chain[i];
|
|
4235
4239
|
|
|
4236
4240
|
if (root === '[]' && options.parseArrays) {
|
|
4237
|
-
obj = [].concat(leaf);
|
|
4241
|
+
obj = options.allowEmptyArrays && leaf === '' ? [] : [].concat(leaf);
|
|
4238
4242
|
} else {
|
|
4239
4243
|
obj = options.plainObjects ? Object.create(null) : {};
|
|
4240
4244
|
var cleanRoot = root.charAt(0) === '[' && root.charAt(root.length - 1) === ']' ? root.slice(1, -1) : root;
|
|
4241
|
-
var
|
|
4242
|
-
|
|
4245
|
+
var decodedRoot = options.decodeDotInKeys ? cleanRoot.replace(/%2E/g, '.') : cleanRoot;
|
|
4246
|
+
var index = parseInt(decodedRoot, 10);
|
|
4247
|
+
if (!options.parseArrays && decodedRoot === '') {
|
|
4243
4248
|
obj = { 0: leaf };
|
|
4244
4249
|
} else if (
|
|
4245
4250
|
!isNaN(index)
|
|
4246
|
-
&& root !==
|
|
4247
|
-
&& String(index) ===
|
|
4251
|
+
&& root !== decodedRoot
|
|
4252
|
+
&& String(index) === decodedRoot
|
|
4248
4253
|
&& index >= 0
|
|
4249
4254
|
&& (options.parseArrays && index <= options.arrayLimit)
|
|
4250
4255
|
) {
|
|
4251
4256
|
obj = [];
|
|
4252
4257
|
obj[index] = leaf;
|
|
4253
|
-
} else if (
|
|
4254
|
-
obj[
|
|
4258
|
+
} else if (decodedRoot !== '__proto__') {
|
|
4259
|
+
obj[decodedRoot] = leaf;
|
|
4255
4260
|
}
|
|
4256
4261
|
}
|
|
4257
4262
|
|
|
@@ -4320,7 +4325,15 @@ var normalizeParseOptions = function normalizeParseOptions(opts) {
|
|
|
4320
4325
|
return defaults;
|
|
4321
4326
|
}
|
|
4322
4327
|
|
|
4323
|
-
if (
|
|
4328
|
+
if (typeof opts.allowEmptyArrays !== 'undefined' && typeof opts.allowEmptyArrays !== 'boolean') {
|
|
4329
|
+
throw new TypeError('`allowEmptyArrays` option can only be `true` or `false`, when provided');
|
|
4330
|
+
}
|
|
4331
|
+
|
|
4332
|
+
if (typeof opts.decodeDotInKeys !== 'undefined' && typeof opts.decodeDotInKeys !== 'boolean') {
|
|
4333
|
+
throw new TypeError('`decodeDotInKeys` option can only be `true` or `false`, when provided');
|
|
4334
|
+
}
|
|
4335
|
+
|
|
4336
|
+
if (opts.decoder !== null && typeof opts.decoder !== 'undefined' && typeof opts.decoder !== 'function') {
|
|
4324
4337
|
throw new TypeError('Decoder has to be a function.');
|
|
4325
4338
|
}
|
|
4326
4339
|
|
|
@@ -4329,18 +4342,29 @@ var normalizeParseOptions = function normalizeParseOptions(opts) {
|
|
|
4329
4342
|
}
|
|
4330
4343
|
var charset = typeof opts.charset === 'undefined' ? defaults.charset : opts.charset;
|
|
4331
4344
|
|
|
4345
|
+
var duplicates = typeof opts.duplicates === 'undefined' ? defaults.duplicates : opts.duplicates;
|
|
4346
|
+
|
|
4347
|
+
if (duplicates !== 'combine' && duplicates !== 'first' && duplicates !== 'last') {
|
|
4348
|
+
throw new TypeError('The duplicates option must be either combine, first, or last');
|
|
4349
|
+
}
|
|
4350
|
+
|
|
4351
|
+
var allowDots = typeof opts.allowDots === 'undefined' ? opts.decodeDotInKeys === true ? true : defaults.allowDots : !!opts.allowDots;
|
|
4352
|
+
|
|
4332
4353
|
return {
|
|
4333
|
-
allowDots:
|
|
4354
|
+
allowDots: allowDots,
|
|
4355
|
+
allowEmptyArrays: typeof opts.allowEmptyArrays === 'boolean' ? !!opts.allowEmptyArrays : defaults.allowEmptyArrays,
|
|
4334
4356
|
allowPrototypes: typeof opts.allowPrototypes === 'boolean' ? opts.allowPrototypes : defaults.allowPrototypes,
|
|
4335
4357
|
allowSparse: typeof opts.allowSparse === 'boolean' ? opts.allowSparse : defaults.allowSparse,
|
|
4336
4358
|
arrayLimit: typeof opts.arrayLimit === 'number' ? opts.arrayLimit : defaults.arrayLimit,
|
|
4337
4359
|
charset: charset,
|
|
4338
4360
|
charsetSentinel: typeof opts.charsetSentinel === 'boolean' ? opts.charsetSentinel : defaults.charsetSentinel,
|
|
4339
4361
|
comma: typeof opts.comma === 'boolean' ? opts.comma : defaults.comma,
|
|
4362
|
+
decodeDotInKeys: typeof opts.decodeDotInKeys === 'boolean' ? opts.decodeDotInKeys : defaults.decodeDotInKeys,
|
|
4340
4363
|
decoder: typeof opts.decoder === 'function' ? opts.decoder : defaults.decoder,
|
|
4341
4364
|
delimiter: typeof opts.delimiter === 'string' || utils.isRegExp(opts.delimiter) ? opts.delimiter : defaults.delimiter,
|
|
4342
4365
|
// eslint-disable-next-line no-implicit-coercion, no-extra-parens
|
|
4343
4366
|
depth: (typeof opts.depth === 'number' || opts.depth === false) ? +opts.depth : defaults.depth,
|
|
4367
|
+
duplicates: duplicates,
|
|
4344
4368
|
ignoreQueryPrefix: opts.ignoreQueryPrefix === true,
|
|
4345
4369
|
interpretNumericEntities: typeof opts.interpretNumericEntities === 'boolean' ? opts.interpretNumericEntities : defaults.interpretNumericEntities,
|
|
4346
4370
|
parameterLimit: typeof opts.parameterLimit === 'number' ? opts.parameterLimit : defaults.parameterLimit,
|
|
@@ -4409,10 +4433,13 @@ var defaultFormat = formats['default'];
|
|
|
4409
4433
|
var defaults = {
|
|
4410
4434
|
addQueryPrefix: false,
|
|
4411
4435
|
allowDots: false,
|
|
4436
|
+
allowEmptyArrays: false,
|
|
4437
|
+
arrayFormat: 'indices',
|
|
4412
4438
|
charset: 'utf-8',
|
|
4413
4439
|
charsetSentinel: false,
|
|
4414
4440
|
delimiter: '&',
|
|
4415
4441
|
encode: true,
|
|
4442
|
+
encodeDotInKeys: false,
|
|
4416
4443
|
encoder: utils.encode,
|
|
4417
4444
|
encodeValuesOnly: false,
|
|
4418
4445
|
format: defaultFormat,
|
|
@@ -4441,8 +4468,10 @@ var stringify = function stringify(
|
|
|
4441
4468
|
prefix,
|
|
4442
4469
|
generateArrayPrefix,
|
|
4443
4470
|
commaRoundTrip,
|
|
4471
|
+
allowEmptyArrays,
|
|
4444
4472
|
strictNullHandling,
|
|
4445
4473
|
skipNulls,
|
|
4474
|
+
encodeDotInKeys,
|
|
4446
4475
|
encoder,
|
|
4447
4476
|
filter,
|
|
4448
4477
|
sort,
|
|
@@ -4524,7 +4553,13 @@ var stringify = function stringify(
|
|
|
4524
4553
|
objKeys = sort ? keys.sort(sort) : keys;
|
|
4525
4554
|
}
|
|
4526
4555
|
|
|
4527
|
-
var
|
|
4556
|
+
var encodedPrefix = encodeDotInKeys ? prefix.replace(/\./g, '%2E') : prefix;
|
|
4557
|
+
|
|
4558
|
+
var adjustedPrefix = commaRoundTrip && isArray(obj) && obj.length === 1 ? encodedPrefix + '[]' : encodedPrefix;
|
|
4559
|
+
|
|
4560
|
+
if (allowEmptyArrays && isArray(obj) && obj.length === 0) {
|
|
4561
|
+
return adjustedPrefix + '[]';
|
|
4562
|
+
}
|
|
4528
4563
|
|
|
4529
4564
|
for (var j = 0; j < objKeys.length; ++j) {
|
|
4530
4565
|
var key = objKeys[j];
|
|
@@ -4534,9 +4569,10 @@ var stringify = function stringify(
|
|
|
4534
4569
|
continue;
|
|
4535
4570
|
}
|
|
4536
4571
|
|
|
4572
|
+
var encodedKey = allowDots && encodeDotInKeys ? key.replace(/\./g, '%2E') : key;
|
|
4537
4573
|
var keyPrefix = isArray(obj)
|
|
4538
|
-
? typeof generateArrayPrefix === 'function' ? generateArrayPrefix(adjustedPrefix,
|
|
4539
|
-
: adjustedPrefix + (allowDots ? '.' +
|
|
4574
|
+
? typeof generateArrayPrefix === 'function' ? generateArrayPrefix(adjustedPrefix, encodedKey) : adjustedPrefix
|
|
4575
|
+
: adjustedPrefix + (allowDots ? '.' + encodedKey : '[' + encodedKey + ']');
|
|
4540
4576
|
|
|
4541
4577
|
sideChannel.set(object, step);
|
|
4542
4578
|
var valueSideChannel = getSideChannel();
|
|
@@ -4546,8 +4582,10 @@ var stringify = function stringify(
|
|
|
4546
4582
|
keyPrefix,
|
|
4547
4583
|
generateArrayPrefix,
|
|
4548
4584
|
commaRoundTrip,
|
|
4585
|
+
allowEmptyArrays,
|
|
4549
4586
|
strictNullHandling,
|
|
4550
4587
|
skipNulls,
|
|
4588
|
+
encodeDotInKeys,
|
|
4551
4589
|
generateArrayPrefix === 'comma' && encodeValuesOnly && isArray(obj) ? null : encoder,
|
|
4552
4590
|
filter,
|
|
4553
4591
|
sort,
|
|
@@ -4569,6 +4607,14 @@ var normalizeStringifyOptions = function normalizeStringifyOptions(opts) {
|
|
|
4569
4607
|
return defaults;
|
|
4570
4608
|
}
|
|
4571
4609
|
|
|
4610
|
+
if (typeof opts.allowEmptyArrays !== 'undefined' && typeof opts.allowEmptyArrays !== 'boolean') {
|
|
4611
|
+
throw new TypeError('`allowEmptyArrays` option can only be `true` or `false`, when provided');
|
|
4612
|
+
}
|
|
4613
|
+
|
|
4614
|
+
if (typeof opts.encodeDotInKeys !== 'undefined' && typeof opts.encodeDotInKeys !== 'boolean') {
|
|
4615
|
+
throw new TypeError('`encodeDotInKeys` option can only be `true` or `false`, when provided');
|
|
4616
|
+
}
|
|
4617
|
+
|
|
4572
4618
|
if (opts.encoder !== null && typeof opts.encoder !== 'undefined' && typeof opts.encoder !== 'function') {
|
|
4573
4619
|
throw new TypeError('Encoder has to be a function.');
|
|
4574
4620
|
}
|
|
@@ -4592,13 +4638,32 @@ var normalizeStringifyOptions = function normalizeStringifyOptions(opts) {
|
|
|
4592
4638
|
filter = opts.filter;
|
|
4593
4639
|
}
|
|
4594
4640
|
|
|
4641
|
+
var arrayFormat;
|
|
4642
|
+
if (opts.arrayFormat in arrayPrefixGenerators) {
|
|
4643
|
+
arrayFormat = opts.arrayFormat;
|
|
4644
|
+
} else if ('indices' in opts) {
|
|
4645
|
+
arrayFormat = opts.indices ? 'indices' : 'repeat';
|
|
4646
|
+
} else {
|
|
4647
|
+
arrayFormat = defaults.arrayFormat;
|
|
4648
|
+
}
|
|
4649
|
+
|
|
4650
|
+
if ('commaRoundTrip' in opts && typeof opts.commaRoundTrip !== 'boolean') {
|
|
4651
|
+
throw new TypeError('`commaRoundTrip` must be a boolean, or absent');
|
|
4652
|
+
}
|
|
4653
|
+
|
|
4654
|
+
var allowDots = typeof opts.allowDots === 'undefined' ? opts.encodeDotInKeys === true ? true : defaults.allowDots : !!opts.allowDots;
|
|
4655
|
+
|
|
4595
4656
|
return {
|
|
4596
4657
|
addQueryPrefix: typeof opts.addQueryPrefix === 'boolean' ? opts.addQueryPrefix : defaults.addQueryPrefix,
|
|
4597
|
-
allowDots:
|
|
4658
|
+
allowDots: allowDots,
|
|
4659
|
+
allowEmptyArrays: typeof opts.allowEmptyArrays === 'boolean' ? !!opts.allowEmptyArrays : defaults.allowEmptyArrays,
|
|
4660
|
+
arrayFormat: arrayFormat,
|
|
4598
4661
|
charset: charset,
|
|
4599
4662
|
charsetSentinel: typeof opts.charsetSentinel === 'boolean' ? opts.charsetSentinel : defaults.charsetSentinel,
|
|
4663
|
+
commaRoundTrip: opts.commaRoundTrip,
|
|
4600
4664
|
delimiter: typeof opts.delimiter === 'undefined' ? defaults.delimiter : opts.delimiter,
|
|
4601
4665
|
encode: typeof opts.encode === 'boolean' ? opts.encode : defaults.encode,
|
|
4666
|
+
encodeDotInKeys: typeof opts.encodeDotInKeys === 'boolean' ? opts.encodeDotInKeys : defaults.encodeDotInKeys,
|
|
4602
4667
|
encoder: typeof opts.encoder === 'function' ? opts.encoder : defaults.encoder,
|
|
4603
4668
|
encodeValuesOnly: typeof opts.encodeValuesOnly === 'boolean' ? opts.encodeValuesOnly : defaults.encodeValuesOnly,
|
|
4604
4669
|
filter: filter,
|
|
@@ -4632,20 +4697,8 @@ module.exports = function (object, opts) {
|
|
|
4632
4697
|
return '';
|
|
4633
4698
|
}
|
|
4634
4699
|
|
|
4635
|
-
var arrayFormat;
|
|
4636
|
-
|
|
4637
|
-
arrayFormat = opts.arrayFormat;
|
|
4638
|
-
} else if (opts && 'indices' in opts) {
|
|
4639
|
-
arrayFormat = opts.indices ? 'indices' : 'repeat';
|
|
4640
|
-
} else {
|
|
4641
|
-
arrayFormat = 'indices';
|
|
4642
|
-
}
|
|
4643
|
-
|
|
4644
|
-
var generateArrayPrefix = arrayPrefixGenerators[arrayFormat];
|
|
4645
|
-
if (opts && 'commaRoundTrip' in opts && typeof opts.commaRoundTrip !== 'boolean') {
|
|
4646
|
-
throw new TypeError('`commaRoundTrip` must be a boolean, or absent');
|
|
4647
|
-
}
|
|
4648
|
-
var commaRoundTrip = generateArrayPrefix === 'comma' && opts && opts.commaRoundTrip;
|
|
4700
|
+
var generateArrayPrefix = arrayPrefixGenerators[options.arrayFormat];
|
|
4701
|
+
var commaRoundTrip = generateArrayPrefix === 'comma' && options.commaRoundTrip;
|
|
4649
4702
|
|
|
4650
4703
|
if (!objKeys) {
|
|
4651
4704
|
objKeys = Object.keys(obj);
|
|
@@ -4667,8 +4720,10 @@ module.exports = function (object, opts) {
|
|
|
4667
4720
|
key,
|
|
4668
4721
|
generateArrayPrefix,
|
|
4669
4722
|
commaRoundTrip,
|
|
4723
|
+
options.allowEmptyArrays,
|
|
4670
4724
|
options.strictNullHandling,
|
|
4671
4725
|
options.skipNulls,
|
|
4726
|
+
options.encodeDotInKeys,
|
|
4672
4727
|
options.encode ? options.encoder : null,
|
|
4673
4728
|
options.filter,
|
|
4674
4729
|
options.sort,
|
|
@@ -4963,9 +5018,7 @@ var gOPD = require('gopd');
|
|
|
4963
5018
|
var $TypeError = require('es-errors/type');
|
|
4964
5019
|
var $floor = GetIntrinsic('%Math.floor%');
|
|
4965
5020
|
|
|
4966
|
-
/** @
|
|
4967
|
-
|
|
4968
|
-
/** @type {<T extends Func = Func>(fn: T, length: number, loose?: boolean) => T} */
|
|
5021
|
+
/** @type {import('.')} */
|
|
4969
5022
|
module.exports = function setFunctionLength(fn, length) {
|
|
4970
5023
|
if (typeof fn !== 'function') {
|
|
4971
5024
|
throw new $TypeError('`fn` is not a function');
|
|
@@ -5854,7 +5907,7 @@ request.send(requestData||null);});};var knownAdapters={http:httpAdapter,xhr:xhr
|
|
|
5854
5907
|
*/function dispatchRequest(config){throwIfCancellationRequested(config);config.headers=AxiosHeaders$1.from(config.headers);// Transform request data
|
|
5855
5908
|
config.data=transformData.call(config,config.transformRequest);if(['post','put','patch'].indexOf(config.method)!==-1){config.headers.setContentType('application/x-www-form-urlencoded',false);}var adapter=adapters.getAdapter(config.adapter||defaults$1.adapter);return adapter(config).then(function onAdapterResolution(response){throwIfCancellationRequested(config);// Transform response data
|
|
5856
5909
|
response.data=transformData.call(config,config.transformResponse,response);response.headers=AxiosHeaders$1.from(response.headers);return response;},function onAdapterRejection(reason){if(!isCancel(reason)){throwIfCancellationRequested(config);// Transform response data
|
|
5857
|
-
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var headersToObject=function headersToObject(thing){return thing instanceof AxiosHeaders$1?thing
|
|
5910
|
+
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var headersToObject=function headersToObject(thing){return thing instanceof AxiosHeaders$1?_objectSpread({},thing):thing;};/**
|
|
5858
5911
|
* Config-specific merge-function which creates a new config-object
|
|
5859
5912
|
* by merging two configuration objects together.
|
|
5860
5913
|
*
|
|
@@ -5867,7 +5920,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,caseless
|
|
|
5867
5920
|
function mergeDeepProperties(a,b,caseless){if(!utils$1.isUndefined(b)){return getMergedValue(a,b,caseless);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a,caseless);}}// eslint-disable-next-line consistent-return
|
|
5868
5921
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
5869
5922
|
function defaultToConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a);}}// eslint-disable-next-line consistent-return
|
|
5870
|
-
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b){return mergeDeepProperties(headersToObject(a),headersToObject(b),true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var VERSION="1.6.
|
|
5923
|
+
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b){return mergeDeepProperties(headersToObject(a),headersToObject(b),true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var VERSION="1.6.8";var validators$1={};// eslint-disable-next-line func-names
|
|
5871
5924
|
['object','boolean','number','function','string','symbol'].forEach(function(type,i){validators$1[type]=function validator(thing){return _typeof(thing)===type||'a'+(i<1?'n ':' ')+type;};});var deprecatedWarnings={};/**
|
|
5872
5925
|
* Transitional option validator
|
|
5873
5926
|
*
|
|
@@ -5980,7 +6033,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
5980
6033
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
5981
6034
|
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];}}}]);return Configuration;}();/**
|
|
5982
6035
|
* @module purecloud-platform-client-v2/ApiClient
|
|
5983
|
-
* @version
|
|
6036
|
+
* @version 190.0.0
|
|
5984
6037
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
5985
6038
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
5986
6039
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6292,7 +6345,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6292
6345
|
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);});}});}}]);return ApiClient;}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
6293
6346
|
* Alerting service.
|
|
6294
6347
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6295
|
-
* @version
|
|
6348
|
+
* @version 190.0.0
|
|
6296
6349
|
*/ /**
|
|
6297
6350
|
* Constructs a new AlertingApi.
|
|
6298
6351
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6449,7 +6502,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6449
6502
|
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']);}}]);return AlertingApi;}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
6450
6503
|
* Analytics service.
|
|
6451
6504
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6452
|
-
* @version
|
|
6505
|
+
* @version 190.0.0
|
|
6453
6506
|
*/ /**
|
|
6454
6507
|
* Constructs a new AnalyticsApi.
|
|
6455
6508
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7059,7 +7112,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
7059
7112
|
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']);}}]);return AnalyticsApi;}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
7060
7113
|
* Architect service.
|
|
7061
7114
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7062
|
-
* @version
|
|
7115
|
+
* @version 190.0.0
|
|
7063
7116
|
*/ /**
|
|
7064
7117
|
* Constructs a new ArchitectApi.
|
|
7065
7118
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8175,7 +8228,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8175
8228
|
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']);}}]);return ArchitectApi;}();var AuditApi=/*#__PURE__*/function(){/**
|
|
8176
8229
|
* Audit service.
|
|
8177
8230
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8178
|
-
* @version
|
|
8231
|
+
* @version 190.0.0
|
|
8179
8232
|
*/ /**
|
|
8180
8233
|
* Constructs a new AuditApi.
|
|
8181
8234
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8217,7 +8270,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8217
8270
|
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']);}}]);return AuditApi;}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
8218
8271
|
* Authorization service.
|
|
8219
8272
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8220
|
-
* @version
|
|
8273
|
+
* @version 190.0.0
|
|
8221
8274
|
*/ /**
|
|
8222
8275
|
* Constructs a new AuthorizationApi.
|
|
8223
8276
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8528,7 +8581,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8528
8581
|
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']);}}]);return AuthorizationApi;}();var BillingApi=/*#__PURE__*/function(){/**
|
|
8529
8582
|
* Billing service.
|
|
8530
8583
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8531
|
-
* @version
|
|
8584
|
+
* @version 190.0.0
|
|
8532
8585
|
*/ /**
|
|
8533
8586
|
* Constructs a new BillingApi.
|
|
8534
8587
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8552,7 +8605,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8552
8605
|
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']);}}]);return BillingApi;}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
8553
8606
|
* CarrierServices service.
|
|
8554
8607
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8555
|
-
* @version
|
|
8608
|
+
* @version 190.0.0
|
|
8556
8609
|
*/ /**
|
|
8557
8610
|
* Constructs a new CarrierServicesApi.
|
|
8558
8611
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8572,7 +8625,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8572
8625
|
*/},{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']);}}]);return CarrierServicesApi;}();var ChatApi=/*#__PURE__*/function(){/**
|
|
8573
8626
|
* Chat service.
|
|
8574
8627
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8575
|
-
* @version
|
|
8628
|
+
* @version 190.0.0
|
|
8576
8629
|
*/ /**
|
|
8577
8630
|
* Constructs a new ChatApi.
|
|
8578
8631
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8584,7 +8637,6 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8584
8637
|
*
|
|
8585
8638
|
* @param {String} roomJid roomId
|
|
8586
8639
|
* @param {String} messageId messageId
|
|
8587
|
-
* deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8588
8640
|
*/_createClass(ChatApi,[{key:"deleteChatsRoomMessage",value:function deleteChatsRoomMessage(roomJid,messageId){// verify the required parameter 'roomJid' is set
|
|
8589
8641
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';}// verify the required parameter 'messageId' is set
|
|
8590
8642
|
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']);}/**
|
|
@@ -8592,7 +8644,6 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
8592
8644
|
*
|
|
8593
8645
|
* @param {String} roomJid roomJid
|
|
8594
8646
|
* @param {String} userId userId
|
|
8595
|
-
* deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8596
8647
|
*/},{key:"deleteChatsRoomParticipant",value:function deleteChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
8597
8648
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
8598
8649
|
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']);}/**
|
|
@@ -8600,7 +8651,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
8600
8651
|
*
|
|
8601
8652
|
* @param {String} roomJid roomJid
|
|
8602
8653
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
8603
|
-
* deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8604
8654
|
*/},{key:"deleteChatsRoomPinnedmessage",value:function deleteChatsRoomPinnedmessage(roomJid,pinnedMessageId){// verify the required parameter 'roomJid' is set
|
|
8605
8655
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomPinnedmessage';}// verify the required parameter 'pinnedMessageId' is set
|
|
8606
8656
|
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']);}/**
|
|
@@ -8608,27 +8658,23 @@ if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the requir
|
|
|
8608
8658
|
*
|
|
8609
8659
|
* @param {String} userId userId
|
|
8610
8660
|
* @param {String} messageId messageId
|
|
8611
|
-
* deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8612
8661
|
*/},{key:"deleteChatsUserMessage",value:function deleteChatsUserMessage(userId,messageId){// verify the required parameter 'userId' is set
|
|
8613
8662
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
8614
8663
|
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']);}/**
|
|
8615
8664
|
* Get a message
|
|
8616
8665
|
*
|
|
8617
8666
|
* @param {String} messageId messageId
|
|
8618
|
-
* getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8619
8667
|
*/},{key:"getChatsMessage",value:function getChatsMessage(messageId){// verify the required parameter 'messageId' is set
|
|
8620
8668
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling getChatsMessage';}return this.apiClient.callApi('/api/v2/chats/messages/{messageId}','GET',{'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8621
8669
|
* Get a room
|
|
8622
8670
|
*
|
|
8623
8671
|
* @param {String} roomJid roomJid
|
|
8624
|
-
* getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8625
8672
|
*/},{key:"getChatsRoom",value:function getChatsRoom(roomJid){// verify the required parameter 'roomJid' is set
|
|
8626
8673
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoom';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}','GET',{'roomJid':roomJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8627
8674
|
* Get messages by id(s) from a room
|
|
8628
8675
|
*
|
|
8629
8676
|
* @param {String} roomJid roomJid
|
|
8630
8677
|
* @param {String} messageIds messageIds, comma separated
|
|
8631
|
-
* getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8632
8678
|
*/},{key:"getChatsRoomMessage",value:function getChatsRoomMessage(roomJid,messageIds){// verify the required parameter 'roomJid' is set
|
|
8633
8679
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomMessage';}// verify the required parameter 'messageIds' is set
|
|
8634
8680
|
if(messageIds===undefined||messageIds===null){throw'Missing the required parameter "messageIds" when calling getChatsRoomMessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages/{messageIds}','GET',{'roomJid':roomJid,'messageIds':messageIds},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8639,9 +8685,20 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
8639
8685
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8640
8686
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8641
8687
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8642
|
-
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8643
8688
|
*/},{key:"getChatsRoomMessages",value:function getChatsRoomMessages(roomJid,opts){opts=opts||{};// verify the required parameter 'roomJid' is set
|
|
8644
8689
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomMessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages','GET',{'roomJid':roomJid},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8690
|
+
* Get a room participant
|
|
8691
|
+
*
|
|
8692
|
+
* @param {String} roomJid roomJid
|
|
8693
|
+
* @param {String} participantJid participantJid
|
|
8694
|
+
*/},{key:"getChatsRoomParticipant",value:function getChatsRoomParticipant(roomJid,participantJid){// verify the required parameter 'roomJid' is set
|
|
8695
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';}// verify the required parameter 'participantJid' is set
|
|
8696
|
+
if(participantJid===undefined||participantJid===null){throw'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{participantJid}','GET',{'roomJid':roomJid,'participantJid':participantJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8697
|
+
* Get room participants in a room
|
|
8698
|
+
*
|
|
8699
|
+
* @param {String} roomJid roomJid
|
|
8700
|
+
*/},{key:"getChatsRoomParticipants",value:function getChatsRoomParticipants(roomJid){// verify the required parameter 'roomJid' is set
|
|
8701
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants','GET',{'roomJid':roomJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8645
8702
|
* Get Chat Settings.
|
|
8646
8703
|
*
|
|
8647
8704
|
*/},{key:"getChatsSettings",value:function getChatsSettings(){return this.apiClient.callApi('/api/v2/chats/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8652,14 +8709,12 @@ if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "ro
|
|
|
8652
8709
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8653
8710
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8654
8711
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8655
|
-
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8656
8712
|
*/},{key:"getChatsThreadMessages",value:function getChatsThreadMessages(threadId,opts){opts=opts||{};// verify the required parameter 'threadId' is set
|
|
8657
8713
|
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']);}/**
|
|
8658
8714
|
* Get messages by id(s) from a 1on1
|
|
8659
8715
|
*
|
|
8660
8716
|
* @param {String} userId userId
|
|
8661
8717
|
* @param {String} messageIds messageIds, comma separated
|
|
8662
|
-
* getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8663
8718
|
*/},{key:"getChatsUserMessage",value:function getChatsUserMessage(userId,messageIds){// verify the required parameter 'userId' is set
|
|
8664
8719
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserMessage';}// verify the required parameter 'messageIds' is set
|
|
8665
8720
|
if(messageIds===undefined||messageIds===null){throw'Missing the required parameter "messageIds" when calling getChatsUserMessage';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/{messageIds}','GET',{'userId':userId,'messageIds':messageIds},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8670,7 +8725,6 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
8670
8725
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8671
8726
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8672
8727
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8673
|
-
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8674
8728
|
*/},{key:"getChatsUserMessages",value:function getChatsUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
8675
8729
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserMessages';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages','GET',{'userId':userId},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8676
8730
|
* Get a user's chat settings
|
|
@@ -8683,7 +8737,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
8683
8737
|
*
|
|
8684
8738
|
* @param {String} roomJid roomJid
|
|
8685
8739
|
* @param {Object} body Room properties
|
|
8686
|
-
* patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8687
8740
|
*/},{key:"patchChatsRoom",value:function patchChatsRoom(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8688
8741
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling patchChatsRoom';}// verify the required parameter 'body' is set
|
|
8689
8742
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchChatsRoom';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}','PATCH',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8692,7 +8745,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8692
8745
|
* @param {String} roomJid roomId
|
|
8693
8746
|
* @param {String} messageId messageId
|
|
8694
8747
|
* @param {Object} body messageBody
|
|
8695
|
-
* patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8696
8748
|
*/},{key:"patchChatsRoomMessage",value:function patchChatsRoomMessage(roomJid,messageId,body){// verify the required parameter 'roomJid' is set
|
|
8697
8749
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling patchChatsRoomMessage';}// verify the required parameter 'messageId' is set
|
|
8698
8750
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling patchChatsRoomMessage';}// verify the required parameter 'body' is set
|
|
@@ -8707,7 +8759,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8707
8759
|
* @param {String} userId userId
|
|
8708
8760
|
* @param {String} messageId messageId
|
|
8709
8761
|
* @param {Object} body message body
|
|
8710
|
-
* patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8711
8762
|
*/},{key:"patchChatsUserMessage",value:function patchChatsUserMessage(userId,messageId,body){// verify the required parameter 'userId' is set
|
|
8712
8763
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
8713
8764
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling patchChatsUserMessage';}// verify the required parameter 'body' is set
|
|
@@ -8724,7 +8775,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8724
8775
|
*
|
|
8725
8776
|
* @param {String} roomJid roomId
|
|
8726
8777
|
* @param {Object} body messageBody
|
|
8727
|
-
* postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8728
8778
|
*/},{key:"postChatsRoomMessages",value:function postChatsRoomMessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8729
8779
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomMessages';}// verify the required parameter 'body' is set
|
|
8730
8780
|
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']);}/**
|
|
@@ -8732,7 +8782,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8732
8782
|
*
|
|
8733
8783
|
* @param {String} roomJid roomJid
|
|
8734
8784
|
* @param {String} userId userId
|
|
8735
|
-
* postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8736
8785
|
*/},{key:"postChatsRoomParticipant",value:function postChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
8737
8786
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
8738
8787
|
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']);}/**
|
|
@@ -8740,24 +8789,28 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
8740
8789
|
*
|
|
8741
8790
|
* @param {String} roomJid roomJid
|
|
8742
8791
|
* @param {Object} body Pinned Message Ids
|
|
8743
|
-
* postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8744
8792
|
*/},{key:"postChatsRoomPinnedmessages",value:function postChatsRoomPinnedmessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8745
8793
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomPinnedmessages';}// verify the required parameter 'body' is set
|
|
8746
8794
|
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']);}/**
|
|
8747
8795
|
* Create an adhoc room
|
|
8748
8796
|
*
|
|
8749
8797
|
* @param {Object} body Room properties
|
|
8750
|
-
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8751
8798
|
*/},{key:"postChatsRooms",value:function postChatsRooms(body){// verify the required parameter 'body' is set
|
|
8752
8799
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRooms';}return this.apiClient.callApi('/api/v2/chats/rooms','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8753
8800
|
* Send a message to a user
|
|
8754
8801
|
*
|
|
8755
8802
|
* @param {String} userId userId
|
|
8756
8803
|
* @param {Object} body message body
|
|
8757
|
-
* postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8758
8804
|
*/},{key:"postChatsUserMessages",value:function postChatsUserMessages(userId,body){// verify the required parameter 'userId' is set
|
|
8759
8805
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessages';}// verify the required parameter 'body' is set
|
|
8760
8806
|
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']);}/**
|
|
8807
|
+
* Update reactions to a message
|
|
8808
|
+
*
|
|
8809
|
+
* @param {String} messageId messageId
|
|
8810
|
+
* @param {Object} body reactionUpdate
|
|
8811
|
+
*/},{key:"putChatsMessageReactions",value:function putChatsMessageReactions(messageId,body){// verify the required parameter 'messageId' is set
|
|
8812
|
+
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling putChatsMessageReactions';}// verify the required parameter 'body' is set
|
|
8813
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsMessageReactions';}return this.apiClient.callApi('/api/v2/chats/messages/{messageId}/reactions','PUT',{'messageId':messageId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8761
8814
|
* Update Chat Settings.
|
|
8762
8815
|
*
|
|
8763
8816
|
* @param {Object} body Chat
|
|
@@ -8765,7 +8818,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8765
8818
|
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']);}}]);return ChatApi;}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
8766
8819
|
* Coaching service.
|
|
8767
8820
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8768
|
-
* @version
|
|
8821
|
+
* @version 190.0.0
|
|
8769
8822
|
*/ /**
|
|
8770
8823
|
* Constructs a new CoachingApi.
|
|
8771
8824
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -8918,7 +8971,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8918
8971
|
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']);}}]);return CoachingApi;}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
8919
8972
|
* ContentManagement service.
|
|
8920
8973
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8921
|
-
* @version
|
|
8974
|
+
* @version 190.0.0
|
|
8922
8975
|
*/ /**
|
|
8923
8976
|
* Constructs a new ContentManagementApi.
|
|
8924
8977
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9201,7 +9254,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9201
9254
|
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']);}}]);return ContentManagementApi;}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
9202
9255
|
* Conversations service.
|
|
9203
9256
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9204
|
-
* @version
|
|
9257
|
+
* @version 190.0.0
|
|
9205
9258
|
*/ /**
|
|
9206
9259
|
* Constructs a new ConversationsApi.
|
|
9207
9260
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -9271,8 +9324,9 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
9271
9324
|
*/},{key:"deleteConversationsMessagingIntegrationsOpenIntegrationId",value:function deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
9272
9325
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9273
9326
|
* Delete a Twitter messaging integration
|
|
9274
|
-
*
|
|
9327
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
9275
9328
|
* @param {String} integrationId Integration ID
|
|
9329
|
+
* @deprecated
|
|
9276
9330
|
*/},{key:"deleteConversationsMessagingIntegrationsTwitterIntegrationId",value:function deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
9277
9331
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9278
9332
|
* Delete a WhatsApp messaging integration
|
|
@@ -9763,20 +9817,22 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
9763
9817
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
9764
9818
|
*/},{key:"getConversationsMessagingIntegrationsOpenIntegrationId",value:function getConversationsMessagingIntegrationsOpenIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
9765
9819
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9766
|
-
* Get a list of Twitter Integrations
|
|
9767
|
-
*
|
|
9820
|
+
* Get a list of Twitter Integrations (Deprecated)
|
|
9821
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
9768
9822
|
* @param {Object} opts Optional parameters
|
|
9769
9823
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
9770
9824
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
9771
9825
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
9772
9826
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
9773
9827
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
9828
|
+
* @deprecated
|
|
9774
9829
|
*/},{key:"getConversationsMessagingIntegrationsTwitter",value:function getConversationsMessagingIntegrationsTwitter(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':opts['expand'],'supportedContent.id':opts['supportedContentId'],'messagingSetting.id':opts['messagingSettingId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9775
|
-
* Get a Twitter messaging integration
|
|
9776
|
-
*
|
|
9830
|
+
* Get a Twitter messaging integration (Deprecated)
|
|
9831
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
9777
9832
|
* @param {String} integrationId Integration ID
|
|
9778
9833
|
* @param {Object} opts Optional parameters
|
|
9779
9834
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
9835
|
+
* @deprecated
|
|
9780
9836
|
*/},{key:"getConversationsMessagingIntegrationsTwitterIntegrationId",value:function getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
9781
9837
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9782
9838
|
* Get a list of WhatsApp Integrations
|
|
@@ -10179,9 +10235,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10179
10235
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}// verify the required parameter 'body' is set
|
|
10180
10236
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10181
10237
|
* Update Twitter messaging integration
|
|
10182
|
-
*
|
|
10238
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
10183
10239
|
* @param {String} integrationId Integration ID
|
|
10184
10240
|
* @param {Object} body TwitterIntegrationRequest
|
|
10241
|
+
* @deprecated
|
|
10185
10242
|
*/},{key:"patchConversationsMessagingIntegrationsTwitterIntegrationId",value:function patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
10186
10243
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}// verify the required parameter 'body' is set
|
|
10187
10244
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -10729,8 +10786,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10729
10786
|
*/},{key:"postConversationsMessagingIntegrationsOpen",value:function postConversationsMessagingIntegrationsOpen(body){// verify the required parameter 'body' is set
|
|
10730
10787
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsOpen';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10731
10788
|
* Create a Twitter Integration
|
|
10732
|
-
*
|
|
10789
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
10733
10790
|
* @param {Object} body TwitterIntegrationRequest
|
|
10791
|
+
* @deprecated
|
|
10734
10792
|
*/},{key:"postConversationsMessagingIntegrationsTwitter",value:function postConversationsMessagingIntegrationsTwitter(body){// verify the required parameter 'body' is set
|
|
10735
10793
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10736
10794
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
@@ -10932,7 +10990,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10932
10990
|
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']);}}]);return ConversationsApi;}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
10933
10991
|
* DataExtensions service.
|
|
10934
10992
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
10935
|
-
* @version
|
|
10993
|
+
* @version 190.0.0
|
|
10936
10994
|
*/ /**
|
|
10937
10995
|
* Constructs a new DataExtensionsApi.
|
|
10938
10996
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -10953,7 +11011,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10953
11011
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return DataExtensionsApi;}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
10954
11012
|
* Downloads service.
|
|
10955
11013
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
10956
|
-
* @version
|
|
11014
|
+
* @version 190.0.0
|
|
10957
11015
|
*/ /**
|
|
10958
11016
|
* Constructs a new DownloadsApi.
|
|
10959
11017
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -10972,7 +11030,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10972
11030
|
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']);}}]);return DownloadsApi;}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
10973
11031
|
* Emails service.
|
|
10974
11032
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
10975
|
-
* @version
|
|
11033
|
+
* @version 190.0.0
|
|
10976
11034
|
*/ /**
|
|
10977
11035
|
* Constructs a new EmailsApi.
|
|
10978
11036
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -10990,7 +11048,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
10990
11048
|
*/},{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']);}}]);return EmailsApi;}();var EventsApi=/*#__PURE__*/function(){/**
|
|
10991
11049
|
* Events service.
|
|
10992
11050
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
10993
|
-
* @version
|
|
11051
|
+
* @version 190.0.0
|
|
10994
11052
|
*/ /**
|
|
10995
11053
|
* Constructs a new EventsApi.
|
|
10996
11054
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11015,7 +11073,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11015
11073
|
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']);}}]);return EventsApi;}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
11016
11074
|
* ExternalContacts service.
|
|
11017
11075
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11018
|
-
* @version
|
|
11076
|
+
* @version 190.0.0
|
|
11019
11077
|
*/ /**
|
|
11020
11078
|
* Constructs a new ExternalContactsApi.
|
|
11021
11079
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11470,7 +11528,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11470
11528
|
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']);}}]);return ExternalContactsApi;}();var FaxApi=/*#__PURE__*/function(){/**
|
|
11471
11529
|
* Fax service.
|
|
11472
11530
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11473
|
-
* @version
|
|
11531
|
+
* @version 190.0.0
|
|
11474
11532
|
*/ /**
|
|
11475
11533
|
* Constructs a new FaxApi.
|
|
11476
11534
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11511,7 +11569,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
11511
11569
|
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']);}}]);return FaxApi;}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
11512
11570
|
* Flows service.
|
|
11513
11571
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11514
|
-
* @version
|
|
11572
|
+
* @version 190.0.0
|
|
11515
11573
|
*/ /**
|
|
11516
11574
|
* Constructs a new FlowsApi.
|
|
11517
11575
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11560,7 +11618,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11560
11618
|
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']);}}]);return FlowsApi;}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
11561
11619
|
* Gamification service.
|
|
11562
11620
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11563
|
-
* @version
|
|
11621
|
+
* @version 190.0.0
|
|
11564
11622
|
*/ /**
|
|
11565
11623
|
* Constructs a new GamificationApi.
|
|
11566
11624
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12100,7 +12158,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12100
12158
|
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']);}}]);return GamificationApi;}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
12101
12159
|
* GeneralDataProtectionRegulation service.
|
|
12102
12160
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12103
|
-
* @version
|
|
12161
|
+
* @version 190.0.0
|
|
12104
12162
|
*/ /**
|
|
12105
12163
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12106
12164
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12135,7 +12193,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12135
12193
|
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']);}}]);return GeneralDataProtectionRegulationApi;}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
12136
12194
|
* Geolocation service.
|
|
12137
12195
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12138
|
-
* @version
|
|
12196
|
+
* @version 190.0.0
|
|
12139
12197
|
*/ /**
|
|
12140
12198
|
* Constructs a new GeolocationApi.
|
|
12141
12199
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12169,7 +12227,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12169
12227
|
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']);}}]);return GeolocationApi;}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
12170
12228
|
* Greetings service.
|
|
12171
12229
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12172
|
-
* @version
|
|
12230
|
+
* @version 190.0.0
|
|
12173
12231
|
*/ /**
|
|
12174
12232
|
* Constructs a new GreetingsApi.
|
|
12175
12233
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12276,7 +12334,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12276
12334
|
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']);}}]);return GreetingsApi;}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
12277
12335
|
* Groups service.
|
|
12278
12336
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12279
|
-
* @version
|
|
12337
|
+
* @version 190.0.0
|
|
12280
12338
|
*/ /**
|
|
12281
12339
|
* Constructs a new GroupsApi.
|
|
12282
12340
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12409,7 +12467,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12409
12467
|
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']);}}]);return GroupsApi;}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
12410
12468
|
* IdentityProvider service.
|
|
12411
12469
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12412
|
-
* @version
|
|
12470
|
+
* @version 190.0.0
|
|
12413
12471
|
*/ /**
|
|
12414
12472
|
* Constructs a new IdentityProviderApi.
|
|
12415
12473
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12565,7 +12623,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12565
12623
|
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']);}}]);return IdentityProviderApi;}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
12566
12624
|
* InfrastructureAsCode service.
|
|
12567
12625
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12568
|
-
* @version
|
|
12626
|
+
* @version 190.0.0
|
|
12569
12627
|
*/ /**
|
|
12570
12628
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12571
12629
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12619,7 +12677,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12619
12677
|
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']);}}]);return InfrastructureAsCodeApi;}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
12620
12678
|
* Integrations service.
|
|
12621
12679
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12622
|
-
* @version
|
|
12680
|
+
* @version 190.0.0
|
|
12623
12681
|
*/ /**
|
|
12624
12682
|
* Constructs a new IntegrationsApi.
|
|
12625
12683
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13229,7 +13287,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13229
13287
|
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']);}}]);return IntegrationsApi;}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
13230
13288
|
* Journey service.
|
|
13231
13289
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13232
|
-
* @version
|
|
13290
|
+
* @version 190.0.0
|
|
13233
13291
|
*/ /**
|
|
13234
13292
|
* Constructs a new JourneyApi.
|
|
13235
13293
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13444,10 +13502,48 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
13444
13502
|
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
13445
13503
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
13446
13504
|
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','GET',{'viewId':viewId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13505
|
+
* Get the job for a journey view version.
|
|
13506
|
+
* used for long descriptions
|
|
13507
|
+
* @param {String} viewId Journey View Id
|
|
13508
|
+
* @param {String} journeyVersionId Journey View Version
|
|
13509
|
+
* @param {String} jobId JobId
|
|
13510
|
+
* getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13511
|
+
*/},{key:"getJourneyViewVersionJob",value:function getJourneyViewVersionJob(viewId,journeyVersionId,jobId){// verify the required parameter 'viewId' is set
|
|
13512
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';}// verify the required parameter 'journeyVersionId' is set
|
|
13513
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';}// verify the required parameter 'jobId' is set
|
|
13514
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13515
|
+
* Get the result of a job for a journey view version.
|
|
13516
|
+
* used for long descriptions
|
|
13517
|
+
* @param {String} viewId JourneyViewResult id
|
|
13518
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
13519
|
+
* @param {String} jobId Id of the executing job
|
|
13520
|
+
* getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13521
|
+
*/},{key:"getJourneyViewVersionJobResults",value:function getJourneyViewVersionJobResults(viewId,journeyViewVersion,jobId){// verify the required parameter 'viewId' is set
|
|
13522
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'journeyViewVersion' is set
|
|
13523
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'jobId' is set
|
|
13524
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13525
|
+
* Get the latest job of a journey view version.
|
|
13526
|
+
* used for long descriptions
|
|
13527
|
+
* @param {String} viewId Journey View Id
|
|
13528
|
+
* @param {String} journeyVersionId Journey View Version
|
|
13529
|
+
* getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13530
|
+
*/},{key:"getJourneyViewVersionJobsLatest",value:function getJourneyViewVersionJobsLatest(viewId,journeyVersionId){// verify the required parameter 'viewId' is set
|
|
13531
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';}// verify the required parameter 'journeyVersionId' is set
|
|
13532
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13447
13533
|
* Get a list of Journey Views
|
|
13448
13534
|
*
|
|
13449
13535
|
* getJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13450
13536
|
*/},{key:"getJourneyViews",value:function getJourneyViews(){return this.apiClient.callApi('/api/v2/journey/views','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13537
|
+
* Get an Event Definition
|
|
13538
|
+
*
|
|
13539
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
13540
|
+
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13541
|
+
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
13542
|
+
if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}','GET',{'eventDefinitionId':eventDefinitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13543
|
+
* Get a list of Event Definitions
|
|
13544
|
+
*
|
|
13545
|
+
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13546
|
+
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13451
13547
|
* Update single action map.
|
|
13452
13548
|
*
|
|
13453
13549
|
* @param {String} actionMapId ID of the action map.
|
|
@@ -13550,6 +13646,14 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
13550
13646
|
* @param {Object} opts Optional parameters
|
|
13551
13647
|
* @param {Object} opts.body
|
|
13552
13648
|
*/},{key:"postJourneySegments",value:function postJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13649
|
+
* Submit a job request for a journey view version.
|
|
13650
|
+
* used for long descriptions
|
|
13651
|
+
* @param {String} viewId Journey View Id
|
|
13652
|
+
* @param {String} journeyVersionId Journey View Version
|
|
13653
|
+
* postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13654
|
+
*/},{key:"postJourneyViewVersionJobs",value:function postJourneyViewVersionJobs(viewId,journeyVersionId){// verify the required parameter 'viewId' is set
|
|
13655
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';}// verify the required parameter 'journeyVersionId' is set
|
|
13656
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs','POST',{'viewId':viewId,'journeyVersionId':journeyVersionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13553
13657
|
* Update a Journey View by ID
|
|
13554
13658
|
* creates a new version
|
|
13555
13659
|
* @param {String} viewId viewId
|
|
@@ -13563,10 +13667,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13563
13667
|
* @param {Object} body JourneyView
|
|
13564
13668
|
* postJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13565
13669
|
*/},{key:"postJourneyViews",value:function postJourneyViews(body){// verify the required parameter 'body' is set
|
|
13566
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViews';}return this.apiClient.callApi('/api/v2/journey/views','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
13670
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViews';}return this.apiClient.callApi('/api/v2/journey/views','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13671
|
+
* Validate whether an encoding exist for a label/value combination.
|
|
13672
|
+
* True indicates a valid encoding
|
|
13673
|
+
* @param {Object} opts Optional parameters
|
|
13674
|
+
* @param {Array.<Object>} opts.body
|
|
13675
|
+
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13676
|
+
*/},{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']);}}]);return JourneyApi;}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
13567
13677
|
* Knowledge service.
|
|
13568
13678
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13569
|
-
* @version
|
|
13679
|
+
* @version 190.0.0
|
|
13570
13680
|
*/ /**
|
|
13571
13681
|
* Constructs a new KnowledgeApi.
|
|
13572
13682
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14478,7 +14588,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14478
14588
|
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']);}}]);return KnowledgeApi;}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
14479
14589
|
* LanguageUnderstanding service.
|
|
14480
14590
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
14481
|
-
* @version
|
|
14591
|
+
* @version 190.0.0
|
|
14482
14592
|
*/ /**
|
|
14483
14593
|
* Constructs a new LanguageUnderstandingApi.
|
|
14484
14594
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14734,7 +14844,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14734
14844
|
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']);}}]);return LanguageUnderstandingApi;}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
14735
14845
|
* Languages service.
|
|
14736
14846
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
14737
|
-
* @version
|
|
14847
|
+
* @version 190.0.0
|
|
14738
14848
|
*/ /**
|
|
14739
14849
|
* Constructs a new LanguagesApi.
|
|
14740
14850
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -14789,7 +14899,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14789
14899
|
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']);}}]);return LanguagesApi;}();var LearningApi=/*#__PURE__*/function(){/**
|
|
14790
14900
|
* Learning service.
|
|
14791
14901
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
14792
|
-
* @version
|
|
14902
|
+
* @version 190.0.0
|
|
14793
14903
|
*/ /**
|
|
14794
14904
|
* Constructs a new LearningApi.
|
|
14795
14905
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15019,7 +15129,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15019
15129
|
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']);}}]);return LearningApi;}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
15020
15130
|
* License service.
|
|
15021
15131
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15022
|
-
* @version
|
|
15132
|
+
* @version 190.0.0
|
|
15023
15133
|
*/ /**
|
|
15024
15134
|
* Constructs a new LicenseApi.
|
|
15025
15135
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15073,7 +15183,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15073
15183
|
*/},{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']);}}]);return LicenseApi;}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
15074
15184
|
* Locations service.
|
|
15075
15185
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15076
|
-
* @version
|
|
15186
|
+
* @version 190.0.0
|
|
15077
15187
|
*/ /**
|
|
15078
15188
|
* Constructs a new LocationsApi.
|
|
15079
15189
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15132,7 +15242,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15132
15242
|
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']);}}]);return LocationsApi;}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
15133
15243
|
* LogCapture service.
|
|
15134
15244
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15135
|
-
* @version
|
|
15245
|
+
* @version 190.0.0
|
|
15136
15246
|
*/ /**
|
|
15137
15247
|
* Constructs a new LogCaptureApi.
|
|
15138
15248
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15182,7 +15292,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15182
15292
|
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']);}}]);return LogCaptureApi;}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
15183
15293
|
* Messaging service.
|
|
15184
15294
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15185
|
-
* @version
|
|
15295
|
+
* @version 190.0.0
|
|
15186
15296
|
*/ /**
|
|
15187
15297
|
* Constructs a new MessagingApi.
|
|
15188
15298
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -15272,7 +15382,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15272
15382
|
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']);}}]);return MessagingApi;}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
15273
15383
|
* MobileDevices service.
|
|
15274
15384
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
15275
|
-
* @version
|
|
15385
|
+
* @version 190.0.0
|
|
15276
15386
|
*/ /**
|
|
15277
15387
|
* Constructs a new MobileDevicesApi.
|
|
15278
15388
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -15311,7 +15421,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15311
15421
|
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']);}}]);return MobileDevicesApi;}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
15312
15422
|
* Notifications service.
|
|
15313
15423
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
15314
|
-
* @version
|
|
15424
|
+
* @version 190.0.0
|
|
15315
15425
|
*/ /**
|
|
15316
15426
|
* Constructs a new NotificationsApi.
|
|
15317
15427
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -15368,7 +15478,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
15368
15478
|
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']);}}]);return NotificationsApi;}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
15369
15479
|
* OAuth service.
|
|
15370
15480
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
15371
|
-
* @version
|
|
15481
|
+
* @version 190.0.0
|
|
15372
15482
|
*/ /**
|
|
15373
15483
|
* Constructs a new OAuthApi.
|
|
15374
15484
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -15453,7 +15563,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
15453
15563
|
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']);}}]);return OAuthApi;}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
15454
15564
|
* Objects service.
|
|
15455
15565
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
15456
|
-
* @version
|
|
15566
|
+
* @version 190.0.0
|
|
15457
15567
|
*/ /**
|
|
15458
15568
|
* Constructs a new ObjectsApi.
|
|
15459
15569
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -15524,7 +15634,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15524
15634
|
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']);}}]);return ObjectsApi;}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
15525
15635
|
* OperationalEvents service.
|
|
15526
15636
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
15527
|
-
* @version
|
|
15637
|
+
* @version 190.0.0
|
|
15528
15638
|
*/ /**
|
|
15529
15639
|
* Constructs a new OperationalEventsApi.
|
|
15530
15640
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -15542,7 +15652,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
15542
15652
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OperationalEventsApi;}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
15543
15653
|
* Organization service.
|
|
15544
15654
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
15545
|
-
* @version
|
|
15655
|
+
* @version 190.0.0
|
|
15546
15656
|
*/ /**
|
|
15547
15657
|
* Constructs a new OrganizationApi.
|
|
15548
15658
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15581,7 +15691,7 @@ if(requestId===undefined||requestId===null){throw'Missing the required parameter
|
|
|
15581
15691
|
* @param {Number} opts.pageSize Page Size (default to 25)
|
|
15582
15692
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
15583
15693
|
*/},{key:"getOrganizationsLimitsChangerequests",value:function getOrganizationsLimitsChangerequests(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/organizations/limits/changerequests','GET',{},{'after':opts['after'],'before':opts['before'],'status':opts['status'],'pageSize':opts['pageSize'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15584
|
-
* Get
|
|
15694
|
+
* Get limit documentation
|
|
15585
15695
|
*
|
|
15586
15696
|
*/},{key:"getOrganizationsLimitsDocs",value:function getOrganizationsLimitsDocs(){return this.apiClient.callApi('/api/v2/organizations/limits/docs','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15587
15697
|
* Get the effective limits in a namespace for an organization
|
|
@@ -15644,7 +15754,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15644
15754
|
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']);}}]);return OrganizationApi;}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
15645
15755
|
* OrganizationAuthorization service.
|
|
15646
15756
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15647
|
-
* @version
|
|
15757
|
+
* @version 190.0.0
|
|
15648
15758
|
*/ /**
|
|
15649
15759
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15650
15760
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -15967,7 +16077,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
15967
16077
|
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']);}}]);return OrganizationAuthorizationApi;}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
15968
16078
|
* Outbound service.
|
|
15969
16079
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
15970
|
-
* @version
|
|
16080
|
+
* @version 190.0.0
|
|
15971
16081
|
*/ /**
|
|
15972
16082
|
* Constructs a new OutboundApi.
|
|
15973
16083
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -17005,7 +17115,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17005
17115
|
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']);}}]);return OutboundApi;}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
17006
17116
|
* Presence service.
|
|
17007
17117
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17008
|
-
* @version
|
|
17118
|
+
* @version 190.0.0
|
|
17009
17119
|
*/ /**
|
|
17010
17120
|
* Constructs a new PresenceApi.
|
|
17011
17121
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -17178,7 +17288,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17178
17288
|
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']);}}]);return PresenceApi;}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
17179
17289
|
* ProcessAutomation service.
|
|
17180
17290
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
17181
|
-
* @version
|
|
17291
|
+
* @version 190.0.0
|
|
17182
17292
|
*/ /**
|
|
17183
17293
|
* Constructs a new ProcessAutomationApi.
|
|
17184
17294
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -17241,7 +17351,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
17241
17351
|
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']);}}]);return ProcessAutomationApi;}();var QualityApi=/*#__PURE__*/function(){/**
|
|
17242
17352
|
* Quality service.
|
|
17243
17353
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
17244
|
-
* @version
|
|
17354
|
+
* @version 190.0.0
|
|
17245
17355
|
*/ /**
|
|
17246
17356
|
* Constructs a new QualityApi.
|
|
17247
17357
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -17712,7 +17822,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
17712
17822
|
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']);}}]);return QualityApi;}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
17713
17823
|
* Recording service.
|
|
17714
17824
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
17715
|
-
* @version
|
|
17825
|
+
* @version 190.0.0
|
|
17716
17826
|
*/ /**
|
|
17717
17827
|
* Constructs a new RecordingApi.
|
|
17718
17828
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -17956,6 +18066,10 @@ if(retentionThresholdDays===undefined||retentionThresholdDays===null){throw'Miss
|
|
|
17956
18066
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
17957
18067
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17958
18068
|
*/},{key:"getRecordingsScreensessions",value:function getRecordingsScreensessions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/screensessions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18069
|
+
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
18070
|
+
*
|
|
18071
|
+
* getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18072
|
+
*/},{key:"getRecordingsScreensessionsDetails",value:function getRecordingsScreensessionsDetails(){return this.apiClient.callApi('/api/v2/recordings/screensessions/details','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17959
18073
|
* Patch a media retention policy
|
|
17960
18074
|
*
|
|
17961
18075
|
* @param {String} policyId Policy ID
|
|
@@ -18119,7 +18233,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18119
18233
|
*/},{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']);}}]);return RecordingApi;}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
18120
18234
|
* ResponseManagement service.
|
|
18121
18235
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
18122
|
-
* @version
|
|
18236
|
+
* @version 190.0.0
|
|
18123
18237
|
*/ /**
|
|
18124
18238
|
* Constructs a new ResponseManagementApi.
|
|
18125
18239
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -18235,7 +18349,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
18235
18349
|
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']);}}]);return ResponseManagementApi;}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
18236
18350
|
* Routing service.
|
|
18237
18351
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
18238
|
-
* @version
|
|
18352
|
+
* @version 190.0.0
|
|
18239
18353
|
*/ /**
|
|
18240
18354
|
* Constructs a new RoutingApi.
|
|
18241
18355
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -18589,12 +18703,13 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
18589
18703
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18590
18704
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18591
18705
|
* @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
|
|
18592
|
-
* @param {String} opts.name
|
|
18593
|
-
* @param {Array.<String>} opts.id
|
|
18594
|
-
* @param {Array.<String>} opts.divisionId
|
|
18595
|
-
* @param {Array.<String>} opts.peerId
|
|
18596
|
-
* @param {
|
|
18597
|
-
|
|
18706
|
+
* @param {String} opts.name Include only queues with the given name (leading and trailing asterisks allowed)
|
|
18707
|
+
* @param {Array.<String>} opts.id Include only queues with the specified ID(s)
|
|
18708
|
+
* @param {Array.<String>} opts.divisionId Include only queues in the specified division ID(s)
|
|
18709
|
+
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
18710
|
+
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
18711
|
+
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
18712
|
+
*/},{key:"getRoutingQueues",value:function getRoutingQueues(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/queues','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'name':opts['name'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'peerId':this.apiClient.buildCollectionParam(opts['peerId'],'multi'),'cannedResponseLibraryId':opts['cannedResponseLibraryId'],'hasPeer':opts['hasPeer']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18598
18713
|
* Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
|
|
18599
18714
|
*
|
|
18600
18715
|
* @param {Object} opts Optional parameters
|
|
@@ -19203,7 +19318,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19203
19318
|
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']);}}]);return RoutingApi;}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
19204
19319
|
* SCIM service.
|
|
19205
19320
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
19206
|
-
* @version
|
|
19321
|
+
* @version 190.0.0
|
|
19207
19322
|
*/ /**
|
|
19208
19323
|
* Constructs a new SCIMApi.
|
|
19209
19324
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -19428,7 +19543,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19428
19543
|
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']);}}]);return SCIMApi;}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
19429
19544
|
* ScreenRecording service.
|
|
19430
19545
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
19431
|
-
* @version
|
|
19546
|
+
* @version 190.0.0
|
|
19432
19547
|
*/ /**
|
|
19433
19548
|
* Constructs a new ScreenRecordingApi.
|
|
19434
19549
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -19443,7 +19558,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19443
19558
|
*/_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']);}}]);return ScreenRecordingApi;}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
19444
19559
|
* Scripts service.
|
|
19445
19560
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
19446
|
-
* @version
|
|
19561
|
+
* @version 190.0.0
|
|
19447
19562
|
*/ /**
|
|
19448
19563
|
* Constructs a new ScriptsApi.
|
|
19449
19564
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -19579,7 +19694,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
19579
19694
|
*/},{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']);}}]);return ScriptsApi;}();var SearchApi=/*#__PURE__*/function(){/**
|
|
19580
19695
|
* Search service.
|
|
19581
19696
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
19582
|
-
* @version
|
|
19697
|
+
* @version 190.0.0
|
|
19583
19698
|
*/ /**
|
|
19584
19699
|
* Constructs a new SearchApi.
|
|
19585
19700
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -19739,7 +19854,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19739
19854
|
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']);}}]);return SearchApi;}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
19740
19855
|
* Settings service.
|
|
19741
19856
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
19742
|
-
* @version
|
|
19857
|
+
* @version 190.0.0
|
|
19743
19858
|
*/ /**
|
|
19744
19859
|
* Constructs a new SettingsApi.
|
|
19745
19860
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -19767,7 +19882,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19767
19882
|
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']);}}]);return SettingsApi;}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
19768
19883
|
* SpeechTextAnalytics service.
|
|
19769
19884
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
19770
|
-
* @version
|
|
19885
|
+
* @version 190.0.0
|
|
19771
19886
|
*/ /**
|
|
19772
19887
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
19773
19888
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20011,7 +20126,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20011
20126
|
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']);}}]);return SpeechTextAnalyticsApi;}();var StationsApi=/*#__PURE__*/function(){/**
|
|
20012
20127
|
* Stations service.
|
|
20013
20128
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
20014
|
-
* @version
|
|
20129
|
+
* @version 190.0.0
|
|
20015
20130
|
*/ /**
|
|
20016
20131
|
* Constructs a new StationsApi.
|
|
20017
20132
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -20043,7 +20158,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
20043
20158
|
*/},{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']);}}]);return StationsApi;}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
20044
20159
|
* Suggest service.
|
|
20045
20160
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
20046
|
-
* @version
|
|
20161
|
+
* @version 190.0.0
|
|
20047
20162
|
*/ /**
|
|
20048
20163
|
* Constructs a new SuggestApi.
|
|
20049
20164
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -20083,7 +20198,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20083
20198
|
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']);}}]);return SuggestApi;}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
20084
20199
|
* TaskManagement service.
|
|
20085
20200
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
20086
|
-
* @version
|
|
20201
|
+
* @version 190.0.0
|
|
20087
20202
|
*/ /**
|
|
20088
20203
|
* Constructs a new TaskManagementApi.
|
|
20089
20204
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -20431,7 +20546,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
20431
20546
|
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']);}}]);return TaskManagementApi;}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
20432
20547
|
* Teams service.
|
|
20433
20548
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
20434
|
-
* @version
|
|
20549
|
+
* @version 190.0.0
|
|
20435
20550
|
*/ /**
|
|
20436
20551
|
* Constructs a new TeamsApi.
|
|
20437
20552
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -20510,7 +20625,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20510
20625
|
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']);}}]);return TeamsApi;}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
20511
20626
|
* Telephony service.
|
|
20512
20627
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
20513
|
-
* @version
|
|
20628
|
+
* @version 190.0.0
|
|
20514
20629
|
*/ /**
|
|
20515
20630
|
* Constructs a new TelephonyApi.
|
|
20516
20631
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -20557,7 +20672,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
20557
20672
|
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']);}}]);return TelephonyApi;}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
20558
20673
|
* TelephonyProvidersEdge service.
|
|
20559
20674
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
20560
|
-
* @version
|
|
20675
|
+
* @version 190.0.0
|
|
20561
20676
|
*/ /**
|
|
20562
20677
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
20563
20678
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -21371,7 +21486,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
21371
21486
|
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']);}}]);return TelephonyProvidersEdgeApi;}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
21372
21487
|
* Textbots service.
|
|
21373
21488
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
21374
|
-
* @version
|
|
21489
|
+
* @version 190.0.0
|
|
21375
21490
|
*/ /**
|
|
21376
21491
|
* Constructs a new TextbotsApi.
|
|
21377
21492
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -21406,7 +21521,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
21406
21521
|
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']);}}]);return TextbotsApi;}();var TokensApi=/*#__PURE__*/function(){/**
|
|
21407
21522
|
* Tokens service.
|
|
21408
21523
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
21409
|
-
* @version
|
|
21524
|
+
* @version 190.0.0
|
|
21410
21525
|
*/ /**
|
|
21411
21526
|
* Constructs a new TokensApi.
|
|
21412
21527
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -21440,7 +21555,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21440
21555
|
*/},{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']);}}]);return TokensApi;}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
21441
21556
|
* Uploads service.
|
|
21442
21557
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
21443
|
-
* @version
|
|
21558
|
+
* @version 190.0.0
|
|
21444
21559
|
*/ /**
|
|
21445
21560
|
* Constructs a new UploadsApi.
|
|
21446
21561
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -21506,7 +21621,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21506
21621
|
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']);}}]);return UploadsApi;}();var UsageApi=/*#__PURE__*/function(){/**
|
|
21507
21622
|
* Usage service.
|
|
21508
21623
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
21509
|
-
* @version
|
|
21624
|
+
* @version 190.0.0
|
|
21510
21625
|
*/ /**
|
|
21511
21626
|
* Constructs a new UsageApi.
|
|
21512
21627
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -21557,7 +21672,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21557
21672
|
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']);}}]);return UsageApi;}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
21558
21673
|
* UserRecordings service.
|
|
21559
21674
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
21560
|
-
* @version
|
|
21675
|
+
* @version 190.0.0
|
|
21561
21676
|
*/ /**
|
|
21562
21677
|
* Constructs a new UserRecordingsApi.
|
|
21563
21678
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -21606,7 +21721,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
21606
21721
|
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']);}}]);return UserRecordingsApi;}();var UsersApi=/*#__PURE__*/function(){/**
|
|
21607
21722
|
* Users service.
|
|
21608
21723
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
21609
|
-
* @version
|
|
21724
|
+
* @version 190.0.0
|
|
21610
21725
|
*/ /**
|
|
21611
21726
|
* Constructs a new UsersApi.
|
|
21612
21727
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -22265,7 +22380,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
22265
22380
|
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']);}}]);return UsersApi;}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
22266
22381
|
* Utilities service.
|
|
22267
22382
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
22268
|
-
* @version
|
|
22383
|
+
* @version 190.0.0
|
|
22269
22384
|
*/ /**
|
|
22270
22385
|
* Constructs a new UtilitiesApi.
|
|
22271
22386
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -22292,7 +22407,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22292
22407
|
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']);}}]);return UtilitiesApi;}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
22293
22408
|
* Voicemail service.
|
|
22294
22409
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
22295
|
-
* @version
|
|
22410
|
+
* @version 190.0.0
|
|
22296
22411
|
*/ /**
|
|
22297
22412
|
* Constructs a new VoicemailApi.
|
|
22298
22413
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -22441,7 +22556,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22441
22556
|
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']);}}]);return VoicemailApi;}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
22442
22557
|
* WebChat service.
|
|
22443
22558
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
22444
|
-
* @version
|
|
22559
|
+
* @version 190.0.0
|
|
22445
22560
|
*/ /**
|
|
22446
22561
|
* Constructs a new WebChatApi.
|
|
22447
22562
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -22574,7 +22689,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22574
22689
|
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']);}}]);return WebChatApi;}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
22575
22690
|
* WebDeployments service.
|
|
22576
22691
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
22577
|
-
* @version
|
|
22692
|
+
* @version 190.0.0
|
|
22578
22693
|
*/ /**
|
|
22579
22694
|
* Constructs a new WebDeploymentsApi.
|
|
22580
22695
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -22695,7 +22810,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22695
22810
|
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']);}}]);return WebDeploymentsApi;}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
22696
22811
|
* WebMessaging service.
|
|
22697
22812
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
22698
|
-
* @version
|
|
22813
|
+
* @version 190.0.0
|
|
22699
22814
|
*/ /**
|
|
22700
22815
|
* Constructs a new WebMessagingApi.
|
|
22701
22816
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -22711,7 +22826,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
22711
22826
|
*/_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']);}}]);return WebMessagingApi;}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
22712
22827
|
* Widgets service.
|
|
22713
22828
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
22714
|
-
* @version
|
|
22829
|
+
* @version 190.0.0
|
|
22715
22830
|
*/ /**
|
|
22716
22831
|
* Constructs a new WidgetsApi.
|
|
22717
22832
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -22746,7 +22861,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22746
22861
|
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']);}}]);return WidgetsApi;}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
22747
22862
|
* WorkforceManagement service.
|
|
22748
22863
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
22749
|
-
* @version
|
|
22864
|
+
* @version 190.0.0
|
|
22750
22865
|
*/ /**
|
|
22751
22866
|
* Constructs a new WorkforceManagementApi.
|
|
22752
22867
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -22787,6 +22902,27 @@ if(runId===undefined||runId===null){throw'Missing the required parameter "runId"
|
|
|
22787
22902
|
*/},{key:"deleteWorkforcemanagementBusinessunitServicegoaltemplate",value:function deleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId,serviceGoalTemplateId){// verify the required parameter 'businessUnitId' is set
|
|
22788
22903
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';}// verify the required parameter 'serviceGoalTemplateId' is set
|
|
22789
22904
|
if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missing the required parameter "serviceGoalTemplateId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}','DELETE',{'businessUnitId':businessUnitId,'serviceGoalTemplateId':serviceGoalTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22905
|
+
* Deletes a staffing group
|
|
22906
|
+
*
|
|
22907
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
22908
|
+
* @param {String} staffingGroupId The ID of the staffing group to delete
|
|
22909
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitStaffinggroup",value:function deleteWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId){// verify the required parameter 'businessUnitId' is set
|
|
22910
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
22911
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','DELETE',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22912
|
+
* Deletes a time-off limit object
|
|
22913
|
+
*
|
|
22914
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
22915
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to delete
|
|
22916
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitTimeofflimit",value:function deleteWorkforcemanagementBusinessunitTimeofflimit(businessUnitId,timeOffLimitId){// verify the required parameter 'businessUnitId' is set
|
|
22917
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';}// verify the required parameter 'timeOffLimitId' is set
|
|
22918
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}','DELETE',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22919
|
+
* Deletes a time-off plan
|
|
22920
|
+
*
|
|
22921
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
22922
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to delete
|
|
22923
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitTimeoffplan",value:function deleteWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId){// verify the required parameter 'businessUnitId' is set
|
|
22924
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
22925
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','DELETE',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22790
22926
|
* Delete a schedule
|
|
22791
22927
|
*
|
|
22792
22928
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -22974,6 +23110,49 @@ if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missin
|
|
|
22974
23110
|
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
22975
23111
|
*/},{key:"getWorkforcemanagementBusinessunitServicegoaltemplates",value:function getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
22976
23112
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates','GET',{'businessUnitId':businessUnitId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23113
|
+
* Gets a staffing group
|
|
23114
|
+
*
|
|
23115
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23116
|
+
* @param {String} staffingGroupId The ID of the staffing group to fetch
|
|
23117
|
+
*/},{key:"getWorkforcemanagementBusinessunitStaffinggroup",value:function getWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId){// verify the required parameter 'businessUnitId' is set
|
|
23118
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
23119
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','GET',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23120
|
+
* Gets a list of staffing groups
|
|
23121
|
+
*
|
|
23122
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23123
|
+
* @param {Object} opts Optional parameters
|
|
23124
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
23125
|
+
*/},{key:"getWorkforcemanagementBusinessunitStaffinggroups",value:function getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23126
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23127
|
+
* Gets a time-off limit object
|
|
23128
|
+
* Returns properties of time-off limit object, but not daily values
|
|
23129
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23130
|
+
* @param {String} timeOffLimitId The ID of the time-off limit to fetch
|
|
23131
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeofflimit",value:function getWorkforcemanagementBusinessunitTimeofflimit(businessUnitId,timeOffLimitId){// verify the required parameter 'businessUnitId' is set
|
|
23132
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';}// verify the required parameter 'timeOffLimitId' is set
|
|
23133
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}','GET',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23134
|
+
* Gets a list of time-off limit objects
|
|
23135
|
+
*
|
|
23136
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23137
|
+
* @param {Object} opts Optional parameters
|
|
23138
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific time-off limit objects
|
|
23139
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeofflimits",value:function getWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23140
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23141
|
+
* Gets a time-off plan
|
|
23142
|
+
*
|
|
23143
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23144
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to fetch
|
|
23145
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeoffplan",value:function getWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId){// verify the required parameter 'businessUnitId' is set
|
|
23146
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
23147
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','GET',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23148
|
+
* Gets a list of time-off plans
|
|
23149
|
+
*
|
|
23150
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23151
|
+
* @param {Object} opts Optional parameters
|
|
23152
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
23153
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
23154
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeoffplans",value:function getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23155
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId'],'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22977
23156
|
* Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
|
|
22978
23157
|
*
|
|
22979
23158
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -23418,6 +23597,24 @@ if(runId===undefined||runId===null){throw'Missing the required parameter "runId"
|
|
|
23418
23597
|
*/},{key:"patchWorkforcemanagementBusinessunitServicegoaltemplate",value:function patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId,serviceGoalTemplateId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23419
23598
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';}// verify the required parameter 'serviceGoalTemplateId' is set
|
|
23420
23599
|
if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missing the required parameter "serviceGoalTemplateId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}','PATCH',{'businessUnitId':businessUnitId,'serviceGoalTemplateId':serviceGoalTemplateId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23600
|
+
* Updates a staffing group
|
|
23601
|
+
*
|
|
23602
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23603
|
+
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
23604
|
+
* @param {Object} opts Optional parameters
|
|
23605
|
+
* @param {Object} opts.body body
|
|
23606
|
+
*/},{key:"patchWorkforcemanagementBusinessunitStaffinggroup",value:function patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23607
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
23608
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','PATCH',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23609
|
+
* Updates a time-off plan
|
|
23610
|
+
*
|
|
23611
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23612
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
23613
|
+
* @param {Object} opts Optional parameters
|
|
23614
|
+
* @param {Object} opts.body body
|
|
23615
|
+
*/},{key:"patchWorkforcemanagementBusinessunitTimeoffplan",value:function patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23616
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
23617
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','PATCH',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23421
23618
|
* Update the requested management unit
|
|
23422
23619
|
*
|
|
23423
23620
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -23618,6 +23815,41 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
23618
23815
|
* @param {Object} opts.body body
|
|
23619
23816
|
*/},{key:"postWorkforcemanagementBusinessunitServicegoaltemplates",value:function postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23620
23817
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23818
|
+
* Creates a new staffing group
|
|
23819
|
+
*
|
|
23820
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23821
|
+
* @param {Object} opts Optional parameters
|
|
23822
|
+
* @param {Object} opts.body body
|
|
23823
|
+
*/},{key:"postWorkforcemanagementBusinessunitStaffinggroups",value:function postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23824
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23825
|
+
* Gets staffing group associations for a list of user IDs
|
|
23826
|
+
*
|
|
23827
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23828
|
+
* @param {Object} opts Optional parameters
|
|
23829
|
+
* @param {Object} opts.body body
|
|
23830
|
+
*/},{key:"postWorkforcemanagementBusinessunitStaffinggroupsQuery",value:function postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23831
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23832
|
+
* Creates a new time-off limit object
|
|
23833
|
+
*
|
|
23834
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23835
|
+
* @param {Object} opts Optional parameters
|
|
23836
|
+
* @param {Object} opts.body body
|
|
23837
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeofflimits",value:function postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23838
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23839
|
+
* Retrieves time-off limit related values based on a given set of filters.
|
|
23840
|
+
*
|
|
23841
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23842
|
+
* @param {Object} opts Optional parameters
|
|
23843
|
+
* @param {Object} opts.body body
|
|
23844
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery",value:function postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23845
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23846
|
+
* Creates a new time-off plan
|
|
23847
|
+
*
|
|
23848
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23849
|
+
* @param {Object} opts Optional parameters
|
|
23850
|
+
* @param {Object} opts.body body
|
|
23851
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeoffplans",value:function postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23852
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23621
23853
|
* Loads agent schedule data from the schedule. Used in combination with the metadata route
|
|
23622
23854
|
*
|
|
23623
23855
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -24061,6 +24293,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24061
24293
|
*/},{key:"putWorkforcemanagementAgentIntegrationsHris",value:function putWorkforcemanagementAgentIntegrationsHris(agentId,body){// verify the required parameter 'agentId' is set
|
|
24062
24294
|
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';}// verify the required parameter 'body' is set
|
|
24063
24295
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/{agentId}/integrations/hris','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
24296
|
+
* Sets daily values for a date range of time-off limit object
|
|
24297
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
24298
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
24299
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
24300
|
+
* @param {Object} opts Optional parameters
|
|
24301
|
+
* @param {Object} opts.body body
|
|
24302
|
+
*/},{key:"putWorkforcemanagementBusinessunitTimeofflimitValues",value:function putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId,timeOffLimitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
24303
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';}// verify the required parameter 'timeOffLimitId' is set
|
|
24304
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values','PUT',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
24064
24305
|
* Sets daily values for a date range of time off limit object
|
|
24065
24306
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
24066
24307
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -24098,7 +24339,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
24098
24339
|
* </pre>
|
|
24099
24340
|
* </p>
|
|
24100
24341
|
* @module purecloud-platform-client-v2/index
|
|
24101
|
-
* @version
|
|
24342
|
+
* @version 190.0.0
|
|
24102
24343
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
24103
24344
|
* The ApiClient constructor.
|
|
24104
24345
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|