purecloud-platform-client-v2 124.0.0 → 127.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 +936 -138
- package/dist/web-amd/purecloud-platform-client-v2.js +936 -138
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +896 -142
- package/dist/web-cjs/purecloud-platform-client-v2.js +909 -1305
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +403 -36
- 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 +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/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 +1 -1
- 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 +1 -1
- 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 +7 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +21 -10
- 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 +116 -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 +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 +473 -1
- package/src/purecloud-platform-client-v2/configuration.js +42 -35
- package/src/purecloud-platform-client-v2/index.js +1 -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
|
-
|
|
2206
|
-
try {
|
|
2207
|
-
var configparser = new ConfigParser();
|
|
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 127.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': '127.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 127.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 127.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 127.0.0
|
|
4820
4758
|
*/
|
|
4821
4759
|
|
|
4822
4760
|
/**
|
|
@@ -7812,7 +7750,7 @@ class AuditApi {
|
|
|
7812
7750
|
/**
|
|
7813
7751
|
* Audit service.
|
|
7814
7752
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7815
|
-
* @version
|
|
7753
|
+
* @version 127.0.0
|
|
7816
7754
|
*/
|
|
7817
7755
|
|
|
7818
7756
|
/**
|
|
@@ -7983,7 +7921,7 @@ class AuthorizationApi {
|
|
|
7983
7921
|
/**
|
|
7984
7922
|
* Authorization service.
|
|
7985
7923
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7986
|
-
* @version
|
|
7924
|
+
* @version 127.0.0
|
|
7987
7925
|
*/
|
|
7988
7926
|
|
|
7989
7927
|
/**
|
|
@@ -9166,7 +9104,7 @@ class BillingApi {
|
|
|
9166
9104
|
/**
|
|
9167
9105
|
* Billing service.
|
|
9168
9106
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9169
|
-
* @version
|
|
9107
|
+
* @version 127.0.0
|
|
9170
9108
|
*/
|
|
9171
9109
|
|
|
9172
9110
|
/**
|
|
@@ -9246,7 +9184,7 @@ class ChatApi {
|
|
|
9246
9184
|
/**
|
|
9247
9185
|
* Chat service.
|
|
9248
9186
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9249
|
-
* @version
|
|
9187
|
+
* @version 127.0.0
|
|
9250
9188
|
*/
|
|
9251
9189
|
|
|
9252
9190
|
/**
|
|
@@ -9337,7 +9275,7 @@ class CoachingApi {
|
|
|
9337
9275
|
/**
|
|
9338
9276
|
* Coaching service.
|
|
9339
9277
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9340
|
-
* @version
|
|
9278
|
+
* @version 127.0.0
|
|
9341
9279
|
*/
|
|
9342
9280
|
|
|
9343
9281
|
/**
|
|
@@ -9912,7 +9850,7 @@ class ContentManagementApi {
|
|
|
9912
9850
|
/**
|
|
9913
9851
|
* ContentManagement service.
|
|
9914
9852
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9915
|
-
* @version
|
|
9853
|
+
* @version 127.0.0
|
|
9916
9854
|
*/
|
|
9917
9855
|
|
|
9918
9856
|
/**
|
|
@@ -11052,7 +10990,7 @@ class ConversationsApi {
|
|
|
11052
10990
|
/**
|
|
11053
10991
|
* Conversations service.
|
|
11054
10992
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11055
|
-
* @version
|
|
10993
|
+
* @version 127.0.0
|
|
11056
10994
|
*/
|
|
11057
10995
|
|
|
11058
10996
|
/**
|
|
@@ -15441,7 +15379,7 @@ class DataExtensionsApi {
|
|
|
15441
15379
|
/**
|
|
15442
15380
|
* DataExtensions service.
|
|
15443
15381
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15444
|
-
* @version
|
|
15382
|
+
* @version 127.0.0
|
|
15445
15383
|
*/
|
|
15446
15384
|
|
|
15447
15385
|
/**
|
|
@@ -15527,7 +15465,7 @@ class ExternalContactsApi {
|
|
|
15527
15465
|
/**
|
|
15528
15466
|
* ExternalContacts service.
|
|
15529
15467
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15530
|
-
* @version
|
|
15468
|
+
* @version 127.0.0
|
|
15531
15469
|
*/
|
|
15532
15470
|
|
|
15533
15471
|
/**
|
|
@@ -17270,7 +17208,7 @@ class FaxApi {
|
|
|
17270
17208
|
/**
|
|
17271
17209
|
* Fax service.
|
|
17272
17210
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17273
|
-
* @version
|
|
17211
|
+
* @version 127.0.0
|
|
17274
17212
|
*/
|
|
17275
17213
|
|
|
17276
17214
|
/**
|
|
@@ -17441,7 +17379,7 @@ class FlowsApi {
|
|
|
17441
17379
|
/**
|
|
17442
17380
|
* Flows service.
|
|
17443
17381
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17444
|
-
* @version
|
|
17382
|
+
* @version 127.0.0
|
|
17445
17383
|
*/
|
|
17446
17384
|
|
|
17447
17385
|
/**
|
|
@@ -17512,7 +17450,7 @@ class GamificationApi {
|
|
|
17512
17450
|
/**
|
|
17513
17451
|
* Gamification service.
|
|
17514
17452
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17515
|
-
* @version
|
|
17453
|
+
* @version 127.0.0
|
|
17516
17454
|
*/
|
|
17517
17455
|
|
|
17518
17456
|
/**
|
|
@@ -18818,7 +18756,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18818
18756
|
/**
|
|
18819
18757
|
* GeneralDataProtectionRegulation service.
|
|
18820
18758
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18821
|
-
* @version
|
|
18759
|
+
* @version 127.0.0
|
|
18822
18760
|
*/
|
|
18823
18761
|
|
|
18824
18762
|
/**
|
|
@@ -18948,7 +18886,7 @@ class GeolocationApi {
|
|
|
18948
18886
|
/**
|
|
18949
18887
|
* Geolocation service.
|
|
18950
18888
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18951
|
-
* @version
|
|
18889
|
+
* @version 127.0.0
|
|
18952
18890
|
*/
|
|
18953
18891
|
|
|
18954
18892
|
/**
|
|
@@ -19079,7 +19017,7 @@ class GreetingsApi {
|
|
|
19079
19017
|
/**
|
|
19080
19018
|
* Greetings service.
|
|
19081
19019
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19082
|
-
* @version
|
|
19020
|
+
* @version 127.0.0
|
|
19083
19021
|
*/
|
|
19084
19022
|
|
|
19085
19023
|
/**
|
|
@@ -19534,7 +19472,7 @@ class GroupsApi {
|
|
|
19534
19472
|
/**
|
|
19535
19473
|
* Groups service.
|
|
19536
19474
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19537
|
-
* @version
|
|
19475
|
+
* @version 127.0.0
|
|
19538
19476
|
*/
|
|
19539
19477
|
|
|
19540
19478
|
/**
|
|
@@ -19939,7 +19877,7 @@ class IdentityProviderApi {
|
|
|
19939
19877
|
/**
|
|
19940
19878
|
* IdentityProvider service.
|
|
19941
19879
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19942
|
-
* @version
|
|
19880
|
+
* @version 127.0.0
|
|
19943
19881
|
*/
|
|
19944
19882
|
|
|
19945
19883
|
/**
|
|
@@ -20695,7 +20633,7 @@ class IntegrationsApi {
|
|
|
20695
20633
|
/**
|
|
20696
20634
|
* Integrations service.
|
|
20697
20635
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20698
|
-
* @version
|
|
20636
|
+
* @version 127.0.0
|
|
20699
20637
|
*/
|
|
20700
20638
|
|
|
20701
20639
|
/**
|
|
@@ -22341,7 +22279,7 @@ class JourneyApi {
|
|
|
22341
22279
|
/**
|
|
22342
22280
|
* Journey service.
|
|
22343
22281
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22344
|
-
* @version
|
|
22282
|
+
* @version 127.0.0
|
|
22345
22283
|
*/
|
|
22346
22284
|
|
|
22347
22285
|
/**
|
|
@@ -23052,7 +22990,7 @@ class KnowledgeApi {
|
|
|
23052
22990
|
/**
|
|
23053
22991
|
* Knowledge service.
|
|
23054
22992
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23055
|
-
* @version
|
|
22993
|
+
* @version 127.0.0
|
|
23056
22994
|
*/
|
|
23057
22995
|
|
|
23058
22996
|
/**
|
|
@@ -23952,7 +23890,7 @@ class LanguageUnderstandingApi {
|
|
|
23952
23890
|
/**
|
|
23953
23891
|
* LanguageUnderstanding service.
|
|
23954
23892
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
23955
|
-
* @version
|
|
23893
|
+
* @version 127.0.0
|
|
23956
23894
|
*/
|
|
23957
23895
|
|
|
23958
23896
|
/**
|
|
@@ -24518,7 +24456,7 @@ class LanguageUnderstandingApi {
|
|
|
24518
24456
|
}
|
|
24519
24457
|
|
|
24520
24458
|
/**
|
|
24521
|
-
* Save information for the draft
|
|
24459
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
24522
24460
|
*
|
|
24523
24461
|
* @param {String} minerId Miner ID
|
|
24524
24462
|
* @param {String} draftId Draft ID
|
|
@@ -24762,7 +24700,7 @@ class LanguageUnderstandingApi {
|
|
|
24762
24700
|
}
|
|
24763
24701
|
|
|
24764
24702
|
/**
|
|
24765
|
-
* 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.
|
|
24766
24704
|
*
|
|
24767
24705
|
* @param {String} minerId Miner ID
|
|
24768
24706
|
* @param {Object} opts Optional parameters
|
|
@@ -24856,7 +24794,7 @@ class LanguagesApi {
|
|
|
24856
24794
|
/**
|
|
24857
24795
|
* Languages service.
|
|
24858
24796
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24859
|
-
* @version
|
|
24797
|
+
* @version 127.0.0
|
|
24860
24798
|
*/
|
|
24861
24799
|
|
|
24862
24800
|
/**
|
|
@@ -25124,7 +25062,7 @@ class LearningApi {
|
|
|
25124
25062
|
/**
|
|
25125
25063
|
* Learning service.
|
|
25126
25064
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25127
|
-
* @version
|
|
25065
|
+
* @version 127.0.0
|
|
25128
25066
|
*/
|
|
25129
25067
|
|
|
25130
25068
|
/**
|
|
@@ -25715,7 +25653,7 @@ class LicenseApi {
|
|
|
25715
25653
|
/**
|
|
25716
25654
|
* License service.
|
|
25717
25655
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
25718
|
-
* @version
|
|
25656
|
+
* @version 127.0.0
|
|
25719
25657
|
*/
|
|
25720
25658
|
|
|
25721
25659
|
/**
|
|
@@ -25953,7 +25891,7 @@ class LocationsApi {
|
|
|
25953
25891
|
/**
|
|
25954
25892
|
* Locations service.
|
|
25955
25893
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25956
|
-
* @version
|
|
25894
|
+
* @version 127.0.0
|
|
25957
25895
|
*/
|
|
25958
25896
|
|
|
25959
25897
|
/**
|
|
@@ -26189,7 +26127,7 @@ class MobileDevicesApi {
|
|
|
26189
26127
|
/**
|
|
26190
26128
|
* MobileDevices service.
|
|
26191
26129
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
26192
|
-
* @version
|
|
26130
|
+
* @version 127.0.0
|
|
26193
26131
|
*/
|
|
26194
26132
|
|
|
26195
26133
|
/**
|
|
@@ -26340,7 +26278,7 @@ class NotificationsApi {
|
|
|
26340
26278
|
/**
|
|
26341
26279
|
* Notifications service.
|
|
26342
26280
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
26343
|
-
* @version
|
|
26281
|
+
* @version 127.0.0
|
|
26344
26282
|
*/
|
|
26345
26283
|
|
|
26346
26284
|
/**
|
|
@@ -26565,7 +26503,7 @@ class OAuthApi {
|
|
|
26565
26503
|
/**
|
|
26566
26504
|
* OAuth service.
|
|
26567
26505
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
26568
|
-
* @version
|
|
26506
|
+
* @version 127.0.0
|
|
26569
26507
|
*/
|
|
26570
26508
|
|
|
26571
26509
|
/**
|
|
@@ -26923,7 +26861,7 @@ class ObjectsApi {
|
|
|
26923
26861
|
/**
|
|
26924
26862
|
* Objects service.
|
|
26925
26863
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26926
|
-
* @version
|
|
26864
|
+
* @version 127.0.0
|
|
26927
26865
|
*/
|
|
26928
26866
|
|
|
26929
26867
|
/**
|
|
@@ -27194,7 +27132,7 @@ class OrganizationApi {
|
|
|
27194
27132
|
/**
|
|
27195
27133
|
* Organization service.
|
|
27196
27134
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
27197
|
-
* @version
|
|
27135
|
+
* @version 127.0.0
|
|
27198
27136
|
*/
|
|
27199
27137
|
|
|
27200
27138
|
/**
|
|
@@ -27597,7 +27535,7 @@ class OrganizationAuthorizationApi {
|
|
|
27597
27535
|
/**
|
|
27598
27536
|
* OrganizationAuthorization service.
|
|
27599
27537
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
27600
|
-
* @version
|
|
27538
|
+
* @version 127.0.0
|
|
27601
27539
|
*/
|
|
27602
27540
|
|
|
27603
27541
|
/**
|
|
@@ -27637,6 +27575,36 @@ class OrganizationAuthorizationApi {
|
|
|
27637
27575
|
);
|
|
27638
27576
|
}
|
|
27639
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
|
+
|
|
27640
27608
|
/**
|
|
27641
27609
|
* Delete Trustee User
|
|
27642
27610
|
*
|
|
@@ -27722,6 +27690,36 @@ class OrganizationAuthorizationApi {
|
|
|
27722
27690
|
);
|
|
27723
27691
|
}
|
|
27724
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
|
+
|
|
27725
27723
|
/**
|
|
27726
27724
|
* Delete Trustee User
|
|
27727
27725
|
*
|
|
@@ -27802,6 +27800,31 @@ class OrganizationAuthorizationApi {
|
|
|
27802
27800
|
);
|
|
27803
27801
|
}
|
|
27804
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
|
+
|
|
27805
27828
|
/**
|
|
27806
27829
|
* Get Trustee User
|
|
27807
27830
|
*
|
|
@@ -27917,6 +27940,26 @@ class OrganizationAuthorizationApi {
|
|
|
27917
27940
|
);
|
|
27918
27941
|
}
|
|
27919
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
|
+
|
|
27920
27963
|
/**
|
|
27921
27964
|
* Get Org Trust
|
|
27922
27965
|
*
|
|
@@ -27942,6 +27985,61 @@ class OrganizationAuthorizationApi {
|
|
|
27942
27985
|
);
|
|
27943
27986
|
}
|
|
27944
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
|
+
|
|
27945
28043
|
/**
|
|
27946
28044
|
* Get Trustee User
|
|
27947
28045
|
*
|
|
@@ -28139,6 +28237,31 @@ class OrganizationAuthorizationApi {
|
|
|
28139
28237
|
);
|
|
28140
28238
|
}
|
|
28141
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
|
+
|
|
28142
28265
|
/**
|
|
28143
28266
|
* Get Org Trustor Audits
|
|
28144
28267
|
*
|
|
@@ -28271,6 +28394,36 @@ class OrganizationAuthorizationApi {
|
|
|
28271
28394
|
);
|
|
28272
28395
|
}
|
|
28273
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
|
+
|
|
28274
28427
|
/**
|
|
28275
28428
|
* Add a Trustee user to the trust.
|
|
28276
28429
|
*
|
|
@@ -28307,7 +28460,7 @@ class OutboundApi {
|
|
|
28307
28460
|
/**
|
|
28308
28461
|
* Outbound service.
|
|
28309
28462
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
28310
|
-
* @version
|
|
28463
|
+
* @version 127.0.0
|
|
28311
28464
|
*/
|
|
28312
28465
|
|
|
28313
28466
|
/**
|
|
@@ -31333,7 +31486,7 @@ class PresenceApi {
|
|
|
31333
31486
|
/**
|
|
31334
31487
|
* Presence service.
|
|
31335
31488
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
31336
|
-
* @version
|
|
31489
|
+
* @version 127.0.0
|
|
31337
31490
|
*/
|
|
31338
31491
|
|
|
31339
31492
|
/**
|
|
@@ -31705,7 +31858,7 @@ class QualityApi {
|
|
|
31705
31858
|
/**
|
|
31706
31859
|
* Quality service.
|
|
31707
31860
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31708
|
-
* @version
|
|
31861
|
+
* @version 127.0.0
|
|
31709
31862
|
*/
|
|
31710
31863
|
|
|
31711
31864
|
/**
|
|
@@ -32078,7 +32231,7 @@ class QualityApi {
|
|
|
32078
32231
|
|
|
32079
32232
|
/**
|
|
32080
32233
|
* Queries Evaluations and returns a paged list
|
|
32081
|
-
* 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.
|
|
32082
32235
|
* @param {Object} opts Optional parameters
|
|
32083
32236
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
32084
32237
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -33233,7 +33386,7 @@ class RecordingApi {
|
|
|
33233
33386
|
/**
|
|
33234
33387
|
* Recording service.
|
|
33235
33388
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
33236
|
-
* @version
|
|
33389
|
+
* @version 127.0.0
|
|
33237
33390
|
*/
|
|
33238
33391
|
|
|
33239
33392
|
/**
|
|
@@ -33829,6 +33982,8 @@ class RecordingApi {
|
|
|
33829
33982
|
* @param {Object} opts Optional parameters
|
|
33830
33983
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
33831
33984
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33985
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
33986
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
33832
33987
|
*/
|
|
33833
33988
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
33834
33989
|
opts = opts || {};
|
|
@@ -33842,7 +33997,7 @@ class RecordingApi {
|
|
|
33842
33997
|
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
33843
33998
|
'GET',
|
|
33844
33999
|
{ 'jobId': jobId },
|
|
33845
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
34000
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
33846
34001
|
{ },
|
|
33847
34002
|
{ },
|
|
33848
34003
|
null,
|
|
@@ -33862,6 +34017,8 @@ class RecordingApi {
|
|
|
33862
34017
|
* @param {Object} opts.state Filter by state
|
|
33863
34018
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
33864
34019
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
34020
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
34021
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
33865
34022
|
*/
|
|
33866
34023
|
getRecordingJobs(opts) {
|
|
33867
34024
|
opts = opts || {};
|
|
@@ -33871,7 +34028,7 @@ class RecordingApi {
|
|
|
33871
34028
|
'/api/v2/recording/jobs',
|
|
33872
34029
|
'GET',
|
|
33873
34030
|
{ },
|
|
33874
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'] },
|
|
34031
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
33875
34032
|
{ },
|
|
33876
34033
|
{ },
|
|
33877
34034
|
null,
|
|
@@ -34752,7 +34909,7 @@ class ResponseManagementApi {
|
|
|
34752
34909
|
/**
|
|
34753
34910
|
* ResponseManagement service.
|
|
34754
34911
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34755
|
-
* @version
|
|
34912
|
+
* @version 127.0.0
|
|
34756
34913
|
*/
|
|
34757
34914
|
|
|
34758
34915
|
/**
|
|
@@ -35077,7 +35234,7 @@ class RoutingApi {
|
|
|
35077
35234
|
/**
|
|
35078
35235
|
* Routing service.
|
|
35079
35236
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
35080
|
-
* @version
|
|
35237
|
+
* @version 127.0.0
|
|
35081
35238
|
*/
|
|
35082
35239
|
|
|
35083
35240
|
/**
|
|
@@ -35390,8 +35547,12 @@ class RoutingApi {
|
|
|
35390
35547
|
* Delete a phone number provisioned for SMS.
|
|
35391
35548
|
*
|
|
35392
35549
|
* @param {String} addressId Address ID
|
|
35550
|
+
* @param {Object} opts Optional parameters
|
|
35551
|
+
* @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)
|
|
35393
35552
|
*/
|
|
35394
|
-
deleteRoutingSmsPhonenumber(addressId) {
|
|
35553
|
+
deleteRoutingSmsPhonenumber(addressId, opts) {
|
|
35554
|
+
opts = opts || {};
|
|
35555
|
+
|
|
35395
35556
|
// verify the required parameter 'addressId' is set
|
|
35396
35557
|
if (addressId === undefined || addressId === null) {
|
|
35397
35558
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -35401,7 +35562,7 @@ class RoutingApi {
|
|
|
35401
35562
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
35402
35563
|
'DELETE',
|
|
35403
35564
|
{ 'addressId': addressId },
|
|
35404
|
-
{
|
|
35565
|
+
{ 'async': opts['async'] },
|
|
35405
35566
|
{ },
|
|
35406
35567
|
{ },
|
|
35407
35568
|
null,
|
|
@@ -36229,12 +36390,11 @@ class RoutingApi {
|
|
|
36229
36390
|
}
|
|
36230
36391
|
|
|
36231
36392
|
/**
|
|
36232
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
36393
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
36233
36394
|
*
|
|
36234
36395
|
* @param {Object} opts Optional parameters
|
|
36235
36396
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
36236
36397
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
36237
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
36238
36398
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
36239
36399
|
*/
|
|
36240
36400
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -36245,7 +36405,7 @@ class RoutingApi {
|
|
|
36245
36405
|
'/api/v2/routing/queues/divisionviews/all',
|
|
36246
36406
|
'GET',
|
|
36247
36407
|
{ },
|
|
36248
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
36408
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
36249
36409
|
{ },
|
|
36250
36410
|
{ },
|
|
36251
36411
|
null,
|
|
@@ -37548,8 +37708,12 @@ class RoutingApi {
|
|
|
37548
37708
|
* Provision a phone number for SMS
|
|
37549
37709
|
*
|
|
37550
37710
|
* @param {Object} body SmsPhoneNumber
|
|
37711
|
+
* @param {Object} opts Optional parameters
|
|
37712
|
+
* @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)
|
|
37551
37713
|
*/
|
|
37552
|
-
postRoutingSmsPhonenumbers(body) {
|
|
37714
|
+
postRoutingSmsPhonenumbers(body, opts) {
|
|
37715
|
+
opts = opts || {};
|
|
37716
|
+
|
|
37553
37717
|
// verify the required parameter 'body' is set
|
|
37554
37718
|
if (body === undefined || body === null) {
|
|
37555
37719
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -37559,7 +37723,7 @@ class RoutingApi {
|
|
|
37559
37723
|
'/api/v2/routing/sms/phonenumbers',
|
|
37560
37724
|
'POST',
|
|
37561
37725
|
{ },
|
|
37562
|
-
{
|
|
37726
|
+
{ 'async': opts['async'] },
|
|
37563
37727
|
{ },
|
|
37564
37728
|
{ },
|
|
37565
37729
|
body,
|
|
@@ -37804,8 +37968,12 @@ class RoutingApi {
|
|
|
37804
37968
|
*
|
|
37805
37969
|
* @param {String} addressId Address ID
|
|
37806
37970
|
* @param {Object} body SmsPhoneNumber
|
|
37971
|
+
* @param {Object} opts Optional parameters
|
|
37972
|
+
* @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)
|
|
37807
37973
|
*/
|
|
37808
|
-
putRoutingSmsPhonenumber(addressId, body) {
|
|
37974
|
+
putRoutingSmsPhonenumber(addressId, body, opts) {
|
|
37975
|
+
opts = opts || {};
|
|
37976
|
+
|
|
37809
37977
|
// verify the required parameter 'addressId' is set
|
|
37810
37978
|
if (addressId === undefined || addressId === null) {
|
|
37811
37979
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -37819,7 +37987,7 @@ class RoutingApi {
|
|
|
37819
37987
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
37820
37988
|
'PUT',
|
|
37821
37989
|
{ 'addressId': addressId },
|
|
37822
|
-
{
|
|
37990
|
+
{ 'async': opts['async'] },
|
|
37823
37991
|
{ },
|
|
37824
37992
|
{ },
|
|
37825
37993
|
body,
|
|
@@ -37985,7 +38153,7 @@ class SCIMApi {
|
|
|
37985
38153
|
/**
|
|
37986
38154
|
* SCIM service.
|
|
37987
38155
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37988
|
-
* @version
|
|
38156
|
+
* @version 127.0.0
|
|
37989
38157
|
*/
|
|
37990
38158
|
|
|
37991
38159
|
/**
|
|
@@ -38862,7 +39030,7 @@ class ScriptsApi {
|
|
|
38862
39030
|
/**
|
|
38863
39031
|
* Scripts service.
|
|
38864
39032
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38865
|
-
* @version
|
|
39033
|
+
* @version 127.0.0
|
|
38866
39034
|
*/
|
|
38867
39035
|
|
|
38868
39036
|
/**
|
|
@@ -39215,7 +39383,7 @@ class SearchApi {
|
|
|
39215
39383
|
/**
|
|
39216
39384
|
* Search service.
|
|
39217
39385
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39218
|
-
* @version
|
|
39386
|
+
* @version 127.0.0
|
|
39219
39387
|
*/
|
|
39220
39388
|
|
|
39221
39389
|
/**
|
|
@@ -39750,7 +39918,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39750
39918
|
/**
|
|
39751
39919
|
* SpeechTextAnalytics service.
|
|
39752
39920
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39753
|
-
* @version
|
|
39921
|
+
* @version 127.0.0
|
|
39754
39922
|
*/
|
|
39755
39923
|
|
|
39756
39924
|
/**
|
|
@@ -39794,6 +39962,51 @@ class SpeechTextAnalyticsApi {
|
|
|
39794
39962
|
);
|
|
39795
39963
|
}
|
|
39796
39964
|
|
|
39965
|
+
/**
|
|
39966
|
+
* Delete All Speech & Text Analytics SentimentFeedback
|
|
39967
|
+
*
|
|
39968
|
+
*/
|
|
39969
|
+
deleteSpeechandtextanalyticsSentimentfeedback() {
|
|
39970
|
+
|
|
39971
|
+
return this.apiClient.callApi(
|
|
39972
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
39973
|
+
'DELETE',
|
|
39974
|
+
{ },
|
|
39975
|
+
{ },
|
|
39976
|
+
{ },
|
|
39977
|
+
{ },
|
|
39978
|
+
null,
|
|
39979
|
+
['PureCloud OAuth'],
|
|
39980
|
+
['application/json'],
|
|
39981
|
+
['application/json']
|
|
39982
|
+
);
|
|
39983
|
+
}
|
|
39984
|
+
|
|
39985
|
+
/**
|
|
39986
|
+
* Delete a Speech & Text Analytics SentimentFeedback by Id
|
|
39987
|
+
*
|
|
39988
|
+
* @param {String} sentimentFeedbackId The Id of the SentimentFeedback
|
|
39989
|
+
*/
|
|
39990
|
+
deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId) {
|
|
39991
|
+
// verify the required parameter 'sentimentFeedbackId' is set
|
|
39992
|
+
if (sentimentFeedbackId === undefined || sentimentFeedbackId === null) {
|
|
39993
|
+
throw 'Missing the required parameter "sentimentFeedbackId" when calling deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId';
|
|
39994
|
+
}
|
|
39995
|
+
|
|
39996
|
+
return this.apiClient.callApi(
|
|
39997
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}',
|
|
39998
|
+
'DELETE',
|
|
39999
|
+
{ 'sentimentFeedbackId': sentimentFeedbackId },
|
|
40000
|
+
{ },
|
|
40001
|
+
{ },
|
|
40002
|
+
{ },
|
|
40003
|
+
null,
|
|
40004
|
+
['PureCloud OAuth'],
|
|
40005
|
+
['application/json'],
|
|
40006
|
+
['application/json']
|
|
40007
|
+
);
|
|
40008
|
+
}
|
|
40009
|
+
|
|
39797
40010
|
/**
|
|
39798
40011
|
* Delete a Speech & Text Analytics topic by id
|
|
39799
40012
|
*
|
|
@@ -39876,7 +40089,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39876
40089
|
|
|
39877
40090
|
/**
|
|
39878
40091
|
* Get list of supported Speech & Text Analytics dialects
|
|
39879
|
-
*
|
|
40092
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
39880
40093
|
*/
|
|
39881
40094
|
getSpeechandtextanalyticsDialects() {
|
|
39882
40095
|
|
|
@@ -40069,6 +40282,50 @@ class SpeechTextAnalyticsApi {
|
|
|
40069
40282
|
);
|
|
40070
40283
|
}
|
|
40071
40284
|
|
|
40285
|
+
/**
|
|
40286
|
+
* Get the list of Speech & Text Analytics sentiment supported dialects
|
|
40287
|
+
*
|
|
40288
|
+
*/
|
|
40289
|
+
getSpeechandtextanalyticsSentimentDialects() {
|
|
40290
|
+
|
|
40291
|
+
return this.apiClient.callApi(
|
|
40292
|
+
'/api/v2/speechandtextanalytics/sentiment/dialects',
|
|
40293
|
+
'GET',
|
|
40294
|
+
{ },
|
|
40295
|
+
{ },
|
|
40296
|
+
{ },
|
|
40297
|
+
{ },
|
|
40298
|
+
null,
|
|
40299
|
+
['PureCloud OAuth'],
|
|
40300
|
+
['application/json'],
|
|
40301
|
+
['application/json']
|
|
40302
|
+
);
|
|
40303
|
+
}
|
|
40304
|
+
|
|
40305
|
+
/**
|
|
40306
|
+
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
40307
|
+
*
|
|
40308
|
+
* @param {Object} opts Optional parameters
|
|
40309
|
+
* @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
|
|
40310
|
+
*/
|
|
40311
|
+
getSpeechandtextanalyticsSentimentfeedback(opts) {
|
|
40312
|
+
opts = opts || {};
|
|
40313
|
+
|
|
40314
|
+
|
|
40315
|
+
return this.apiClient.callApi(
|
|
40316
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
40317
|
+
'GET',
|
|
40318
|
+
{ },
|
|
40319
|
+
{ 'dialect': opts['dialect'] },
|
|
40320
|
+
{ },
|
|
40321
|
+
{ },
|
|
40322
|
+
null,
|
|
40323
|
+
['PureCloud OAuth'],
|
|
40324
|
+
['application/json'],
|
|
40325
|
+
['application/json']
|
|
40326
|
+
);
|
|
40327
|
+
}
|
|
40328
|
+
|
|
40072
40329
|
/**
|
|
40073
40330
|
* Get Speech And Text Analytics Settings
|
|
40074
40331
|
*
|
|
@@ -40313,6 +40570,31 @@ class SpeechTextAnalyticsApi {
|
|
|
40313
40570
|
);
|
|
40314
40571
|
}
|
|
40315
40572
|
|
|
40573
|
+
/**
|
|
40574
|
+
* Create a Speech & Text Analytics SentimentFeedback
|
|
40575
|
+
*
|
|
40576
|
+
* @param {Object} body The SentimentFeedback to create
|
|
40577
|
+
*/
|
|
40578
|
+
postSpeechandtextanalyticsSentimentfeedback(body) {
|
|
40579
|
+
// verify the required parameter 'body' is set
|
|
40580
|
+
if (body === undefined || body === null) {
|
|
40581
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsSentimentfeedback';
|
|
40582
|
+
}
|
|
40583
|
+
|
|
40584
|
+
return this.apiClient.callApi(
|
|
40585
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
40586
|
+
'POST',
|
|
40587
|
+
{ },
|
|
40588
|
+
{ },
|
|
40589
|
+
{ },
|
|
40590
|
+
{ },
|
|
40591
|
+
body,
|
|
40592
|
+
['PureCloud OAuth'],
|
|
40593
|
+
['application/json'],
|
|
40594
|
+
['application/json']
|
|
40595
|
+
);
|
|
40596
|
+
}
|
|
40597
|
+
|
|
40316
40598
|
/**
|
|
40317
40599
|
* Create new Speech & Text Analytics topic
|
|
40318
40600
|
*
|
|
@@ -40509,7 +40791,7 @@ class StationsApi {
|
|
|
40509
40791
|
/**
|
|
40510
40792
|
* Stations service.
|
|
40511
40793
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40512
|
-
* @version
|
|
40794
|
+
* @version 127.0.0
|
|
40513
40795
|
*/
|
|
40514
40796
|
|
|
40515
40797
|
/**
|
|
@@ -40656,7 +40938,7 @@ class SuggestApi {
|
|
|
40656
40938
|
/**
|
|
40657
40939
|
* Suggest service.
|
|
40658
40940
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40659
|
-
* @version
|
|
40941
|
+
* @version 127.0.0
|
|
40660
40942
|
*/
|
|
40661
40943
|
|
|
40662
40944
|
/**
|
|
@@ -40795,7 +41077,7 @@ class TelephonyApi {
|
|
|
40795
41077
|
/**
|
|
40796
41078
|
* Telephony service.
|
|
40797
41079
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40798
|
-
* @version
|
|
41080
|
+
* @version 127.0.0
|
|
40799
41081
|
*/
|
|
40800
41082
|
|
|
40801
41083
|
/**
|
|
@@ -40903,7 +41185,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
40903
41185
|
/**
|
|
40904
41186
|
* TelephonyProvidersEdge service.
|
|
40905
41187
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40906
|
-
* @version
|
|
41188
|
+
* @version 127.0.0
|
|
40907
41189
|
*/
|
|
40908
41190
|
|
|
40909
41191
|
/**
|
|
@@ -44516,7 +44798,7 @@ class TextbotsApi {
|
|
|
44516
44798
|
/**
|
|
44517
44799
|
* Textbots service.
|
|
44518
44800
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44519
|
-
* @version
|
|
44801
|
+
* @version 127.0.0
|
|
44520
44802
|
*/
|
|
44521
44803
|
|
|
44522
44804
|
/**
|
|
@@ -44617,7 +44899,7 @@ class TokensApi {
|
|
|
44617
44899
|
/**
|
|
44618
44900
|
* Tokens service.
|
|
44619
44901
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44620
|
-
* @version
|
|
44902
|
+
* @version 127.0.0
|
|
44621
44903
|
*/
|
|
44622
44904
|
|
|
44623
44905
|
/**
|
|
@@ -44723,7 +45005,7 @@ class UploadsApi {
|
|
|
44723
45005
|
/**
|
|
44724
45006
|
* Uploads service.
|
|
44725
45007
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44726
|
-
* @version
|
|
45008
|
+
* @version 127.0.0
|
|
44727
45009
|
*/
|
|
44728
45010
|
|
|
44729
45011
|
/**
|
|
@@ -44899,7 +45181,7 @@ class UsageApi {
|
|
|
44899
45181
|
/**
|
|
44900
45182
|
* Usage service.
|
|
44901
45183
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44902
|
-
* @version
|
|
45184
|
+
* @version 127.0.0
|
|
44903
45185
|
*/
|
|
44904
45186
|
|
|
44905
45187
|
/**
|
|
@@ -44970,7 +45252,7 @@ class UserRecordingsApi {
|
|
|
44970
45252
|
/**
|
|
44971
45253
|
* UserRecordings service.
|
|
44972
45254
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44973
|
-
* @version
|
|
45255
|
+
* @version 127.0.0
|
|
44974
45256
|
*/
|
|
44975
45257
|
|
|
44976
45258
|
/**
|
|
@@ -45154,7 +45436,7 @@ class UsersApi {
|
|
|
45154
45436
|
/**
|
|
45155
45437
|
* Users service.
|
|
45156
45438
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45157
|
-
* @version
|
|
45439
|
+
* @version 127.0.0
|
|
45158
45440
|
*/
|
|
45159
45441
|
|
|
45160
45442
|
/**
|
|
@@ -47456,7 +47738,7 @@ class UtilitiesApi {
|
|
|
47456
47738
|
/**
|
|
47457
47739
|
* Utilities service.
|
|
47458
47740
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47459
|
-
* @version
|
|
47741
|
+
* @version 127.0.0
|
|
47460
47742
|
*/
|
|
47461
47743
|
|
|
47462
47744
|
/**
|
|
@@ -47567,7 +47849,7 @@ class VoicemailApi {
|
|
|
47567
47849
|
/**
|
|
47568
47850
|
* Voicemail service.
|
|
47569
47851
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47570
|
-
* @version
|
|
47852
|
+
* @version 127.0.0
|
|
47571
47853
|
*/
|
|
47572
47854
|
|
|
47573
47855
|
/**
|
|
@@ -48234,7 +48516,7 @@ class WebChatApi {
|
|
|
48234
48516
|
/**
|
|
48235
48517
|
* WebChat service.
|
|
48236
48518
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48237
|
-
* @version
|
|
48519
|
+
* @version 127.0.0
|
|
48238
48520
|
*/
|
|
48239
48521
|
|
|
48240
48522
|
/**
|
|
@@ -48778,7 +49060,7 @@ class WebDeploymentsApi {
|
|
|
48778
49060
|
/**
|
|
48779
49061
|
* WebDeployments service.
|
|
48780
49062
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48781
|
-
* @version
|
|
49063
|
+
* @version 127.0.0
|
|
48782
49064
|
*/
|
|
48783
49065
|
|
|
48784
49066
|
/**
|
|
@@ -49133,7 +49415,7 @@ class WebMessagingApi {
|
|
|
49133
49415
|
/**
|
|
49134
49416
|
* WebMessaging service.
|
|
49135
49417
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49136
|
-
* @version
|
|
49418
|
+
* @version 127.0.0
|
|
49137
49419
|
*/
|
|
49138
49420
|
|
|
49139
49421
|
/**
|
|
@@ -49179,7 +49461,7 @@ class WidgetsApi {
|
|
|
49179
49461
|
/**
|
|
49180
49462
|
* Widgets service.
|
|
49181
49463
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49182
|
-
* @version
|
|
49464
|
+
* @version 127.0.0
|
|
49183
49465
|
*/
|
|
49184
49466
|
|
|
49185
49467
|
/**
|
|
@@ -49325,7 +49607,7 @@ class WorkforceManagementApi {
|
|
|
49325
49607
|
/**
|
|
49326
49608
|
* WorkforceManagement service.
|
|
49327
49609
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49328
|
-
* @version
|
|
49610
|
+
* @version 127.0.0
|
|
49329
49611
|
*/
|
|
49330
49612
|
|
|
49331
49613
|
/**
|
|
@@ -49600,6 +49882,66 @@ class WorkforceManagementApi {
|
|
|
49600
49882
|
);
|
|
49601
49883
|
}
|
|
49602
49884
|
|
|
49885
|
+
/**
|
|
49886
|
+
* Deletes a time off limit object
|
|
49887
|
+
*
|
|
49888
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49889
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
49890
|
+
*/
|
|
49891
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49892
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49893
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49894
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
49895
|
+
}
|
|
49896
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49897
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49898
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
49899
|
+
}
|
|
49900
|
+
|
|
49901
|
+
return this.apiClient.callApi(
|
|
49902
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49903
|
+
'DELETE',
|
|
49904
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49905
|
+
{ },
|
|
49906
|
+
{ },
|
|
49907
|
+
{ },
|
|
49908
|
+
null,
|
|
49909
|
+
['PureCloud OAuth'],
|
|
49910
|
+
['application/json'],
|
|
49911
|
+
['application/json']
|
|
49912
|
+
);
|
|
49913
|
+
}
|
|
49914
|
+
|
|
49915
|
+
/**
|
|
49916
|
+
* Deletes a time off plan
|
|
49917
|
+
*
|
|
49918
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49919
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
49920
|
+
*/
|
|
49921
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49922
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49923
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49924
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
49925
|
+
}
|
|
49926
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49927
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49928
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
49929
|
+
}
|
|
49930
|
+
|
|
49931
|
+
return this.apiClient.callApi(
|
|
49932
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49933
|
+
'DELETE',
|
|
49934
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49935
|
+
{ },
|
|
49936
|
+
{ },
|
|
49937
|
+
{ },
|
|
49938
|
+
null,
|
|
49939
|
+
['PureCloud OAuth'],
|
|
49940
|
+
['application/json'],
|
|
49941
|
+
['application/json']
|
|
49942
|
+
);
|
|
49943
|
+
}
|
|
49944
|
+
|
|
49603
49945
|
/**
|
|
49604
49946
|
* Delete a work plan
|
|
49605
49947
|
*
|
|
@@ -50841,6 +51183,116 @@ class WorkforceManagementApi {
|
|
|
50841
51183
|
);
|
|
50842
51184
|
}
|
|
50843
51185
|
|
|
51186
|
+
/**
|
|
51187
|
+
* Gets a time off limit object
|
|
51188
|
+
* Returns properties of time off limit object, but not daily values.
|
|
51189
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51190
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
51191
|
+
*/
|
|
51192
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
51193
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51194
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51195
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
51196
|
+
}
|
|
51197
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51198
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51199
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
51200
|
+
}
|
|
51201
|
+
|
|
51202
|
+
return this.apiClient.callApi(
|
|
51203
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
51204
|
+
'GET',
|
|
51205
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51206
|
+
{ },
|
|
51207
|
+
{ },
|
|
51208
|
+
{ },
|
|
51209
|
+
null,
|
|
51210
|
+
['PureCloud OAuth'],
|
|
51211
|
+
['application/json'],
|
|
51212
|
+
['application/json']
|
|
51213
|
+
);
|
|
51214
|
+
}
|
|
51215
|
+
|
|
51216
|
+
/**
|
|
51217
|
+
* Gets a list of time off limit objects under management unit.
|
|
51218
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
51219
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51220
|
+
*/
|
|
51221
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
51222
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51223
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51224
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
51225
|
+
}
|
|
51226
|
+
|
|
51227
|
+
return this.apiClient.callApi(
|
|
51228
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51229
|
+
'GET',
|
|
51230
|
+
{ 'managementUnitId': managementUnitId },
|
|
51231
|
+
{ },
|
|
51232
|
+
{ },
|
|
51233
|
+
{ },
|
|
51234
|
+
null,
|
|
51235
|
+
['PureCloud OAuth'],
|
|
51236
|
+
['application/json'],
|
|
51237
|
+
['application/json']
|
|
51238
|
+
);
|
|
51239
|
+
}
|
|
51240
|
+
|
|
51241
|
+
/**
|
|
51242
|
+
* Gets a time off plan
|
|
51243
|
+
*
|
|
51244
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51245
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
51246
|
+
*/
|
|
51247
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
51248
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51249
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51250
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
51251
|
+
}
|
|
51252
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
51253
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
51254
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
51255
|
+
}
|
|
51256
|
+
|
|
51257
|
+
return this.apiClient.callApi(
|
|
51258
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
51259
|
+
'GET',
|
|
51260
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
51261
|
+
{ },
|
|
51262
|
+
{ },
|
|
51263
|
+
{ },
|
|
51264
|
+
null,
|
|
51265
|
+
['PureCloud OAuth'],
|
|
51266
|
+
['application/json'],
|
|
51267
|
+
['application/json']
|
|
51268
|
+
);
|
|
51269
|
+
}
|
|
51270
|
+
|
|
51271
|
+
/**
|
|
51272
|
+
* Gets a list of time off plans
|
|
51273
|
+
*
|
|
51274
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51275
|
+
*/
|
|
51276
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
51277
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51278
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51279
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
51280
|
+
}
|
|
51281
|
+
|
|
51282
|
+
return this.apiClient.callApi(
|
|
51283
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51284
|
+
'GET',
|
|
51285
|
+
{ 'managementUnitId': managementUnitId },
|
|
51286
|
+
{ },
|
|
51287
|
+
{ },
|
|
51288
|
+
{ },
|
|
51289
|
+
null,
|
|
51290
|
+
['PureCloud OAuth'],
|
|
51291
|
+
['application/json'],
|
|
51292
|
+
['application/json']
|
|
51293
|
+
);
|
|
51294
|
+
}
|
|
51295
|
+
|
|
50844
51296
|
/**
|
|
50845
51297
|
* Get a time off request
|
|
50846
51298
|
*
|
|
@@ -50876,6 +51328,41 @@ class WorkforceManagementApi {
|
|
|
50876
51328
|
);
|
|
50877
51329
|
}
|
|
50878
51330
|
|
|
51331
|
+
/**
|
|
51332
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
51333
|
+
*
|
|
51334
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51335
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
51336
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
51337
|
+
*/
|
|
51338
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
51339
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51340
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51341
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51342
|
+
}
|
|
51343
|
+
// verify the required parameter 'userId' is set
|
|
51344
|
+
if (userId === undefined || userId === null) {
|
|
51345
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51346
|
+
}
|
|
51347
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
51348
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
51349
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
51350
|
+
}
|
|
51351
|
+
|
|
51352
|
+
return this.apiClient.callApi(
|
|
51353
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
51354
|
+
'GET',
|
|
51355
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
51356
|
+
{ },
|
|
51357
|
+
{ },
|
|
51358
|
+
{ },
|
|
51359
|
+
null,
|
|
51360
|
+
['PureCloud OAuth'],
|
|
51361
|
+
['application/json'],
|
|
51362
|
+
['application/json']
|
|
51363
|
+
);
|
|
51364
|
+
}
|
|
51365
|
+
|
|
50879
51366
|
/**
|
|
50880
51367
|
* Get a list of time off requests for a given user
|
|
50881
51368
|
*
|
|
@@ -51309,6 +51796,31 @@ class WorkforceManagementApi {
|
|
|
51309
51796
|
);
|
|
51310
51797
|
}
|
|
51311
51798
|
|
|
51799
|
+
/**
|
|
51800
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
51801
|
+
*
|
|
51802
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
51803
|
+
*/
|
|
51804
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
51805
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
51806
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
51807
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
51808
|
+
}
|
|
51809
|
+
|
|
51810
|
+
return this.apiClient.callApi(
|
|
51811
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
51812
|
+
'GET',
|
|
51813
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
51814
|
+
{ },
|
|
51815
|
+
{ },
|
|
51816
|
+
{ },
|
|
51817
|
+
null,
|
|
51818
|
+
['PureCloud OAuth'],
|
|
51819
|
+
['application/json'],
|
|
51820
|
+
['application/json']
|
|
51821
|
+
);
|
|
51822
|
+
}
|
|
51823
|
+
|
|
51312
51824
|
/**
|
|
51313
51825
|
* Get a list of time off requests for the current user
|
|
51314
51826
|
*
|
|
@@ -51527,6 +52039,74 @@ class WorkforceManagementApi {
|
|
|
51527
52039
|
);
|
|
51528
52040
|
}
|
|
51529
52041
|
|
|
52042
|
+
/**
|
|
52043
|
+
* Updates a time off limit object.
|
|
52044
|
+
* Updates time off limit object properties, but not daily values.
|
|
52045
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
52046
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
52047
|
+
* @param {Object} opts Optional parameters
|
|
52048
|
+
* @param {Object} opts.body body
|
|
52049
|
+
*/
|
|
52050
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
52051
|
+
opts = opts || {};
|
|
52052
|
+
|
|
52053
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52054
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52055
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
52056
|
+
}
|
|
52057
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
52058
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
52059
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
52060
|
+
}
|
|
52061
|
+
|
|
52062
|
+
return this.apiClient.callApi(
|
|
52063
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
52064
|
+
'PATCH',
|
|
52065
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
52066
|
+
{ },
|
|
52067
|
+
{ },
|
|
52068
|
+
{ },
|
|
52069
|
+
opts['body'],
|
|
52070
|
+
['PureCloud OAuth'],
|
|
52071
|
+
['application/json'],
|
|
52072
|
+
['application/json']
|
|
52073
|
+
);
|
|
52074
|
+
}
|
|
52075
|
+
|
|
52076
|
+
/**
|
|
52077
|
+
* Updates a time off plan
|
|
52078
|
+
*
|
|
52079
|
+
* @param {String} managementUnitId The management unit ID.
|
|
52080
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
52081
|
+
* @param {Object} opts Optional parameters
|
|
52082
|
+
* @param {Object} opts.body body
|
|
52083
|
+
*/
|
|
52084
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
52085
|
+
opts = opts || {};
|
|
52086
|
+
|
|
52087
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52088
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52089
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
52090
|
+
}
|
|
52091
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
52092
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
52093
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
52094
|
+
}
|
|
52095
|
+
|
|
52096
|
+
return this.apiClient.callApi(
|
|
52097
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
52098
|
+
'PATCH',
|
|
52099
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
52100
|
+
{ },
|
|
52101
|
+
{ },
|
|
52102
|
+
{ },
|
|
52103
|
+
opts['body'],
|
|
52104
|
+
['PureCloud OAuth'],
|
|
52105
|
+
['application/json'],
|
|
52106
|
+
['application/json']
|
|
52107
|
+
);
|
|
52108
|
+
}
|
|
52109
|
+
|
|
51530
52110
|
/**
|
|
51531
52111
|
* Update a time off request
|
|
51532
52112
|
*
|
|
@@ -52388,6 +52968,93 @@ class WorkforceManagementApi {
|
|
|
52388
52968
|
);
|
|
52389
52969
|
}
|
|
52390
52970
|
|
|
52971
|
+
/**
|
|
52972
|
+
* Creates a new time off limit object under management unit.
|
|
52973
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
52974
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
52975
|
+
* @param {Object} opts Optional parameters
|
|
52976
|
+
* @param {Object} opts.body body
|
|
52977
|
+
*/
|
|
52978
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
52979
|
+
opts = opts || {};
|
|
52980
|
+
|
|
52981
|
+
// verify the required parameter 'managementUnitId' is set
|
|
52982
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
52983
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
52984
|
+
}
|
|
52985
|
+
|
|
52986
|
+
return this.apiClient.callApi(
|
|
52987
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
52988
|
+
'POST',
|
|
52989
|
+
{ 'managementUnitId': managementUnitId },
|
|
52990
|
+
{ },
|
|
52991
|
+
{ },
|
|
52992
|
+
{ },
|
|
52993
|
+
opts['body'],
|
|
52994
|
+
['PureCloud OAuth'],
|
|
52995
|
+
['application/json'],
|
|
52996
|
+
['application/json']
|
|
52997
|
+
);
|
|
52998
|
+
}
|
|
52999
|
+
|
|
53000
|
+
/**
|
|
53001
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
53002
|
+
*
|
|
53003
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53004
|
+
* @param {Object} opts Optional parameters
|
|
53005
|
+
* @param {Object} opts.body body
|
|
53006
|
+
*/
|
|
53007
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
53008
|
+
opts = opts || {};
|
|
53009
|
+
|
|
53010
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53011
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53012
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
53013
|
+
}
|
|
53014
|
+
|
|
53015
|
+
return this.apiClient.callApi(
|
|
53016
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
53017
|
+
'POST',
|
|
53018
|
+
{ 'managementUnitId': managementUnitId },
|
|
53019
|
+
{ },
|
|
53020
|
+
{ },
|
|
53021
|
+
{ },
|
|
53022
|
+
opts['body'],
|
|
53023
|
+
['PureCloud OAuth'],
|
|
53024
|
+
['application/json'],
|
|
53025
|
+
['application/json']
|
|
53026
|
+
);
|
|
53027
|
+
}
|
|
53028
|
+
|
|
53029
|
+
/**
|
|
53030
|
+
* Creates a new time off plan
|
|
53031
|
+
*
|
|
53032
|
+
* @param {String} managementUnitId The management unit ID.
|
|
53033
|
+
* @param {Object} opts Optional parameters
|
|
53034
|
+
* @param {Object} opts.body body
|
|
53035
|
+
*/
|
|
53036
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
53037
|
+
opts = opts || {};
|
|
53038
|
+
|
|
53039
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53040
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53041
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
53042
|
+
}
|
|
53043
|
+
|
|
53044
|
+
return this.apiClient.callApi(
|
|
53045
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
53046
|
+
'POST',
|
|
53047
|
+
{ 'managementUnitId': managementUnitId },
|
|
53048
|
+
{ },
|
|
53049
|
+
{ },
|
|
53050
|
+
{ },
|
|
53051
|
+
opts['body'],
|
|
53052
|
+
['PureCloud OAuth'],
|
|
53053
|
+
['application/json'],
|
|
53054
|
+
['application/json']
|
|
53055
|
+
);
|
|
53056
|
+
}
|
|
53057
|
+
|
|
52391
53058
|
/**
|
|
52392
53059
|
* Create a new time off request
|
|
52393
53060
|
*
|
|
@@ -52446,6 +53113,35 @@ class WorkforceManagementApi {
|
|
|
52446
53113
|
);
|
|
52447
53114
|
}
|
|
52448
53115
|
|
|
53116
|
+
/**
|
|
53117
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
53118
|
+
*
|
|
53119
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53120
|
+
* @param {Object} opts Optional parameters
|
|
53121
|
+
* @param {Object} opts.body body
|
|
53122
|
+
*/
|
|
53123
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
53124
|
+
opts = opts || {};
|
|
53125
|
+
|
|
53126
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53127
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53128
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
53129
|
+
}
|
|
53130
|
+
|
|
53131
|
+
return this.apiClient.callApi(
|
|
53132
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
53133
|
+
'POST',
|
|
53134
|
+
{ 'managementUnitId': managementUnitId },
|
|
53135
|
+
{ },
|
|
53136
|
+
{ },
|
|
53137
|
+
{ },
|
|
53138
|
+
opts['body'],
|
|
53139
|
+
['PureCloud OAuth'],
|
|
53140
|
+
['application/json'],
|
|
53141
|
+
['application/json']
|
|
53142
|
+
);
|
|
53143
|
+
}
|
|
53144
|
+
|
|
52449
53145
|
/**
|
|
52450
53146
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52451
53147
|
*
|
|
@@ -52829,6 +53525,30 @@ class WorkforceManagementApi {
|
|
|
52829
53525
|
);
|
|
52830
53526
|
}
|
|
52831
53527
|
|
|
53528
|
+
/**
|
|
53529
|
+
* Queries available time off for the current user
|
|
53530
|
+
*
|
|
53531
|
+
* @param {Object} opts Optional parameters
|
|
53532
|
+
* @param {Object} opts.body body
|
|
53533
|
+
*/
|
|
53534
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
53535
|
+
opts = opts || {};
|
|
53536
|
+
|
|
53537
|
+
|
|
53538
|
+
return this.apiClient.callApi(
|
|
53539
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
53540
|
+
'POST',
|
|
53541
|
+
{ },
|
|
53542
|
+
{ },
|
|
53543
|
+
{ },
|
|
53544
|
+
{ },
|
|
53545
|
+
opts['body'],
|
|
53546
|
+
['PureCloud OAuth'],
|
|
53547
|
+
['application/json'],
|
|
53548
|
+
['application/json']
|
|
53549
|
+
);
|
|
53550
|
+
}
|
|
53551
|
+
|
|
52832
53552
|
/**
|
|
52833
53553
|
* Create a time off request for the current user
|
|
52834
53554
|
*
|
|
@@ -52853,6 +53573,40 @@ class WorkforceManagementApi {
|
|
|
52853
53573
|
);
|
|
52854
53574
|
}
|
|
52855
53575
|
|
|
53576
|
+
/**
|
|
53577
|
+
* Sets daily values for a date range of time off limit object
|
|
53578
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
53579
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
53580
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
53581
|
+
* @param {Object} opts Optional parameters
|
|
53582
|
+
* @param {Object} opts.body body
|
|
53583
|
+
*/
|
|
53584
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
53585
|
+
opts = opts || {};
|
|
53586
|
+
|
|
53587
|
+
// verify the required parameter 'managementUnitId' is set
|
|
53588
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
53589
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
53590
|
+
}
|
|
53591
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
53592
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
53593
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
53594
|
+
}
|
|
53595
|
+
|
|
53596
|
+
return this.apiClient.callApi(
|
|
53597
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
53598
|
+
'PUT',
|
|
53599
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
53600
|
+
{ },
|
|
53601
|
+
{ },
|
|
53602
|
+
{ },
|
|
53603
|
+
opts['body'],
|
|
53604
|
+
['PureCloud OAuth'],
|
|
53605
|
+
['application/json'],
|
|
53606
|
+
['application/json']
|
|
53607
|
+
);
|
|
53608
|
+
}
|
|
53609
|
+
|
|
52856
53610
|
}
|
|
52857
53611
|
|
|
52858
53612
|
/**
|
|
@@ -52884,7 +53638,7 @@ class WorkforceManagementApi {
|
|
|
52884
53638
|
* </pre>
|
|
52885
53639
|
* </p>
|
|
52886
53640
|
* @module purecloud-platform-client-v2/index
|
|
52887
|
-
* @version
|
|
53641
|
+
* @version 127.0.0
|
|
52888
53642
|
*/
|
|
52889
53643
|
class platformClient {
|
|
52890
53644
|
constructor() {
|