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
|
@@ -690,7 +690,7 @@ class Configuration {
|
|
|
690
690
|
|
|
691
691
|
/**
|
|
692
692
|
* @module purecloud-platform-client-v2/ApiClient
|
|
693
|
-
* @version
|
|
693
|
+
* @version 224.0.0
|
|
694
694
|
*/
|
|
695
695
|
class ApiClient {
|
|
696
696
|
/**
|
|
@@ -2230,11 +2230,393 @@ class ApiClient {
|
|
|
2230
2230
|
}
|
|
2231
2231
|
}
|
|
2232
2232
|
|
|
2233
|
+
class AIStudioApi {
|
|
2234
|
+
/**
|
|
2235
|
+
* AIStudio service.
|
|
2236
|
+
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2237
|
+
* @version 224.0.0
|
|
2238
|
+
*/
|
|
2239
|
+
|
|
2240
|
+
/**
|
|
2241
|
+
* Constructs a new AIStudioApi.
|
|
2242
|
+
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
2243
|
+
* @class
|
|
2244
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
2245
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
2246
|
+
*/
|
|
2247
|
+
constructor(apiClient) {
|
|
2248
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
2249
|
+
}
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
/**
|
|
2253
|
+
* Start the deletion of a guide.
|
|
2254
|
+
*
|
|
2255
|
+
* @param {String} guideId Guide ID
|
|
2256
|
+
* deleteGuideJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2257
|
+
*/
|
|
2258
|
+
deleteGuideJobs(guideId) {
|
|
2259
|
+
// verify the required parameter 'guideId' is set
|
|
2260
|
+
if (guideId === undefined || guideId === null) {
|
|
2261
|
+
throw 'Missing the required parameter "guideId" when calling deleteGuideJobs';
|
|
2262
|
+
}
|
|
2263
|
+
|
|
2264
|
+
return this.apiClient.callApi(
|
|
2265
|
+
'/api/v2/guides/{guideId}/jobs',
|
|
2266
|
+
'DELETE',
|
|
2267
|
+
{ 'guideId': guideId },
|
|
2268
|
+
{ },
|
|
2269
|
+
{ },
|
|
2270
|
+
{ },
|
|
2271
|
+
null,
|
|
2272
|
+
['PureCloud OAuth'],
|
|
2273
|
+
['application/json'],
|
|
2274
|
+
['application/json']
|
|
2275
|
+
);
|
|
2276
|
+
}
|
|
2277
|
+
|
|
2278
|
+
/**
|
|
2279
|
+
* Get guide.
|
|
2280
|
+
*
|
|
2281
|
+
* @param {String} guideId Guide ID
|
|
2282
|
+
* getGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2283
|
+
*/
|
|
2284
|
+
getGuide(guideId) {
|
|
2285
|
+
// verify the required parameter 'guideId' is set
|
|
2286
|
+
if (guideId === undefined || guideId === null) {
|
|
2287
|
+
throw 'Missing the required parameter "guideId" when calling getGuide';
|
|
2288
|
+
}
|
|
2289
|
+
|
|
2290
|
+
return this.apiClient.callApi(
|
|
2291
|
+
'/api/v2/guides/{guideId}',
|
|
2292
|
+
'GET',
|
|
2293
|
+
{ 'guideId': guideId },
|
|
2294
|
+
{ },
|
|
2295
|
+
{ },
|
|
2296
|
+
{ },
|
|
2297
|
+
null,
|
|
2298
|
+
['PureCloud OAuth'],
|
|
2299
|
+
['application/json'],
|
|
2300
|
+
['application/json']
|
|
2301
|
+
);
|
|
2302
|
+
}
|
|
2303
|
+
|
|
2304
|
+
/**
|
|
2305
|
+
* Get the specified guide deletion job.
|
|
2306
|
+
*
|
|
2307
|
+
* @param {String} guideId Guide ID
|
|
2308
|
+
* @param {String} jobId jobId
|
|
2309
|
+
* getGuideJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2310
|
+
*/
|
|
2311
|
+
getGuideJob(guideId, jobId) {
|
|
2312
|
+
// verify the required parameter 'guideId' is set
|
|
2313
|
+
if (guideId === undefined || guideId === null) {
|
|
2314
|
+
throw 'Missing the required parameter "guideId" when calling getGuideJob';
|
|
2315
|
+
}
|
|
2316
|
+
// verify the required parameter 'jobId' is set
|
|
2317
|
+
if (jobId === undefined || jobId === null) {
|
|
2318
|
+
throw 'Missing the required parameter "jobId" when calling getGuideJob';
|
|
2319
|
+
}
|
|
2320
|
+
|
|
2321
|
+
return this.apiClient.callApi(
|
|
2322
|
+
'/api/v2/guides/{guideId}/jobs/{jobId}',
|
|
2323
|
+
'GET',
|
|
2324
|
+
{ 'guideId': guideId,'jobId': jobId },
|
|
2325
|
+
{ },
|
|
2326
|
+
{ },
|
|
2327
|
+
{ },
|
|
2328
|
+
null,
|
|
2329
|
+
['PureCloud OAuth'],
|
|
2330
|
+
['application/json'],
|
|
2331
|
+
['application/json']
|
|
2332
|
+
);
|
|
2333
|
+
}
|
|
2334
|
+
|
|
2335
|
+
/**
|
|
2336
|
+
* Get a guide version.
|
|
2337
|
+
*
|
|
2338
|
+
* @param {String} guideId Guide ID
|
|
2339
|
+
* @param {String} versionId Version ID
|
|
2340
|
+
* getGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2341
|
+
*/
|
|
2342
|
+
getGuideVersion(guideId, versionId) {
|
|
2343
|
+
// verify the required parameter 'guideId' is set
|
|
2344
|
+
if (guideId === undefined || guideId === null) {
|
|
2345
|
+
throw 'Missing the required parameter "guideId" when calling getGuideVersion';
|
|
2346
|
+
}
|
|
2347
|
+
// verify the required parameter 'versionId' is set
|
|
2348
|
+
if (versionId === undefined || versionId === null) {
|
|
2349
|
+
throw 'Missing the required parameter "versionId" when calling getGuideVersion';
|
|
2350
|
+
}
|
|
2351
|
+
|
|
2352
|
+
return this.apiClient.callApi(
|
|
2353
|
+
'/api/v2/guides/{guideId}/versions/{versionId}',
|
|
2354
|
+
'GET',
|
|
2355
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
2356
|
+
{ },
|
|
2357
|
+
{ },
|
|
2358
|
+
{ },
|
|
2359
|
+
null,
|
|
2360
|
+
['PureCloud OAuth'],
|
|
2361
|
+
['application/json'],
|
|
2362
|
+
['application/json']
|
|
2363
|
+
);
|
|
2364
|
+
}
|
|
2365
|
+
|
|
2366
|
+
/**
|
|
2367
|
+
* Get the status of the publishing job for this guide version.
|
|
2368
|
+
*
|
|
2369
|
+
* @param {String} guideId Guide ID
|
|
2370
|
+
* @param {String} versionId Version ID
|
|
2371
|
+
* @param {String} jobId jobId
|
|
2372
|
+
* getGuideVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2373
|
+
*/
|
|
2374
|
+
getGuideVersionJob(guideId, versionId, jobId) {
|
|
2375
|
+
// verify the required parameter 'guideId' is set
|
|
2376
|
+
if (guideId === undefined || guideId === null) {
|
|
2377
|
+
throw 'Missing the required parameter "guideId" when calling getGuideVersionJob';
|
|
2378
|
+
}
|
|
2379
|
+
// verify the required parameter 'versionId' is set
|
|
2380
|
+
if (versionId === undefined || versionId === null) {
|
|
2381
|
+
throw 'Missing the required parameter "versionId" when calling getGuideVersionJob';
|
|
2382
|
+
}
|
|
2383
|
+
// verify the required parameter 'jobId' is set
|
|
2384
|
+
if (jobId === undefined || jobId === null) {
|
|
2385
|
+
throw 'Missing the required parameter "jobId" when calling getGuideVersionJob';
|
|
2386
|
+
}
|
|
2387
|
+
|
|
2388
|
+
return this.apiClient.callApi(
|
|
2389
|
+
'/api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId}',
|
|
2390
|
+
'GET',
|
|
2391
|
+
{ 'guideId': guideId,'versionId': versionId,'jobId': jobId },
|
|
2392
|
+
{ },
|
|
2393
|
+
{ },
|
|
2394
|
+
{ },
|
|
2395
|
+
null,
|
|
2396
|
+
['PureCloud OAuth'],
|
|
2397
|
+
['application/json'],
|
|
2398
|
+
['application/json']
|
|
2399
|
+
);
|
|
2400
|
+
}
|
|
2401
|
+
|
|
2402
|
+
/**
|
|
2403
|
+
* Get all guides.
|
|
2404
|
+
*
|
|
2405
|
+
* @param {Object} opts Optional parameters
|
|
2406
|
+
* @param {String} opts.name Filter by matching name - case insensitive.
|
|
2407
|
+
* @param {String} opts.nameContains Filter by name contains - case insensitive.
|
|
2408
|
+
* @param {Object} opts.status Filter by status.
|
|
2409
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2410
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2411
|
+
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2412
|
+
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
2413
|
+
* getGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2414
|
+
*/
|
|
2415
|
+
getGuides(opts) {
|
|
2416
|
+
opts = opts || {};
|
|
2417
|
+
|
|
2418
|
+
|
|
2419
|
+
return this.apiClient.callApi(
|
|
2420
|
+
'/api/v2/guides',
|
|
2421
|
+
'GET',
|
|
2422
|
+
{ },
|
|
2423
|
+
{ 'name': opts['name'],'nameContains': opts['nameContains'],'status': opts['status'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
2424
|
+
{ },
|
|
2425
|
+
{ },
|
|
2426
|
+
null,
|
|
2427
|
+
['PureCloud OAuth'],
|
|
2428
|
+
['application/json'],
|
|
2429
|
+
['application/json']
|
|
2430
|
+
);
|
|
2431
|
+
}
|
|
2432
|
+
|
|
2433
|
+
/**
|
|
2434
|
+
* Get the status of the guide content generation job.
|
|
2435
|
+
*
|
|
2436
|
+
* @param {String} jobId jobId
|
|
2437
|
+
* getGuidesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2438
|
+
*/
|
|
2439
|
+
getGuidesJob(jobId) {
|
|
2440
|
+
// verify the required parameter 'jobId' is set
|
|
2441
|
+
if (jobId === undefined || jobId === null) {
|
|
2442
|
+
throw 'Missing the required parameter "jobId" when calling getGuidesJob';
|
|
2443
|
+
}
|
|
2444
|
+
|
|
2445
|
+
return this.apiClient.callApi(
|
|
2446
|
+
'/api/v2/guides/jobs/{jobId}',
|
|
2447
|
+
'GET',
|
|
2448
|
+
{ 'jobId': jobId },
|
|
2449
|
+
{ },
|
|
2450
|
+
{ },
|
|
2451
|
+
{ },
|
|
2452
|
+
null,
|
|
2453
|
+
['PureCloud OAuth'],
|
|
2454
|
+
['application/json'],
|
|
2455
|
+
['application/json']
|
|
2456
|
+
);
|
|
2457
|
+
}
|
|
2458
|
+
|
|
2459
|
+
/**
|
|
2460
|
+
* Update a guide version.
|
|
2461
|
+
*
|
|
2462
|
+
* @param {String} guideId Guide ID
|
|
2463
|
+
* @param {String} versionId Version ID
|
|
2464
|
+
* @param {Object} body
|
|
2465
|
+
* patchGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2466
|
+
*/
|
|
2467
|
+
patchGuideVersion(guideId, versionId, body) {
|
|
2468
|
+
// verify the required parameter 'guideId' is set
|
|
2469
|
+
if (guideId === undefined || guideId === null) {
|
|
2470
|
+
throw 'Missing the required parameter "guideId" when calling patchGuideVersion';
|
|
2471
|
+
}
|
|
2472
|
+
// verify the required parameter 'versionId' is set
|
|
2473
|
+
if (versionId === undefined || versionId === null) {
|
|
2474
|
+
throw 'Missing the required parameter "versionId" when calling patchGuideVersion';
|
|
2475
|
+
}
|
|
2476
|
+
// verify the required parameter 'body' is set
|
|
2477
|
+
if (body === undefined || body === null) {
|
|
2478
|
+
throw 'Missing the required parameter "body" when calling patchGuideVersion';
|
|
2479
|
+
}
|
|
2480
|
+
|
|
2481
|
+
return this.apiClient.callApi(
|
|
2482
|
+
'/api/v2/guides/{guideId}/versions/{versionId}',
|
|
2483
|
+
'PATCH',
|
|
2484
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
2485
|
+
{ },
|
|
2486
|
+
{ },
|
|
2487
|
+
{ },
|
|
2488
|
+
body,
|
|
2489
|
+
['PureCloud OAuth'],
|
|
2490
|
+
['application/json'],
|
|
2491
|
+
['application/json']
|
|
2492
|
+
);
|
|
2493
|
+
}
|
|
2494
|
+
|
|
2495
|
+
/**
|
|
2496
|
+
* Start the publishing of a guide version.
|
|
2497
|
+
*
|
|
2498
|
+
* @param {String} guideId Guide ID
|
|
2499
|
+
* @param {String} versionId Version ID
|
|
2500
|
+
* @param {Object} body
|
|
2501
|
+
* postGuideVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2502
|
+
*/
|
|
2503
|
+
postGuideVersionJobs(guideId, versionId, body) {
|
|
2504
|
+
// verify the required parameter 'guideId' is set
|
|
2505
|
+
if (guideId === undefined || guideId === null) {
|
|
2506
|
+
throw 'Missing the required parameter "guideId" when calling postGuideVersionJobs';
|
|
2507
|
+
}
|
|
2508
|
+
// verify the required parameter 'versionId' is set
|
|
2509
|
+
if (versionId === undefined || versionId === null) {
|
|
2510
|
+
throw 'Missing the required parameter "versionId" when calling postGuideVersionJobs';
|
|
2511
|
+
}
|
|
2512
|
+
// verify the required parameter 'body' is set
|
|
2513
|
+
if (body === undefined || body === null) {
|
|
2514
|
+
throw 'Missing the required parameter "body" when calling postGuideVersionJobs';
|
|
2515
|
+
}
|
|
2516
|
+
|
|
2517
|
+
return this.apiClient.callApi(
|
|
2518
|
+
'/api/v2/guides/{guideId}/versions/{versionId}/jobs',
|
|
2519
|
+
'POST',
|
|
2520
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
2521
|
+
{ },
|
|
2522
|
+
{ },
|
|
2523
|
+
{ },
|
|
2524
|
+
body,
|
|
2525
|
+
['PureCloud OAuth'],
|
|
2526
|
+
['application/json'],
|
|
2527
|
+
['application/json']
|
|
2528
|
+
);
|
|
2529
|
+
}
|
|
2530
|
+
|
|
2531
|
+
/**
|
|
2532
|
+
* Create a guide version.
|
|
2533
|
+
*
|
|
2534
|
+
* @param {String} guideId Guide ID
|
|
2535
|
+
* @param {Object} opts Optional parameters
|
|
2536
|
+
* @param {Object} opts.body
|
|
2537
|
+
* postGuideVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2538
|
+
*/
|
|
2539
|
+
postGuideVersions(guideId, opts) {
|
|
2540
|
+
opts = opts || {};
|
|
2541
|
+
|
|
2542
|
+
// verify the required parameter 'guideId' is set
|
|
2543
|
+
if (guideId === undefined || guideId === null) {
|
|
2544
|
+
throw 'Missing the required parameter "guideId" when calling postGuideVersions';
|
|
2545
|
+
}
|
|
2546
|
+
|
|
2547
|
+
return this.apiClient.callApi(
|
|
2548
|
+
'/api/v2/guides/{guideId}/versions',
|
|
2549
|
+
'POST',
|
|
2550
|
+
{ 'guideId': guideId },
|
|
2551
|
+
{ },
|
|
2552
|
+
{ },
|
|
2553
|
+
{ },
|
|
2554
|
+
opts['body'],
|
|
2555
|
+
['PureCloud OAuth'],
|
|
2556
|
+
['application/json'],
|
|
2557
|
+
['application/json']
|
|
2558
|
+
);
|
|
2559
|
+
}
|
|
2560
|
+
|
|
2561
|
+
/**
|
|
2562
|
+
* Create a guide.
|
|
2563
|
+
*
|
|
2564
|
+
* @param {Object} body
|
|
2565
|
+
* postGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2566
|
+
*/
|
|
2567
|
+
postGuides(body) {
|
|
2568
|
+
// verify the required parameter 'body' is set
|
|
2569
|
+
if (body === undefined || body === null) {
|
|
2570
|
+
throw 'Missing the required parameter "body" when calling postGuides';
|
|
2571
|
+
}
|
|
2572
|
+
|
|
2573
|
+
return this.apiClient.callApi(
|
|
2574
|
+
'/api/v2/guides',
|
|
2575
|
+
'POST',
|
|
2576
|
+
{ },
|
|
2577
|
+
{ },
|
|
2578
|
+
{ },
|
|
2579
|
+
{ },
|
|
2580
|
+
body,
|
|
2581
|
+
['PureCloud OAuth'],
|
|
2582
|
+
['application/json'],
|
|
2583
|
+
['application/json']
|
|
2584
|
+
);
|
|
2585
|
+
}
|
|
2586
|
+
|
|
2587
|
+
/**
|
|
2588
|
+
* Start a guide content generation job.
|
|
2589
|
+
*
|
|
2590
|
+
* @param {Object} body
|
|
2591
|
+
* postGuidesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2592
|
+
*/
|
|
2593
|
+
postGuidesJobs(body) {
|
|
2594
|
+
// verify the required parameter 'body' is set
|
|
2595
|
+
if (body === undefined || body === null) {
|
|
2596
|
+
throw 'Missing the required parameter "body" when calling postGuidesJobs';
|
|
2597
|
+
}
|
|
2598
|
+
|
|
2599
|
+
return this.apiClient.callApi(
|
|
2600
|
+
'/api/v2/guides/jobs',
|
|
2601
|
+
'POST',
|
|
2602
|
+
{ },
|
|
2603
|
+
{ },
|
|
2604
|
+
{ },
|
|
2605
|
+
{ },
|
|
2606
|
+
body,
|
|
2607
|
+
['PureCloud OAuth'],
|
|
2608
|
+
['application/json'],
|
|
2609
|
+
['application/json']
|
|
2610
|
+
);
|
|
2611
|
+
}
|
|
2612
|
+
|
|
2613
|
+
}
|
|
2614
|
+
|
|
2233
2615
|
class AgentAssistantsApi {
|
|
2234
2616
|
/**
|
|
2235
2617
|
* AgentAssistants service.
|
|
2236
2618
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2237
|
-
* @version
|
|
2619
|
+
* @version 224.0.0
|
|
2238
2620
|
*/
|
|
2239
2621
|
|
|
2240
2622
|
/**
|
|
@@ -2437,6 +2819,7 @@ class AgentAssistantsApi {
|
|
|
2437
2819
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
2438
2820
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
2439
2821
|
* @param {String} opts.name Return the assistant by the given name.
|
|
2822
|
+
* @param {Object} opts.expand Which fields, if any, to expand
|
|
2440
2823
|
*/
|
|
2441
2824
|
getAssistants(opts) {
|
|
2442
2825
|
opts = opts || {};
|
|
@@ -2446,7 +2829,7 @@ class AgentAssistantsApi {
|
|
|
2446
2829
|
'/api/v2/assistants',
|
|
2447
2830
|
'GET',
|
|
2448
2831
|
{ },
|
|
2449
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
2832
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'expand': opts['expand'] },
|
|
2450
2833
|
{ },
|
|
2451
2834
|
{ },
|
|
2452
2835
|
null,
|
|
@@ -2610,7 +2993,7 @@ class AgentCopilotApi {
|
|
|
2610
2993
|
/**
|
|
2611
2994
|
* AgentCopilot service.
|
|
2612
2995
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2613
|
-
* @version
|
|
2996
|
+
* @version 224.0.0
|
|
2614
2997
|
*/
|
|
2615
2998
|
|
|
2616
2999
|
/**
|
|
@@ -2686,7 +3069,7 @@ class AgentUIApi {
|
|
|
2686
3069
|
/**
|
|
2687
3070
|
* AgentUI service.
|
|
2688
3071
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2689
|
-
* @version
|
|
3072
|
+
* @version 224.0.0
|
|
2690
3073
|
*/
|
|
2691
3074
|
|
|
2692
3075
|
/**
|
|
@@ -2817,7 +3200,7 @@ class AlertingApi {
|
|
|
2817
3200
|
/**
|
|
2818
3201
|
* Alerting service.
|
|
2819
3202
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2820
|
-
* @version
|
|
3203
|
+
* @version 224.0.0
|
|
2821
3204
|
*/
|
|
2822
3205
|
|
|
2823
3206
|
/**
|
|
@@ -3218,7 +3601,7 @@ class AnalyticsApi {
|
|
|
3218
3601
|
/**
|
|
3219
3602
|
* Analytics service.
|
|
3220
3603
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3221
|
-
* @version
|
|
3604
|
+
* @version 224.0.0
|
|
3222
3605
|
*/
|
|
3223
3606
|
|
|
3224
3607
|
/**
|
|
@@ -4791,7 +5174,7 @@ class AnalyticsApi {
|
|
|
4791
5174
|
}
|
|
4792
5175
|
|
|
4793
5176
|
/**
|
|
4794
|
-
* Count agents by
|
|
5177
|
+
* Count agents by different groupings
|
|
4795
5178
|
*
|
|
4796
5179
|
* @param {Object} body query
|
|
4797
5180
|
*/
|
|
@@ -6039,7 +6422,7 @@ class ArchitectApi {
|
|
|
6039
6422
|
/**
|
|
6040
6423
|
* Architect service.
|
|
6041
6424
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6042
|
-
* @version
|
|
6425
|
+
* @version 224.0.0
|
|
6043
6426
|
*/
|
|
6044
6427
|
|
|
6045
6428
|
/**
|
|
@@ -6925,7 +7308,7 @@ class ArchitectApi {
|
|
|
6925
7308
|
|
|
6926
7309
|
/**
|
|
6927
7310
|
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
6928
|
-
* This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch
|
|
7311
|
+
* 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.
|
|
6929
7312
|
* @param {Object} opts Optional parameters
|
|
6930
7313
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
6931
7314
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -9083,6 +9466,7 @@ class ArchitectApi {
|
|
|
9083
9466
|
*
|
|
9084
9467
|
* @param {String} promptId Prompt ID
|
|
9085
9468
|
* @param {String} languageCode Language
|
|
9469
|
+
* postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9086
9470
|
*/
|
|
9087
9471
|
postArchitectPromptResourceUploads(promptId, languageCode) {
|
|
9088
9472
|
// verify the required parameter 'promptId' is set
|
|
@@ -9243,6 +9627,7 @@ class ArchitectApi {
|
|
|
9243
9627
|
*
|
|
9244
9628
|
* @param {String} promptId Prompt ID
|
|
9245
9629
|
* @param {String} languageCode Language
|
|
9630
|
+
* postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9246
9631
|
*/
|
|
9247
9632
|
postArchitectSystempromptResourceUploads(promptId, languageCode) {
|
|
9248
9633
|
// verify the required parameter 'promptId' is set
|
|
@@ -10332,7 +10717,7 @@ class AuditApi {
|
|
|
10332
10717
|
/**
|
|
10333
10718
|
* Audit service.
|
|
10334
10719
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10335
|
-
* @version
|
|
10720
|
+
* @version 224.0.0
|
|
10336
10721
|
*/
|
|
10337
10722
|
|
|
10338
10723
|
/**
|
|
@@ -10533,7 +10918,7 @@ class AuthorizationApi {
|
|
|
10533
10918
|
/**
|
|
10534
10919
|
* Authorization service.
|
|
10535
10920
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10536
|
-
* @version
|
|
10921
|
+
* @version 224.0.0
|
|
10537
10922
|
*/
|
|
10538
10923
|
|
|
10539
10924
|
/**
|
|
@@ -12248,7 +12633,7 @@ class BillingApi {
|
|
|
12248
12633
|
/**
|
|
12249
12634
|
* Billing service.
|
|
12250
12635
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12251
|
-
* @version
|
|
12636
|
+
* @version 224.0.0
|
|
12252
12637
|
*/
|
|
12253
12638
|
|
|
12254
12639
|
/**
|
|
@@ -12504,7 +12889,7 @@ class BusinessRulesApi {
|
|
|
12504
12889
|
/**
|
|
12505
12890
|
* BusinessRules service.
|
|
12506
12891
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12507
|
-
* @version
|
|
12892
|
+
* @version 224.0.0
|
|
12508
12893
|
*/
|
|
12509
12894
|
|
|
12510
12895
|
/**
|
|
@@ -12777,7 +13162,7 @@ class BusinessRulesApi {
|
|
|
12777
13162
|
* @param {String} tableId Table ID
|
|
12778
13163
|
* @param {Object} opts Optional parameters
|
|
12779
13164
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12780
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
13165
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12781
13166
|
* @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.
|
|
12782
13167
|
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12783
13168
|
*/
|
|
@@ -12808,7 +13193,7 @@ class BusinessRulesApi {
|
|
|
12808
13193
|
*
|
|
12809
13194
|
* @param {Object} opts Optional parameters
|
|
12810
13195
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12811
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
13196
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12812
13197
|
* @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.
|
|
12813
13198
|
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12814
13199
|
*/
|
|
@@ -12834,11 +13219,13 @@ class BusinessRulesApi {
|
|
|
12834
13219
|
* Search for decision tables.
|
|
12835
13220
|
*
|
|
12836
13221
|
* @param {Object} opts Optional parameters
|
|
12837
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12838
13222
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12839
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
13223
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12840
13224
|
* @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.
|
|
12841
13225
|
* @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.
|
|
13226
|
+
* @param {Boolean} opts.withPublishedVersion Filters results to only decision tables that have at least one version in Published status
|
|
13227
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
13228
|
+
* @param {Array.<String>} opts.ids Decision table IDs to search for
|
|
12842
13229
|
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12843
13230
|
*/
|
|
12844
13231
|
getBusinessrulesDecisiontablesSearch(opts) {
|
|
@@ -12849,7 +13236,7 @@ class BusinessRulesApi {
|
|
|
12849
13236
|
'/api/v2/businessrules/decisiontables/search',
|
|
12850
13237
|
'GET',
|
|
12851
13238
|
{ },
|
|
12852
|
-
{ '
|
|
13239
|
+
{ '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') },
|
|
12853
13240
|
{ },
|
|
12854
13241
|
{ },
|
|
12855
13242
|
null,
|
|
@@ -13021,12 +13408,13 @@ class BusinessRulesApi {
|
|
|
13021
13408
|
}
|
|
13022
13409
|
|
|
13023
13410
|
/**
|
|
13024
|
-
*
|
|
13411
|
+
* Partially update a decision table row. Will be deprecated, we should use PUT request.
|
|
13025
13412
|
*
|
|
13026
13413
|
* @param {String} tableId Table ID
|
|
13027
13414
|
* @param {Number} tableVersion Table Version
|
|
13028
13415
|
* @param {String} rowId Row ID
|
|
13029
|
-
* @param {Object} body
|
|
13416
|
+
* @param {Object} body Partially update decision table row request
|
|
13417
|
+
* @deprecated
|
|
13030
13418
|
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13031
13419
|
*/
|
|
13032
13420
|
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
@@ -13381,6 +13769,47 @@ class BusinessRulesApi {
|
|
|
13381
13769
|
);
|
|
13382
13770
|
}
|
|
13383
13771
|
|
|
13772
|
+
/**
|
|
13773
|
+
* Full update a decision table row
|
|
13774
|
+
*
|
|
13775
|
+
* @param {String} tableId Table ID
|
|
13776
|
+
* @param {Number} tableVersion Table Version
|
|
13777
|
+
* @param {String} rowId Row ID
|
|
13778
|
+
* @param {Object} body Full update decision table row request
|
|
13779
|
+
* putBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13780
|
+
*/
|
|
13781
|
+
putBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
13782
|
+
// verify the required parameter 'tableId' is set
|
|
13783
|
+
if (tableId === undefined || tableId === null) {
|
|
13784
|
+
throw 'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionRow';
|
|
13785
|
+
}
|
|
13786
|
+
// verify the required parameter 'tableVersion' is set
|
|
13787
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13788
|
+
throw 'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionRow';
|
|
13789
|
+
}
|
|
13790
|
+
// verify the required parameter 'rowId' is set
|
|
13791
|
+
if (rowId === undefined || rowId === null) {
|
|
13792
|
+
throw 'Missing the required parameter "rowId" when calling putBusinessrulesDecisiontableVersionRow';
|
|
13793
|
+
}
|
|
13794
|
+
// verify the required parameter 'body' is set
|
|
13795
|
+
if (body === undefined || body === null) {
|
|
13796
|
+
throw 'Missing the required parameter "body" when calling putBusinessrulesDecisiontableVersionRow';
|
|
13797
|
+
}
|
|
13798
|
+
|
|
13799
|
+
return this.apiClient.callApi(
|
|
13800
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
13801
|
+
'PUT',
|
|
13802
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
13803
|
+
{ },
|
|
13804
|
+
{ },
|
|
13805
|
+
{ },
|
|
13806
|
+
body,
|
|
13807
|
+
['PureCloud OAuth'],
|
|
13808
|
+
['application/json'],
|
|
13809
|
+
['application/json']
|
|
13810
|
+
);
|
|
13811
|
+
}
|
|
13812
|
+
|
|
13384
13813
|
/**
|
|
13385
13814
|
* Update a schema
|
|
13386
13815
|
*
|
|
@@ -13418,7 +13847,7 @@ class CarrierServicesApi {
|
|
|
13418
13847
|
/**
|
|
13419
13848
|
* CarrierServices service.
|
|
13420
13849
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
13421
|
-
* @version
|
|
13850
|
+
* @version 224.0.0
|
|
13422
13851
|
*/
|
|
13423
13852
|
|
|
13424
13853
|
/**
|
|
@@ -13488,7 +13917,7 @@ class ChatApi {
|
|
|
13488
13917
|
/**
|
|
13489
13918
|
* Chat service.
|
|
13490
13919
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
13491
|
-
* @version
|
|
13920
|
+
* @version 224.0.0
|
|
13492
13921
|
*/
|
|
13493
13922
|
|
|
13494
13923
|
/**
|
|
@@ -14421,7 +14850,7 @@ class CoachingApi {
|
|
|
14421
14850
|
/**
|
|
14422
14851
|
* Coaching service.
|
|
14423
14852
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
14424
|
-
* @version
|
|
14853
|
+
* @version 224.0.0
|
|
14425
14854
|
*/
|
|
14426
14855
|
|
|
14427
14856
|
/**
|
|
@@ -14998,7 +15427,7 @@ class ContentManagementApi {
|
|
|
14998
15427
|
/**
|
|
14999
15428
|
* ContentManagement service.
|
|
15000
15429
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15001
|
-
* @version
|
|
15430
|
+
* @version 224.0.0
|
|
15002
15431
|
*/
|
|
15003
15432
|
|
|
15004
15433
|
/**
|
|
@@ -16079,7 +16508,7 @@ class ConversationsApi {
|
|
|
16079
16508
|
/**
|
|
16080
16509
|
* Conversations service.
|
|
16081
16510
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
16082
|
-
* @version
|
|
16511
|
+
* @version 224.0.0
|
|
16083
16512
|
*/
|
|
16084
16513
|
|
|
16085
16514
|
/**
|
|
@@ -16669,6 +17098,78 @@ class ConversationsApi {
|
|
|
16669
17098
|
);
|
|
16670
17099
|
}
|
|
16671
17100
|
|
|
17101
|
+
/**
|
|
17102
|
+
* Get message
|
|
17103
|
+
*
|
|
17104
|
+
* @param {String} conversationId conversationId
|
|
17105
|
+
* @param {String} communicationId communicationId
|
|
17106
|
+
* @param {String} messageId messageId
|
|
17107
|
+
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17108
|
+
*/
|
|
17109
|
+
getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) {
|
|
17110
|
+
// verify the required parameter 'conversationId' is set
|
|
17111
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17112
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationInternalmessage';
|
|
17113
|
+
}
|
|
17114
|
+
// verify the required parameter 'communicationId' is set
|
|
17115
|
+
if (communicationId === undefined || communicationId === null) {
|
|
17116
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationInternalmessage';
|
|
17117
|
+
}
|
|
17118
|
+
// verify the required parameter 'messageId' is set
|
|
17119
|
+
if (messageId === undefined || messageId === null) {
|
|
17120
|
+
throw 'Missing the required parameter "messageId" when calling getConversationCommunicationInternalmessage';
|
|
17121
|
+
}
|
|
17122
|
+
|
|
17123
|
+
return this.apiClient.callApi(
|
|
17124
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages/{messageId}',
|
|
17125
|
+
'GET',
|
|
17126
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'messageId': messageId },
|
|
17127
|
+
{ },
|
|
17128
|
+
{ },
|
|
17129
|
+
{ },
|
|
17130
|
+
null,
|
|
17131
|
+
['PureCloud OAuth'],
|
|
17132
|
+
['application/json'],
|
|
17133
|
+
['application/json']
|
|
17134
|
+
);
|
|
17135
|
+
}
|
|
17136
|
+
|
|
17137
|
+
/**
|
|
17138
|
+
* Get messages for communication
|
|
17139
|
+
*
|
|
17140
|
+
* @param {String} conversationId conversationId
|
|
17141
|
+
* @param {String} communicationId communicationId
|
|
17142
|
+
* @param {Object} opts Optional parameters
|
|
17143
|
+
* @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)
|
|
17144
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17145
|
+
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17146
|
+
*/
|
|
17147
|
+
getConversationCommunicationInternalmessages(conversationId, communicationId, opts) {
|
|
17148
|
+
opts = opts || {};
|
|
17149
|
+
|
|
17150
|
+
// verify the required parameter 'conversationId' is set
|
|
17151
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17152
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationInternalmessages';
|
|
17153
|
+
}
|
|
17154
|
+
// verify the required parameter 'communicationId' is set
|
|
17155
|
+
if (communicationId === undefined || communicationId === null) {
|
|
17156
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationInternalmessages';
|
|
17157
|
+
}
|
|
17158
|
+
|
|
17159
|
+
return this.apiClient.callApi(
|
|
17160
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages',
|
|
17161
|
+
'GET',
|
|
17162
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
17163
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
17164
|
+
{ },
|
|
17165
|
+
{ },
|
|
17166
|
+
null,
|
|
17167
|
+
['PureCloud OAuth'],
|
|
17168
|
+
['application/json'],
|
|
17169
|
+
['application/json']
|
|
17170
|
+
);
|
|
17171
|
+
}
|
|
17172
|
+
|
|
16672
17173
|
/**
|
|
16673
17174
|
* Fetch info on a secure session
|
|
16674
17175
|
*
|
|
@@ -16967,7 +17468,7 @@ class ConversationsApi {
|
|
|
16967
17468
|
* @param {String} participantId participantId
|
|
16968
17469
|
* @param {String} communicationId communicationId
|
|
16969
17470
|
* @param {Object} opts Optional parameters
|
|
16970
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17471
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
16971
17472
|
*/
|
|
16972
17473
|
getConversationsCallParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
16973
17474
|
opts = opts || {};
|
|
@@ -17005,7 +17506,7 @@ class ConversationsApi {
|
|
|
17005
17506
|
* @param {String} conversationId conversationId
|
|
17006
17507
|
* @param {String} participantId participantId
|
|
17007
17508
|
* @param {Object} opts Optional parameters
|
|
17008
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17509
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17009
17510
|
*/
|
|
17010
17511
|
getConversationsCallParticipantWrapup(conversationId, participantId, opts) {
|
|
17011
17512
|
opts = opts || {};
|
|
@@ -17095,7 +17596,7 @@ class ConversationsApi {
|
|
|
17095
17596
|
* @param {String} participantId participantId
|
|
17096
17597
|
* @param {String} communicationId communicationId
|
|
17097
17598
|
* @param {Object} opts Optional parameters
|
|
17098
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17599
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17099
17600
|
*/
|
|
17100
17601
|
getConversationsCallbackParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
17101
17602
|
opts = opts || {};
|
|
@@ -17133,7 +17634,7 @@ class ConversationsApi {
|
|
|
17133
17634
|
* @param {String} conversationId conversationId
|
|
17134
17635
|
* @param {String} participantId participantId
|
|
17135
17636
|
* @param {Object} opts Optional parameters
|
|
17136
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17637
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17137
17638
|
*/
|
|
17138
17639
|
getConversationsCallbackParticipantWrapup(conversationId, participantId, opts) {
|
|
17139
17640
|
opts = opts || {};
|
|
@@ -17375,7 +17876,7 @@ class ConversationsApi {
|
|
|
17375
17876
|
* @param {String} participantId participantId
|
|
17376
17877
|
* @param {String} communicationId communicationId
|
|
17377
17878
|
* @param {Object} opts Optional parameters
|
|
17378
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17879
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17379
17880
|
* @deprecated
|
|
17380
17881
|
*/
|
|
17381
17882
|
getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -17414,7 +17915,7 @@ class ConversationsApi {
|
|
|
17414
17915
|
* @param {String} conversationId conversationId
|
|
17415
17916
|
* @param {String} participantId participantId
|
|
17416
17917
|
* @param {Object} opts Optional parameters
|
|
17417
|
-
* @param {Boolean} opts.provisional Indicates
|
|
17918
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17418
17919
|
* @deprecated
|
|
17419
17920
|
*/
|
|
17420
17921
|
getConversationsChatParticipantWrapup(conversationId, participantId, opts) {
|
|
@@ -17527,7 +18028,7 @@ class ConversationsApi {
|
|
|
17527
18028
|
* @param {String} participantId participantId
|
|
17528
18029
|
* @param {String} communicationId communicationId
|
|
17529
18030
|
* @param {Object} opts Optional parameters
|
|
17530
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18031
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17531
18032
|
* @deprecated
|
|
17532
18033
|
*/
|
|
17533
18034
|
getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -17566,7 +18067,7 @@ class ConversationsApi {
|
|
|
17566
18067
|
* @param {String} conversationId conversationId
|
|
17567
18068
|
* @param {String} participantId participantId
|
|
17568
18069
|
* @param {Object} opts Optional parameters
|
|
17569
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18070
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17570
18071
|
* @deprecated
|
|
17571
18072
|
*/
|
|
17572
18073
|
getConversationsCobrowsesessionParticipantWrapup(conversationId, participantId, opts) {
|
|
@@ -17758,7 +18259,7 @@ class ConversationsApi {
|
|
|
17758
18259
|
* @param {String} participantId participantId
|
|
17759
18260
|
* @param {String} communicationId communicationId
|
|
17760
18261
|
* @param {Object} opts Optional parameters
|
|
17761
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18262
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17762
18263
|
*/
|
|
17763
18264
|
getConversationsEmailParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
17764
18265
|
opts = opts || {};
|
|
@@ -17796,7 +18297,7 @@ class ConversationsApi {
|
|
|
17796
18297
|
* @param {String} conversationId conversationId
|
|
17797
18298
|
* @param {String} participantId participantId
|
|
17798
18299
|
* @param {Object} opts Optional parameters
|
|
17799
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18300
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
17800
18301
|
*/
|
|
17801
18302
|
getConversationsEmailParticipantWrapup(conversationId, participantId, opts) {
|
|
17802
18303
|
opts = opts || {};
|
|
@@ -17899,6 +18400,53 @@ class ConversationsApi {
|
|
|
17899
18400
|
);
|
|
17900
18401
|
}
|
|
17901
18402
|
|
|
18403
|
+
/**
|
|
18404
|
+
* Get internal message conversation
|
|
18405
|
+
*
|
|
18406
|
+
* @param {String} conversationId conversationId
|
|
18407
|
+
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18408
|
+
*/
|
|
18409
|
+
getConversationsInternalmessage(conversationId) {
|
|
18410
|
+
// verify the required parameter 'conversationId' is set
|
|
18411
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18412
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationsInternalmessage';
|
|
18413
|
+
}
|
|
18414
|
+
|
|
18415
|
+
return this.apiClient.callApi(
|
|
18416
|
+
'/api/v2/conversations/internalmessages/{conversationId}',
|
|
18417
|
+
'GET',
|
|
18418
|
+
{ 'conversationId': conversationId },
|
|
18419
|
+
{ },
|
|
18420
|
+
{ },
|
|
18421
|
+
{ },
|
|
18422
|
+
null,
|
|
18423
|
+
['PureCloud OAuth'],
|
|
18424
|
+
['application/json'],
|
|
18425
|
+
['application/json']
|
|
18426
|
+
);
|
|
18427
|
+
}
|
|
18428
|
+
|
|
18429
|
+
/**
|
|
18430
|
+
* Get active internal message conversations for the logged in user
|
|
18431
|
+
*
|
|
18432
|
+
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18433
|
+
*/
|
|
18434
|
+
getConversationsInternalmessages() {
|
|
18435
|
+
|
|
18436
|
+
return this.apiClient.callApi(
|
|
18437
|
+
'/api/v2/conversations/internalmessages',
|
|
18438
|
+
'GET',
|
|
18439
|
+
{ },
|
|
18440
|
+
{ },
|
|
18441
|
+
{ },
|
|
18442
|
+
{ },
|
|
18443
|
+
null,
|
|
18444
|
+
['PureCloud OAuth'],
|
|
18445
|
+
['application/json'],
|
|
18446
|
+
['application/json']
|
|
18447
|
+
);
|
|
18448
|
+
}
|
|
18449
|
+
|
|
17902
18450
|
/**
|
|
17903
18451
|
* Get the encryption key configurations
|
|
17904
18452
|
*
|
|
@@ -18074,7 +18622,7 @@ class ConversationsApi {
|
|
|
18074
18622
|
* @param {String} participantId participantId
|
|
18075
18623
|
* @param {String} communicationId communicationId
|
|
18076
18624
|
* @param {Object} opts Optional parameters
|
|
18077
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18625
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
18078
18626
|
*/
|
|
18079
18627
|
getConversationsMessageParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18080
18628
|
opts = opts || {};
|
|
@@ -18112,7 +18660,7 @@ class ConversationsApi {
|
|
|
18112
18660
|
* @param {String} conversationId conversationId
|
|
18113
18661
|
* @param {String} participantId participantId
|
|
18114
18662
|
* @param {Object} opts Optional parameters
|
|
18115
|
-
* @param {Boolean} opts.provisional Indicates
|
|
18663
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
18116
18664
|
*/
|
|
18117
18665
|
getConversationsMessageParticipantWrapup(conversationId, participantId, opts) {
|
|
18118
18666
|
opts = opts || {};
|
|
@@ -18382,6 +18930,31 @@ class ConversationsApi {
|
|
|
18382
18930
|
);
|
|
18383
18931
|
}
|
|
18384
18932
|
|
|
18933
|
+
/**
|
|
18934
|
+
* Get X (Formally Twitter) messaging integration identity resolution settings
|
|
18935
|
+
*
|
|
18936
|
+
* @param {String} integrationId Integration Id
|
|
18937
|
+
*/
|
|
18938
|
+
getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(integrationId) {
|
|
18939
|
+
// verify the required parameter 'integrationId' is set
|
|
18940
|
+
if (integrationId === undefined || integrationId === null) {
|
|
18941
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
18942
|
+
}
|
|
18943
|
+
|
|
18944
|
+
return this.apiClient.callApi(
|
|
18945
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}',
|
|
18946
|
+
'GET',
|
|
18947
|
+
{ 'integrationId': integrationId },
|
|
18948
|
+
{ },
|
|
18949
|
+
{ },
|
|
18950
|
+
{ },
|
|
18951
|
+
null,
|
|
18952
|
+
['PureCloud OAuth'],
|
|
18953
|
+
['application/json'],
|
|
18954
|
+
['application/json']
|
|
18955
|
+
);
|
|
18956
|
+
}
|
|
18957
|
+
|
|
18385
18958
|
/**
|
|
18386
18959
|
* Get a whatsApp integration Identity Resolution settings
|
|
18387
18960
|
*
|
|
@@ -18932,7 +19505,7 @@ class ConversationsApi {
|
|
|
18932
19505
|
* @param {String} participantId participantId
|
|
18933
19506
|
* @param {String} communicationId communicationId
|
|
18934
19507
|
* @param {Object} opts Optional parameters
|
|
18935
|
-
* @param {Boolean} opts.provisional Indicates
|
|
19508
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
18936
19509
|
* @deprecated
|
|
18937
19510
|
*/
|
|
18938
19511
|
getConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -18992,7 +19565,7 @@ class ConversationsApi {
|
|
|
18992
19565
|
* @param {String} participantId participantId
|
|
18993
19566
|
* @param {String} communicationId communicationId
|
|
18994
19567
|
* @param {Object} opts Optional parameters
|
|
18995
|
-
* @param {Boolean} opts.provisional Indicates
|
|
19568
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
18996
19569
|
*/
|
|
18997
19570
|
getConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18998
19571
|
opts = opts || {};
|
|
@@ -19057,7 +19630,7 @@ class ConversationsApi {
|
|
|
19057
19630
|
* @param {String} participantId participantId
|
|
19058
19631
|
* @param {String} communicationId communicationId
|
|
19059
19632
|
* @param {Object} opts Optional parameters
|
|
19060
|
-
* @param {Boolean} opts.provisional Indicates
|
|
19633
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
19061
19634
|
*/
|
|
19062
19635
|
getConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
19063
19636
|
opts = opts || {};
|
|
@@ -20829,6 +21402,42 @@ class ConversationsApi {
|
|
|
20829
21402
|
);
|
|
20830
21403
|
}
|
|
20831
21404
|
|
|
21405
|
+
/**
|
|
21406
|
+
* Send internal message
|
|
21407
|
+
* Send a new internal message for an existing communication.
|
|
21408
|
+
* @param {String} conversationId conversationId
|
|
21409
|
+
* @param {String} communicationId communicationId
|
|
21410
|
+
* @param {Object} body Message
|
|
21411
|
+
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21412
|
+
*/
|
|
21413
|
+
postConversationCommunicationInternalmessages(conversationId, communicationId, body) {
|
|
21414
|
+
// verify the required parameter 'conversationId' is set
|
|
21415
|
+
if (conversationId === undefined || conversationId === null) {
|
|
21416
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationInternalmessages';
|
|
21417
|
+
}
|
|
21418
|
+
// verify the required parameter 'communicationId' is set
|
|
21419
|
+
if (communicationId === undefined || communicationId === null) {
|
|
21420
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationInternalmessages';
|
|
21421
|
+
}
|
|
21422
|
+
// verify the required parameter 'body' is set
|
|
21423
|
+
if (body === undefined || body === null) {
|
|
21424
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationInternalmessages';
|
|
21425
|
+
}
|
|
21426
|
+
|
|
21427
|
+
return this.apiClient.callApi(
|
|
21428
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages',
|
|
21429
|
+
'POST',
|
|
21430
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
21431
|
+
{ },
|
|
21432
|
+
{ },
|
|
21433
|
+
{ },
|
|
21434
|
+
body,
|
|
21435
|
+
['PureCloud OAuth'],
|
|
21436
|
+
['application/json'],
|
|
21437
|
+
['application/json']
|
|
21438
|
+
);
|
|
21439
|
+
}
|
|
21440
|
+
|
|
20832
21441
|
/**
|
|
20833
21442
|
* 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.
|
|
20834
21443
|
*
|
|
@@ -20922,6 +21531,42 @@ class ConversationsApi {
|
|
|
20922
21531
|
);
|
|
20923
21532
|
}
|
|
20924
21533
|
|
|
21534
|
+
/**
|
|
21535
|
+
* Setup internal message communication with user
|
|
21536
|
+
* The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission.
|
|
21537
|
+
* @param {String} conversationId conversation ID
|
|
21538
|
+
* @param {String} participantId participant ID
|
|
21539
|
+
* @param {Object} body Confer request
|
|
21540
|
+
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21541
|
+
*/
|
|
21542
|
+
postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) {
|
|
21543
|
+
// verify the required parameter 'conversationId' is set
|
|
21544
|
+
if (conversationId === undefined || conversationId === null) {
|
|
21545
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
21546
|
+
}
|
|
21547
|
+
// verify the required parameter 'participantId' is set
|
|
21548
|
+
if (participantId === undefined || participantId === null) {
|
|
21549
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
21550
|
+
}
|
|
21551
|
+
// verify the required parameter 'body' is set
|
|
21552
|
+
if (body === undefined || body === null) {
|
|
21553
|
+
throw 'Missing the required parameter "body" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
21554
|
+
}
|
|
21555
|
+
|
|
21556
|
+
return this.apiClient.callApi(
|
|
21557
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/internalmessages/users/communications',
|
|
21558
|
+
'POST',
|
|
21559
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
21560
|
+
{ },
|
|
21561
|
+
{ },
|
|
21562
|
+
{ },
|
|
21563
|
+
body,
|
|
21564
|
+
['PureCloud OAuth'],
|
|
21565
|
+
['application/json'],
|
|
21566
|
+
['application/json']
|
|
21567
|
+
);
|
|
21568
|
+
}
|
|
21569
|
+
|
|
20925
21570
|
/**
|
|
20926
21571
|
* Replace this participant with the specified user and/or address
|
|
20927
21572
|
*
|
|
@@ -22397,6 +23042,41 @@ class ConversationsApi {
|
|
|
22397
23042
|
);
|
|
22398
23043
|
}
|
|
22399
23044
|
|
|
23045
|
+
/**
|
|
23046
|
+
* Send a social media message
|
|
23047
|
+
* Send a social media message on existing conversation/communication.
|
|
23048
|
+
* @param {String} conversationId conversationId
|
|
23049
|
+
* @param {String} communicationId communicationId
|
|
23050
|
+
* @param {Object} body Message
|
|
23051
|
+
*/
|
|
23052
|
+
postConversationsMessageCommunicationSocialmediaMessages(conversationId, communicationId, body) {
|
|
23053
|
+
// verify the required parameter 'conversationId' is set
|
|
23054
|
+
if (conversationId === undefined || conversationId === null) {
|
|
23055
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
23056
|
+
}
|
|
23057
|
+
// verify the required parameter 'communicationId' is set
|
|
23058
|
+
if (communicationId === undefined || communicationId === null) {
|
|
23059
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
23060
|
+
}
|
|
23061
|
+
// verify the required parameter 'body' is set
|
|
23062
|
+
if (body === undefined || body === null) {
|
|
23063
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
23064
|
+
}
|
|
23065
|
+
|
|
23066
|
+
return this.apiClient.callApi(
|
|
23067
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/socialmedia/messages',
|
|
23068
|
+
'POST',
|
|
23069
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
23070
|
+
{ },
|
|
23071
|
+
{ },
|
|
23072
|
+
{ },
|
|
23073
|
+
body,
|
|
23074
|
+
['PureCloud OAuth'],
|
|
23075
|
+
['application/json'],
|
|
23076
|
+
['application/json']
|
|
23077
|
+
);
|
|
23078
|
+
}
|
|
23079
|
+
|
|
22400
23080
|
/**
|
|
22401
23081
|
* Send message typing event
|
|
22402
23082
|
* Send message typing event for existing conversation/communication.
|
|
@@ -22526,6 +23206,36 @@ class ConversationsApi {
|
|
|
22526
23206
|
);
|
|
22527
23207
|
}
|
|
22528
23208
|
|
|
23209
|
+
/**
|
|
23210
|
+
* Send inbound Open Response
|
|
23211
|
+
* 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.
|
|
23212
|
+
* @param {String} integrationId integrationId
|
|
23213
|
+
* @param {Object} body OpenInboundStructuredResponseMessage
|
|
23214
|
+
*/
|
|
23215
|
+
postConversationsMessageInboundOpenStructuredResponse(integrationId, body) {
|
|
23216
|
+
// verify the required parameter 'integrationId' is set
|
|
23217
|
+
if (integrationId === undefined || integrationId === null) {
|
|
23218
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenStructuredResponse';
|
|
23219
|
+
}
|
|
23220
|
+
// verify the required parameter 'body' is set
|
|
23221
|
+
if (body === undefined || body === null) {
|
|
23222
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenStructuredResponse';
|
|
23223
|
+
}
|
|
23224
|
+
|
|
23225
|
+
return this.apiClient.callApi(
|
|
23226
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/structured/response',
|
|
23227
|
+
'POST',
|
|
23228
|
+
{ 'integrationId': integrationId },
|
|
23229
|
+
{ },
|
|
23230
|
+
{ },
|
|
23231
|
+
{ },
|
|
23232
|
+
body,
|
|
23233
|
+
['PureCloud OAuth'],
|
|
23234
|
+
['application/json'],
|
|
23235
|
+
['application/json']
|
|
23236
|
+
);
|
|
23237
|
+
}
|
|
23238
|
+
|
|
22529
23239
|
/**
|
|
22530
23240
|
* Get messages in batch
|
|
22531
23241
|
* 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"]
|
|
@@ -23634,6 +24344,36 @@ class ConversationsApi {
|
|
|
23634
24344
|
);
|
|
23635
24345
|
}
|
|
23636
24346
|
|
|
24347
|
+
/**
|
|
24348
|
+
* Create an identity resolution settings for an X (Formally Twitter) messaging integration
|
|
24349
|
+
*
|
|
24350
|
+
* @param {String} integrationId Integration Id
|
|
24351
|
+
* @param {Object} body IdentityResolutionConfig
|
|
24352
|
+
*/
|
|
24353
|
+
putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
24354
|
+
// verify the required parameter 'integrationId' is set
|
|
24355
|
+
if (integrationId === undefined || integrationId === null) {
|
|
24356
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
24357
|
+
}
|
|
24358
|
+
// verify the required parameter 'body' is set
|
|
24359
|
+
if (body === undefined || body === null) {
|
|
24360
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
24361
|
+
}
|
|
24362
|
+
|
|
24363
|
+
return this.apiClient.callApi(
|
|
24364
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}',
|
|
24365
|
+
'PUT',
|
|
24366
|
+
{ 'integrationId': integrationId },
|
|
24367
|
+
{ },
|
|
24368
|
+
{ },
|
|
24369
|
+
{ },
|
|
24370
|
+
body,
|
|
24371
|
+
['PureCloud OAuth'],
|
|
24372
|
+
['application/json'],
|
|
24373
|
+
['application/json']
|
|
24374
|
+
);
|
|
24375
|
+
}
|
|
24376
|
+
|
|
23637
24377
|
/**
|
|
23638
24378
|
* Update a whatsApp integration Identity Resolution settings
|
|
23639
24379
|
*
|
|
@@ -23836,7 +24576,7 @@ class DataExtensionsApi {
|
|
|
23836
24576
|
/**
|
|
23837
24577
|
* DataExtensions service.
|
|
23838
24578
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23839
|
-
* @version
|
|
24579
|
+
* @version 224.0.0
|
|
23840
24580
|
*/
|
|
23841
24581
|
|
|
23842
24582
|
/**
|
|
@@ -23922,7 +24662,7 @@ class DataPrivacyApi {
|
|
|
23922
24662
|
/**
|
|
23923
24663
|
* DataPrivacy service.
|
|
23924
24664
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
23925
|
-
* @version
|
|
24665
|
+
* @version 224.0.0
|
|
23926
24666
|
*/
|
|
23927
24667
|
|
|
23928
24668
|
/**
|
|
@@ -24092,7 +24832,7 @@ class DownloadsApi {
|
|
|
24092
24832
|
/**
|
|
24093
24833
|
* Downloads service.
|
|
24094
24834
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
24095
|
-
* @version
|
|
24835
|
+
* @version 224.0.0
|
|
24096
24836
|
*/
|
|
24097
24837
|
|
|
24098
24838
|
/**
|
|
@@ -24144,7 +24884,7 @@ class EmailsApi {
|
|
|
24144
24884
|
/**
|
|
24145
24885
|
* Emails service.
|
|
24146
24886
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
24147
|
-
* @version
|
|
24887
|
+
* @version 224.0.0
|
|
24148
24888
|
*/
|
|
24149
24889
|
|
|
24150
24890
|
/**
|
|
@@ -24273,7 +25013,7 @@ class EmployeeEngagementApi {
|
|
|
24273
25013
|
/**
|
|
24274
25014
|
* EmployeeEngagement service.
|
|
24275
25015
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
24276
|
-
* @version
|
|
25016
|
+
* @version 224.0.0
|
|
24277
25017
|
*/
|
|
24278
25018
|
|
|
24279
25019
|
/**
|
|
@@ -24424,7 +25164,7 @@ class EventsApi {
|
|
|
24424
25164
|
/**
|
|
24425
25165
|
* Events service.
|
|
24426
25166
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
24427
|
-
* @version
|
|
25167
|
+
* @version 224.0.0
|
|
24428
25168
|
*/
|
|
24429
25169
|
|
|
24430
25170
|
/**
|
|
@@ -24520,7 +25260,7 @@ class ExternalContactsApi {
|
|
|
24520
25260
|
/**
|
|
24521
25261
|
* ExternalContacts service.
|
|
24522
25262
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
24523
|
-
* @version
|
|
25263
|
+
* @version 224.0.0
|
|
24524
25264
|
*/
|
|
24525
25265
|
|
|
24526
25266
|
/**
|
|
@@ -27708,7 +28448,7 @@ class FaxApi {
|
|
|
27708
28448
|
/**
|
|
27709
28449
|
* Fax service.
|
|
27710
28450
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
27711
|
-
* @version
|
|
28451
|
+
* @version 224.0.0
|
|
27712
28452
|
*/
|
|
27713
28453
|
|
|
27714
28454
|
/**
|
|
@@ -27923,7 +28663,7 @@ class FlowsApi {
|
|
|
27923
28663
|
/**
|
|
27924
28664
|
* Flows service.
|
|
27925
28665
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
27926
|
-
* @version
|
|
28666
|
+
* @version 224.0.0
|
|
27927
28667
|
*/
|
|
27928
28668
|
|
|
27929
28669
|
/**
|
|
@@ -28106,7 +28846,7 @@ class GamificationApi {
|
|
|
28106
28846
|
/**
|
|
28107
28847
|
* Gamification service.
|
|
28108
28848
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
28109
|
-
* @version
|
|
28849
|
+
* @version 224.0.0
|
|
28110
28850
|
*/
|
|
28111
28851
|
|
|
28112
28852
|
/**
|
|
@@ -30613,7 +31353,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
30613
31353
|
/**
|
|
30614
31354
|
* GeneralDataProtectionRegulation service.
|
|
30615
31355
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
30616
|
-
* @version
|
|
31356
|
+
* @version 224.0.0
|
|
30617
31357
|
*/
|
|
30618
31358
|
|
|
30619
31359
|
/**
|
|
@@ -30743,7 +31483,7 @@ class GeolocationApi {
|
|
|
30743
31483
|
/**
|
|
30744
31484
|
* Geolocation service.
|
|
30745
31485
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
30746
|
-
* @version
|
|
31486
|
+
* @version 224.0.0
|
|
30747
31487
|
*/
|
|
30748
31488
|
|
|
30749
31489
|
/**
|
|
@@ -30874,7 +31614,7 @@ class GreetingsApi {
|
|
|
30874
31614
|
/**
|
|
30875
31615
|
* Greetings service.
|
|
30876
31616
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
30877
|
-
* @version
|
|
31617
|
+
* @version 224.0.0
|
|
30878
31618
|
*/
|
|
30879
31619
|
|
|
30880
31620
|
/**
|
|
@@ -30940,12 +31680,70 @@ class GreetingsApi {
|
|
|
30940
31680
|
}
|
|
30941
31681
|
|
|
30942
31682
|
/**
|
|
30943
|
-
*
|
|
31683
|
+
* Download a organization greeting recording
|
|
30944
31684
|
*
|
|
30945
31685
|
* @param {String} greetingId Greeting ID
|
|
30946
31686
|
* @param {Object} opts Optional parameters
|
|
30947
31687
|
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
30948
31688
|
*/
|
|
31689
|
+
getGreetingDownloads(greetingId, opts) {
|
|
31690
|
+
opts = opts || {};
|
|
31691
|
+
|
|
31692
|
+
// verify the required parameter 'greetingId' is set
|
|
31693
|
+
if (greetingId === undefined || greetingId === null) {
|
|
31694
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingDownloads';
|
|
31695
|
+
}
|
|
31696
|
+
|
|
31697
|
+
return this.apiClient.callApi(
|
|
31698
|
+
'/api/v2/greetings/{greetingId}/downloads',
|
|
31699
|
+
'GET',
|
|
31700
|
+
{ 'greetingId': greetingId },
|
|
31701
|
+
{ 'formatId': opts['formatId'] },
|
|
31702
|
+
{ },
|
|
31703
|
+
{ },
|
|
31704
|
+
null,
|
|
31705
|
+
['PureCloud OAuth'],
|
|
31706
|
+
['application/json'],
|
|
31707
|
+
['application/json']
|
|
31708
|
+
);
|
|
31709
|
+
}
|
|
31710
|
+
|
|
31711
|
+
/**
|
|
31712
|
+
* Download a group greeting recording
|
|
31713
|
+
*
|
|
31714
|
+
* @param {String} greetingId Greeting ID
|
|
31715
|
+
* @param {Object} opts Optional parameters
|
|
31716
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
31717
|
+
*/
|
|
31718
|
+
getGreetingGroupsDownloads(greetingId, opts) {
|
|
31719
|
+
opts = opts || {};
|
|
31720
|
+
|
|
31721
|
+
// verify the required parameter 'greetingId' is set
|
|
31722
|
+
if (greetingId === undefined || greetingId === null) {
|
|
31723
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingGroupsDownloads';
|
|
31724
|
+
}
|
|
31725
|
+
|
|
31726
|
+
return this.apiClient.callApi(
|
|
31727
|
+
'/api/v2/greetings/{greetingId}/groups/downloads',
|
|
31728
|
+
'GET',
|
|
31729
|
+
{ 'greetingId': greetingId },
|
|
31730
|
+
{ 'formatId': opts['formatId'] },
|
|
31731
|
+
{ },
|
|
31732
|
+
{ },
|
|
31733
|
+
null,
|
|
31734
|
+
['PureCloud OAuth'],
|
|
31735
|
+
['application/json'],
|
|
31736
|
+
['application/json']
|
|
31737
|
+
);
|
|
31738
|
+
}
|
|
31739
|
+
|
|
31740
|
+
/**
|
|
31741
|
+
* Get media playback URI for this greeting
|
|
31742
|
+
* API should migrate to use GET api/v2/greetings/{greetingId}/downloads
|
|
31743
|
+
* @param {String} greetingId Greeting ID
|
|
31744
|
+
* @param {Object} opts Optional parameters
|
|
31745
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
31746
|
+
*/
|
|
30949
31747
|
getGreetingMedia(greetingId, opts) {
|
|
30950
31748
|
opts = opts || {};
|
|
30951
31749
|
|
|
@@ -30968,6 +31766,35 @@ class GreetingsApi {
|
|
|
30968
31766
|
);
|
|
30969
31767
|
}
|
|
30970
31768
|
|
|
31769
|
+
/**
|
|
31770
|
+
* Download a user greeting recording
|
|
31771
|
+
*
|
|
31772
|
+
* @param {String} greetingId Greeting ID
|
|
31773
|
+
* @param {Object} opts Optional parameters
|
|
31774
|
+
* @param {Object} opts.formatId The desired media format. (default to WAV)
|
|
31775
|
+
*/
|
|
31776
|
+
getGreetingUsersDownloads(greetingId, opts) {
|
|
31777
|
+
opts = opts || {};
|
|
31778
|
+
|
|
31779
|
+
// verify the required parameter 'greetingId' is set
|
|
31780
|
+
if (greetingId === undefined || greetingId === null) {
|
|
31781
|
+
throw 'Missing the required parameter "greetingId" when calling getGreetingUsersDownloads';
|
|
31782
|
+
}
|
|
31783
|
+
|
|
31784
|
+
return this.apiClient.callApi(
|
|
31785
|
+
'/api/v2/greetings/{greetingId}/users/downloads',
|
|
31786
|
+
'GET',
|
|
31787
|
+
{ 'greetingId': greetingId },
|
|
31788
|
+
{ 'formatId': opts['formatId'] },
|
|
31789
|
+
{ },
|
|
31790
|
+
{ },
|
|
31791
|
+
null,
|
|
31792
|
+
['PureCloud OAuth'],
|
|
31793
|
+
['application/json'],
|
|
31794
|
+
['application/json']
|
|
31795
|
+
);
|
|
31796
|
+
}
|
|
31797
|
+
|
|
30971
31798
|
/**
|
|
30972
31799
|
* Gets an Organization's Greetings
|
|
30973
31800
|
*
|
|
@@ -31329,7 +32156,7 @@ class GroupsApi {
|
|
|
31329
32156
|
/**
|
|
31330
32157
|
* Groups service.
|
|
31331
32158
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
31332
|
-
* @version
|
|
32159
|
+
* @version 224.0.0
|
|
31333
32160
|
*/
|
|
31334
32161
|
|
|
31335
32162
|
/**
|
|
@@ -31848,7 +32675,7 @@ class IdentityProviderApi {
|
|
|
31848
32675
|
/**
|
|
31849
32676
|
* IdentityProvider service.
|
|
31850
32677
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
31851
|
-
* @version
|
|
32678
|
+
* @version 224.0.0
|
|
31852
32679
|
*/
|
|
31853
32680
|
|
|
31854
32681
|
/**
|
|
@@ -32709,7 +33536,7 @@ class InfrastructureAsCodeApi {
|
|
|
32709
33536
|
/**
|
|
32710
33537
|
* InfrastructureAsCode service.
|
|
32711
33538
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
32712
|
-
* @version
|
|
33539
|
+
* @version 224.0.0
|
|
32713
33540
|
*/
|
|
32714
33541
|
|
|
32715
33542
|
/**
|
|
@@ -32876,7 +33703,7 @@ class IntegrationsApi {
|
|
|
32876
33703
|
/**
|
|
32877
33704
|
* Integrations service.
|
|
32878
33705
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
32879
|
-
* @version
|
|
33706
|
+
* @version 224.0.0
|
|
32880
33707
|
*/
|
|
32881
33708
|
|
|
32882
33709
|
/**
|
|
@@ -33507,6 +34334,103 @@ class IntegrationsApi {
|
|
|
33507
34334
|
);
|
|
33508
34335
|
}
|
|
33509
34336
|
|
|
34337
|
+
/**
|
|
34338
|
+
* Get a specific Bot details
|
|
34339
|
+
*
|
|
34340
|
+
* @param {String} integrationId The integration ID for this group of bots
|
|
34341
|
+
* @param {String} botId The bot ID for this bot
|
|
34342
|
+
* @param {Object} opts Optional parameters
|
|
34343
|
+
* @param {String} opts.version Specific Version
|
|
34344
|
+
* getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34345
|
+
*/
|
|
34346
|
+
getIntegrationsBotconnectorBot(integrationId, botId, opts) {
|
|
34347
|
+
opts = opts || {};
|
|
34348
|
+
|
|
34349
|
+
// verify the required parameter 'integrationId' is set
|
|
34350
|
+
if (integrationId === undefined || integrationId === null) {
|
|
34351
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBot';
|
|
34352
|
+
}
|
|
34353
|
+
// verify the required parameter 'botId' is set
|
|
34354
|
+
if (botId === undefined || botId === null) {
|
|
34355
|
+
throw 'Missing the required parameter "botId" when calling getIntegrationsBotconnectorBot';
|
|
34356
|
+
}
|
|
34357
|
+
|
|
34358
|
+
return this.apiClient.callApi(
|
|
34359
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots/{botId}',
|
|
34360
|
+
'GET',
|
|
34361
|
+
{ 'integrationId': integrationId,'botId': botId },
|
|
34362
|
+
{ 'version': opts['version'] },
|
|
34363
|
+
{ },
|
|
34364
|
+
{ },
|
|
34365
|
+
null,
|
|
34366
|
+
['PureCloud OAuth'],
|
|
34367
|
+
['application/json'],
|
|
34368
|
+
['application/json']
|
|
34369
|
+
);
|
|
34370
|
+
}
|
|
34371
|
+
|
|
34372
|
+
/**
|
|
34373
|
+
* Get the list of bots for this integration.
|
|
34374
|
+
*
|
|
34375
|
+
* @param {String} integrationId The integration ID for this group of bots.
|
|
34376
|
+
* @param {Object} opts Optional parameters
|
|
34377
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34378
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
34379
|
+
* getIntegrationsBotconnectorBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34380
|
+
*/
|
|
34381
|
+
getIntegrationsBotconnectorBots(integrationId, opts) {
|
|
34382
|
+
opts = opts || {};
|
|
34383
|
+
|
|
34384
|
+
// verify the required parameter 'integrationId' is set
|
|
34385
|
+
if (integrationId === undefined || integrationId === null) {
|
|
34386
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBots';
|
|
34387
|
+
}
|
|
34388
|
+
|
|
34389
|
+
return this.apiClient.callApi(
|
|
34390
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots',
|
|
34391
|
+
'GET',
|
|
34392
|
+
{ 'integrationId': integrationId },
|
|
34393
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
34394
|
+
{ },
|
|
34395
|
+
{ },
|
|
34396
|
+
null,
|
|
34397
|
+
['PureCloud OAuth'],
|
|
34398
|
+
['application/json'],
|
|
34399
|
+
['application/json']
|
|
34400
|
+
);
|
|
34401
|
+
}
|
|
34402
|
+
|
|
34403
|
+
/**
|
|
34404
|
+
* Get the summary list of bots for this integration.
|
|
34405
|
+
*
|
|
34406
|
+
* @param {String} integrationId The integration ID for this group of bots.
|
|
34407
|
+
* @param {Object} opts Optional parameters
|
|
34408
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34409
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
34410
|
+
* getIntegrationsBotconnectorBotsSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34411
|
+
*/
|
|
34412
|
+
getIntegrationsBotconnectorBotsSummaries(integrationId, opts) {
|
|
34413
|
+
opts = opts || {};
|
|
34414
|
+
|
|
34415
|
+
// verify the required parameter 'integrationId' is set
|
|
34416
|
+
if (integrationId === undefined || integrationId === null) {
|
|
34417
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBotsSummaries';
|
|
34418
|
+
}
|
|
34419
|
+
|
|
34420
|
+
return this.apiClient.callApi(
|
|
34421
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots/summaries',
|
|
34422
|
+
'GET',
|
|
34423
|
+
{ 'integrationId': integrationId },
|
|
34424
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
34425
|
+
{ },
|
|
34426
|
+
{ },
|
|
34427
|
+
null,
|
|
34428
|
+
['PureCloud OAuth'],
|
|
34429
|
+
['application/json'],
|
|
34430
|
+
['application/json']
|
|
34431
|
+
);
|
|
34432
|
+
}
|
|
34433
|
+
|
|
33510
34434
|
/**
|
|
33511
34435
|
* Get a specific botConnector bot, plus versions, for this integration
|
|
33512
34436
|
*
|
|
@@ -33740,6 +34664,32 @@ class IntegrationsApi {
|
|
|
33740
34664
|
);
|
|
33741
34665
|
}
|
|
33742
34666
|
|
|
34667
|
+
/**
|
|
34668
|
+
* List multiple sets of credentials using cursor-based paging
|
|
34669
|
+
*
|
|
34670
|
+
* @param {Object} opts Optional parameters
|
|
34671
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
34672
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
34673
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
34674
|
+
*/
|
|
34675
|
+
getIntegrationsCredentialsListing(opts) {
|
|
34676
|
+
opts = opts || {};
|
|
34677
|
+
|
|
34678
|
+
|
|
34679
|
+
return this.apiClient.callApi(
|
|
34680
|
+
'/api/v2/integrations/credentials/listing',
|
|
34681
|
+
'GET',
|
|
34682
|
+
{ },
|
|
34683
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
34684
|
+
{ },
|
|
34685
|
+
{ },
|
|
34686
|
+
null,
|
|
34687
|
+
['PureCloud OAuth'],
|
|
34688
|
+
['application/json'],
|
|
34689
|
+
['application/json']
|
|
34690
|
+
);
|
|
34691
|
+
}
|
|
34692
|
+
|
|
33743
34693
|
/**
|
|
33744
34694
|
* List all credential types
|
|
33745
34695
|
*
|
|
@@ -34986,6 +35936,58 @@ class IntegrationsApi {
|
|
|
34986
35936
|
);
|
|
34987
35937
|
}
|
|
34988
35938
|
|
|
35939
|
+
/**
|
|
35940
|
+
* Send an incoming message to the bot.
|
|
35941
|
+
*
|
|
35942
|
+
* @param {Object} body Incoming Message Request
|
|
35943
|
+
* postIntegrationsBotconnectorsIncomingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35944
|
+
*/
|
|
35945
|
+
postIntegrationsBotconnectorsIncomingMessages(body) {
|
|
35946
|
+
// verify the required parameter 'body' is set
|
|
35947
|
+
if (body === undefined || body === null) {
|
|
35948
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsBotconnectorsIncomingMessages';
|
|
35949
|
+
}
|
|
35950
|
+
|
|
35951
|
+
return this.apiClient.callApi(
|
|
35952
|
+
'/api/v2/integrations/botconnectors/incoming/messages',
|
|
35953
|
+
'POST',
|
|
35954
|
+
{ },
|
|
35955
|
+
{ },
|
|
35956
|
+
{ },
|
|
35957
|
+
{ },
|
|
35958
|
+
body,
|
|
35959
|
+
['PureCloud OAuth'],
|
|
35960
|
+
['application/json'],
|
|
35961
|
+
['application/json']
|
|
35962
|
+
);
|
|
35963
|
+
}
|
|
35964
|
+
|
|
35965
|
+
/**
|
|
35966
|
+
* Send an outgoing message to the end user.
|
|
35967
|
+
*
|
|
35968
|
+
* @param {Object} body Outgoing Message Request
|
|
35969
|
+
* postIntegrationsBotconnectorsOutgoingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35970
|
+
*/
|
|
35971
|
+
postIntegrationsBotconnectorsOutgoingMessages(body) {
|
|
35972
|
+
// verify the required parameter 'body' is set
|
|
35973
|
+
if (body === undefined || body === null) {
|
|
35974
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsBotconnectorsOutgoingMessages';
|
|
35975
|
+
}
|
|
35976
|
+
|
|
35977
|
+
return this.apiClient.callApi(
|
|
35978
|
+
'/api/v2/integrations/botconnectors/outgoing/messages',
|
|
35979
|
+
'POST',
|
|
35980
|
+
{ },
|
|
35981
|
+
{ },
|
|
35982
|
+
{ },
|
|
35983
|
+
{ },
|
|
35984
|
+
body,
|
|
35985
|
+
['PureCloud OAuth'],
|
|
35986
|
+
['application/json'],
|
|
35987
|
+
['application/json']
|
|
35988
|
+
);
|
|
35989
|
+
}
|
|
35990
|
+
|
|
34989
35991
|
/**
|
|
34990
35992
|
* Create a set of credentials
|
|
34991
35993
|
*
|
|
@@ -35345,7 +36347,7 @@ class JourneyApi {
|
|
|
35345
36347
|
/**
|
|
35346
36348
|
* Journey service.
|
|
35347
36349
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
35348
|
-
* @version
|
|
36350
|
+
* @version 224.0.0
|
|
35349
36351
|
*/
|
|
35350
36352
|
|
|
35351
36353
|
/**
|
|
@@ -37330,7 +38332,7 @@ class KnowledgeApi {
|
|
|
37330
38332
|
/**
|
|
37331
38333
|
* Knowledge service.
|
|
37332
38334
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
37333
|
-
* @version
|
|
38335
|
+
* @version 224.0.0
|
|
37334
38336
|
*/
|
|
37335
38337
|
|
|
37336
38338
|
/**
|
|
@@ -41203,7 +42205,7 @@ class LanguageUnderstandingApi {
|
|
|
41203
42205
|
/**
|
|
41204
42206
|
* LanguageUnderstanding service.
|
|
41205
42207
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
41206
|
-
* @version
|
|
42208
|
+
* @version 224.0.0
|
|
41207
42209
|
*/
|
|
41208
42210
|
|
|
41209
42211
|
/**
|
|
@@ -42236,7 +43238,7 @@ class LanguagesApi {
|
|
|
42236
43238
|
/**
|
|
42237
43239
|
* Languages service.
|
|
42238
43240
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
42239
|
-
* @version
|
|
43241
|
+
* @version 224.0.0
|
|
42240
43242
|
*/
|
|
42241
43243
|
|
|
42242
43244
|
/**
|
|
@@ -42458,7 +43460,7 @@ class LearningApi {
|
|
|
42458
43460
|
/**
|
|
42459
43461
|
* Learning service.
|
|
42460
43462
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
42461
|
-
* @version
|
|
43463
|
+
* @version 224.0.0
|
|
42462
43464
|
*/
|
|
42463
43465
|
|
|
42464
43466
|
/**
|
|
@@ -43487,7 +44489,7 @@ class LicenseApi {
|
|
|
43487
44489
|
/**
|
|
43488
44490
|
* License service.
|
|
43489
44491
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
43490
|
-
* @version
|
|
44492
|
+
* @version 224.0.0
|
|
43491
44493
|
*/
|
|
43492
44494
|
|
|
43493
44495
|
/**
|
|
@@ -43725,7 +44727,7 @@ class LocationsApi {
|
|
|
43725
44727
|
/**
|
|
43726
44728
|
* Locations service.
|
|
43727
44729
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
43728
|
-
* @version
|
|
44730
|
+
* @version 224.0.0
|
|
43729
44731
|
*/
|
|
43730
44732
|
|
|
43731
44733
|
/**
|
|
@@ -43961,7 +44963,7 @@ class LogCaptureApi {
|
|
|
43961
44963
|
/**
|
|
43962
44964
|
* LogCapture service.
|
|
43963
44965
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
43964
|
-
* @version
|
|
44966
|
+
* @version 224.0.0
|
|
43965
44967
|
*/
|
|
43966
44968
|
|
|
43967
44969
|
/**
|
|
@@ -44103,7 +45105,6 @@ class LogCaptureApi {
|
|
|
44103
45105
|
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
44104
45106
|
*
|
|
44105
45107
|
* @param {Object} opts Optional parameters
|
|
44106
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
44107
45108
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
44108
45109
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
44109
45110
|
* @param {Object} opts.body
|
|
@@ -44116,7 +45117,7 @@ class LogCaptureApi {
|
|
|
44116
45117
|
'/api/v2/diagnostics/logcapture/browser/entries/query',
|
|
44117
45118
|
'POST',
|
|
44118
45119
|
{ },
|
|
44119
|
-
{ '
|
|
45120
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
44120
45121
|
{ },
|
|
44121
45122
|
{ },
|
|
44122
45123
|
opts['body'],
|
|
@@ -44161,7 +45162,7 @@ class MessagingApi {
|
|
|
44161
45162
|
/**
|
|
44162
45163
|
* Messaging service.
|
|
44163
45164
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
44164
|
-
* @version
|
|
45165
|
+
* @version 224.0.0
|
|
44165
45166
|
*/
|
|
44166
45167
|
|
|
44167
45168
|
/**
|
|
@@ -44520,7 +45521,7 @@ class MobileDevicesApi {
|
|
|
44520
45521
|
/**
|
|
44521
45522
|
* MobileDevices service.
|
|
44522
45523
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
44523
|
-
* @version
|
|
45524
|
+
* @version 224.0.0
|
|
44524
45525
|
*/
|
|
44525
45526
|
|
|
44526
45527
|
/**
|
|
@@ -44671,7 +45672,7 @@ class NotificationsApi {
|
|
|
44671
45672
|
/**
|
|
44672
45673
|
* Notifications service.
|
|
44673
45674
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
44674
|
-
* @version
|
|
45675
|
+
* @version 224.0.0
|
|
44675
45676
|
*/
|
|
44676
45677
|
|
|
44677
45678
|
/**
|
|
@@ -44904,7 +45905,7 @@ class OAuthApi {
|
|
|
44904
45905
|
/**
|
|
44905
45906
|
* OAuth service.
|
|
44906
45907
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
44907
|
-
* @version
|
|
45908
|
+
* @version 224.0.0
|
|
44908
45909
|
*/
|
|
44909
45910
|
|
|
44910
45911
|
/**
|
|
@@ -45270,7 +46271,7 @@ class ObjectsApi {
|
|
|
45270
46271
|
/**
|
|
45271
46272
|
* Objects service.
|
|
45272
46273
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
45273
|
-
* @version
|
|
46274
|
+
* @version 224.0.0
|
|
45274
46275
|
*/
|
|
45275
46276
|
|
|
45276
46277
|
/**
|
|
@@ -45594,7 +46595,7 @@ class OperationalEventsApi {
|
|
|
45594
46595
|
/**
|
|
45595
46596
|
* OperationalEvents service.
|
|
45596
46597
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
45597
|
-
* @version
|
|
46598
|
+
* @version 224.0.0
|
|
45598
46599
|
*/
|
|
45599
46600
|
|
|
45600
46601
|
/**
|
|
@@ -45711,7 +46712,7 @@ class OrganizationApi {
|
|
|
45711
46712
|
/**
|
|
45712
46713
|
* Organization service.
|
|
45713
46714
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
45714
|
-
* @version
|
|
46715
|
+
* @version 224.0.0
|
|
45715
46716
|
*/
|
|
45716
46717
|
|
|
45717
46718
|
/**
|
|
@@ -46186,7 +47187,7 @@ class OrganizationAuthorizationApi {
|
|
|
46186
47187
|
/**
|
|
46187
47188
|
* OrganizationAuthorization service.
|
|
46188
47189
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
46189
|
-
* @version
|
|
47190
|
+
* @version 224.0.0
|
|
46190
47191
|
*/
|
|
46191
47192
|
|
|
46192
47193
|
/**
|
|
@@ -47580,7 +48581,7 @@ class OutboundApi {
|
|
|
47580
48581
|
/**
|
|
47581
48582
|
* Outbound service.
|
|
47582
48583
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
47583
|
-
* @version
|
|
48584
|
+
* @version 224.0.0
|
|
47584
48585
|
*/
|
|
47585
48586
|
|
|
47586
48587
|
/**
|
|
@@ -52202,7 +53203,7 @@ class PresenceApi {
|
|
|
52202
53203
|
/**
|
|
52203
53204
|
* Presence service.
|
|
52204
53205
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
52205
|
-
* @version
|
|
53206
|
+
* @version 224.0.0
|
|
52206
53207
|
*/
|
|
52207
53208
|
|
|
52208
53209
|
/**
|
|
@@ -52946,7 +53947,7 @@ class ProcessAutomationApi {
|
|
|
52946
53947
|
/**
|
|
52947
53948
|
* ProcessAutomation service.
|
|
52948
53949
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
52949
|
-
* @version
|
|
53950
|
+
* @version 224.0.0
|
|
52950
53951
|
*/
|
|
52951
53952
|
|
|
52952
53953
|
/**
|
|
@@ -53185,7 +54186,7 @@ class QualityApi {
|
|
|
53185
54186
|
/**
|
|
53186
54187
|
* Quality service.
|
|
53187
54188
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
53188
|
-
* @version
|
|
54189
|
+
* @version 224.0.0
|
|
53189
54190
|
*/
|
|
53190
54191
|
|
|
53191
54192
|
/**
|
|
@@ -54972,7 +55973,7 @@ class RecordingApi {
|
|
|
54972
55973
|
/**
|
|
54973
55974
|
* Recording service.
|
|
54974
55975
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
54975
|
-
* @version
|
|
55976
|
+
* @version 224.0.0
|
|
54976
55977
|
*/
|
|
54977
55978
|
|
|
54978
55979
|
/**
|
|
@@ -56577,7 +57578,7 @@ class ResponseManagementApi {
|
|
|
56577
57578
|
/**
|
|
56578
57579
|
* ResponseManagement service.
|
|
56579
57580
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
56580
|
-
* @version
|
|
57581
|
+
* @version 224.0.0
|
|
56581
57582
|
*/
|
|
56582
57583
|
|
|
56583
57584
|
/**
|
|
@@ -57087,7 +58088,7 @@ class RoutingApi {
|
|
|
57087
58088
|
/**
|
|
57088
58089
|
* Routing service.
|
|
57089
58090
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
57090
|
-
* @version
|
|
58091
|
+
* @version 224.0.0
|
|
57091
58092
|
*/
|
|
57092
58093
|
|
|
57093
58094
|
/**
|
|
@@ -60001,6 +61002,36 @@ class RoutingApi {
|
|
|
60001
61002
|
);
|
|
60002
61003
|
}
|
|
60003
61004
|
|
|
61005
|
+
/**
|
|
61006
|
+
* Update a phone number provisioned for SMS.
|
|
61007
|
+
*
|
|
61008
|
+
* @param {String} phoneNumberId phone number
|
|
61009
|
+
* @param {Object} body SmsPhoneNumberPatchRequest
|
|
61010
|
+
*/
|
|
61011
|
+
patchRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
61012
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
61013
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
61014
|
+
throw 'Missing the required parameter "phoneNumberId" when calling patchRoutingSmsPhonenumber';
|
|
61015
|
+
}
|
|
61016
|
+
// verify the required parameter 'body' is set
|
|
61017
|
+
if (body === undefined || body === null) {
|
|
61018
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSmsPhonenumber';
|
|
61019
|
+
}
|
|
61020
|
+
|
|
61021
|
+
return this.apiClient.callApi(
|
|
61022
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
61023
|
+
'PATCH',
|
|
61024
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
61025
|
+
{ },
|
|
61026
|
+
{ },
|
|
61027
|
+
{ },
|
|
61028
|
+
body,
|
|
61029
|
+
['PureCloud OAuth'],
|
|
61030
|
+
['application/json'],
|
|
61031
|
+
['application/json']
|
|
61032
|
+
);
|
|
61033
|
+
}
|
|
61034
|
+
|
|
60004
61035
|
/**
|
|
60005
61036
|
* Join or unjoin a queue for a user
|
|
60006
61037
|
*
|
|
@@ -61397,7 +62428,7 @@ class SCIMApi {
|
|
|
61397
62428
|
/**
|
|
61398
62429
|
* SCIM service.
|
|
61399
62430
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
61400
|
-
* @version
|
|
62431
|
+
* @version 224.0.0
|
|
61401
62432
|
*/
|
|
61402
62433
|
|
|
61403
62434
|
/**
|
|
@@ -62274,7 +63305,7 @@ class ScreenRecordingApi {
|
|
|
62274
63305
|
/**
|
|
62275
63306
|
* ScreenRecording service.
|
|
62276
63307
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
62277
|
-
* @version
|
|
63308
|
+
* @version 224.0.0
|
|
62278
63309
|
*/
|
|
62279
63310
|
|
|
62280
63311
|
/**
|
|
@@ -62319,7 +63350,7 @@ class ScriptsApi {
|
|
|
62319
63350
|
/**
|
|
62320
63351
|
* Scripts service.
|
|
62321
63352
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
62322
|
-
* @version
|
|
63353
|
+
* @version 224.0.0
|
|
62323
63354
|
*/
|
|
62324
63355
|
|
|
62325
63356
|
/**
|
|
@@ -62795,7 +63826,7 @@ class SearchApi {
|
|
|
62795
63826
|
/**
|
|
62796
63827
|
* Search service.
|
|
62797
63828
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
62798
|
-
* @version
|
|
63829
|
+
* @version 224.0.0
|
|
62799
63830
|
*/
|
|
62800
63831
|
|
|
62801
63832
|
/**
|
|
@@ -63538,7 +64569,7 @@ class SettingsApi {
|
|
|
63538
64569
|
/**
|
|
63539
64570
|
* Settings service.
|
|
63540
64571
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
63541
|
-
* @version
|
|
64572
|
+
* @version 224.0.0
|
|
63542
64573
|
*/
|
|
63543
64574
|
|
|
63544
64575
|
/**
|
|
@@ -63886,7 +64917,7 @@ class SocialMediaApi {
|
|
|
63886
64917
|
/**
|
|
63887
64918
|
* SocialMedia service.
|
|
63888
64919
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
63889
|
-
* @version
|
|
64920
|
+
* @version 224.0.0
|
|
63890
64921
|
*/
|
|
63891
64922
|
|
|
63892
64923
|
/**
|
|
@@ -64022,7 +65053,6 @@ class SocialMediaApi {
|
|
|
64022
65053
|
* @param {String} openId openId
|
|
64023
65054
|
* @param {Object} opts Optional parameters
|
|
64024
65055
|
* @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)
|
|
64025
|
-
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64026
65056
|
*/
|
|
64027
65057
|
deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64028
65058
|
opts = opts || {};
|
|
@@ -64423,7 +65453,6 @@ class SocialMediaApi {
|
|
|
64423
65453
|
* @param {String} openId openId
|
|
64424
65454
|
* @param {Object} opts Optional parameters
|
|
64425
65455
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
64426
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64427
65456
|
*/
|
|
64428
65457
|
getSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64429
65458
|
opts = opts || {};
|
|
@@ -64459,7 +65488,6 @@ class SocialMediaApi {
|
|
|
64459
65488
|
* @param {String} dataIngestionRuleVersion version
|
|
64460
65489
|
* @param {Object} opts Optional parameters
|
|
64461
65490
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
64462
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64463
65491
|
*/
|
|
64464
65492
|
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId, openId, dataIngestionRuleVersion, opts) {
|
|
64465
65493
|
opts = opts || {};
|
|
@@ -64500,7 +65528,6 @@ class SocialMediaApi {
|
|
|
64500
65528
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
64501
65529
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
64502
65530
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
64503
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64504
65531
|
*/
|
|
64505
65532
|
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId, openId, opts) {
|
|
64506
65533
|
opts = opts || {};
|
|
@@ -64734,7 +65761,6 @@ class SocialMediaApi {
|
|
|
64734
65761
|
* @param {String} openId openId
|
|
64735
65762
|
* @param {Object} opts Optional parameters
|
|
64736
65763
|
* @param {Object} opts.body
|
|
64737
|
-
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64738
65764
|
*/
|
|
64739
65765
|
patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64740
65766
|
opts = opts || {};
|
|
@@ -64934,7 +65960,6 @@ class SocialMediaApi {
|
|
|
64934
65960
|
* @param {String} topicId topicId
|
|
64935
65961
|
* @param {Object} opts Optional parameters
|
|
64936
65962
|
* @param {Object} opts.body
|
|
64937
|
-
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64938
65963
|
*/
|
|
64939
65964
|
postSocialmediaTopicDataingestionrulesOpen(topicId, opts) {
|
|
64940
65965
|
opts = opts || {};
|
|
@@ -64958,6 +65983,76 @@ class SocialMediaApi {
|
|
|
64958
65983
|
);
|
|
64959
65984
|
}
|
|
64960
65985
|
|
|
65986
|
+
/**
|
|
65987
|
+
* Ingest a list of Open Social Messages
|
|
65988
|
+
* 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.
|
|
65989
|
+
* @param {String} topicId Topic ID
|
|
65990
|
+
* @param {String} ruleId Data Ingestion Rule ID
|
|
65991
|
+
* @param {Array.<Object>} body NormalizedMessage
|
|
65992
|
+
*/
|
|
65993
|
+
postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk(topicId, ruleId, body) {
|
|
65994
|
+
// verify the required parameter 'topicId' is set
|
|
65995
|
+
if (topicId === undefined || topicId === null) {
|
|
65996
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
65997
|
+
}
|
|
65998
|
+
// verify the required parameter 'ruleId' is set
|
|
65999
|
+
if (ruleId === undefined || ruleId === null) {
|
|
66000
|
+
throw 'Missing the required parameter "ruleId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
66001
|
+
}
|
|
66002
|
+
// verify the required parameter 'body' is set
|
|
66003
|
+
if (body === undefined || body === null) {
|
|
66004
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
66005
|
+
}
|
|
66006
|
+
|
|
66007
|
+
return this.apiClient.callApi(
|
|
66008
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/messages/bulk',
|
|
66009
|
+
'POST',
|
|
66010
|
+
{ 'topicId': topicId,'ruleId': ruleId },
|
|
66011
|
+
{ },
|
|
66012
|
+
{ },
|
|
66013
|
+
{ },
|
|
66014
|
+
body,
|
|
66015
|
+
['PureCloud OAuth'],
|
|
66016
|
+
['application/json'],
|
|
66017
|
+
['application/json']
|
|
66018
|
+
);
|
|
66019
|
+
}
|
|
66020
|
+
|
|
66021
|
+
/**
|
|
66022
|
+
* Ingest a list of Open Social Reactions
|
|
66023
|
+
* 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.
|
|
66024
|
+
* @param {String} topicId Topic ID
|
|
66025
|
+
* @param {String} ruleId Data Ingestion Rule ID
|
|
66026
|
+
* @param {Object} body NormalizedEvent
|
|
66027
|
+
*/
|
|
66028
|
+
postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk(topicId, ruleId, body) {
|
|
66029
|
+
// verify the required parameter 'topicId' is set
|
|
66030
|
+
if (topicId === undefined || topicId === null) {
|
|
66031
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
66032
|
+
}
|
|
66033
|
+
// verify the required parameter 'ruleId' is set
|
|
66034
|
+
if (ruleId === undefined || ruleId === null) {
|
|
66035
|
+
throw 'Missing the required parameter "ruleId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
66036
|
+
}
|
|
66037
|
+
// verify the required parameter 'body' is set
|
|
66038
|
+
if (body === undefined || body === null) {
|
|
66039
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
66040
|
+
}
|
|
66041
|
+
|
|
66042
|
+
return this.apiClient.callApi(
|
|
66043
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/reactions/bulk',
|
|
66044
|
+
'POST',
|
|
66045
|
+
{ 'topicId': topicId,'ruleId': ruleId },
|
|
66046
|
+
{ },
|
|
66047
|
+
{ },
|
|
66048
|
+
{ },
|
|
66049
|
+
body,
|
|
66050
|
+
['PureCloud OAuth'],
|
|
66051
|
+
['application/json'],
|
|
66052
|
+
['application/json']
|
|
66053
|
+
);
|
|
66054
|
+
}
|
|
66055
|
+
|
|
64961
66056
|
/**
|
|
64962
66057
|
* Create an twitter data ingestion rule.
|
|
64963
66058
|
*
|
|
@@ -65106,7 +66201,6 @@ class SocialMediaApi {
|
|
|
65106
66201
|
* @param {String} openId openId
|
|
65107
66202
|
* @param {Object} opts Optional parameters
|
|
65108
66203
|
* @param {Object} opts.body
|
|
65109
|
-
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65110
66204
|
*/
|
|
65111
66205
|
putSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
65112
66206
|
opts = opts || {};
|
|
@@ -65174,7 +66268,7 @@ class SpeechTextAnalyticsApi {
|
|
|
65174
66268
|
/**
|
|
65175
66269
|
* SpeechTextAnalytics service.
|
|
65176
66270
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
65177
|
-
* @version
|
|
66271
|
+
* @version 224.0.0
|
|
65178
66272
|
*/
|
|
65179
66273
|
|
|
65180
66274
|
/**
|
|
@@ -66068,6 +67162,31 @@ class SpeechTextAnalyticsApi {
|
|
|
66068
67162
|
);
|
|
66069
67163
|
}
|
|
66070
67164
|
|
|
67165
|
+
/**
|
|
67166
|
+
* Get a Speech and Text Analytics test topics phrase job by id
|
|
67167
|
+
*
|
|
67168
|
+
* @param {String} jobId the id of the test topic phrase job
|
|
67169
|
+
*/
|
|
67170
|
+
getSpeechandtextanalyticsTopicsTestphraseJob(jobId) {
|
|
67171
|
+
// verify the required parameter 'jobId' is set
|
|
67172
|
+
if (jobId === undefined || jobId === null) {
|
|
67173
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsTopicsTestphraseJob';
|
|
67174
|
+
}
|
|
67175
|
+
|
|
67176
|
+
return this.apiClient.callApi(
|
|
67177
|
+
'/api/v2/speechandtextanalytics/topics/testphrase/jobs/{jobId}',
|
|
67178
|
+
'GET',
|
|
67179
|
+
{ 'jobId': jobId },
|
|
67180
|
+
{ },
|
|
67181
|
+
{ },
|
|
67182
|
+
{ },
|
|
67183
|
+
null,
|
|
67184
|
+
['PureCloud OAuth'],
|
|
67185
|
+
['application/json'],
|
|
67186
|
+
['application/json']
|
|
67187
|
+
);
|
|
67188
|
+
}
|
|
67189
|
+
|
|
66071
67190
|
/**
|
|
66072
67191
|
* Translate a single interaction recording (or an email conversation)
|
|
66073
67192
|
*
|
|
@@ -66348,6 +67467,31 @@ class SpeechTextAnalyticsApi {
|
|
|
66348
67467
|
);
|
|
66349
67468
|
}
|
|
66350
67469
|
|
|
67470
|
+
/**
|
|
67471
|
+
* Create new Speech and Text Analytics publish topics job
|
|
67472
|
+
*
|
|
67473
|
+
* @param {Object} body The publish test topic phrase job to create
|
|
67474
|
+
*/
|
|
67475
|
+
postSpeechandtextanalyticsTopicsTestphraseJobs(body) {
|
|
67476
|
+
// verify the required parameter 'body' is set
|
|
67477
|
+
if (body === undefined || body === null) {
|
|
67478
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsTopicsTestphraseJobs';
|
|
67479
|
+
}
|
|
67480
|
+
|
|
67481
|
+
return this.apiClient.callApi(
|
|
67482
|
+
'/api/v2/speechandtextanalytics/topics/testphrase/jobs',
|
|
67483
|
+
'POST',
|
|
67484
|
+
{ },
|
|
67485
|
+
{ },
|
|
67486
|
+
{ },
|
|
67487
|
+
{ },
|
|
67488
|
+
body,
|
|
67489
|
+
['PureCloud OAuth'],
|
|
67490
|
+
['application/json'],
|
|
67491
|
+
['application/json']
|
|
67492
|
+
);
|
|
67493
|
+
}
|
|
67494
|
+
|
|
66351
67495
|
/**
|
|
66352
67496
|
* Search resources.
|
|
66353
67497
|
*
|
|
@@ -66613,7 +67757,7 @@ class StationsApi {
|
|
|
66613
67757
|
/**
|
|
66614
67758
|
* Stations service.
|
|
66615
67759
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
66616
|
-
* @version
|
|
67760
|
+
* @version 224.0.0
|
|
66617
67761
|
*/
|
|
66618
67762
|
|
|
66619
67763
|
/**
|
|
@@ -66715,7 +67859,7 @@ class SuggestApi {
|
|
|
66715
67859
|
/**
|
|
66716
67860
|
* Suggest service.
|
|
66717
67861
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
66718
|
-
* @version
|
|
67862
|
+
* @version 224.0.0
|
|
66719
67863
|
*/
|
|
66720
67864
|
|
|
66721
67865
|
/**
|
|
@@ -66854,7 +67998,7 @@ class TaskManagementApi {
|
|
|
66854
67998
|
/**
|
|
66855
67999
|
* TaskManagement service.
|
|
66856
68000
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
66857
|
-
* @version
|
|
68001
|
+
* @version 224.0.0
|
|
66858
68002
|
*/
|
|
66859
68003
|
|
|
66860
68004
|
/**
|
|
@@ -69016,7 +70160,7 @@ class TeamsApi {
|
|
|
69016
70160
|
/**
|
|
69017
70161
|
* Teams service.
|
|
69018
70162
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
69019
|
-
* @version
|
|
70163
|
+
* @version 224.0.0
|
|
69020
70164
|
*/
|
|
69021
70165
|
|
|
69022
70166
|
/**
|
|
@@ -69155,7 +70299,7 @@ class TeamsApi {
|
|
|
69155
70299
|
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
69156
70300
|
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
69157
70301
|
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
69158
|
-
* @param {Object} opts.expand Expand the
|
|
70302
|
+
* @param {Object} opts.expand Expand the division on each team
|
|
69159
70303
|
*/
|
|
69160
70304
|
getTeams(opts) {
|
|
69161
70305
|
opts = opts || {};
|
|
@@ -69321,7 +70465,7 @@ class TelephonyApi {
|
|
|
69321
70465
|
/**
|
|
69322
70466
|
* Telephony service.
|
|
69323
70467
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
69324
|
-
* @version
|
|
70468
|
+
* @version 224.0.0
|
|
69325
70469
|
*/
|
|
69326
70470
|
|
|
69327
70471
|
/**
|
|
@@ -69503,7 +70647,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
69503
70647
|
/**
|
|
69504
70648
|
* TelephonyProvidersEdge service.
|
|
69505
70649
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
69506
|
-
* @version
|
|
70650
|
+
* @version 224.0.0
|
|
69507
70651
|
*/
|
|
69508
70652
|
|
|
69509
70653
|
/**
|
|
@@ -70707,7 +71851,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
70707
71851
|
|
|
70708
71852
|
/**
|
|
70709
71853
|
* Get a pageable list of basic extension pool objects filterable by query parameters.
|
|
70710
|
-
* This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch
|
|
71854
|
+
* 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.
|
|
70711
71855
|
* @param {Object} opts Optional parameters
|
|
70712
71856
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
70713
71857
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -72284,6 +73428,47 @@ class TelephonyProvidersEdgeApi {
|
|
|
72284
73428
|
);
|
|
72285
73429
|
}
|
|
72286
73430
|
|
|
73431
|
+
/**
|
|
73432
|
+
* Post media endpoint statistics event.
|
|
73433
|
+
*
|
|
73434
|
+
* @param {String} conversationId Identifier of the conversation
|
|
73435
|
+
* @param {String} communicationId Identifier of the media session
|
|
73436
|
+
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
73437
|
+
* @param {Object} body MediaStatisticsPostRequest
|
|
73438
|
+
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73439
|
+
*/
|
|
73440
|
+
postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId, communicationId, mediaResourceId, body) {
|
|
73441
|
+
// verify the required parameter 'conversationId' is set
|
|
73442
|
+
if (conversationId === undefined || conversationId === null) {
|
|
73443
|
+
throw 'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
73444
|
+
}
|
|
73445
|
+
// verify the required parameter 'communicationId' is set
|
|
73446
|
+
if (communicationId === undefined || communicationId === null) {
|
|
73447
|
+
throw 'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
73448
|
+
}
|
|
73449
|
+
// verify the required parameter 'mediaResourceId' is set
|
|
73450
|
+
if (mediaResourceId === undefined || mediaResourceId === null) {
|
|
73451
|
+
throw 'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
73452
|
+
}
|
|
73453
|
+
// verify the required parameter 'body' is set
|
|
73454
|
+
if (body === undefined || body === null) {
|
|
73455
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
73456
|
+
}
|
|
73457
|
+
|
|
73458
|
+
return this.apiClient.callApi(
|
|
73459
|
+
'/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}',
|
|
73460
|
+
'POST',
|
|
73461
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'mediaResourceId': mediaResourceId },
|
|
73462
|
+
{ },
|
|
73463
|
+
{ },
|
|
73464
|
+
{ },
|
|
73465
|
+
body,
|
|
73466
|
+
['PureCloud OAuth'],
|
|
73467
|
+
['application/json'],
|
|
73468
|
+
['application/json']
|
|
73469
|
+
);
|
|
73470
|
+
}
|
|
73471
|
+
|
|
72287
73472
|
/**
|
|
72288
73473
|
* Reboot a Phone
|
|
72289
73474
|
*
|
|
@@ -72955,7 +74140,7 @@ class TextbotsApi {
|
|
|
72955
74140
|
/**
|
|
72956
74141
|
* Textbots service.
|
|
72957
74142
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
72958
|
-
* @version
|
|
74143
|
+
* @version 224.0.0
|
|
72959
74144
|
*/
|
|
72960
74145
|
|
|
72961
74146
|
/**
|
|
@@ -73084,7 +74269,7 @@ class TokensApi {
|
|
|
73084
74269
|
/**
|
|
73085
74270
|
* Tokens service.
|
|
73086
74271
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
73087
|
-
* @version
|
|
74272
|
+
* @version 224.0.0
|
|
73088
74273
|
*/
|
|
73089
74274
|
|
|
73090
74275
|
/**
|
|
@@ -73238,7 +74423,7 @@ class UploadsApi {
|
|
|
73238
74423
|
/**
|
|
73239
74424
|
* Uploads service.
|
|
73240
74425
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
73241
|
-
* @version
|
|
74426
|
+
* @version 224.0.0
|
|
73242
74427
|
*/
|
|
73243
74428
|
|
|
73244
74429
|
/**
|
|
@@ -73529,7 +74714,7 @@ class UsageApi {
|
|
|
73529
74714
|
/**
|
|
73530
74715
|
* Usage service.
|
|
73531
74716
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
73532
|
-
* @version
|
|
74717
|
+
* @version 224.0.0
|
|
73533
74718
|
*/
|
|
73534
74719
|
|
|
73535
74720
|
/**
|
|
@@ -73744,7 +74929,7 @@ class UserRecordingsApi {
|
|
|
73744
74929
|
/**
|
|
73745
74930
|
* UserRecordings service.
|
|
73746
74931
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
73747
|
-
* @version
|
|
74932
|
+
* @version 224.0.0
|
|
73748
74933
|
*/
|
|
73749
74934
|
|
|
73750
74935
|
/**
|
|
@@ -73959,7 +75144,7 @@ class UsersApi {
|
|
|
73959
75144
|
/**
|
|
73960
75145
|
* Users service.
|
|
73961
75146
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
73962
|
-
* @version
|
|
75147
|
+
* @version 224.0.0
|
|
73963
75148
|
*/
|
|
73964
75149
|
|
|
73965
75150
|
/**
|
|
@@ -75548,6 +76733,36 @@ class UsersApi {
|
|
|
75548
76733
|
);
|
|
75549
76734
|
}
|
|
75550
76735
|
|
|
76736
|
+
/**
|
|
76737
|
+
* Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required
|
|
76738
|
+
*
|
|
76739
|
+
* @param {Object} opts Optional parameters
|
|
76740
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
76741
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
76742
|
+
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
76743
|
+
* @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.
|
|
76744
|
+
* @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.
|
|
76745
|
+
* @param {Object} opts.state Only list users of this state (default to active)
|
|
76746
|
+
* getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76747
|
+
*/
|
|
76748
|
+
getUsersQuery(opts) {
|
|
76749
|
+
opts = opts || {};
|
|
76750
|
+
|
|
76751
|
+
|
|
76752
|
+
return this.apiClient.callApi(
|
|
76753
|
+
'/api/v2/users/query',
|
|
76754
|
+
'GET',
|
|
76755
|
+
{ },
|
|
76756
|
+
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
76757
|
+
{ },
|
|
76758
|
+
{ },
|
|
76759
|
+
null,
|
|
76760
|
+
['PureCloud OAuth'],
|
|
76761
|
+
['application/json'],
|
|
76762
|
+
['application/json']
|
|
76763
|
+
);
|
|
76764
|
+
}
|
|
76765
|
+
|
|
75551
76766
|
/**
|
|
75552
76767
|
* Search users using the q64 value returned from a previous search
|
|
75553
76768
|
*
|
|
@@ -76912,7 +78127,7 @@ class UtilitiesApi {
|
|
|
76912
78127
|
/**
|
|
76913
78128
|
* Utilities service.
|
|
76914
78129
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
76915
|
-
* @version
|
|
78130
|
+
* @version 224.0.0
|
|
76916
78131
|
*/
|
|
76917
78132
|
|
|
76918
78133
|
/**
|
|
@@ -77023,7 +78238,7 @@ class VoicemailApi {
|
|
|
77023
78238
|
/**
|
|
77024
78239
|
* Voicemail service.
|
|
77025
78240
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
77026
|
-
* @version
|
|
78241
|
+
* @version 224.0.0
|
|
77027
78242
|
*/
|
|
77028
78243
|
|
|
77029
78244
|
/**
|
|
@@ -77279,7 +78494,7 @@ class VoicemailApi {
|
|
|
77279
78494
|
|
|
77280
78495
|
/**
|
|
77281
78496
|
* Get media playback URI for this voicemail message
|
|
77282
|
-
*
|
|
78497
|
+
* API should migrate to use GET api/v2/voicemail/messages/{messageId}/downloads
|
|
77283
78498
|
* @param {String} messageId Message ID
|
|
77284
78499
|
* @param {Object} opts Optional parameters
|
|
77285
78500
|
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
@@ -77745,7 +78960,7 @@ class WebChatApi {
|
|
|
77745
78960
|
/**
|
|
77746
78961
|
* WebChat service.
|
|
77747
78962
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
77748
|
-
* @version
|
|
78963
|
+
* @version 224.0.0
|
|
77749
78964
|
*/
|
|
77750
78965
|
|
|
77751
78966
|
/**
|
|
@@ -78305,7 +79520,7 @@ class WebDeploymentsApi {
|
|
|
78305
79520
|
/**
|
|
78306
79521
|
* WebDeployments service.
|
|
78307
79522
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
78308
|
-
* @version
|
|
79523
|
+
* @version 224.0.0
|
|
78309
79524
|
*/
|
|
78310
79525
|
|
|
78311
79526
|
/**
|
|
@@ -78887,7 +80102,7 @@ class WebMessagingApi {
|
|
|
78887
80102
|
/**
|
|
78888
80103
|
* WebMessaging service.
|
|
78889
80104
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
78890
|
-
* @version
|
|
80105
|
+
* @version 224.0.0
|
|
78891
80106
|
*/
|
|
78892
80107
|
|
|
78893
80108
|
/**
|
|
@@ -78933,7 +80148,7 @@ class WidgetsApi {
|
|
|
78933
80148
|
/**
|
|
78934
80149
|
* Widgets service.
|
|
78935
80150
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
78936
|
-
* @version
|
|
80151
|
+
* @version 224.0.0
|
|
78937
80152
|
*/
|
|
78938
80153
|
|
|
78939
80154
|
/**
|
|
@@ -79084,7 +80299,7 @@ class WorkforceManagementApi {
|
|
|
79084
80299
|
/**
|
|
79085
80300
|
* WorkforceManagement service.
|
|
79086
80301
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
79087
|
-
* @version
|
|
80302
|
+
* @version 224.0.0
|
|
79088
80303
|
*/
|
|
79089
80304
|
|
|
79090
80305
|
/**
|
|
@@ -80697,6 +81912,7 @@ class WorkforceManagementApi {
|
|
|
80697
81912
|
* @param {String} businessUnitId The ID of the business unit
|
|
80698
81913
|
* @param {Object} opts Optional parameters
|
|
80699
81914
|
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
81915
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
80700
81916
|
*/
|
|
80701
81917
|
getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
80702
81918
|
opts = opts || {};
|
|
@@ -80710,7 +81926,7 @@ class WorkforceManagementApi {
|
|
|
80710
81926
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
80711
81927
|
'GET',
|
|
80712
81928
|
{ 'businessUnitId': businessUnitId },
|
|
80713
|
-
{ 'managementUnitId': opts['managementUnitId'] },
|
|
81929
|
+
{ 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
|
|
80714
81930
|
{ },
|
|
80715
81931
|
{ },
|
|
80716
81932
|
null,
|
|
@@ -82806,16 +84022,17 @@ class WorkforceManagementApi {
|
|
|
82806
84022
|
* Update my alternative shifts trade by trade ID
|
|
82807
84023
|
*
|
|
82808
84024
|
* @param {String} tradeId The ID of the alternative shift trade
|
|
82809
|
-
* @param {Object}
|
|
82810
|
-
* @param {Object} opts.body body
|
|
84025
|
+
* @param {Object} body body
|
|
82811
84026
|
*/
|
|
82812
|
-
patchWorkforcemanagementAlternativeshiftsTrade(tradeId,
|
|
82813
|
-
opts = opts || {};
|
|
82814
|
-
|
|
84027
|
+
patchWorkforcemanagementAlternativeshiftsTrade(tradeId, body) {
|
|
82815
84028
|
// verify the required parameter 'tradeId' is set
|
|
82816
84029
|
if (tradeId === undefined || tradeId === null) {
|
|
82817
84030
|
throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
|
|
82818
84031
|
}
|
|
84032
|
+
// verify the required parameter 'body' is set
|
|
84033
|
+
if (body === undefined || body === null) {
|
|
84034
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTrade';
|
|
84035
|
+
}
|
|
82819
84036
|
|
|
82820
84037
|
return this.apiClient.callApi(
|
|
82821
84038
|
'/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
|
|
@@ -82824,7 +84041,7 @@ class WorkforceManagementApi {
|
|
|
82824
84041
|
{ },
|
|
82825
84042
|
{ },
|
|
82826
84043
|
{ },
|
|
82827
|
-
|
|
84044
|
+
body,
|
|
82828
84045
|
['PureCloud OAuth'],
|
|
82829
84046
|
['application/json'],
|
|
82830
84047
|
['application/json']
|
|
@@ -82860,16 +84077,17 @@ class WorkforceManagementApi {
|
|
|
82860
84077
|
* Update business unit
|
|
82861
84078
|
*
|
|
82862
84079
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
82863
|
-
* @param {Object}
|
|
82864
|
-
* @param {Object} opts.body body
|
|
84080
|
+
* @param {Object} body body
|
|
82865
84081
|
*/
|
|
82866
|
-
patchWorkforcemanagementBusinessunit(businessUnitId,
|
|
82867
|
-
opts = opts || {};
|
|
82868
|
-
|
|
84082
|
+
patchWorkforcemanagementBusinessunit(businessUnitId, body) {
|
|
82869
84083
|
// verify the required parameter 'businessUnitId' is set
|
|
82870
84084
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82871
84085
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunit';
|
|
82872
84086
|
}
|
|
84087
|
+
// verify the required parameter 'body' is set
|
|
84088
|
+
if (body === undefined || body === null) {
|
|
84089
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunit';
|
|
84090
|
+
}
|
|
82873
84091
|
|
|
82874
84092
|
return this.apiClient.callApi(
|
|
82875
84093
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
@@ -82878,7 +84096,7 @@ class WorkforceManagementApi {
|
|
|
82878
84096
|
{ },
|
|
82879
84097
|
{ },
|
|
82880
84098
|
{ },
|
|
82881
|
-
|
|
84099
|
+
body,
|
|
82882
84100
|
['PureCloud OAuth'],
|
|
82883
84101
|
['application/json'],
|
|
82884
84102
|
['application/json']
|
|
@@ -82890,12 +84108,9 @@ class WorkforceManagementApi {
|
|
|
82890
84108
|
*
|
|
82891
84109
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
82892
84110
|
* @param {String} activityCodeId The ID of the activity code to update
|
|
82893
|
-
* @param {Object}
|
|
82894
|
-
* @param {Object} opts.body body
|
|
84111
|
+
* @param {Object} body body
|
|
82895
84112
|
*/
|
|
82896
|
-
patchWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId,
|
|
82897
|
-
opts = opts || {};
|
|
82898
|
-
|
|
84113
|
+
patchWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId, body) {
|
|
82899
84114
|
// verify the required parameter 'businessUnitId' is set
|
|
82900
84115
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82901
84116
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
@@ -82904,6 +84119,10 @@ class WorkforceManagementApi {
|
|
|
82904
84119
|
if (activityCodeId === undefined || activityCodeId === null) {
|
|
82905
84120
|
throw 'Missing the required parameter "activityCodeId" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
82906
84121
|
}
|
|
84122
|
+
// verify the required parameter 'body' is set
|
|
84123
|
+
if (body === undefined || body === null) {
|
|
84124
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
84125
|
+
}
|
|
82907
84126
|
|
|
82908
84127
|
return this.apiClient.callApi(
|
|
82909
84128
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}',
|
|
@@ -82912,7 +84131,7 @@ class WorkforceManagementApi {
|
|
|
82912
84131
|
{ },
|
|
82913
84132
|
{ },
|
|
82914
84133
|
{ },
|
|
82915
|
-
|
|
84134
|
+
body,
|
|
82916
84135
|
['PureCloud OAuth'],
|
|
82917
84136
|
['application/json'],
|
|
82918
84137
|
['application/json']
|
|
@@ -82958,16 +84177,17 @@ class WorkforceManagementApi {
|
|
|
82958
84177
|
* Update alternative shifts settings for a business unit
|
|
82959
84178
|
*
|
|
82960
84179
|
* @param {String} businessUnitId The ID of the business unit
|
|
82961
|
-
* @param {Object}
|
|
82962
|
-
* @param {Object} opts.body body
|
|
84180
|
+
* @param {Object} body body
|
|
82963
84181
|
*/
|
|
82964
|
-
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId,
|
|
82965
|
-
opts = opts || {};
|
|
82966
|
-
|
|
84182
|
+
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, body) {
|
|
82967
84183
|
// verify the required parameter 'businessUnitId' is set
|
|
82968
84184
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82969
84185
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
82970
84186
|
}
|
|
84187
|
+
// verify the required parameter 'body' is set
|
|
84188
|
+
if (body === undefined || body === null) {
|
|
84189
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
84190
|
+
}
|
|
82971
84191
|
|
|
82972
84192
|
return this.apiClient.callApi(
|
|
82973
84193
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
|
|
@@ -82976,7 +84196,7 @@ class WorkforceManagementApi {
|
|
|
82976
84196
|
{ },
|
|
82977
84197
|
{ },
|
|
82978
84198
|
{ },
|
|
82979
|
-
|
|
84199
|
+
body,
|
|
82980
84200
|
['PureCloud OAuth'],
|
|
82981
84201
|
['application/json'],
|
|
82982
84202
|
['application/json']
|
|
@@ -82988,12 +84208,9 @@ class WorkforceManagementApi {
|
|
|
82988
84208
|
*
|
|
82989
84209
|
* @param {String} businessUnitId The ID of the business unit.
|
|
82990
84210
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
82991
|
-
* @param {Object}
|
|
82992
|
-
* @param {Object} opts.body body
|
|
84211
|
+
* @param {Object} body body
|
|
82993
84212
|
*/
|
|
82994
|
-
patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId,
|
|
82995
|
-
opts = opts || {};
|
|
82996
|
-
|
|
84213
|
+
patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId, body) {
|
|
82997
84214
|
// verify the required parameter 'businessUnitId' is set
|
|
82998
84215
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82999
84216
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
@@ -83002,6 +84219,10 @@ class WorkforceManagementApi {
|
|
|
83002
84219
|
if (planningGroupId === undefined || planningGroupId === null) {
|
|
83003
84220
|
throw 'Missing the required parameter "planningGroupId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
83004
84221
|
}
|
|
84222
|
+
// verify the required parameter 'body' is set
|
|
84223
|
+
if (body === undefined || body === null) {
|
|
84224
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
84225
|
+
}
|
|
83005
84226
|
|
|
83006
84227
|
return this.apiClient.callApi(
|
|
83007
84228
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}',
|
|
@@ -83010,7 +84231,7 @@ class WorkforceManagementApi {
|
|
|
83010
84231
|
{ },
|
|
83011
84232
|
{ },
|
|
83012
84233
|
{ },
|
|
83013
|
-
|
|
84234
|
+
body,
|
|
83014
84235
|
['PureCloud OAuth'],
|
|
83015
84236
|
['application/json'],
|
|
83016
84237
|
['application/json']
|
|
@@ -83022,12 +84243,9 @@ class WorkforceManagementApi {
|
|
|
83022
84243
|
*
|
|
83023
84244
|
* @param {String} businessUnitId The ID of the business unit
|
|
83024
84245
|
* @param {String} runId The ID of the schedule run
|
|
83025
|
-
* @param {Object}
|
|
83026
|
-
* @param {Object} opts.body body
|
|
84246
|
+
* @param {Object} body body
|
|
83027
84247
|
*/
|
|
83028
|
-
patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId,
|
|
83029
|
-
opts = opts || {};
|
|
83030
|
-
|
|
84248
|
+
patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId, body) {
|
|
83031
84249
|
// verify the required parameter 'businessUnitId' is set
|
|
83032
84250
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83033
84251
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
@@ -83036,6 +84254,10 @@ class WorkforceManagementApi {
|
|
|
83036
84254
|
if (runId === undefined || runId === null) {
|
|
83037
84255
|
throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
83038
84256
|
}
|
|
84257
|
+
// verify the required parameter 'body' is set
|
|
84258
|
+
if (body === undefined || body === null) {
|
|
84259
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
84260
|
+
}
|
|
83039
84261
|
|
|
83040
84262
|
return this.apiClient.callApi(
|
|
83041
84263
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}',
|
|
@@ -83044,7 +84266,7 @@ class WorkforceManagementApi {
|
|
|
83044
84266
|
{ },
|
|
83045
84267
|
{ },
|
|
83046
84268
|
{ },
|
|
83047
|
-
|
|
84269
|
+
body,
|
|
83048
84270
|
['PureCloud OAuth'],
|
|
83049
84271
|
['application/json'],
|
|
83050
84272
|
['application/json']
|
|
@@ -83056,12 +84278,9 @@ class WorkforceManagementApi {
|
|
|
83056
84278
|
*
|
|
83057
84279
|
* @param {String} businessUnitId The ID of the business unit.
|
|
83058
84280
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to update
|
|
83059
|
-
* @param {Object}
|
|
83060
|
-
* @param {Object} opts.body body
|
|
84281
|
+
* @param {Object} body body
|
|
83061
84282
|
*/
|
|
83062
|
-
patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId,
|
|
83063
|
-
opts = opts || {};
|
|
83064
|
-
|
|
84283
|
+
patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, body) {
|
|
83065
84284
|
// verify the required parameter 'businessUnitId' is set
|
|
83066
84285
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83067
84286
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -83070,6 +84289,10 @@ class WorkforceManagementApi {
|
|
|
83070
84289
|
if (serviceGoalTemplateId === undefined || serviceGoalTemplateId === null) {
|
|
83071
84290
|
throw 'Missing the required parameter "serviceGoalTemplateId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
83072
84291
|
}
|
|
84292
|
+
// verify the required parameter 'body' is set
|
|
84293
|
+
if (body === undefined || body === null) {
|
|
84294
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
84295
|
+
}
|
|
83073
84296
|
|
|
83074
84297
|
return this.apiClient.callApi(
|
|
83075
84298
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
@@ -83078,7 +84301,7 @@ class WorkforceManagementApi {
|
|
|
83078
84301
|
{ },
|
|
83079
84302
|
{ },
|
|
83080
84303
|
{ },
|
|
83081
|
-
|
|
84304
|
+
body,
|
|
83082
84305
|
['PureCloud OAuth'],
|
|
83083
84306
|
['application/json'],
|
|
83084
84307
|
['application/json']
|
|
@@ -83090,12 +84313,9 @@ class WorkforceManagementApi {
|
|
|
83090
84313
|
*
|
|
83091
84314
|
* @param {String} businessUnitId The ID of the business unit
|
|
83092
84315
|
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
83093
|
-
* @param {Object}
|
|
83094
|
-
* @param {Object} opts.body body
|
|
84316
|
+
* @param {Object} body body
|
|
83095
84317
|
*/
|
|
83096
|
-
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId,
|
|
83097
|
-
opts = opts || {};
|
|
83098
|
-
|
|
84318
|
+
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, body) {
|
|
83099
84319
|
// verify the required parameter 'businessUnitId' is set
|
|
83100
84320
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83101
84321
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
@@ -83104,6 +84324,10 @@ class WorkforceManagementApi {
|
|
|
83104
84324
|
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
83105
84325
|
throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
83106
84326
|
}
|
|
84327
|
+
// verify the required parameter 'body' is set
|
|
84328
|
+
if (body === undefined || body === null) {
|
|
84329
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
84330
|
+
}
|
|
83107
84331
|
|
|
83108
84332
|
return this.apiClient.callApi(
|
|
83109
84333
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
@@ -83112,7 +84336,7 @@ class WorkforceManagementApi {
|
|
|
83112
84336
|
{ },
|
|
83113
84337
|
{ },
|
|
83114
84338
|
{ },
|
|
83115
|
-
|
|
84339
|
+
body,
|
|
83116
84340
|
['PureCloud OAuth'],
|
|
83117
84341
|
['application/json'],
|
|
83118
84342
|
['application/json']
|
|
@@ -83124,12 +84348,9 @@ class WorkforceManagementApi {
|
|
|
83124
84348
|
*
|
|
83125
84349
|
* @param {String} businessUnitId The ID of the business unit
|
|
83126
84350
|
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
83127
|
-
* @param {Object}
|
|
83128
|
-
* @param {Object} opts.body body
|
|
84351
|
+
* @param {Object} body body
|
|
83129
84352
|
*/
|
|
83130
|
-
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId,
|
|
83131
|
-
opts = opts || {};
|
|
83132
|
-
|
|
84353
|
+
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, body) {
|
|
83133
84354
|
// verify the required parameter 'businessUnitId' is set
|
|
83134
84355
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83135
84356
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
@@ -83138,6 +84359,10 @@ class WorkforceManagementApi {
|
|
|
83138
84359
|
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
83139
84360
|
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
83140
84361
|
}
|
|
84362
|
+
// verify the required parameter 'body' is set
|
|
84363
|
+
if (body === undefined || body === null) {
|
|
84364
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
84365
|
+
}
|
|
83141
84366
|
|
|
83142
84367
|
return this.apiClient.callApi(
|
|
83143
84368
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
@@ -83146,7 +84371,7 @@ class WorkforceManagementApi {
|
|
|
83146
84371
|
{ },
|
|
83147
84372
|
{ },
|
|
83148
84373
|
{ },
|
|
83149
|
-
|
|
84374
|
+
body,
|
|
83150
84375
|
['PureCloud OAuth'],
|
|
83151
84376
|
['application/json'],
|
|
83152
84377
|
['application/json']
|
|
@@ -83194,12 +84419,9 @@ class WorkforceManagementApi {
|
|
|
83194
84419
|
* @param {String} businessUnitId The ID of the business unit
|
|
83195
84420
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
83196
84421
|
* @param {String} bidGroupId Work Plan Bid Group id
|
|
83197
|
-
* @param {Object}
|
|
83198
|
-
* @param {Object} opts.body body
|
|
84422
|
+
* @param {Object} body body
|
|
83199
84423
|
*/
|
|
83200
|
-
patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId,
|
|
83201
|
-
opts = opts || {};
|
|
83202
|
-
|
|
84424
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, body) {
|
|
83203
84425
|
// verify the required parameter 'businessUnitId' is set
|
|
83204
84426
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83205
84427
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
@@ -83212,6 +84434,10 @@ class WorkforceManagementApi {
|
|
|
83212
84434
|
if (bidGroupId === undefined || bidGroupId === null) {
|
|
83213
84435
|
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
83214
84436
|
}
|
|
84437
|
+
// verify the required parameter 'body' is set
|
|
84438
|
+
if (body === undefined || body === null) {
|
|
84439
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
84440
|
+
}
|
|
83215
84441
|
|
|
83216
84442
|
return this.apiClient.callApi(
|
|
83217
84443
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
@@ -83220,7 +84446,7 @@ class WorkforceManagementApi {
|
|
|
83220
84446
|
{ },
|
|
83221
84447
|
{ },
|
|
83222
84448
|
{ },
|
|
83223
|
-
|
|
84449
|
+
body,
|
|
83224
84450
|
['PureCloud OAuth'],
|
|
83225
84451
|
['application/json'],
|
|
83226
84452
|
['application/json']
|
|
@@ -83233,12 +84459,9 @@ class WorkforceManagementApi {
|
|
|
83233
84459
|
* @param {String} businessUnitId The ID of the business unit
|
|
83234
84460
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
83235
84461
|
* @param {String} bidGroupId The ID of the work plan bid group
|
|
83236
|
-
* @param {Object}
|
|
83237
|
-
* @param {Object} opts.body body
|
|
84462
|
+
* @param {Object} body body
|
|
83238
84463
|
*/
|
|
83239
|
-
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId,
|
|
83240
|
-
opts = opts || {};
|
|
83241
|
-
|
|
84464
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, body) {
|
|
83242
84465
|
// verify the required parameter 'businessUnitId' is set
|
|
83243
84466
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83244
84467
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
@@ -83251,6 +84474,10 @@ class WorkforceManagementApi {
|
|
|
83251
84474
|
if (bidGroupId === undefined || bidGroupId === null) {
|
|
83252
84475
|
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
83253
84476
|
}
|
|
84477
|
+
// verify the required parameter 'body' is set
|
|
84478
|
+
if (body === undefined || body === null) {
|
|
84479
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
84480
|
+
}
|
|
83254
84481
|
|
|
83255
84482
|
return this.apiClient.callApi(
|
|
83256
84483
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
|
|
@@ -83259,7 +84486,7 @@ class WorkforceManagementApi {
|
|
|
83259
84486
|
{ },
|
|
83260
84487
|
{ },
|
|
83261
84488
|
{ },
|
|
83262
|
-
|
|
84489
|
+
body,
|
|
83263
84490
|
['PureCloud OAuth'],
|
|
83264
84491
|
['application/json'],
|
|
83265
84492
|
['application/json']
|
|
@@ -83270,16 +84497,17 @@ class WorkforceManagementApi {
|
|
|
83270
84497
|
* Update the requested management unit
|
|
83271
84498
|
*
|
|
83272
84499
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83273
|
-
* @param {Object}
|
|
83274
|
-
* @param {Object} opts.body body
|
|
84500
|
+
* @param {Object} body body
|
|
83275
84501
|
*/
|
|
83276
|
-
patchWorkforcemanagementManagementunit(managementUnitId,
|
|
83277
|
-
opts = opts || {};
|
|
83278
|
-
|
|
84502
|
+
patchWorkforcemanagementManagementunit(managementUnitId, body) {
|
|
83279
84503
|
// verify the required parameter 'managementUnitId' is set
|
|
83280
84504
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83281
84505
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunit';
|
|
83282
84506
|
}
|
|
84507
|
+
// verify the required parameter 'body' is set
|
|
84508
|
+
if (body === undefined || body === null) {
|
|
84509
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunit';
|
|
84510
|
+
}
|
|
83283
84511
|
|
|
83284
84512
|
return this.apiClient.callApi(
|
|
83285
84513
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}',
|
|
@@ -83288,7 +84516,7 @@ class WorkforceManagementApi {
|
|
|
83288
84516
|
{ },
|
|
83289
84517
|
{ },
|
|
83290
84518
|
{ },
|
|
83291
|
-
|
|
84519
|
+
body,
|
|
83292
84520
|
['PureCloud OAuth'],
|
|
83293
84521
|
['application/json'],
|
|
83294
84522
|
['application/json']
|
|
@@ -83299,16 +84527,17 @@ class WorkforceManagementApi {
|
|
|
83299
84527
|
* Update agent configurations
|
|
83300
84528
|
*
|
|
83301
84529
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83302
|
-
* @param {Object}
|
|
83303
|
-
* @param {Object} opts.body body
|
|
84530
|
+
* @param {Object} body body
|
|
83304
84531
|
*/
|
|
83305
|
-
patchWorkforcemanagementManagementunitAgents(managementUnitId,
|
|
83306
|
-
opts = opts || {};
|
|
83307
|
-
|
|
84532
|
+
patchWorkforcemanagementManagementunitAgents(managementUnitId, body) {
|
|
83308
84533
|
// verify the required parameter 'managementUnitId' is set
|
|
83309
84534
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83310
84535
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
|
|
83311
84536
|
}
|
|
84537
|
+
// verify the required parameter 'body' is set
|
|
84538
|
+
if (body === undefined || body === null) {
|
|
84539
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitAgents';
|
|
84540
|
+
}
|
|
83312
84541
|
|
|
83313
84542
|
return this.apiClient.callApi(
|
|
83314
84543
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
|
|
@@ -83317,7 +84546,7 @@ class WorkforceManagementApi {
|
|
|
83317
84546
|
{ },
|
|
83318
84547
|
{ },
|
|
83319
84548
|
{ },
|
|
83320
|
-
|
|
84549
|
+
body,
|
|
83321
84550
|
['PureCloud OAuth'],
|
|
83322
84551
|
['application/json'],
|
|
83323
84552
|
['application/json']
|
|
@@ -83328,16 +84557,17 @@ class WorkforceManagementApi {
|
|
|
83328
84557
|
* Updates agent work plan configuration
|
|
83329
84558
|
*
|
|
83330
84559
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83331
|
-
* @param {Object}
|
|
83332
|
-
* @param {Object} opts.body body
|
|
84560
|
+
* @param {Object} body body
|
|
83333
84561
|
*/
|
|
83334
|
-
patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId,
|
|
83335
|
-
opts = opts || {};
|
|
83336
|
-
|
|
84562
|
+
patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId, body) {
|
|
83337
84563
|
// verify the required parameter 'managementUnitId' is set
|
|
83338
84564
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83339
84565
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';
|
|
83340
84566
|
}
|
|
84567
|
+
// verify the required parameter 'body' is set
|
|
84568
|
+
if (body === undefined || body === null) {
|
|
84569
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';
|
|
84570
|
+
}
|
|
83341
84571
|
|
|
83342
84572
|
return this.apiClient.callApi(
|
|
83343
84573
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk',
|
|
@@ -83346,7 +84576,7 @@ class WorkforceManagementApi {
|
|
|
83346
84576
|
{ },
|
|
83347
84577
|
{ },
|
|
83348
84578
|
{ },
|
|
83349
|
-
|
|
84579
|
+
body,
|
|
83350
84580
|
['PureCloud OAuth'],
|
|
83351
84581
|
['application/json'],
|
|
83352
84582
|
['application/json']
|
|
@@ -83358,12 +84588,9 @@ class WorkforceManagementApi {
|
|
|
83358
84588
|
* Updates time off limit object properties, but not daily values.
|
|
83359
84589
|
* @param {String} managementUnitId The ID of the management unit.
|
|
83360
84590
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
83361
|
-
* @param {Object}
|
|
83362
|
-
* @param {Object} opts.body body
|
|
84591
|
+
* @param {Object} body body
|
|
83363
84592
|
*/
|
|
83364
|
-
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId,
|
|
83365
|
-
opts = opts || {};
|
|
83366
|
-
|
|
84593
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, body) {
|
|
83367
84594
|
// verify the required parameter 'managementUnitId' is set
|
|
83368
84595
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83369
84596
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
@@ -83372,6 +84599,10 @@ class WorkforceManagementApi {
|
|
|
83372
84599
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
83373
84600
|
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
83374
84601
|
}
|
|
84602
|
+
// verify the required parameter 'body' is set
|
|
84603
|
+
if (body === undefined || body === null) {
|
|
84604
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
84605
|
+
}
|
|
83375
84606
|
|
|
83376
84607
|
return this.apiClient.callApi(
|
|
83377
84608
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
@@ -83380,7 +84611,7 @@ class WorkforceManagementApi {
|
|
|
83380
84611
|
{ },
|
|
83381
84612
|
{ },
|
|
83382
84613
|
{ },
|
|
83383
|
-
|
|
84614
|
+
body,
|
|
83384
84615
|
['PureCloud OAuth'],
|
|
83385
84616
|
['application/json'],
|
|
83386
84617
|
['application/json']
|
|
@@ -83392,12 +84623,9 @@ class WorkforceManagementApi {
|
|
|
83392
84623
|
*
|
|
83393
84624
|
* @param {String} managementUnitId The ID of the management unit
|
|
83394
84625
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
83395
|
-
* @param {Object}
|
|
83396
|
-
* @param {Object} opts.body body
|
|
84626
|
+
* @param {Object} body body
|
|
83397
84627
|
*/
|
|
83398
|
-
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId,
|
|
83399
|
-
opts = opts || {};
|
|
83400
|
-
|
|
84628
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, body) {
|
|
83401
84629
|
// verify the required parameter 'managementUnitId' is set
|
|
83402
84630
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83403
84631
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
@@ -83406,6 +84634,10 @@ class WorkforceManagementApi {
|
|
|
83406
84634
|
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
83407
84635
|
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
83408
84636
|
}
|
|
84637
|
+
// verify the required parameter 'body' is set
|
|
84638
|
+
if (body === undefined || body === null) {
|
|
84639
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
84640
|
+
}
|
|
83409
84641
|
|
|
83410
84642
|
return this.apiClient.callApi(
|
|
83411
84643
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
@@ -83414,7 +84646,7 @@ class WorkforceManagementApi {
|
|
|
83414
84646
|
{ },
|
|
83415
84647
|
{ },
|
|
83416
84648
|
{ },
|
|
83417
|
-
|
|
84649
|
+
body,
|
|
83418
84650
|
['PureCloud OAuth'],
|
|
83419
84651
|
['application/json'],
|
|
83420
84652
|
['application/json']
|
|
@@ -83427,12 +84659,9 @@ class WorkforceManagementApi {
|
|
|
83427
84659
|
* @param {String} managementUnitId The ID of the management unit.
|
|
83428
84660
|
* @param {String} timeOffRequestId The ID of the time off request.
|
|
83429
84661
|
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
83430
|
-
* @param {Object}
|
|
83431
|
-
* @param {Object} opts.body body
|
|
84662
|
+
* @param {Object} body body
|
|
83432
84663
|
*/
|
|
83433
|
-
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId,
|
|
83434
|
-
opts = opts || {};
|
|
83435
|
-
|
|
84664
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, body) {
|
|
83436
84665
|
// verify the required parameter 'managementUnitId' is set
|
|
83437
84666
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83438
84667
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
@@ -83445,6 +84674,10 @@ class WorkforceManagementApi {
|
|
|
83445
84674
|
if (userId === undefined || userId === null) {
|
|
83446
84675
|
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
83447
84676
|
}
|
|
84677
|
+
// verify the required parameter 'body' is set
|
|
84678
|
+
if (body === undefined || body === null) {
|
|
84679
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
84680
|
+
}
|
|
83448
84681
|
|
|
83449
84682
|
return this.apiClient.callApi(
|
|
83450
84683
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
@@ -83453,7 +84686,7 @@ class WorkforceManagementApi {
|
|
|
83453
84686
|
{ },
|
|
83454
84687
|
{ },
|
|
83455
84688
|
{ },
|
|
83456
|
-
|
|
84689
|
+
body,
|
|
83457
84690
|
['PureCloud OAuth'],
|
|
83458
84691
|
['application/json'],
|
|
83459
84692
|
['application/json']
|
|
@@ -83466,12 +84699,9 @@ class WorkforceManagementApi {
|
|
|
83466
84699
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83467
84700
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
83468
84701
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
83469
|
-
* @param {Object}
|
|
83470
|
-
* @param {Object} opts.body body
|
|
84702
|
+
* @param {Object} body body
|
|
83471
84703
|
*/
|
|
83472
|
-
patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId,
|
|
83473
|
-
opts = opts || {};
|
|
83474
|
-
|
|
84704
|
+
patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId, body) {
|
|
83475
84705
|
// verify the required parameter 'managementUnitId' is set
|
|
83476
84706
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83477
84707
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
@@ -83484,6 +84714,10 @@ class WorkforceManagementApi {
|
|
|
83484
84714
|
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
83485
84715
|
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
83486
84716
|
}
|
|
84717
|
+
// verify the required parameter 'body' is set
|
|
84718
|
+
if (body === undefined || body === null) {
|
|
84719
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
84720
|
+
}
|
|
83487
84721
|
|
|
83488
84722
|
return this.apiClient.callApi(
|
|
83489
84723
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}',
|
|
@@ -83492,7 +84726,7 @@ class WorkforceManagementApi {
|
|
|
83492
84726
|
{ },
|
|
83493
84727
|
{ },
|
|
83494
84728
|
{ },
|
|
83495
|
-
|
|
84729
|
+
body,
|
|
83496
84730
|
['PureCloud OAuth'],
|
|
83497
84731
|
['application/json'],
|
|
83498
84732
|
['application/json']
|
|
@@ -83544,11 +84778,11 @@ class WorkforceManagementApi {
|
|
|
83544
84778
|
*
|
|
83545
84779
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83546
84780
|
* @param {String} workPlanId The ID of the work plan to update
|
|
84781
|
+
* @param {Object} body body
|
|
83547
84782
|
* @param {Object} opts Optional parameters
|
|
83548
84783
|
* @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
|
|
83549
|
-
* @param {Object} opts.body body
|
|
83550
84784
|
*/
|
|
83551
|
-
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
|
|
84785
|
+
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, body, opts) {
|
|
83552
84786
|
opts = opts || {};
|
|
83553
84787
|
|
|
83554
84788
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -83559,6 +84793,10 @@ class WorkforceManagementApi {
|
|
|
83559
84793
|
if (workPlanId === undefined || workPlanId === null) {
|
|
83560
84794
|
throw 'Missing the required parameter "workPlanId" when calling patchWorkforcemanagementManagementunitWorkplan';
|
|
83561
84795
|
}
|
|
84796
|
+
// verify the required parameter 'body' is set
|
|
84797
|
+
if (body === undefined || body === null) {
|
|
84798
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWorkplan';
|
|
84799
|
+
}
|
|
83562
84800
|
|
|
83563
84801
|
return this.apiClient.callApi(
|
|
83564
84802
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
@@ -83567,7 +84805,7 @@ class WorkforceManagementApi {
|
|
|
83567
84805
|
{ 'validationMode': opts['validationMode'] },
|
|
83568
84806
|
{ },
|
|
83569
84807
|
{ },
|
|
83570
|
-
|
|
84808
|
+
body,
|
|
83571
84809
|
['PureCloud OAuth'],
|
|
83572
84810
|
['application/json'],
|
|
83573
84811
|
['application/json']
|
|
@@ -83579,12 +84817,9 @@ class WorkforceManagementApi {
|
|
|
83579
84817
|
*
|
|
83580
84818
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83581
84819
|
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
83582
|
-
* @param {Object}
|
|
83583
|
-
* @param {Object} opts.body body
|
|
84820
|
+
* @param {Object} body body
|
|
83584
84821
|
*/
|
|
83585
|
-
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId,
|
|
83586
|
-
opts = opts || {};
|
|
83587
|
-
|
|
84822
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, body) {
|
|
83588
84823
|
// verify the required parameter 'managementUnitId' is set
|
|
83589
84824
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83590
84825
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
@@ -83593,6 +84828,10 @@ class WorkforceManagementApi {
|
|
|
83593
84828
|
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
83594
84829
|
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
83595
84830
|
}
|
|
84831
|
+
// verify the required parameter 'body' is set
|
|
84832
|
+
if (body === undefined || body === null) {
|
|
84833
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
84834
|
+
}
|
|
83596
84835
|
|
|
83597
84836
|
return this.apiClient.callApi(
|
|
83598
84837
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
@@ -83601,7 +84840,7 @@ class WorkforceManagementApi {
|
|
|
83601
84840
|
{ },
|
|
83602
84841
|
{ },
|
|
83603
84842
|
{ },
|
|
83604
|
-
|
|
84843
|
+
body,
|
|
83605
84844
|
['PureCloud OAuth'],
|
|
83606
84845
|
['application/json'],
|
|
83607
84846
|
['application/json']
|
|
@@ -83612,16 +84851,17 @@ class WorkforceManagementApi {
|
|
|
83612
84851
|
* Update a time off request for the current user
|
|
83613
84852
|
*
|
|
83614
84853
|
* @param {String} timeOffRequestId The ID of the time off request
|
|
83615
|
-
* @param {Object}
|
|
83616
|
-
* @param {Object} opts.body body
|
|
84854
|
+
* @param {Object} body body
|
|
83617
84855
|
*/
|
|
83618
|
-
patchWorkforcemanagementTimeoffrequest(timeOffRequestId,
|
|
83619
|
-
opts = opts || {};
|
|
83620
|
-
|
|
84856
|
+
patchWorkforcemanagementTimeoffrequest(timeOffRequestId, body) {
|
|
83621
84857
|
// verify the required parameter 'timeOffRequestId' is set
|
|
83622
84858
|
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
83623
84859
|
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementTimeoffrequest';
|
|
83624
84860
|
}
|
|
84861
|
+
// verify the required parameter 'body' is set
|
|
84862
|
+
if (body === undefined || body === null) {
|
|
84863
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementTimeoffrequest';
|
|
84864
|
+
}
|
|
83625
84865
|
|
|
83626
84866
|
return this.apiClient.callApi(
|
|
83627
84867
|
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}',
|
|
@@ -83630,7 +84870,7 @@ class WorkforceManagementApi {
|
|
|
83630
84870
|
{ },
|
|
83631
84871
|
{ },
|
|
83632
84872
|
{ },
|
|
83633
|
-
|
|
84873
|
+
body,
|
|
83634
84874
|
['PureCloud OAuth'],
|
|
83635
84875
|
['application/json'],
|
|
83636
84876
|
['application/json']
|
|
@@ -83641,16 +84881,17 @@ class WorkforceManagementApi {
|
|
|
83641
84881
|
* Update work plan bid ranks for a user
|
|
83642
84882
|
*
|
|
83643
84883
|
* @param {String} userId The userId to whom the work plan bid ranks apply.
|
|
83644
|
-
* @param {Object}
|
|
83645
|
-
* @param {Object} opts.body body
|
|
84884
|
+
* @param {Object} body body
|
|
83646
84885
|
*/
|
|
83647
|
-
patchWorkforcemanagementUserWorkplanbidranks(userId,
|
|
83648
|
-
opts = opts || {};
|
|
83649
|
-
|
|
84886
|
+
patchWorkforcemanagementUserWorkplanbidranks(userId, body) {
|
|
83650
84887
|
// verify the required parameter 'userId' is set
|
|
83651
84888
|
if (userId === undefined || userId === null) {
|
|
83652
84889
|
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
|
|
83653
84890
|
}
|
|
84891
|
+
// verify the required parameter 'body' is set
|
|
84892
|
+
if (body === undefined || body === null) {
|
|
84893
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUserWorkplanbidranks';
|
|
84894
|
+
}
|
|
83654
84895
|
|
|
83655
84896
|
return this.apiClient.callApi(
|
|
83656
84897
|
'/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
|
|
@@ -83659,7 +84900,7 @@ class WorkforceManagementApi {
|
|
|
83659
84900
|
{ },
|
|
83660
84901
|
{ },
|
|
83661
84902
|
{ },
|
|
83662
|
-
|
|
84903
|
+
body,
|
|
83663
84904
|
['PureCloud OAuth'],
|
|
83664
84905
|
['application/json'],
|
|
83665
84906
|
['application/json']
|
|
@@ -83695,16 +84936,17 @@ class WorkforceManagementApi {
|
|
|
83695
84936
|
* Update an agent's work plan bidding preference
|
|
83696
84937
|
*
|
|
83697
84938
|
* @param {String} bidId The ID of the work plan bid
|
|
83698
|
-
* @param {Object}
|
|
83699
|
-
* @param {Object} opts.body body
|
|
84939
|
+
* @param {Object} body body
|
|
83700
84940
|
*/
|
|
83701
|
-
patchWorkforcemanagementWorkplanbidPreferences(bidId,
|
|
83702
|
-
opts = opts || {};
|
|
83703
|
-
|
|
84941
|
+
patchWorkforcemanagementWorkplanbidPreferences(bidId, body) {
|
|
83704
84942
|
// verify the required parameter 'bidId' is set
|
|
83705
84943
|
if (bidId === undefined || bidId === null) {
|
|
83706
84944
|
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
|
|
83707
84945
|
}
|
|
84946
|
+
// verify the required parameter 'body' is set
|
|
84947
|
+
if (body === undefined || body === null) {
|
|
84948
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementWorkplanbidPreferences';
|
|
84949
|
+
}
|
|
83708
84950
|
|
|
83709
84951
|
return this.apiClient.callApi(
|
|
83710
84952
|
'/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
|
|
@@ -83713,7 +84955,7 @@ class WorkforceManagementApi {
|
|
|
83713
84955
|
{ },
|
|
83714
84956
|
{ },
|
|
83715
84957
|
{ },
|
|
83716
|
-
|
|
84958
|
+
body,
|
|
83717
84959
|
['PureCloud OAuth'],
|
|
83718
84960
|
['application/json'],
|
|
83719
84961
|
['application/json']
|
|
@@ -83803,12 +85045,13 @@ class WorkforceManagementApi {
|
|
|
83803
85045
|
/**
|
|
83804
85046
|
* Request a historical adherence report in bulk
|
|
83805
85047
|
*
|
|
83806
|
-
* @param {Object}
|
|
83807
|
-
* @param {Object} opts.body body
|
|
85048
|
+
* @param {Object} body body
|
|
83808
85049
|
*/
|
|
83809
|
-
postWorkforcemanagementAdherenceHistoricalBulk(
|
|
83810
|
-
|
|
83811
|
-
|
|
85050
|
+
postWorkforcemanagementAdherenceHistoricalBulk(body) {
|
|
85051
|
+
// verify the required parameter 'body' is set
|
|
85052
|
+
if (body === undefined || body === null) {
|
|
85053
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceHistoricalBulk';
|
|
85054
|
+
}
|
|
83812
85055
|
|
|
83813
85056
|
return this.apiClient.callApi(
|
|
83814
85057
|
'/api/v2/workforcemanagement/adherence/historical/bulk',
|
|
@@ -83817,7 +85060,7 @@ class WorkforceManagementApi {
|
|
|
83817
85060
|
{ },
|
|
83818
85061
|
{ },
|
|
83819
85062
|
{ },
|
|
83820
|
-
|
|
85063
|
+
body,
|
|
83821
85064
|
['PureCloud OAuth'],
|
|
83822
85065
|
['application/json'],
|
|
83823
85066
|
['application/json']
|
|
@@ -83892,12 +85135,13 @@ class WorkforceManagementApi {
|
|
|
83892
85135
|
/**
|
|
83893
85136
|
* Move agents in and out of management unit
|
|
83894
85137
|
*
|
|
83895
|
-
* @param {Object}
|
|
83896
|
-
* @param {Object} opts.body body
|
|
85138
|
+
* @param {Object} body body
|
|
83897
85139
|
*/
|
|
83898
|
-
postWorkforcemanagementAgents(
|
|
83899
|
-
|
|
83900
|
-
|
|
85140
|
+
postWorkforcemanagementAgents(body) {
|
|
85141
|
+
// verify the required parameter 'body' is set
|
|
85142
|
+
if (body === undefined || body === null) {
|
|
85143
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgents';
|
|
85144
|
+
}
|
|
83901
85145
|
|
|
83902
85146
|
return this.apiClient.callApi(
|
|
83903
85147
|
'/api/v2/workforcemanagement/agents',
|
|
@@ -83906,7 +85150,7 @@ class WorkforceManagementApi {
|
|
|
83906
85150
|
{ },
|
|
83907
85151
|
{ },
|
|
83908
85152
|
{ },
|
|
83909
|
-
|
|
85153
|
+
body,
|
|
83910
85154
|
['PureCloud OAuth'],
|
|
83911
85155
|
['application/json'],
|
|
83912
85156
|
['application/json']
|
|
@@ -83916,12 +85160,13 @@ class WorkforceManagementApi {
|
|
|
83916
85160
|
/**
|
|
83917
85161
|
* Query integrations for agents
|
|
83918
85162
|
*
|
|
83919
|
-
* @param {Object}
|
|
83920
|
-
* @param {Object} opts.body body
|
|
85163
|
+
* @param {Object} body body
|
|
83921
85164
|
*/
|
|
83922
|
-
postWorkforcemanagementAgentsIntegrationsHrisQuery(
|
|
83923
|
-
|
|
83924
|
-
|
|
85165
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(body) {
|
|
85166
|
+
// verify the required parameter 'body' is set
|
|
85167
|
+
if (body === undefined || body === null) {
|
|
85168
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsIntegrationsHrisQuery';
|
|
85169
|
+
}
|
|
83925
85170
|
|
|
83926
85171
|
return this.apiClient.callApi(
|
|
83927
85172
|
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
@@ -83930,7 +85175,7 @@ class WorkforceManagementApi {
|
|
|
83930
85175
|
{ },
|
|
83931
85176
|
{ },
|
|
83932
85177
|
{ },
|
|
83933
|
-
|
|
85178
|
+
body,
|
|
83934
85179
|
['PureCloud OAuth'],
|
|
83935
85180
|
['application/json'],
|
|
83936
85181
|
['application/json']
|
|
@@ -83965,12 +85210,13 @@ class WorkforceManagementApi {
|
|
|
83965
85210
|
/**
|
|
83966
85211
|
* Get published schedule for the current user
|
|
83967
85212
|
*
|
|
83968
|
-
* @param {Object}
|
|
83969
|
-
* @param {Object} opts.body body
|
|
85213
|
+
* @param {Object} body body
|
|
83970
85214
|
*/
|
|
83971
|
-
postWorkforcemanagementAgentschedulesMine(
|
|
83972
|
-
|
|
83973
|
-
|
|
85215
|
+
postWorkforcemanagementAgentschedulesMine(body) {
|
|
85216
|
+
// verify the required parameter 'body' is set
|
|
85217
|
+
if (body === undefined || body === null) {
|
|
85218
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentschedulesMine';
|
|
85219
|
+
}
|
|
83974
85220
|
|
|
83975
85221
|
return this.apiClient.callApi(
|
|
83976
85222
|
'/api/v2/workforcemanagement/agentschedules/mine',
|
|
@@ -83979,7 +85225,7 @@ class WorkforceManagementApi {
|
|
|
83979
85225
|
{ },
|
|
83980
85226
|
{ },
|
|
83981
85227
|
{ },
|
|
83982
|
-
|
|
85228
|
+
body,
|
|
83983
85229
|
['PureCloud OAuth'],
|
|
83984
85230
|
['application/json'],
|
|
83985
85231
|
['application/json']
|
|
@@ -84065,16 +85311,17 @@ class WorkforceManagementApi {
|
|
|
84065
85311
|
* Create a new activity code
|
|
84066
85312
|
*
|
|
84067
85313
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
84068
|
-
* @param {Object}
|
|
84069
|
-
* @param {Object} opts.body body
|
|
85314
|
+
* @param {Object} body body
|
|
84070
85315
|
*/
|
|
84071
|
-
postWorkforcemanagementBusinessunitActivitycodes(businessUnitId,
|
|
84072
|
-
opts = opts || {};
|
|
84073
|
-
|
|
85316
|
+
postWorkforcemanagementBusinessunitActivitycodes(businessUnitId, body) {
|
|
84074
85317
|
// verify the required parameter 'businessUnitId' is set
|
|
84075
85318
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84076
85319
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivitycodes';
|
|
84077
85320
|
}
|
|
85321
|
+
// verify the required parameter 'body' is set
|
|
85322
|
+
if (body === undefined || body === null) {
|
|
85323
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivitycodes';
|
|
85324
|
+
}
|
|
84078
85325
|
|
|
84079
85326
|
return this.apiClient.callApi(
|
|
84080
85327
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes',
|
|
@@ -84083,7 +85330,7 @@ class WorkforceManagementApi {
|
|
|
84083
85330
|
{ },
|
|
84084
85331
|
{ },
|
|
84085
85332
|
{ },
|
|
84086
|
-
|
|
85333
|
+
body,
|
|
84087
85334
|
['PureCloud OAuth'],
|
|
84088
85335
|
['application/json'],
|
|
84089
85336
|
['application/json']
|
|
@@ -84189,18 +85436,22 @@ class WorkforceManagementApi {
|
|
|
84189
85436
|
* Search published schedules
|
|
84190
85437
|
*
|
|
84191
85438
|
* @param {String} businessUnitId The ID of the business unit
|
|
85439
|
+
* @param {Object} body body
|
|
84192
85440
|
* @param {Object} opts Optional parameters
|
|
84193
85441
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
84194
85442
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
84195
|
-
* @param {Object} opts.body body
|
|
84196
85443
|
*/
|
|
84197
|
-
postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId, opts) {
|
|
85444
|
+
postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId, body, opts) {
|
|
84198
85445
|
opts = opts || {};
|
|
84199
85446
|
|
|
84200
85447
|
// verify the required parameter 'businessUnitId' is set
|
|
84201
85448
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84202
85449
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAgentschedulesSearch';
|
|
84203
85450
|
}
|
|
85451
|
+
// verify the required parameter 'body' is set
|
|
85452
|
+
if (body === undefined || body === null) {
|
|
85453
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAgentschedulesSearch';
|
|
85454
|
+
}
|
|
84204
85455
|
|
|
84205
85456
|
return this.apiClient.callApi(
|
|
84206
85457
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search',
|
|
@@ -84209,7 +85460,7 @@ class WorkforceManagementApi {
|
|
|
84209
85460
|
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
84210
85461
|
{ },
|
|
84211
85462
|
{ },
|
|
84212
|
-
|
|
85463
|
+
body,
|
|
84213
85464
|
['PureCloud OAuth'],
|
|
84214
85465
|
['application/json'],
|
|
84215
85466
|
['application/json']
|
|
@@ -84254,17 +85505,21 @@ class WorkforceManagementApi {
|
|
|
84254
85505
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
84255
85506
|
*
|
|
84256
85507
|
* @param {String} businessUnitId The ID of the business unit
|
|
85508
|
+
* @param {Object} body body
|
|
84257
85509
|
* @param {Object} opts Optional parameters
|
|
84258
85510
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
84259
|
-
* @param {Object} opts.body body
|
|
84260
85511
|
*/
|
|
84261
|
-
postWorkforcemanagementBusinessunitIntraday(businessUnitId, opts) {
|
|
85512
|
+
postWorkforcemanagementBusinessunitIntraday(businessUnitId, body, opts) {
|
|
84262
85513
|
opts = opts || {};
|
|
84263
85514
|
|
|
84264
85515
|
// verify the required parameter 'businessUnitId' is set
|
|
84265
85516
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84266
85517
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';
|
|
84267
85518
|
}
|
|
85519
|
+
// verify the required parameter 'body' is set
|
|
85520
|
+
if (body === undefined || body === null) {
|
|
85521
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitIntraday';
|
|
85522
|
+
}
|
|
84268
85523
|
|
|
84269
85524
|
return this.apiClient.callApi(
|
|
84270
85525
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday',
|
|
@@ -84273,7 +85528,7 @@ class WorkforceManagementApi {
|
|
|
84273
85528
|
{ 'forceAsync': opts['forceAsync'] },
|
|
84274
85529
|
{ },
|
|
84275
85530
|
{ },
|
|
84276
|
-
|
|
85531
|
+
body,
|
|
84277
85532
|
['PureCloud OAuth'],
|
|
84278
85533
|
['application/json'],
|
|
84279
85534
|
['application/json']
|
|
@@ -84284,16 +85539,17 @@ class WorkforceManagementApi {
|
|
|
84284
85539
|
* Adds a new planning group
|
|
84285
85540
|
*
|
|
84286
85541
|
* @param {String} businessUnitId The ID of the business unit.
|
|
84287
|
-
* @param {Object}
|
|
84288
|
-
* @param {Object} opts.body body
|
|
85542
|
+
* @param {Object} body body
|
|
84289
85543
|
*/
|
|
84290
|
-
postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId,
|
|
84291
|
-
opts = opts || {};
|
|
84292
|
-
|
|
85544
|
+
postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId, body) {
|
|
84293
85545
|
// verify the required parameter 'businessUnitId' is set
|
|
84294
85546
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84295
85547
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitPlanninggroups';
|
|
84296
85548
|
}
|
|
85549
|
+
// verify the required parameter 'body' is set
|
|
85550
|
+
if (body === undefined || body === null) {
|
|
85551
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitPlanninggroups';
|
|
85552
|
+
}
|
|
84297
85553
|
|
|
84298
85554
|
return this.apiClient.callApi(
|
|
84299
85555
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups',
|
|
@@ -84302,7 +85558,7 @@ class WorkforceManagementApi {
|
|
|
84302
85558
|
{ },
|
|
84303
85559
|
{ },
|
|
84304
85560
|
{ },
|
|
84305
|
-
|
|
85561
|
+
body,
|
|
84306
85562
|
['PureCloud OAuth'],
|
|
84307
85563
|
['application/json'],
|
|
84308
85564
|
['application/json']
|
|
@@ -84313,16 +85569,17 @@ class WorkforceManagementApi {
|
|
|
84313
85569
|
* Adds a new service goal template
|
|
84314
85570
|
*
|
|
84315
85571
|
* @param {String} businessUnitId The ID of the business unit.
|
|
84316
|
-
* @param {Object}
|
|
84317
|
-
* @param {Object} opts.body body
|
|
85572
|
+
* @param {Object} body body
|
|
84318
85573
|
*/
|
|
84319
|
-
postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,
|
|
84320
|
-
opts = opts || {};
|
|
84321
|
-
|
|
85574
|
+
postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, body) {
|
|
84322
85575
|
// verify the required parameter 'businessUnitId' is set
|
|
84323
85576
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84324
85577
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
84325
85578
|
}
|
|
85579
|
+
// verify the required parameter 'body' is set
|
|
85580
|
+
if (body === undefined || body === null) {
|
|
85581
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
85582
|
+
}
|
|
84326
85583
|
|
|
84327
85584
|
return this.apiClient.callApi(
|
|
84328
85585
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
@@ -84331,7 +85588,7 @@ class WorkforceManagementApi {
|
|
|
84331
85588
|
{ },
|
|
84332
85589
|
{ },
|
|
84333
85590
|
{ },
|
|
84334
|
-
|
|
85591
|
+
body,
|
|
84335
85592
|
['PureCloud OAuth'],
|
|
84336
85593
|
['application/json'],
|
|
84337
85594
|
['application/json']
|
|
@@ -84342,16 +85599,17 @@ class WorkforceManagementApi {
|
|
|
84342
85599
|
* Creates a new staffing group
|
|
84343
85600
|
*
|
|
84344
85601
|
* @param {String} businessUnitId The ID of the business unit
|
|
84345
|
-
* @param {Object}
|
|
84346
|
-
* @param {Object} opts.body body
|
|
85602
|
+
* @param {Object} body body
|
|
84347
85603
|
*/
|
|
84348
|
-
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,
|
|
84349
|
-
opts = opts || {};
|
|
84350
|
-
|
|
85604
|
+
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, body) {
|
|
84351
85605
|
// verify the required parameter 'businessUnitId' is set
|
|
84352
85606
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84353
85607
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
84354
85608
|
}
|
|
85609
|
+
// verify the required parameter 'body' is set
|
|
85610
|
+
if (body === undefined || body === null) {
|
|
85611
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
85612
|
+
}
|
|
84355
85613
|
|
|
84356
85614
|
return this.apiClient.callApi(
|
|
84357
85615
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
@@ -84360,7 +85618,7 @@ class WorkforceManagementApi {
|
|
|
84360
85618
|
{ },
|
|
84361
85619
|
{ },
|
|
84362
85620
|
{ },
|
|
84363
|
-
|
|
85621
|
+
body,
|
|
84364
85622
|
['PureCloud OAuth'],
|
|
84365
85623
|
['application/json'],
|
|
84366
85624
|
['application/json']
|
|
@@ -84371,25 +85629,30 @@ class WorkforceManagementApi {
|
|
|
84371
85629
|
* Gets staffing group associations for a list of user IDs
|
|
84372
85630
|
*
|
|
84373
85631
|
* @param {String} businessUnitId The ID of the business unit
|
|
85632
|
+
* @param {Object} body body
|
|
84374
85633
|
* @param {Object} opts Optional parameters
|
|
84375
|
-
* @param {
|
|
85634
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service
|
|
84376
85635
|
*/
|
|
84377
|
-
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, opts) {
|
|
85636
|
+
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, body, opts) {
|
|
84378
85637
|
opts = opts || {};
|
|
84379
85638
|
|
|
84380
85639
|
// verify the required parameter 'businessUnitId' is set
|
|
84381
85640
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84382
85641
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
84383
85642
|
}
|
|
85643
|
+
// verify the required parameter 'body' is set
|
|
85644
|
+
if (body === undefined || body === null) {
|
|
85645
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
85646
|
+
}
|
|
84384
85647
|
|
|
84385
85648
|
return this.apiClient.callApi(
|
|
84386
85649
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
|
|
84387
85650
|
'POST',
|
|
84388
85651
|
{ 'businessUnitId': businessUnitId },
|
|
85652
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
84389
85653
|
{ },
|
|
84390
85654
|
{ },
|
|
84391
|
-
|
|
84392
|
-
opts['body'],
|
|
85655
|
+
body,
|
|
84393
85656
|
['PureCloud OAuth'],
|
|
84394
85657
|
['application/json'],
|
|
84395
85658
|
['application/json']
|
|
@@ -84400,16 +85663,17 @@ class WorkforceManagementApi {
|
|
|
84400
85663
|
* Creates a new time-off limit object
|
|
84401
85664
|
*
|
|
84402
85665
|
* @param {String} businessUnitId The ID of the business unit
|
|
84403
|
-
* @param {Object}
|
|
84404
|
-
* @param {Object} opts.body body
|
|
85666
|
+
* @param {Object} body body
|
|
84405
85667
|
*/
|
|
84406
|
-
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,
|
|
84407
|
-
opts = opts || {};
|
|
84408
|
-
|
|
85668
|
+
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, body) {
|
|
84409
85669
|
// verify the required parameter 'businessUnitId' is set
|
|
84410
85670
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84411
85671
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
84412
85672
|
}
|
|
85673
|
+
// verify the required parameter 'body' is set
|
|
85674
|
+
if (body === undefined || body === null) {
|
|
85675
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
85676
|
+
}
|
|
84413
85677
|
|
|
84414
85678
|
return this.apiClient.callApi(
|
|
84415
85679
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
@@ -84418,7 +85682,7 @@ class WorkforceManagementApi {
|
|
|
84418
85682
|
{ },
|
|
84419
85683
|
{ },
|
|
84420
85684
|
{ },
|
|
84421
|
-
|
|
85685
|
+
body,
|
|
84422
85686
|
['PureCloud OAuth'],
|
|
84423
85687
|
['application/json'],
|
|
84424
85688
|
['application/json']
|
|
@@ -84429,16 +85693,17 @@ class WorkforceManagementApi {
|
|
|
84429
85693
|
* Retrieves time-off limit related values based on a given set of filters.
|
|
84430
85694
|
*
|
|
84431
85695
|
* @param {String} businessUnitId The ID of the business unit
|
|
84432
|
-
* @param {Object}
|
|
84433
|
-
* @param {Object} opts.body body
|
|
85696
|
+
* @param {Object} body body
|
|
84434
85697
|
*/
|
|
84435
|
-
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId,
|
|
84436
|
-
opts = opts || {};
|
|
84437
|
-
|
|
85698
|
+
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId, body) {
|
|
84438
85699
|
// verify the required parameter 'businessUnitId' is set
|
|
84439
85700
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84440
85701
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
84441
85702
|
}
|
|
85703
|
+
// verify the required parameter 'body' is set
|
|
85704
|
+
if (body === undefined || body === null) {
|
|
85705
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
85706
|
+
}
|
|
84442
85707
|
|
|
84443
85708
|
return this.apiClient.callApi(
|
|
84444
85709
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query',
|
|
@@ -84447,7 +85712,7 @@ class WorkforceManagementApi {
|
|
|
84447
85712
|
{ },
|
|
84448
85713
|
{ },
|
|
84449
85714
|
{ },
|
|
84450
|
-
|
|
85715
|
+
body,
|
|
84451
85716
|
['PureCloud OAuth'],
|
|
84452
85717
|
['application/json'],
|
|
84453
85718
|
['application/json']
|
|
@@ -84458,16 +85723,17 @@ class WorkforceManagementApi {
|
|
|
84458
85723
|
* Creates a new time-off plan
|
|
84459
85724
|
*
|
|
84460
85725
|
* @param {String} businessUnitId The ID of the business unit
|
|
84461
|
-
* @param {Object}
|
|
84462
|
-
* @param {Object} opts.body body
|
|
85726
|
+
* @param {Object} body body
|
|
84463
85727
|
*/
|
|
84464
|
-
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,
|
|
84465
|
-
opts = opts || {};
|
|
84466
|
-
|
|
85728
|
+
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, body) {
|
|
84467
85729
|
// verify the required parameter 'businessUnitId' is set
|
|
84468
85730
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84469
85731
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
84470
85732
|
}
|
|
85733
|
+
// verify the required parameter 'body' is set
|
|
85734
|
+
if (body === undefined || body === null) {
|
|
85735
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
85736
|
+
}
|
|
84471
85737
|
|
|
84472
85738
|
return this.apiClient.callApi(
|
|
84473
85739
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
@@ -84476,7 +85742,7 @@ class WorkforceManagementApi {
|
|
|
84476
85742
|
{ },
|
|
84477
85743
|
{ },
|
|
84478
85744
|
{ },
|
|
84479
|
-
|
|
85745
|
+
body,
|
|
84480
85746
|
['PureCloud OAuth'],
|
|
84481
85747
|
['application/json'],
|
|
84482
85748
|
['application/json']
|
|
@@ -84574,12 +85840,9 @@ class WorkforceManagementApi {
|
|
|
84574
85840
|
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
84575
85841
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
84576
85842
|
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
84577
|
-
* @param {Object}
|
|
84578
|
-
* @param {Object} opts.body body
|
|
85843
|
+
* @param {Object} body body
|
|
84579
85844
|
*/
|
|
84580
|
-
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId,
|
|
84581
|
-
opts = opts || {};
|
|
84582
|
-
|
|
85845
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, body) {
|
|
84583
85846
|
// verify the required parameter 'businessUnitId' is set
|
|
84584
85847
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84585
85848
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
@@ -84592,6 +85855,10 @@ class WorkforceManagementApi {
|
|
|
84592
85855
|
if (scheduleId === undefined || scheduleId === null) {
|
|
84593
85856
|
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
84594
85857
|
}
|
|
85858
|
+
// verify the required parameter 'body' is set
|
|
85859
|
+
if (body === undefined || body === null) {
|
|
85860
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
85861
|
+
}
|
|
84595
85862
|
|
|
84596
85863
|
return this.apiClient.callApi(
|
|
84597
85864
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
|
|
@@ -84600,7 +85867,7 @@ class WorkforceManagementApi {
|
|
|
84600
85867
|
{ },
|
|
84601
85868
|
{ },
|
|
84602
85869
|
{ },
|
|
84603
|
-
|
|
85870
|
+
body,
|
|
84604
85871
|
['PureCloud OAuth'],
|
|
84605
85872
|
['application/json'],
|
|
84606
85873
|
['application/json']
|
|
@@ -84613,12 +85880,9 @@ class WorkforceManagementApi {
|
|
|
84613
85880
|
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
84614
85881
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
84615
85882
|
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
84616
|
-
* @param {Object}
|
|
84617
|
-
* @param {Object} opts.body body
|
|
85883
|
+
* @param {Object} body body
|
|
84618
85884
|
*/
|
|
84619
|
-
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId,
|
|
84620
|
-
opts = opts || {};
|
|
84621
|
-
|
|
85885
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, body) {
|
|
84622
85886
|
// verify the required parameter 'businessUnitId' is set
|
|
84623
85887
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84624
85888
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
@@ -84631,6 +85895,10 @@ class WorkforceManagementApi {
|
|
|
84631
85895
|
if (scheduleId === undefined || scheduleId === null) {
|
|
84632
85896
|
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
84633
85897
|
}
|
|
85898
|
+
// verify the required parameter 'body' is set
|
|
85899
|
+
if (body === undefined || body === null) {
|
|
85900
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
85901
|
+
}
|
|
84634
85902
|
|
|
84635
85903
|
return this.apiClient.callApi(
|
|
84636
85904
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
|
|
@@ -84639,7 +85907,7 @@ class WorkforceManagementApi {
|
|
|
84639
85907
|
{ },
|
|
84640
85908
|
{ },
|
|
84641
85909
|
{ },
|
|
84642
|
-
|
|
85910
|
+
body,
|
|
84643
85911
|
['PureCloud OAuth'],
|
|
84644
85912
|
['application/json'],
|
|
84645
85913
|
['application/json']
|
|
@@ -85064,12 +86332,9 @@ class WorkforceManagementApi {
|
|
|
85064
86332
|
*
|
|
85065
86333
|
* @param {String} businessUnitId The ID of the business unit
|
|
85066
86334
|
* @param {String} bidId The ID of the work plan bid to copy
|
|
85067
|
-
* @param {Object}
|
|
85068
|
-
* @param {Object} opts.body body
|
|
86335
|
+
* @param {Object} body body
|
|
85069
86336
|
*/
|
|
85070
|
-
postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId,
|
|
85071
|
-
opts = opts || {};
|
|
85072
|
-
|
|
86337
|
+
postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, body) {
|
|
85073
86338
|
// verify the required parameter 'businessUnitId' is set
|
|
85074
86339
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
85075
86340
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
@@ -85078,6 +86343,10 @@ class WorkforceManagementApi {
|
|
|
85078
86343
|
if (bidId === undefined || bidId === null) {
|
|
85079
86344
|
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
85080
86345
|
}
|
|
86346
|
+
// verify the required parameter 'body' is set
|
|
86347
|
+
if (body === undefined || body === null) {
|
|
86348
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
86349
|
+
}
|
|
85081
86350
|
|
|
85082
86351
|
return this.apiClient.callApi(
|
|
85083
86352
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
|
|
@@ -85086,7 +86355,7 @@ class WorkforceManagementApi {
|
|
|
85086
86355
|
{ },
|
|
85087
86356
|
{ },
|
|
85088
86357
|
{ },
|
|
85089
|
-
|
|
86358
|
+
body,
|
|
85090
86359
|
['PureCloud OAuth'],
|
|
85091
86360
|
['application/json'],
|
|
85092
86361
|
['application/json']
|
|
@@ -85098,12 +86367,9 @@ class WorkforceManagementApi {
|
|
|
85098
86367
|
*
|
|
85099
86368
|
* @param {String} businessUnitId The ID of the business unit
|
|
85100
86369
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
85101
|
-
* @param {Object}
|
|
85102
|
-
* @param {Object} opts.body body
|
|
86370
|
+
* @param {Object} body body
|
|
85103
86371
|
*/
|
|
85104
|
-
postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId,
|
|
85105
|
-
opts = opts || {};
|
|
85106
|
-
|
|
86372
|
+
postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, body) {
|
|
85107
86373
|
// verify the required parameter 'businessUnitId' is set
|
|
85108
86374
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
85109
86375
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
@@ -85112,6 +86378,10 @@ class WorkforceManagementApi {
|
|
|
85112
86378
|
if (bidId === undefined || bidId === null) {
|
|
85113
86379
|
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
85114
86380
|
}
|
|
86381
|
+
// verify the required parameter 'body' is set
|
|
86382
|
+
if (body === undefined || body === null) {
|
|
86383
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
86384
|
+
}
|
|
85115
86385
|
|
|
85116
86386
|
return this.apiClient.callApi(
|
|
85117
86387
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
|
|
@@ -85120,7 +86390,7 @@ class WorkforceManagementApi {
|
|
|
85120
86390
|
{ },
|
|
85121
86391
|
{ },
|
|
85122
86392
|
{ },
|
|
85123
|
-
|
|
86393
|
+
body,
|
|
85124
86394
|
['PureCloud OAuth'],
|
|
85125
86395
|
['application/json'],
|
|
85126
86396
|
['application/json']
|
|
@@ -85131,16 +86401,17 @@ class WorkforceManagementApi {
|
|
|
85131
86401
|
* Create a new work plan bid
|
|
85132
86402
|
*
|
|
85133
86403
|
* @param {String} businessUnitId The ID of the business unit
|
|
85134
|
-
* @param {Object}
|
|
85135
|
-
* @param {Object} opts.body The work plan bid to be created
|
|
86404
|
+
* @param {Object} body The work plan bid to be created
|
|
85136
86405
|
*/
|
|
85137
|
-
postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId,
|
|
85138
|
-
opts = opts || {};
|
|
85139
|
-
|
|
86406
|
+
postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, body) {
|
|
85140
86407
|
// verify the required parameter 'businessUnitId' is set
|
|
85141
86408
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
85142
86409
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
|
|
85143
86410
|
}
|
|
86411
|
+
// verify the required parameter 'body' is set
|
|
86412
|
+
if (body === undefined || body === null) {
|
|
86413
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbids';
|
|
86414
|
+
}
|
|
85144
86415
|
|
|
85145
86416
|
return this.apiClient.callApi(
|
|
85146
86417
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
|
|
@@ -85149,7 +86420,7 @@ class WorkforceManagementApi {
|
|
|
85149
86420
|
{ },
|
|
85150
86421
|
{ },
|
|
85151
86422
|
{ },
|
|
85152
|
-
|
|
86423
|
+
body,
|
|
85153
86424
|
['PureCloud OAuth'],
|
|
85154
86425
|
['application/json'],
|
|
85155
86426
|
['application/json']
|
|
@@ -85159,12 +86430,13 @@ class WorkforceManagementApi {
|
|
|
85159
86430
|
/**
|
|
85160
86431
|
* Add a new business unit
|
|
85161
86432
|
* It may take a minute or two for a new business unit to be available for api operations
|
|
85162
|
-
* @param {Object}
|
|
85163
|
-
* @param {Object} opts.body body
|
|
86433
|
+
* @param {Object} body body
|
|
85164
86434
|
*/
|
|
85165
|
-
postWorkforcemanagementBusinessunits(
|
|
85166
|
-
|
|
85167
|
-
|
|
86435
|
+
postWorkforcemanagementBusinessunits(body) {
|
|
86436
|
+
// verify the required parameter 'body' is set
|
|
86437
|
+
if (body === undefined || body === null) {
|
|
86438
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunits';
|
|
86439
|
+
}
|
|
85168
86440
|
|
|
85169
86441
|
return this.apiClient.callApi(
|
|
85170
86442
|
'/api/v2/workforcemanagement/businessunits',
|
|
@@ -85173,7 +86445,7 @@ class WorkforceManagementApi {
|
|
|
85173
86445
|
{ },
|
|
85174
86446
|
{ },
|
|
85175
86447
|
{ },
|
|
85176
|
-
|
|
86448
|
+
body,
|
|
85177
86449
|
['PureCloud OAuth'],
|
|
85178
86450
|
['application/json'],
|
|
85179
86451
|
['application/json']
|
|
@@ -85207,12 +86479,13 @@ class WorkforceManagementApi {
|
|
|
85207
86479
|
/**
|
|
85208
86480
|
* Delete the list of the historical data import entries
|
|
85209
86481
|
*
|
|
85210
|
-
* @param {Object}
|
|
85211
|
-
* @param {Object} opts.body body
|
|
86482
|
+
* @param {Object} body body
|
|
85212
86483
|
*/
|
|
85213
|
-
postWorkforcemanagementHistoricaldataBulkRemoveJobs(
|
|
85214
|
-
|
|
85215
|
-
|
|
86484
|
+
postWorkforcemanagementHistoricaldataBulkRemoveJobs(body) {
|
|
86485
|
+
// verify the required parameter 'body' is set
|
|
86486
|
+
if (body === undefined || body === null) {
|
|
86487
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementHistoricaldataBulkRemoveJobs';
|
|
86488
|
+
}
|
|
85216
86489
|
|
|
85217
86490
|
return this.apiClient.callApi(
|
|
85218
86491
|
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs',
|
|
@@ -85221,7 +86494,7 @@ class WorkforceManagementApi {
|
|
|
85221
86494
|
{ },
|
|
85222
86495
|
{ },
|
|
85223
86496
|
{ },
|
|
85224
|
-
|
|
86497
|
+
body,
|
|
85225
86498
|
['PureCloud OAuth'],
|
|
85226
86499
|
['application/json'],
|
|
85227
86500
|
['application/json']
|
|
@@ -85252,12 +86525,13 @@ class WorkforceManagementApi {
|
|
|
85252
86525
|
/**
|
|
85253
86526
|
* Trigger validation process for historical import
|
|
85254
86527
|
*
|
|
85255
|
-
* @param {Object}
|
|
85256
|
-
* @param {Object} opts.body body
|
|
86528
|
+
* @param {Object} body body
|
|
85257
86529
|
*/
|
|
85258
|
-
postWorkforcemanagementHistoricaldataValidate(
|
|
85259
|
-
|
|
85260
|
-
|
|
86530
|
+
postWorkforcemanagementHistoricaldataValidate(body) {
|
|
86531
|
+
// verify the required parameter 'body' is set
|
|
86532
|
+
if (body === undefined || body === null) {
|
|
86533
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementHistoricaldataValidate';
|
|
86534
|
+
}
|
|
85261
86535
|
|
|
85262
86536
|
return this.apiClient.callApi(
|
|
85263
86537
|
'/api/v2/workforcemanagement/historicaldata/validate',
|
|
@@ -85266,7 +86540,7 @@ class WorkforceManagementApi {
|
|
|
85266
86540
|
{ },
|
|
85267
86541
|
{ },
|
|
85268
86542
|
{ },
|
|
85269
|
-
|
|
86543
|
+
body,
|
|
85270
86544
|
['PureCloud OAuth'],
|
|
85271
86545
|
['application/json'],
|
|
85272
86546
|
['application/json']
|
|
@@ -85302,17 +86576,21 @@ class WorkforceManagementApi {
|
|
|
85302
86576
|
* Get agents work plans configuration
|
|
85303
86577
|
*
|
|
85304
86578
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86579
|
+
* @param {Object} body body
|
|
85305
86580
|
* @param {Object} opts Optional parameters
|
|
85306
86581
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85307
|
-
* @param {Object} opts.body body
|
|
85308
86582
|
*/
|
|
85309
|
-
postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId, opts) {
|
|
86583
|
+
postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId, body, opts) {
|
|
85310
86584
|
opts = opts || {};
|
|
85311
86585
|
|
|
85312
86586
|
// verify the required parameter 'managementUnitId' is set
|
|
85313
86587
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85314
86588
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';
|
|
85315
86589
|
}
|
|
86590
|
+
// verify the required parameter 'body' is set
|
|
86591
|
+
if (body === undefined || body === null) {
|
|
86592
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';
|
|
86593
|
+
}
|
|
85316
86594
|
|
|
85317
86595
|
return this.apiClient.callApi(
|
|
85318
86596
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query',
|
|
@@ -85321,7 +86599,7 @@ class WorkforceManagementApi {
|
|
|
85321
86599
|
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
85322
86600
|
{ },
|
|
85323
86601
|
{ },
|
|
85324
|
-
|
|
86602
|
+
body,
|
|
85325
86603
|
['PureCloud OAuth'],
|
|
85326
86604
|
['application/json'],
|
|
85327
86605
|
['application/json']
|
|
@@ -85332,18 +86610,22 @@ class WorkforceManagementApi {
|
|
|
85332
86610
|
* Query published schedules for given given time range for set of users
|
|
85333
86611
|
*
|
|
85334
86612
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86613
|
+
* @param {Object} body body
|
|
85335
86614
|
* @param {Object} opts Optional parameters
|
|
85336
86615
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
85337
86616
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85338
|
-
* @param {Object} opts.body body
|
|
85339
86617
|
*/
|
|
85340
|
-
postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId, opts) {
|
|
86618
|
+
postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId, body, opts) {
|
|
85341
86619
|
opts = opts || {};
|
|
85342
86620
|
|
|
85343
86621
|
// verify the required parameter 'managementUnitId' is set
|
|
85344
86622
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85345
86623
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
|
|
85346
86624
|
}
|
|
86625
|
+
// verify the required parameter 'body' is set
|
|
86626
|
+
if (body === undefined || body === null) {
|
|
86627
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
|
|
86628
|
+
}
|
|
85347
86629
|
|
|
85348
86630
|
return this.apiClient.callApi(
|
|
85349
86631
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search',
|
|
@@ -85352,7 +86634,7 @@ class WorkforceManagementApi {
|
|
|
85352
86634
|
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
85353
86635
|
{ },
|
|
85354
86636
|
{ },
|
|
85355
|
-
|
|
86637
|
+
body,
|
|
85356
86638
|
['PureCloud OAuth'],
|
|
85357
86639
|
['application/json'],
|
|
85358
86640
|
['application/json']
|
|
@@ -85363,16 +86645,17 @@ class WorkforceManagementApi {
|
|
|
85363
86645
|
* Request a historical adherence report
|
|
85364
86646
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
85365
86647
|
* @param {String} managementUnitId The ID of the management unit
|
|
85366
|
-
* @param {Object}
|
|
85367
|
-
* @param {Object} opts.body body
|
|
86648
|
+
* @param {Object} body body
|
|
85368
86649
|
*/
|
|
85369
|
-
postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId,
|
|
85370
|
-
opts = opts || {};
|
|
85371
|
-
|
|
86650
|
+
postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId, body) {
|
|
85372
86651
|
// verify the required parameter 'managementUnitId' is set
|
|
85373
86652
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85374
86653
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
|
|
85375
86654
|
}
|
|
86655
|
+
// verify the required parameter 'body' is set
|
|
86656
|
+
if (body === undefined || body === null) {
|
|
86657
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
|
|
86658
|
+
}
|
|
85376
86659
|
|
|
85377
86660
|
return this.apiClient.callApi(
|
|
85378
86661
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery',
|
|
@@ -85381,7 +86664,7 @@ class WorkforceManagementApi {
|
|
|
85381
86664
|
{ },
|
|
85382
86665
|
{ },
|
|
85383
86666
|
{ },
|
|
85384
|
-
|
|
86667
|
+
body,
|
|
85385
86668
|
['PureCloud OAuth'],
|
|
85386
86669
|
['application/json'],
|
|
85387
86670
|
['application/json']
|
|
@@ -85392,16 +86675,17 @@ class WorkforceManagementApi {
|
|
|
85392
86675
|
* Move the requested management unit to a new business unit
|
|
85393
86676
|
* Returns status 200 if the management unit is already in the requested business unit
|
|
85394
86677
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85395
|
-
* @param {Object}
|
|
85396
|
-
* @param {Object} opts.body body
|
|
86678
|
+
* @param {Object} body body
|
|
85397
86679
|
*/
|
|
85398
|
-
postWorkforcemanagementManagementunitMove(managementUnitId,
|
|
85399
|
-
opts = opts || {};
|
|
85400
|
-
|
|
86680
|
+
postWorkforcemanagementManagementunitMove(managementUnitId, body) {
|
|
85401
86681
|
// verify the required parameter 'managementUnitId' is set
|
|
85402
86682
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85403
86683
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitMove';
|
|
85404
86684
|
}
|
|
86685
|
+
// verify the required parameter 'body' is set
|
|
86686
|
+
if (body === undefined || body === null) {
|
|
86687
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitMove';
|
|
86688
|
+
}
|
|
85405
86689
|
|
|
85406
86690
|
return this.apiClient.callApi(
|
|
85407
86691
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/move',
|
|
@@ -85410,7 +86694,7 @@ class WorkforceManagementApi {
|
|
|
85410
86694
|
{ },
|
|
85411
86695
|
{ },
|
|
85412
86696
|
{ },
|
|
85413
|
-
|
|
86697
|
+
body,
|
|
85414
86698
|
['PureCloud OAuth'],
|
|
85415
86699
|
['application/json'],
|
|
85416
86700
|
['application/json']
|
|
@@ -85421,17 +86705,18 @@ class WorkforceManagementApi {
|
|
|
85421
86705
|
* Query published schedules for given given time range for set of users
|
|
85422
86706
|
*
|
|
85423
86707
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85424
|
-
* @param {Object}
|
|
85425
|
-
* @param {Object} opts.body body
|
|
86708
|
+
* @param {Object} body body
|
|
85426
86709
|
* @deprecated
|
|
85427
86710
|
*/
|
|
85428
|
-
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId,
|
|
85429
|
-
opts = opts || {};
|
|
85430
|
-
|
|
86711
|
+
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, body) {
|
|
85431
86712
|
// verify the required parameter 'managementUnitId' is set
|
|
85432
86713
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85433
86714
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitSchedulesSearch';
|
|
85434
86715
|
}
|
|
86716
|
+
// verify the required parameter 'body' is set
|
|
86717
|
+
if (body === undefined || body === null) {
|
|
86718
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitSchedulesSearch';
|
|
86719
|
+
}
|
|
85435
86720
|
|
|
85436
86721
|
return this.apiClient.callApi(
|
|
85437
86722
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search',
|
|
@@ -85440,7 +86725,7 @@ class WorkforceManagementApi {
|
|
|
85440
86725
|
{ },
|
|
85441
86726
|
{ },
|
|
85442
86727
|
{ },
|
|
85443
|
-
|
|
86728
|
+
body,
|
|
85444
86729
|
['PureCloud OAuth'],
|
|
85445
86730
|
['application/json'],
|
|
85446
86731
|
['application/json']
|
|
@@ -85451,16 +86736,17 @@ class WorkforceManagementApi {
|
|
|
85451
86736
|
* Request a historical shrinkage report
|
|
85452
86737
|
* 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.
|
|
85453
86738
|
* @param {String} managementUnitId The ID of the management unit
|
|
85454
|
-
* @param {Object}
|
|
85455
|
-
* @param {Object} opts.body body
|
|
86739
|
+
* @param {Object} body body
|
|
85456
86740
|
*/
|
|
85457
|
-
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId,
|
|
85458
|
-
opts = opts || {};
|
|
85459
|
-
|
|
86741
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, body) {
|
|
85460
86742
|
// verify the required parameter 'managementUnitId' is set
|
|
85461
86743
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85462
86744
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
85463
86745
|
}
|
|
86746
|
+
// verify the required parameter 'body' is set
|
|
86747
|
+
if (body === undefined || body === null) {
|
|
86748
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
86749
|
+
}
|
|
85464
86750
|
|
|
85465
86751
|
return this.apiClient.callApi(
|
|
85466
86752
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
@@ -85469,7 +86755,7 @@ class WorkforceManagementApi {
|
|
|
85469
86755
|
{ },
|
|
85470
86756
|
{ },
|
|
85471
86757
|
{ },
|
|
85472
|
-
|
|
86758
|
+
body,
|
|
85473
86759
|
['PureCloud OAuth'],
|
|
85474
86760
|
['application/json'],
|
|
85475
86761
|
['application/json']
|
|
@@ -85480,16 +86766,17 @@ class WorkforceManagementApi {
|
|
|
85480
86766
|
* Creates a new time off limit object under management unit.
|
|
85481
86767
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
85482
86768
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85483
|
-
* @param {Object}
|
|
85484
|
-
* @param {Object} opts.body body
|
|
86769
|
+
* @param {Object} body body
|
|
85485
86770
|
*/
|
|
85486
|
-
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId,
|
|
85487
|
-
opts = opts || {};
|
|
85488
|
-
|
|
86771
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, body) {
|
|
85489
86772
|
// verify the required parameter 'managementUnitId' is set
|
|
85490
86773
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85491
86774
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
85492
86775
|
}
|
|
86776
|
+
// verify the required parameter 'body' is set
|
|
86777
|
+
if (body === undefined || body === null) {
|
|
86778
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
86779
|
+
}
|
|
85493
86780
|
|
|
85494
86781
|
return this.apiClient.callApi(
|
|
85495
86782
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
@@ -85498,7 +86785,7 @@ class WorkforceManagementApi {
|
|
|
85498
86785
|
{ },
|
|
85499
86786
|
{ },
|
|
85500
86787
|
{ },
|
|
85501
|
-
|
|
86788
|
+
body,
|
|
85502
86789
|
['PureCloud OAuth'],
|
|
85503
86790
|
['application/json'],
|
|
85504
86791
|
['application/json']
|
|
@@ -85509,16 +86796,17 @@ class WorkforceManagementApi {
|
|
|
85509
86796
|
* Retrieves time off limit related values based on a given set of filters.
|
|
85510
86797
|
*
|
|
85511
86798
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85512
|
-
* @param {Object}
|
|
85513
|
-
* @param {Object} opts.body body
|
|
86799
|
+
* @param {Object} body body
|
|
85514
86800
|
*/
|
|
85515
|
-
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId,
|
|
85516
|
-
opts = opts || {};
|
|
85517
|
-
|
|
86801
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, body) {
|
|
85518
86802
|
// verify the required parameter 'managementUnitId' is set
|
|
85519
86803
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85520
86804
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
85521
86805
|
}
|
|
86806
|
+
// verify the required parameter 'body' is set
|
|
86807
|
+
if (body === undefined || body === null) {
|
|
86808
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
86809
|
+
}
|
|
85522
86810
|
|
|
85523
86811
|
return this.apiClient.callApi(
|
|
85524
86812
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
@@ -85527,7 +86815,7 @@ class WorkforceManagementApi {
|
|
|
85527
86815
|
{ },
|
|
85528
86816
|
{ },
|
|
85529
86817
|
{ },
|
|
85530
|
-
|
|
86818
|
+
body,
|
|
85531
86819
|
['PureCloud OAuth'],
|
|
85532
86820
|
['application/json'],
|
|
85533
86821
|
['application/json']
|
|
@@ -85538,16 +86826,17 @@ class WorkforceManagementApi {
|
|
|
85538
86826
|
* Creates a new time off plan
|
|
85539
86827
|
*
|
|
85540
86828
|
* @param {String} managementUnitId The ID of the management unit
|
|
85541
|
-
* @param {Object}
|
|
85542
|
-
* @param {Object} opts.body body
|
|
86829
|
+
* @param {Object} body body
|
|
85543
86830
|
*/
|
|
85544
|
-
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId,
|
|
85545
|
-
opts = opts || {};
|
|
85546
|
-
|
|
86831
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, body) {
|
|
85547
86832
|
// verify the required parameter 'managementUnitId' is set
|
|
85548
86833
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85549
86834
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
85550
86835
|
}
|
|
86836
|
+
// verify the required parameter 'body' is set
|
|
86837
|
+
if (body === undefined || body === null) {
|
|
86838
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
86839
|
+
}
|
|
85551
86840
|
|
|
85552
86841
|
return this.apiClient.callApi(
|
|
85553
86842
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
@@ -85556,7 +86845,7 @@ class WorkforceManagementApi {
|
|
|
85556
86845
|
{ },
|
|
85557
86846
|
{ },
|
|
85558
86847
|
{ },
|
|
85559
|
-
|
|
86848
|
+
body,
|
|
85560
86849
|
['PureCloud OAuth'],
|
|
85561
86850
|
['application/json'],
|
|
85562
86851
|
['application/json']
|
|
@@ -85567,16 +86856,17 @@ class WorkforceManagementApi {
|
|
|
85567
86856
|
* Create a new time off request
|
|
85568
86857
|
*
|
|
85569
86858
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85570
|
-
* @param {Object}
|
|
85571
|
-
* @param {Object} opts.body body
|
|
86859
|
+
* @param {Object} body body
|
|
85572
86860
|
*/
|
|
85573
|
-
postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId,
|
|
85574
|
-
opts = opts || {};
|
|
85575
|
-
|
|
86861
|
+
postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId, body) {
|
|
85576
86862
|
// verify the required parameter 'managementUnitId' is set
|
|
85577
86863
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85578
86864
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequests';
|
|
85579
86865
|
}
|
|
86866
|
+
// verify the required parameter 'body' is set
|
|
86867
|
+
if (body === undefined || body === null) {
|
|
86868
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequests';
|
|
86869
|
+
}
|
|
85580
86870
|
|
|
85581
86871
|
return this.apiClient.callApi(
|
|
85582
86872
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests',
|
|
@@ -85585,7 +86875,7 @@ class WorkforceManagementApi {
|
|
|
85585
86875
|
{ },
|
|
85586
86876
|
{ },
|
|
85587
86877
|
{ },
|
|
85588
|
-
|
|
86878
|
+
body,
|
|
85589
86879
|
['PureCloud OAuth'],
|
|
85590
86880
|
['application/json'],
|
|
85591
86881
|
['application/json']
|
|
@@ -85596,16 +86886,17 @@ class WorkforceManagementApi {
|
|
|
85596
86886
|
* Retrieves integration statuses for a list of time off requests
|
|
85597
86887
|
*
|
|
85598
86888
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85599
|
-
* @param {Object}
|
|
85600
|
-
* @param {Object} opts.body body
|
|
86889
|
+
* @param {Object} body body
|
|
85601
86890
|
*/
|
|
85602
|
-
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId,
|
|
85603
|
-
opts = opts || {};
|
|
85604
|
-
|
|
86891
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, body) {
|
|
85605
86892
|
// verify the required parameter 'managementUnitId' is set
|
|
85606
86893
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85607
86894
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
85608
86895
|
}
|
|
86896
|
+
// verify the required parameter 'body' is set
|
|
86897
|
+
if (body === undefined || body === null) {
|
|
86898
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
86899
|
+
}
|
|
85609
86900
|
|
|
85610
86901
|
return this.apiClient.callApi(
|
|
85611
86902
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
@@ -85614,7 +86905,7 @@ class WorkforceManagementApi {
|
|
|
85614
86905
|
{ },
|
|
85615
86906
|
{ },
|
|
85616
86907
|
{ },
|
|
85617
|
-
|
|
86908
|
+
body,
|
|
85618
86909
|
['PureCloud OAuth'],
|
|
85619
86910
|
['application/json'],
|
|
85620
86911
|
['application/json']
|
|
@@ -85625,17 +86916,21 @@ class WorkforceManagementApi {
|
|
|
85625
86916
|
* Fetches time off requests matching the conditions specified in the request body
|
|
85626
86917
|
* 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
|
|
85627
86918
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86919
|
+
* @param {Object} body body
|
|
85628
86920
|
* @param {Object} opts Optional parameters
|
|
85629
86921
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85630
|
-
* @param {Object} opts.body body
|
|
85631
86922
|
*/
|
|
85632
|
-
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, opts) {
|
|
86923
|
+
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, body, opts) {
|
|
85633
86924
|
opts = opts || {};
|
|
85634
86925
|
|
|
85635
86926
|
// verify the required parameter 'managementUnitId' is set
|
|
85636
86927
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85637
86928
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
|
|
85638
86929
|
}
|
|
86930
|
+
// verify the required parameter 'body' is set
|
|
86931
|
+
if (body === undefined || body === null) {
|
|
86932
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
|
|
86933
|
+
}
|
|
85639
86934
|
|
|
85640
86935
|
return this.apiClient.callApi(
|
|
85641
86936
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query',
|
|
@@ -85644,7 +86939,7 @@ class WorkforceManagementApi {
|
|
|
85644
86939
|
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
85645
86940
|
{ },
|
|
85646
86941
|
{ },
|
|
85647
|
-
|
|
86942
|
+
body,
|
|
85648
86943
|
['PureCloud OAuth'],
|
|
85649
86944
|
['application/json'],
|
|
85650
86945
|
['application/json']
|
|
@@ -85655,16 +86950,17 @@ class WorkforceManagementApi {
|
|
|
85655
86950
|
* Retrieves daily waitlist position for a list of time off requests
|
|
85656
86951
|
*
|
|
85657
86952
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85658
|
-
* @param {Object}
|
|
85659
|
-
* @param {Object} opts.body body
|
|
86953
|
+
* @param {Object} body body
|
|
85660
86954
|
*/
|
|
85661
|
-
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId,
|
|
85662
|
-
opts = opts || {};
|
|
85663
|
-
|
|
86955
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, body) {
|
|
85664
86956
|
// verify the required parameter 'managementUnitId' is set
|
|
85665
86957
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85666
86958
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
85667
86959
|
}
|
|
86960
|
+
// verify the required parameter 'body' is set
|
|
86961
|
+
if (body === undefined || body === null) {
|
|
86962
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
86963
|
+
}
|
|
85668
86964
|
|
|
85669
86965
|
return this.apiClient.callApi(
|
|
85670
86966
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
@@ -85673,7 +86969,7 @@ class WorkforceManagementApi {
|
|
|
85673
86969
|
{ },
|
|
85674
86970
|
{ },
|
|
85675
86971
|
{ },
|
|
85676
|
-
|
|
86972
|
+
body,
|
|
85677
86973
|
['PureCloud OAuth'],
|
|
85678
86974
|
['application/json'],
|
|
85679
86975
|
['application/json']
|
|
@@ -85755,12 +87051,9 @@ class WorkforceManagementApi {
|
|
|
85755
87051
|
*
|
|
85756
87052
|
* @param {String} managementUnitId The ID of the management unit
|
|
85757
87053
|
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
85758
|
-
* @param {Object}
|
|
85759
|
-
* @param {Object} opts.body body
|
|
87054
|
+
* @param {Object} body body
|
|
85760
87055
|
*/
|
|
85761
|
-
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId,
|
|
85762
|
-
opts = opts || {};
|
|
85763
|
-
|
|
87056
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body) {
|
|
85764
87057
|
// verify the required parameter 'managementUnitId' is set
|
|
85765
87058
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85766
87059
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
@@ -85769,6 +87062,10 @@ class WorkforceManagementApi {
|
|
|
85769
87062
|
if (userId === undefined || userId === null) {
|
|
85770
87063
|
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
85771
87064
|
}
|
|
87065
|
+
// verify the required parameter 'body' is set
|
|
87066
|
+
if (body === undefined || body === null) {
|
|
87067
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
87068
|
+
}
|
|
85772
87069
|
|
|
85773
87070
|
return this.apiClient.callApi(
|
|
85774
87071
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
@@ -85777,7 +87074,7 @@ class WorkforceManagementApi {
|
|
|
85777
87074
|
{ },
|
|
85778
87075
|
{ },
|
|
85779
87076
|
{ },
|
|
85780
|
-
|
|
87077
|
+
body,
|
|
85781
87078
|
['PureCloud OAuth'],
|
|
85782
87079
|
['application/json'],
|
|
85783
87080
|
['application/json']
|
|
@@ -85942,12 +87239,9 @@ class WorkforceManagementApi {
|
|
|
85942
87239
|
*
|
|
85943
87240
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85944
87241
|
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
85945
|
-
* @param {Object}
|
|
85946
|
-
* @param {Object} opts.body body
|
|
87242
|
+
* @param {Object} body body
|
|
85947
87243
|
*/
|
|
85948
|
-
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId,
|
|
85949
|
-
opts = opts || {};
|
|
85950
|
-
|
|
87244
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, body) {
|
|
85951
87245
|
// verify the required parameter 'managementUnitId' is set
|
|
85952
87246
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85953
87247
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
@@ -85956,6 +87250,10 @@ class WorkforceManagementApi {
|
|
|
85956
87250
|
if (workPlanId === undefined || workPlanId === null) {
|
|
85957
87251
|
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
85958
87252
|
}
|
|
87253
|
+
// verify the required parameter 'body' is set
|
|
87254
|
+
if (body === undefined || body === null) {
|
|
87255
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
87256
|
+
}
|
|
85959
87257
|
|
|
85960
87258
|
return this.apiClient.callApi(
|
|
85961
87259
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
@@ -85964,7 +87262,7 @@ class WorkforceManagementApi {
|
|
|
85964
87262
|
{ },
|
|
85965
87263
|
{ },
|
|
85966
87264
|
{ },
|
|
85967
|
-
|
|
87265
|
+
body,
|
|
85968
87266
|
['PureCloud OAuth'],
|
|
85969
87267
|
['application/json'],
|
|
85970
87268
|
['application/json']
|
|
@@ -85976,11 +87274,11 @@ class WorkforceManagementApi {
|
|
|
85976
87274
|
*
|
|
85977
87275
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85978
87276
|
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
87277
|
+
* @param {Object} body body
|
|
85979
87278
|
* @param {Object} opts Optional parameters
|
|
85980
87279
|
* @param {Array.<String>} opts.expand
|
|
85981
|
-
* @param {Object} opts.body body
|
|
85982
87280
|
*/
|
|
85983
|
-
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
87281
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, body, opts) {
|
|
85984
87282
|
opts = opts || {};
|
|
85985
87283
|
|
|
85986
87284
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -85991,6 +87289,10 @@ class WorkforceManagementApi {
|
|
|
85991
87289
|
if (workPlanId === undefined || workPlanId === null) {
|
|
85992
87290
|
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
85993
87291
|
}
|
|
87292
|
+
// verify the required parameter 'body' is set
|
|
87293
|
+
if (body === undefined || body === null) {
|
|
87294
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
87295
|
+
}
|
|
85994
87296
|
|
|
85995
87297
|
return this.apiClient.callApi(
|
|
85996
87298
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
@@ -85999,7 +87301,7 @@ class WorkforceManagementApi {
|
|
|
85999
87301
|
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
86000
87302
|
{ },
|
|
86001
87303
|
{ },
|
|
86002
|
-
|
|
87304
|
+
body,
|
|
86003
87305
|
['PureCloud OAuth'],
|
|
86004
87306
|
['application/json'],
|
|
86005
87307
|
['application/json']
|
|
@@ -86011,12 +87313,9 @@ class WorkforceManagementApi {
|
|
|
86011
87313
|
*
|
|
86012
87314
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86013
87315
|
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
86014
|
-
* @param {Object}
|
|
86015
|
-
* @param {Object} opts.body body
|
|
87316
|
+
* @param {Object} body body
|
|
86016
87317
|
*/
|
|
86017
|
-
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId,
|
|
86018
|
-
opts = opts || {};
|
|
86019
|
-
|
|
87318
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, body) {
|
|
86020
87319
|
// verify the required parameter 'managementUnitId' is set
|
|
86021
87320
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86022
87321
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
@@ -86025,6 +87324,10 @@ class WorkforceManagementApi {
|
|
|
86025
87324
|
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
86026
87325
|
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
86027
87326
|
}
|
|
87327
|
+
// verify the required parameter 'body' is set
|
|
87328
|
+
if (body === undefined || body === null) {
|
|
87329
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
87330
|
+
}
|
|
86028
87331
|
|
|
86029
87332
|
return this.apiClient.callApi(
|
|
86030
87333
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
@@ -86033,7 +87336,7 @@ class WorkforceManagementApi {
|
|
|
86033
87336
|
{ },
|
|
86034
87337
|
{ },
|
|
86035
87338
|
{ },
|
|
86036
|
-
|
|
87339
|
+
body,
|
|
86037
87340
|
['PureCloud OAuth'],
|
|
86038
87341
|
['application/json'],
|
|
86039
87342
|
['application/json']
|
|
@@ -86044,16 +87347,17 @@ class WorkforceManagementApi {
|
|
|
86044
87347
|
* Create a new work plan rotation
|
|
86045
87348
|
*
|
|
86046
87349
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86047
|
-
* @param {Object}
|
|
86048
|
-
* @param {Object} opts.body body
|
|
87350
|
+
* @param {Object} body body
|
|
86049
87351
|
*/
|
|
86050
|
-
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId,
|
|
86051
|
-
opts = opts || {};
|
|
86052
|
-
|
|
87352
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, body) {
|
|
86053
87353
|
// verify the required parameter 'managementUnitId' is set
|
|
86054
87354
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86055
87355
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
86056
87356
|
}
|
|
87357
|
+
// verify the required parameter 'body' is set
|
|
87358
|
+
if (body === undefined || body === null) {
|
|
87359
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
87360
|
+
}
|
|
86057
87361
|
|
|
86058
87362
|
return this.apiClient.callApi(
|
|
86059
87363
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
@@ -86062,7 +87366,7 @@ class WorkforceManagementApi {
|
|
|
86062
87366
|
{ },
|
|
86063
87367
|
{ },
|
|
86064
87368
|
{ },
|
|
86065
|
-
|
|
87369
|
+
body,
|
|
86066
87370
|
['PureCloud OAuth'],
|
|
86067
87371
|
['application/json'],
|
|
86068
87372
|
['application/json']
|
|
@@ -86073,17 +87377,21 @@ class WorkforceManagementApi {
|
|
|
86073
87377
|
* Create a new work plan
|
|
86074
87378
|
*
|
|
86075
87379
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
87380
|
+
* @param {Object} body body
|
|
86076
87381
|
* @param {Object} opts Optional parameters
|
|
86077
87382
|
* @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
|
|
86078
|
-
* @param {Object} opts.body body
|
|
86079
87383
|
*/
|
|
86080
|
-
postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
87384
|
+
postWorkforcemanagementManagementunitWorkplans(managementUnitId, body, opts) {
|
|
86081
87385
|
opts = opts || {};
|
|
86082
87386
|
|
|
86083
87387
|
// verify the required parameter 'managementUnitId' is set
|
|
86084
87388
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86085
87389
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplans';
|
|
86086
87390
|
}
|
|
87391
|
+
// verify the required parameter 'body' is set
|
|
87392
|
+
if (body === undefined || body === null) {
|
|
87393
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplans';
|
|
87394
|
+
}
|
|
86087
87395
|
|
|
86088
87396
|
return this.apiClient.callApi(
|
|
86089
87397
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
@@ -86092,7 +87400,7 @@ class WorkforceManagementApi {
|
|
|
86092
87400
|
{ 'validationMode': opts['validationMode'] },
|
|
86093
87401
|
{ },
|
|
86094
87402
|
{ },
|
|
86095
|
-
|
|
87403
|
+
body,
|
|
86096
87404
|
['PureCloud OAuth'],
|
|
86097
87405
|
['application/json'],
|
|
86098
87406
|
['application/json']
|
|
@@ -86102,12 +87410,13 @@ class WorkforceManagementApi {
|
|
|
86102
87410
|
/**
|
|
86103
87411
|
* Add a management unit
|
|
86104
87412
|
* It may take a minute or two for a new management unit to be available for api operations
|
|
86105
|
-
* @param {Object}
|
|
86106
|
-
* @param {Object} opts.body body
|
|
87413
|
+
* @param {Object} body body
|
|
86107
87414
|
*/
|
|
86108
|
-
postWorkforcemanagementManagementunits(
|
|
86109
|
-
|
|
86110
|
-
|
|
87415
|
+
postWorkforcemanagementManagementunits(body) {
|
|
87416
|
+
// verify the required parameter 'body' is set
|
|
87417
|
+
if (body === undefined || body === null) {
|
|
87418
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunits';
|
|
87419
|
+
}
|
|
86111
87420
|
|
|
86112
87421
|
return this.apiClient.callApi(
|
|
86113
87422
|
'/api/v2/workforcemanagement/managementunits',
|
|
@@ -86116,7 +87425,7 @@ class WorkforceManagementApi {
|
|
|
86116
87425
|
{ },
|
|
86117
87426
|
{ },
|
|
86118
87427
|
{ },
|
|
86119
|
-
|
|
87428
|
+
body,
|
|
86120
87429
|
['PureCloud OAuth'],
|
|
86121
87430
|
['application/json'],
|
|
86122
87431
|
['application/json']
|
|
@@ -86126,12 +87435,13 @@ class WorkforceManagementApi {
|
|
|
86126
87435
|
/**
|
|
86127
87436
|
* Mark a list of notifications as read or unread
|
|
86128
87437
|
*
|
|
86129
|
-
* @param {Object}
|
|
86130
|
-
* @param {Object} opts.body body
|
|
87438
|
+
* @param {Object} body body
|
|
86131
87439
|
*/
|
|
86132
|
-
postWorkforcemanagementNotificationsUpdate(
|
|
86133
|
-
|
|
86134
|
-
|
|
87440
|
+
postWorkforcemanagementNotificationsUpdate(body) {
|
|
87441
|
+
// verify the required parameter 'body' is set
|
|
87442
|
+
if (body === undefined || body === null) {
|
|
87443
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementNotificationsUpdate';
|
|
87444
|
+
}
|
|
86135
87445
|
|
|
86136
87446
|
return this.apiClient.callApi(
|
|
86137
87447
|
'/api/v2/workforcemanagement/notifications/update',
|
|
@@ -86140,7 +87450,7 @@ class WorkforceManagementApi {
|
|
|
86140
87450
|
{ },
|
|
86141
87451
|
{ },
|
|
86142
87452
|
{ },
|
|
86143
|
-
|
|
87453
|
+
body,
|
|
86144
87454
|
['PureCloud OAuth'],
|
|
86145
87455
|
['application/json'],
|
|
86146
87456
|
['application/json']
|
|
@@ -86176,16 +87486,17 @@ class WorkforceManagementApi {
|
|
|
86176
87486
|
* Request a teams historical adherence report
|
|
86177
87487
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
86178
87488
|
* @param {String} teamId The ID of the team
|
|
86179
|
-
* @param {Object}
|
|
86180
|
-
* @param {Object} opts.body body
|
|
87489
|
+
* @param {Object} body body
|
|
86181
87490
|
*/
|
|
86182
|
-
postWorkforcemanagementTeamAdherenceHistorical(teamId,
|
|
86183
|
-
opts = opts || {};
|
|
86184
|
-
|
|
87491
|
+
postWorkforcemanagementTeamAdherenceHistorical(teamId, body) {
|
|
86185
87492
|
// verify the required parameter 'teamId' is set
|
|
86186
87493
|
if (teamId === undefined || teamId === null) {
|
|
86187
87494
|
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';
|
|
86188
87495
|
}
|
|
87496
|
+
// verify the required parameter 'body' is set
|
|
87497
|
+
if (body === undefined || body === null) {
|
|
87498
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTeamAdherenceHistorical';
|
|
87499
|
+
}
|
|
86189
87500
|
|
|
86190
87501
|
return this.apiClient.callApi(
|
|
86191
87502
|
'/api/v2/workforcemanagement/teams/{teamId}/adherence/historical',
|
|
@@ -86194,7 +87505,7 @@ class WorkforceManagementApi {
|
|
|
86194
87505
|
{ },
|
|
86195
87506
|
{ },
|
|
86196
87507
|
{ },
|
|
86197
|
-
|
|
87508
|
+
body,
|
|
86198
87509
|
['PureCloud OAuth'],
|
|
86199
87510
|
['application/json'],
|
|
86200
87511
|
['application/json']
|
|
@@ -86205,16 +87516,17 @@ class WorkforceManagementApi {
|
|
|
86205
87516
|
* Request a historical shrinkage report
|
|
86206
87517
|
* The maximum supported range for historical shrinkage queries is up to 32 days
|
|
86207
87518
|
* @param {String} teamId The ID of the team
|
|
86208
|
-
* @param {Object}
|
|
86209
|
-
* @param {Object} opts.body body
|
|
87519
|
+
* @param {Object} body body
|
|
86210
87520
|
*/
|
|
86211
|
-
postWorkforcemanagementTeamShrinkageJobs(teamId,
|
|
86212
|
-
opts = opts || {};
|
|
86213
|
-
|
|
87521
|
+
postWorkforcemanagementTeamShrinkageJobs(teamId, body) {
|
|
86214
87522
|
// verify the required parameter 'teamId' is set
|
|
86215
87523
|
if (teamId === undefined || teamId === null) {
|
|
86216
87524
|
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';
|
|
86217
87525
|
}
|
|
87526
|
+
// verify the required parameter 'body' is set
|
|
87527
|
+
if (body === undefined || body === null) {
|
|
87528
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTeamShrinkageJobs';
|
|
87529
|
+
}
|
|
86218
87530
|
|
|
86219
87531
|
return this.apiClient.callApi(
|
|
86220
87532
|
'/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs',
|
|
@@ -86223,7 +87535,7 @@ class WorkforceManagementApi {
|
|
|
86223
87535
|
{ },
|
|
86224
87536
|
{ },
|
|
86225
87537
|
{ },
|
|
86226
|
-
|
|
87538
|
+
body,
|
|
86227
87539
|
['PureCloud OAuth'],
|
|
86228
87540
|
['application/json'],
|
|
86229
87541
|
['application/json']
|
|
@@ -86258,12 +87570,13 @@ class WorkforceManagementApi {
|
|
|
86258
87570
|
/**
|
|
86259
87571
|
* Queries available time off for the current user
|
|
86260
87572
|
*
|
|
86261
|
-
* @param {Object}
|
|
86262
|
-
* @param {Object} opts.body body
|
|
87573
|
+
* @param {Object} body body
|
|
86263
87574
|
*/
|
|
86264
|
-
postWorkforcemanagementTimeofflimitsAvailableQuery(
|
|
86265
|
-
|
|
86266
|
-
|
|
87575
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(body) {
|
|
87576
|
+
// verify the required parameter 'body' is set
|
|
87577
|
+
if (body === undefined || body === null) {
|
|
87578
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeofflimitsAvailableQuery';
|
|
87579
|
+
}
|
|
86267
87580
|
|
|
86268
87581
|
return this.apiClient.callApi(
|
|
86269
87582
|
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
@@ -86272,7 +87585,7 @@ class WorkforceManagementApi {
|
|
|
86272
87585
|
{ },
|
|
86273
87586
|
{ },
|
|
86274
87587
|
{ },
|
|
86275
|
-
|
|
87588
|
+
body,
|
|
86276
87589
|
['PureCloud OAuth'],
|
|
86277
87590
|
['application/json'],
|
|
86278
87591
|
['application/json']
|
|
@@ -86282,12 +87595,13 @@ class WorkforceManagementApi {
|
|
|
86282
87595
|
/**
|
|
86283
87596
|
* Create a time off request for the current user
|
|
86284
87597
|
*
|
|
86285
|
-
* @param {Object}
|
|
86286
|
-
* @param {Object} opts.body body
|
|
87598
|
+
* @param {Object} body body
|
|
86287
87599
|
*/
|
|
86288
|
-
postWorkforcemanagementTimeoffrequests(
|
|
86289
|
-
|
|
86290
|
-
|
|
87600
|
+
postWorkforcemanagementTimeoffrequests(body) {
|
|
87601
|
+
// verify the required parameter 'body' is set
|
|
87602
|
+
if (body === undefined || body === null) {
|
|
87603
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequests';
|
|
87604
|
+
}
|
|
86291
87605
|
|
|
86292
87606
|
return this.apiClient.callApi(
|
|
86293
87607
|
'/api/v2/workforcemanagement/timeoffrequests',
|
|
@@ -86296,7 +87610,7 @@ class WorkforceManagementApi {
|
|
|
86296
87610
|
{ },
|
|
86297
87611
|
{ },
|
|
86298
87612
|
{ },
|
|
86299
|
-
|
|
87613
|
+
body,
|
|
86300
87614
|
['PureCloud OAuth'],
|
|
86301
87615
|
['application/json'],
|
|
86302
87616
|
['application/json']
|
|
@@ -86306,12 +87620,13 @@ class WorkforceManagementApi {
|
|
|
86306
87620
|
/**
|
|
86307
87621
|
* Estimates available time off for current user
|
|
86308
87622
|
*
|
|
86309
|
-
* @param {Object}
|
|
86310
|
-
* @param {Object} opts.body body
|
|
87623
|
+
* @param {Object} body body
|
|
86311
87624
|
*/
|
|
86312
|
-
postWorkforcemanagementTimeoffrequestsEstimate(
|
|
86313
|
-
|
|
86314
|
-
|
|
87625
|
+
postWorkforcemanagementTimeoffrequestsEstimate(body) {
|
|
87626
|
+
// verify the required parameter 'body' is set
|
|
87627
|
+
if (body === undefined || body === null) {
|
|
87628
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequestsEstimate';
|
|
87629
|
+
}
|
|
86315
87630
|
|
|
86316
87631
|
return this.apiClient.callApi(
|
|
86317
87632
|
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
@@ -86320,7 +87635,7 @@ class WorkforceManagementApi {
|
|
|
86320
87635
|
{ },
|
|
86321
87636
|
{ },
|
|
86322
87637
|
{ },
|
|
86323
|
-
|
|
87638
|
+
body,
|
|
86324
87639
|
['PureCloud OAuth'],
|
|
86325
87640
|
['application/json'],
|
|
86326
87641
|
['application/json']
|
|
@@ -86330,12 +87645,13 @@ class WorkforceManagementApi {
|
|
|
86330
87645
|
/**
|
|
86331
87646
|
* Retrieves integration statuses for a list of current user time off requests
|
|
86332
87647
|
*
|
|
86333
|
-
* @param {Object}
|
|
86334
|
-
* @param {Object} opts.body body
|
|
87648
|
+
* @param {Object} body body
|
|
86335
87649
|
*/
|
|
86336
|
-
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(
|
|
86337
|
-
|
|
86338
|
-
|
|
87650
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(body) {
|
|
87651
|
+
// verify the required parameter 'body' is set
|
|
87652
|
+
if (body === undefined || body === null) {
|
|
87653
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery';
|
|
87654
|
+
}
|
|
86339
87655
|
|
|
86340
87656
|
return this.apiClient.callApi(
|
|
86341
87657
|
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
@@ -86344,7 +87660,7 @@ class WorkforceManagementApi {
|
|
|
86344
87660
|
{ },
|
|
86345
87661
|
{ },
|
|
86346
87662
|
{ },
|
|
86347
|
-
|
|
87663
|
+
body,
|
|
86348
87664
|
['PureCloud OAuth'],
|
|
86349
87665
|
['application/json'],
|
|
86350
87666
|
['application/json']
|
|
@@ -86386,12 +87702,9 @@ class WorkforceManagementApi {
|
|
|
86386
87702
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
86387
87703
|
* @param {String} businessUnitId The ID of the business unit
|
|
86388
87704
|
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
86389
|
-
* @param {Object}
|
|
86390
|
-
* @param {Object} opts.body body
|
|
87705
|
+
* @param {Object} body body
|
|
86391
87706
|
*/
|
|
86392
|
-
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId,
|
|
86393
|
-
opts = opts || {};
|
|
86394
|
-
|
|
87707
|
+
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId, body) {
|
|
86395
87708
|
// verify the required parameter 'businessUnitId' is set
|
|
86396
87709
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
86397
87710
|
throw 'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
@@ -86400,6 +87713,10 @@ class WorkforceManagementApi {
|
|
|
86400
87713
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
86401
87714
|
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
86402
87715
|
}
|
|
87716
|
+
// verify the required parameter 'body' is set
|
|
87717
|
+
if (body === undefined || body === null) {
|
|
87718
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
87719
|
+
}
|
|
86403
87720
|
|
|
86404
87721
|
return this.apiClient.callApi(
|
|
86405
87722
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
@@ -86408,7 +87725,7 @@ class WorkforceManagementApi {
|
|
|
86408
87725
|
{ },
|
|
86409
87726
|
{ },
|
|
86410
87727
|
{ },
|
|
86411
|
-
|
|
87728
|
+
body,
|
|
86412
87729
|
['PureCloud OAuth'],
|
|
86413
87730
|
['application/json'],
|
|
86414
87731
|
['application/json']
|
|
@@ -86420,12 +87737,9 @@ class WorkforceManagementApi {
|
|
|
86420
87737
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
86421
87738
|
* @param {String} managementUnitId The ID of the management unit.
|
|
86422
87739
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
86423
|
-
* @param {Object}
|
|
86424
|
-
* @param {Object} opts.body body
|
|
87740
|
+
* @param {Object} body body
|
|
86425
87741
|
*/
|
|
86426
|
-
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId,
|
|
86427
|
-
opts = opts || {};
|
|
86428
|
-
|
|
87742
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, body) {
|
|
86429
87743
|
// verify the required parameter 'managementUnitId' is set
|
|
86430
87744
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86431
87745
|
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
@@ -86434,6 +87748,10 @@ class WorkforceManagementApi {
|
|
|
86434
87748
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
86435
87749
|
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
86436
87750
|
}
|
|
87751
|
+
// verify the required parameter 'body' is set
|
|
87752
|
+
if (body === undefined || body === null) {
|
|
87753
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
87754
|
+
}
|
|
86437
87755
|
|
|
86438
87756
|
return this.apiClient.callApi(
|
|
86439
87757
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
@@ -86442,7 +87760,7 @@ class WorkforceManagementApi {
|
|
|
86442
87760
|
{ },
|
|
86443
87761
|
{ },
|
|
86444
87762
|
{ },
|
|
86445
|
-
|
|
87763
|
+
body,
|
|
86446
87764
|
['PureCloud OAuth'],
|
|
86447
87765
|
['application/json'],
|
|
86448
87766
|
['application/json']
|
|
@@ -86480,7 +87798,7 @@ class WorkforceManagementApi {
|
|
|
86480
87798
|
* </pre>
|
|
86481
87799
|
* </p>
|
|
86482
87800
|
* @module purecloud-platform-client-v2/index
|
|
86483
|
-
* @version
|
|
87801
|
+
* @version 224.0.0
|
|
86484
87802
|
*/
|
|
86485
87803
|
class platformClient {
|
|
86486
87804
|
constructor() {
|
|
@@ -86494,6 +87812,11 @@ class platformClient {
|
|
|
86494
87812
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
86495
87813
|
*/
|
|
86496
87814
|
this.ApiClientClass = ApiClient;
|
|
87815
|
+
/**
|
|
87816
|
+
* The AIStudioApi service constructor.
|
|
87817
|
+
* @property {module:purecloud-platform-client-v2/api/AIStudioApi}
|
|
87818
|
+
*/
|
|
87819
|
+
this.AIStudioApi = AIStudioApi;
|
|
86497
87820
|
/**
|
|
86498
87821
|
* The AgentAssistantsApi service constructor.
|
|
86499
87822
|
* @property {module:purecloud-platform-client-v2/api/AgentAssistantsApi}
|