purecloud-platform-client-v2 122.0.0 → 126.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 +6 -2
- package/dist/node/purecloud-platform-client-v2.js +1005 -142
- package/dist/web-amd/purecloud-platform-client-v2.js +1005 -142
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +965 -146
- package/dist/web-cjs/purecloud-platform-client-v2.js +978 -1309
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1546 -243
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -26
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +8 -4
- 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/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +3 -3
- 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/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/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +216 -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/QualityApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +22 -11
- package/src/purecloud-platform-client-v2/api/SCIMApi.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/SpeechTextAnalyticsApi.js +96 -2
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +31 -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 +51 -0
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +473 -1
- package/src/purecloud-platform-client-v2/configuration.js +42 -35
- package/src/purecloud-platform-client-v2/index.js +7 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2171,26 +2171,7 @@ class Configuration {
|
|
|
2171
2171
|
|
|
2172
2172
|
liveLoadConfig() {
|
|
2173
2173
|
// If in browser, don't read config file, use default values
|
|
2174
|
-
|
|
2175
|
-
this.configPath = '';
|
|
2176
|
-
return;
|
|
2177
|
-
}
|
|
2178
|
-
|
|
2179
|
-
this.updateConfigFromFile();
|
|
2180
|
-
|
|
2181
|
-
if (this.live_reload_config && this.live_reload_config === true) {
|
|
2182
|
-
try {
|
|
2183
|
-
const fs = require('fs');
|
|
2184
|
-
fs.watchFile(this.configPath, { persistent: false }, (eventType, filename) => {
|
|
2185
|
-
this.updateConfigFromFile();
|
|
2186
|
-
if (!this.live_reload_config) {
|
|
2187
|
-
fs.unwatchFile(this.configPath);
|
|
2188
|
-
}
|
|
2189
|
-
});
|
|
2190
|
-
} catch (err) {
|
|
2191
|
-
// do nothing
|
|
2192
|
-
}
|
|
2193
|
-
}
|
|
2174
|
+
this.configPath = '';
|
|
2194
2175
|
}
|
|
2195
2176
|
|
|
2196
2177
|
setConfigPath(path) {
|
|
@@ -2201,24 +2182,6 @@ class Configuration {
|
|
|
2201
2182
|
}
|
|
2202
2183
|
|
|
2203
2184
|
updateConfigFromFile() {
|
|
2204
|
-
const ConfigParser = require('configparser');
|
|
2205
|
-
var configparser = new ConfigParser();
|
|
2206
|
-
|
|
2207
|
-
try {
|
|
2208
|
-
configparser.read(this.configPath); // If no error catched, indicates it's INI format
|
|
2209
|
-
this.config = configparser;
|
|
2210
|
-
} catch (error) {
|
|
2211
|
-
if (error.name && error.name === 'MissingSectionHeaderError') {
|
|
2212
|
-
// Not INI format, see if it's JSON format
|
|
2213
|
-
const fs = require('fs');
|
|
2214
|
-
var configData = fs.readFileSync(this.configPath, 'utf8');
|
|
2215
|
-
this.config = {
|
|
2216
|
-
_sections: JSON.parse(configData), // To match INI data format
|
|
2217
|
-
};
|
|
2218
|
-
}
|
|
2219
|
-
}
|
|
2220
|
-
|
|
2221
|
-
if (this.config) this.updateConfigValues();
|
|
2222
2185
|
}
|
|
2223
2186
|
|
|
2224
2187
|
updateConfigValues() {
|
|
@@ -2300,7 +2263,7 @@ class Configuration {
|
|
|
2300
2263
|
|
|
2301
2264
|
/**
|
|
2302
2265
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2303
|
-
* @version
|
|
2266
|
+
* @version 126.0.0
|
|
2304
2267
|
*/
|
|
2305
2268
|
class ApiClient {
|
|
2306
2269
|
/**
|
|
@@ -3240,7 +3203,7 @@ class ApiClient {
|
|
|
3240
3203
|
|
|
3241
3204
|
// set header parameters
|
|
3242
3205
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
3243
|
-
//request.set({ 'purecloud-sdk': '
|
|
3206
|
+
//request.set({ 'purecloud-sdk': '126.0.0' });
|
|
3244
3207
|
|
|
3245
3208
|
// set request timeout
|
|
3246
3209
|
request.timeout(that.timeout);
|
|
@@ -3340,7 +3303,7 @@ class AlertingApi {
|
|
|
3340
3303
|
/**
|
|
3341
3304
|
* Alerting service.
|
|
3342
3305
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3343
|
-
* @version
|
|
3306
|
+
* @version 126.0.0
|
|
3344
3307
|
*/
|
|
3345
3308
|
|
|
3346
3309
|
/**
|
|
@@ -3654,7 +3617,7 @@ class AnalyticsApi {
|
|
|
3654
3617
|
/**
|
|
3655
3618
|
* Analytics service.
|
|
3656
3619
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3657
|
-
* @version
|
|
3620
|
+
* @version 126.0.0
|
|
3658
3621
|
*/
|
|
3659
3622
|
|
|
3660
3623
|
/**
|
|
@@ -4250,31 +4213,6 @@ class AnalyticsApi {
|
|
|
4250
4213
|
);
|
|
4251
4214
|
}
|
|
4252
4215
|
|
|
4253
|
-
/**
|
|
4254
|
-
* Patch AnalyticsReportingSettings values for an organization
|
|
4255
|
-
*
|
|
4256
|
-
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
4257
|
-
*/
|
|
4258
|
-
patchAnalyticsReportingSettings(body) {
|
|
4259
|
-
// verify the required parameter 'body' is set
|
|
4260
|
-
if (body === undefined || body === null) {
|
|
4261
|
-
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
4262
|
-
}
|
|
4263
|
-
|
|
4264
|
-
return this.apiClient.callApi(
|
|
4265
|
-
'/api/v2/analytics/reporting/settings',
|
|
4266
|
-
'PATCH',
|
|
4267
|
-
{ },
|
|
4268
|
-
{ },
|
|
4269
|
-
{ },
|
|
4270
|
-
{ },
|
|
4271
|
-
body,
|
|
4272
|
-
['PureCloud OAuth'],
|
|
4273
|
-
['application/json'],
|
|
4274
|
-
['application/json']
|
|
4275
|
-
);
|
|
4276
|
-
}
|
|
4277
|
-
|
|
4278
4216
|
/**
|
|
4279
4217
|
* Query for bot aggregates
|
|
4280
4218
|
*
|
|
@@ -4816,7 +4754,7 @@ class ArchitectApi {
|
|
|
4816
4754
|
/**
|
|
4817
4755
|
* Architect service.
|
|
4818
4756
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4819
|
-
* @version
|
|
4757
|
+
* @version 126.0.0
|
|
4820
4758
|
*/
|
|
4821
4759
|
|
|
4822
4760
|
/**
|
|
@@ -7684,17 +7622,21 @@ class ArchitectApi {
|
|
|
7684
7622
|
* Updates a specific datatable by id
|
|
7685
7623
|
* Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
|
|
7686
7624
|
* @param {String} datatableId id of datatable
|
|
7625
|
+
* @param {Object} body datatable json-schema
|
|
7687
7626
|
* @param {Object} opts Optional parameters
|
|
7688
7627
|
* @param {Object} opts.expand Expand instructions for the result
|
|
7689
|
-
* @param {Object} opts.body datatable json-schema
|
|
7690
7628
|
*/
|
|
7691
|
-
putFlowsDatatable(datatableId, opts) {
|
|
7629
|
+
putFlowsDatatable(datatableId, body, opts) {
|
|
7692
7630
|
opts = opts || {};
|
|
7693
7631
|
|
|
7694
7632
|
// verify the required parameter 'datatableId' is set
|
|
7695
7633
|
if (datatableId === undefined || datatableId === null) {
|
|
7696
7634
|
throw 'Missing the required parameter "datatableId" when calling putFlowsDatatable';
|
|
7697
7635
|
}
|
|
7636
|
+
// verify the required parameter 'body' is set
|
|
7637
|
+
if (body === undefined || body === null) {
|
|
7638
|
+
throw 'Missing the required parameter "body" when calling putFlowsDatatable';
|
|
7639
|
+
}
|
|
7698
7640
|
|
|
7699
7641
|
return this.apiClient.callApi(
|
|
7700
7642
|
'/api/v2/flows/datatables/{datatableId}',
|
|
@@ -7703,7 +7645,7 @@ class ArchitectApi {
|
|
|
7703
7645
|
{ 'expand': opts['expand'] },
|
|
7704
7646
|
{ },
|
|
7705
7647
|
{ },
|
|
7706
|
-
|
|
7648
|
+
body,
|
|
7707
7649
|
['PureCloud OAuth'],
|
|
7708
7650
|
['application/json'],
|
|
7709
7651
|
['application/json']
|
|
@@ -7808,7 +7750,7 @@ class AuditApi {
|
|
|
7808
7750
|
/**
|
|
7809
7751
|
* Audit service.
|
|
7810
7752
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7811
|
-
* @version
|
|
7753
|
+
* @version 126.0.0
|
|
7812
7754
|
*/
|
|
7813
7755
|
|
|
7814
7756
|
/**
|
|
@@ -7979,7 +7921,7 @@ class AuthorizationApi {
|
|
|
7979
7921
|
/**
|
|
7980
7922
|
* Authorization service.
|
|
7981
7923
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7982
|
-
* @version
|
|
7924
|
+
* @version 126.0.0
|
|
7983
7925
|
*/
|
|
7984
7926
|
|
|
7985
7927
|
/**
|
|
@@ -9162,7 +9104,7 @@ class BillingApi {
|
|
|
9162
9104
|
/**
|
|
9163
9105
|
* Billing service.
|
|
9164
9106
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9165
|
-
* @version
|
|
9107
|
+
* @version 126.0.0
|
|
9166
9108
|
*/
|
|
9167
9109
|
|
|
9168
9110
|
/**
|
|
@@ -9242,7 +9184,7 @@ class ChatApi {
|
|
|
9242
9184
|
/**
|
|
9243
9185
|
* Chat service.
|
|
9244
9186
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9245
|
-
* @version
|
|
9187
|
+
* @version 126.0.0
|
|
9246
9188
|
*/
|
|
9247
9189
|
|
|
9248
9190
|
/**
|
|
@@ -9333,7 +9275,7 @@ class CoachingApi {
|
|
|
9333
9275
|
/**
|
|
9334
9276
|
* Coaching service.
|
|
9335
9277
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9336
|
-
* @version
|
|
9278
|
+
* @version 126.0.0
|
|
9337
9279
|
*/
|
|
9338
9280
|
|
|
9339
9281
|
/**
|
|
@@ -9908,7 +9850,7 @@ class ContentManagementApi {
|
|
|
9908
9850
|
/**
|
|
9909
9851
|
* ContentManagement service.
|
|
9910
9852
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9911
|
-
* @version
|
|
9853
|
+
* @version 126.0.0
|
|
9912
9854
|
*/
|
|
9913
9855
|
|
|
9914
9856
|
/**
|
|
@@ -11048,7 +10990,7 @@ class ConversationsApi {
|
|
|
11048
10990
|
/**
|
|
11049
10991
|
* Conversations service.
|
|
11050
10992
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11051
|
-
* @version
|
|
10993
|
+
* @version 126.0.0
|
|
11052
10994
|
*/
|
|
11053
10995
|
|
|
11054
10996
|
/**
|
|
@@ -14117,7 +14059,7 @@ class ConversationsApi {
|
|
|
14117
14059
|
}
|
|
14118
14060
|
|
|
14119
14061
|
/**
|
|
14120
|
-
* Attempts to manually assign a specified conversation to a specified
|
|
14062
|
+
* Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
|
|
14121
14063
|
*
|
|
14122
14064
|
* @param {String} conversationId conversation ID
|
|
14123
14065
|
* @param {Object} body Targeted user
|
|
@@ -15437,7 +15379,7 @@ class DataExtensionsApi {
|
|
|
15437
15379
|
/**
|
|
15438
15380
|
* DataExtensions service.
|
|
15439
15381
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15440
|
-
* @version
|
|
15382
|
+
* @version 126.0.0
|
|
15441
15383
|
*/
|
|
15442
15384
|
|
|
15443
15385
|
/**
|
|
@@ -15523,7 +15465,7 @@ class ExternalContactsApi {
|
|
|
15523
15465
|
/**
|
|
15524
15466
|
* ExternalContacts service.
|
|
15525
15467
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15526
|
-
* @version
|
|
15468
|
+
* @version 126.0.0
|
|
15527
15469
|
*/
|
|
15528
15470
|
|
|
15529
15471
|
/**
|
|
@@ -17266,7 +17208,7 @@ class FaxApi {
|
|
|
17266
17208
|
/**
|
|
17267
17209
|
* Fax service.
|
|
17268
17210
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17269
|
-
* @version
|
|
17211
|
+
* @version 126.0.0
|
|
17270
17212
|
*/
|
|
17271
17213
|
|
|
17272
17214
|
/**
|
|
@@ -17437,7 +17379,7 @@ class FlowsApi {
|
|
|
17437
17379
|
/**
|
|
17438
17380
|
* Flows service.
|
|
17439
17381
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17440
|
-
* @version
|
|
17382
|
+
* @version 126.0.0
|
|
17441
17383
|
*/
|
|
17442
17384
|
|
|
17443
17385
|
/**
|
|
@@ -17508,7 +17450,7 @@ class GamificationApi {
|
|
|
17508
17450
|
/**
|
|
17509
17451
|
* Gamification service.
|
|
17510
17452
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17511
|
-
* @version
|
|
17453
|
+
* @version 126.0.0
|
|
17512
17454
|
*/
|
|
17513
17455
|
|
|
17514
17456
|
/**
|
|
@@ -18814,7 +18756,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18814
18756
|
/**
|
|
18815
18757
|
* GeneralDataProtectionRegulation service.
|
|
18816
18758
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18817
|
-
* @version
|
|
18759
|
+
* @version 126.0.0
|
|
18818
18760
|
*/
|
|
18819
18761
|
|
|
18820
18762
|
/**
|
|
@@ -18944,7 +18886,7 @@ class GeolocationApi {
|
|
|
18944
18886
|
/**
|
|
18945
18887
|
* Geolocation service.
|
|
18946
18888
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18947
|
-
* @version
|
|
18889
|
+
* @version 126.0.0
|
|
18948
18890
|
*/
|
|
18949
18891
|
|
|
18950
18892
|
/**
|
|
@@ -19075,7 +19017,7 @@ class GreetingsApi {
|
|
|
19075
19017
|
/**
|
|
19076
19018
|
* Greetings service.
|
|
19077
19019
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19078
|
-
* @version
|
|
19020
|
+
* @version 126.0.0
|
|
19079
19021
|
*/
|
|
19080
19022
|
|
|
19081
19023
|
/**
|
|
@@ -19530,7 +19472,7 @@ class GroupsApi {
|
|
|
19530
19472
|
/**
|
|
19531
19473
|
* Groups service.
|
|
19532
19474
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19533
|
-
* @version
|
|
19475
|
+
* @version 126.0.0
|
|
19534
19476
|
*/
|
|
19535
19477
|
|
|
19536
19478
|
/**
|
|
@@ -19935,7 +19877,7 @@ class IdentityProviderApi {
|
|
|
19935
19877
|
/**
|
|
19936
19878
|
* IdentityProvider service.
|
|
19937
19879
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19938
|
-
* @version
|
|
19880
|
+
* @version 126.0.0
|
|
19939
19881
|
*/
|
|
19940
19882
|
|
|
19941
19883
|
/**
|
|
@@ -20691,7 +20633,7 @@ class IntegrationsApi {
|
|
|
20691
20633
|
/**
|
|
20692
20634
|
* Integrations service.
|
|
20693
20635
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20694
|
-
* @version
|
|
20636
|
+
* @version 126.0.0
|
|
20695
20637
|
*/
|
|
20696
20638
|
|
|
20697
20639
|
/**
|
|
@@ -22337,7 +22279,7 @@ class JourneyApi {
|
|
|
22337
22279
|
/**
|
|
22338
22280
|
* Journey service.
|
|
22339
22281
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22340
|
-
* @version
|
|
22282
|
+
* @version 126.0.0
|
|
22341
22283
|
*/
|
|
22342
22284
|
|
|
22343
22285
|
/**
|
|
@@ -23048,7 +22990,7 @@ class KnowledgeApi {
|
|
|
23048
22990
|
/**
|
|
23049
22991
|
* Knowledge service.
|
|
23050
22992
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23051
|
-
* @version
|
|
22993
|
+
* @version 126.0.0
|
|
23052
22994
|
*/
|
|
23053
22995
|
|
|
23054
22996
|
/**
|
|
@@ -23338,6 +23280,8 @@ class KnowledgeApi {
|
|
|
23338
23280
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23339
23281
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
23340
23282
|
* @param {String} opts.title Filter by document title.
|
|
23283
|
+
* @param {Object} opts.sortBy Sort by.
|
|
23284
|
+
* @param {Object} opts.sortOrder Sort Order.
|
|
23341
23285
|
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
23342
23286
|
*/
|
|
23343
23287
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
@@ -23356,7 +23300,7 @@ class KnowledgeApi {
|
|
|
23356
23300
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
23357
23301
|
'GET',
|
|
23358
23302
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
23359
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'],'documentIds': this.apiClient.buildCollectionParam(opts['documentIds'], 'multi') },
|
|
23303
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'documentIds': this.apiClient.buildCollectionParam(opts['documentIds'], 'multi') },
|
|
23360
23304
|
{ },
|
|
23361
23305
|
{ },
|
|
23362
23306
|
null,
|
|
@@ -23485,6 +23429,8 @@ class KnowledgeApi {
|
|
|
23485
23429
|
* @param {String} opts.name Filter by Name.
|
|
23486
23430
|
* @param {Object} opts.coreLanguage Filter by core language.
|
|
23487
23431
|
* @param {Boolean} opts.published Filter by published status.
|
|
23432
|
+
* @param {Object} opts.sortBy Sort by.
|
|
23433
|
+
* @param {Object} opts.sortOrder Sort Order.
|
|
23488
23434
|
*/
|
|
23489
23435
|
getKnowledgeKnowledgebases(opts) {
|
|
23490
23436
|
opts = opts || {};
|
|
@@ -23494,7 +23440,7 @@ class KnowledgeApi {
|
|
|
23494
23440
|
'/api/v2/knowledge/knowledgebases',
|
|
23495
23441
|
'GET',
|
|
23496
23442
|
{ },
|
|
23497
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'coreLanguage': opts['coreLanguage'],'published': opts['published'] },
|
|
23443
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'coreLanguage': opts['coreLanguage'],'published': opts['published'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
23498
23444
|
{ },
|
|
23499
23445
|
{ },
|
|
23500
23446
|
null,
|
|
@@ -23944,7 +23890,7 @@ class LanguageUnderstandingApi {
|
|
|
23944
23890
|
/**
|
|
23945
23891
|
* LanguageUnderstanding service.
|
|
23946
23892
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
23947
|
-
* @version
|
|
23893
|
+
* @version 126.0.0
|
|
23948
23894
|
*/
|
|
23949
23895
|
|
|
23950
23896
|
/**
|
|
@@ -24510,7 +24456,7 @@ class LanguageUnderstandingApi {
|
|
|
24510
24456
|
}
|
|
24511
24457
|
|
|
24512
24458
|
/**
|
|
24513
|
-
* Save information for the draft
|
|
24459
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
24514
24460
|
*
|
|
24515
24461
|
* @param {String} minerId Miner ID
|
|
24516
24462
|
* @param {String} draftId Draft ID
|
|
@@ -24754,7 +24700,7 @@ class LanguageUnderstandingApi {
|
|
|
24754
24700
|
}
|
|
24755
24701
|
|
|
24756
24702
|
/**
|
|
24757
|
-
* Start the mining process. Specify date range pair with mediaType
|
|
24703
|
+
* Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.
|
|
24758
24704
|
*
|
|
24759
24705
|
* @param {String} minerId Miner ID
|
|
24760
24706
|
* @param {Object} opts Optional parameters
|
|
@@ -24848,7 +24794,7 @@ class LanguagesApi {
|
|
|
24848
24794
|
/**
|
|
24849
24795
|
* Languages service.
|
|
24850
24796
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24851
|
-
* @version
|
|
24797
|
+
* @version 126.0.0
|
|
24852
24798
|
*/
|
|
24853
24799
|
|
|
24854
24800
|
/**
|
|
@@ -25116,7 +25062,7 @@ class LearningApi {
|
|
|
25116
25062
|
/**
|
|
25117
25063
|
* Learning service.
|
|
25118
25064
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25119
|
-
* @version
|
|
25065
|
+
* @version 126.0.0
|
|
25120
25066
|
*/
|
|
25121
25067
|
|
|
25122
25068
|
/**
|
|
@@ -25707,7 +25653,7 @@ class LicenseApi {
|
|
|
25707
25653
|
/**
|
|
25708
25654
|
* License service.
|
|
25709
25655
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
25710
|
-
* @version
|
|
25656
|
+
* @version 126.0.0
|
|
25711
25657
|
*/
|
|
25712
25658
|
|
|
25713
25659
|
/**
|
|
@@ -25945,7 +25891,7 @@ class LocationsApi {
|
|
|
25945
25891
|
/**
|
|
25946
25892
|
* Locations service.
|
|
25947
25893
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25948
|
-
* @version
|
|
25894
|
+
* @version 126.0.0
|
|
25949
25895
|
*/
|
|
25950
25896
|
|
|
25951
25897
|
/**
|
|
@@ -26181,7 +26127,7 @@ class MobileDevicesApi {
|
|
|
26181
26127
|
/**
|
|
26182
26128
|
* MobileDevices service.
|
|
26183
26129
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
26184
|
-
* @version
|
|
26130
|
+
* @version 126.0.0
|
|
26185
26131
|
*/
|
|
26186
26132
|
|
|
26187
26133
|
/**
|
|
@@ -26332,7 +26278,7 @@ class NotificationsApi {
|
|
|
26332
26278
|
/**
|
|
26333
26279
|
* Notifications service.
|
|
26334
26280
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
26335
|
-
* @version
|
|
26281
|
+
* @version 126.0.0
|
|
26336
26282
|
*/
|
|
26337
26283
|
|
|
26338
26284
|
/**
|
|
@@ -26557,7 +26503,7 @@ class OAuthApi {
|
|
|
26557
26503
|
/**
|
|
26558
26504
|
* OAuth service.
|
|
26559
26505
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
26560
|
-
* @version
|
|
26506
|
+
* @version 126.0.0
|
|
26561
26507
|
*/
|
|
26562
26508
|
|
|
26563
26509
|
/**
|
|
@@ -26915,7 +26861,7 @@ class ObjectsApi {
|
|
|
26915
26861
|
/**
|
|
26916
26862
|
* Objects service.
|
|
26917
26863
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26918
|
-
* @version
|
|
26864
|
+
* @version 126.0.0
|
|
26919
26865
|
*/
|
|
26920
26866
|
|
|
26921
26867
|
/**
|
|
@@ -27186,7 +27132,7 @@ class OrganizationApi {
|
|
|
27186
27132
|
/**
|
|
27187
27133
|
* Organization service.
|
|
27188
27134
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
27189
|
-
* @version
|
|
27135
|
+
* @version 126.0.0
|
|
27190
27136
|
*/
|
|
27191
27137
|
|
|
27192
27138
|
/**
|
|
@@ -27589,7 +27535,7 @@ class OrganizationAuthorizationApi {
|
|
|
27589
27535
|
/**
|
|
27590
27536
|
* OrganizationAuthorization service.
|
|
27591
27537
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
27592
|
-
* @version
|
|
27538
|
+
* @version 126.0.0
|
|
27593
27539
|
*/
|
|
27594
27540
|
|
|
27595
27541
|
/**
|
|
@@ -27629,6 +27575,36 @@ class OrganizationAuthorizationApi {
|
|
|
27629
27575
|
);
|
|
27630
27576
|
}
|
|
27631
27577
|
|
|
27578
|
+
/**
|
|
27579
|
+
* Deletes cloned user
|
|
27580
|
+
*
|
|
27581
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
27582
|
+
* @param {String} trusteeUserId Id of the cloned user to delete
|
|
27583
|
+
*/
|
|
27584
|
+
deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId, trusteeUserId) {
|
|
27585
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
27586
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
27587
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
27588
|
+
}
|
|
27589
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
27590
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
27591
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
27592
|
+
}
|
|
27593
|
+
|
|
27594
|
+
return this.apiClient.callApi(
|
|
27595
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}',
|
|
27596
|
+
'DELETE',
|
|
27597
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeUserId': trusteeUserId },
|
|
27598
|
+
{ },
|
|
27599
|
+
{ },
|
|
27600
|
+
{ },
|
|
27601
|
+
null,
|
|
27602
|
+
['PureCloud OAuth'],
|
|
27603
|
+
['application/json'],
|
|
27604
|
+
['application/json']
|
|
27605
|
+
);
|
|
27606
|
+
}
|
|
27607
|
+
|
|
27632
27608
|
/**
|
|
27633
27609
|
* Delete Trustee User
|
|
27634
27610
|
*
|
|
@@ -27714,6 +27690,36 @@ class OrganizationAuthorizationApi {
|
|
|
27714
27690
|
);
|
|
27715
27691
|
}
|
|
27716
27692
|
|
|
27693
|
+
/**
|
|
27694
|
+
* Delete Cloned User
|
|
27695
|
+
*
|
|
27696
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
27697
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
27698
|
+
*/
|
|
27699
|
+
deleteOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
27700
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
27701
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
27702
|
+
throw 'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
27703
|
+
}
|
|
27704
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
27705
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
27706
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
27707
|
+
}
|
|
27708
|
+
|
|
27709
|
+
return this.apiClient.callApi(
|
|
27710
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
27711
|
+
'DELETE',
|
|
27712
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
27713
|
+
{ },
|
|
27714
|
+
{ },
|
|
27715
|
+
{ },
|
|
27716
|
+
null,
|
|
27717
|
+
['PureCloud OAuth'],
|
|
27718
|
+
['application/json'],
|
|
27719
|
+
['application/json']
|
|
27720
|
+
);
|
|
27721
|
+
}
|
|
27722
|
+
|
|
27717
27723
|
/**
|
|
27718
27724
|
* Delete Trustee User
|
|
27719
27725
|
*
|
|
@@ -27794,6 +27800,31 @@ class OrganizationAuthorizationApi {
|
|
|
27794
27800
|
);
|
|
27795
27801
|
}
|
|
27796
27802
|
|
|
27803
|
+
/**
|
|
27804
|
+
* The list of cloned users from the trustee organization (i.e. users with a native user record).
|
|
27805
|
+
* There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged
|
|
27806
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
27807
|
+
*/
|
|
27808
|
+
getOrgauthorizationTrusteeClonedusers(trusteeOrgId) {
|
|
27809
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
27810
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
27811
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeClonedusers';
|
|
27812
|
+
}
|
|
27813
|
+
|
|
27814
|
+
return this.apiClient.callApi(
|
|
27815
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers',
|
|
27816
|
+
'GET',
|
|
27817
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
27818
|
+
{ },
|
|
27819
|
+
{ },
|
|
27820
|
+
{ },
|
|
27821
|
+
null,
|
|
27822
|
+
['PureCloud OAuth'],
|
|
27823
|
+
['application/json'],
|
|
27824
|
+
['application/json']
|
|
27825
|
+
);
|
|
27826
|
+
}
|
|
27827
|
+
|
|
27797
27828
|
/**
|
|
27798
27829
|
* Get Trustee User
|
|
27799
27830
|
*
|
|
@@ -27909,6 +27940,26 @@ class OrganizationAuthorizationApi {
|
|
|
27909
27940
|
);
|
|
27910
27941
|
}
|
|
27911
27942
|
|
|
27943
|
+
/**
|
|
27944
|
+
* Get organization authorization trust with Customer Care, if one exists.
|
|
27945
|
+
*
|
|
27946
|
+
*/
|
|
27947
|
+
getOrgauthorizationTrusteesDefault() {
|
|
27948
|
+
|
|
27949
|
+
return this.apiClient.callApi(
|
|
27950
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
27951
|
+
'GET',
|
|
27952
|
+
{ },
|
|
27953
|
+
{ },
|
|
27954
|
+
{ },
|
|
27955
|
+
{ },
|
|
27956
|
+
null,
|
|
27957
|
+
['PureCloud OAuth'],
|
|
27958
|
+
['application/json'],
|
|
27959
|
+
['application/json']
|
|
27960
|
+
);
|
|
27961
|
+
}
|
|
27962
|
+
|
|
27912
27963
|
/**
|
|
27913
27964
|
* Get Org Trust
|
|
27914
27965
|
*
|
|
@@ -27934,6 +27985,61 @@ class OrganizationAuthorizationApi {
|
|
|
27934
27985
|
);
|
|
27935
27986
|
}
|
|
27936
27987
|
|
|
27988
|
+
/**
|
|
27989
|
+
* Get Cloned User
|
|
27990
|
+
*
|
|
27991
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
27992
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
27993
|
+
*/
|
|
27994
|
+
getOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
27995
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
27996
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
27997
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorCloneduser';
|
|
27998
|
+
}
|
|
27999
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
28000
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
28001
|
+
throw 'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorCloneduser';
|
|
28002
|
+
}
|
|
28003
|
+
|
|
28004
|
+
return this.apiClient.callApi(
|
|
28005
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
28006
|
+
'GET',
|
|
28007
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
28008
|
+
{ },
|
|
28009
|
+
{ },
|
|
28010
|
+
{ },
|
|
28011
|
+
null,
|
|
28012
|
+
['PureCloud OAuth'],
|
|
28013
|
+
['application/json'],
|
|
28014
|
+
['application/json']
|
|
28015
|
+
);
|
|
28016
|
+
}
|
|
28017
|
+
|
|
28018
|
+
/**
|
|
28019
|
+
* The list of cloned users in the trustor organization (i.e. users with a native user record).
|
|
28020
|
+
*
|
|
28021
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
28022
|
+
*/
|
|
28023
|
+
getOrgauthorizationTrustorClonedusers(trustorOrgId) {
|
|
28024
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
28025
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
28026
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorClonedusers';
|
|
28027
|
+
}
|
|
28028
|
+
|
|
28029
|
+
return this.apiClient.callApi(
|
|
28030
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers',
|
|
28031
|
+
'GET',
|
|
28032
|
+
{ 'trustorOrgId': trustorOrgId },
|
|
28033
|
+
{ },
|
|
28034
|
+
{ },
|
|
28035
|
+
{ },
|
|
28036
|
+
null,
|
|
28037
|
+
['PureCloud OAuth'],
|
|
28038
|
+
['application/json'],
|
|
28039
|
+
['application/json']
|
|
28040
|
+
);
|
|
28041
|
+
}
|
|
28042
|
+
|
|
27937
28043
|
/**
|
|
27938
28044
|
* Get Trustee User
|
|
27939
28045
|
*
|
|
@@ -28131,6 +28237,31 @@ class OrganizationAuthorizationApi {
|
|
|
28131
28237
|
);
|
|
28132
28238
|
}
|
|
28133
28239
|
|
|
28240
|
+
/**
|
|
28241
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
28242
|
+
*
|
|
28243
|
+
* @param {Object} opts Optional parameters
|
|
28244
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
28245
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
28246
|
+
*/
|
|
28247
|
+
postOrgauthorizationTrusteesDefault(opts) {
|
|
28248
|
+
opts = opts || {};
|
|
28249
|
+
|
|
28250
|
+
|
|
28251
|
+
return this.apiClient.callApi(
|
|
28252
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
28253
|
+
'POST',
|
|
28254
|
+
{ },
|
|
28255
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'] },
|
|
28256
|
+
{ },
|
|
28257
|
+
{ },
|
|
28258
|
+
null,
|
|
28259
|
+
['PureCloud OAuth'],
|
|
28260
|
+
['application/json'],
|
|
28261
|
+
['application/json']
|
|
28262
|
+
);
|
|
28263
|
+
}
|
|
28264
|
+
|
|
28134
28265
|
/**
|
|
28135
28266
|
* Get Org Trustor Audits
|
|
28136
28267
|
*
|
|
@@ -28263,6 +28394,36 @@ class OrganizationAuthorizationApi {
|
|
|
28263
28394
|
);
|
|
28264
28395
|
}
|
|
28265
28396
|
|
|
28397
|
+
/**
|
|
28398
|
+
* Creates a clone of the trustee user in the trustor org.
|
|
28399
|
+
*
|
|
28400
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
28401
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
28402
|
+
*/
|
|
28403
|
+
putOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
28404
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
28405
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
28406
|
+
throw 'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorCloneduser';
|
|
28407
|
+
}
|
|
28408
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
28409
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
28410
|
+
throw 'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorCloneduser';
|
|
28411
|
+
}
|
|
28412
|
+
|
|
28413
|
+
return this.apiClient.callApi(
|
|
28414
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
28415
|
+
'PUT',
|
|
28416
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
28417
|
+
{ },
|
|
28418
|
+
{ },
|
|
28419
|
+
{ },
|
|
28420
|
+
null,
|
|
28421
|
+
['PureCloud OAuth'],
|
|
28422
|
+
['application/json'],
|
|
28423
|
+
['application/json']
|
|
28424
|
+
);
|
|
28425
|
+
}
|
|
28426
|
+
|
|
28266
28427
|
/**
|
|
28267
28428
|
* Add a Trustee user to the trust.
|
|
28268
28429
|
*
|
|
@@ -28299,7 +28460,7 @@ class OutboundApi {
|
|
|
28299
28460
|
/**
|
|
28300
28461
|
* Outbound service.
|
|
28301
28462
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
28302
|
-
* @version
|
|
28463
|
+
* @version 126.0.0
|
|
28303
28464
|
*/
|
|
28304
28465
|
|
|
28305
28466
|
/**
|
|
@@ -31325,7 +31486,7 @@ class PresenceApi {
|
|
|
31325
31486
|
/**
|
|
31326
31487
|
* Presence service.
|
|
31327
31488
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
31328
|
-
* @version
|
|
31489
|
+
* @version 126.0.0
|
|
31329
31490
|
*/
|
|
31330
31491
|
|
|
31331
31492
|
/**
|
|
@@ -31697,7 +31858,7 @@ class QualityApi {
|
|
|
31697
31858
|
/**
|
|
31698
31859
|
* Quality service.
|
|
31699
31860
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31700
|
-
* @version
|
|
31861
|
+
* @version 126.0.0
|
|
31701
31862
|
*/
|
|
31702
31863
|
|
|
31703
31864
|
/**
|
|
@@ -32070,7 +32231,7 @@ class QualityApi {
|
|
|
32070
32231
|
|
|
32071
32232
|
/**
|
|
32072
32233
|
* Queries Evaluations and returns a paged list
|
|
32073
|
-
* Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
32234
|
+
* Query params must include one of conversationId, evaluatorUserId, or agentUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
32074
32235
|
* @param {Object} opts Optional parameters
|
|
32075
32236
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
32076
32237
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -33225,7 +33386,7 @@ class RecordingApi {
|
|
|
33225
33386
|
/**
|
|
33226
33387
|
* Recording service.
|
|
33227
33388
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
33228
|
-
* @version
|
|
33389
|
+
* @version 126.0.0
|
|
33229
33390
|
*/
|
|
33230
33391
|
|
|
33231
33392
|
/**
|
|
@@ -34744,7 +34905,7 @@ class ResponseManagementApi {
|
|
|
34744
34905
|
/**
|
|
34745
34906
|
* ResponseManagement service.
|
|
34746
34907
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34747
|
-
* @version
|
|
34908
|
+
* @version 126.0.0
|
|
34748
34909
|
*/
|
|
34749
34910
|
|
|
34750
34911
|
/**
|
|
@@ -35069,7 +35230,7 @@ class RoutingApi {
|
|
|
35069
35230
|
/**
|
|
35070
35231
|
* Routing service.
|
|
35071
35232
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
35072
|
-
* @version
|
|
35233
|
+
* @version 126.0.0
|
|
35073
35234
|
*/
|
|
35074
35235
|
|
|
35075
35236
|
/**
|
|
@@ -35382,8 +35543,12 @@ class RoutingApi {
|
|
|
35382
35543
|
* Delete a phone number provisioned for SMS.
|
|
35383
35544
|
*
|
|
35384
35545
|
* @param {String} addressId Address ID
|
|
35546
|
+
* @param {Object} opts Optional parameters
|
|
35547
|
+
* @param {Boolean} opts.async Delete a phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the deletion of a provisioned phone number. (default to false)
|
|
35385
35548
|
*/
|
|
35386
|
-
deleteRoutingSmsPhonenumber(addressId) {
|
|
35549
|
+
deleteRoutingSmsPhonenumber(addressId, opts) {
|
|
35550
|
+
opts = opts || {};
|
|
35551
|
+
|
|
35387
35552
|
// verify the required parameter 'addressId' is set
|
|
35388
35553
|
if (addressId === undefined || addressId === null) {
|
|
35389
35554
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -35393,7 +35558,7 @@ class RoutingApi {
|
|
|
35393
35558
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
35394
35559
|
'DELETE',
|
|
35395
35560
|
{ 'addressId': addressId },
|
|
35396
|
-
{
|
|
35561
|
+
{ 'async': opts['async'] },
|
|
35397
35562
|
{ },
|
|
35398
35563
|
{ },
|
|
35399
35564
|
null,
|
|
@@ -36221,12 +36386,11 @@ class RoutingApi {
|
|
|
36221
36386
|
}
|
|
36222
36387
|
|
|
36223
36388
|
/**
|
|
36224
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
36389
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
36225
36390
|
*
|
|
36226
36391
|
* @param {Object} opts Optional parameters
|
|
36227
36392
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
36228
36393
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
36229
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
36230
36394
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
36231
36395
|
*/
|
|
36232
36396
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -36237,7 +36401,7 @@ class RoutingApi {
|
|
|
36237
36401
|
'/api/v2/routing/queues/divisionviews/all',
|
|
36238
36402
|
'GET',
|
|
36239
36403
|
{ },
|
|
36240
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
36404
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
36241
36405
|
{ },
|
|
36242
36406
|
{ },
|
|
36243
36407
|
null,
|
|
@@ -36721,7 +36885,7 @@ class RoutingApi {
|
|
|
36721
36885
|
|
|
36722
36886
|
/**
|
|
36723
36887
|
* Update attributes of an in-queue conversation
|
|
36724
|
-
* Returns an object indicating the updated values of all settable attributes. Supported attributes:
|
|
36888
|
+
* Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, languageId, and priority.
|
|
36725
36889
|
* @param {String} conversationId Conversation ID
|
|
36726
36890
|
* @param {Object} body Conversation Attributes
|
|
36727
36891
|
*/
|
|
@@ -37540,8 +37704,12 @@ class RoutingApi {
|
|
|
37540
37704
|
* Provision a phone number for SMS
|
|
37541
37705
|
*
|
|
37542
37706
|
* @param {Object} body SmsPhoneNumber
|
|
37707
|
+
* @param {Object} opts Optional parameters
|
|
37708
|
+
* @param {Boolean} opts.async Provision a new phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the provisioning of a new phone number. Check the phoneNumber's provisioningStatus for completion of this request. (default to false)
|
|
37543
37709
|
*/
|
|
37544
|
-
postRoutingSmsPhonenumbers(body) {
|
|
37710
|
+
postRoutingSmsPhonenumbers(body, opts) {
|
|
37711
|
+
opts = opts || {};
|
|
37712
|
+
|
|
37545
37713
|
// verify the required parameter 'body' is set
|
|
37546
37714
|
if (body === undefined || body === null) {
|
|
37547
37715
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -37551,7 +37719,7 @@ class RoutingApi {
|
|
|
37551
37719
|
'/api/v2/routing/sms/phonenumbers',
|
|
37552
37720
|
'POST',
|
|
37553
37721
|
{ },
|
|
37554
|
-
{
|
|
37722
|
+
{ 'async': opts['async'] },
|
|
37555
37723
|
{ },
|
|
37556
37724
|
{ },
|
|
37557
37725
|
body,
|
|
@@ -37796,8 +37964,12 @@ class RoutingApi {
|
|
|
37796
37964
|
*
|
|
37797
37965
|
* @param {String} addressId Address ID
|
|
37798
37966
|
* @param {Object} body SmsPhoneNumber
|
|
37967
|
+
* @param {Object} opts Optional parameters
|
|
37968
|
+
* @param {Boolean} opts.async Update an existing phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the update of a provisioned phone number. Check the phoneNumber's provisioningStatus for the progress of this request. (default to false)
|
|
37799
37969
|
*/
|
|
37800
|
-
putRoutingSmsPhonenumber(addressId, body) {
|
|
37970
|
+
putRoutingSmsPhonenumber(addressId, body, opts) {
|
|
37971
|
+
opts = opts || {};
|
|
37972
|
+
|
|
37801
37973
|
// verify the required parameter 'addressId' is set
|
|
37802
37974
|
if (addressId === undefined || addressId === null) {
|
|
37803
37975
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -37811,7 +37983,7 @@ class RoutingApi {
|
|
|
37811
37983
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
37812
37984
|
'PUT',
|
|
37813
37985
|
{ 'addressId': addressId },
|
|
37814
|
-
{
|
|
37986
|
+
{ 'async': opts['async'] },
|
|
37815
37987
|
{ },
|
|
37816
37988
|
{ },
|
|
37817
37989
|
body,
|
|
@@ -37977,7 +38149,7 @@ class SCIMApi {
|
|
|
37977
38149
|
/**
|
|
37978
38150
|
* SCIM service.
|
|
37979
38151
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37980
|
-
* @version
|
|
38152
|
+
* @version 126.0.0
|
|
37981
38153
|
*/
|
|
37982
38154
|
|
|
37983
38155
|
/**
|
|
@@ -38854,7 +39026,7 @@ class ScriptsApi {
|
|
|
38854
39026
|
/**
|
|
38855
39027
|
* Scripts service.
|
|
38856
39028
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38857
|
-
* @version
|
|
39029
|
+
* @version 126.0.0
|
|
38858
39030
|
*/
|
|
38859
39031
|
|
|
38860
39032
|
/**
|
|
@@ -39207,7 +39379,7 @@ class SearchApi {
|
|
|
39207
39379
|
/**
|
|
39208
39380
|
* Search service.
|
|
39209
39381
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39210
|
-
* @version
|
|
39382
|
+
* @version 126.0.0
|
|
39211
39383
|
*/
|
|
39212
39384
|
|
|
39213
39385
|
/**
|
|
@@ -39742,7 +39914,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39742
39914
|
/**
|
|
39743
39915
|
* SpeechTextAnalytics service.
|
|
39744
39916
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39745
|
-
* @version
|
|
39917
|
+
* @version 126.0.0
|
|
39746
39918
|
*/
|
|
39747
39919
|
|
|
39748
39920
|
/**
|
|
@@ -39786,6 +39958,51 @@ class SpeechTextAnalyticsApi {
|
|
|
39786
39958
|
);
|
|
39787
39959
|
}
|
|
39788
39960
|
|
|
39961
|
+
/**
|
|
39962
|
+
* Delete All Speech & Text Analytics SentimentFeedback
|
|
39963
|
+
*
|
|
39964
|
+
*/
|
|
39965
|
+
deleteSpeechandtextanalyticsSentimentfeedback() {
|
|
39966
|
+
|
|
39967
|
+
return this.apiClient.callApi(
|
|
39968
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
39969
|
+
'DELETE',
|
|
39970
|
+
{ },
|
|
39971
|
+
{ },
|
|
39972
|
+
{ },
|
|
39973
|
+
{ },
|
|
39974
|
+
null,
|
|
39975
|
+
['PureCloud OAuth'],
|
|
39976
|
+
['application/json'],
|
|
39977
|
+
['application/json']
|
|
39978
|
+
);
|
|
39979
|
+
}
|
|
39980
|
+
|
|
39981
|
+
/**
|
|
39982
|
+
* Delete a Speech & Text Analytics SentimentFeedback by Id
|
|
39983
|
+
*
|
|
39984
|
+
* @param {String} sentimentFeedbackId The Id of the SentimentFeedback
|
|
39985
|
+
*/
|
|
39986
|
+
deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId) {
|
|
39987
|
+
// verify the required parameter 'sentimentFeedbackId' is set
|
|
39988
|
+
if (sentimentFeedbackId === undefined || sentimentFeedbackId === null) {
|
|
39989
|
+
throw 'Missing the required parameter "sentimentFeedbackId" when calling deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId';
|
|
39990
|
+
}
|
|
39991
|
+
|
|
39992
|
+
return this.apiClient.callApi(
|
|
39993
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}',
|
|
39994
|
+
'DELETE',
|
|
39995
|
+
{ 'sentimentFeedbackId': sentimentFeedbackId },
|
|
39996
|
+
{ },
|
|
39997
|
+
{ },
|
|
39998
|
+
{ },
|
|
39999
|
+
null,
|
|
40000
|
+
['PureCloud OAuth'],
|
|
40001
|
+
['application/json'],
|
|
40002
|
+
['application/json']
|
|
40003
|
+
);
|
|
40004
|
+
}
|
|
40005
|
+
|
|
39789
40006
|
/**
|
|
39790
40007
|
* Delete a Speech & Text Analytics topic by id
|
|
39791
40008
|
*
|
|
@@ -39868,7 +40085,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39868
40085
|
|
|
39869
40086
|
/**
|
|
39870
40087
|
* Get list of supported Speech & Text Analytics dialects
|
|
39871
|
-
*
|
|
40088
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
39872
40089
|
*/
|
|
39873
40090
|
getSpeechandtextanalyticsDialects() {
|
|
39874
40091
|
|
|
@@ -40061,6 +40278,30 @@ class SpeechTextAnalyticsApi {
|
|
|
40061
40278
|
);
|
|
40062
40279
|
}
|
|
40063
40280
|
|
|
40281
|
+
/**
|
|
40282
|
+
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
40283
|
+
*
|
|
40284
|
+
* @param {Object} opts Optional parameters
|
|
40285
|
+
* @param {String} opts.dialect The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard
|
|
40286
|
+
*/
|
|
40287
|
+
getSpeechandtextanalyticsSentimentfeedback(opts) {
|
|
40288
|
+
opts = opts || {};
|
|
40289
|
+
|
|
40290
|
+
|
|
40291
|
+
return this.apiClient.callApi(
|
|
40292
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
40293
|
+
'GET',
|
|
40294
|
+
{ },
|
|
40295
|
+
{ 'dialect': opts['dialect'] },
|
|
40296
|
+
{ },
|
|
40297
|
+
{ },
|
|
40298
|
+
null,
|
|
40299
|
+
['PureCloud OAuth'],
|
|
40300
|
+
['application/json'],
|
|
40301
|
+
['application/json']
|
|
40302
|
+
);
|
|
40303
|
+
}
|
|
40304
|
+
|
|
40064
40305
|
/**
|
|
40065
40306
|
* Get Speech And Text Analytics Settings
|
|
40066
40307
|
*
|
|
@@ -40305,6 +40546,31 @@ class SpeechTextAnalyticsApi {
|
|
|
40305
40546
|
);
|
|
40306
40547
|
}
|
|
40307
40548
|
|
|
40549
|
+
/**
|
|
40550
|
+
* Create a Speech & Text Analytics SentimentFeedback
|
|
40551
|
+
*
|
|
40552
|
+
* @param {Object} body The SentimentFeedback to create
|
|
40553
|
+
*/
|
|
40554
|
+
postSpeechandtextanalyticsSentimentfeedback(body) {
|
|
40555
|
+
// verify the required parameter 'body' is set
|
|
40556
|
+
if (body === undefined || body === null) {
|
|
40557
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsSentimentfeedback';
|
|
40558
|
+
}
|
|
40559
|
+
|
|
40560
|
+
return this.apiClient.callApi(
|
|
40561
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
40562
|
+
'POST',
|
|
40563
|
+
{ },
|
|
40564
|
+
{ },
|
|
40565
|
+
{ },
|
|
40566
|
+
{ },
|
|
40567
|
+
body,
|
|
40568
|
+
['PureCloud OAuth'],
|
|
40569
|
+
['application/json'],
|
|
40570
|
+
['application/json']
|
|
40571
|
+
);
|
|
40572
|
+
}
|
|
40573
|
+
|
|
40308
40574
|
/**
|
|
40309
40575
|
* Create new Speech & Text Analytics topic
|
|
40310
40576
|
*
|
|
@@ -40501,7 +40767,7 @@ class StationsApi {
|
|
|
40501
40767
|
/**
|
|
40502
40768
|
* Stations service.
|
|
40503
40769
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40504
|
-
* @version
|
|
40770
|
+
* @version 126.0.0
|
|
40505
40771
|
*/
|
|
40506
40772
|
|
|
40507
40773
|
/**
|
|
@@ -40648,7 +40914,7 @@ class SuggestApi {
|
|
|
40648
40914
|
/**
|
|
40649
40915
|
* Suggest service.
|
|
40650
40916
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40651
|
-
* @version
|
|
40917
|
+
* @version 126.0.0
|
|
40652
40918
|
*/
|
|
40653
40919
|
|
|
40654
40920
|
/**
|
|
@@ -40787,7 +41053,7 @@ class TelephonyApi {
|
|
|
40787
41053
|
/**
|
|
40788
41054
|
* Telephony service.
|
|
40789
41055
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40790
|
-
* @version
|
|
41056
|
+
* @version 126.0.0
|
|
40791
41057
|
*/
|
|
40792
41058
|
|
|
40793
41059
|
/**
|
|
@@ -40895,7 +41161,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
40895
41161
|
/**
|
|
40896
41162
|
* TelephonyProvidersEdge service.
|
|
40897
41163
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40898
|
-
* @version
|
|
41164
|
+
* @version 126.0.0
|
|
40899
41165
|
*/
|
|
40900
41166
|
|
|
40901
41167
|
/**
|
|
@@ -44508,7 +44774,7 @@ class TextbotsApi {
|
|
|
44508
44774
|
/**
|
|
44509
44775
|
* Textbots service.
|
|
44510
44776
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44511
|
-
* @version
|
|
44777
|
+
* @version 126.0.0
|
|
44512
44778
|
*/
|
|
44513
44779
|
|
|
44514
44780
|
/**
|
|
@@ -44609,7 +44875,7 @@ class TokensApi {
|
|
|
44609
44875
|
/**
|
|
44610
44876
|
* Tokens service.
|
|
44611
44877
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44612
|
-
* @version
|
|
44878
|
+
* @version 126.0.0
|
|
44613
44879
|
*/
|
|
44614
44880
|
|
|
44615
44881
|
/**
|
|
@@ -44715,7 +44981,7 @@ class UploadsApi {
|
|
|
44715
44981
|
/**
|
|
44716
44982
|
* Uploads service.
|
|
44717
44983
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44718
|
-
* @version
|
|
44984
|
+
* @version 126.0.0
|
|
44719
44985
|
*/
|
|
44720
44986
|
|
|
44721
44987
|
/**
|
|
@@ -44891,7 +45157,7 @@ class UsageApi {
|
|
|
44891
45157
|
/**
|
|
44892
45158
|
* Usage service.
|
|
44893
45159
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44894
|
-
* @version
|
|
45160
|
+
* @version 126.0.0
|
|
44895
45161
|
*/
|
|
44896
45162
|
|
|
44897
45163
|
/**
|
|
@@ -44962,7 +45228,7 @@ class UserRecordingsApi {
|
|
|
44962
45228
|
/**
|
|
44963
45229
|
* UserRecordings service.
|
|
44964
45230
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44965
|
-
* @version
|
|
45231
|
+
* @version 126.0.0
|
|
44966
45232
|
*/
|
|
44967
45233
|
|
|
44968
45234
|
/**
|
|
@@ -45146,7 +45412,7 @@ class UsersApi {
|
|
|
45146
45412
|
/**
|
|
45147
45413
|
* Users service.
|
|
45148
45414
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45149
|
-
* @version
|
|
45415
|
+
* @version 126.0.0
|
|
45150
45416
|
*/
|
|
45151
45417
|
|
|
45152
45418
|
/**
|
|
@@ -47448,7 +47714,7 @@ class UtilitiesApi {
|
|
|
47448
47714
|
/**
|
|
47449
47715
|
* Utilities service.
|
|
47450
47716
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47451
|
-
* @version
|
|
47717
|
+
* @version 126.0.0
|
|
47452
47718
|
*/
|
|
47453
47719
|
|
|
47454
47720
|
/**
|
|
@@ -47559,7 +47825,7 @@ class VoicemailApi {
|
|
|
47559
47825
|
/**
|
|
47560
47826
|
* Voicemail service.
|
|
47561
47827
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47562
|
-
* @version
|
|
47828
|
+
* @version 126.0.0
|
|
47563
47829
|
*/
|
|
47564
47830
|
|
|
47565
47831
|
/**
|
|
@@ -48190,13 +48456,43 @@ class VoicemailApi {
|
|
|
48190
48456
|
);
|
|
48191
48457
|
}
|
|
48192
48458
|
|
|
48459
|
+
/**
|
|
48460
|
+
* Update a user's voicemail policy
|
|
48461
|
+
*
|
|
48462
|
+
* @param {String} userId User ID
|
|
48463
|
+
* @param {Object} body The user's voicemail policy
|
|
48464
|
+
*/
|
|
48465
|
+
putVoicemailUserpolicy(userId, body) {
|
|
48466
|
+
// verify the required parameter 'userId' is set
|
|
48467
|
+
if (userId === undefined || userId === null) {
|
|
48468
|
+
throw 'Missing the required parameter "userId" when calling putVoicemailUserpolicy';
|
|
48469
|
+
}
|
|
48470
|
+
// verify the required parameter 'body' is set
|
|
48471
|
+
if (body === undefined || body === null) {
|
|
48472
|
+
throw 'Missing the required parameter "body" when calling putVoicemailUserpolicy';
|
|
48473
|
+
}
|
|
48474
|
+
|
|
48475
|
+
return this.apiClient.callApi(
|
|
48476
|
+
'/api/v2/voicemail/userpolicies/{userId}',
|
|
48477
|
+
'PUT',
|
|
48478
|
+
{ 'userId': userId },
|
|
48479
|
+
{ },
|
|
48480
|
+
{ },
|
|
48481
|
+
{ },
|
|
48482
|
+
body,
|
|
48483
|
+
['PureCloud OAuth'],
|
|
48484
|
+
['application/json'],
|
|
48485
|
+
['application/json']
|
|
48486
|
+
);
|
|
48487
|
+
}
|
|
48488
|
+
|
|
48193
48489
|
}
|
|
48194
48490
|
|
|
48195
48491
|
class WebChatApi {
|
|
48196
48492
|
/**
|
|
48197
48493
|
* WebChat service.
|
|
48198
48494
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48199
|
-
* @version
|
|
48495
|
+
* @version 126.0.0
|
|
48200
48496
|
*/
|
|
48201
48497
|
|
|
48202
48498
|
/**
|
|
@@ -48740,7 +49036,7 @@ class WebDeploymentsApi {
|
|
|
48740
49036
|
/**
|
|
48741
49037
|
* WebDeployments service.
|
|
48742
49038
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48743
|
-
* @version
|
|
49039
|
+
* @version 126.0.0
|
|
48744
49040
|
*/
|
|
48745
49041
|
|
|
48746
49042
|
/**
|
|
@@ -49091,11 +49387,57 @@ class WebDeploymentsApi {
|
|
|
49091
49387
|
|
|
49092
49388
|
}
|
|
49093
49389
|
|
|
49390
|
+
class WebMessagingApi {
|
|
49391
|
+
/**
|
|
49392
|
+
* WebMessaging service.
|
|
49393
|
+
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49394
|
+
* @version 126.0.0
|
|
49395
|
+
*/
|
|
49396
|
+
|
|
49397
|
+
/**
|
|
49398
|
+
* Constructs a new WebMessagingApi.
|
|
49399
|
+
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
49400
|
+
* @class
|
|
49401
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
49402
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
49403
|
+
*/
|
|
49404
|
+
constructor(apiClient) {
|
|
49405
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
49406
|
+
}
|
|
49407
|
+
|
|
49408
|
+
|
|
49409
|
+
/**
|
|
49410
|
+
* Get the messages for a web messaging session.
|
|
49411
|
+
*
|
|
49412
|
+
* @param {Object} opts Optional parameters
|
|
49413
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
49414
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
49415
|
+
*/
|
|
49416
|
+
getWebmessagingMessages(opts) {
|
|
49417
|
+
opts = opts || {};
|
|
49418
|
+
|
|
49419
|
+
|
|
49420
|
+
return this.apiClient.callApi(
|
|
49421
|
+
'/api/v2/webmessaging/messages',
|
|
49422
|
+
'GET',
|
|
49423
|
+
{ },
|
|
49424
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
49425
|
+
{ },
|
|
49426
|
+
{ },
|
|
49427
|
+
null,
|
|
49428
|
+
['PureCloud OAuth'],
|
|
49429
|
+
['application/json'],
|
|
49430
|
+
['application/json']
|
|
49431
|
+
);
|
|
49432
|
+
}
|
|
49433
|
+
|
|
49434
|
+
}
|
|
49435
|
+
|
|
49094
49436
|
class WidgetsApi {
|
|
49095
49437
|
/**
|
|
49096
49438
|
* Widgets service.
|
|
49097
49439
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49098
|
-
* @version
|
|
49440
|
+
* @version 126.0.0
|
|
49099
49441
|
*/
|
|
49100
49442
|
|
|
49101
49443
|
/**
|
|
@@ -49241,7 +49583,7 @@ class WorkforceManagementApi {
|
|
|
49241
49583
|
/**
|
|
49242
49584
|
* WorkforceManagement service.
|
|
49243
49585
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49244
|
-
* @version
|
|
49586
|
+
* @version 126.0.0
|
|
49245
49587
|
*/
|
|
49246
49588
|
|
|
49247
49589
|
/**
|
|
@@ -49516,6 +49858,66 @@ class WorkforceManagementApi {
|
|
|
49516
49858
|
);
|
|
49517
49859
|
}
|
|
49518
49860
|
|
|
49861
|
+
/**
|
|
49862
|
+
* Deletes a time off limit object
|
|
49863
|
+
*
|
|
49864
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49865
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
49866
|
+
*/
|
|
49867
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49868
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49869
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49870
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
49871
|
+
}
|
|
49872
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49873
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49874
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
49875
|
+
}
|
|
49876
|
+
|
|
49877
|
+
return this.apiClient.callApi(
|
|
49878
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49879
|
+
'DELETE',
|
|
49880
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49881
|
+
{ },
|
|
49882
|
+
{ },
|
|
49883
|
+
{ },
|
|
49884
|
+
null,
|
|
49885
|
+
['PureCloud OAuth'],
|
|
49886
|
+
['application/json'],
|
|
49887
|
+
['application/json']
|
|
49888
|
+
);
|
|
49889
|
+
}
|
|
49890
|
+
|
|
49891
|
+
/**
|
|
49892
|
+
* Deletes a time off plan
|
|
49893
|
+
*
|
|
49894
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49895
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
49896
|
+
*/
|
|
49897
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49898
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49899
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49900
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
49901
|
+
}
|
|
49902
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49903
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49904
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
49905
|
+
}
|
|
49906
|
+
|
|
49907
|
+
return this.apiClient.callApi(
|
|
49908
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49909
|
+
'DELETE',
|
|
49910
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49911
|
+
{ },
|
|
49912
|
+
{ },
|
|
49913
|
+
{ },
|
|
49914
|
+
null,
|
|
49915
|
+
['PureCloud OAuth'],
|
|
49916
|
+
['application/json'],
|
|
49917
|
+
['application/json']
|
|
49918
|
+
);
|
|
49919
|
+
}
|
|
49920
|
+
|
|
49519
49921
|
/**
|
|
49520
49922
|
* Delete a work plan
|
|
49521
49923
|
*
|
|
@@ -50757,6 +51159,116 @@ class WorkforceManagementApi {
|
|
|
50757
51159
|
);
|
|
50758
51160
|
}
|
|
50759
51161
|
|
|
51162
|
+
/**
|
|
51163
|
+
* Gets a time off limit object
|
|
51164
|
+
* Returns properties of time off limit object, but not daily values.
|
|
51165
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51166
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
51167
|
+
*/
|
|
51168
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
51169
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51170
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51171
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
51172
|
+
}
|
|
51173
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51174
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51175
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
51176
|
+
}
|
|
51177
|
+
|
|
51178
|
+
return this.apiClient.callApi(
|
|
51179
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
51180
|
+
'GET',
|
|
51181
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51182
|
+
{ },
|
|
51183
|
+
{ },
|
|
51184
|
+
{ },
|
|
51185
|
+
null,
|
|
51186
|
+
['PureCloud OAuth'],
|
|
51187
|
+
['application/json'],
|
|
51188
|
+
['application/json']
|
|
51189
|
+
);
|
|
51190
|
+
}
|
|
51191
|
+
|
|
51192
|
+
/**
|
|
51193
|
+
* Gets a list of time off limit objects under management unit.
|
|
51194
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
51195
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51196
|
+
*/
|
|
51197
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
51198
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51199
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51200
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
51201
|
+
}
|
|
51202
|
+
|
|
51203
|
+
return this.apiClient.callApi(
|
|
51204
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51205
|
+
'GET',
|
|
51206
|
+
{ 'managementUnitId': managementUnitId },
|
|
51207
|
+
{ },
|
|
51208
|
+
{ },
|
|
51209
|
+
{ },
|
|
51210
|
+
null,
|
|
51211
|
+
['PureCloud OAuth'],
|
|
51212
|
+
['application/json'],
|
|
51213
|
+
['application/json']
|
|
51214
|
+
);
|
|
51215
|
+
}
|
|
51216
|
+
|
|
51217
|
+
/**
|
|
51218
|
+
* Gets a time off plan
|
|
51219
|
+
*
|
|
51220
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51221
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
51222
|
+
*/
|
|
51223
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
51224
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51225
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51226
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
51227
|
+
}
|
|
51228
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
51229
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
51230
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
51231
|
+
}
|
|
51232
|
+
|
|
51233
|
+
return this.apiClient.callApi(
|
|
51234
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
51235
|
+
'GET',
|
|
51236
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
51237
|
+
{ },
|
|
51238
|
+
{ },
|
|
51239
|
+
{ },
|
|
51240
|
+
null,
|
|
51241
|
+
['PureCloud OAuth'],
|
|
51242
|
+
['application/json'],
|
|
51243
|
+
['application/json']
|
|
51244
|
+
);
|
|
51245
|
+
}
|
|
51246
|
+
|
|
51247
|
+
/**
|
|
51248
|
+
* Gets a list of time off plans
|
|
51249
|
+
*
|
|
51250
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51251
|
+
*/
|
|
51252
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
51253
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51254
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51255
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
51256
|
+
}
|
|
51257
|
+
|
|
51258
|
+
return this.apiClient.callApi(
|
|
51259
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51260
|
+
'GET',
|
|
51261
|
+
{ 'managementUnitId': managementUnitId },
|
|
51262
|
+
{ },
|
|
51263
|
+
{ },
|
|
51264
|
+
{ },
|
|
51265
|
+
null,
|
|
51266
|
+
['PureCloud OAuth'],
|
|
51267
|
+
['application/json'],
|
|
51268
|
+
['application/json']
|
|
51269
|
+
);
|
|
51270
|
+
}
|
|
51271
|
+
|
|
50760
51272
|
/**
|
|
50761
51273
|
* Get a time off request
|
|
50762
51274
|
*
|
|
@@ -50792,6 +51304,41 @@ class WorkforceManagementApi {
|
|
|
50792
51304
|
);
|
|
50793
51305
|
}
|
|
50794
51306
|
|
|
51307
|
+
/**
|
|
51308
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
51309
|
+
*
|
|
51310
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51311
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
51312
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
51313
|
+
*/
|
|
51314
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
51315
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51316
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51317
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51318
|
+
}
|
|
51319
|
+
// verify the required parameter 'userId' is set
|
|
51320
|
+
if (userId === undefined || userId === null) {
|
|
51321
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51322
|
+
}
|
|
51323
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
51324
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
51325
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51326
|
+
}
|
|
51327
|
+
|
|
51328
|
+
return this.apiClient.callApi(
|
|
51329
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
51330
|
+
'GET',
|
|
51331
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
51332
|
+
{ },
|
|
51333
|
+
{ },
|
|
51334
|
+
{ },
|
|
51335
|
+
null,
|
|
51336
|
+
['PureCloud OAuth'],
|
|
51337
|
+
['application/json'],
|
|
51338
|
+
['application/json']
|
|
51339
|
+
);
|
|
51340
|
+
}
|
|
51341
|
+
|
|
50795
51342
|
/**
|
|
50796
51343
|
* Get a list of time off requests for a given user
|
|
50797
51344
|
*
|
|
@@ -51225,6 +51772,31 @@ class WorkforceManagementApi {
|
|
|
51225
51772
|
);
|
|
51226
51773
|
}
|
|
51227
51774
|
|
|
51775
|
+
/**
|
|
51776
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
51777
|
+
*
|
|
51778
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
51779
|
+
*/
|
|
51780
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
51781
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
51782
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
51783
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
51784
|
+
}
|
|
51785
|
+
|
|
51786
|
+
return this.apiClient.callApi(
|
|
51787
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
51788
|
+
'GET',
|
|
51789
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
51790
|
+
{ },
|
|
51791
|
+
{ },
|
|
51792
|
+
{ },
|
|
51793
|
+
null,
|
|
51794
|
+
['PureCloud OAuth'],
|
|
51795
|
+
['application/json'],
|
|
51796
|
+
['application/json']
|
|
51797
|
+
);
|
|
51798
|
+
}
|
|
51799
|
+
|
|
51228
51800
|
/**
|
|
51229
51801
|
* Get a list of time off requests for the current user
|
|
51230
51802
|
*
|
|
@@ -51443,6 +52015,74 @@ class WorkforceManagementApi {
|
|
|
51443
52015
|
);
|
|
51444
52016
|
}
|
|
51445
52017
|
|
|
52018
|
+
/**
|
|
52019
|
+
* Updates a time off limit object.
|
|
52020
|
+
* Updates time off limit object properties, but not daily values.
|
|
52021
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
52022
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
52023
|
+
* @param {Object} opts Optional parameters
|
|
52024
|
+
* @param {Object} opts.body body
|
|
52025
|
+
*/
|
|
52026
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
52027
|
+
opts = opts || {};
|
|
52028
|
+
|
|
52029
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52030
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52031
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
52032
|
+
}
|
|
52033
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
52034
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
52035
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
52036
|
+
}
|
|
52037
|
+
|
|
52038
|
+
return this.apiClient.callApi(
|
|
52039
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
52040
|
+
'PATCH',
|
|
52041
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
52042
|
+
{ },
|
|
52043
|
+
{ },
|
|
52044
|
+
{ },
|
|
52045
|
+
opts['body'],
|
|
52046
|
+
['PureCloud OAuth'],
|
|
52047
|
+
['application/json'],
|
|
52048
|
+
['application/json']
|
|
52049
|
+
);
|
|
52050
|
+
}
|
|
52051
|
+
|
|
52052
|
+
/**
|
|
52053
|
+
* Updates a time off plan
|
|
52054
|
+
*
|
|
52055
|
+
* @param {String} managementUnitId The management unit ID.
|
|
52056
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
52057
|
+
* @param {Object} opts Optional parameters
|
|
52058
|
+
* @param {Object} opts.body body
|
|
52059
|
+
*/
|
|
52060
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
52061
|
+
opts = opts || {};
|
|
52062
|
+
|
|
52063
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52064
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52065
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
52066
|
+
}
|
|
52067
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
52068
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
52069
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
52070
|
+
}
|
|
52071
|
+
|
|
52072
|
+
return this.apiClient.callApi(
|
|
52073
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
52074
|
+
'PATCH',
|
|
52075
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
52076
|
+
{ },
|
|
52077
|
+
{ },
|
|
52078
|
+
{ },
|
|
52079
|
+
opts['body'],
|
|
52080
|
+
['PureCloud OAuth'],
|
|
52081
|
+
['application/json'],
|
|
52082
|
+
['application/json']
|
|
52083
|
+
);
|
|
52084
|
+
}
|
|
52085
|
+
|
|
51446
52086
|
/**
|
|
51447
52087
|
* Update a time off request
|
|
51448
52088
|
*
|
|
@@ -52304,6 +52944,93 @@ class WorkforceManagementApi {
|
|
|
52304
52944
|
);
|
|
52305
52945
|
}
|
|
52306
52946
|
|
|
52947
|
+
/**
|
|
52948
|
+
* Creates a new time off limit object under management unit.
|
|
52949
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
52950
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
52951
|
+
* @param {Object} opts Optional parameters
|
|
52952
|
+
* @param {Object} opts.body body
|
|
52953
|
+
*/
|
|
52954
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
52955
|
+
opts = opts || {};
|
|
52956
|
+
|
|
52957
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52958
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52959
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
52960
|
+
}
|
|
52961
|
+
|
|
52962
|
+
return this.apiClient.callApi(
|
|
52963
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
52964
|
+
'POST',
|
|
52965
|
+
{ 'managementUnitId': managementUnitId },
|
|
52966
|
+
{ },
|
|
52967
|
+
{ },
|
|
52968
|
+
{ },
|
|
52969
|
+
opts['body'],
|
|
52970
|
+
['PureCloud OAuth'],
|
|
52971
|
+
['application/json'],
|
|
52972
|
+
['application/json']
|
|
52973
|
+
);
|
|
52974
|
+
}
|
|
52975
|
+
|
|
52976
|
+
/**
|
|
52977
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
52978
|
+
*
|
|
52979
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
52980
|
+
* @param {Object} opts Optional parameters
|
|
52981
|
+
* @param {Object} opts.body body
|
|
52982
|
+
*/
|
|
52983
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
52984
|
+
opts = opts || {};
|
|
52985
|
+
|
|
52986
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52987
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52988
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
52989
|
+
}
|
|
52990
|
+
|
|
52991
|
+
return this.apiClient.callApi(
|
|
52992
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
52993
|
+
'POST',
|
|
52994
|
+
{ 'managementUnitId': managementUnitId },
|
|
52995
|
+
{ },
|
|
52996
|
+
{ },
|
|
52997
|
+
{ },
|
|
52998
|
+
opts['body'],
|
|
52999
|
+
['PureCloud OAuth'],
|
|
53000
|
+
['application/json'],
|
|
53001
|
+
['application/json']
|
|
53002
|
+
);
|
|
53003
|
+
}
|
|
53004
|
+
|
|
53005
|
+
/**
|
|
53006
|
+
* Creates a new time off plan
|
|
53007
|
+
*
|
|
53008
|
+
* @param {String} managementUnitId The management unit ID.
|
|
53009
|
+
* @param {Object} opts Optional parameters
|
|
53010
|
+
* @param {Object} opts.body body
|
|
53011
|
+
*/
|
|
53012
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
53013
|
+
opts = opts || {};
|
|
53014
|
+
|
|
53015
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53016
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53017
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
53018
|
+
}
|
|
53019
|
+
|
|
53020
|
+
return this.apiClient.callApi(
|
|
53021
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
53022
|
+
'POST',
|
|
53023
|
+
{ 'managementUnitId': managementUnitId },
|
|
53024
|
+
{ },
|
|
53025
|
+
{ },
|
|
53026
|
+
{ },
|
|
53027
|
+
opts['body'],
|
|
53028
|
+
['PureCloud OAuth'],
|
|
53029
|
+
['application/json'],
|
|
53030
|
+
['application/json']
|
|
53031
|
+
);
|
|
53032
|
+
}
|
|
53033
|
+
|
|
52307
53034
|
/**
|
|
52308
53035
|
* Create a new time off request
|
|
52309
53036
|
*
|
|
@@ -52362,6 +53089,35 @@ class WorkforceManagementApi {
|
|
|
52362
53089
|
);
|
|
52363
53090
|
}
|
|
52364
53091
|
|
|
53092
|
+
/**
|
|
53093
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
53094
|
+
*
|
|
53095
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53096
|
+
* @param {Object} opts Optional parameters
|
|
53097
|
+
* @param {Object} opts.body body
|
|
53098
|
+
*/
|
|
53099
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
53100
|
+
opts = opts || {};
|
|
53101
|
+
|
|
53102
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53103
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53104
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
53105
|
+
}
|
|
53106
|
+
|
|
53107
|
+
return this.apiClient.callApi(
|
|
53108
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
53109
|
+
'POST',
|
|
53110
|
+
{ 'managementUnitId': managementUnitId },
|
|
53111
|
+
{ },
|
|
53112
|
+
{ },
|
|
53113
|
+
{ },
|
|
53114
|
+
opts['body'],
|
|
53115
|
+
['PureCloud OAuth'],
|
|
53116
|
+
['application/json'],
|
|
53117
|
+
['application/json']
|
|
53118
|
+
);
|
|
53119
|
+
}
|
|
53120
|
+
|
|
52365
53121
|
/**
|
|
52366
53122
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52367
53123
|
*
|
|
@@ -52745,6 +53501,30 @@ class WorkforceManagementApi {
|
|
|
52745
53501
|
);
|
|
52746
53502
|
}
|
|
52747
53503
|
|
|
53504
|
+
/**
|
|
53505
|
+
* Queries available time off for the current user
|
|
53506
|
+
*
|
|
53507
|
+
* @param {Object} opts Optional parameters
|
|
53508
|
+
* @param {Object} opts.body body
|
|
53509
|
+
*/
|
|
53510
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
53511
|
+
opts = opts || {};
|
|
53512
|
+
|
|
53513
|
+
|
|
53514
|
+
return this.apiClient.callApi(
|
|
53515
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
53516
|
+
'POST',
|
|
53517
|
+
{ },
|
|
53518
|
+
{ },
|
|
53519
|
+
{ },
|
|
53520
|
+
{ },
|
|
53521
|
+
opts['body'],
|
|
53522
|
+
['PureCloud OAuth'],
|
|
53523
|
+
['application/json'],
|
|
53524
|
+
['application/json']
|
|
53525
|
+
);
|
|
53526
|
+
}
|
|
53527
|
+
|
|
52748
53528
|
/**
|
|
52749
53529
|
* Create a time off request for the current user
|
|
52750
53530
|
*
|
|
@@ -52769,6 +53549,40 @@ class WorkforceManagementApi {
|
|
|
52769
53549
|
);
|
|
52770
53550
|
}
|
|
52771
53551
|
|
|
53552
|
+
/**
|
|
53553
|
+
* Sets daily values for a date range of time off limit object
|
|
53554
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
53555
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53556
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
53557
|
+
* @param {Object} opts Optional parameters
|
|
53558
|
+
* @param {Object} opts.body body
|
|
53559
|
+
*/
|
|
53560
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
53561
|
+
opts = opts || {};
|
|
53562
|
+
|
|
53563
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53564
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53565
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
53566
|
+
}
|
|
53567
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
53568
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
53569
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
53570
|
+
}
|
|
53571
|
+
|
|
53572
|
+
return this.apiClient.callApi(
|
|
53573
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
53574
|
+
'PUT',
|
|
53575
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
53576
|
+
{ },
|
|
53577
|
+
{ },
|
|
53578
|
+
{ },
|
|
53579
|
+
opts['body'],
|
|
53580
|
+
['PureCloud OAuth'],
|
|
53581
|
+
['application/json'],
|
|
53582
|
+
['application/json']
|
|
53583
|
+
);
|
|
53584
|
+
}
|
|
53585
|
+
|
|
52772
53586
|
}
|
|
52773
53587
|
|
|
52774
53588
|
/**
|
|
@@ -52800,7 +53614,7 @@ class WorkforceManagementApi {
|
|
|
52800
53614
|
* </pre>
|
|
52801
53615
|
* </p>
|
|
52802
53616
|
* @module purecloud-platform-client-v2/index
|
|
52803
|
-
* @version
|
|
53617
|
+
* @version 126.0.0
|
|
52804
53618
|
*/
|
|
52805
53619
|
class platformClient {
|
|
52806
53620
|
constructor() {
|
|
@@ -53104,6 +53918,11 @@ class platformClient {
|
|
|
53104
53918
|
* @property {module:purecloud-platform-client-v2/api/WebDeploymentsApi}
|
|
53105
53919
|
*/
|
|
53106
53920
|
this.WebDeploymentsApi = WebDeploymentsApi;
|
|
53921
|
+
/**
|
|
53922
|
+
* The WebMessagingApi service constructor.
|
|
53923
|
+
* @property {module:purecloud-platform-client-v2/api/WebMessagingApi}
|
|
53924
|
+
*/
|
|
53925
|
+
this.WebMessagingApi = WebMessagingApi;
|
|
53107
53926
|
/**
|
|
53108
53927
|
* The WidgetsApi service constructor.
|
|
53109
53928
|
* @property {module:purecloud-platform-client-v2/api/WidgetsApi}
|