purecloud-platform-client-v2 152.0.0 → 154.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +485 -81
- package/dist/web-amd/purecloud-platform-client-v2.js +485 -81
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +485 -81
- package/dist/web-cjs/purecloud-platform-client-v2.js +485 -81
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +784 -207
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -2
- 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/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/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +31 -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 +6 -6
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +325 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 154.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1478,7 +1478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1478
1478
|
/**
|
|
1479
1479
|
* Alerting service.
|
|
1480
1480
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1481
|
-
* @version
|
|
1481
|
+
* @version 154.0.0
|
|
1482
1482
|
*/
|
|
1483
1483
|
|
|
1484
1484
|
/**
|
|
@@ -1792,7 +1792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1792
1792
|
/**
|
|
1793
1793
|
* Analytics service.
|
|
1794
1794
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1795
|
-
* @version
|
|
1795
|
+
* @version 154.0.0
|
|
1796
1796
|
*/
|
|
1797
1797
|
|
|
1798
1798
|
/**
|
|
@@ -1808,7 +1808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1808
1808
|
|
|
1809
1809
|
|
|
1810
1810
|
/**
|
|
1811
|
-
* Delete/cancel an async
|
|
1811
|
+
* Delete/cancel an async details job
|
|
1812
1812
|
*
|
|
1813
1813
|
* @param {String} jobId jobId
|
|
1814
1814
|
*/
|
|
@@ -1892,6 +1892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1892
1892
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
1893
1893
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
1894
1894
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
1895
|
+
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
1895
1896
|
*/
|
|
1896
1897
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
1897
1898
|
opts = opts || {};
|
|
@@ -1905,7 +1906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1905
1906
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
1906
1907
|
'GET',
|
|
1907
1908
|
{ 'botFlowId': botFlowId },
|
|
1908
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
1909
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
1909
1910
|
{ },
|
|
1910
1911
|
{ },
|
|
1911
1912
|
null,
|
|
@@ -1990,7 +1991,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1990
1991
|
}
|
|
1991
1992
|
|
|
1992
1993
|
/**
|
|
1993
|
-
* Fetch a page of results for an async
|
|
1994
|
+
* Fetch a page of results for an async details job
|
|
1994
1995
|
*
|
|
1995
1996
|
* @param {String} jobId jobId
|
|
1996
1997
|
* @param {Object} opts Optional parameters
|
|
@@ -3045,7 +3046,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3045
3046
|
/**
|
|
3046
3047
|
* Architect service.
|
|
3047
3048
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3048
|
-
* @version
|
|
3049
|
+
* @version 154.0.0
|
|
3049
3050
|
*/
|
|
3050
3051
|
|
|
3051
3052
|
/**
|
|
@@ -3804,6 +3805,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3804
3805
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
3805
3806
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
3806
3807
|
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
3808
|
+
* @param {String} opts.scheduleGroup The Schedule Group of the IVR to filter by.
|
|
3807
3809
|
*/
|
|
3808
3810
|
getArchitectIvrs(opts) {
|
|
3809
3811
|
opts = opts || {};
|
|
@@ -3813,7 +3815,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3813
3815
|
'/api/v2/architect/ivrs',
|
|
3814
3816
|
'GET',
|
|
3815
3817
|
{ },
|
|
3816
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
3818
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'] },
|
|
3817
3819
|
{ },
|
|
3818
3820
|
{ },
|
|
3819
3821
|
null,
|
|
@@ -6092,7 +6094,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6092
6094
|
/**
|
|
6093
6095
|
* Audit service.
|
|
6094
6096
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6095
|
-
* @version
|
|
6097
|
+
* @version 154.0.0
|
|
6096
6098
|
*/
|
|
6097
6099
|
|
|
6098
6100
|
/**
|
|
@@ -6263,7 +6265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6263
6265
|
/**
|
|
6264
6266
|
* Authorization service.
|
|
6265
6267
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6266
|
-
* @version
|
|
6268
|
+
* @version 154.0.0
|
|
6267
6269
|
*/
|
|
6268
6270
|
|
|
6269
6271
|
/**
|
|
@@ -6796,6 +6798,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6796
6798
|
);
|
|
6797
6799
|
}
|
|
6798
6800
|
|
|
6801
|
+
/**
|
|
6802
|
+
* Get authorization settings
|
|
6803
|
+
*
|
|
6804
|
+
*/
|
|
6805
|
+
getAuthorizationSettings() {
|
|
6806
|
+
|
|
6807
|
+
return this.apiClient.callApi(
|
|
6808
|
+
'/api/v2/authorization/settings',
|
|
6809
|
+
'GET',
|
|
6810
|
+
{ },
|
|
6811
|
+
{ },
|
|
6812
|
+
{ },
|
|
6813
|
+
{ },
|
|
6814
|
+
null,
|
|
6815
|
+
['PureCloud OAuth'],
|
|
6816
|
+
['application/json'],
|
|
6817
|
+
['application/json']
|
|
6818
|
+
);
|
|
6819
|
+
}
|
|
6820
|
+
|
|
6799
6821
|
/**
|
|
6800
6822
|
* Returns a listing of roles and permissions for a user.
|
|
6801
6823
|
*
|
|
@@ -6920,6 +6942,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6920
6942
|
);
|
|
6921
6943
|
}
|
|
6922
6944
|
|
|
6945
|
+
/**
|
|
6946
|
+
* Change authorization settings
|
|
6947
|
+
* Change authorization settings
|
|
6948
|
+
* @param {Object} body Authorization Settings
|
|
6949
|
+
*/
|
|
6950
|
+
patchAuthorizationSettings(body) {
|
|
6951
|
+
// verify the required parameter 'body' is set
|
|
6952
|
+
if (body === undefined || body === null) {
|
|
6953
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
6954
|
+
}
|
|
6955
|
+
|
|
6956
|
+
return this.apiClient.callApi(
|
|
6957
|
+
'/api/v2/authorization/settings',
|
|
6958
|
+
'PATCH',
|
|
6959
|
+
{ },
|
|
6960
|
+
{ },
|
|
6961
|
+
{ },
|
|
6962
|
+
{ },
|
|
6963
|
+
body,
|
|
6964
|
+
['PureCloud OAuth'],
|
|
6965
|
+
['application/json'],
|
|
6966
|
+
['application/json']
|
|
6967
|
+
);
|
|
6968
|
+
}
|
|
6969
|
+
|
|
6923
6970
|
/**
|
|
6924
6971
|
* Assign a list of objects to a division
|
|
6925
6972
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
@@ -7446,7 +7493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7446
7493
|
/**
|
|
7447
7494
|
* Billing service.
|
|
7448
7495
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7449
|
-
* @version
|
|
7496
|
+
* @version 154.0.0
|
|
7450
7497
|
*/
|
|
7451
7498
|
|
|
7452
7499
|
/**
|
|
@@ -7526,7 +7573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7526
7573
|
/**
|
|
7527
7574
|
* Chat service.
|
|
7528
7575
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7529
|
-
* @version
|
|
7576
|
+
* @version 154.0.0
|
|
7530
7577
|
*/
|
|
7531
7578
|
|
|
7532
7579
|
/**
|
|
@@ -7617,7 +7664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7617
7664
|
/**
|
|
7618
7665
|
* Coaching service.
|
|
7619
7666
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7620
|
-
* @version
|
|
7667
|
+
* @version 154.0.0
|
|
7621
7668
|
*/
|
|
7622
7669
|
|
|
7623
7670
|
/**
|
|
@@ -8194,7 +8241,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8194
8241
|
/**
|
|
8195
8242
|
* ContentManagement service.
|
|
8196
8243
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8197
|
-
* @version
|
|
8244
|
+
* @version 154.0.0
|
|
8198
8245
|
*/
|
|
8199
8246
|
|
|
8200
8247
|
/**
|
|
@@ -9334,7 +9381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9334
9381
|
/**
|
|
9335
9382
|
* Conversations service.
|
|
9336
9383
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9337
|
-
* @version
|
|
9384
|
+
* @version 154.0.0
|
|
9338
9385
|
*/
|
|
9339
9386
|
|
|
9340
9387
|
/**
|
|
@@ -9350,7 +9397,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9350
9397
|
|
|
9351
9398
|
|
|
9352
9399
|
/**
|
|
9353
|
-
* Delete/cancel an async
|
|
9400
|
+
* Delete/cancel an async details job
|
|
9354
9401
|
*
|
|
9355
9402
|
* @param {String} jobId jobId
|
|
9356
9403
|
*/
|
|
@@ -9724,7 +9771,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9724
9771
|
}
|
|
9725
9772
|
|
|
9726
9773
|
/**
|
|
9727
|
-
* Fetch a page of results for an async
|
|
9774
|
+
* Fetch a page of results for an async details job
|
|
9728
9775
|
*
|
|
9729
9776
|
* @param {String} jobId jobId
|
|
9730
9777
|
* @param {Object} opts Optional parameters
|
|
@@ -14557,7 +14604,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14557
14604
|
/**
|
|
14558
14605
|
* DataExtensions service.
|
|
14559
14606
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14560
|
-
* @version
|
|
14607
|
+
* @version 154.0.0
|
|
14561
14608
|
*/
|
|
14562
14609
|
|
|
14563
14610
|
/**
|
|
@@ -14643,7 +14690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14643
14690
|
/**
|
|
14644
14691
|
* Downloads service.
|
|
14645
14692
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14646
|
-
* @version
|
|
14693
|
+
* @version 154.0.0
|
|
14647
14694
|
*/
|
|
14648
14695
|
|
|
14649
14696
|
/**
|
|
@@ -14695,7 +14742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14695
14742
|
/**
|
|
14696
14743
|
* Events service.
|
|
14697
14744
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14698
|
-
* @version
|
|
14745
|
+
* @version 154.0.0
|
|
14699
14746
|
*/
|
|
14700
14747
|
|
|
14701
14748
|
/**
|
|
@@ -14791,7 +14838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14791
14838
|
/**
|
|
14792
14839
|
* ExternalContacts service.
|
|
14793
14840
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14794
|
-
* @version
|
|
14841
|
+
* @version 154.0.0
|
|
14795
14842
|
*/
|
|
14796
14843
|
|
|
14797
14844
|
/**
|
|
@@ -16749,7 +16796,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16749
16796
|
/**
|
|
16750
16797
|
* Fax service.
|
|
16751
16798
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16752
|
-
* @version
|
|
16799
|
+
* @version 154.0.0
|
|
16753
16800
|
*/
|
|
16754
16801
|
|
|
16755
16802
|
/**
|
|
@@ -16920,7 +16967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16920
16967
|
/**
|
|
16921
16968
|
* Flows service.
|
|
16922
16969
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16923
|
-
* @version
|
|
16970
|
+
* @version 154.0.0
|
|
16924
16971
|
*/
|
|
16925
16972
|
|
|
16926
16973
|
/**
|
|
@@ -16991,7 +17038,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16991
17038
|
/**
|
|
16992
17039
|
* Gamification service.
|
|
16993
17040
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16994
|
-
* @version
|
|
17041
|
+
* @version 154.0.0
|
|
16995
17042
|
*/
|
|
16996
17043
|
|
|
16997
17044
|
/**
|
|
@@ -18608,7 +18655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18608
18655
|
/**
|
|
18609
18656
|
* GeneralDataProtectionRegulation service.
|
|
18610
18657
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18611
|
-
* @version
|
|
18658
|
+
* @version 154.0.0
|
|
18612
18659
|
*/
|
|
18613
18660
|
|
|
18614
18661
|
/**
|
|
@@ -18738,7 +18785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18738
18785
|
/**
|
|
18739
18786
|
* Geolocation service.
|
|
18740
18787
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18741
|
-
* @version
|
|
18788
|
+
* @version 154.0.0
|
|
18742
18789
|
*/
|
|
18743
18790
|
|
|
18744
18791
|
/**
|
|
@@ -18869,7 +18916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18869
18916
|
/**
|
|
18870
18917
|
* Greetings service.
|
|
18871
18918
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18872
|
-
* @version
|
|
18919
|
+
* @version 154.0.0
|
|
18873
18920
|
*/
|
|
18874
18921
|
|
|
18875
18922
|
/**
|
|
@@ -19324,7 +19371,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19324
19371
|
/**
|
|
19325
19372
|
* Groups service.
|
|
19326
19373
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19327
|
-
* @version
|
|
19374
|
+
* @version 154.0.0
|
|
19328
19375
|
*/
|
|
19329
19376
|
|
|
19330
19377
|
/**
|
|
@@ -19730,7 +19777,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19730
19777
|
/**
|
|
19731
19778
|
* IdentityProvider service.
|
|
19732
19779
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19733
|
-
* @version
|
|
19780
|
+
* @version 154.0.0
|
|
19734
19781
|
*/
|
|
19735
19782
|
|
|
19736
19783
|
/**
|
|
@@ -20486,7 +20533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20486
20533
|
/**
|
|
20487
20534
|
* Integrations service.
|
|
20488
20535
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20489
|
-
* @version
|
|
20536
|
+
* @version 154.0.0
|
|
20490
20537
|
*/
|
|
20491
20538
|
|
|
20492
20539
|
/**
|
|
@@ -22086,7 +22133,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22086
22133
|
/**
|
|
22087
22134
|
* Journey service.
|
|
22088
22135
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22089
|
-
* @version
|
|
22136
|
+
* @version 154.0.0
|
|
22090
22137
|
*/
|
|
22091
22138
|
|
|
22092
22139
|
/**
|
|
@@ -22872,7 +22919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22872
22919
|
/**
|
|
22873
22920
|
* Knowledge service.
|
|
22874
22921
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22875
|
-
* @version
|
|
22922
|
+
* @version 154.0.0
|
|
22876
22923
|
*/
|
|
22877
22924
|
|
|
22878
22925
|
/**
|
|
@@ -25305,7 +25352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25305
25352
|
/**
|
|
25306
25353
|
* LanguageUnderstanding service.
|
|
25307
25354
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25308
|
-
* @version
|
|
25355
|
+
* @version 154.0.0
|
|
25309
25356
|
*/
|
|
25310
25357
|
|
|
25311
25358
|
/**
|
|
@@ -26209,7 +26256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26209
26256
|
/**
|
|
26210
26257
|
* Languages service.
|
|
26211
26258
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26212
|
-
* @version
|
|
26259
|
+
* @version 154.0.0
|
|
26213
26260
|
*/
|
|
26214
26261
|
|
|
26215
26262
|
/**
|
|
@@ -26477,7 +26524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26477
26524
|
/**
|
|
26478
26525
|
* Learning service.
|
|
26479
26526
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26480
|
-
* @version
|
|
26527
|
+
* @version 154.0.0
|
|
26481
26528
|
*/
|
|
26482
26529
|
|
|
26483
26530
|
/**
|
|
@@ -26777,6 +26824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26777
26824
|
* @param {String} opts.searchTerm Search Term (searchable by name)
|
|
26778
26825
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
26779
26826
|
* @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
|
|
26827
|
+
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
26780
26828
|
*/
|
|
26781
26829
|
getLearningModules(opts) {
|
|
26782
26830
|
opts = opts || {};
|
|
@@ -26786,7 +26834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26786
26834
|
'/api/v2/learning/modules',
|
|
26787
26835
|
'GET',
|
|
26788
26836
|
{ },
|
|
26789
|
-
{ 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'] },
|
|
26837
|
+
{ 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi') },
|
|
26790
26838
|
{ },
|
|
26791
26839
|
{ },
|
|
26792
26840
|
null,
|
|
@@ -27237,7 +27285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27237
27285
|
/**
|
|
27238
27286
|
* License service.
|
|
27239
27287
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27240
|
-
* @version
|
|
27288
|
+
* @version 154.0.0
|
|
27241
27289
|
*/
|
|
27242
27290
|
|
|
27243
27291
|
/**
|
|
@@ -27475,7 +27523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27475
27523
|
/**
|
|
27476
27524
|
* Locations service.
|
|
27477
27525
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27478
|
-
* @version
|
|
27526
|
+
* @version 154.0.0
|
|
27479
27527
|
*/
|
|
27480
27528
|
|
|
27481
27529
|
/**
|
|
@@ -27711,7 +27759,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27711
27759
|
/**
|
|
27712
27760
|
* Messaging service.
|
|
27713
27761
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27714
|
-
* @version
|
|
27762
|
+
* @version 154.0.0
|
|
27715
27763
|
*/
|
|
27716
27764
|
|
|
27717
27765
|
/**
|
|
@@ -27862,7 +27910,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27862
27910
|
/**
|
|
27863
27911
|
* MobileDevices service.
|
|
27864
27912
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27865
|
-
* @version
|
|
27913
|
+
* @version 154.0.0
|
|
27866
27914
|
*/
|
|
27867
27915
|
|
|
27868
27916
|
/**
|
|
@@ -28013,7 +28061,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28013
28061
|
/**
|
|
28014
28062
|
* Notifications service.
|
|
28015
28063
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28016
|
-
* @version
|
|
28064
|
+
* @version 154.0.0
|
|
28017
28065
|
*/
|
|
28018
28066
|
|
|
28019
28067
|
/**
|
|
@@ -28238,7 +28286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28238
28286
|
/**
|
|
28239
28287
|
* OAuth service.
|
|
28240
28288
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28241
|
-
* @version
|
|
28289
|
+
* @version 154.0.0
|
|
28242
28290
|
*/
|
|
28243
28291
|
|
|
28244
28292
|
/**
|
|
@@ -28604,7 +28652,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28604
28652
|
/**
|
|
28605
28653
|
* Objects service.
|
|
28606
28654
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28607
|
-
* @version
|
|
28655
|
+
* @version 154.0.0
|
|
28608
28656
|
*/
|
|
28609
28657
|
|
|
28610
28658
|
/**
|
|
@@ -28875,7 +28923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28875
28923
|
/**
|
|
28876
28924
|
* Organization service.
|
|
28877
28925
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28878
|
-
* @version
|
|
28926
|
+
* @version 154.0.0
|
|
28879
28927
|
*/
|
|
28880
28928
|
|
|
28881
28929
|
/**
|
|
@@ -29278,7 +29326,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29278
29326
|
/**
|
|
29279
29327
|
* OrganizationAuthorization service.
|
|
29280
29328
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29281
|
-
* @version
|
|
29329
|
+
* @version 154.0.0
|
|
29282
29330
|
*/
|
|
29283
29331
|
|
|
29284
29332
|
/**
|
|
@@ -30203,7 +30251,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30203
30251
|
/**
|
|
30204
30252
|
* Outbound service.
|
|
30205
30253
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30206
|
-
* @version
|
|
30254
|
+
* @version 154.0.0
|
|
30207
30255
|
*/
|
|
30208
30256
|
|
|
30209
30257
|
/**
|
|
@@ -32827,6 +32875,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32827
32875
|
);
|
|
32828
32876
|
}
|
|
32829
32877
|
|
|
32878
|
+
/**
|
|
32879
|
+
* Add email addresses to a DNC list.
|
|
32880
|
+
* Only Internal DNC lists may be appended to
|
|
32881
|
+
* @param {String} dncListId DncList ID
|
|
32882
|
+
* @param {Array.<String>} body DNC email addresses
|
|
32883
|
+
*/
|
|
32884
|
+
postOutboundDnclistEmailaddresses(dncListId, body) {
|
|
32885
|
+
// verify the required parameter 'dncListId' is set
|
|
32886
|
+
if (dncListId === undefined || dncListId === null) {
|
|
32887
|
+
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistEmailaddresses';
|
|
32888
|
+
}
|
|
32889
|
+
// verify the required parameter 'body' is set
|
|
32890
|
+
if (body === undefined || body === null) {
|
|
32891
|
+
throw 'Missing the required parameter "body" when calling postOutboundDnclistEmailaddresses';
|
|
32892
|
+
}
|
|
32893
|
+
|
|
32894
|
+
return this.apiClient.callApi(
|
|
32895
|
+
'/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
|
|
32896
|
+
'POST',
|
|
32897
|
+
{ 'dncListId': dncListId },
|
|
32898
|
+
{ },
|
|
32899
|
+
{ },
|
|
32900
|
+
{ },
|
|
32901
|
+
body,
|
|
32902
|
+
['PureCloud OAuth'],
|
|
32903
|
+
['application/json'],
|
|
32904
|
+
['application/json']
|
|
32905
|
+
);
|
|
32906
|
+
}
|
|
32907
|
+
|
|
32830
32908
|
/**
|
|
32831
32909
|
* Initiate the export of a dnc list.
|
|
32832
32910
|
* Returns 200 if received OK.
|
|
@@ -33592,7 +33670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33592
33670
|
/**
|
|
33593
33671
|
* Presence service.
|
|
33594
33672
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33595
|
-
* @version
|
|
33673
|
+
* @version 154.0.0
|
|
33596
33674
|
*/
|
|
33597
33675
|
|
|
33598
33676
|
/**
|
|
@@ -34098,7 +34176,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34098
34176
|
/**
|
|
34099
34177
|
* ProcessAutomation service.
|
|
34100
34178
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34101
|
-
* @version
|
|
34179
|
+
* @version 154.0.0
|
|
34102
34180
|
*/
|
|
34103
34181
|
|
|
34104
34182
|
/**
|
|
@@ -34336,7 +34414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34336
34414
|
/**
|
|
34337
34415
|
* Quality service.
|
|
34338
34416
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34339
|
-
* @version
|
|
34417
|
+
* @version 154.0.0
|
|
34340
34418
|
*/
|
|
34341
34419
|
|
|
34342
34420
|
/**
|
|
@@ -35914,7 +35992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35914
35992
|
/**
|
|
35915
35993
|
* Recording service.
|
|
35916
35994
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35917
|
-
* @version
|
|
35995
|
+
* @version 154.0.0
|
|
35918
35996
|
*/
|
|
35919
35997
|
|
|
35920
35998
|
/**
|
|
@@ -36616,7 +36694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36616
36694
|
}
|
|
36617
36695
|
|
|
36618
36696
|
/**
|
|
36619
|
-
* Get the local encryption settings
|
|
36697
|
+
* Get the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
36620
36698
|
*
|
|
36621
36699
|
* @param {String} settingsId Settings Id
|
|
36622
36700
|
*/
|
|
@@ -36641,7 +36719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36641
36719
|
}
|
|
36642
36720
|
|
|
36643
36721
|
/**
|
|
36644
|
-
* gets a list local key settings data
|
|
36722
|
+
* gets a list local key settings data. Replaced by API recording/keyconfigurations
|
|
36645
36723
|
*
|
|
36646
36724
|
*/
|
|
36647
36725
|
getRecordingLocalkeysSettings() {
|
|
@@ -37093,7 +37171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37093
37171
|
}
|
|
37094
37172
|
|
|
37095
37173
|
/**
|
|
37096
|
-
* create a local recording key
|
|
37174
|
+
* create a local key management recording key
|
|
37097
37175
|
*
|
|
37098
37176
|
* @param {Object} body Local Encryption body
|
|
37099
37177
|
*/
|
|
@@ -37118,7 +37196,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37118
37196
|
}
|
|
37119
37197
|
|
|
37120
37198
|
/**
|
|
37121
|
-
* create settings for local key creation
|
|
37199
|
+
* create settings for local key creation. Replaced by API recording/keyconfigurations
|
|
37122
37200
|
*
|
|
37123
37201
|
* @param {Object} body Local Encryption Configuration
|
|
37124
37202
|
*/
|
|
@@ -37461,7 +37539,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37461
37539
|
}
|
|
37462
37540
|
|
|
37463
37541
|
/**
|
|
37464
|
-
* Update the local encryption settings
|
|
37542
|
+
* Update the local encryption settings. Replaced by API recording/keyconfigurations/{keyConfigurationId}
|
|
37465
37543
|
*
|
|
37466
37544
|
* @param {String} settingsId Settings Id
|
|
37467
37545
|
* @param {Object} body Local Encryption metadata
|
|
@@ -37601,7 +37679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37601
37679
|
/**
|
|
37602
37680
|
* ResponseManagement service.
|
|
37603
37681
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37604
|
-
* @version
|
|
37682
|
+
* @version 154.0.0
|
|
37605
37683
|
*/
|
|
37606
37684
|
|
|
37607
37685
|
/**
|
|
@@ -38085,7 +38163,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38085
38163
|
/**
|
|
38086
38164
|
* Routing service.
|
|
38087
38165
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38088
|
-
* @version
|
|
38166
|
+
* @version 154.0.0
|
|
38089
38167
|
*/
|
|
38090
38168
|
|
|
38091
38169
|
/**
|
|
@@ -38811,6 +38889,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38811
38889
|
* Get domains
|
|
38812
38890
|
*
|
|
38813
38891
|
* @param {Object} opts Optional parameters
|
|
38892
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38893
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38814
38894
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
38815
38895
|
*/
|
|
38816
38896
|
getRoutingEmailDomains(opts) {
|
|
@@ -38821,7 +38901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38821
38901
|
'/api/v2/routing/email/domains',
|
|
38822
38902
|
'GET',
|
|
38823
38903
|
{ },
|
|
38824
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
38904
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
38825
38905
|
{ },
|
|
38826
38906
|
{ },
|
|
38827
38907
|
null,
|
|
@@ -41498,7 +41578,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41498
41578
|
/**
|
|
41499
41579
|
* SCIM service.
|
|
41500
41580
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41501
|
-
* @version
|
|
41581
|
+
* @version 154.0.0
|
|
41502
41582
|
*/
|
|
41503
41583
|
|
|
41504
41584
|
/**
|
|
@@ -42375,7 +42455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42375
42455
|
/**
|
|
42376
42456
|
* Scripts service.
|
|
42377
42457
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42378
|
-
* @version
|
|
42458
|
+
* @version 154.0.0
|
|
42379
42459
|
*/
|
|
42380
42460
|
|
|
42381
42461
|
/**
|
|
@@ -42794,7 +42874,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42794
42874
|
/**
|
|
42795
42875
|
* Search service.
|
|
42796
42876
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42797
|
-
* @version
|
|
42877
|
+
* @version 154.0.0
|
|
42798
42878
|
*/
|
|
42799
42879
|
|
|
42800
42880
|
/**
|
|
@@ -43379,7 +43459,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43379
43459
|
/**
|
|
43380
43460
|
* SpeechTextAnalytics service.
|
|
43381
43461
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43382
|
-
* @version
|
|
43462
|
+
* @version 154.0.0
|
|
43383
43463
|
*/
|
|
43384
43464
|
|
|
43385
43465
|
/**
|
|
@@ -44233,7 +44313,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44233
44313
|
/**
|
|
44234
44314
|
* Stations service.
|
|
44235
44315
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44236
|
-
* @version
|
|
44316
|
+
* @version 154.0.0
|
|
44237
44317
|
*/
|
|
44238
44318
|
|
|
44239
44319
|
/**
|
|
@@ -44380,7 +44460,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44380
44460
|
/**
|
|
44381
44461
|
* Suggest service.
|
|
44382
44462
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44383
|
-
* @version
|
|
44463
|
+
* @version 154.0.0
|
|
44384
44464
|
*/
|
|
44385
44465
|
|
|
44386
44466
|
/**
|
|
@@ -44519,7 +44599,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44519
44599
|
/**
|
|
44520
44600
|
* Teams service.
|
|
44521
44601
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44522
|
-
* @version
|
|
44602
|
+
* @version 154.0.0
|
|
44523
44603
|
*/
|
|
44524
44604
|
|
|
44525
44605
|
/**
|
|
@@ -44790,7 +44870,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44790
44870
|
/**
|
|
44791
44871
|
* Telephony service.
|
|
44792
44872
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44793
|
-
* @version
|
|
44873
|
+
* @version 154.0.0
|
|
44794
44874
|
*/
|
|
44795
44875
|
|
|
44796
44876
|
/**
|
|
@@ -44898,7 +44978,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44898
44978
|
/**
|
|
44899
44979
|
* TelephonyProvidersEdge service.
|
|
44900
44980
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44901
|
-
* @version
|
|
44981
|
+
* @version 154.0.0
|
|
44902
44982
|
*/
|
|
44903
44983
|
|
|
44904
44984
|
/**
|
|
@@ -48531,7 +48611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48531
48611
|
/**
|
|
48532
48612
|
* Textbots service.
|
|
48533
48613
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48534
|
-
* @version
|
|
48614
|
+
* @version 154.0.0
|
|
48535
48615
|
*/
|
|
48536
48616
|
|
|
48537
48617
|
/**
|
|
@@ -48659,7 +48739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48659
48739
|
/**
|
|
48660
48740
|
* Tokens service.
|
|
48661
48741
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48662
|
-
* @version
|
|
48742
|
+
* @version 154.0.0
|
|
48663
48743
|
*/
|
|
48664
48744
|
|
|
48665
48745
|
/**
|
|
@@ -48765,7 +48845,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48765
48845
|
/**
|
|
48766
48846
|
* Uploads service.
|
|
48767
48847
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48768
|
-
* @version
|
|
48848
|
+
* @version 154.0.0
|
|
48769
48849
|
*/
|
|
48770
48850
|
|
|
48771
48851
|
/**
|
|
@@ -48941,7 +49021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48941
49021
|
/**
|
|
48942
49022
|
* Usage service.
|
|
48943
49023
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48944
|
-
* @version
|
|
49024
|
+
* @version 154.0.0
|
|
48945
49025
|
*/
|
|
48946
49026
|
|
|
48947
49027
|
/**
|
|
@@ -49012,7 +49092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49012
49092
|
/**
|
|
49013
49093
|
* UserRecordings service.
|
|
49014
49094
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49015
|
-
* @version
|
|
49095
|
+
* @version 154.0.0
|
|
49016
49096
|
*/
|
|
49017
49097
|
|
|
49018
49098
|
/**
|
|
@@ -49197,7 +49277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49197
49277
|
/**
|
|
49198
49278
|
* Users service.
|
|
49199
49279
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49200
|
-
* @version
|
|
49280
|
+
* @version 154.0.0
|
|
49201
49281
|
*/
|
|
49202
49282
|
|
|
49203
49283
|
/**
|
|
@@ -51554,7 +51634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51554
51634
|
/**
|
|
51555
51635
|
* Utilities service.
|
|
51556
51636
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51557
|
-
* @version
|
|
51637
|
+
* @version 154.0.0
|
|
51558
51638
|
*/
|
|
51559
51639
|
|
|
51560
51640
|
/**
|
|
@@ -51665,7 +51745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51665
51745
|
/**
|
|
51666
51746
|
* Voicemail service.
|
|
51667
51747
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51668
|
-
* @version
|
|
51748
|
+
* @version 154.0.0
|
|
51669
51749
|
*/
|
|
51670
51750
|
|
|
51671
51751
|
/**
|
|
@@ -52332,7 +52412,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52332
52412
|
/**
|
|
52333
52413
|
* WebChat service.
|
|
52334
52414
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52335
|
-
* @version
|
|
52415
|
+
* @version 154.0.0
|
|
52336
52416
|
*/
|
|
52337
52417
|
|
|
52338
52418
|
/**
|
|
@@ -52876,7 +52956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52876
52956
|
/**
|
|
52877
52957
|
* WebDeployments service.
|
|
52878
52958
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52879
|
-
* @version
|
|
52959
|
+
* @version 154.0.0
|
|
52880
52960
|
*/
|
|
52881
52961
|
|
|
52882
52962
|
/**
|
|
@@ -53264,7 +53344,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53264
53344
|
/**
|
|
53265
53345
|
* WebMessaging service.
|
|
53266
53346
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53267
|
-
* @version
|
|
53347
|
+
* @version 154.0.0
|
|
53268
53348
|
*/
|
|
53269
53349
|
|
|
53270
53350
|
/**
|
|
@@ -53310,7 +53390,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53310
53390
|
/**
|
|
53311
53391
|
* Widgets service.
|
|
53312
53392
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53313
|
-
* @version
|
|
53393
|
+
* @version 154.0.0
|
|
53314
53394
|
*/
|
|
53315
53395
|
|
|
53316
53396
|
/**
|
|
@@ -53456,7 +53536,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53456
53536
|
/**
|
|
53457
53537
|
* WorkforceManagement service.
|
|
53458
53538
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53459
|
-
* @version
|
|
53539
|
+
* @version 154.0.0
|
|
53460
53540
|
*/
|
|
53461
53541
|
|
|
53462
53542
|
/**
|
|
@@ -53876,6 +53956,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53876
53956
|
);
|
|
53877
53957
|
}
|
|
53878
53958
|
|
|
53959
|
+
/**
|
|
53960
|
+
* Get an adherence explanation for the current user
|
|
53961
|
+
*
|
|
53962
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
53963
|
+
*/
|
|
53964
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
53965
|
+
// verify the required parameter 'explanationId' is set
|
|
53966
|
+
if (explanationId === undefined || explanationId === null) {
|
|
53967
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
53968
|
+
}
|
|
53969
|
+
|
|
53970
|
+
return this.apiClient.callApi(
|
|
53971
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
53972
|
+
'GET',
|
|
53973
|
+
{ 'explanationId': explanationId },
|
|
53974
|
+
{ },
|
|
53975
|
+
{ },
|
|
53976
|
+
{ },
|
|
53977
|
+
null,
|
|
53978
|
+
['PureCloud OAuth'],
|
|
53979
|
+
['application/json'],
|
|
53980
|
+
['application/json']
|
|
53981
|
+
);
|
|
53982
|
+
}
|
|
53983
|
+
|
|
53984
|
+
/**
|
|
53985
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
53986
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
53987
|
+
* @param {String} jobId The ID of the job
|
|
53988
|
+
*/
|
|
53989
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
53990
|
+
// verify the required parameter 'jobId' is set
|
|
53991
|
+
if (jobId === undefined || jobId === null) {
|
|
53992
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
53993
|
+
}
|
|
53994
|
+
|
|
53995
|
+
return this.apiClient.callApi(
|
|
53996
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
53997
|
+
'GET',
|
|
53998
|
+
{ 'jobId': jobId },
|
|
53999
|
+
{ },
|
|
54000
|
+
{ },
|
|
54001
|
+
{ },
|
|
54002
|
+
null,
|
|
54003
|
+
['PureCloud OAuth'],
|
|
54004
|
+
['application/json'],
|
|
54005
|
+
['application/json']
|
|
54006
|
+
);
|
|
54007
|
+
}
|
|
54008
|
+
|
|
53879
54009
|
/**
|
|
53880
54010
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
53881
54011
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -53926,6 +54056,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53926
54056
|
);
|
|
53927
54057
|
}
|
|
53928
54058
|
|
|
54059
|
+
/**
|
|
54060
|
+
* Get an adherence explanation
|
|
54061
|
+
*
|
|
54062
|
+
* @param {String} agentId The ID of the agent to query
|
|
54063
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
54064
|
+
*/
|
|
54065
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
54066
|
+
// verify the required parameter 'agentId' is set
|
|
54067
|
+
if (agentId === undefined || agentId === null) {
|
|
54068
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54069
|
+
}
|
|
54070
|
+
// verify the required parameter 'explanationId' is set
|
|
54071
|
+
if (explanationId === undefined || explanationId === null) {
|
|
54072
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54073
|
+
}
|
|
54074
|
+
|
|
54075
|
+
return this.apiClient.callApi(
|
|
54076
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
54077
|
+
'GET',
|
|
54078
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
54079
|
+
{ },
|
|
54080
|
+
{ },
|
|
54081
|
+
{ },
|
|
54082
|
+
null,
|
|
54083
|
+
['PureCloud OAuth'],
|
|
54084
|
+
['application/json'],
|
|
54085
|
+
['application/json']
|
|
54086
|
+
);
|
|
54087
|
+
}
|
|
54088
|
+
|
|
53929
54089
|
/**
|
|
53930
54090
|
* Get the management unit to which the agent belongs
|
|
53931
54091
|
*
|
|
@@ -55645,6 +55805,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55645
55805
|
);
|
|
55646
55806
|
}
|
|
55647
55807
|
|
|
55808
|
+
/**
|
|
55809
|
+
* Request to fetch the status of the historical shrinkage query
|
|
55810
|
+
*
|
|
55811
|
+
* @param {String} jobId jobId
|
|
55812
|
+
*/
|
|
55813
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
55814
|
+
// verify the required parameter 'jobId' is set
|
|
55815
|
+
if (jobId === undefined || jobId === null) {
|
|
55816
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
55817
|
+
}
|
|
55818
|
+
|
|
55819
|
+
return this.apiClient.callApi(
|
|
55820
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
55821
|
+
'GET',
|
|
55822
|
+
{ 'jobId': jobId },
|
|
55823
|
+
{ },
|
|
55824
|
+
{ },
|
|
55825
|
+
{ },
|
|
55826
|
+
null,
|
|
55827
|
+
['PureCloud OAuth'],
|
|
55828
|
+
['application/json'],
|
|
55829
|
+
['application/json']
|
|
55830
|
+
);
|
|
55831
|
+
}
|
|
55832
|
+
|
|
55648
55833
|
/**
|
|
55649
55834
|
* Get a time off request for the current user
|
|
55650
55835
|
*
|
|
@@ -55719,6 +55904,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55719
55904
|
);
|
|
55720
55905
|
}
|
|
55721
55906
|
|
|
55907
|
+
/**
|
|
55908
|
+
* Update an adherence explanation
|
|
55909
|
+
*
|
|
55910
|
+
* @param {String} agentId The ID of the agent to query
|
|
55911
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55912
|
+
* @param {Object} body The request body
|
|
55913
|
+
*/
|
|
55914
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
55915
|
+
// verify the required parameter 'agentId' is set
|
|
55916
|
+
if (agentId === undefined || agentId === null) {
|
|
55917
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55918
|
+
}
|
|
55919
|
+
// verify the required parameter 'explanationId' is set
|
|
55920
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55921
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55922
|
+
}
|
|
55923
|
+
// verify the required parameter 'body' is set
|
|
55924
|
+
if (body === undefined || body === null) {
|
|
55925
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55926
|
+
}
|
|
55927
|
+
|
|
55928
|
+
return this.apiClient.callApi(
|
|
55929
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
55930
|
+
'PATCH',
|
|
55931
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
55932
|
+
{ },
|
|
55933
|
+
{ },
|
|
55934
|
+
{ },
|
|
55935
|
+
body,
|
|
55936
|
+
['PureCloud OAuth'],
|
|
55937
|
+
['application/json'],
|
|
55938
|
+
['application/json']
|
|
55939
|
+
);
|
|
55940
|
+
}
|
|
55941
|
+
|
|
55722
55942
|
/**
|
|
55723
55943
|
* Update business unit
|
|
55724
55944
|
*
|
|
@@ -56158,6 +56378,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56158
56378
|
);
|
|
56159
56379
|
}
|
|
56160
56380
|
|
|
56381
|
+
/**
|
|
56382
|
+
* Submit an adherence explanation for the current user
|
|
56383
|
+
*
|
|
56384
|
+
* @param {Object} body The request body
|
|
56385
|
+
*/
|
|
56386
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
56387
|
+
// verify the required parameter 'body' is set
|
|
56388
|
+
if (body === undefined || body === null) {
|
|
56389
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
56390
|
+
}
|
|
56391
|
+
|
|
56392
|
+
return this.apiClient.callApi(
|
|
56393
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
56394
|
+
'POST',
|
|
56395
|
+
{ },
|
|
56396
|
+
{ },
|
|
56397
|
+
{ },
|
|
56398
|
+
{ },
|
|
56399
|
+
body,
|
|
56400
|
+
['PureCloud OAuth'],
|
|
56401
|
+
['application/json'],
|
|
56402
|
+
['application/json']
|
|
56403
|
+
);
|
|
56404
|
+
}
|
|
56405
|
+
|
|
56406
|
+
/**
|
|
56407
|
+
* Query adherence explanations for the current user
|
|
56408
|
+
*
|
|
56409
|
+
* @param {Object} body The request body
|
|
56410
|
+
* @param {Object} opts Optional parameters
|
|
56411
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56412
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56413
|
+
*/
|
|
56414
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
56415
|
+
opts = opts || {};
|
|
56416
|
+
|
|
56417
|
+
// verify the required parameter 'body' is set
|
|
56418
|
+
if (body === undefined || body === null) {
|
|
56419
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
56420
|
+
}
|
|
56421
|
+
|
|
56422
|
+
return this.apiClient.callApi(
|
|
56423
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
56424
|
+
'POST',
|
|
56425
|
+
{ },
|
|
56426
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56427
|
+
{ },
|
|
56428
|
+
{ },
|
|
56429
|
+
body,
|
|
56430
|
+
['PureCloud OAuth'],
|
|
56431
|
+
['application/json'],
|
|
56432
|
+
['application/json']
|
|
56433
|
+
);
|
|
56434
|
+
}
|
|
56435
|
+
|
|
56161
56436
|
/**
|
|
56162
56437
|
* Request a historical adherence report for users across management units
|
|
56163
56438
|
*
|
|
@@ -56182,6 +56457,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56182
56457
|
);
|
|
56183
56458
|
}
|
|
56184
56459
|
|
|
56460
|
+
/**
|
|
56461
|
+
* Add an adherence explanation for the requested user
|
|
56462
|
+
*
|
|
56463
|
+
* @param {String} agentId The ID of the agent to query
|
|
56464
|
+
* @param {Object} body The request body
|
|
56465
|
+
*/
|
|
56466
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
56467
|
+
// verify the required parameter 'agentId' is set
|
|
56468
|
+
if (agentId === undefined || agentId === null) {
|
|
56469
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56470
|
+
}
|
|
56471
|
+
// verify the required parameter 'body' is set
|
|
56472
|
+
if (body === undefined || body === null) {
|
|
56473
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56474
|
+
}
|
|
56475
|
+
|
|
56476
|
+
return this.apiClient.callApi(
|
|
56477
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
56478
|
+
'POST',
|
|
56479
|
+
{ 'agentId': agentId },
|
|
56480
|
+
{ },
|
|
56481
|
+
{ },
|
|
56482
|
+
{ },
|
|
56483
|
+
body,
|
|
56484
|
+
['PureCloud OAuth'],
|
|
56485
|
+
['application/json'],
|
|
56486
|
+
['application/json']
|
|
56487
|
+
);
|
|
56488
|
+
}
|
|
56489
|
+
|
|
56490
|
+
/**
|
|
56491
|
+
* Query adherence explanations for the given agent across a specified range
|
|
56492
|
+
*
|
|
56493
|
+
* @param {String} agentId The ID of the agent to query
|
|
56494
|
+
* @param {Object} body The request body
|
|
56495
|
+
* @param {Object} opts Optional parameters
|
|
56496
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56497
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56498
|
+
*/
|
|
56499
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
56500
|
+
opts = opts || {};
|
|
56501
|
+
|
|
56502
|
+
// verify the required parameter 'agentId' is set
|
|
56503
|
+
if (agentId === undefined || agentId === null) {
|
|
56504
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56505
|
+
}
|
|
56506
|
+
// verify the required parameter 'body' is set
|
|
56507
|
+
if (body === undefined || body === null) {
|
|
56508
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56509
|
+
}
|
|
56510
|
+
|
|
56511
|
+
return this.apiClient.callApi(
|
|
56512
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
56513
|
+
'POST',
|
|
56514
|
+
{ 'agentId': agentId },
|
|
56515
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56516
|
+
{ },
|
|
56517
|
+
{ },
|
|
56518
|
+
body,
|
|
56519
|
+
['PureCloud OAuth'],
|
|
56520
|
+
['application/json'],
|
|
56521
|
+
['application/json']
|
|
56522
|
+
);
|
|
56523
|
+
}
|
|
56524
|
+
|
|
56185
56525
|
/**
|
|
56186
56526
|
* Get published schedule for the current user
|
|
56187
56527
|
*
|
|
@@ -56235,6 +56575,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56235
56575
|
);
|
|
56236
56576
|
}
|
|
56237
56577
|
|
|
56578
|
+
/**
|
|
56579
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
56580
|
+
*
|
|
56581
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
56582
|
+
* @param {Object} body The request body
|
|
56583
|
+
* @param {Object} opts Optional parameters
|
|
56584
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56585
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56586
|
+
*/
|
|
56587
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
56588
|
+
opts = opts || {};
|
|
56589
|
+
|
|
56590
|
+
// verify the required parameter 'businessUnitId' is set
|
|
56591
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
56592
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56593
|
+
}
|
|
56594
|
+
// verify the required parameter 'body' is set
|
|
56595
|
+
if (body === undefined || body === null) {
|
|
56596
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56597
|
+
}
|
|
56598
|
+
|
|
56599
|
+
return this.apiClient.callApi(
|
|
56600
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
56601
|
+
'POST',
|
|
56602
|
+
{ 'businessUnitId': businessUnitId },
|
|
56603
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56604
|
+
{ },
|
|
56605
|
+
{ },
|
|
56606
|
+
body,
|
|
56607
|
+
['PureCloud OAuth'],
|
|
56608
|
+
['application/json'],
|
|
56609
|
+
['application/json']
|
|
56610
|
+
);
|
|
56611
|
+
}
|
|
56612
|
+
|
|
56238
56613
|
/**
|
|
56239
56614
|
* Search published schedules
|
|
56240
56615
|
*
|
|
@@ -57062,6 +57437,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57062
57437
|
);
|
|
57063
57438
|
}
|
|
57064
57439
|
|
|
57440
|
+
/**
|
|
57441
|
+
* Request a historical shrinkage report
|
|
57442
|
+
* 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.
|
|
57443
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57444
|
+
* @param {Object} opts Optional parameters
|
|
57445
|
+
* @param {Object} opts.body body
|
|
57446
|
+
*/
|
|
57447
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
57448
|
+
opts = opts || {};
|
|
57449
|
+
|
|
57450
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57451
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57452
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
57453
|
+
}
|
|
57454
|
+
|
|
57455
|
+
return this.apiClient.callApi(
|
|
57456
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
57457
|
+
'POST',
|
|
57458
|
+
{ 'managementUnitId': managementUnitId },
|
|
57459
|
+
{ },
|
|
57460
|
+
{ },
|
|
57461
|
+
{ },
|
|
57462
|
+
opts['body'],
|
|
57463
|
+
['PureCloud OAuth'],
|
|
57464
|
+
['application/json'],
|
|
57465
|
+
['application/json']
|
|
57466
|
+
);
|
|
57467
|
+
}
|
|
57468
|
+
|
|
57065
57469
|
/**
|
|
57066
57470
|
* Creates a new time off limit object under management unit.
|
|
57067
57471
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -57802,7 +58206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57802
58206
|
* </pre>
|
|
57803
58207
|
* </p>
|
|
57804
58208
|
* @module purecloud-platform-client-v2/index
|
|
57805
|
-
* @version
|
|
58209
|
+
* @version 154.0.0
|
|
57806
58210
|
*/
|
|
57807
58211
|
class platformClient {
|
|
57808
58212
|
constructor() {
|