purecloud-platform-client-v2 222.0.0 → 224.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1863 -540
- package/dist/web-amd/purecloud-platform-client-v2.js +1863 -540
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +745 -410
- package/dist/web-cjs/purecloud-platform-client-v2.js +745 -410
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1681 -998
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +387 -0
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +4 -2
- 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/BusinessRulesApi.js +52 -8
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.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 +327 -16
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +89 -2
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +176 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +71 -8
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +51 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +43 -2
- 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 +31 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
- 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 +524 -421
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -687,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
687
|
|
|
688
688
|
/**
|
|
689
689
|
* @module purecloud-platform-client-v2/ApiClient
|
|
690
|
-
* @version
|
|
690
|
+
* @version 224.0.0
|
|
691
691
|
*/
|
|
692
692
|
class ApiClient {
|
|
693
693
|
/**
|
|
@@ -2227,11 +2227,393 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2227
2227
|
}
|
|
2228
2228
|
}
|
|
2229
2229
|
|
|
2230
|
+
class AIStudioApi {
|
|
2231
|
+
/**
|
|
2232
|
+
* AIStudio service.
|
|
2233
|
+
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2234
|
+
* @version 224.0.0
|
|
2235
|
+
*/
|
|
2236
|
+
|
|
2237
|
+
/**
|
|
2238
|
+
* Constructs a new AIStudioApi.
|
|
2239
|
+
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
2240
|
+
* @class
|
|
2241
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
2242
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
2243
|
+
*/
|
|
2244
|
+
constructor(apiClient) {
|
|
2245
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
2246
|
+
}
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
/**
|
|
2250
|
+
* Start the deletion of a guide.
|
|
2251
|
+
*
|
|
2252
|
+
* @param {String} guideId Guide ID
|
|
2253
|
+
* deleteGuideJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2254
|
+
*/
|
|
2255
|
+
deleteGuideJobs(guideId) {
|
|
2256
|
+
// verify the required parameter 'guideId' is set
|
|
2257
|
+
if (guideId === undefined || guideId === null) {
|
|
2258
|
+
throw 'Missing the required parameter "guideId" when calling deleteGuideJobs';
|
|
2259
|
+
}
|
|
2260
|
+
|
|
2261
|
+
return this.apiClient.callApi(
|
|
2262
|
+
'/api/v2/guides/{guideId}/jobs',
|
|
2263
|
+
'DELETE',
|
|
2264
|
+
{ 'guideId': guideId },
|
|
2265
|
+
{ },
|
|
2266
|
+
{ },
|
|
2267
|
+
{ },
|
|
2268
|
+
null,
|
|
2269
|
+
['PureCloud OAuth'],
|
|
2270
|
+
['application/json'],
|
|
2271
|
+
['application/json']
|
|
2272
|
+
);
|
|
2273
|
+
}
|
|
2274
|
+
|
|
2275
|
+
/**
|
|
2276
|
+
* Get guide.
|
|
2277
|
+
*
|
|
2278
|
+
* @param {String} guideId Guide ID
|
|
2279
|
+
* getGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2280
|
+
*/
|
|
2281
|
+
getGuide(guideId) {
|
|
2282
|
+
// verify the required parameter 'guideId' is set
|
|
2283
|
+
if (guideId === undefined || guideId === null) {
|
|
2284
|
+
throw 'Missing the required parameter "guideId" when calling getGuide';
|
|
2285
|
+
}
|
|
2286
|
+
|
|
2287
|
+
return this.apiClient.callApi(
|
|
2288
|
+
'/api/v2/guides/{guideId}',
|
|
2289
|
+
'GET',
|
|
2290
|
+
{ 'guideId': guideId },
|
|
2291
|
+
{ },
|
|
2292
|
+
{ },
|
|
2293
|
+
{ },
|
|
2294
|
+
null,
|
|
2295
|
+
['PureCloud OAuth'],
|
|
2296
|
+
['application/json'],
|
|
2297
|
+
['application/json']
|
|
2298
|
+
);
|
|
2299
|
+
}
|
|
2300
|
+
|
|
2301
|
+
/**
|
|
2302
|
+
* Get the specified guide deletion job.
|
|
2303
|
+
*
|
|
2304
|
+
* @param {String} guideId Guide ID
|
|
2305
|
+
* @param {String} jobId jobId
|
|
2306
|
+
* getGuideJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2307
|
+
*/
|
|
2308
|
+
getGuideJob(guideId, jobId) {
|
|
2309
|
+
// verify the required parameter 'guideId' is set
|
|
2310
|
+
if (guideId === undefined || guideId === null) {
|
|
2311
|
+
throw 'Missing the required parameter "guideId" when calling getGuideJob';
|
|
2312
|
+
}
|
|
2313
|
+
// verify the required parameter 'jobId' is set
|
|
2314
|
+
if (jobId === undefined || jobId === null) {
|
|
2315
|
+
throw 'Missing the required parameter "jobId" when calling getGuideJob';
|
|
2316
|
+
}
|
|
2317
|
+
|
|
2318
|
+
return this.apiClient.callApi(
|
|
2319
|
+
'/api/v2/guides/{guideId}/jobs/{jobId}',
|
|
2320
|
+
'GET',
|
|
2321
|
+
{ 'guideId': guideId,'jobId': jobId },
|
|
2322
|
+
{ },
|
|
2323
|
+
{ },
|
|
2324
|
+
{ },
|
|
2325
|
+
null,
|
|
2326
|
+
['PureCloud OAuth'],
|
|
2327
|
+
['application/json'],
|
|
2328
|
+
['application/json']
|
|
2329
|
+
);
|
|
2330
|
+
}
|
|
2331
|
+
|
|
2332
|
+
/**
|
|
2333
|
+
* Get a guide version.
|
|
2334
|
+
*
|
|
2335
|
+
* @param {String} guideId Guide ID
|
|
2336
|
+
* @param {String} versionId Version ID
|
|
2337
|
+
* getGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2338
|
+
*/
|
|
2339
|
+
getGuideVersion(guideId, versionId) {
|
|
2340
|
+
// verify the required parameter 'guideId' is set
|
|
2341
|
+
if (guideId === undefined || guideId === null) {
|
|
2342
|
+
throw 'Missing the required parameter "guideId" when calling getGuideVersion';
|
|
2343
|
+
}
|
|
2344
|
+
// verify the required parameter 'versionId' is set
|
|
2345
|
+
if (versionId === undefined || versionId === null) {
|
|
2346
|
+
throw 'Missing the required parameter "versionId" when calling getGuideVersion';
|
|
2347
|
+
}
|
|
2348
|
+
|
|
2349
|
+
return this.apiClient.callApi(
|
|
2350
|
+
'/api/v2/guides/{guideId}/versions/{versionId}',
|
|
2351
|
+
'GET',
|
|
2352
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
2353
|
+
{ },
|
|
2354
|
+
{ },
|
|
2355
|
+
{ },
|
|
2356
|
+
null,
|
|
2357
|
+
['PureCloud OAuth'],
|
|
2358
|
+
['application/json'],
|
|
2359
|
+
['application/json']
|
|
2360
|
+
);
|
|
2361
|
+
}
|
|
2362
|
+
|
|
2363
|
+
/**
|
|
2364
|
+
* Get the status of the publishing job for this guide version.
|
|
2365
|
+
*
|
|
2366
|
+
* @param {String} guideId Guide ID
|
|
2367
|
+
* @param {String} versionId Version ID
|
|
2368
|
+
* @param {String} jobId jobId
|
|
2369
|
+
* getGuideVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2370
|
+
*/
|
|
2371
|
+
getGuideVersionJob(guideId, versionId, jobId) {
|
|
2372
|
+
// verify the required parameter 'guideId' is set
|
|
2373
|
+
if (guideId === undefined || guideId === null) {
|
|
2374
|
+
throw 'Missing the required parameter "guideId" when calling getGuideVersionJob';
|
|
2375
|
+
}
|
|
2376
|
+
// verify the required parameter 'versionId' is set
|
|
2377
|
+
if (versionId === undefined || versionId === null) {
|
|
2378
|
+
throw 'Missing the required parameter "versionId" when calling getGuideVersionJob';
|
|
2379
|
+
}
|
|
2380
|
+
// verify the required parameter 'jobId' is set
|
|
2381
|
+
if (jobId === undefined || jobId === null) {
|
|
2382
|
+
throw 'Missing the required parameter "jobId" when calling getGuideVersionJob';
|
|
2383
|
+
}
|
|
2384
|
+
|
|
2385
|
+
return this.apiClient.callApi(
|
|
2386
|
+
'/api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId}',
|
|
2387
|
+
'GET',
|
|
2388
|
+
{ 'guideId': guideId,'versionId': versionId,'jobId': jobId },
|
|
2389
|
+
{ },
|
|
2390
|
+
{ },
|
|
2391
|
+
{ },
|
|
2392
|
+
null,
|
|
2393
|
+
['PureCloud OAuth'],
|
|
2394
|
+
['application/json'],
|
|
2395
|
+
['application/json']
|
|
2396
|
+
);
|
|
2397
|
+
}
|
|
2398
|
+
|
|
2399
|
+
/**
|
|
2400
|
+
* Get all guides.
|
|
2401
|
+
*
|
|
2402
|
+
* @param {Object} opts Optional parameters
|
|
2403
|
+
* @param {String} opts.name Filter by matching name - case insensitive.
|
|
2404
|
+
* @param {String} opts.nameContains Filter by name contains - case insensitive.
|
|
2405
|
+
* @param {Object} opts.status Filter by status.
|
|
2406
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2407
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2408
|
+
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2409
|
+
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
2410
|
+
* getGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2411
|
+
*/
|
|
2412
|
+
getGuides(opts) {
|
|
2413
|
+
opts = opts || {};
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
return this.apiClient.callApi(
|
|
2417
|
+
'/api/v2/guides',
|
|
2418
|
+
'GET',
|
|
2419
|
+
{ },
|
|
2420
|
+
{ 'name': opts['name'],'nameContains': opts['nameContains'],'status': opts['status'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
2421
|
+
{ },
|
|
2422
|
+
{ },
|
|
2423
|
+
null,
|
|
2424
|
+
['PureCloud OAuth'],
|
|
2425
|
+
['application/json'],
|
|
2426
|
+
['application/json']
|
|
2427
|
+
);
|
|
2428
|
+
}
|
|
2429
|
+
|
|
2430
|
+
/**
|
|
2431
|
+
* Get the status of the guide content generation job.
|
|
2432
|
+
*
|
|
2433
|
+
* @param {String} jobId jobId
|
|
2434
|
+
* getGuidesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2435
|
+
*/
|
|
2436
|
+
getGuidesJob(jobId) {
|
|
2437
|
+
// verify the required parameter 'jobId' is set
|
|
2438
|
+
if (jobId === undefined || jobId === null) {
|
|
2439
|
+
throw 'Missing the required parameter "jobId" when calling getGuidesJob';
|
|
2440
|
+
}
|
|
2441
|
+
|
|
2442
|
+
return this.apiClient.callApi(
|
|
2443
|
+
'/api/v2/guides/jobs/{jobId}',
|
|
2444
|
+
'GET',
|
|
2445
|
+
{ 'jobId': jobId },
|
|
2446
|
+
{ },
|
|
2447
|
+
{ },
|
|
2448
|
+
{ },
|
|
2449
|
+
null,
|
|
2450
|
+
['PureCloud OAuth'],
|
|
2451
|
+
['application/json'],
|
|
2452
|
+
['application/json']
|
|
2453
|
+
);
|
|
2454
|
+
}
|
|
2455
|
+
|
|
2456
|
+
/**
|
|
2457
|
+
* Update a guide version.
|
|
2458
|
+
*
|
|
2459
|
+
* @param {String} guideId Guide ID
|
|
2460
|
+
* @param {String} versionId Version ID
|
|
2461
|
+
* @param {Object} body
|
|
2462
|
+
* patchGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2463
|
+
*/
|
|
2464
|
+
patchGuideVersion(guideId, versionId, body) {
|
|
2465
|
+
// verify the required parameter 'guideId' is set
|
|
2466
|
+
if (guideId === undefined || guideId === null) {
|
|
2467
|
+
throw 'Missing the required parameter "guideId" when calling patchGuideVersion';
|
|
2468
|
+
}
|
|
2469
|
+
// verify the required parameter 'versionId' is set
|
|
2470
|
+
if (versionId === undefined || versionId === null) {
|
|
2471
|
+
throw 'Missing the required parameter "versionId" when calling patchGuideVersion';
|
|
2472
|
+
}
|
|
2473
|
+
// verify the required parameter 'body' is set
|
|
2474
|
+
if (body === undefined || body === null) {
|
|
2475
|
+
throw 'Missing the required parameter "body" when calling patchGuideVersion';
|
|
2476
|
+
}
|
|
2477
|
+
|
|
2478
|
+
return this.apiClient.callApi(
|
|
2479
|
+
'/api/v2/guides/{guideId}/versions/{versionId}',
|
|
2480
|
+
'PATCH',
|
|
2481
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
2482
|
+
{ },
|
|
2483
|
+
{ },
|
|
2484
|
+
{ },
|
|
2485
|
+
body,
|
|
2486
|
+
['PureCloud OAuth'],
|
|
2487
|
+
['application/json'],
|
|
2488
|
+
['application/json']
|
|
2489
|
+
);
|
|
2490
|
+
}
|
|
2491
|
+
|
|
2492
|
+
/**
|
|
2493
|
+
* Start the publishing of a guide version.
|
|
2494
|
+
*
|
|
2495
|
+
* @param {String} guideId Guide ID
|
|
2496
|
+
* @param {String} versionId Version ID
|
|
2497
|
+
* @param {Object} body
|
|
2498
|
+
* postGuideVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2499
|
+
*/
|
|
2500
|
+
postGuideVersionJobs(guideId, versionId, body) {
|
|
2501
|
+
// verify the required parameter 'guideId' is set
|
|
2502
|
+
if (guideId === undefined || guideId === null) {
|
|
2503
|
+
throw 'Missing the required parameter "guideId" when calling postGuideVersionJobs';
|
|
2504
|
+
}
|
|
2505
|
+
// verify the required parameter 'versionId' is set
|
|
2506
|
+
if (versionId === undefined || versionId === null) {
|
|
2507
|
+
throw 'Missing the required parameter "versionId" when calling postGuideVersionJobs';
|
|
2508
|
+
}
|
|
2509
|
+
// verify the required parameter 'body' is set
|
|
2510
|
+
if (body === undefined || body === null) {
|
|
2511
|
+
throw 'Missing the required parameter "body" when calling postGuideVersionJobs';
|
|
2512
|
+
}
|
|
2513
|
+
|
|
2514
|
+
return this.apiClient.callApi(
|
|
2515
|
+
'/api/v2/guides/{guideId}/versions/{versionId}/jobs',
|
|
2516
|
+
'POST',
|
|
2517
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
2518
|
+
{ },
|
|
2519
|
+
{ },
|
|
2520
|
+
{ },
|
|
2521
|
+
body,
|
|
2522
|
+
['PureCloud OAuth'],
|
|
2523
|
+
['application/json'],
|
|
2524
|
+
['application/json']
|
|
2525
|
+
);
|
|
2526
|
+
}
|
|
2527
|
+
|
|
2528
|
+
/**
|
|
2529
|
+
* Create a guide version.
|
|
2530
|
+
*
|
|
2531
|
+
* @param {String} guideId Guide ID
|
|
2532
|
+
* @param {Object} opts Optional parameters
|
|
2533
|
+
* @param {Object} opts.body
|
|
2534
|
+
* postGuideVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2535
|
+
*/
|
|
2536
|
+
postGuideVersions(guideId, opts) {
|
|
2537
|
+
opts = opts || {};
|
|
2538
|
+
|
|
2539
|
+
// verify the required parameter 'guideId' is set
|
|
2540
|
+
if (guideId === undefined || guideId === null) {
|
|
2541
|
+
throw 'Missing the required parameter "guideId" when calling postGuideVersions';
|
|
2542
|
+
}
|
|
2543
|
+
|
|
2544
|
+
return this.apiClient.callApi(
|
|
2545
|
+
'/api/v2/guides/{guideId}/versions',
|
|
2546
|
+
'POST',
|
|
2547
|
+
{ 'guideId': guideId },
|
|
2548
|
+
{ },
|
|
2549
|
+
{ },
|
|
2550
|
+
{ },
|
|
2551
|
+
opts['body'],
|
|
2552
|
+
['PureCloud OAuth'],
|
|
2553
|
+
['application/json'],
|
|
2554
|
+
['application/json']
|
|
2555
|
+
);
|
|
2556
|
+
}
|
|
2557
|
+
|
|
2558
|
+
/**
|
|
2559
|
+
* Create a guide.
|
|
2560
|
+
*
|
|
2561
|
+
* @param {Object} body
|
|
2562
|
+
* postGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2563
|
+
*/
|
|
2564
|
+
postGuides(body) {
|
|
2565
|
+
// verify the required parameter 'body' is set
|
|
2566
|
+
if (body === undefined || body === null) {
|
|
2567
|
+
throw 'Missing the required parameter "body" when calling postGuides';
|
|
2568
|
+
}
|
|
2569
|
+
|
|
2570
|
+
return this.apiClient.callApi(
|
|
2571
|
+
'/api/v2/guides',
|
|
2572
|
+
'POST',
|
|
2573
|
+
{ },
|
|
2574
|
+
{ },
|
|
2575
|
+
{ },
|
|
2576
|
+
{ },
|
|
2577
|
+
body,
|
|
2578
|
+
['PureCloud OAuth'],
|
|
2579
|
+
['application/json'],
|
|
2580
|
+
['application/json']
|
|
2581
|
+
);
|
|
2582
|
+
}
|
|
2583
|
+
|
|
2584
|
+
/**
|
|
2585
|
+
* Start a guide content generation job.
|
|
2586
|
+
*
|
|
2587
|
+
* @param {Object} body
|
|
2588
|
+
* postGuidesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2589
|
+
*/
|
|
2590
|
+
postGuidesJobs(body) {
|
|
2591
|
+
// verify the required parameter 'body' is set
|
|
2592
|
+
if (body === undefined || body === null) {
|
|
2593
|
+
throw 'Missing the required parameter "body" when calling postGuidesJobs';
|
|
2594
|
+
}
|
|
2595
|
+
|
|
2596
|
+
return this.apiClient.callApi(
|
|
2597
|
+
'/api/v2/guides/jobs',
|
|
2598
|
+
'POST',
|
|
2599
|
+
{ },
|
|
2600
|
+
{ },
|
|
2601
|
+
{ },
|
|
2602
|
+
{ },
|
|
2603
|
+
body,
|
|
2604
|
+
['PureCloud OAuth'],
|
|
2605
|
+
['application/json'],
|
|
2606
|
+
['application/json']
|
|
2607
|
+
);
|
|
2608
|
+
}
|
|
2609
|
+
|
|
2610
|
+
}
|
|
2611
|
+
|
|
2230
2612
|
class AgentAssistantsApi {
|
|
2231
2613
|
/**
|
|
2232
2614
|
* AgentAssistants service.
|
|
2233
2615
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2234
|
-
* @version
|
|
2616
|
+
* @version 224.0.0
|
|
2235
2617
|
*/
|
|
2236
2618
|
|
|
2237
2619
|
/**
|
|
@@ -2434,6 +2816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2434
2816
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
2435
2817
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
2436
2818
|
* @param {String} opts.name Return the assistant by the given name.
|
|
2819
|
+
* @param {Object} opts.expand Which fields, if any, to expand
|
|
2437
2820
|
*/
|
|
2438
2821
|
getAssistants(opts) {
|
|
2439
2822
|
opts = opts || {};
|
|
@@ -2443,7 +2826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2443
2826
|
'/api/v2/assistants',
|
|
2444
2827
|
'GET',
|
|
2445
2828
|
{ },
|
|
2446
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
2829
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'expand': opts['expand'] },
|
|
2447
2830
|
{ },
|
|
2448
2831
|
{ },
|
|
2449
2832
|
null,
|
|
@@ -2607,7 +2990,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2607
2990
|
/**
|
|
2608
2991
|
* AgentCopilot service.
|
|
2609
2992
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2610
|
-
* @version
|
|
2993
|
+
* @version 224.0.0
|
|
2611
2994
|
*/
|
|
2612
2995
|
|
|
2613
2996
|
/**
|
|
@@ -2683,7 +3066,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2683
3066
|
/**
|
|
2684
3067
|
* AgentUI service.
|
|
2685
3068
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2686
|
-
* @version
|
|
3069
|
+
* @version 224.0.0
|
|
2687
3070
|
*/
|
|
2688
3071
|
|
|
2689
3072
|
/**
|
|
@@ -2814,7 +3197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2814
3197
|
/**
|
|
2815
3198
|
* Alerting service.
|
|
2816
3199
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2817
|
-
* @version
|
|
3200
|
+
* @version 224.0.0
|
|
2818
3201
|
*/
|
|
2819
3202
|
|
|
2820
3203
|
/**
|
|
@@ -3215,7 +3598,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3215
3598
|
/**
|
|
3216
3599
|
* Analytics service.
|
|
3217
3600
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3218
|
-
* @version
|
|
3601
|
+
* @version 224.0.0
|
|
3219
3602
|
*/
|
|
3220
3603
|
|
|
3221
3604
|
/**
|
|
@@ -4788,7 +5171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4788
5171
|
}
|
|
4789
5172
|
|
|
4790
5173
|
/**
|
|
4791
|
-
* Count agents by
|
|
5174
|
+
* Count agents by different groupings
|
|
4792
5175
|
*
|
|
4793
5176
|
* @param {Object} body query
|
|
4794
5177
|
*/
|
|
@@ -6036,7 +6419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6036
6419
|
/**
|
|
6037
6420
|
* Architect service.
|
|
6038
6421
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6039
|
-
* @version
|
|
6422
|
+
* @version 224.0.0
|
|
6040
6423
|
*/
|
|
6041
6424
|
|
|
6042
6425
|
/**
|
|
@@ -6922,7 +7305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6922
7305
|
|
|
6923
7306
|
/**
|
|
6924
7307
|
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
6925
|
-
* This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch
|
|
7308
|
+
* This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search.
|
|
6926
7309
|
* @param {Object} opts Optional parameters
|
|
6927
7310
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
6928
7311
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -9080,6 +9463,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9080
9463
|
*
|
|
9081
9464
|
* @param {String} promptId Prompt ID
|
|
9082
9465
|
* @param {String} languageCode Language
|
|
9466
|
+
* postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9083
9467
|
*/
|
|
9084
9468
|
postArchitectPromptResourceUploads(promptId, languageCode) {
|
|
9085
9469
|
// verify the required parameter 'promptId' is set
|
|
@@ -9240,6 +9624,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9240
9624
|
*
|
|
9241
9625
|
* @param {String} promptId Prompt ID
|
|
9242
9626
|
* @param {String} languageCode Language
|
|
9627
|
+
* postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9243
9628
|
*/
|
|
9244
9629
|
postArchitectSystempromptResourceUploads(promptId, languageCode) {
|
|
9245
9630
|
// verify the required parameter 'promptId' is set
|
|
@@ -10329,7 +10714,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10329
10714
|
/**
|
|
10330
10715
|
* Audit service.
|
|
10331
10716
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10332
|
-
* @version
|
|
10717
|
+
* @version 224.0.0
|
|
10333
10718
|
*/
|
|
10334
10719
|
|
|
10335
10720
|
/**
|
|
@@ -10530,7 +10915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10530
10915
|
/**
|
|
10531
10916
|
* Authorization service.
|
|
10532
10917
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10533
|
-
* @version
|
|
10918
|
+
* @version 224.0.0
|
|
10534
10919
|
*/
|
|
10535
10920
|
|
|
10536
10921
|
/**
|
|
@@ -12245,7 +12630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12245
12630
|
/**
|
|
12246
12631
|
* Billing service.
|
|
12247
12632
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12248
|
-
* @version
|
|
12633
|
+
* @version 224.0.0
|
|
12249
12634
|
*/
|
|
12250
12635
|
|
|
12251
12636
|
/**
|
|
@@ -12501,7 +12886,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12501
12886
|
/**
|
|
12502
12887
|
* BusinessRules service.
|
|
12503
12888
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12504
|
-
* @version
|
|
12889
|
+
* @version 224.0.0
|
|
12505
12890
|
*/
|
|
12506
12891
|
|
|
12507
12892
|
/**
|
|
@@ -12774,7 +13159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12774
13159
|
* @param {String} tableId Table ID
|
|
12775
13160
|
* @param {Object} opts Optional parameters
|
|
12776
13161
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12777
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
13162
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12778
13163
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
12779
13164
|
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12780
13165
|
*/
|
|
@@ -12805,7 +13190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12805
13190
|
*
|
|
12806
13191
|
* @param {Object} opts Optional parameters
|
|
12807
13192
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12808
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
13193
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12809
13194
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
12810
13195
|
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12811
13196
|
*/
|
|
@@ -12831,11 +13216,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12831
13216
|
* Search for decision tables.
|
|
12832
13217
|
*
|
|
12833
13218
|
* @param {Object} opts Optional parameters
|
|
12834
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12835
13219
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12836
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
13220
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12837
13221
|
* @param {String} opts.schemaId Search for decision tables that use the schema with this ID. Cannot be combined with name search. Search results will not be paginated if used.
|
|
12838
13222
|
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name. Cannot be combined with schema search. Search results will not be paginated if used.
|
|
13223
|
+
* @param {Boolean} opts.withPublishedVersion Filters results to only decision tables that have at least one version in Published status
|
|
13224
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
13225
|
+
* @param {Array.<String>} opts.ids Decision table IDs to search for
|
|
12839
13226
|
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12840
13227
|
*/
|
|
12841
13228
|
getBusinessrulesDecisiontablesSearch(opts) {
|
|
@@ -12846,7 +13233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12846
13233
|
'/api/v2/businessrules/decisiontables/search',
|
|
12847
13234
|
'GET',
|
|
12848
13235
|
{ },
|
|
12849
|
-
{ '
|
|
13236
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'schemaId': opts['schemaId'],'name': opts['name'],'withPublishedVersion': opts['withPublishedVersion'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') },
|
|
12850
13237
|
{ },
|
|
12851
13238
|
{ },
|
|
12852
13239
|
null,
|
|
@@ -13018,12 +13405,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13018
13405
|
}
|
|
13019
13406
|
|
|
13020
13407
|
/**
|
|
13021
|
-
*
|
|
13408
|
+
* Partially update a decision table row. Will be deprecated, we should use PUT request.
|
|
13022
13409
|
*
|
|
13023
13410
|
* @param {String} tableId Table ID
|
|
13024
13411
|
* @param {Number} tableVersion Table Version
|
|
13025
13412
|
* @param {String} rowId Row ID
|
|
13026
|
-
* @param {Object} body
|
|
13413
|
+
* @param {Object} body Partially update decision table row request
|
|
13414
|
+
* @deprecated
|
|
13027
13415
|
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13028
13416
|
*/
|
|
13029
13417
|
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
@@ -13378,6 +13766,47 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13378
13766
|
);
|
|
13379
13767
|
}
|
|
13380
13768
|
|
|
13769
|
+
/**
|
|
13770
|
+
* Full update a decision table row
|
|
13771
|
+
*
|
|
13772
|
+
* @param {String} tableId Table ID
|
|
13773
|
+
* @param {Number} tableVersion Table Version
|
|
13774
|
+
* @param {String} rowId Row ID
|
|
13775
|
+
* @param {Object} body Full update decision table row request
|
|
13776
|
+
* putBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13777
|
+
*/
|
|
13778
|
+
putBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
13779
|
+
// verify the required parameter 'tableId' is set
|
|
13780
|
+
if (tableId === undefined || tableId === null) {
|
|
13781
|
+
throw 'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionRow';
|
|
13782
|
+
}
|
|
13783
|
+
// verify the required parameter 'tableVersion' is set
|
|
13784
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13785
|
+
throw 'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionRow';
|
|
13786
|
+
}
|
|
13787
|
+
// verify the required parameter 'rowId' is set
|
|
13788
|
+
if (rowId === undefined || rowId === null) {
|
|
13789
|
+
throw 'Missing the required parameter "rowId" when calling putBusinessrulesDecisiontableVersionRow';
|
|
13790
|
+
}
|
|
13791
|
+
// verify the required parameter 'body' is set
|
|
13792
|
+
if (body === undefined || body === null) {
|
|
13793
|
+
throw 'Missing the required parameter "body" when calling putBusinessrulesDecisiontableVersionRow';
|
|
13794
|
+
}
|
|
13795
|
+
|
|
13796
|
+
return this.apiClient.callApi(
|
|
13797
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
13798
|
+
'PUT',
|
|
13799
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
13800
|
+
{ },
|
|
13801
|
+
{ },
|
|
13802
|
+
{ },
|
|
13803
|
+
body,
|
|
13804
|
+
['PureCloud OAuth'],
|
|
13805
|
+
['application/json'],
|
|
13806
|
+
['application/json']
|
|
13807
|
+
);
|
|
13808
|
+
}
|
|
13809
|
+
|
|
13381
13810
|
/**
|
|
13382
13811
|
* Update a schema
|
|
13383
13812
|
*
|
|
@@ -13415,7 +13844,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13415
13844
|
/**
|
|
13416
13845
|
* CarrierServices service.
|
|
13417
13846
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
13418
|
-
* @version
|
|
13847
|
+
* @version 224.0.0
|
|
13419
13848
|
*/
|
|
13420
13849
|
|
|
13421
13850
|
/**
|
|
@@ -13485,7 +13914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13485
13914
|
/**
|
|
13486
13915
|
* Chat service.
|
|
13487
13916
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
13488
|
-
* @version
|
|
13917
|
+
* @version 224.0.0
|
|
13489
13918
|
*/
|
|
13490
13919
|
|
|
13491
13920
|
/**
|
|
@@ -14418,7 +14847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14418
14847
|
/**
|
|
14419
14848
|
* Coaching service.
|
|
14420
14849
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
14421
|
-
* @version
|
|
14850
|
+
* @version 224.0.0
|
|
14422
14851
|
*/
|
|
14423
14852
|
|
|
14424
14853
|
/**
|
|
@@ -14995,7 +15424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14995
15424
|
/**
|
|
14996
15425
|
* ContentManagement service.
|
|
14997
15426
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
14998
|
-
* @version
|
|
15427
|
+
* @version 224.0.0
|
|
14999
15428
|
*/
|
|
15000
15429
|
|
|
15001
15430
|
/**
|
|
@@ -16076,7 +16505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16076
16505
|
/**
|
|
16077
16506
|
* Conversations service.
|
|
16078
16507
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
16079
|
-
* @version
|
|
16508
|
+
* @version 224.0.0
|
|
16080
16509
|
*/
|
|
16081
16510
|
|
|
16082
16511
|
/**
|
|
@@ -16666,6 +17095,78 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16666
17095
|
);
|
|
16667
17096
|
}
|
|
16668
17097
|
|
|
17098
|
+
/**
|
|
17099
|
+
* Get message
|
|
17100
|
+
*
|
|
17101
|
+
* @param {String} conversationId conversationId
|
|
17102
|
+
* @param {String} communicationId communicationId
|
|
17103
|
+
* @param {String} messageId messageId
|
|
17104
|
+
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17105
|
+
*/
|
|
17106
|
+
getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) {
|
|
17107
|
+
// verify the required parameter 'conversationId' is set
|
|
17108
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17109
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationInternalmessage';
|
|
17110
|
+
}
|
|
17111
|
+
// verify the required parameter 'communicationId' is set
|
|
17112
|
+
if (communicationId === undefined || communicationId === null) {
|
|
17113
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationInternalmessage';
|
|
17114
|
+
}
|
|
17115
|
+
// verify the required parameter 'messageId' is set
|
|
17116
|
+
if (messageId === undefined || messageId === null) {
|
|
17117
|
+
throw 'Missing the required parameter "messageId" when calling getConversationCommunicationInternalmessage';
|
|
17118
|
+
}
|
|
17119
|
+
|
|
17120
|
+
return this.apiClient.callApi(
|
|
17121
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages/{messageId}',
|
|
17122
|
+
'GET',
|
|
17123
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'messageId': messageId },
|
|
17124
|
+
{ },
|
|
17125
|
+
{ },
|
|
17126
|
+
{ },
|
|
17127
|
+
null,
|
|
17128
|
+
['PureCloud OAuth'],
|
|
17129
|
+
['application/json'],
|
|
17130
|
+
['application/json']
|
|
17131
|
+
);
|
|
17132
|
+
}
|
|
17133
|
+
|
|
17134
|
+
/**
|
|
17135
|
+
* Get messages for communication
|
|
17136
|
+
*
|
|
17137
|
+
* @param {String} conversationId conversationId
|
|
17138
|
+
* @param {String} communicationId communicationId
|
|
17139
|
+
* @param {Object} opts Optional parameters
|
|
17140
|
+
* @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (default to 25)
|
|
17141
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17142
|
+
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17143
|
+
*/
|
|
17144
|
+
getConversationCommunicationInternalmessages(conversationId, communicationId, opts) {
|
|
17145
|
+
opts = opts || {};
|
|
17146
|
+
|
|
17147
|
+
// verify the required parameter 'conversationId' is set
|
|
17148
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17149
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationInternalmessages';
|
|
17150
|
+
}
|
|
17151
|
+
// verify the required parameter 'communicationId' is set
|
|
17152
|
+
if (communicationId === undefined || communicationId === null) {
|
|
17153
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationInternalmessages';
|
|
17154
|
+
}
|
|
17155
|
+
|
|
17156
|
+
return this.apiClient.callApi(
|
|
17157
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages',
|
|
17158
|
+
'GET',
|
|
17159
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
17160
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
17161
|
+
{ },
|
|
17162
|
+
{ },
|
|
17163
|
+
null,
|
|
17164
|
+
['PureCloud OAuth'],
|
|
17165
|
+
['application/json'],
|
|
17166
|
+
['application/json']
|
|
17167
|
+
);
|
|
17168
|
+
}
|
|
17169
|
+
|
|
16669
17170
|
/**
|
|
16670
17171
|
* Fetch info on a secure session
|
|
16671
17172
|
*
|
|
@@ -16964,7 +17465,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16964
17465
|
* @param {String} participantId participantId
|
|
16965
17466
|
* @param {String} communicationId communicationId
|
|
16966
17467
|
* @param {Object} opts Optional parameters
|
|
16967
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17468
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
16968
17469
|
*/
|
|
16969
17470
|
getConversationsCallParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
16970
17471
|
opts = opts || {};
|
|
@@ -17002,7 +17503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17002
17503
|
* @param {String} conversationId conversationId
|
|
17003
17504
|
* @param {String} participantId participantId
|
|
17004
17505
|
* @param {Object} opts Optional parameters
|
|
17005
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17506
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17006
17507
|
*/
|
|
17007
17508
|
getConversationsCallParticipantWrapup(conversationId, participantId, opts) {
|
|
17008
17509
|
opts = opts || {};
|
|
@@ -17092,7 +17593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17092
17593
|
* @param {String} participantId participantId
|
|
17093
17594
|
* @param {String} communicationId communicationId
|
|
17094
17595
|
* @param {Object} opts Optional parameters
|
|
17095
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17596
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17096
17597
|
*/
|
|
17097
17598
|
getConversationsCallbackParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
17098
17599
|
opts = opts || {};
|
|
@@ -17130,7 +17631,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17130
17631
|
* @param {String} conversationId conversationId
|
|
17131
17632
|
* @param {String} participantId participantId
|
|
17132
17633
|
* @param {Object} opts Optional parameters
|
|
17133
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17634
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17134
17635
|
*/
|
|
17135
17636
|
getConversationsCallbackParticipantWrapup(conversationId, participantId, opts) {
|
|
17136
17637
|
opts = opts || {};
|
|
@@ -17372,7 +17873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17372
17873
|
* @param {String} participantId participantId
|
|
17373
17874
|
* @param {String} communicationId communicationId
|
|
17374
17875
|
* @param {Object} opts Optional parameters
|
|
17375
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17876
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17376
17877
|
* @deprecated
|
|
17377
17878
|
*/
|
|
17378
17879
|
getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -17411,7 +17912,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17411
17912
|
* @param {String} conversationId conversationId
|
|
17412
17913
|
* @param {String} participantId participantId
|
|
17413
17914
|
* @param {Object} opts Optional parameters
|
|
17414
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17915
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17415
17916
|
* @deprecated
|
|
17416
17917
|
*/
|
|
17417
17918
|
getConversationsChatParticipantWrapup(conversationId, participantId, opts) {
|
|
@@ -17524,7 +18025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17524
18025
|
* @param {String} participantId participantId
|
|
17525
18026
|
* @param {String} communicationId communicationId
|
|
17526
18027
|
* @param {Object} opts Optional parameters
|
|
17527
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18028
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17528
18029
|
* @deprecated
|
|
17529
18030
|
*/
|
|
17530
18031
|
getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -17563,7 +18064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17563
18064
|
* @param {String} conversationId conversationId
|
|
17564
18065
|
* @param {String} participantId participantId
|
|
17565
18066
|
* @param {Object} opts Optional parameters
|
|
17566
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18067
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17567
18068
|
* @deprecated
|
|
17568
18069
|
*/
|
|
17569
18070
|
getConversationsCobrowsesessionParticipantWrapup(conversationId, participantId, opts) {
|
|
@@ -17755,7 +18256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17755
18256
|
* @param {String} participantId participantId
|
|
17756
18257
|
* @param {String} communicationId communicationId
|
|
17757
18258
|
* @param {Object} opts Optional parameters
|
|
17758
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18259
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17759
18260
|
*/
|
|
17760
18261
|
getConversationsEmailParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
17761
18262
|
opts = opts || {};
|
|
@@ -17793,7 +18294,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17793
18294
|
* @param {String} conversationId conversationId
|
|
17794
18295
|
* @param {String} participantId participantId
|
|
17795
18296
|
* @param {Object} opts Optional parameters
|
|
17796
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18297
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17797
18298
|
*/
|
|
17798
18299
|
getConversationsEmailParticipantWrapup(conversationId, participantId, opts) {
|
|
17799
18300
|
opts = opts || {};
|
|
@@ -17896,6 +18397,53 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17896
18397
|
);
|
|
17897
18398
|
}
|
|
17898
18399
|
|
|
18400
|
+
/**
|
|
18401
|
+
* Get internal message conversation
|
|
18402
|
+
*
|
|
18403
|
+
* @param {String} conversationId conversationId
|
|
18404
|
+
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18405
|
+
*/
|
|
18406
|
+
getConversationsInternalmessage(conversationId) {
|
|
18407
|
+
// verify the required parameter 'conversationId' is set
|
|
18408
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18409
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationsInternalmessage';
|
|
18410
|
+
}
|
|
18411
|
+
|
|
18412
|
+
return this.apiClient.callApi(
|
|
18413
|
+
'/api/v2/conversations/internalmessages/{conversationId}',
|
|
18414
|
+
'GET',
|
|
18415
|
+
{ 'conversationId': conversationId },
|
|
18416
|
+
{ },
|
|
18417
|
+
{ },
|
|
18418
|
+
{ },
|
|
18419
|
+
null,
|
|
18420
|
+
['PureCloud OAuth'],
|
|
18421
|
+
['application/json'],
|
|
18422
|
+
['application/json']
|
|
18423
|
+
);
|
|
18424
|
+
}
|
|
18425
|
+
|
|
18426
|
+
/**
|
|
18427
|
+
* Get active internal message conversations for the logged in user
|
|
18428
|
+
*
|
|
18429
|
+
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18430
|
+
*/
|
|
18431
|
+
getConversationsInternalmessages() {
|
|
18432
|
+
|
|
18433
|
+
return this.apiClient.callApi(
|
|
18434
|
+
'/api/v2/conversations/internalmessages',
|
|
18435
|
+
'GET',
|
|
18436
|
+
{ },
|
|
18437
|
+
{ },
|
|
18438
|
+
{ },
|
|
18439
|
+
{ },
|
|
18440
|
+
null,
|
|
18441
|
+
['PureCloud OAuth'],
|
|
18442
|
+
['application/json'],
|
|
18443
|
+
['application/json']
|
|
18444
|
+
);
|
|
18445
|
+
}
|
|
18446
|
+
|
|
17899
18447
|
/**
|
|
17900
18448
|
* Get the encryption key configurations
|
|
17901
18449
|
*
|
|
@@ -18071,7 +18619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18071
18619
|
* @param {String} participantId participantId
|
|
18072
18620
|
* @param {String} communicationId communicationId
|
|
18073
18621
|
* @param {Object} opts Optional parameters
|
|
18074
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18622
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
18075
18623
|
*/
|
|
18076
18624
|
getConversationsMessageParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18077
18625
|
opts = opts || {};
|
|
@@ -18109,7 +18657,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18109
18657
|
* @param {String} conversationId conversationId
|
|
18110
18658
|
* @param {String} participantId participantId
|
|
18111
18659
|
* @param {Object} opts Optional parameters
|
|
18112
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18660
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
18113
18661
|
*/
|
|
18114
18662
|
getConversationsMessageParticipantWrapup(conversationId, participantId, opts) {
|
|
18115
18663
|
opts = opts || {};
|
|
@@ -18379,6 +18927,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18379
18927
|
);
|
|
18380
18928
|
}
|
|
18381
18929
|
|
|
18930
|
+
/**
|
|
18931
|
+
* Get X (Formally Twitter) messaging integration identity resolution settings
|
|
18932
|
+
*
|
|
18933
|
+
* @param {String} integrationId Integration Id
|
|
18934
|
+
*/
|
|
18935
|
+
getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(integrationId) {
|
|
18936
|
+
// verify the required parameter 'integrationId' is set
|
|
18937
|
+
if (integrationId === undefined || integrationId === null) {
|
|
18938
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
18939
|
+
}
|
|
18940
|
+
|
|
18941
|
+
return this.apiClient.callApi(
|
|
18942
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}',
|
|
18943
|
+
'GET',
|
|
18944
|
+
{ 'integrationId': integrationId },
|
|
18945
|
+
{ },
|
|
18946
|
+
{ },
|
|
18947
|
+
{ },
|
|
18948
|
+
null,
|
|
18949
|
+
['PureCloud OAuth'],
|
|
18950
|
+
['application/json'],
|
|
18951
|
+
['application/json']
|
|
18952
|
+
);
|
|
18953
|
+
}
|
|
18954
|
+
|
|
18382
18955
|
/**
|
|
18383
18956
|
* Get a whatsApp integration Identity Resolution settings
|
|
18384
18957
|
*
|
|
@@ -18929,7 +19502,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18929
19502
|
* @param {String} participantId participantId
|
|
18930
19503
|
* @param {String} communicationId communicationId
|
|
18931
19504
|
* @param {Object} opts Optional parameters
|
|
18932
|
-
* @param {Boolean} opts.provisional Indicates
|
|
19505
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
18933
19506
|
* @deprecated
|
|
18934
19507
|
*/
|
|
18935
19508
|
getConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -18989,7 +19562,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18989
19562
|
* @param {String} participantId participantId
|
|
18990
19563
|
* @param {String} communicationId communicationId
|
|
18991
19564
|
* @param {Object} opts Optional parameters
|
|
18992
|
-
* @param {Boolean} opts.provisional Indicates
|
|
19565
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
18993
19566
|
*/
|
|
18994
19567
|
getConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18995
19568
|
opts = opts || {};
|
|
@@ -19054,7 +19627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19054
19627
|
* @param {String} participantId participantId
|
|
19055
19628
|
* @param {String} communicationId communicationId
|
|
19056
19629
|
* @param {Object} opts Optional parameters
|
|
19057
|
-
* @param {Boolean} opts.provisional Indicates
|
|
19630
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
19058
19631
|
*/
|
|
19059
19632
|
getConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
19060
19633
|
opts = opts || {};
|
|
@@ -20826,6 +21399,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20826
21399
|
);
|
|
20827
21400
|
}
|
|
20828
21401
|
|
|
21402
|
+
/**
|
|
21403
|
+
* Send internal message
|
|
21404
|
+
* Send a new internal message for an existing communication.
|
|
21405
|
+
* @param {String} conversationId conversationId
|
|
21406
|
+
* @param {String} communicationId communicationId
|
|
21407
|
+
* @param {Object} body Message
|
|
21408
|
+
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21409
|
+
*/
|
|
21410
|
+
postConversationCommunicationInternalmessages(conversationId, communicationId, body) {
|
|
21411
|
+
// verify the required parameter 'conversationId' is set
|
|
21412
|
+
if (conversationId === undefined || conversationId === null) {
|
|
21413
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationInternalmessages';
|
|
21414
|
+
}
|
|
21415
|
+
// verify the required parameter 'communicationId' is set
|
|
21416
|
+
if (communicationId === undefined || communicationId === null) {
|
|
21417
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationInternalmessages';
|
|
21418
|
+
}
|
|
21419
|
+
// verify the required parameter 'body' is set
|
|
21420
|
+
if (body === undefined || body === null) {
|
|
21421
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationInternalmessages';
|
|
21422
|
+
}
|
|
21423
|
+
|
|
21424
|
+
return this.apiClient.callApi(
|
|
21425
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages',
|
|
21426
|
+
'POST',
|
|
21427
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
21428
|
+
{ },
|
|
21429
|
+
{ },
|
|
21430
|
+
{ },
|
|
21431
|
+
body,
|
|
21432
|
+
['PureCloud OAuth'],
|
|
21433
|
+
['application/json'],
|
|
21434
|
+
['application/json']
|
|
21435
|
+
);
|
|
21436
|
+
}
|
|
21437
|
+
|
|
20829
21438
|
/**
|
|
20830
21439
|
* Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
20831
21440
|
*
|
|
@@ -20919,6 +21528,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20919
21528
|
);
|
|
20920
21529
|
}
|
|
20921
21530
|
|
|
21531
|
+
/**
|
|
21532
|
+
* Setup internal message communication with user
|
|
21533
|
+
* The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission.
|
|
21534
|
+
* @param {String} conversationId conversation ID
|
|
21535
|
+
* @param {String} participantId participant ID
|
|
21536
|
+
* @param {Object} body Confer request
|
|
21537
|
+
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21538
|
+
*/
|
|
21539
|
+
postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) {
|
|
21540
|
+
// verify the required parameter 'conversationId' is set
|
|
21541
|
+
if (conversationId === undefined || conversationId === null) {
|
|
21542
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
21543
|
+
}
|
|
21544
|
+
// verify the required parameter 'participantId' is set
|
|
21545
|
+
if (participantId === undefined || participantId === null) {
|
|
21546
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
21547
|
+
}
|
|
21548
|
+
// verify the required parameter 'body' is set
|
|
21549
|
+
if (body === undefined || body === null) {
|
|
21550
|
+
throw 'Missing the required parameter "body" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
21551
|
+
}
|
|
21552
|
+
|
|
21553
|
+
return this.apiClient.callApi(
|
|
21554
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/internalmessages/users/communications',
|
|
21555
|
+
'POST',
|
|
21556
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
21557
|
+
{ },
|
|
21558
|
+
{ },
|
|
21559
|
+
{ },
|
|
21560
|
+
body,
|
|
21561
|
+
['PureCloud OAuth'],
|
|
21562
|
+
['application/json'],
|
|
21563
|
+
['application/json']
|
|
21564
|
+
);
|
|
21565
|
+
}
|
|
21566
|
+
|
|
20922
21567
|
/**
|
|
20923
21568
|
* Replace this participant with the specified user and/or address
|
|
20924
21569
|
*
|
|
@@ -22394,6 +23039,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22394
23039
|
);
|
|
22395
23040
|
}
|
|
22396
23041
|
|
|
23042
|
+
/**
|
|
23043
|
+
* Send a social media message
|
|
23044
|
+
* Send a social media message on existing conversation/communication.
|
|
23045
|
+
* @param {String} conversationId conversationId
|
|
23046
|
+
* @param {String} communicationId communicationId
|
|
23047
|
+
* @param {Object} body Message
|
|
23048
|
+
*/
|
|
23049
|
+
postConversationsMessageCommunicationSocialmediaMessages(conversationId, communicationId, body) {
|
|
23050
|
+
// verify the required parameter 'conversationId' is set
|
|
23051
|
+
if (conversationId === undefined || conversationId === null) {
|
|
23052
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
23053
|
+
}
|
|
23054
|
+
// verify the required parameter 'communicationId' is set
|
|
23055
|
+
if (communicationId === undefined || communicationId === null) {
|
|
23056
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
23057
|
+
}
|
|
23058
|
+
// verify the required parameter 'body' is set
|
|
23059
|
+
if (body === undefined || body === null) {
|
|
23060
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
23061
|
+
}
|
|
23062
|
+
|
|
23063
|
+
return this.apiClient.callApi(
|
|
23064
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/socialmedia/messages',
|
|
23065
|
+
'POST',
|
|
23066
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
23067
|
+
{ },
|
|
23068
|
+
{ },
|
|
23069
|
+
{ },
|
|
23070
|
+
body,
|
|
23071
|
+
['PureCloud OAuth'],
|
|
23072
|
+
['application/json'],
|
|
23073
|
+
['application/json']
|
|
23074
|
+
);
|
|
23075
|
+
}
|
|
23076
|
+
|
|
22397
23077
|
/**
|
|
22398
23078
|
* Send message typing event
|
|
22399
23079
|
* Send message typing event for existing conversation/communication.
|
|
@@ -22523,6 +23203,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22523
23203
|
);
|
|
22524
23204
|
}
|
|
22525
23205
|
|
|
23206
|
+
/**
|
|
23207
|
+
* Send inbound Open Response
|
|
23208
|
+
* Send an inbound response for a structured message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
23209
|
+
* @param {String} integrationId integrationId
|
|
23210
|
+
* @param {Object} body OpenInboundStructuredResponseMessage
|
|
23211
|
+
*/
|
|
23212
|
+
postConversationsMessageInboundOpenStructuredResponse(integrationId, body) {
|
|
23213
|
+
// verify the required parameter 'integrationId' is set
|
|
23214
|
+
if (integrationId === undefined || integrationId === null) {
|
|
23215
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenStructuredResponse';
|
|
23216
|
+
}
|
|
23217
|
+
// verify the required parameter 'body' is set
|
|
23218
|
+
if (body === undefined || body === null) {
|
|
23219
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenStructuredResponse';
|
|
23220
|
+
}
|
|
23221
|
+
|
|
23222
|
+
return this.apiClient.callApi(
|
|
23223
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/structured/response',
|
|
23224
|
+
'POST',
|
|
23225
|
+
{ 'integrationId': integrationId },
|
|
23226
|
+
{ },
|
|
23227
|
+
{ },
|
|
23228
|
+
{ },
|
|
23229
|
+
body,
|
|
23230
|
+
['PureCloud OAuth'],
|
|
23231
|
+
['application/json'],
|
|
23232
|
+
['application/json']
|
|
23233
|
+
);
|
|
23234
|
+
}
|
|
23235
|
+
|
|
22526
23236
|
/**
|
|
22527
23237
|
* Get messages in batch
|
|
22528
23238
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
@@ -23631,6 +24341,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23631
24341
|
);
|
|
23632
24342
|
}
|
|
23633
24343
|
|
|
24344
|
+
/**
|
|
24345
|
+
* Create an identity resolution settings for an X (Formally Twitter) messaging integration
|
|
24346
|
+
*
|
|
24347
|
+
* @param {String} integrationId Integration Id
|
|
24348
|
+
* @param {Object} body IdentityResolutionConfig
|
|
24349
|
+
*/
|
|
24350
|
+
putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
24351
|
+
// verify the required parameter 'integrationId' is set
|
|
24352
|
+
if (integrationId === undefined || integrationId === null) {
|
|
24353
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
24354
|
+
}
|
|
24355
|
+
// verify the required parameter 'body' is set
|
|
24356
|
+
if (body === undefined || body === null) {
|
|
24357
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
24358
|
+
}
|
|
24359
|
+
|
|
24360
|
+
return this.apiClient.callApi(
|
|
24361
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}',
|
|
24362
|
+
'PUT',
|
|
24363
|
+
{ 'integrationId': integrationId },
|
|
24364
|
+
{ },
|
|
24365
|
+
{ },
|
|
24366
|
+
{ },
|
|
24367
|
+
body,
|
|
24368
|
+
['PureCloud OAuth'],
|
|
24369
|
+
['application/json'],
|
|
24370
|
+
['application/json']
|
|
24371
|
+
);
|
|
24372
|
+
}
|
|
24373
|
+
|
|
23634
24374
|
/**
|
|
23635
24375
|
* Update a whatsApp integration Identity Resolution settings
|
|
23636
24376
|
*
|
|
@@ -23833,7 +24573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23833
24573
|
/**
|
|
23834
24574
|
* DataExtensions service.
|
|
23835
24575
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23836
|
-
* @version
|
|
24576
|
+
* @version 224.0.0
|
|
23837
24577
|
*/
|
|
23838
24578
|
|
|
23839
24579
|
/**
|
|
@@ -23919,7 +24659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23919
24659
|
/**
|
|
23920
24660
|
* DataPrivacy service.
|
|
23921
24661
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
23922
|
-
* @version
|
|
24662
|
+
* @version 224.0.0
|
|
23923
24663
|
*/
|
|
23924
24664
|
|
|
23925
24665
|
/**
|
|
@@ -24089,7 +24829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24089
24829
|
/**
|
|
24090
24830
|
* Downloads service.
|
|
24091
24831
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
24092
|
-
* @version
|
|
24832
|
+
* @version 224.0.0
|
|
24093
24833
|
*/
|
|
24094
24834
|
|
|
24095
24835
|
/**
|
|
@@ -24141,7 +24881,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24141
24881
|
/**
|
|
24142
24882
|
* Emails service.
|
|
24143
24883
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
24144
|
-
* @version
|
|
24884
|
+
* @version 224.0.0
|
|
24145
24885
|
*/
|
|
24146
24886
|
|
|
24147
24887
|
/**
|
|
@@ -24270,7 +25010,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24270
25010
|
/**
|
|
24271
25011
|
* EmployeeEngagement service.
|
|
24272
25012
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
24273
|
-
* @version
|
|
25013
|
+
* @version 224.0.0
|
|
24274
25014
|
*/
|
|
24275
25015
|
|
|
24276
25016
|
/**
|
|
@@ -24421,7 +25161,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24421
25161
|
/**
|
|
24422
25162
|
* Events service.
|
|
24423
25163
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
24424
|
-
* @version
|
|
25164
|
+
* @version 224.0.0
|
|
24425
25165
|
*/
|
|
24426
25166
|
|
|
24427
25167
|
/**
|
|
@@ -24517,7 +25257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24517
25257
|
/**
|
|
24518
25258
|
* ExternalContacts service.
|
|
24519
25259
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
24520
|
-
* @version
|
|
25260
|
+
* @version 224.0.0
|
|
24521
25261
|
*/
|
|
24522
25262
|
|
|
24523
25263
|
/**
|
|
@@ -27705,7 +28445,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27705
28445
|
/**
|
|
27706
28446
|
* Fax service.
|
|
27707
28447
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
27708
|
-
* @version
|
|
28448
|
+
* @version 224.0.0
|
|
27709
28449
|
*/
|
|
27710
28450
|
|
|
27711
28451
|
/**
|
|
@@ -27920,7 +28660,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27920
28660
|
/**
|
|
27921
28661
|
* Flows service.
|
|
27922
28662
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
27923
|
-
* @version
|
|
28663
|
+
* @version 224.0.0
|
|
27924
28664
|
*/
|
|
27925
28665
|
|
|
27926
28666
|
/**
|
|
@@ -28103,7 +28843,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28103
28843
|
/**
|
|
28104
28844
|
* Gamification service.
|
|
28105
28845
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
28106
|
-
* @version
|
|
28846
|
+
* @version 224.0.0
|
|
28107
28847
|
*/
|
|
28108
28848
|
|
|
28109
28849
|
/**
|
|
@@ -30610,7 +31350,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30610
31350
|
/**
|
|
30611
31351
|
* GeneralDataProtectionRegulation service.
|
|
30612
31352
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
30613
|
-
* @version
|
|
31353
|
+
* @version 224.0.0
|
|
30614
31354
|
*/
|
|
30615
31355
|
|
|
30616
31356
|
/**
|
|
@@ -30740,7 +31480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30740
31480
|
/**
|
|
30741
31481
|
* Geolocation service.
|
|
30742
31482
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
30743
|
-
* @version
|
|
31483
|
+
* @version 224.0.0
|
|
30744
31484
|
*/
|
|
30745
31485
|
|
|
30746
31486
|
/**
|
|
@@ -30871,7 +31611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30871
31611
|
/**
|
|
30872
31612
|
* Greetings service.
|
|
30873
31613
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
30874
|
-
* @version
|
|
31614
|
+
* @version 224.0.0
|
|
30875
31615
|
*/
|
|
30876
31616
|
|
|
30877
31617
|
/**
|
|
@@ -30937,12 +31677,70 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30937
31677
|
}
|
|
30938
31678
|
|
|
30939
31679
|
/**
|
|
30940
|
-
*
|
|
31680
|
+
* Download a organization greeting recording
|
|
30941
31681
|
*
|
|
30942
31682
|
* @param {String} greetingId Greeting ID
|
|
30943
31683
|
* @param {Object} opts Optional parameters
|
|
30944
31684
|
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
30945
31685
|
*/
|
|
31686
|
+
getGreetingDownloads(greetingId, opts) {
|
|
31687
|
+
opts = opts || {};
|
|
31688
|
+
|
|
31689
|
+
// verify the required parameter 'greetingId' is set
|
|
31690
|
+
if (greetingId === undefined || greetingId === null) {
|
|
31691
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingDownloads';
|
|
31692
|
+
}
|
|
31693
|
+
|
|
31694
|
+
return this.apiClient.callApi(
|
|
31695
|
+
'/api/v2/greetings/{greetingId}/downloads',
|
|
31696
|
+
'GET',
|
|
31697
|
+
{ 'greetingId': greetingId },
|
|
31698
|
+
{ 'formatId': opts['formatId'] },
|
|
31699
|
+
{ },
|
|
31700
|
+
{ },
|
|
31701
|
+
null,
|
|
31702
|
+
['PureCloud OAuth'],
|
|
31703
|
+
['application/json'],
|
|
31704
|
+
['application/json']
|
|
31705
|
+
);
|
|
31706
|
+
}
|
|
31707
|
+
|
|
31708
|
+
/**
|
|
31709
|
+
* Download a group greeting recording
|
|
31710
|
+
*
|
|
31711
|
+
* @param {String} greetingId Greeting ID
|
|
31712
|
+
* @param {Object} opts Optional parameters
|
|
31713
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
31714
|
+
*/
|
|
31715
|
+
getGreetingGroupsDownloads(greetingId, opts) {
|
|
31716
|
+
opts = opts || {};
|
|
31717
|
+
|
|
31718
|
+
// verify the required parameter 'greetingId' is set
|
|
31719
|
+
if (greetingId === undefined || greetingId === null) {
|
|
31720
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingGroupsDownloads';
|
|
31721
|
+
}
|
|
31722
|
+
|
|
31723
|
+
return this.apiClient.callApi(
|
|
31724
|
+
'/api/v2/greetings/{greetingId}/groups/downloads',
|
|
31725
|
+
'GET',
|
|
31726
|
+
{ 'greetingId': greetingId },
|
|
31727
|
+
{ 'formatId': opts['formatId'] },
|
|
31728
|
+
{ },
|
|
31729
|
+
{ },
|
|
31730
|
+
null,
|
|
31731
|
+
['PureCloud OAuth'],
|
|
31732
|
+
['application/json'],
|
|
31733
|
+
['application/json']
|
|
31734
|
+
);
|
|
31735
|
+
}
|
|
31736
|
+
|
|
31737
|
+
/**
|
|
31738
|
+
* Get media playback URI for this greeting
|
|
31739
|
+
* API should migrate to use GET api/v2/greetings/{greetingId}/downloads
|
|
31740
|
+
* @param {String} greetingId Greeting ID
|
|
31741
|
+
* @param {Object} opts Optional parameters
|
|
31742
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
31743
|
+
*/
|
|
30946
31744
|
getGreetingMedia(greetingId, opts) {
|
|
30947
31745
|
opts = opts || {};
|
|
30948
31746
|
|
|
@@ -30965,6 +31763,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30965
31763
|
);
|
|
30966
31764
|
}
|
|
30967
31765
|
|
|
31766
|
+
/**
|
|
31767
|
+
* Download a user greeting recording
|
|
31768
|
+
*
|
|
31769
|
+
* @param {String} greetingId Greeting ID
|
|
31770
|
+
* @param {Object} opts Optional parameters
|
|
31771
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
31772
|
+
*/
|
|
31773
|
+
getGreetingUsersDownloads(greetingId, opts) {
|
|
31774
|
+
opts = opts || {};
|
|
31775
|
+
|
|
31776
|
+
// verify the required parameter 'greetingId' is set
|
|
31777
|
+
if (greetingId === undefined || greetingId === null) {
|
|
31778
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingUsersDownloads';
|
|
31779
|
+
}
|
|
31780
|
+
|
|
31781
|
+
return this.apiClient.callApi(
|
|
31782
|
+
'/api/v2/greetings/{greetingId}/users/downloads',
|
|
31783
|
+
'GET',
|
|
31784
|
+
{ 'greetingId': greetingId },
|
|
31785
|
+
{ 'formatId': opts['formatId'] },
|
|
31786
|
+
{ },
|
|
31787
|
+
{ },
|
|
31788
|
+
null,
|
|
31789
|
+
['PureCloud OAuth'],
|
|
31790
|
+
['application/json'],
|
|
31791
|
+
['application/json']
|
|
31792
|
+
);
|
|
31793
|
+
}
|
|
31794
|
+
|
|
30968
31795
|
/**
|
|
30969
31796
|
* Gets an Organization's Greetings
|
|
30970
31797
|
*
|
|
@@ -31326,7 +32153,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31326
32153
|
/**
|
|
31327
32154
|
* Groups service.
|
|
31328
32155
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
31329
|
-
* @version
|
|
32156
|
+
* @version 224.0.0
|
|
31330
32157
|
*/
|
|
31331
32158
|
|
|
31332
32159
|
/**
|
|
@@ -31845,7 +32672,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31845
32672
|
/**
|
|
31846
32673
|
* IdentityProvider service.
|
|
31847
32674
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
31848
|
-
* @version
|
|
32675
|
+
* @version 224.0.0
|
|
31849
32676
|
*/
|
|
31850
32677
|
|
|
31851
32678
|
/**
|
|
@@ -32706,7 +33533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32706
33533
|
/**
|
|
32707
33534
|
* InfrastructureAsCode service.
|
|
32708
33535
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
32709
|
-
* @version
|
|
33536
|
+
* @version 224.0.0
|
|
32710
33537
|
*/
|
|
32711
33538
|
|
|
32712
33539
|
/**
|
|
@@ -32873,7 +33700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32873
33700
|
/**
|
|
32874
33701
|
* Integrations service.
|
|
32875
33702
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
32876
|
-
* @version
|
|
33703
|
+
* @version 224.0.0
|
|
32877
33704
|
*/
|
|
32878
33705
|
|
|
32879
33706
|
/**
|
|
@@ -33504,6 +34331,103 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33504
34331
|
);
|
|
33505
34332
|
}
|
|
33506
34333
|
|
|
34334
|
+
/**
|
|
34335
|
+
* Get a specific Bot details
|
|
34336
|
+
*
|
|
34337
|
+
* @param {String} integrationId The integration ID for this group of bots
|
|
34338
|
+
* @param {String} botId The bot ID for this bot
|
|
34339
|
+
* @param {Object} opts Optional parameters
|
|
34340
|
+
* @param {String} opts.version Specific Version
|
|
34341
|
+
* getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34342
|
+
*/
|
|
34343
|
+
getIntegrationsBotconnectorBot(integrationId, botId, opts) {
|
|
34344
|
+
opts = opts || {};
|
|
34345
|
+
|
|
34346
|
+
// verify the required parameter 'integrationId' is set
|
|
34347
|
+
if (integrationId === undefined || integrationId === null) {
|
|
34348
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBot';
|
|
34349
|
+
}
|
|
34350
|
+
// verify the required parameter 'botId' is set
|
|
34351
|
+
if (botId === undefined || botId === null) {
|
|
34352
|
+
throw 'Missing the required parameter "botId" when calling getIntegrationsBotconnectorBot';
|
|
34353
|
+
}
|
|
34354
|
+
|
|
34355
|
+
return this.apiClient.callApi(
|
|
34356
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots/{botId}',
|
|
34357
|
+
'GET',
|
|
34358
|
+
{ 'integrationId': integrationId,'botId': botId },
|
|
34359
|
+
{ 'version': opts['version'] },
|
|
34360
|
+
{ },
|
|
34361
|
+
{ },
|
|
34362
|
+
null,
|
|
34363
|
+
['PureCloud OAuth'],
|
|
34364
|
+
['application/json'],
|
|
34365
|
+
['application/json']
|
|
34366
|
+
);
|
|
34367
|
+
}
|
|
34368
|
+
|
|
34369
|
+
/**
|
|
34370
|
+
* Get the list of bots for this integration.
|
|
34371
|
+
*
|
|
34372
|
+
* @param {String} integrationId The integration ID for this group of bots.
|
|
34373
|
+
* @param {Object} opts Optional parameters
|
|
34374
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34375
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
34376
|
+
* getIntegrationsBotconnectorBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34377
|
+
*/
|
|
34378
|
+
getIntegrationsBotconnectorBots(integrationId, opts) {
|
|
34379
|
+
opts = opts || {};
|
|
34380
|
+
|
|
34381
|
+
// verify the required parameter 'integrationId' is set
|
|
34382
|
+
if (integrationId === undefined || integrationId === null) {
|
|
34383
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBots';
|
|
34384
|
+
}
|
|
34385
|
+
|
|
34386
|
+
return this.apiClient.callApi(
|
|
34387
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots',
|
|
34388
|
+
'GET',
|
|
34389
|
+
{ 'integrationId': integrationId },
|
|
34390
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
34391
|
+
{ },
|
|
34392
|
+
{ },
|
|
34393
|
+
null,
|
|
34394
|
+
['PureCloud OAuth'],
|
|
34395
|
+
['application/json'],
|
|
34396
|
+
['application/json']
|
|
34397
|
+
);
|
|
34398
|
+
}
|
|
34399
|
+
|
|
34400
|
+
/**
|
|
34401
|
+
* Get the summary list of bots for this integration.
|
|
34402
|
+
*
|
|
34403
|
+
* @param {String} integrationId The integration ID for this group of bots.
|
|
34404
|
+
* @param {Object} opts Optional parameters
|
|
34405
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34406
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
34407
|
+
* getIntegrationsBotconnectorBotsSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34408
|
+
*/
|
|
34409
|
+
getIntegrationsBotconnectorBotsSummaries(integrationId, opts) {
|
|
34410
|
+
opts = opts || {};
|
|
34411
|
+
|
|
34412
|
+
// verify the required parameter 'integrationId' is set
|
|
34413
|
+
if (integrationId === undefined || integrationId === null) {
|
|
34414
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBotsSummaries';
|
|
34415
|
+
}
|
|
34416
|
+
|
|
34417
|
+
return this.apiClient.callApi(
|
|
34418
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots/summaries',
|
|
34419
|
+
'GET',
|
|
34420
|
+
{ 'integrationId': integrationId },
|
|
34421
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
34422
|
+
{ },
|
|
34423
|
+
{ },
|
|
34424
|
+
null,
|
|
34425
|
+
['PureCloud OAuth'],
|
|
34426
|
+
['application/json'],
|
|
34427
|
+
['application/json']
|
|
34428
|
+
);
|
|
34429
|
+
}
|
|
34430
|
+
|
|
33507
34431
|
/**
|
|
33508
34432
|
* Get a specific botConnector bot, plus versions, for this integration
|
|
33509
34433
|
*
|
|
@@ -33737,6 +34661,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33737
34661
|
);
|
|
33738
34662
|
}
|
|
33739
34663
|
|
|
34664
|
+
/**
|
|
34665
|
+
* List multiple sets of credentials using cursor-based paging
|
|
34666
|
+
*
|
|
34667
|
+
* @param {Object} opts Optional parameters
|
|
34668
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
34669
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
34670
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
34671
|
+
*/
|
|
34672
|
+
getIntegrationsCredentialsListing(opts) {
|
|
34673
|
+
opts = opts || {};
|
|
34674
|
+
|
|
34675
|
+
|
|
34676
|
+
return this.apiClient.callApi(
|
|
34677
|
+
'/api/v2/integrations/credentials/listing',
|
|
34678
|
+
'GET',
|
|
34679
|
+
{ },
|
|
34680
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
34681
|
+
{ },
|
|
34682
|
+
{ },
|
|
34683
|
+
null,
|
|
34684
|
+
['PureCloud OAuth'],
|
|
34685
|
+
['application/json'],
|
|
34686
|
+
['application/json']
|
|
34687
|
+
);
|
|
34688
|
+
}
|
|
34689
|
+
|
|
33740
34690
|
/**
|
|
33741
34691
|
* List all credential types
|
|
33742
34692
|
*
|
|
@@ -34983,6 +35933,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34983
35933
|
);
|
|
34984
35934
|
}
|
|
34985
35935
|
|
|
35936
|
+
/**
|
|
35937
|
+
* Send an incoming message to the bot.
|
|
35938
|
+
*
|
|
35939
|
+
* @param {Object} body Incoming Message Request
|
|
35940
|
+
* postIntegrationsBotconnectorsIncomingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35941
|
+
*/
|
|
35942
|
+
postIntegrationsBotconnectorsIncomingMessages(body) {
|
|
35943
|
+
// verify the required parameter 'body' is set
|
|
35944
|
+
if (body === undefined || body === null) {
|
|
35945
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsBotconnectorsIncomingMessages';
|
|
35946
|
+
}
|
|
35947
|
+
|
|
35948
|
+
return this.apiClient.callApi(
|
|
35949
|
+
'/api/v2/integrations/botconnectors/incoming/messages',
|
|
35950
|
+
'POST',
|
|
35951
|
+
{ },
|
|
35952
|
+
{ },
|
|
35953
|
+
{ },
|
|
35954
|
+
{ },
|
|
35955
|
+
body,
|
|
35956
|
+
['PureCloud OAuth'],
|
|
35957
|
+
['application/json'],
|
|
35958
|
+
['application/json']
|
|
35959
|
+
);
|
|
35960
|
+
}
|
|
35961
|
+
|
|
35962
|
+
/**
|
|
35963
|
+
* Send an outgoing message to the end user.
|
|
35964
|
+
*
|
|
35965
|
+
* @param {Object} body Outgoing Message Request
|
|
35966
|
+
* postIntegrationsBotconnectorsOutgoingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35967
|
+
*/
|
|
35968
|
+
postIntegrationsBotconnectorsOutgoingMessages(body) {
|
|
35969
|
+
// verify the required parameter 'body' is set
|
|
35970
|
+
if (body === undefined || body === null) {
|
|
35971
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsBotconnectorsOutgoingMessages';
|
|
35972
|
+
}
|
|
35973
|
+
|
|
35974
|
+
return this.apiClient.callApi(
|
|
35975
|
+
'/api/v2/integrations/botconnectors/outgoing/messages',
|
|
35976
|
+
'POST',
|
|
35977
|
+
{ },
|
|
35978
|
+
{ },
|
|
35979
|
+
{ },
|
|
35980
|
+
{ },
|
|
35981
|
+
body,
|
|
35982
|
+
['PureCloud OAuth'],
|
|
35983
|
+
['application/json'],
|
|
35984
|
+
['application/json']
|
|
35985
|
+
);
|
|
35986
|
+
}
|
|
35987
|
+
|
|
34986
35988
|
/**
|
|
34987
35989
|
* Create a set of credentials
|
|
34988
35990
|
*
|
|
@@ -35342,7 +36344,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35342
36344
|
/**
|
|
35343
36345
|
* Journey service.
|
|
35344
36346
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
35345
|
-
* @version
|
|
36347
|
+
* @version 224.0.0
|
|
35346
36348
|
*/
|
|
35347
36349
|
|
|
35348
36350
|
/**
|
|
@@ -37327,7 +38329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37327
38329
|
/**
|
|
37328
38330
|
* Knowledge service.
|
|
37329
38331
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
37330
|
-
* @version
|
|
38332
|
+
* @version 224.0.0
|
|
37331
38333
|
*/
|
|
37332
38334
|
|
|
37333
38335
|
/**
|
|
@@ -41200,7 +42202,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41200
42202
|
/**
|
|
41201
42203
|
* LanguageUnderstanding service.
|
|
41202
42204
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
41203
|
-
* @version
|
|
42205
|
+
* @version 224.0.0
|
|
41204
42206
|
*/
|
|
41205
42207
|
|
|
41206
42208
|
/**
|
|
@@ -42233,7 +43235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42233
43235
|
/**
|
|
42234
43236
|
* Languages service.
|
|
42235
43237
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
42236
|
-
* @version
|
|
43238
|
+
* @version 224.0.0
|
|
42237
43239
|
*/
|
|
42238
43240
|
|
|
42239
43241
|
/**
|
|
@@ -42455,7 +43457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42455
43457
|
/**
|
|
42456
43458
|
* Learning service.
|
|
42457
43459
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
42458
|
-
* @version
|
|
43460
|
+
* @version 224.0.0
|
|
42459
43461
|
*/
|
|
42460
43462
|
|
|
42461
43463
|
/**
|
|
@@ -43484,7 +44486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43484
44486
|
/**
|
|
43485
44487
|
* License service.
|
|
43486
44488
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
43487
|
-
* @version
|
|
44489
|
+
* @version 224.0.0
|
|
43488
44490
|
*/
|
|
43489
44491
|
|
|
43490
44492
|
/**
|
|
@@ -43722,7 +44724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43722
44724
|
/**
|
|
43723
44725
|
* Locations service.
|
|
43724
44726
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
43725
|
-
* @version
|
|
44727
|
+
* @version 224.0.0
|
|
43726
44728
|
*/
|
|
43727
44729
|
|
|
43728
44730
|
/**
|
|
@@ -43958,7 +44960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43958
44960
|
/**
|
|
43959
44961
|
* LogCapture service.
|
|
43960
44962
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
43961
|
-
* @version
|
|
44963
|
+
* @version 224.0.0
|
|
43962
44964
|
*/
|
|
43963
44965
|
|
|
43964
44966
|
/**
|
|
@@ -44100,7 +45102,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44100
45102
|
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
44101
45103
|
*
|
|
44102
45104
|
* @param {Object} opts Optional parameters
|
|
44103
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
44104
45105
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
44105
45106
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
44106
45107
|
* @param {Object} opts.body
|
|
@@ -44113,7 +45114,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44113
45114
|
'/api/v2/diagnostics/logcapture/browser/entries/query',
|
|
44114
45115
|
'POST',
|
|
44115
45116
|
{ },
|
|
44116
|
-
{ '
|
|
45117
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
44117
45118
|
{ },
|
|
44118
45119
|
{ },
|
|
44119
45120
|
opts['body'],
|
|
@@ -44158,7 +45159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44158
45159
|
/**
|
|
44159
45160
|
* Messaging service.
|
|
44160
45161
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
44161
|
-
* @version
|
|
45162
|
+
* @version 224.0.0
|
|
44162
45163
|
*/
|
|
44163
45164
|
|
|
44164
45165
|
/**
|
|
@@ -44517,7 +45518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44517
45518
|
/**
|
|
44518
45519
|
* MobileDevices service.
|
|
44519
45520
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
44520
|
-
* @version
|
|
45521
|
+
* @version 224.0.0
|
|
44521
45522
|
*/
|
|
44522
45523
|
|
|
44523
45524
|
/**
|
|
@@ -44668,7 +45669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44668
45669
|
/**
|
|
44669
45670
|
* Notifications service.
|
|
44670
45671
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
44671
|
-
* @version
|
|
45672
|
+
* @version 224.0.0
|
|
44672
45673
|
*/
|
|
44673
45674
|
|
|
44674
45675
|
/**
|
|
@@ -44901,7 +45902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44901
45902
|
/**
|
|
44902
45903
|
* OAuth service.
|
|
44903
45904
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
44904
|
-
* @version
|
|
45905
|
+
* @version 224.0.0
|
|
44905
45906
|
*/
|
|
44906
45907
|
|
|
44907
45908
|
/**
|
|
@@ -45267,7 +46268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45267
46268
|
/**
|
|
45268
46269
|
* Objects service.
|
|
45269
46270
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
45270
|
-
* @version
|
|
46271
|
+
* @version 224.0.0
|
|
45271
46272
|
*/
|
|
45272
46273
|
|
|
45273
46274
|
/**
|
|
@@ -45591,7 +46592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45591
46592
|
/**
|
|
45592
46593
|
* OperationalEvents service.
|
|
45593
46594
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
45594
|
-
* @version
|
|
46595
|
+
* @version 224.0.0
|
|
45595
46596
|
*/
|
|
45596
46597
|
|
|
45597
46598
|
/**
|
|
@@ -45708,7 +46709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45708
46709
|
/**
|
|
45709
46710
|
* Organization service.
|
|
45710
46711
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
45711
|
-
* @version
|
|
46712
|
+
* @version 224.0.0
|
|
45712
46713
|
*/
|
|
45713
46714
|
|
|
45714
46715
|
/**
|
|
@@ -46183,7 +47184,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46183
47184
|
/**
|
|
46184
47185
|
* OrganizationAuthorization service.
|
|
46185
47186
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
46186
|
-
* @version
|
|
47187
|
+
* @version 224.0.0
|
|
46187
47188
|
*/
|
|
46188
47189
|
|
|
46189
47190
|
/**
|
|
@@ -47577,7 +48578,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47577
48578
|
/**
|
|
47578
48579
|
* Outbound service.
|
|
47579
48580
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
47580
|
-
* @version
|
|
48581
|
+
* @version 224.0.0
|
|
47581
48582
|
*/
|
|
47582
48583
|
|
|
47583
48584
|
/**
|
|
@@ -52199,7 +53200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52199
53200
|
/**
|
|
52200
53201
|
* Presence service.
|
|
52201
53202
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
52202
|
-
* @version
|
|
53203
|
+
* @version 224.0.0
|
|
52203
53204
|
*/
|
|
52204
53205
|
|
|
52205
53206
|
/**
|
|
@@ -52943,7 +53944,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52943
53944
|
/**
|
|
52944
53945
|
* ProcessAutomation service.
|
|
52945
53946
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
52946
|
-
* @version
|
|
53947
|
+
* @version 224.0.0
|
|
52947
53948
|
*/
|
|
52948
53949
|
|
|
52949
53950
|
/**
|
|
@@ -53182,7 +54183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53182
54183
|
/**
|
|
53183
54184
|
* Quality service.
|
|
53184
54185
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
53185
|
-
* @version
|
|
54186
|
+
* @version 224.0.0
|
|
53186
54187
|
*/
|
|
53187
54188
|
|
|
53188
54189
|
/**
|
|
@@ -54969,7 +55970,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54969
55970
|
/**
|
|
54970
55971
|
* Recording service.
|
|
54971
55972
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
54972
|
-
* @version
|
|
55973
|
+
* @version 224.0.0
|
|
54973
55974
|
*/
|
|
54974
55975
|
|
|
54975
55976
|
/**
|
|
@@ -56574,7 +57575,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56574
57575
|
/**
|
|
56575
57576
|
* ResponseManagement service.
|
|
56576
57577
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
56577
|
-
* @version
|
|
57578
|
+
* @version 224.0.0
|
|
56578
57579
|
*/
|
|
56579
57580
|
|
|
56580
57581
|
/**
|
|
@@ -57084,7 +58085,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57084
58085
|
/**
|
|
57085
58086
|
* Routing service.
|
|
57086
58087
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
57087
|
-
* @version
|
|
58088
|
+
* @version 224.0.0
|
|
57088
58089
|
*/
|
|
57089
58090
|
|
|
57090
58091
|
/**
|
|
@@ -59998,6 +60999,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59998
60999
|
);
|
|
59999
61000
|
}
|
|
60000
61001
|
|
|
61002
|
+
/**
|
|
61003
|
+
* Update a phone number provisioned for SMS.
|
|
61004
|
+
*
|
|
61005
|
+
* @param {String} phoneNumberId phone number
|
|
61006
|
+
* @param {Object} body SmsPhoneNumberPatchRequest
|
|
61007
|
+
*/
|
|
61008
|
+
patchRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
61009
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
61010
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
61011
|
+
throw 'Missing the required parameter "phoneNumberId" when calling patchRoutingSmsPhonenumber';
|
|
61012
|
+
}
|
|
61013
|
+
// verify the required parameter 'body' is set
|
|
61014
|
+
if (body === undefined || body === null) {
|
|
61015
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSmsPhonenumber';
|
|
61016
|
+
}
|
|
61017
|
+
|
|
61018
|
+
return this.apiClient.callApi(
|
|
61019
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
61020
|
+
'PATCH',
|
|
61021
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
61022
|
+
{ },
|
|
61023
|
+
{ },
|
|
61024
|
+
{ },
|
|
61025
|
+
body,
|
|
61026
|
+
['PureCloud OAuth'],
|
|
61027
|
+
['application/json'],
|
|
61028
|
+
['application/json']
|
|
61029
|
+
);
|
|
61030
|
+
}
|
|
61031
|
+
|
|
60001
61032
|
/**
|
|
60002
61033
|
* Join or unjoin a queue for a user
|
|
60003
61034
|
*
|
|
@@ -61394,7 +62425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61394
62425
|
/**
|
|
61395
62426
|
* SCIM service.
|
|
61396
62427
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
61397
|
-
* @version
|
|
62428
|
+
* @version 224.0.0
|
|
61398
62429
|
*/
|
|
61399
62430
|
|
|
61400
62431
|
/**
|
|
@@ -62271,7 +63302,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62271
63302
|
/**
|
|
62272
63303
|
* ScreenRecording service.
|
|
62273
63304
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
62274
|
-
* @version
|
|
63305
|
+
* @version 224.0.0
|
|
62275
63306
|
*/
|
|
62276
63307
|
|
|
62277
63308
|
/**
|
|
@@ -62316,7 +63347,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62316
63347
|
/**
|
|
62317
63348
|
* Scripts service.
|
|
62318
63349
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
62319
|
-
* @version
|
|
63350
|
+
* @version 224.0.0
|
|
62320
63351
|
*/
|
|
62321
63352
|
|
|
62322
63353
|
/**
|
|
@@ -62792,7 +63823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62792
63823
|
/**
|
|
62793
63824
|
* Search service.
|
|
62794
63825
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
62795
|
-
* @version
|
|
63826
|
+
* @version 224.0.0
|
|
62796
63827
|
*/
|
|
62797
63828
|
|
|
62798
63829
|
/**
|
|
@@ -63535,7 +64566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63535
64566
|
/**
|
|
63536
64567
|
* Settings service.
|
|
63537
64568
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
63538
|
-
* @version
|
|
64569
|
+
* @version 224.0.0
|
|
63539
64570
|
*/
|
|
63540
64571
|
|
|
63541
64572
|
/**
|
|
@@ -63883,7 +64914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63883
64914
|
/**
|
|
63884
64915
|
* SocialMedia service.
|
|
63885
64916
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
63886
|
-
* @version
|
|
64917
|
+
* @version 224.0.0
|
|
63887
64918
|
*/
|
|
63888
64919
|
|
|
63889
64920
|
/**
|
|
@@ -64019,7 +65050,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64019
65050
|
* @param {String} openId openId
|
|
64020
65051
|
* @param {Object} opts Optional parameters
|
|
64021
65052
|
* @param {Boolean} opts.hardDelete Determines whether a open data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
64022
|
-
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64023
65053
|
*/
|
|
64024
65054
|
deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64025
65055
|
opts = opts || {};
|
|
@@ -64420,7 +65450,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64420
65450
|
* @param {String} openId openId
|
|
64421
65451
|
* @param {Object} opts Optional parameters
|
|
64422
65452
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
64423
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64424
65453
|
*/
|
|
64425
65454
|
getSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64426
65455
|
opts = opts || {};
|
|
@@ -64456,7 +65485,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64456
65485
|
* @param {String} dataIngestionRuleVersion version
|
|
64457
65486
|
* @param {Object} opts Optional parameters
|
|
64458
65487
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
64459
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64460
65488
|
*/
|
|
64461
65489
|
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId, openId, dataIngestionRuleVersion, opts) {
|
|
64462
65490
|
opts = opts || {};
|
|
@@ -64497,7 +65525,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64497
65525
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
64498
65526
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
64499
65527
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
64500
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64501
65528
|
*/
|
|
64502
65529
|
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId, openId, opts) {
|
|
64503
65530
|
opts = opts || {};
|
|
@@ -64731,7 +65758,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64731
65758
|
* @param {String} openId openId
|
|
64732
65759
|
* @param {Object} opts Optional parameters
|
|
64733
65760
|
* @param {Object} opts.body
|
|
64734
|
-
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64735
65761
|
*/
|
|
64736
65762
|
patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64737
65763
|
opts = opts || {};
|
|
@@ -64931,7 +65957,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64931
65957
|
* @param {String} topicId topicId
|
|
64932
65958
|
* @param {Object} opts Optional parameters
|
|
64933
65959
|
* @param {Object} opts.body
|
|
64934
|
-
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64935
65960
|
*/
|
|
64936
65961
|
postSocialmediaTopicDataingestionrulesOpen(topicId, opts) {
|
|
64937
65962
|
opts = opts || {};
|
|
@@ -64955,6 +65980,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64955
65980
|
);
|
|
64956
65981
|
}
|
|
64957
65982
|
|
|
65983
|
+
/**
|
|
65984
|
+
* Ingest a list of Open Social Messages
|
|
65985
|
+
* Ingest a list of open social messages to an ingestion rule on a topic. This endpoint will ingest and enrich these messages. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least social scope.
|
|
65986
|
+
* @param {String} topicId Topic ID
|
|
65987
|
+
* @param {String} ruleId Data Ingestion Rule ID
|
|
65988
|
+
* @param {Array.<Object>} body NormalizedMessage
|
|
65989
|
+
*/
|
|
65990
|
+
postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk(topicId, ruleId, body) {
|
|
65991
|
+
// verify the required parameter 'topicId' is set
|
|
65992
|
+
if (topicId === undefined || topicId === null) {
|
|
65993
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
65994
|
+
}
|
|
65995
|
+
// verify the required parameter 'ruleId' is set
|
|
65996
|
+
if (ruleId === undefined || ruleId === null) {
|
|
65997
|
+
throw 'Missing the required parameter "ruleId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
65998
|
+
}
|
|
65999
|
+
// verify the required parameter 'body' is set
|
|
66000
|
+
if (body === undefined || body === null) {
|
|
66001
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
66002
|
+
}
|
|
66003
|
+
|
|
66004
|
+
return this.apiClient.callApi(
|
|
66005
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/messages/bulk',
|
|
66006
|
+
'POST',
|
|
66007
|
+
{ 'topicId': topicId,'ruleId': ruleId },
|
|
66008
|
+
{ },
|
|
66009
|
+
{ },
|
|
66010
|
+
{ },
|
|
66011
|
+
body,
|
|
66012
|
+
['PureCloud OAuth'],
|
|
66013
|
+
['application/json'],
|
|
66014
|
+
['application/json']
|
|
66015
|
+
);
|
|
66016
|
+
}
|
|
66017
|
+
|
|
66018
|
+
/**
|
|
66019
|
+
* Ingest a list of Open Social Reactions
|
|
66020
|
+
* Ingest a list of open social reactions to an ingestion rule on a topic. This endpoint will ingest these reactions. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least social scope.
|
|
66021
|
+
* @param {String} topicId Topic ID
|
|
66022
|
+
* @param {String} ruleId Data Ingestion Rule ID
|
|
66023
|
+
* @param {Object} body NormalizedEvent
|
|
66024
|
+
*/
|
|
66025
|
+
postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk(topicId, ruleId, body) {
|
|
66026
|
+
// verify the required parameter 'topicId' is set
|
|
66027
|
+
if (topicId === undefined || topicId === null) {
|
|
66028
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
66029
|
+
}
|
|
66030
|
+
// verify the required parameter 'ruleId' is set
|
|
66031
|
+
if (ruleId === undefined || ruleId === null) {
|
|
66032
|
+
throw 'Missing the required parameter "ruleId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
66033
|
+
}
|
|
66034
|
+
// verify the required parameter 'body' is set
|
|
66035
|
+
if (body === undefined || body === null) {
|
|
66036
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
66037
|
+
}
|
|
66038
|
+
|
|
66039
|
+
return this.apiClient.callApi(
|
|
66040
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/reactions/bulk',
|
|
66041
|
+
'POST',
|
|
66042
|
+
{ 'topicId': topicId,'ruleId': ruleId },
|
|
66043
|
+
{ },
|
|
66044
|
+
{ },
|
|
66045
|
+
{ },
|
|
66046
|
+
body,
|
|
66047
|
+
['PureCloud OAuth'],
|
|
66048
|
+
['application/json'],
|
|
66049
|
+
['application/json']
|
|
66050
|
+
);
|
|
66051
|
+
}
|
|
66052
|
+
|
|
64958
66053
|
/**
|
|
64959
66054
|
* Create an twitter data ingestion rule.
|
|
64960
66055
|
*
|
|
@@ -65103,7 +66198,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65103
66198
|
* @param {String} openId openId
|
|
65104
66199
|
* @param {Object} opts Optional parameters
|
|
65105
66200
|
* @param {Object} opts.body
|
|
65106
|
-
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65107
66201
|
*/
|
|
65108
66202
|
putSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
65109
66203
|
opts = opts || {};
|
|
@@ -65171,7 +66265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65171
66265
|
/**
|
|
65172
66266
|
* SpeechTextAnalytics service.
|
|
65173
66267
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
65174
|
-
* @version
|
|
66268
|
+
* @version 224.0.0
|
|
65175
66269
|
*/
|
|
65176
66270
|
|
|
65177
66271
|
/**
|
|
@@ -66065,6 +67159,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66065
67159
|
);
|
|
66066
67160
|
}
|
|
66067
67161
|
|
|
67162
|
+
/**
|
|
67163
|
+
* Get a Speech and Text Analytics test topics phrase job by id
|
|
67164
|
+
*
|
|
67165
|
+
* @param {String} jobId the id of the test topic phrase job
|
|
67166
|
+
*/
|
|
67167
|
+
getSpeechandtextanalyticsTopicsTestphraseJob(jobId) {
|
|
67168
|
+
// verify the required parameter 'jobId' is set
|
|
67169
|
+
if (jobId === undefined || jobId === null) {
|
|
67170
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsTopicsTestphraseJob';
|
|
67171
|
+
}
|
|
67172
|
+
|
|
67173
|
+
return this.apiClient.callApi(
|
|
67174
|
+
'/api/v2/speechandtextanalytics/topics/testphrase/jobs/{jobId}',
|
|
67175
|
+
'GET',
|
|
67176
|
+
{ 'jobId': jobId },
|
|
67177
|
+
{ },
|
|
67178
|
+
{ },
|
|
67179
|
+
{ },
|
|
67180
|
+
null,
|
|
67181
|
+
['PureCloud OAuth'],
|
|
67182
|
+
['application/json'],
|
|
67183
|
+
['application/json']
|
|
67184
|
+
);
|
|
67185
|
+
}
|
|
67186
|
+
|
|
66068
67187
|
/**
|
|
66069
67188
|
* Translate a single interaction recording (or an email conversation)
|
|
66070
67189
|
*
|
|
@@ -66345,6 +67464,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66345
67464
|
);
|
|
66346
67465
|
}
|
|
66347
67466
|
|
|
67467
|
+
/**
|
|
67468
|
+
* Create new Speech and Text Analytics publish topics job
|
|
67469
|
+
*
|
|
67470
|
+
* @param {Object} body The publish test topic phrase job to create
|
|
67471
|
+
*/
|
|
67472
|
+
postSpeechandtextanalyticsTopicsTestphraseJobs(body) {
|
|
67473
|
+
// verify the required parameter 'body' is set
|
|
67474
|
+
if (body === undefined || body === null) {
|
|
67475
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsTopicsTestphraseJobs';
|
|
67476
|
+
}
|
|
67477
|
+
|
|
67478
|
+
return this.apiClient.callApi(
|
|
67479
|
+
'/api/v2/speechandtextanalytics/topics/testphrase/jobs',
|
|
67480
|
+
'POST',
|
|
67481
|
+
{ },
|
|
67482
|
+
{ },
|
|
67483
|
+
{ },
|
|
67484
|
+
{ },
|
|
67485
|
+
body,
|
|
67486
|
+
['PureCloud OAuth'],
|
|
67487
|
+
['application/json'],
|
|
67488
|
+
['application/json']
|
|
67489
|
+
);
|
|
67490
|
+
}
|
|
67491
|
+
|
|
66348
67492
|
/**
|
|
66349
67493
|
* Search resources.
|
|
66350
67494
|
*
|
|
@@ -66610,7 +67754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66610
67754
|
/**
|
|
66611
67755
|
* Stations service.
|
|
66612
67756
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
66613
|
-
* @version
|
|
67757
|
+
* @version 224.0.0
|
|
66614
67758
|
*/
|
|
66615
67759
|
|
|
66616
67760
|
/**
|
|
@@ -66712,7 +67856,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66712
67856
|
/**
|
|
66713
67857
|
* Suggest service.
|
|
66714
67858
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
66715
|
-
* @version
|
|
67859
|
+
* @version 224.0.0
|
|
66716
67860
|
*/
|
|
66717
67861
|
|
|
66718
67862
|
/**
|
|
@@ -66851,7 +67995,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66851
67995
|
/**
|
|
66852
67996
|
* TaskManagement service.
|
|
66853
67997
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
66854
|
-
* @version
|
|
67998
|
+
* @version 224.0.0
|
|
66855
67999
|
*/
|
|
66856
68000
|
|
|
66857
68001
|
/**
|
|
@@ -69013,7 +70157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69013
70157
|
/**
|
|
69014
70158
|
* Teams service.
|
|
69015
70159
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
69016
|
-
* @version
|
|
70160
|
+
* @version 224.0.0
|
|
69017
70161
|
*/
|
|
69018
70162
|
|
|
69019
70163
|
/**
|
|
@@ -69152,7 +70296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69152
70296
|
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
69153
70297
|
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
69154
70298
|
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
69155
|
-
* @param {Object} opts.expand Expand the
|
|
70299
|
+
* @param {Object} opts.expand Expand the division on each team
|
|
69156
70300
|
*/
|
|
69157
70301
|
getTeams(opts) {
|
|
69158
70302
|
opts = opts || {};
|
|
@@ -69318,7 +70462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69318
70462
|
/**
|
|
69319
70463
|
* Telephony service.
|
|
69320
70464
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
69321
|
-
* @version
|
|
70465
|
+
* @version 224.0.0
|
|
69322
70466
|
*/
|
|
69323
70467
|
|
|
69324
70468
|
/**
|
|
@@ -69500,7 +70644,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69500
70644
|
/**
|
|
69501
70645
|
* TelephonyProvidersEdge service.
|
|
69502
70646
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
69503
|
-
* @version
|
|
70647
|
+
* @version 224.0.0
|
|
69504
70648
|
*/
|
|
69505
70649
|
|
|
69506
70650
|
/**
|
|
@@ -70704,7 +71848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70704
71848
|
|
|
70705
71849
|
/**
|
|
70706
71850
|
* Get a pageable list of basic extension pool objects filterable by query parameters.
|
|
70707
|
-
* This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch
|
|
71851
|
+
* This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch extension pools that match the given ID(s) and not use any additional supplied query parameters in the search.
|
|
70708
71852
|
* @param {Object} opts Optional parameters
|
|
70709
71853
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
70710
71854
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -72281,6 +73425,47 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72281
73425
|
);
|
|
72282
73426
|
}
|
|
72283
73427
|
|
|
73428
|
+
/**
|
|
73429
|
+
* Post media endpoint statistics event.
|
|
73430
|
+
*
|
|
73431
|
+
* @param {String} conversationId Identifier of the conversation
|
|
73432
|
+
* @param {String} communicationId Identifier of the media session
|
|
73433
|
+
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
73434
|
+
* @param {Object} body MediaStatisticsPostRequest
|
|
73435
|
+
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73436
|
+
*/
|
|
73437
|
+
postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId, communicationId, mediaResourceId, body) {
|
|
73438
|
+
// verify the required parameter 'conversationId' is set
|
|
73439
|
+
if (conversationId === undefined || conversationId === null) {
|
|
73440
|
+
throw 'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
73441
|
+
}
|
|
73442
|
+
// verify the required parameter 'communicationId' is set
|
|
73443
|
+
if (communicationId === undefined || communicationId === null) {
|
|
73444
|
+
throw 'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
73445
|
+
}
|
|
73446
|
+
// verify the required parameter 'mediaResourceId' is set
|
|
73447
|
+
if (mediaResourceId === undefined || mediaResourceId === null) {
|
|
73448
|
+
throw 'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
73449
|
+
}
|
|
73450
|
+
// verify the required parameter 'body' is set
|
|
73451
|
+
if (body === undefined || body === null) {
|
|
73452
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
73453
|
+
}
|
|
73454
|
+
|
|
73455
|
+
return this.apiClient.callApi(
|
|
73456
|
+
'/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}',
|
|
73457
|
+
'POST',
|
|
73458
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'mediaResourceId': mediaResourceId },
|
|
73459
|
+
{ },
|
|
73460
|
+
{ },
|
|
73461
|
+
{ },
|
|
73462
|
+
body,
|
|
73463
|
+
['PureCloud OAuth'],
|
|
73464
|
+
['application/json'],
|
|
73465
|
+
['application/json']
|
|
73466
|
+
);
|
|
73467
|
+
}
|
|
73468
|
+
|
|
72284
73469
|
/**
|
|
72285
73470
|
* Reboot a Phone
|
|
72286
73471
|
*
|
|
@@ -72952,7 +74137,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72952
74137
|
/**
|
|
72953
74138
|
* Textbots service.
|
|
72954
74139
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
72955
|
-
* @version
|
|
74140
|
+
* @version 224.0.0
|
|
72956
74141
|
*/
|
|
72957
74142
|
|
|
72958
74143
|
/**
|
|
@@ -73081,7 +74266,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73081
74266
|
/**
|
|
73082
74267
|
* Tokens service.
|
|
73083
74268
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
73084
|
-
* @version
|
|
74269
|
+
* @version 224.0.0
|
|
73085
74270
|
*/
|
|
73086
74271
|
|
|
73087
74272
|
/**
|
|
@@ -73235,7 +74420,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73235
74420
|
/**
|
|
73236
74421
|
* Uploads service.
|
|
73237
74422
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
73238
|
-
* @version
|
|
74423
|
+
* @version 224.0.0
|
|
73239
74424
|
*/
|
|
73240
74425
|
|
|
73241
74426
|
/**
|
|
@@ -73526,7 +74711,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73526
74711
|
/**
|
|
73527
74712
|
* Usage service.
|
|
73528
74713
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
73529
|
-
* @version
|
|
74714
|
+
* @version 224.0.0
|
|
73530
74715
|
*/
|
|
73531
74716
|
|
|
73532
74717
|
/**
|
|
@@ -73741,7 +74926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73741
74926
|
/**
|
|
73742
74927
|
* UserRecordings service.
|
|
73743
74928
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
73744
|
-
* @version
|
|
74929
|
+
* @version 224.0.0
|
|
73745
74930
|
*/
|
|
73746
74931
|
|
|
73747
74932
|
/**
|
|
@@ -73956,7 +75141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73956
75141
|
/**
|
|
73957
75142
|
* Users service.
|
|
73958
75143
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
73959
|
-
* @version
|
|
75144
|
+
* @version 224.0.0
|
|
73960
75145
|
*/
|
|
73961
75146
|
|
|
73962
75147
|
/**
|
|
@@ -75545,6 +76730,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75545
76730
|
);
|
|
75546
76731
|
}
|
|
75547
76732
|
|
|
76733
|
+
/**
|
|
76734
|
+
* Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required
|
|
76735
|
+
*
|
|
76736
|
+
* @param {Object} opts Optional parameters
|
|
76737
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
76738
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
76739
|
+
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
76740
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
76741
|
+
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
76742
|
+
* @param {Object} opts.state Only list users of this state (default to active)
|
|
76743
|
+
* getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76744
|
+
*/
|
|
76745
|
+
getUsersQuery(opts) {
|
|
76746
|
+
opts = opts || {};
|
|
76747
|
+
|
|
76748
|
+
|
|
76749
|
+
return this.apiClient.callApi(
|
|
76750
|
+
'/api/v2/users/query',
|
|
76751
|
+
'GET',
|
|
76752
|
+
{ },
|
|
76753
|
+
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
76754
|
+
{ },
|
|
76755
|
+
{ },
|
|
76756
|
+
null,
|
|
76757
|
+
['PureCloud OAuth'],
|
|
76758
|
+
['application/json'],
|
|
76759
|
+
['application/json']
|
|
76760
|
+
);
|
|
76761
|
+
}
|
|
76762
|
+
|
|
75548
76763
|
/**
|
|
75549
76764
|
* Search users using the q64 value returned from a previous search
|
|
75550
76765
|
*
|
|
@@ -76909,7 +78124,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76909
78124
|
/**
|
|
76910
78125
|
* Utilities service.
|
|
76911
78126
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
76912
|
-
* @version
|
|
78127
|
+
* @version 224.0.0
|
|
76913
78128
|
*/
|
|
76914
78129
|
|
|
76915
78130
|
/**
|
|
@@ -77020,7 +78235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77020
78235
|
/**
|
|
77021
78236
|
* Voicemail service.
|
|
77022
78237
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
77023
|
-
* @version
|
|
78238
|
+
* @version 224.0.0
|
|
77024
78239
|
*/
|
|
77025
78240
|
|
|
77026
78241
|
/**
|
|
@@ -77276,7 +78491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77276
78491
|
|
|
77277
78492
|
/**
|
|
77278
78493
|
* Get media playback URI for this voicemail message
|
|
77279
|
-
*
|
|
78494
|
+
* API should migrate to use GET api/v2/voicemail/messages/{messageId}/downloads
|
|
77280
78495
|
* @param {String} messageId Message ID
|
|
77281
78496
|
* @param {Object} opts Optional parameters
|
|
77282
78497
|
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
@@ -77742,7 +78957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77742
78957
|
/**
|
|
77743
78958
|
* WebChat service.
|
|
77744
78959
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
77745
|
-
* @version
|
|
78960
|
+
* @version 224.0.0
|
|
77746
78961
|
*/
|
|
77747
78962
|
|
|
77748
78963
|
/**
|
|
@@ -78302,7 +79517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78302
79517
|
/**
|
|
78303
79518
|
* WebDeployments service.
|
|
78304
79519
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
78305
|
-
* @version
|
|
79520
|
+
* @version 224.0.0
|
|
78306
79521
|
*/
|
|
78307
79522
|
|
|
78308
79523
|
/**
|
|
@@ -78884,7 +80099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78884
80099
|
/**
|
|
78885
80100
|
* WebMessaging service.
|
|
78886
80101
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
78887
|
-
* @version
|
|
80102
|
+
* @version 224.0.0
|
|
78888
80103
|
*/
|
|
78889
80104
|
|
|
78890
80105
|
/**
|
|
@@ -78930,7 +80145,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78930
80145
|
/**
|
|
78931
80146
|
* Widgets service.
|
|
78932
80147
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
78933
|
-
* @version
|
|
80148
|
+
* @version 224.0.0
|
|
78934
80149
|
*/
|
|
78935
80150
|
|
|
78936
80151
|
/**
|
|
@@ -79081,7 +80296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79081
80296
|
/**
|
|
79082
80297
|
* WorkforceManagement service.
|
|
79083
80298
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
79084
|
-
* @version
|
|
80299
|
+
* @version 224.0.0
|
|
79085
80300
|
*/
|
|
79086
80301
|
|
|
79087
80302
|
/**
|
|
@@ -80694,6 +81909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80694
81909
|
* @param {String} businessUnitId The ID of the business unit
|
|
80695
81910
|
* @param {Object} opts Optional parameters
|
|
80696
81911
|
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
81912
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
80697
81913
|
*/
|
|
80698
81914
|
getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
80699
81915
|
opts = opts || {};
|
|
@@ -80707,7 +81923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80707
81923
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
80708
81924
|
'GET',
|
|
80709
81925
|
{ 'businessUnitId': businessUnitId },
|
|
80710
|
-
{ 'managementUnitId': opts['managementUnitId'] },
|
|
81926
|
+
{ 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
|
|
80711
81927
|
{ },
|
|
80712
81928
|
{ },
|
|
80713
81929
|
null,
|
|
@@ -82803,16 +84019,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82803
84019
|
* Update my alternative shifts trade by trade ID
|
|
82804
84020
|
*
|
|
82805
84021
|
* @param {String} tradeId The ID of the alternative shift trade
|
|
82806
|
-
* @param {Object}
|
|
82807
|
-
* @param {Object} opts.body body
|
|
84022
|
+
* @param {Object} body body
|
|
82808
84023
|
*/
|
|
82809
|
-
patchWorkforcemanagementAlternativeshiftsTrade(tradeId,
|
|
82810
|
-
opts = opts || {};
|
|
82811
|
-
|
|
84024
|
+
patchWorkforcemanagementAlternativeshiftsTrade(tradeId, body) {
|
|
82812
84025
|
// verify the required parameter 'tradeId' is set
|
|
82813
84026
|
if (tradeId === undefined || tradeId === null) {
|
|
82814
84027
|
throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
|
|
82815
84028
|
}
|
|
84029
|
+
// verify the required parameter 'body' is set
|
|
84030
|
+
if (body === undefined || body === null) {
|
|
84031
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTrade';
|
|
84032
|
+
}
|
|
82816
84033
|
|
|
82817
84034
|
return this.apiClient.callApi(
|
|
82818
84035
|
'/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
|
|
@@ -82821,7 +84038,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82821
84038
|
{ },
|
|
82822
84039
|
{ },
|
|
82823
84040
|
{ },
|
|
82824
|
-
|
|
84041
|
+
body,
|
|
82825
84042
|
['PureCloud OAuth'],
|
|
82826
84043
|
['application/json'],
|
|
82827
84044
|
['application/json']
|
|
@@ -82857,16 +84074,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82857
84074
|
* Update business unit
|
|
82858
84075
|
*
|
|
82859
84076
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
82860
|
-
* @param {Object}
|
|
82861
|
-
* @param {Object} opts.body body
|
|
84077
|
+
* @param {Object} body body
|
|
82862
84078
|
*/
|
|
82863
|
-
patchWorkforcemanagementBusinessunit(businessUnitId,
|
|
82864
|
-
opts = opts || {};
|
|
82865
|
-
|
|
84079
|
+
patchWorkforcemanagementBusinessunit(businessUnitId, body) {
|
|
82866
84080
|
// verify the required parameter 'businessUnitId' is set
|
|
82867
84081
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82868
84082
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunit';
|
|
82869
84083
|
}
|
|
84084
|
+
// verify the required parameter 'body' is set
|
|
84085
|
+
if (body === undefined || body === null) {
|
|
84086
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunit';
|
|
84087
|
+
}
|
|
82870
84088
|
|
|
82871
84089
|
return this.apiClient.callApi(
|
|
82872
84090
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
@@ -82875,7 +84093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82875
84093
|
{ },
|
|
82876
84094
|
{ },
|
|
82877
84095
|
{ },
|
|
82878
|
-
|
|
84096
|
+
body,
|
|
82879
84097
|
['PureCloud OAuth'],
|
|
82880
84098
|
['application/json'],
|
|
82881
84099
|
['application/json']
|
|
@@ -82887,12 +84105,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82887
84105
|
*
|
|
82888
84106
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
82889
84107
|
* @param {String} activityCodeId The ID of the activity code to update
|
|
82890
|
-
* @param {Object}
|
|
82891
|
-
* @param {Object} opts.body body
|
|
84108
|
+
* @param {Object} body body
|
|
82892
84109
|
*/
|
|
82893
|
-
patchWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId,
|
|
82894
|
-
opts = opts || {};
|
|
82895
|
-
|
|
84110
|
+
patchWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId, body) {
|
|
82896
84111
|
// verify the required parameter 'businessUnitId' is set
|
|
82897
84112
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82898
84113
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
@@ -82901,6 +84116,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82901
84116
|
if (activityCodeId === undefined || activityCodeId === null) {
|
|
82902
84117
|
throw 'Missing the required parameter "activityCodeId" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
82903
84118
|
}
|
|
84119
|
+
// verify the required parameter 'body' is set
|
|
84120
|
+
if (body === undefined || body === null) {
|
|
84121
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
84122
|
+
}
|
|
82904
84123
|
|
|
82905
84124
|
return this.apiClient.callApi(
|
|
82906
84125
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}',
|
|
@@ -82909,7 +84128,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82909
84128
|
{ },
|
|
82910
84129
|
{ },
|
|
82911
84130
|
{ },
|
|
82912
|
-
|
|
84131
|
+
body,
|
|
82913
84132
|
['PureCloud OAuth'],
|
|
82914
84133
|
['application/json'],
|
|
82915
84134
|
['application/json']
|
|
@@ -82955,16 +84174,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82955
84174
|
* Update alternative shifts settings for a business unit
|
|
82956
84175
|
*
|
|
82957
84176
|
* @param {String} businessUnitId The ID of the business unit
|
|
82958
|
-
* @param {Object}
|
|
82959
|
-
* @param {Object} opts.body body
|
|
84177
|
+
* @param {Object} body body
|
|
82960
84178
|
*/
|
|
82961
|
-
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId,
|
|
82962
|
-
opts = opts || {};
|
|
82963
|
-
|
|
84179
|
+
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, body) {
|
|
82964
84180
|
// verify the required parameter 'businessUnitId' is set
|
|
82965
84181
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82966
84182
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
82967
84183
|
}
|
|
84184
|
+
// verify the required parameter 'body' is set
|
|
84185
|
+
if (body === undefined || body === null) {
|
|
84186
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
84187
|
+
}
|
|
82968
84188
|
|
|
82969
84189
|
return this.apiClient.callApi(
|
|
82970
84190
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
|
|
@@ -82973,7 +84193,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82973
84193
|
{ },
|
|
82974
84194
|
{ },
|
|
82975
84195
|
{ },
|
|
82976
|
-
|
|
84196
|
+
body,
|
|
82977
84197
|
['PureCloud OAuth'],
|
|
82978
84198
|
['application/json'],
|
|
82979
84199
|
['application/json']
|
|
@@ -82985,12 +84205,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82985
84205
|
*
|
|
82986
84206
|
* @param {String} businessUnitId The ID of the business unit.
|
|
82987
84207
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
82988
|
-
* @param {Object}
|
|
82989
|
-
* @param {Object} opts.body body
|
|
84208
|
+
* @param {Object} body body
|
|
82990
84209
|
*/
|
|
82991
|
-
patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId,
|
|
82992
|
-
opts = opts || {};
|
|
82993
|
-
|
|
84210
|
+
patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId, body) {
|
|
82994
84211
|
// verify the required parameter 'businessUnitId' is set
|
|
82995
84212
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82996
84213
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
@@ -82999,6 +84216,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82999
84216
|
if (planningGroupId === undefined || planningGroupId === null) {
|
|
83000
84217
|
throw 'Missing the required parameter "planningGroupId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
83001
84218
|
}
|
|
84219
|
+
// verify the required parameter 'body' is set
|
|
84220
|
+
if (body === undefined || body === null) {
|
|
84221
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
84222
|
+
}
|
|
83002
84223
|
|
|
83003
84224
|
return this.apiClient.callApi(
|
|
83004
84225
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}',
|
|
@@ -83007,7 +84228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83007
84228
|
{ },
|
|
83008
84229
|
{ },
|
|
83009
84230
|
{ },
|
|
83010
|
-
|
|
84231
|
+
body,
|
|
83011
84232
|
['PureCloud OAuth'],
|
|
83012
84233
|
['application/json'],
|
|
83013
84234
|
['application/json']
|
|
@@ -83019,12 +84240,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83019
84240
|
*
|
|
83020
84241
|
* @param {String} businessUnitId The ID of the business unit
|
|
83021
84242
|
* @param {String} runId The ID of the schedule run
|
|
83022
|
-
* @param {Object}
|
|
83023
|
-
* @param {Object} opts.body body
|
|
84243
|
+
* @param {Object} body body
|
|
83024
84244
|
*/
|
|
83025
|
-
patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId,
|
|
83026
|
-
opts = opts || {};
|
|
83027
|
-
|
|
84245
|
+
patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId, body) {
|
|
83028
84246
|
// verify the required parameter 'businessUnitId' is set
|
|
83029
84247
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83030
84248
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
@@ -83033,6 +84251,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83033
84251
|
if (runId === undefined || runId === null) {
|
|
83034
84252
|
throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
83035
84253
|
}
|
|
84254
|
+
// verify the required parameter 'body' is set
|
|
84255
|
+
if (body === undefined || body === null) {
|
|
84256
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
84257
|
+
}
|
|
83036
84258
|
|
|
83037
84259
|
return this.apiClient.callApi(
|
|
83038
84260
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}',
|
|
@@ -83041,7 +84263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83041
84263
|
{ },
|
|
83042
84264
|
{ },
|
|
83043
84265
|
{ },
|
|
83044
|
-
|
|
84266
|
+
body,
|
|
83045
84267
|
['PureCloud OAuth'],
|
|
83046
84268
|
['application/json'],
|
|
83047
84269
|
['application/json']
|
|
@@ -83053,12 +84275,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83053
84275
|
*
|
|
83054
84276
|
* @param {String} businessUnitId The ID of the business unit.
|
|
83055
84277
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to update
|
|
83056
|
-
* @param {Object}
|
|
83057
|
-
* @param {Object} opts.body body
|
|
84278
|
+
* @param {Object} body body
|
|
83058
84279
|
*/
|
|
83059
|
-
patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId,
|
|
83060
|
-
opts = opts || {};
|
|
83061
|
-
|
|
84280
|
+
patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, body) {
|
|
83062
84281
|
// verify the required parameter 'businessUnitId' is set
|
|
83063
84282
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83064
84283
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -83067,6 +84286,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83067
84286
|
if (serviceGoalTemplateId === undefined || serviceGoalTemplateId === null) {
|
|
83068
84287
|
throw 'Missing the required parameter "serviceGoalTemplateId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
83069
84288
|
}
|
|
84289
|
+
// verify the required parameter 'body' is set
|
|
84290
|
+
if (body === undefined || body === null) {
|
|
84291
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
84292
|
+
}
|
|
83070
84293
|
|
|
83071
84294
|
return this.apiClient.callApi(
|
|
83072
84295
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
@@ -83075,7 +84298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83075
84298
|
{ },
|
|
83076
84299
|
{ },
|
|
83077
84300
|
{ },
|
|
83078
|
-
|
|
84301
|
+
body,
|
|
83079
84302
|
['PureCloud OAuth'],
|
|
83080
84303
|
['application/json'],
|
|
83081
84304
|
['application/json']
|
|
@@ -83087,12 +84310,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83087
84310
|
*
|
|
83088
84311
|
* @param {String} businessUnitId The ID of the business unit
|
|
83089
84312
|
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
83090
|
-
* @param {Object}
|
|
83091
|
-
* @param {Object} opts.body body
|
|
84313
|
+
* @param {Object} body body
|
|
83092
84314
|
*/
|
|
83093
|
-
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId,
|
|
83094
|
-
opts = opts || {};
|
|
83095
|
-
|
|
84315
|
+
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, body) {
|
|
83096
84316
|
// verify the required parameter 'businessUnitId' is set
|
|
83097
84317
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83098
84318
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
@@ -83101,6 +84321,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83101
84321
|
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
83102
84322
|
throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
83103
84323
|
}
|
|
84324
|
+
// verify the required parameter 'body' is set
|
|
84325
|
+
if (body === undefined || body === null) {
|
|
84326
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
84327
|
+
}
|
|
83104
84328
|
|
|
83105
84329
|
return this.apiClient.callApi(
|
|
83106
84330
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
@@ -83109,7 +84333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83109
84333
|
{ },
|
|
83110
84334
|
{ },
|
|
83111
84335
|
{ },
|
|
83112
|
-
|
|
84336
|
+
body,
|
|
83113
84337
|
['PureCloud OAuth'],
|
|
83114
84338
|
['application/json'],
|
|
83115
84339
|
['application/json']
|
|
@@ -83121,12 +84345,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83121
84345
|
*
|
|
83122
84346
|
* @param {String} businessUnitId The ID of the business unit
|
|
83123
84347
|
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
83124
|
-
* @param {Object}
|
|
83125
|
-
* @param {Object} opts.body body
|
|
84348
|
+
* @param {Object} body body
|
|
83126
84349
|
*/
|
|
83127
|
-
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId,
|
|
83128
|
-
opts = opts || {};
|
|
83129
|
-
|
|
84350
|
+
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, body) {
|
|
83130
84351
|
// verify the required parameter 'businessUnitId' is set
|
|
83131
84352
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83132
84353
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
@@ -83135,6 +84356,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83135
84356
|
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
83136
84357
|
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
83137
84358
|
}
|
|
84359
|
+
// verify the required parameter 'body' is set
|
|
84360
|
+
if (body === undefined || body === null) {
|
|
84361
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
84362
|
+
}
|
|
83138
84363
|
|
|
83139
84364
|
return this.apiClient.callApi(
|
|
83140
84365
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
@@ -83143,7 +84368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83143
84368
|
{ },
|
|
83144
84369
|
{ },
|
|
83145
84370
|
{ },
|
|
83146
|
-
|
|
84371
|
+
body,
|
|
83147
84372
|
['PureCloud OAuth'],
|
|
83148
84373
|
['application/json'],
|
|
83149
84374
|
['application/json']
|
|
@@ -83191,12 +84416,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83191
84416
|
* @param {String} businessUnitId The ID of the business unit
|
|
83192
84417
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
83193
84418
|
* @param {String} bidGroupId Work Plan Bid Group id
|
|
83194
|
-
* @param {Object}
|
|
83195
|
-
* @param {Object} opts.body body
|
|
84419
|
+
* @param {Object} body body
|
|
83196
84420
|
*/
|
|
83197
|
-
patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId,
|
|
83198
|
-
opts = opts || {};
|
|
83199
|
-
|
|
84421
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, body) {
|
|
83200
84422
|
// verify the required parameter 'businessUnitId' is set
|
|
83201
84423
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83202
84424
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
@@ -83209,6 +84431,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83209
84431
|
if (bidGroupId === undefined || bidGroupId === null) {
|
|
83210
84432
|
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
83211
84433
|
}
|
|
84434
|
+
// verify the required parameter 'body' is set
|
|
84435
|
+
if (body === undefined || body === null) {
|
|
84436
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
84437
|
+
}
|
|
83212
84438
|
|
|
83213
84439
|
return this.apiClient.callApi(
|
|
83214
84440
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
@@ -83217,7 +84443,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83217
84443
|
{ },
|
|
83218
84444
|
{ },
|
|
83219
84445
|
{ },
|
|
83220
|
-
|
|
84446
|
+
body,
|
|
83221
84447
|
['PureCloud OAuth'],
|
|
83222
84448
|
['application/json'],
|
|
83223
84449
|
['application/json']
|
|
@@ -83230,12 +84456,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83230
84456
|
* @param {String} businessUnitId The ID of the business unit
|
|
83231
84457
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
83232
84458
|
* @param {String} bidGroupId The ID of the work plan bid group
|
|
83233
|
-
* @param {Object}
|
|
83234
|
-
* @param {Object} opts.body body
|
|
84459
|
+
* @param {Object} body body
|
|
83235
84460
|
*/
|
|
83236
|
-
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId,
|
|
83237
|
-
opts = opts || {};
|
|
83238
|
-
|
|
84461
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, body) {
|
|
83239
84462
|
// verify the required parameter 'businessUnitId' is set
|
|
83240
84463
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83241
84464
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
@@ -83248,6 +84471,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83248
84471
|
if (bidGroupId === undefined || bidGroupId === null) {
|
|
83249
84472
|
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
83250
84473
|
}
|
|
84474
|
+
// verify the required parameter 'body' is set
|
|
84475
|
+
if (body === undefined || body === null) {
|
|
84476
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
84477
|
+
}
|
|
83251
84478
|
|
|
83252
84479
|
return this.apiClient.callApi(
|
|
83253
84480
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
|
|
@@ -83256,7 +84483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83256
84483
|
{ },
|
|
83257
84484
|
{ },
|
|
83258
84485
|
{ },
|
|
83259
|
-
|
|
84486
|
+
body,
|
|
83260
84487
|
['PureCloud OAuth'],
|
|
83261
84488
|
['application/json'],
|
|
83262
84489
|
['application/json']
|
|
@@ -83267,16 +84494,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83267
84494
|
* Update the requested management unit
|
|
83268
84495
|
*
|
|
83269
84496
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83270
|
-
* @param {Object}
|
|
83271
|
-
* @param {Object} opts.body body
|
|
84497
|
+
* @param {Object} body body
|
|
83272
84498
|
*/
|
|
83273
|
-
patchWorkforcemanagementManagementunit(managementUnitId,
|
|
83274
|
-
opts = opts || {};
|
|
83275
|
-
|
|
84499
|
+
patchWorkforcemanagementManagementunit(managementUnitId, body) {
|
|
83276
84500
|
// verify the required parameter 'managementUnitId' is set
|
|
83277
84501
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83278
84502
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunit';
|
|
83279
84503
|
}
|
|
84504
|
+
// verify the required parameter 'body' is set
|
|
84505
|
+
if (body === undefined || body === null) {
|
|
84506
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunit';
|
|
84507
|
+
}
|
|
83280
84508
|
|
|
83281
84509
|
return this.apiClient.callApi(
|
|
83282
84510
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}',
|
|
@@ -83285,7 +84513,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83285
84513
|
{ },
|
|
83286
84514
|
{ },
|
|
83287
84515
|
{ },
|
|
83288
|
-
|
|
84516
|
+
body,
|
|
83289
84517
|
['PureCloud OAuth'],
|
|
83290
84518
|
['application/json'],
|
|
83291
84519
|
['application/json']
|
|
@@ -83296,16 +84524,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83296
84524
|
* Update agent configurations
|
|
83297
84525
|
*
|
|
83298
84526
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83299
|
-
* @param {Object}
|
|
83300
|
-
* @param {Object} opts.body body
|
|
84527
|
+
* @param {Object} body body
|
|
83301
84528
|
*/
|
|
83302
|
-
patchWorkforcemanagementManagementunitAgents(managementUnitId,
|
|
83303
|
-
opts = opts || {};
|
|
83304
|
-
|
|
84529
|
+
patchWorkforcemanagementManagementunitAgents(managementUnitId, body) {
|
|
83305
84530
|
// verify the required parameter 'managementUnitId' is set
|
|
83306
84531
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83307
84532
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
|
|
83308
84533
|
}
|
|
84534
|
+
// verify the required parameter 'body' is set
|
|
84535
|
+
if (body === undefined || body === null) {
|
|
84536
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitAgents';
|
|
84537
|
+
}
|
|
83309
84538
|
|
|
83310
84539
|
return this.apiClient.callApi(
|
|
83311
84540
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
|
|
@@ -83314,7 +84543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83314
84543
|
{ },
|
|
83315
84544
|
{ },
|
|
83316
84545
|
{ },
|
|
83317
|
-
|
|
84546
|
+
body,
|
|
83318
84547
|
['PureCloud OAuth'],
|
|
83319
84548
|
['application/json'],
|
|
83320
84549
|
['application/json']
|
|
@@ -83325,16 +84554,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83325
84554
|
* Updates agent work plan configuration
|
|
83326
84555
|
*
|
|
83327
84556
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83328
|
-
* @param {Object}
|
|
83329
|
-
* @param {Object} opts.body body
|
|
84557
|
+
* @param {Object} body body
|
|
83330
84558
|
*/
|
|
83331
|
-
patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId,
|
|
83332
|
-
opts = opts || {};
|
|
83333
|
-
|
|
84559
|
+
patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId, body) {
|
|
83334
84560
|
// verify the required parameter 'managementUnitId' is set
|
|
83335
84561
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83336
84562
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';
|
|
83337
84563
|
}
|
|
84564
|
+
// verify the required parameter 'body' is set
|
|
84565
|
+
if (body === undefined || body === null) {
|
|
84566
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';
|
|
84567
|
+
}
|
|
83338
84568
|
|
|
83339
84569
|
return this.apiClient.callApi(
|
|
83340
84570
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk',
|
|
@@ -83343,7 +84573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83343
84573
|
{ },
|
|
83344
84574
|
{ },
|
|
83345
84575
|
{ },
|
|
83346
|
-
|
|
84576
|
+
body,
|
|
83347
84577
|
['PureCloud OAuth'],
|
|
83348
84578
|
['application/json'],
|
|
83349
84579
|
['application/json']
|
|
@@ -83355,12 +84585,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83355
84585
|
* Updates time off limit object properties, but not daily values.
|
|
83356
84586
|
* @param {String} managementUnitId The ID of the management unit.
|
|
83357
84587
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
83358
|
-
* @param {Object}
|
|
83359
|
-
* @param {Object} opts.body body
|
|
84588
|
+
* @param {Object} body body
|
|
83360
84589
|
*/
|
|
83361
|
-
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId,
|
|
83362
|
-
opts = opts || {};
|
|
83363
|
-
|
|
84590
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, body) {
|
|
83364
84591
|
// verify the required parameter 'managementUnitId' is set
|
|
83365
84592
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83366
84593
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
@@ -83369,6 +84596,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83369
84596
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
83370
84597
|
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
83371
84598
|
}
|
|
84599
|
+
// verify the required parameter 'body' is set
|
|
84600
|
+
if (body === undefined || body === null) {
|
|
84601
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
84602
|
+
}
|
|
83372
84603
|
|
|
83373
84604
|
return this.apiClient.callApi(
|
|
83374
84605
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
@@ -83377,7 +84608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83377
84608
|
{ },
|
|
83378
84609
|
{ },
|
|
83379
84610
|
{ },
|
|
83380
|
-
|
|
84611
|
+
body,
|
|
83381
84612
|
['PureCloud OAuth'],
|
|
83382
84613
|
['application/json'],
|
|
83383
84614
|
['application/json']
|
|
@@ -83389,12 +84620,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83389
84620
|
*
|
|
83390
84621
|
* @param {String} managementUnitId The ID of the management unit
|
|
83391
84622
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
83392
|
-
* @param {Object}
|
|
83393
|
-
* @param {Object} opts.body body
|
|
84623
|
+
* @param {Object} body body
|
|
83394
84624
|
*/
|
|
83395
|
-
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId,
|
|
83396
|
-
opts = opts || {};
|
|
83397
|
-
|
|
84625
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, body) {
|
|
83398
84626
|
// verify the required parameter 'managementUnitId' is set
|
|
83399
84627
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83400
84628
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
@@ -83403,6 +84631,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83403
84631
|
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
83404
84632
|
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
83405
84633
|
}
|
|
84634
|
+
// verify the required parameter 'body' is set
|
|
84635
|
+
if (body === undefined || body === null) {
|
|
84636
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
84637
|
+
}
|
|
83406
84638
|
|
|
83407
84639
|
return this.apiClient.callApi(
|
|
83408
84640
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
@@ -83411,7 +84643,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83411
84643
|
{ },
|
|
83412
84644
|
{ },
|
|
83413
84645
|
{ },
|
|
83414
|
-
|
|
84646
|
+
body,
|
|
83415
84647
|
['PureCloud OAuth'],
|
|
83416
84648
|
['application/json'],
|
|
83417
84649
|
['application/json']
|
|
@@ -83424,12 +84656,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83424
84656
|
* @param {String} managementUnitId The ID of the management unit.
|
|
83425
84657
|
* @param {String} timeOffRequestId The ID of the time off request.
|
|
83426
84658
|
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
83427
|
-
* @param {Object}
|
|
83428
|
-
* @param {Object} opts.body body
|
|
84659
|
+
* @param {Object} body body
|
|
83429
84660
|
*/
|
|
83430
|
-
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId,
|
|
83431
|
-
opts = opts || {};
|
|
83432
|
-
|
|
84661
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, body) {
|
|
83433
84662
|
// verify the required parameter 'managementUnitId' is set
|
|
83434
84663
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83435
84664
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
@@ -83442,6 +84671,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83442
84671
|
if (userId === undefined || userId === null) {
|
|
83443
84672
|
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
83444
84673
|
}
|
|
84674
|
+
// verify the required parameter 'body' is set
|
|
84675
|
+
if (body === undefined || body === null) {
|
|
84676
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
84677
|
+
}
|
|
83445
84678
|
|
|
83446
84679
|
return this.apiClient.callApi(
|
|
83447
84680
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
@@ -83450,7 +84683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83450
84683
|
{ },
|
|
83451
84684
|
{ },
|
|
83452
84685
|
{ },
|
|
83453
|
-
|
|
84686
|
+
body,
|
|
83454
84687
|
['PureCloud OAuth'],
|
|
83455
84688
|
['application/json'],
|
|
83456
84689
|
['application/json']
|
|
@@ -83463,12 +84696,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83463
84696
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83464
84697
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
83465
84698
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
83466
|
-
* @param {Object}
|
|
83467
|
-
* @param {Object} opts.body body
|
|
84699
|
+
* @param {Object} body body
|
|
83468
84700
|
*/
|
|
83469
|
-
patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId,
|
|
83470
|
-
opts = opts || {};
|
|
83471
|
-
|
|
84701
|
+
patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId, body) {
|
|
83472
84702
|
// verify the required parameter 'managementUnitId' is set
|
|
83473
84703
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83474
84704
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
@@ -83481,6 +84711,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83481
84711
|
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
83482
84712
|
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
83483
84713
|
}
|
|
84714
|
+
// verify the required parameter 'body' is set
|
|
84715
|
+
if (body === undefined || body === null) {
|
|
84716
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
84717
|
+
}
|
|
83484
84718
|
|
|
83485
84719
|
return this.apiClient.callApi(
|
|
83486
84720
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}',
|
|
@@ -83489,7 +84723,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83489
84723
|
{ },
|
|
83490
84724
|
{ },
|
|
83491
84725
|
{ },
|
|
83492
|
-
|
|
84726
|
+
body,
|
|
83493
84727
|
['PureCloud OAuth'],
|
|
83494
84728
|
['application/json'],
|
|
83495
84729
|
['application/json']
|
|
@@ -83541,11 +84775,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83541
84775
|
*
|
|
83542
84776
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83543
84777
|
* @param {String} workPlanId The ID of the work plan to update
|
|
84778
|
+
* @param {Object} body body
|
|
83544
84779
|
* @param {Object} opts Optional parameters
|
|
83545
84780
|
* @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
|
|
83546
|
-
* @param {Object} opts.body body
|
|
83547
84781
|
*/
|
|
83548
|
-
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
|
|
84782
|
+
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, body, opts) {
|
|
83549
84783
|
opts = opts || {};
|
|
83550
84784
|
|
|
83551
84785
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -83556,6 +84790,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83556
84790
|
if (workPlanId === undefined || workPlanId === null) {
|
|
83557
84791
|
throw 'Missing the required parameter "workPlanId" when calling patchWorkforcemanagementManagementunitWorkplan';
|
|
83558
84792
|
}
|
|
84793
|
+
// verify the required parameter 'body' is set
|
|
84794
|
+
if (body === undefined || body === null) {
|
|
84795
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWorkplan';
|
|
84796
|
+
}
|
|
83559
84797
|
|
|
83560
84798
|
return this.apiClient.callApi(
|
|
83561
84799
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
@@ -83564,7 +84802,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83564
84802
|
{ 'validationMode': opts['validationMode'] },
|
|
83565
84803
|
{ },
|
|
83566
84804
|
{ },
|
|
83567
|
-
|
|
84805
|
+
body,
|
|
83568
84806
|
['PureCloud OAuth'],
|
|
83569
84807
|
['application/json'],
|
|
83570
84808
|
['application/json']
|
|
@@ -83576,12 +84814,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83576
84814
|
*
|
|
83577
84815
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83578
84816
|
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
83579
|
-
* @param {Object}
|
|
83580
|
-
* @param {Object} opts.body body
|
|
84817
|
+
* @param {Object} body body
|
|
83581
84818
|
*/
|
|
83582
|
-
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId,
|
|
83583
|
-
opts = opts || {};
|
|
83584
|
-
|
|
84819
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, body) {
|
|
83585
84820
|
// verify the required parameter 'managementUnitId' is set
|
|
83586
84821
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83587
84822
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
@@ -83590,6 +84825,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83590
84825
|
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
83591
84826
|
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
83592
84827
|
}
|
|
84828
|
+
// verify the required parameter 'body' is set
|
|
84829
|
+
if (body === undefined || body === null) {
|
|
84830
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
84831
|
+
}
|
|
83593
84832
|
|
|
83594
84833
|
return this.apiClient.callApi(
|
|
83595
84834
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
@@ -83598,7 +84837,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83598
84837
|
{ },
|
|
83599
84838
|
{ },
|
|
83600
84839
|
{ },
|
|
83601
|
-
|
|
84840
|
+
body,
|
|
83602
84841
|
['PureCloud OAuth'],
|
|
83603
84842
|
['application/json'],
|
|
83604
84843
|
['application/json']
|
|
@@ -83609,16 +84848,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83609
84848
|
* Update a time off request for the current user
|
|
83610
84849
|
*
|
|
83611
84850
|
* @param {String} timeOffRequestId The ID of the time off request
|
|
83612
|
-
* @param {Object}
|
|
83613
|
-
* @param {Object} opts.body body
|
|
84851
|
+
* @param {Object} body body
|
|
83614
84852
|
*/
|
|
83615
|
-
patchWorkforcemanagementTimeoffrequest(timeOffRequestId,
|
|
83616
|
-
opts = opts || {};
|
|
83617
|
-
|
|
84853
|
+
patchWorkforcemanagementTimeoffrequest(timeOffRequestId, body) {
|
|
83618
84854
|
// verify the required parameter 'timeOffRequestId' is set
|
|
83619
84855
|
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
83620
84856
|
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementTimeoffrequest';
|
|
83621
84857
|
}
|
|
84858
|
+
// verify the required parameter 'body' is set
|
|
84859
|
+
if (body === undefined || body === null) {
|
|
84860
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementTimeoffrequest';
|
|
84861
|
+
}
|
|
83622
84862
|
|
|
83623
84863
|
return this.apiClient.callApi(
|
|
83624
84864
|
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}',
|
|
@@ -83627,7 +84867,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83627
84867
|
{ },
|
|
83628
84868
|
{ },
|
|
83629
84869
|
{ },
|
|
83630
|
-
|
|
84870
|
+
body,
|
|
83631
84871
|
['PureCloud OAuth'],
|
|
83632
84872
|
['application/json'],
|
|
83633
84873
|
['application/json']
|
|
@@ -83638,16 +84878,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83638
84878
|
* Update work plan bid ranks for a user
|
|
83639
84879
|
*
|
|
83640
84880
|
* @param {String} userId The userId to whom the work plan bid ranks apply.
|
|
83641
|
-
* @param {Object}
|
|
83642
|
-
* @param {Object} opts.body body
|
|
84881
|
+
* @param {Object} body body
|
|
83643
84882
|
*/
|
|
83644
|
-
patchWorkforcemanagementUserWorkplanbidranks(userId,
|
|
83645
|
-
opts = opts || {};
|
|
83646
|
-
|
|
84883
|
+
patchWorkforcemanagementUserWorkplanbidranks(userId, body) {
|
|
83647
84884
|
// verify the required parameter 'userId' is set
|
|
83648
84885
|
if (userId === undefined || userId === null) {
|
|
83649
84886
|
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
|
|
83650
84887
|
}
|
|
84888
|
+
// verify the required parameter 'body' is set
|
|
84889
|
+
if (body === undefined || body === null) {
|
|
84890
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUserWorkplanbidranks';
|
|
84891
|
+
}
|
|
83651
84892
|
|
|
83652
84893
|
return this.apiClient.callApi(
|
|
83653
84894
|
'/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
|
|
@@ -83656,7 +84897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83656
84897
|
{ },
|
|
83657
84898
|
{ },
|
|
83658
84899
|
{ },
|
|
83659
|
-
|
|
84900
|
+
body,
|
|
83660
84901
|
['PureCloud OAuth'],
|
|
83661
84902
|
['application/json'],
|
|
83662
84903
|
['application/json']
|
|
@@ -83692,16 +84933,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83692
84933
|
* Update an agent's work plan bidding preference
|
|
83693
84934
|
*
|
|
83694
84935
|
* @param {String} bidId The ID of the work plan bid
|
|
83695
|
-
* @param {Object}
|
|
83696
|
-
* @param {Object} opts.body body
|
|
84936
|
+
* @param {Object} body body
|
|
83697
84937
|
*/
|
|
83698
|
-
patchWorkforcemanagementWorkplanbidPreferences(bidId,
|
|
83699
|
-
opts = opts || {};
|
|
83700
|
-
|
|
84938
|
+
patchWorkforcemanagementWorkplanbidPreferences(bidId, body) {
|
|
83701
84939
|
// verify the required parameter 'bidId' is set
|
|
83702
84940
|
if (bidId === undefined || bidId === null) {
|
|
83703
84941
|
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
|
|
83704
84942
|
}
|
|
84943
|
+
// verify the required parameter 'body' is set
|
|
84944
|
+
if (body === undefined || body === null) {
|
|
84945
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementWorkplanbidPreferences';
|
|
84946
|
+
}
|
|
83705
84947
|
|
|
83706
84948
|
return this.apiClient.callApi(
|
|
83707
84949
|
'/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
|
|
@@ -83710,7 +84952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83710
84952
|
{ },
|
|
83711
84953
|
{ },
|
|
83712
84954
|
{ },
|
|
83713
|
-
|
|
84955
|
+
body,
|
|
83714
84956
|
['PureCloud OAuth'],
|
|
83715
84957
|
['application/json'],
|
|
83716
84958
|
['application/json']
|
|
@@ -83800,12 +85042,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83800
85042
|
/**
|
|
83801
85043
|
* Request a historical adherence report in bulk
|
|
83802
85044
|
*
|
|
83803
|
-
* @param {Object}
|
|
83804
|
-
* @param {Object} opts.body body
|
|
85045
|
+
* @param {Object} body body
|
|
83805
85046
|
*/
|
|
83806
|
-
postWorkforcemanagementAdherenceHistoricalBulk(
|
|
83807
|
-
|
|
83808
|
-
|
|
85047
|
+
postWorkforcemanagementAdherenceHistoricalBulk(body) {
|
|
85048
|
+
// verify the required parameter 'body' is set
|
|
85049
|
+
if (body === undefined || body === null) {
|
|
85050
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceHistoricalBulk';
|
|
85051
|
+
}
|
|
83809
85052
|
|
|
83810
85053
|
return this.apiClient.callApi(
|
|
83811
85054
|
'/api/v2/workforcemanagement/adherence/historical/bulk',
|
|
@@ -83814,7 +85057,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83814
85057
|
{ },
|
|
83815
85058
|
{ },
|
|
83816
85059
|
{ },
|
|
83817
|
-
|
|
85060
|
+
body,
|
|
83818
85061
|
['PureCloud OAuth'],
|
|
83819
85062
|
['application/json'],
|
|
83820
85063
|
['application/json']
|
|
@@ -83889,12 +85132,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83889
85132
|
/**
|
|
83890
85133
|
* Move agents in and out of management unit
|
|
83891
85134
|
*
|
|
83892
|
-
* @param {Object}
|
|
83893
|
-
* @param {Object} opts.body body
|
|
85135
|
+
* @param {Object} body body
|
|
83894
85136
|
*/
|
|
83895
|
-
postWorkforcemanagementAgents(
|
|
83896
|
-
|
|
83897
|
-
|
|
85137
|
+
postWorkforcemanagementAgents(body) {
|
|
85138
|
+
// verify the required parameter 'body' is set
|
|
85139
|
+
if (body === undefined || body === null) {
|
|
85140
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgents';
|
|
85141
|
+
}
|
|
83898
85142
|
|
|
83899
85143
|
return this.apiClient.callApi(
|
|
83900
85144
|
'/api/v2/workforcemanagement/agents',
|
|
@@ -83903,7 +85147,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83903
85147
|
{ },
|
|
83904
85148
|
{ },
|
|
83905
85149
|
{ },
|
|
83906
|
-
|
|
85150
|
+
body,
|
|
83907
85151
|
['PureCloud OAuth'],
|
|
83908
85152
|
['application/json'],
|
|
83909
85153
|
['application/json']
|
|
@@ -83913,12 +85157,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83913
85157
|
/**
|
|
83914
85158
|
* Query integrations for agents
|
|
83915
85159
|
*
|
|
83916
|
-
* @param {Object}
|
|
83917
|
-
* @param {Object} opts.body body
|
|
85160
|
+
* @param {Object} body body
|
|
83918
85161
|
*/
|
|
83919
|
-
postWorkforcemanagementAgentsIntegrationsHrisQuery(
|
|
83920
|
-
|
|
83921
|
-
|
|
85162
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(body) {
|
|
85163
|
+
// verify the required parameter 'body' is set
|
|
85164
|
+
if (body === undefined || body === null) {
|
|
85165
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsIntegrationsHrisQuery';
|
|
85166
|
+
}
|
|
83922
85167
|
|
|
83923
85168
|
return this.apiClient.callApi(
|
|
83924
85169
|
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
@@ -83927,7 +85172,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83927
85172
|
{ },
|
|
83928
85173
|
{ },
|
|
83929
85174
|
{ },
|
|
83930
|
-
|
|
85175
|
+
body,
|
|
83931
85176
|
['PureCloud OAuth'],
|
|
83932
85177
|
['application/json'],
|
|
83933
85178
|
['application/json']
|
|
@@ -83962,12 +85207,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83962
85207
|
/**
|
|
83963
85208
|
* Get published schedule for the current user
|
|
83964
85209
|
*
|
|
83965
|
-
* @param {Object}
|
|
83966
|
-
* @param {Object} opts.body body
|
|
85210
|
+
* @param {Object} body body
|
|
83967
85211
|
*/
|
|
83968
|
-
postWorkforcemanagementAgentschedulesMine(
|
|
83969
|
-
|
|
83970
|
-
|
|
85212
|
+
postWorkforcemanagementAgentschedulesMine(body) {
|
|
85213
|
+
// verify the required parameter 'body' is set
|
|
85214
|
+
if (body === undefined || body === null) {
|
|
85215
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentschedulesMine';
|
|
85216
|
+
}
|
|
83971
85217
|
|
|
83972
85218
|
return this.apiClient.callApi(
|
|
83973
85219
|
'/api/v2/workforcemanagement/agentschedules/mine',
|
|
@@ -83976,7 +85222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83976
85222
|
{ },
|
|
83977
85223
|
{ },
|
|
83978
85224
|
{ },
|
|
83979
|
-
|
|
85225
|
+
body,
|
|
83980
85226
|
['PureCloud OAuth'],
|
|
83981
85227
|
['application/json'],
|
|
83982
85228
|
['application/json']
|
|
@@ -84062,16 +85308,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84062
85308
|
* Create a new activity code
|
|
84063
85309
|
*
|
|
84064
85310
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
84065
|
-
* @param {Object}
|
|
84066
|
-
* @param {Object} opts.body body
|
|
85311
|
+
* @param {Object} body body
|
|
84067
85312
|
*/
|
|
84068
|
-
postWorkforcemanagementBusinessunitActivitycodes(businessUnitId,
|
|
84069
|
-
opts = opts || {};
|
|
84070
|
-
|
|
85313
|
+
postWorkforcemanagementBusinessunitActivitycodes(businessUnitId, body) {
|
|
84071
85314
|
// verify the required parameter 'businessUnitId' is set
|
|
84072
85315
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84073
85316
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivitycodes';
|
|
84074
85317
|
}
|
|
85318
|
+
// verify the required parameter 'body' is set
|
|
85319
|
+
if (body === undefined || body === null) {
|
|
85320
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivitycodes';
|
|
85321
|
+
}
|
|
84075
85322
|
|
|
84076
85323
|
return this.apiClient.callApi(
|
|
84077
85324
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes',
|
|
@@ -84080,7 +85327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84080
85327
|
{ },
|
|
84081
85328
|
{ },
|
|
84082
85329
|
{ },
|
|
84083
|
-
|
|
85330
|
+
body,
|
|
84084
85331
|
['PureCloud OAuth'],
|
|
84085
85332
|
['application/json'],
|
|
84086
85333
|
['application/json']
|
|
@@ -84186,18 +85433,22 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84186
85433
|
* Search published schedules
|
|
84187
85434
|
*
|
|
84188
85435
|
* @param {String} businessUnitId The ID of the business unit
|
|
85436
|
+
* @param {Object} body body
|
|
84189
85437
|
* @param {Object} opts Optional parameters
|
|
84190
85438
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
84191
85439
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
84192
|
-
* @param {Object} opts.body body
|
|
84193
85440
|
*/
|
|
84194
|
-
postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId, opts) {
|
|
85441
|
+
postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId, body, opts) {
|
|
84195
85442
|
opts = opts || {};
|
|
84196
85443
|
|
|
84197
85444
|
// verify the required parameter 'businessUnitId' is set
|
|
84198
85445
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84199
85446
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAgentschedulesSearch';
|
|
84200
85447
|
}
|
|
85448
|
+
// verify the required parameter 'body' is set
|
|
85449
|
+
if (body === undefined || body === null) {
|
|
85450
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAgentschedulesSearch';
|
|
85451
|
+
}
|
|
84201
85452
|
|
|
84202
85453
|
return this.apiClient.callApi(
|
|
84203
85454
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search',
|
|
@@ -84206,7 +85457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84206
85457
|
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
84207
85458
|
{ },
|
|
84208
85459
|
{ },
|
|
84209
|
-
|
|
85460
|
+
body,
|
|
84210
85461
|
['PureCloud OAuth'],
|
|
84211
85462
|
['application/json'],
|
|
84212
85463
|
['application/json']
|
|
@@ -84251,17 +85502,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84251
85502
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
84252
85503
|
*
|
|
84253
85504
|
* @param {String} businessUnitId The ID of the business unit
|
|
85505
|
+
* @param {Object} body body
|
|
84254
85506
|
* @param {Object} opts Optional parameters
|
|
84255
85507
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
84256
|
-
* @param {Object} opts.body body
|
|
84257
85508
|
*/
|
|
84258
|
-
postWorkforcemanagementBusinessunitIntraday(businessUnitId, opts) {
|
|
85509
|
+
postWorkforcemanagementBusinessunitIntraday(businessUnitId, body, opts) {
|
|
84259
85510
|
opts = opts || {};
|
|
84260
85511
|
|
|
84261
85512
|
// verify the required parameter 'businessUnitId' is set
|
|
84262
85513
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84263
85514
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';
|
|
84264
85515
|
}
|
|
85516
|
+
// verify the required parameter 'body' is set
|
|
85517
|
+
if (body === undefined || body === null) {
|
|
85518
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitIntraday';
|
|
85519
|
+
}
|
|
84265
85520
|
|
|
84266
85521
|
return this.apiClient.callApi(
|
|
84267
85522
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday',
|
|
@@ -84270,7 +85525,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84270
85525
|
{ 'forceAsync': opts['forceAsync'] },
|
|
84271
85526
|
{ },
|
|
84272
85527
|
{ },
|
|
84273
|
-
|
|
85528
|
+
body,
|
|
84274
85529
|
['PureCloud OAuth'],
|
|
84275
85530
|
['application/json'],
|
|
84276
85531
|
['application/json']
|
|
@@ -84281,16 +85536,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84281
85536
|
* Adds a new planning group
|
|
84282
85537
|
*
|
|
84283
85538
|
* @param {String} businessUnitId The ID of the business unit.
|
|
84284
|
-
* @param {Object}
|
|
84285
|
-
* @param {Object} opts.body body
|
|
85539
|
+
* @param {Object} body body
|
|
84286
85540
|
*/
|
|
84287
|
-
postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId,
|
|
84288
|
-
opts = opts || {};
|
|
84289
|
-
|
|
85541
|
+
postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId, body) {
|
|
84290
85542
|
// verify the required parameter 'businessUnitId' is set
|
|
84291
85543
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84292
85544
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitPlanninggroups';
|
|
84293
85545
|
}
|
|
85546
|
+
// verify the required parameter 'body' is set
|
|
85547
|
+
if (body === undefined || body === null) {
|
|
85548
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitPlanninggroups';
|
|
85549
|
+
}
|
|
84294
85550
|
|
|
84295
85551
|
return this.apiClient.callApi(
|
|
84296
85552
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups',
|
|
@@ -84299,7 +85555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84299
85555
|
{ },
|
|
84300
85556
|
{ },
|
|
84301
85557
|
{ },
|
|
84302
|
-
|
|
85558
|
+
body,
|
|
84303
85559
|
['PureCloud OAuth'],
|
|
84304
85560
|
['application/json'],
|
|
84305
85561
|
['application/json']
|
|
@@ -84310,16 +85566,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84310
85566
|
* Adds a new service goal template
|
|
84311
85567
|
*
|
|
84312
85568
|
* @param {String} businessUnitId The ID of the business unit.
|
|
84313
|
-
* @param {Object}
|
|
84314
|
-
* @param {Object} opts.body body
|
|
85569
|
+
* @param {Object} body body
|
|
84315
85570
|
*/
|
|
84316
|
-
postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,
|
|
84317
|
-
opts = opts || {};
|
|
84318
|
-
|
|
85571
|
+
postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, body) {
|
|
84319
85572
|
// verify the required parameter 'businessUnitId' is set
|
|
84320
85573
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84321
85574
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
84322
85575
|
}
|
|
85576
|
+
// verify the required parameter 'body' is set
|
|
85577
|
+
if (body === undefined || body === null) {
|
|
85578
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
85579
|
+
}
|
|
84323
85580
|
|
|
84324
85581
|
return this.apiClient.callApi(
|
|
84325
85582
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
@@ -84328,7 +85585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84328
85585
|
{ },
|
|
84329
85586
|
{ },
|
|
84330
85587
|
{ },
|
|
84331
|
-
|
|
85588
|
+
body,
|
|
84332
85589
|
['PureCloud OAuth'],
|
|
84333
85590
|
['application/json'],
|
|
84334
85591
|
['application/json']
|
|
@@ -84339,16 +85596,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84339
85596
|
* Creates a new staffing group
|
|
84340
85597
|
*
|
|
84341
85598
|
* @param {String} businessUnitId The ID of the business unit
|
|
84342
|
-
* @param {Object}
|
|
84343
|
-
* @param {Object} opts.body body
|
|
85599
|
+
* @param {Object} body body
|
|
84344
85600
|
*/
|
|
84345
|
-
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,
|
|
84346
|
-
opts = opts || {};
|
|
84347
|
-
|
|
85601
|
+
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, body) {
|
|
84348
85602
|
// verify the required parameter 'businessUnitId' is set
|
|
84349
85603
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84350
85604
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
84351
85605
|
}
|
|
85606
|
+
// verify the required parameter 'body' is set
|
|
85607
|
+
if (body === undefined || body === null) {
|
|
85608
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
85609
|
+
}
|
|
84352
85610
|
|
|
84353
85611
|
return this.apiClient.callApi(
|
|
84354
85612
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
@@ -84357,7 +85615,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84357
85615
|
{ },
|
|
84358
85616
|
{ },
|
|
84359
85617
|
{ },
|
|
84360
|
-
|
|
85618
|
+
body,
|
|
84361
85619
|
['PureCloud OAuth'],
|
|
84362
85620
|
['application/json'],
|
|
84363
85621
|
['application/json']
|
|
@@ -84368,25 +85626,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84368
85626
|
* Gets staffing group associations for a list of user IDs
|
|
84369
85627
|
*
|
|
84370
85628
|
* @param {String} businessUnitId The ID of the business unit
|
|
85629
|
+
* @param {Object} body body
|
|
84371
85630
|
* @param {Object} opts Optional parameters
|
|
84372
|
-
* @param {
|
|
85631
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service
|
|
84373
85632
|
*/
|
|
84374
|
-
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, opts) {
|
|
85633
|
+
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, body, opts) {
|
|
84375
85634
|
opts = opts || {};
|
|
84376
85635
|
|
|
84377
85636
|
// verify the required parameter 'businessUnitId' is set
|
|
84378
85637
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84379
85638
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
84380
85639
|
}
|
|
85640
|
+
// verify the required parameter 'body' is set
|
|
85641
|
+
if (body === undefined || body === null) {
|
|
85642
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
85643
|
+
}
|
|
84381
85644
|
|
|
84382
85645
|
return this.apiClient.callApi(
|
|
84383
85646
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
|
|
84384
85647
|
'POST',
|
|
84385
85648
|
{ 'businessUnitId': businessUnitId },
|
|
85649
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
84386
85650
|
{ },
|
|
84387
85651
|
{ },
|
|
84388
|
-
|
|
84389
|
-
opts['body'],
|
|
85652
|
+
body,
|
|
84390
85653
|
['PureCloud OAuth'],
|
|
84391
85654
|
['application/json'],
|
|
84392
85655
|
['application/json']
|
|
@@ -84397,16 +85660,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84397
85660
|
* Creates a new time-off limit object
|
|
84398
85661
|
*
|
|
84399
85662
|
* @param {String} businessUnitId The ID of the business unit
|
|
84400
|
-
* @param {Object}
|
|
84401
|
-
* @param {Object} opts.body body
|
|
85663
|
+
* @param {Object} body body
|
|
84402
85664
|
*/
|
|
84403
|
-
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,
|
|
84404
|
-
opts = opts || {};
|
|
84405
|
-
|
|
85665
|
+
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, body) {
|
|
84406
85666
|
// verify the required parameter 'businessUnitId' is set
|
|
84407
85667
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84408
85668
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
84409
85669
|
}
|
|
85670
|
+
// verify the required parameter 'body' is set
|
|
85671
|
+
if (body === undefined || body === null) {
|
|
85672
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
85673
|
+
}
|
|
84410
85674
|
|
|
84411
85675
|
return this.apiClient.callApi(
|
|
84412
85676
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
@@ -84415,7 +85679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84415
85679
|
{ },
|
|
84416
85680
|
{ },
|
|
84417
85681
|
{ },
|
|
84418
|
-
|
|
85682
|
+
body,
|
|
84419
85683
|
['PureCloud OAuth'],
|
|
84420
85684
|
['application/json'],
|
|
84421
85685
|
['application/json']
|
|
@@ -84426,16 +85690,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84426
85690
|
* Retrieves time-off limit related values based on a given set of filters.
|
|
84427
85691
|
*
|
|
84428
85692
|
* @param {String} businessUnitId The ID of the business unit
|
|
84429
|
-
* @param {Object}
|
|
84430
|
-
* @param {Object} opts.body body
|
|
85693
|
+
* @param {Object} body body
|
|
84431
85694
|
*/
|
|
84432
|
-
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId,
|
|
84433
|
-
opts = opts || {};
|
|
84434
|
-
|
|
85695
|
+
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId, body) {
|
|
84435
85696
|
// verify the required parameter 'businessUnitId' is set
|
|
84436
85697
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84437
85698
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
84438
85699
|
}
|
|
85700
|
+
// verify the required parameter 'body' is set
|
|
85701
|
+
if (body === undefined || body === null) {
|
|
85702
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
85703
|
+
}
|
|
84439
85704
|
|
|
84440
85705
|
return this.apiClient.callApi(
|
|
84441
85706
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query',
|
|
@@ -84444,7 +85709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84444
85709
|
{ },
|
|
84445
85710
|
{ },
|
|
84446
85711
|
{ },
|
|
84447
|
-
|
|
85712
|
+
body,
|
|
84448
85713
|
['PureCloud OAuth'],
|
|
84449
85714
|
['application/json'],
|
|
84450
85715
|
['application/json']
|
|
@@ -84455,16 +85720,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84455
85720
|
* Creates a new time-off plan
|
|
84456
85721
|
*
|
|
84457
85722
|
* @param {String} businessUnitId The ID of the business unit
|
|
84458
|
-
* @param {Object}
|
|
84459
|
-
* @param {Object} opts.body body
|
|
85723
|
+
* @param {Object} body body
|
|
84460
85724
|
*/
|
|
84461
|
-
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,
|
|
84462
|
-
opts = opts || {};
|
|
84463
|
-
|
|
85725
|
+
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, body) {
|
|
84464
85726
|
// verify the required parameter 'businessUnitId' is set
|
|
84465
85727
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84466
85728
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
84467
85729
|
}
|
|
85730
|
+
// verify the required parameter 'body' is set
|
|
85731
|
+
if (body === undefined || body === null) {
|
|
85732
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
85733
|
+
}
|
|
84468
85734
|
|
|
84469
85735
|
return this.apiClient.callApi(
|
|
84470
85736
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
@@ -84473,7 +85739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84473
85739
|
{ },
|
|
84474
85740
|
{ },
|
|
84475
85741
|
{ },
|
|
84476
|
-
|
|
85742
|
+
body,
|
|
84477
85743
|
['PureCloud OAuth'],
|
|
84478
85744
|
['application/json'],
|
|
84479
85745
|
['application/json']
|
|
@@ -84571,12 +85837,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84571
85837
|
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
84572
85838
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
84573
85839
|
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
84574
|
-
* @param {Object}
|
|
84575
|
-
* @param {Object} opts.body body
|
|
85840
|
+
* @param {Object} body body
|
|
84576
85841
|
*/
|
|
84577
|
-
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId,
|
|
84578
|
-
opts = opts || {};
|
|
84579
|
-
|
|
85842
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, body) {
|
|
84580
85843
|
// verify the required parameter 'businessUnitId' is set
|
|
84581
85844
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84582
85845
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
@@ -84589,6 +85852,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84589
85852
|
if (scheduleId === undefined || scheduleId === null) {
|
|
84590
85853
|
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
84591
85854
|
}
|
|
85855
|
+
// verify the required parameter 'body' is set
|
|
85856
|
+
if (body === undefined || body === null) {
|
|
85857
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
85858
|
+
}
|
|
84592
85859
|
|
|
84593
85860
|
return this.apiClient.callApi(
|
|
84594
85861
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
|
|
@@ -84597,7 +85864,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84597
85864
|
{ },
|
|
84598
85865
|
{ },
|
|
84599
85866
|
{ },
|
|
84600
|
-
|
|
85867
|
+
body,
|
|
84601
85868
|
['PureCloud OAuth'],
|
|
84602
85869
|
['application/json'],
|
|
84603
85870
|
['application/json']
|
|
@@ -84610,12 +85877,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84610
85877
|
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
84611
85878
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
84612
85879
|
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
84613
|
-
* @param {Object}
|
|
84614
|
-
* @param {Object} opts.body body
|
|
85880
|
+
* @param {Object} body body
|
|
84615
85881
|
*/
|
|
84616
|
-
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId,
|
|
84617
|
-
opts = opts || {};
|
|
84618
|
-
|
|
85882
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, body) {
|
|
84619
85883
|
// verify the required parameter 'businessUnitId' is set
|
|
84620
85884
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84621
85885
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
@@ -84628,6 +85892,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84628
85892
|
if (scheduleId === undefined || scheduleId === null) {
|
|
84629
85893
|
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
84630
85894
|
}
|
|
85895
|
+
// verify the required parameter 'body' is set
|
|
85896
|
+
if (body === undefined || body === null) {
|
|
85897
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
85898
|
+
}
|
|
84631
85899
|
|
|
84632
85900
|
return this.apiClient.callApi(
|
|
84633
85901
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
|
|
@@ -84636,7 +85904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84636
85904
|
{ },
|
|
84637
85905
|
{ },
|
|
84638
85906
|
{ },
|
|
84639
|
-
|
|
85907
|
+
body,
|
|
84640
85908
|
['PureCloud OAuth'],
|
|
84641
85909
|
['application/json'],
|
|
84642
85910
|
['application/json']
|
|
@@ -85061,12 +86329,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85061
86329
|
*
|
|
85062
86330
|
* @param {String} businessUnitId The ID of the business unit
|
|
85063
86331
|
* @param {String} bidId The ID of the work plan bid to copy
|
|
85064
|
-
* @param {Object}
|
|
85065
|
-
* @param {Object} opts.body body
|
|
86332
|
+
* @param {Object} body body
|
|
85066
86333
|
*/
|
|
85067
|
-
postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId,
|
|
85068
|
-
opts = opts || {};
|
|
85069
|
-
|
|
86334
|
+
postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, body) {
|
|
85070
86335
|
// verify the required parameter 'businessUnitId' is set
|
|
85071
86336
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
85072
86337
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
@@ -85075,6 +86340,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85075
86340
|
if (bidId === undefined || bidId === null) {
|
|
85076
86341
|
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
85077
86342
|
}
|
|
86343
|
+
// verify the required parameter 'body' is set
|
|
86344
|
+
if (body === undefined || body === null) {
|
|
86345
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
86346
|
+
}
|
|
85078
86347
|
|
|
85079
86348
|
return this.apiClient.callApi(
|
|
85080
86349
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
|
|
@@ -85083,7 +86352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85083
86352
|
{ },
|
|
85084
86353
|
{ },
|
|
85085
86354
|
{ },
|
|
85086
|
-
|
|
86355
|
+
body,
|
|
85087
86356
|
['PureCloud OAuth'],
|
|
85088
86357
|
['application/json'],
|
|
85089
86358
|
['application/json']
|
|
@@ -85095,12 +86364,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85095
86364
|
*
|
|
85096
86365
|
* @param {String} businessUnitId The ID of the business unit
|
|
85097
86366
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
85098
|
-
* @param {Object}
|
|
85099
|
-
* @param {Object} opts.body body
|
|
86367
|
+
* @param {Object} body body
|
|
85100
86368
|
*/
|
|
85101
|
-
postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId,
|
|
85102
|
-
opts = opts || {};
|
|
85103
|
-
|
|
86369
|
+
postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, body) {
|
|
85104
86370
|
// verify the required parameter 'businessUnitId' is set
|
|
85105
86371
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
85106
86372
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
@@ -85109,6 +86375,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85109
86375
|
if (bidId === undefined || bidId === null) {
|
|
85110
86376
|
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
85111
86377
|
}
|
|
86378
|
+
// verify the required parameter 'body' is set
|
|
86379
|
+
if (body === undefined || body === null) {
|
|
86380
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
86381
|
+
}
|
|
85112
86382
|
|
|
85113
86383
|
return this.apiClient.callApi(
|
|
85114
86384
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
|
|
@@ -85117,7 +86387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85117
86387
|
{ },
|
|
85118
86388
|
{ },
|
|
85119
86389
|
{ },
|
|
85120
|
-
|
|
86390
|
+
body,
|
|
85121
86391
|
['PureCloud OAuth'],
|
|
85122
86392
|
['application/json'],
|
|
85123
86393
|
['application/json']
|
|
@@ -85128,16 +86398,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85128
86398
|
* Create a new work plan bid
|
|
85129
86399
|
*
|
|
85130
86400
|
* @param {String} businessUnitId The ID of the business unit
|
|
85131
|
-
* @param {Object}
|
|
85132
|
-
* @param {Object} opts.body The work plan bid to be created
|
|
86401
|
+
* @param {Object} body The work plan bid to be created
|
|
85133
86402
|
*/
|
|
85134
|
-
postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId,
|
|
85135
|
-
opts = opts || {};
|
|
85136
|
-
|
|
86403
|
+
postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, body) {
|
|
85137
86404
|
// verify the required parameter 'businessUnitId' is set
|
|
85138
86405
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
85139
86406
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
|
|
85140
86407
|
}
|
|
86408
|
+
// verify the required parameter 'body' is set
|
|
86409
|
+
if (body === undefined || body === null) {
|
|
86410
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbids';
|
|
86411
|
+
}
|
|
85141
86412
|
|
|
85142
86413
|
return this.apiClient.callApi(
|
|
85143
86414
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
|
|
@@ -85146,7 +86417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85146
86417
|
{ },
|
|
85147
86418
|
{ },
|
|
85148
86419
|
{ },
|
|
85149
|
-
|
|
86420
|
+
body,
|
|
85150
86421
|
['PureCloud OAuth'],
|
|
85151
86422
|
['application/json'],
|
|
85152
86423
|
['application/json']
|
|
@@ -85156,12 +86427,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85156
86427
|
/**
|
|
85157
86428
|
* Add a new business unit
|
|
85158
86429
|
* It may take a minute or two for a new business unit to be available for api operations
|
|
85159
|
-
* @param {Object}
|
|
85160
|
-
* @param {Object} opts.body body
|
|
86430
|
+
* @param {Object} body body
|
|
85161
86431
|
*/
|
|
85162
|
-
postWorkforcemanagementBusinessunits(
|
|
85163
|
-
|
|
85164
|
-
|
|
86432
|
+
postWorkforcemanagementBusinessunits(body) {
|
|
86433
|
+
// verify the required parameter 'body' is set
|
|
86434
|
+
if (body === undefined || body === null) {
|
|
86435
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunits';
|
|
86436
|
+
}
|
|
85165
86437
|
|
|
85166
86438
|
return this.apiClient.callApi(
|
|
85167
86439
|
'/api/v2/workforcemanagement/businessunits',
|
|
@@ -85170,7 +86442,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85170
86442
|
{ },
|
|
85171
86443
|
{ },
|
|
85172
86444
|
{ },
|
|
85173
|
-
|
|
86445
|
+
body,
|
|
85174
86446
|
['PureCloud OAuth'],
|
|
85175
86447
|
['application/json'],
|
|
85176
86448
|
['application/json']
|
|
@@ -85204,12 +86476,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85204
86476
|
/**
|
|
85205
86477
|
* Delete the list of the historical data import entries
|
|
85206
86478
|
*
|
|
85207
|
-
* @param {Object}
|
|
85208
|
-
* @param {Object} opts.body body
|
|
86479
|
+
* @param {Object} body body
|
|
85209
86480
|
*/
|
|
85210
|
-
postWorkforcemanagementHistoricaldataBulkRemoveJobs(
|
|
85211
|
-
|
|
85212
|
-
|
|
86481
|
+
postWorkforcemanagementHistoricaldataBulkRemoveJobs(body) {
|
|
86482
|
+
// verify the required parameter 'body' is set
|
|
86483
|
+
if (body === undefined || body === null) {
|
|
86484
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementHistoricaldataBulkRemoveJobs';
|
|
86485
|
+
}
|
|
85213
86486
|
|
|
85214
86487
|
return this.apiClient.callApi(
|
|
85215
86488
|
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs',
|
|
@@ -85218,7 +86491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85218
86491
|
{ },
|
|
85219
86492
|
{ },
|
|
85220
86493
|
{ },
|
|
85221
|
-
|
|
86494
|
+
body,
|
|
85222
86495
|
['PureCloud OAuth'],
|
|
85223
86496
|
['application/json'],
|
|
85224
86497
|
['application/json']
|
|
@@ -85249,12 +86522,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85249
86522
|
/**
|
|
85250
86523
|
* Trigger validation process for historical import
|
|
85251
86524
|
*
|
|
85252
|
-
* @param {Object}
|
|
85253
|
-
* @param {Object} opts.body body
|
|
86525
|
+
* @param {Object} body body
|
|
85254
86526
|
*/
|
|
85255
|
-
postWorkforcemanagementHistoricaldataValidate(
|
|
85256
|
-
|
|
85257
|
-
|
|
86527
|
+
postWorkforcemanagementHistoricaldataValidate(body) {
|
|
86528
|
+
// verify the required parameter 'body' is set
|
|
86529
|
+
if (body === undefined || body === null) {
|
|
86530
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementHistoricaldataValidate';
|
|
86531
|
+
}
|
|
85258
86532
|
|
|
85259
86533
|
return this.apiClient.callApi(
|
|
85260
86534
|
'/api/v2/workforcemanagement/historicaldata/validate',
|
|
@@ -85263,7 +86537,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85263
86537
|
{ },
|
|
85264
86538
|
{ },
|
|
85265
86539
|
{ },
|
|
85266
|
-
|
|
86540
|
+
body,
|
|
85267
86541
|
['PureCloud OAuth'],
|
|
85268
86542
|
['application/json'],
|
|
85269
86543
|
['application/json']
|
|
@@ -85299,17 +86573,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85299
86573
|
* Get agents work plans configuration
|
|
85300
86574
|
*
|
|
85301
86575
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86576
|
+
* @param {Object} body body
|
|
85302
86577
|
* @param {Object} opts Optional parameters
|
|
85303
86578
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85304
|
-
* @param {Object} opts.body body
|
|
85305
86579
|
*/
|
|
85306
|
-
postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId, opts) {
|
|
86580
|
+
postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId, body, opts) {
|
|
85307
86581
|
opts = opts || {};
|
|
85308
86582
|
|
|
85309
86583
|
// verify the required parameter 'managementUnitId' is set
|
|
85310
86584
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85311
86585
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';
|
|
85312
86586
|
}
|
|
86587
|
+
// verify the required parameter 'body' is set
|
|
86588
|
+
if (body === undefined || body === null) {
|
|
86589
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';
|
|
86590
|
+
}
|
|
85313
86591
|
|
|
85314
86592
|
return this.apiClient.callApi(
|
|
85315
86593
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query',
|
|
@@ -85318,7 +86596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85318
86596
|
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
85319
86597
|
{ },
|
|
85320
86598
|
{ },
|
|
85321
|
-
|
|
86599
|
+
body,
|
|
85322
86600
|
['PureCloud OAuth'],
|
|
85323
86601
|
['application/json'],
|
|
85324
86602
|
['application/json']
|
|
@@ -85329,18 +86607,22 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85329
86607
|
* Query published schedules for given given time range for set of users
|
|
85330
86608
|
*
|
|
85331
86609
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86610
|
+
* @param {Object} body body
|
|
85332
86611
|
* @param {Object} opts Optional parameters
|
|
85333
86612
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
85334
86613
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85335
|
-
* @param {Object} opts.body body
|
|
85336
86614
|
*/
|
|
85337
|
-
postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId, opts) {
|
|
86615
|
+
postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId, body, opts) {
|
|
85338
86616
|
opts = opts || {};
|
|
85339
86617
|
|
|
85340
86618
|
// verify the required parameter 'managementUnitId' is set
|
|
85341
86619
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85342
86620
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
|
|
85343
86621
|
}
|
|
86622
|
+
// verify the required parameter 'body' is set
|
|
86623
|
+
if (body === undefined || body === null) {
|
|
86624
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
|
|
86625
|
+
}
|
|
85344
86626
|
|
|
85345
86627
|
return this.apiClient.callApi(
|
|
85346
86628
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search',
|
|
@@ -85349,7 +86631,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85349
86631
|
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
85350
86632
|
{ },
|
|
85351
86633
|
{ },
|
|
85352
|
-
|
|
86634
|
+
body,
|
|
85353
86635
|
['PureCloud OAuth'],
|
|
85354
86636
|
['application/json'],
|
|
85355
86637
|
['application/json']
|
|
@@ -85360,16 +86642,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85360
86642
|
* Request a historical adherence report
|
|
85361
86643
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
85362
86644
|
* @param {String} managementUnitId The ID of the management unit
|
|
85363
|
-
* @param {Object}
|
|
85364
|
-
* @param {Object} opts.body body
|
|
86645
|
+
* @param {Object} body body
|
|
85365
86646
|
*/
|
|
85366
|
-
postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId,
|
|
85367
|
-
opts = opts || {};
|
|
85368
|
-
|
|
86647
|
+
postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId, body) {
|
|
85369
86648
|
// verify the required parameter 'managementUnitId' is set
|
|
85370
86649
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85371
86650
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
|
|
85372
86651
|
}
|
|
86652
|
+
// verify the required parameter 'body' is set
|
|
86653
|
+
if (body === undefined || body === null) {
|
|
86654
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
|
|
86655
|
+
}
|
|
85373
86656
|
|
|
85374
86657
|
return this.apiClient.callApi(
|
|
85375
86658
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery',
|
|
@@ -85378,7 +86661,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85378
86661
|
{ },
|
|
85379
86662
|
{ },
|
|
85380
86663
|
{ },
|
|
85381
|
-
|
|
86664
|
+
body,
|
|
85382
86665
|
['PureCloud OAuth'],
|
|
85383
86666
|
['application/json'],
|
|
85384
86667
|
['application/json']
|
|
@@ -85389,16 +86672,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85389
86672
|
* Move the requested management unit to a new business unit
|
|
85390
86673
|
* Returns status 200 if the management unit is already in the requested business unit
|
|
85391
86674
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85392
|
-
* @param {Object}
|
|
85393
|
-
* @param {Object} opts.body body
|
|
86675
|
+
* @param {Object} body body
|
|
85394
86676
|
*/
|
|
85395
|
-
postWorkforcemanagementManagementunitMove(managementUnitId,
|
|
85396
|
-
opts = opts || {};
|
|
85397
|
-
|
|
86677
|
+
postWorkforcemanagementManagementunitMove(managementUnitId, body) {
|
|
85398
86678
|
// verify the required parameter 'managementUnitId' is set
|
|
85399
86679
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85400
86680
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitMove';
|
|
85401
86681
|
}
|
|
86682
|
+
// verify the required parameter 'body' is set
|
|
86683
|
+
if (body === undefined || body === null) {
|
|
86684
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitMove';
|
|
86685
|
+
}
|
|
85402
86686
|
|
|
85403
86687
|
return this.apiClient.callApi(
|
|
85404
86688
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/move',
|
|
@@ -85407,7 +86691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85407
86691
|
{ },
|
|
85408
86692
|
{ },
|
|
85409
86693
|
{ },
|
|
85410
|
-
|
|
86694
|
+
body,
|
|
85411
86695
|
['PureCloud OAuth'],
|
|
85412
86696
|
['application/json'],
|
|
85413
86697
|
['application/json']
|
|
@@ -85418,17 +86702,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85418
86702
|
* Query published schedules for given given time range for set of users
|
|
85419
86703
|
*
|
|
85420
86704
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85421
|
-
* @param {Object}
|
|
85422
|
-
* @param {Object} opts.body body
|
|
86705
|
+
* @param {Object} body body
|
|
85423
86706
|
* @deprecated
|
|
85424
86707
|
*/
|
|
85425
|
-
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId,
|
|
85426
|
-
opts = opts || {};
|
|
85427
|
-
|
|
86708
|
+
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, body) {
|
|
85428
86709
|
// verify the required parameter 'managementUnitId' is set
|
|
85429
86710
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85430
86711
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitSchedulesSearch';
|
|
85431
86712
|
}
|
|
86713
|
+
// verify the required parameter 'body' is set
|
|
86714
|
+
if (body === undefined || body === null) {
|
|
86715
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitSchedulesSearch';
|
|
86716
|
+
}
|
|
85432
86717
|
|
|
85433
86718
|
return this.apiClient.callApi(
|
|
85434
86719
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search',
|
|
@@ -85437,7 +86722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85437
86722
|
{ },
|
|
85438
86723
|
{ },
|
|
85439
86724
|
{ },
|
|
85440
|
-
|
|
86725
|
+
body,
|
|
85441
86726
|
['PureCloud OAuth'],
|
|
85442
86727
|
['application/json'],
|
|
85443
86728
|
['application/json']
|
|
@@ -85448,16 +86733,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85448
86733
|
* Request a historical shrinkage report
|
|
85449
86734
|
* The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
|
|
85450
86735
|
* @param {String} managementUnitId The ID of the management unit
|
|
85451
|
-
* @param {Object}
|
|
85452
|
-
* @param {Object} opts.body body
|
|
86736
|
+
* @param {Object} body body
|
|
85453
86737
|
*/
|
|
85454
|
-
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId,
|
|
85455
|
-
opts = opts || {};
|
|
85456
|
-
|
|
86738
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, body) {
|
|
85457
86739
|
// verify the required parameter 'managementUnitId' is set
|
|
85458
86740
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85459
86741
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
85460
86742
|
}
|
|
86743
|
+
// verify the required parameter 'body' is set
|
|
86744
|
+
if (body === undefined || body === null) {
|
|
86745
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
86746
|
+
}
|
|
85461
86747
|
|
|
85462
86748
|
return this.apiClient.callApi(
|
|
85463
86749
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
@@ -85466,7 +86752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85466
86752
|
{ },
|
|
85467
86753
|
{ },
|
|
85468
86754
|
{ },
|
|
85469
|
-
|
|
86755
|
+
body,
|
|
85470
86756
|
['PureCloud OAuth'],
|
|
85471
86757
|
['application/json'],
|
|
85472
86758
|
['application/json']
|
|
@@ -85477,16 +86763,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85477
86763
|
* Creates a new time off limit object under management unit.
|
|
85478
86764
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
85479
86765
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85480
|
-
* @param {Object}
|
|
85481
|
-
* @param {Object} opts.body body
|
|
86766
|
+
* @param {Object} body body
|
|
85482
86767
|
*/
|
|
85483
|
-
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId,
|
|
85484
|
-
opts = opts || {};
|
|
85485
|
-
|
|
86768
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, body) {
|
|
85486
86769
|
// verify the required parameter 'managementUnitId' is set
|
|
85487
86770
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85488
86771
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
85489
86772
|
}
|
|
86773
|
+
// verify the required parameter 'body' is set
|
|
86774
|
+
if (body === undefined || body === null) {
|
|
86775
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
86776
|
+
}
|
|
85490
86777
|
|
|
85491
86778
|
return this.apiClient.callApi(
|
|
85492
86779
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
@@ -85495,7 +86782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85495
86782
|
{ },
|
|
85496
86783
|
{ },
|
|
85497
86784
|
{ },
|
|
85498
|
-
|
|
86785
|
+
body,
|
|
85499
86786
|
['PureCloud OAuth'],
|
|
85500
86787
|
['application/json'],
|
|
85501
86788
|
['application/json']
|
|
@@ -85506,16 +86793,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85506
86793
|
* Retrieves time off limit related values based on a given set of filters.
|
|
85507
86794
|
*
|
|
85508
86795
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85509
|
-
* @param {Object}
|
|
85510
|
-
* @param {Object} opts.body body
|
|
86796
|
+
* @param {Object} body body
|
|
85511
86797
|
*/
|
|
85512
|
-
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId,
|
|
85513
|
-
opts = opts || {};
|
|
85514
|
-
|
|
86798
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, body) {
|
|
85515
86799
|
// verify the required parameter 'managementUnitId' is set
|
|
85516
86800
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85517
86801
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
85518
86802
|
}
|
|
86803
|
+
// verify the required parameter 'body' is set
|
|
86804
|
+
if (body === undefined || body === null) {
|
|
86805
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
86806
|
+
}
|
|
85519
86807
|
|
|
85520
86808
|
return this.apiClient.callApi(
|
|
85521
86809
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
@@ -85524,7 +86812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85524
86812
|
{ },
|
|
85525
86813
|
{ },
|
|
85526
86814
|
{ },
|
|
85527
|
-
|
|
86815
|
+
body,
|
|
85528
86816
|
['PureCloud OAuth'],
|
|
85529
86817
|
['application/json'],
|
|
85530
86818
|
['application/json']
|
|
@@ -85535,16 +86823,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85535
86823
|
* Creates a new time off plan
|
|
85536
86824
|
*
|
|
85537
86825
|
* @param {String} managementUnitId The ID of the management unit
|
|
85538
|
-
* @param {Object}
|
|
85539
|
-
* @param {Object} opts.body body
|
|
86826
|
+
* @param {Object} body body
|
|
85540
86827
|
*/
|
|
85541
|
-
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId,
|
|
85542
|
-
opts = opts || {};
|
|
85543
|
-
|
|
86828
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, body) {
|
|
85544
86829
|
// verify the required parameter 'managementUnitId' is set
|
|
85545
86830
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85546
86831
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
85547
86832
|
}
|
|
86833
|
+
// verify the required parameter 'body' is set
|
|
86834
|
+
if (body === undefined || body === null) {
|
|
86835
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
86836
|
+
}
|
|
85548
86837
|
|
|
85549
86838
|
return this.apiClient.callApi(
|
|
85550
86839
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
@@ -85553,7 +86842,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85553
86842
|
{ },
|
|
85554
86843
|
{ },
|
|
85555
86844
|
{ },
|
|
85556
|
-
|
|
86845
|
+
body,
|
|
85557
86846
|
['PureCloud OAuth'],
|
|
85558
86847
|
['application/json'],
|
|
85559
86848
|
['application/json']
|
|
@@ -85564,16 +86853,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85564
86853
|
* Create a new time off request
|
|
85565
86854
|
*
|
|
85566
86855
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85567
|
-
* @param {Object}
|
|
85568
|
-
* @param {Object} opts.body body
|
|
86856
|
+
* @param {Object} body body
|
|
85569
86857
|
*/
|
|
85570
|
-
postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId,
|
|
85571
|
-
opts = opts || {};
|
|
85572
|
-
|
|
86858
|
+
postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId, body) {
|
|
85573
86859
|
// verify the required parameter 'managementUnitId' is set
|
|
85574
86860
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85575
86861
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequests';
|
|
85576
86862
|
}
|
|
86863
|
+
// verify the required parameter 'body' is set
|
|
86864
|
+
if (body === undefined || body === null) {
|
|
86865
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequests';
|
|
86866
|
+
}
|
|
85577
86867
|
|
|
85578
86868
|
return this.apiClient.callApi(
|
|
85579
86869
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests',
|
|
@@ -85582,7 +86872,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85582
86872
|
{ },
|
|
85583
86873
|
{ },
|
|
85584
86874
|
{ },
|
|
85585
|
-
|
|
86875
|
+
body,
|
|
85586
86876
|
['PureCloud OAuth'],
|
|
85587
86877
|
['application/json'],
|
|
85588
86878
|
['application/json']
|
|
@@ -85593,16 +86883,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85593
86883
|
* Retrieves integration statuses for a list of time off requests
|
|
85594
86884
|
*
|
|
85595
86885
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85596
|
-
* @param {Object}
|
|
85597
|
-
* @param {Object} opts.body body
|
|
86886
|
+
* @param {Object} body body
|
|
85598
86887
|
*/
|
|
85599
|
-
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId,
|
|
85600
|
-
opts = opts || {};
|
|
85601
|
-
|
|
86888
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, body) {
|
|
85602
86889
|
// verify the required parameter 'managementUnitId' is set
|
|
85603
86890
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85604
86891
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
85605
86892
|
}
|
|
86893
|
+
// verify the required parameter 'body' is set
|
|
86894
|
+
if (body === undefined || body === null) {
|
|
86895
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
86896
|
+
}
|
|
85606
86897
|
|
|
85607
86898
|
return this.apiClient.callApi(
|
|
85608
86899
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
@@ -85611,7 +86902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85611
86902
|
{ },
|
|
85612
86903
|
{ },
|
|
85613
86904
|
{ },
|
|
85614
|
-
|
|
86905
|
+
body,
|
|
85615
86906
|
['PureCloud OAuth'],
|
|
85616
86907
|
['application/json'],
|
|
85617
86908
|
['application/json']
|
|
@@ -85622,17 +86913,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85622
86913
|
* Fetches time off requests matching the conditions specified in the request body
|
|
85623
86914
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
85624
86915
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86916
|
+
* @param {Object} body body
|
|
85625
86917
|
* @param {Object} opts Optional parameters
|
|
85626
86918
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85627
|
-
* @param {Object} opts.body body
|
|
85628
86919
|
*/
|
|
85629
|
-
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, opts) {
|
|
86920
|
+
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, body, opts) {
|
|
85630
86921
|
opts = opts || {};
|
|
85631
86922
|
|
|
85632
86923
|
// verify the required parameter 'managementUnitId' is set
|
|
85633
86924
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85634
86925
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
|
|
85635
86926
|
}
|
|
86927
|
+
// verify the required parameter 'body' is set
|
|
86928
|
+
if (body === undefined || body === null) {
|
|
86929
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
|
|
86930
|
+
}
|
|
85636
86931
|
|
|
85637
86932
|
return this.apiClient.callApi(
|
|
85638
86933
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query',
|
|
@@ -85641,7 +86936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85641
86936
|
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
85642
86937
|
{ },
|
|
85643
86938
|
{ },
|
|
85644
|
-
|
|
86939
|
+
body,
|
|
85645
86940
|
['PureCloud OAuth'],
|
|
85646
86941
|
['application/json'],
|
|
85647
86942
|
['application/json']
|
|
@@ -85652,16 +86947,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85652
86947
|
* Retrieves daily waitlist position for a list of time off requests
|
|
85653
86948
|
*
|
|
85654
86949
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85655
|
-
* @param {Object}
|
|
85656
|
-
* @param {Object} opts.body body
|
|
86950
|
+
* @param {Object} body body
|
|
85657
86951
|
*/
|
|
85658
|
-
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId,
|
|
85659
|
-
opts = opts || {};
|
|
85660
|
-
|
|
86952
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, body) {
|
|
85661
86953
|
// verify the required parameter 'managementUnitId' is set
|
|
85662
86954
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85663
86955
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
85664
86956
|
}
|
|
86957
|
+
// verify the required parameter 'body' is set
|
|
86958
|
+
if (body === undefined || body === null) {
|
|
86959
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
86960
|
+
}
|
|
85665
86961
|
|
|
85666
86962
|
return this.apiClient.callApi(
|
|
85667
86963
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
@@ -85670,7 +86966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85670
86966
|
{ },
|
|
85671
86967
|
{ },
|
|
85672
86968
|
{ },
|
|
85673
|
-
|
|
86969
|
+
body,
|
|
85674
86970
|
['PureCloud OAuth'],
|
|
85675
86971
|
['application/json'],
|
|
85676
86972
|
['application/json']
|
|
@@ -85752,12 +87048,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85752
87048
|
*
|
|
85753
87049
|
* @param {String} managementUnitId The ID of the management unit
|
|
85754
87050
|
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
85755
|
-
* @param {Object}
|
|
85756
|
-
* @param {Object} opts.body body
|
|
87051
|
+
* @param {Object} body body
|
|
85757
87052
|
*/
|
|
85758
|
-
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId,
|
|
85759
|
-
opts = opts || {};
|
|
85760
|
-
|
|
87053
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body) {
|
|
85761
87054
|
// verify the required parameter 'managementUnitId' is set
|
|
85762
87055
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85763
87056
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
@@ -85766,6 +87059,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85766
87059
|
if (userId === undefined || userId === null) {
|
|
85767
87060
|
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
85768
87061
|
}
|
|
87062
|
+
// verify the required parameter 'body' is set
|
|
87063
|
+
if (body === undefined || body === null) {
|
|
87064
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
87065
|
+
}
|
|
85769
87066
|
|
|
85770
87067
|
return this.apiClient.callApi(
|
|
85771
87068
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
@@ -85774,7 +87071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85774
87071
|
{ },
|
|
85775
87072
|
{ },
|
|
85776
87073
|
{ },
|
|
85777
|
-
|
|
87074
|
+
body,
|
|
85778
87075
|
['PureCloud OAuth'],
|
|
85779
87076
|
['application/json'],
|
|
85780
87077
|
['application/json']
|
|
@@ -85939,12 +87236,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85939
87236
|
*
|
|
85940
87237
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85941
87238
|
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
85942
|
-
* @param {Object}
|
|
85943
|
-
* @param {Object} opts.body body
|
|
87239
|
+
* @param {Object} body body
|
|
85944
87240
|
*/
|
|
85945
|
-
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId,
|
|
85946
|
-
opts = opts || {};
|
|
85947
|
-
|
|
87241
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, body) {
|
|
85948
87242
|
// verify the required parameter 'managementUnitId' is set
|
|
85949
87243
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85950
87244
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
@@ -85953,6 +87247,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85953
87247
|
if (workPlanId === undefined || workPlanId === null) {
|
|
85954
87248
|
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
85955
87249
|
}
|
|
87250
|
+
// verify the required parameter 'body' is set
|
|
87251
|
+
if (body === undefined || body === null) {
|
|
87252
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
87253
|
+
}
|
|
85956
87254
|
|
|
85957
87255
|
return this.apiClient.callApi(
|
|
85958
87256
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
@@ -85961,7 +87259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85961
87259
|
{ },
|
|
85962
87260
|
{ },
|
|
85963
87261
|
{ },
|
|
85964
|
-
|
|
87262
|
+
body,
|
|
85965
87263
|
['PureCloud OAuth'],
|
|
85966
87264
|
['application/json'],
|
|
85967
87265
|
['application/json']
|
|
@@ -85973,11 +87271,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85973
87271
|
*
|
|
85974
87272
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85975
87273
|
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
87274
|
+
* @param {Object} body body
|
|
85976
87275
|
* @param {Object} opts Optional parameters
|
|
85977
87276
|
* @param {Array.<String>} opts.expand
|
|
85978
|
-
* @param {Object} opts.body body
|
|
85979
87277
|
*/
|
|
85980
|
-
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
87278
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, body, opts) {
|
|
85981
87279
|
opts = opts || {};
|
|
85982
87280
|
|
|
85983
87281
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -85988,6 +87286,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85988
87286
|
if (workPlanId === undefined || workPlanId === null) {
|
|
85989
87287
|
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
85990
87288
|
}
|
|
87289
|
+
// verify the required parameter 'body' is set
|
|
87290
|
+
if (body === undefined || body === null) {
|
|
87291
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
87292
|
+
}
|
|
85991
87293
|
|
|
85992
87294
|
return this.apiClient.callApi(
|
|
85993
87295
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
@@ -85996,7 +87298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85996
87298
|
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
85997
87299
|
{ },
|
|
85998
87300
|
{ },
|
|
85999
|
-
|
|
87301
|
+
body,
|
|
86000
87302
|
['PureCloud OAuth'],
|
|
86001
87303
|
['application/json'],
|
|
86002
87304
|
['application/json']
|
|
@@ -86008,12 +87310,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86008
87310
|
*
|
|
86009
87311
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86010
87312
|
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
86011
|
-
* @param {Object}
|
|
86012
|
-
* @param {Object} opts.body body
|
|
87313
|
+
* @param {Object} body body
|
|
86013
87314
|
*/
|
|
86014
|
-
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId,
|
|
86015
|
-
opts = opts || {};
|
|
86016
|
-
|
|
87315
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, body) {
|
|
86017
87316
|
// verify the required parameter 'managementUnitId' is set
|
|
86018
87317
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86019
87318
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
@@ -86022,6 +87321,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86022
87321
|
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
86023
87322
|
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
86024
87323
|
}
|
|
87324
|
+
// verify the required parameter 'body' is set
|
|
87325
|
+
if (body === undefined || body === null) {
|
|
87326
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
87327
|
+
}
|
|
86025
87328
|
|
|
86026
87329
|
return this.apiClient.callApi(
|
|
86027
87330
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
@@ -86030,7 +87333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86030
87333
|
{ },
|
|
86031
87334
|
{ },
|
|
86032
87335
|
{ },
|
|
86033
|
-
|
|
87336
|
+
body,
|
|
86034
87337
|
['PureCloud OAuth'],
|
|
86035
87338
|
['application/json'],
|
|
86036
87339
|
['application/json']
|
|
@@ -86041,16 +87344,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86041
87344
|
* Create a new work plan rotation
|
|
86042
87345
|
*
|
|
86043
87346
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86044
|
-
* @param {Object}
|
|
86045
|
-
* @param {Object} opts.body body
|
|
87347
|
+
* @param {Object} body body
|
|
86046
87348
|
*/
|
|
86047
|
-
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId,
|
|
86048
|
-
opts = opts || {};
|
|
86049
|
-
|
|
87349
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, body) {
|
|
86050
87350
|
// verify the required parameter 'managementUnitId' is set
|
|
86051
87351
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86052
87352
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
86053
87353
|
}
|
|
87354
|
+
// verify the required parameter 'body' is set
|
|
87355
|
+
if (body === undefined || body === null) {
|
|
87356
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
87357
|
+
}
|
|
86054
87358
|
|
|
86055
87359
|
return this.apiClient.callApi(
|
|
86056
87360
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
@@ -86059,7 +87363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86059
87363
|
{ },
|
|
86060
87364
|
{ },
|
|
86061
87365
|
{ },
|
|
86062
|
-
|
|
87366
|
+
body,
|
|
86063
87367
|
['PureCloud OAuth'],
|
|
86064
87368
|
['application/json'],
|
|
86065
87369
|
['application/json']
|
|
@@ -86070,17 +87374,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86070
87374
|
* Create a new work plan
|
|
86071
87375
|
*
|
|
86072
87376
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
87377
|
+
* @param {Object} body body
|
|
86073
87378
|
* @param {Object} opts Optional parameters
|
|
86074
87379
|
* @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
|
|
86075
|
-
* @param {Object} opts.body body
|
|
86076
87380
|
*/
|
|
86077
|
-
postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
87381
|
+
postWorkforcemanagementManagementunitWorkplans(managementUnitId, body, opts) {
|
|
86078
87382
|
opts = opts || {};
|
|
86079
87383
|
|
|
86080
87384
|
// verify the required parameter 'managementUnitId' is set
|
|
86081
87385
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86082
87386
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplans';
|
|
86083
87387
|
}
|
|
87388
|
+
// verify the required parameter 'body' is set
|
|
87389
|
+
if (body === undefined || body === null) {
|
|
87390
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplans';
|
|
87391
|
+
}
|
|
86084
87392
|
|
|
86085
87393
|
return this.apiClient.callApi(
|
|
86086
87394
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
@@ -86089,7 +87397,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86089
87397
|
{ 'validationMode': opts['validationMode'] },
|
|
86090
87398
|
{ },
|
|
86091
87399
|
{ },
|
|
86092
|
-
|
|
87400
|
+
body,
|
|
86093
87401
|
['PureCloud OAuth'],
|
|
86094
87402
|
['application/json'],
|
|
86095
87403
|
['application/json']
|
|
@@ -86099,12 +87407,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86099
87407
|
/**
|
|
86100
87408
|
* Add a management unit
|
|
86101
87409
|
* It may take a minute or two for a new management unit to be available for api operations
|
|
86102
|
-
* @param {Object}
|
|
86103
|
-
* @param {Object} opts.body body
|
|
87410
|
+
* @param {Object} body body
|
|
86104
87411
|
*/
|
|
86105
|
-
postWorkforcemanagementManagementunits(
|
|
86106
|
-
|
|
86107
|
-
|
|
87412
|
+
postWorkforcemanagementManagementunits(body) {
|
|
87413
|
+
// verify the required parameter 'body' is set
|
|
87414
|
+
if (body === undefined || body === null) {
|
|
87415
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunits';
|
|
87416
|
+
}
|
|
86108
87417
|
|
|
86109
87418
|
return this.apiClient.callApi(
|
|
86110
87419
|
'/api/v2/workforcemanagement/managementunits',
|
|
@@ -86113,7 +87422,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86113
87422
|
{ },
|
|
86114
87423
|
{ },
|
|
86115
87424
|
{ },
|
|
86116
|
-
|
|
87425
|
+
body,
|
|
86117
87426
|
['PureCloud OAuth'],
|
|
86118
87427
|
['application/json'],
|
|
86119
87428
|
['application/json']
|
|
@@ -86123,12 +87432,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86123
87432
|
/**
|
|
86124
87433
|
* Mark a list of notifications as read or unread
|
|
86125
87434
|
*
|
|
86126
|
-
* @param {Object}
|
|
86127
|
-
* @param {Object} opts.body body
|
|
87435
|
+
* @param {Object} body body
|
|
86128
87436
|
*/
|
|
86129
|
-
postWorkforcemanagementNotificationsUpdate(
|
|
86130
|
-
|
|
86131
|
-
|
|
87437
|
+
postWorkforcemanagementNotificationsUpdate(body) {
|
|
87438
|
+
// verify the required parameter 'body' is set
|
|
87439
|
+
if (body === undefined || body === null) {
|
|
87440
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementNotificationsUpdate';
|
|
87441
|
+
}
|
|
86132
87442
|
|
|
86133
87443
|
return this.apiClient.callApi(
|
|
86134
87444
|
'/api/v2/workforcemanagement/notifications/update',
|
|
@@ -86137,7 +87447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86137
87447
|
{ },
|
|
86138
87448
|
{ },
|
|
86139
87449
|
{ },
|
|
86140
|
-
|
|
87450
|
+
body,
|
|
86141
87451
|
['PureCloud OAuth'],
|
|
86142
87452
|
['application/json'],
|
|
86143
87453
|
['application/json']
|
|
@@ -86173,16 +87483,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86173
87483
|
* Request a teams historical adherence report
|
|
86174
87484
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
86175
87485
|
* @param {String} teamId The ID of the team
|
|
86176
|
-
* @param {Object}
|
|
86177
|
-
* @param {Object} opts.body body
|
|
87486
|
+
* @param {Object} body body
|
|
86178
87487
|
*/
|
|
86179
|
-
postWorkforcemanagementTeamAdherenceHistorical(teamId,
|
|
86180
|
-
opts = opts || {};
|
|
86181
|
-
|
|
87488
|
+
postWorkforcemanagementTeamAdherenceHistorical(teamId, body) {
|
|
86182
87489
|
// verify the required parameter 'teamId' is set
|
|
86183
87490
|
if (teamId === undefined || teamId === null) {
|
|
86184
87491
|
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';
|
|
86185
87492
|
}
|
|
87493
|
+
// verify the required parameter 'body' is set
|
|
87494
|
+
if (body === undefined || body === null) {
|
|
87495
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTeamAdherenceHistorical';
|
|
87496
|
+
}
|
|
86186
87497
|
|
|
86187
87498
|
return this.apiClient.callApi(
|
|
86188
87499
|
'/api/v2/workforcemanagement/teams/{teamId}/adherence/historical',
|
|
@@ -86191,7 +87502,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86191
87502
|
{ },
|
|
86192
87503
|
{ },
|
|
86193
87504
|
{ },
|
|
86194
|
-
|
|
87505
|
+
body,
|
|
86195
87506
|
['PureCloud OAuth'],
|
|
86196
87507
|
['application/json'],
|
|
86197
87508
|
['application/json']
|
|
@@ -86202,16 +87513,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86202
87513
|
* Request a historical shrinkage report
|
|
86203
87514
|
* The maximum supported range for historical shrinkage queries is up to 32 days
|
|
86204
87515
|
* @param {String} teamId The ID of the team
|
|
86205
|
-
* @param {Object}
|
|
86206
|
-
* @param {Object} opts.body body
|
|
87516
|
+
* @param {Object} body body
|
|
86207
87517
|
*/
|
|
86208
|
-
postWorkforcemanagementTeamShrinkageJobs(teamId,
|
|
86209
|
-
opts = opts || {};
|
|
86210
|
-
|
|
87518
|
+
postWorkforcemanagementTeamShrinkageJobs(teamId, body) {
|
|
86211
87519
|
// verify the required parameter 'teamId' is set
|
|
86212
87520
|
if (teamId === undefined || teamId === null) {
|
|
86213
87521
|
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';
|
|
86214
87522
|
}
|
|
87523
|
+
// verify the required parameter 'body' is set
|
|
87524
|
+
if (body === undefined || body === null) {
|
|
87525
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTeamShrinkageJobs';
|
|
87526
|
+
}
|
|
86215
87527
|
|
|
86216
87528
|
return this.apiClient.callApi(
|
|
86217
87529
|
'/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs',
|
|
@@ -86220,7 +87532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86220
87532
|
{ },
|
|
86221
87533
|
{ },
|
|
86222
87534
|
{ },
|
|
86223
|
-
|
|
87535
|
+
body,
|
|
86224
87536
|
['PureCloud OAuth'],
|
|
86225
87537
|
['application/json'],
|
|
86226
87538
|
['application/json']
|
|
@@ -86255,12 +87567,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86255
87567
|
/**
|
|
86256
87568
|
* Queries available time off for the current user
|
|
86257
87569
|
*
|
|
86258
|
-
* @param {Object}
|
|
86259
|
-
* @param {Object} opts.body body
|
|
87570
|
+
* @param {Object} body body
|
|
86260
87571
|
*/
|
|
86261
|
-
postWorkforcemanagementTimeofflimitsAvailableQuery(
|
|
86262
|
-
|
|
86263
|
-
|
|
87572
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(body) {
|
|
87573
|
+
// verify the required parameter 'body' is set
|
|
87574
|
+
if (body === undefined || body === null) {
|
|
87575
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeofflimitsAvailableQuery';
|
|
87576
|
+
}
|
|
86264
87577
|
|
|
86265
87578
|
return this.apiClient.callApi(
|
|
86266
87579
|
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
@@ -86269,7 +87582,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86269
87582
|
{ },
|
|
86270
87583
|
{ },
|
|
86271
87584
|
{ },
|
|
86272
|
-
|
|
87585
|
+
body,
|
|
86273
87586
|
['PureCloud OAuth'],
|
|
86274
87587
|
['application/json'],
|
|
86275
87588
|
['application/json']
|
|
@@ -86279,12 +87592,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86279
87592
|
/**
|
|
86280
87593
|
* Create a time off request for the current user
|
|
86281
87594
|
*
|
|
86282
|
-
* @param {Object}
|
|
86283
|
-
* @param {Object} opts.body body
|
|
87595
|
+
* @param {Object} body body
|
|
86284
87596
|
*/
|
|
86285
|
-
postWorkforcemanagementTimeoffrequests(
|
|
86286
|
-
|
|
86287
|
-
|
|
87597
|
+
postWorkforcemanagementTimeoffrequests(body) {
|
|
87598
|
+
// verify the required parameter 'body' is set
|
|
87599
|
+
if (body === undefined || body === null) {
|
|
87600
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequests';
|
|
87601
|
+
}
|
|
86288
87602
|
|
|
86289
87603
|
return this.apiClient.callApi(
|
|
86290
87604
|
'/api/v2/workforcemanagement/timeoffrequests',
|
|
@@ -86293,7 +87607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86293
87607
|
{ },
|
|
86294
87608
|
{ },
|
|
86295
87609
|
{ },
|
|
86296
|
-
|
|
87610
|
+
body,
|
|
86297
87611
|
['PureCloud OAuth'],
|
|
86298
87612
|
['application/json'],
|
|
86299
87613
|
['application/json']
|
|
@@ -86303,12 +87617,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86303
87617
|
/**
|
|
86304
87618
|
* Estimates available time off for current user
|
|
86305
87619
|
*
|
|
86306
|
-
* @param {Object}
|
|
86307
|
-
* @param {Object} opts.body body
|
|
87620
|
+
* @param {Object} body body
|
|
86308
87621
|
*/
|
|
86309
|
-
postWorkforcemanagementTimeoffrequestsEstimate(
|
|
86310
|
-
|
|
86311
|
-
|
|
87622
|
+
postWorkforcemanagementTimeoffrequestsEstimate(body) {
|
|
87623
|
+
// verify the required parameter 'body' is set
|
|
87624
|
+
if (body === undefined || body === null) {
|
|
87625
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequestsEstimate';
|
|
87626
|
+
}
|
|
86312
87627
|
|
|
86313
87628
|
return this.apiClient.callApi(
|
|
86314
87629
|
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
@@ -86317,7 +87632,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86317
87632
|
{ },
|
|
86318
87633
|
{ },
|
|
86319
87634
|
{ },
|
|
86320
|
-
|
|
87635
|
+
body,
|
|
86321
87636
|
['PureCloud OAuth'],
|
|
86322
87637
|
['application/json'],
|
|
86323
87638
|
['application/json']
|
|
@@ -86327,12 +87642,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86327
87642
|
/**
|
|
86328
87643
|
* Retrieves integration statuses for a list of current user time off requests
|
|
86329
87644
|
*
|
|
86330
|
-
* @param {Object}
|
|
86331
|
-
* @param {Object} opts.body body
|
|
87645
|
+
* @param {Object} body body
|
|
86332
87646
|
*/
|
|
86333
|
-
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(
|
|
86334
|
-
|
|
86335
|
-
|
|
87647
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(body) {
|
|
87648
|
+
// verify the required parameter 'body' is set
|
|
87649
|
+
if (body === undefined || body === null) {
|
|
87650
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery';
|
|
87651
|
+
}
|
|
86336
87652
|
|
|
86337
87653
|
return this.apiClient.callApi(
|
|
86338
87654
|
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
@@ -86341,7 +87657,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86341
87657
|
{ },
|
|
86342
87658
|
{ },
|
|
86343
87659
|
{ },
|
|
86344
|
-
|
|
87660
|
+
body,
|
|
86345
87661
|
['PureCloud OAuth'],
|
|
86346
87662
|
['application/json'],
|
|
86347
87663
|
['application/json']
|
|
@@ -86383,12 +87699,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86383
87699
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
86384
87700
|
* @param {String} businessUnitId The ID of the business unit
|
|
86385
87701
|
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
86386
|
-
* @param {Object}
|
|
86387
|
-
* @param {Object} opts.body body
|
|
87702
|
+
* @param {Object} body body
|
|
86388
87703
|
*/
|
|
86389
|
-
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId,
|
|
86390
|
-
opts = opts || {};
|
|
86391
|
-
|
|
87704
|
+
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId, body) {
|
|
86392
87705
|
// verify the required parameter 'businessUnitId' is set
|
|
86393
87706
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
86394
87707
|
throw 'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
@@ -86397,6 +87710,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86397
87710
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
86398
87711
|
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
86399
87712
|
}
|
|
87713
|
+
// verify the required parameter 'body' is set
|
|
87714
|
+
if (body === undefined || body === null) {
|
|
87715
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
87716
|
+
}
|
|
86400
87717
|
|
|
86401
87718
|
return this.apiClient.callApi(
|
|
86402
87719
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
@@ -86405,7 +87722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86405
87722
|
{ },
|
|
86406
87723
|
{ },
|
|
86407
87724
|
{ },
|
|
86408
|
-
|
|
87725
|
+
body,
|
|
86409
87726
|
['PureCloud OAuth'],
|
|
86410
87727
|
['application/json'],
|
|
86411
87728
|
['application/json']
|
|
@@ -86417,12 +87734,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86417
87734
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
86418
87735
|
* @param {String} managementUnitId The ID of the management unit.
|
|
86419
87736
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
86420
|
-
* @param {Object}
|
|
86421
|
-
* @param {Object} opts.body body
|
|
87737
|
+
* @param {Object} body body
|
|
86422
87738
|
*/
|
|
86423
|
-
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId,
|
|
86424
|
-
opts = opts || {};
|
|
86425
|
-
|
|
87739
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, body) {
|
|
86426
87740
|
// verify the required parameter 'managementUnitId' is set
|
|
86427
87741
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86428
87742
|
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
@@ -86431,6 +87745,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86431
87745
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
86432
87746
|
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
86433
87747
|
}
|
|
87748
|
+
// verify the required parameter 'body' is set
|
|
87749
|
+
if (body === undefined || body === null) {
|
|
87750
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
87751
|
+
}
|
|
86434
87752
|
|
|
86435
87753
|
return this.apiClient.callApi(
|
|
86436
87754
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
@@ -86439,7 +87757,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86439
87757
|
{ },
|
|
86440
87758
|
{ },
|
|
86441
87759
|
{ },
|
|
86442
|
-
|
|
87760
|
+
body,
|
|
86443
87761
|
['PureCloud OAuth'],
|
|
86444
87762
|
['application/json'],
|
|
86445
87763
|
['application/json']
|
|
@@ -86477,7 +87795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86477
87795
|
* </pre>
|
|
86478
87796
|
* </p>
|
|
86479
87797
|
* @module purecloud-platform-client-v2/index
|
|
86480
|
-
* @version
|
|
87798
|
+
* @version 224.0.0
|
|
86481
87799
|
*/
|
|
86482
87800
|
class platformClient {
|
|
86483
87801
|
constructor() {
|
|
@@ -86491,6 +87809,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86491
87809
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
86492
87810
|
*/
|
|
86493
87811
|
this.ApiClientClass = ApiClient;
|
|
87812
|
+
/**
|
|
87813
|
+
* The AIStudioApi service constructor.
|
|
87814
|
+
* @property {module:purecloud-platform-client-v2/api/AIStudioApi}
|
|
87815
|
+
*/
|
|
87816
|
+
this.AIStudioApi = AIStudioApi;
|
|
86494
87817
|
/**
|
|
86495
87818
|
* The AgentAssistantsApi service constructor.
|
|
86496
87819
|
* @property {module:purecloud-platform-client-v2/api/AgentAssistantsApi}
|