purecloud-platform-client-v2 151.0.0 → 153.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 +712 -150
- package/dist/web-amd/purecloud-platform-client-v2.js +712 -150
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +712 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +712 -150
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +579 -212
- 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 +30 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +5 -4
- 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 +16 -10
- 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 -65
- 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 +3 -3
- 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/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 +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 +226 -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
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 153.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1481,7 +1481,7 @@ class AlertingApi {
|
|
|
1481
1481
|
/**
|
|
1482
1482
|
* Alerting service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 153.0.0
|
|
1485
1485
|
*/
|
|
1486
1486
|
|
|
1487
1487
|
/**
|
|
@@ -1795,7 +1795,7 @@ class AnalyticsApi {
|
|
|
1795
1795
|
/**
|
|
1796
1796
|
* Analytics service.
|
|
1797
1797
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1798
|
-
* @version
|
|
1798
|
+
* @version 153.0.0
|
|
1799
1799
|
*/
|
|
1800
1800
|
|
|
1801
1801
|
/**
|
|
@@ -1811,7 +1811,7 @@ class AnalyticsApi {
|
|
|
1811
1811
|
|
|
1812
1812
|
|
|
1813
1813
|
/**
|
|
1814
|
-
* Delete/cancel an async
|
|
1814
|
+
* Delete/cancel an async details job
|
|
1815
1815
|
*
|
|
1816
1816
|
* @param {String} jobId jobId
|
|
1817
1817
|
*/
|
|
@@ -1894,6 +1894,7 @@ class AnalyticsApi {
|
|
|
1894
1894
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
1895
1895
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
1896
1896
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
1897
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
1897
1898
|
*/
|
|
1898
1899
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
1899
1900
|
opts = opts || {};
|
|
@@ -1907,7 +1908,7 @@ class AnalyticsApi {
|
|
|
1907
1908
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
1908
1909
|
'GET',
|
|
1909
1910
|
{ 'botFlowId': botFlowId },
|
|
1910
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'] },
|
|
1911
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
1911
1912
|
{ },
|
|
1912
1913
|
{ },
|
|
1913
1914
|
null,
|
|
@@ -1992,7 +1993,7 @@ class AnalyticsApi {
|
|
|
1992
1993
|
}
|
|
1993
1994
|
|
|
1994
1995
|
/**
|
|
1995
|
-
* Fetch a page of results for an async
|
|
1996
|
+
* Fetch a page of results for an async details job
|
|
1996
1997
|
*
|
|
1997
1998
|
* @param {String} jobId jobId
|
|
1998
1999
|
* @param {Object} opts Optional parameters
|
|
@@ -2456,6 +2457,31 @@ class AnalyticsApi {
|
|
|
2456
2457
|
);
|
|
2457
2458
|
}
|
|
2458
2459
|
|
|
2460
|
+
/**
|
|
2461
|
+
* Query for action aggregates
|
|
2462
|
+
*
|
|
2463
|
+
* @param {Object} body query
|
|
2464
|
+
*/
|
|
2465
|
+
postAnalyticsActionsAggregatesQuery(body) {
|
|
2466
|
+
// verify the required parameter 'body' is set
|
|
2467
|
+
if (body === undefined || body === null) {
|
|
2468
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
|
|
2469
|
+
}
|
|
2470
|
+
|
|
2471
|
+
return this.apiClient.callApi(
|
|
2472
|
+
'/api/v2/analytics/actions/aggregates/query',
|
|
2473
|
+
'POST',
|
|
2474
|
+
{ },
|
|
2475
|
+
{ },
|
|
2476
|
+
{ },
|
|
2477
|
+
{ },
|
|
2478
|
+
body,
|
|
2479
|
+
['PureCloud OAuth'],
|
|
2480
|
+
['application/json'],
|
|
2481
|
+
['application/json']
|
|
2482
|
+
);
|
|
2483
|
+
}
|
|
2484
|
+
|
|
2459
2485
|
/**
|
|
2460
2486
|
* Query for bot aggregates
|
|
2461
2487
|
*
|
|
@@ -3022,7 +3048,7 @@ class ArchitectApi {
|
|
|
3022
3048
|
/**
|
|
3023
3049
|
* Architect service.
|
|
3024
3050
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3025
|
-
* @version
|
|
3051
|
+
* @version 153.0.0
|
|
3026
3052
|
*/
|
|
3027
3053
|
|
|
3028
3054
|
/**
|
|
@@ -4615,6 +4641,7 @@ class ArchitectApi {
|
|
|
4615
4641
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
4616
4642
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
4617
4643
|
* @param {Boolean} opts.showbrief If true returns just the key value of the row (default to true)
|
|
4644
|
+
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
4618
4645
|
*/
|
|
4619
4646
|
getFlowsDatatableRows(datatableId, opts) {
|
|
4620
4647
|
opts = opts || {};
|
|
@@ -4628,7 +4655,7 @@ class ArchitectApi {
|
|
|
4628
4655
|
'/api/v2/flows/datatables/{datatableId}/rows',
|
|
4629
4656
|
'GET',
|
|
4630
4657
|
{ 'datatableId': datatableId },
|
|
4631
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'] },
|
|
4658
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'],'sortOrder': opts['sortOrder'] },
|
|
4632
4659
|
{ },
|
|
4633
4660
|
{ },
|
|
4634
4661
|
null,
|
|
@@ -4648,7 +4675,7 @@ class ArchitectApi {
|
|
|
4648
4675
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
4649
4676
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
4650
4677
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
4651
|
-
* @param {String} opts.name Name
|
|
4678
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
4652
4679
|
*/
|
|
4653
4680
|
getFlowsDatatables(opts) {
|
|
4654
4681
|
opts = opts || {};
|
|
@@ -4707,7 +4734,7 @@ class ArchitectApi {
|
|
|
4707
4734
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
4708
4735
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
4709
4736
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
4710
|
-
* @param {String} opts.name Name
|
|
4737
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
4711
4738
|
*/
|
|
4712
4739
|
getFlowsDatatablesDivisionviews(opts) {
|
|
4713
4740
|
opts = opts || {};
|
|
@@ -6068,7 +6095,7 @@ class AuditApi {
|
|
|
6068
6095
|
/**
|
|
6069
6096
|
* Audit service.
|
|
6070
6097
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6071
|
-
* @version
|
|
6098
|
+
* @version 153.0.0
|
|
6072
6099
|
*/
|
|
6073
6100
|
|
|
6074
6101
|
/**
|
|
@@ -6239,7 +6266,7 @@ class AuthorizationApi {
|
|
|
6239
6266
|
/**
|
|
6240
6267
|
* Authorization service.
|
|
6241
6268
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6242
|
-
* @version
|
|
6269
|
+
* @version 153.0.0
|
|
6243
6270
|
*/
|
|
6244
6271
|
|
|
6245
6272
|
/**
|
|
@@ -6772,6 +6799,26 @@ class AuthorizationApi {
|
|
|
6772
6799
|
);
|
|
6773
6800
|
}
|
|
6774
6801
|
|
|
6802
|
+
/**
|
|
6803
|
+
* Get authorization settings
|
|
6804
|
+
*
|
|
6805
|
+
*/
|
|
6806
|
+
getAuthorizationSettings() {
|
|
6807
|
+
|
|
6808
|
+
return this.apiClient.callApi(
|
|
6809
|
+
'/api/v2/authorization/settings',
|
|
6810
|
+
'GET',
|
|
6811
|
+
{ },
|
|
6812
|
+
{ },
|
|
6813
|
+
{ },
|
|
6814
|
+
{ },
|
|
6815
|
+
null,
|
|
6816
|
+
['PureCloud OAuth'],
|
|
6817
|
+
['application/json'],
|
|
6818
|
+
['application/json']
|
|
6819
|
+
);
|
|
6820
|
+
}
|
|
6821
|
+
|
|
6775
6822
|
/**
|
|
6776
6823
|
* Returns a listing of roles and permissions for a user.
|
|
6777
6824
|
*
|
|
@@ -6896,6 +6943,31 @@ class AuthorizationApi {
|
|
|
6896
6943
|
);
|
|
6897
6944
|
}
|
|
6898
6945
|
|
|
6946
|
+
/**
|
|
6947
|
+
* Change authorization settings
|
|
6948
|
+
* Change authorization settings
|
|
6949
|
+
* @param {Object} body Authorization Settings
|
|
6950
|
+
*/
|
|
6951
|
+
patchAuthorizationSettings(body) {
|
|
6952
|
+
// verify the required parameter 'body' is set
|
|
6953
|
+
if (body === undefined || body === null) {
|
|
6954
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
6955
|
+
}
|
|
6956
|
+
|
|
6957
|
+
return this.apiClient.callApi(
|
|
6958
|
+
'/api/v2/authorization/settings',
|
|
6959
|
+
'PATCH',
|
|
6960
|
+
{ },
|
|
6961
|
+
{ },
|
|
6962
|
+
{ },
|
|
6963
|
+
{ },
|
|
6964
|
+
body,
|
|
6965
|
+
['PureCloud OAuth'],
|
|
6966
|
+
['application/json'],
|
|
6967
|
+
['application/json']
|
|
6968
|
+
);
|
|
6969
|
+
}
|
|
6970
|
+
|
|
6899
6971
|
/**
|
|
6900
6972
|
* Assign a list of objects to a division
|
|
6901
6973
|
* 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"]
|
|
@@ -7422,7 +7494,7 @@ class BillingApi {
|
|
|
7422
7494
|
/**
|
|
7423
7495
|
* Billing service.
|
|
7424
7496
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7425
|
-
* @version
|
|
7497
|
+
* @version 153.0.0
|
|
7426
7498
|
*/
|
|
7427
7499
|
|
|
7428
7500
|
/**
|
|
@@ -7502,7 +7574,7 @@ class ChatApi {
|
|
|
7502
7574
|
/**
|
|
7503
7575
|
* Chat service.
|
|
7504
7576
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7505
|
-
* @version
|
|
7577
|
+
* @version 153.0.0
|
|
7506
7578
|
*/
|
|
7507
7579
|
|
|
7508
7580
|
/**
|
|
@@ -7593,7 +7665,7 @@ class CoachingApi {
|
|
|
7593
7665
|
/**
|
|
7594
7666
|
* Coaching service.
|
|
7595
7667
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7596
|
-
* @version
|
|
7668
|
+
* @version 153.0.0
|
|
7597
7669
|
*/
|
|
7598
7670
|
|
|
7599
7671
|
/**
|
|
@@ -8170,7 +8242,7 @@ class ContentManagementApi {
|
|
|
8170
8242
|
/**
|
|
8171
8243
|
* ContentManagement service.
|
|
8172
8244
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8173
|
-
* @version
|
|
8245
|
+
* @version 153.0.0
|
|
8174
8246
|
*/
|
|
8175
8247
|
|
|
8176
8248
|
/**
|
|
@@ -9310,7 +9382,7 @@ class ConversationsApi {
|
|
|
9310
9382
|
/**
|
|
9311
9383
|
* Conversations service.
|
|
9312
9384
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9313
|
-
* @version
|
|
9385
|
+
* @version 153.0.0
|
|
9314
9386
|
*/
|
|
9315
9387
|
|
|
9316
9388
|
/**
|
|
@@ -9326,7 +9398,7 @@ class ConversationsApi {
|
|
|
9326
9398
|
|
|
9327
9399
|
|
|
9328
9400
|
/**
|
|
9329
|
-
* Delete/cancel an async
|
|
9401
|
+
* Delete/cancel an async details job
|
|
9330
9402
|
*
|
|
9331
9403
|
* @param {String} jobId jobId
|
|
9332
9404
|
*/
|
|
@@ -9700,7 +9772,7 @@ class ConversationsApi {
|
|
|
9700
9772
|
}
|
|
9701
9773
|
|
|
9702
9774
|
/**
|
|
9703
|
-
* Fetch a page of results for an async
|
|
9775
|
+
* Fetch a page of results for an async details job
|
|
9704
9776
|
*
|
|
9705
9777
|
* @param {String} jobId jobId
|
|
9706
9778
|
* @param {Object} opts Optional parameters
|
|
@@ -10989,8 +11061,9 @@ class ConversationsApi {
|
|
|
10989
11061
|
* @param {Object} opts Optional parameters
|
|
10990
11062
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10991
11063
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10992
|
-
* @param {
|
|
11064
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value.
|
|
10993
11065
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11066
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
10994
11067
|
*/
|
|
10995
11068
|
getConversationsMessagingIntegrations(opts) {
|
|
10996
11069
|
opts = opts || {};
|
|
@@ -11000,7 +11073,7 @@ class ConversationsApi {
|
|
|
11000
11073
|
'/api/v2/conversations/messaging/integrations',
|
|
11001
11074
|
'GET',
|
|
11002
11075
|
{ },
|
|
11003
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11076
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11004
11077
|
{ },
|
|
11005
11078
|
{ },
|
|
11006
11079
|
null,
|
|
@@ -11018,6 +11091,7 @@ class ConversationsApi {
|
|
|
11018
11091
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11019
11092
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11020
11093
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11094
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11021
11095
|
*/
|
|
11022
11096
|
getConversationsMessagingIntegrationsFacebook(opts) {
|
|
11023
11097
|
opts = opts || {};
|
|
@@ -11027,7 +11101,7 @@ class ConversationsApi {
|
|
|
11027
11101
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
11028
11102
|
'GET',
|
|
11029
11103
|
{ },
|
|
11030
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11104
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11031
11105
|
{ },
|
|
11032
11106
|
{ },
|
|
11033
11107
|
null,
|
|
@@ -11074,6 +11148,7 @@ class ConversationsApi {
|
|
|
11074
11148
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11075
11149
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11076
11150
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11151
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11077
11152
|
*/
|
|
11078
11153
|
getConversationsMessagingIntegrationsLine(opts) {
|
|
11079
11154
|
opts = opts || {};
|
|
@@ -11083,7 +11158,7 @@ class ConversationsApi {
|
|
|
11083
11158
|
'/api/v2/conversations/messaging/integrations/line',
|
|
11084
11159
|
'GET',
|
|
11085
11160
|
{ },
|
|
11086
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11161
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11087
11162
|
{ },
|
|
11088
11163
|
{ },
|
|
11089
11164
|
null,
|
|
@@ -11130,6 +11205,7 @@ class ConversationsApi {
|
|
|
11130
11205
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11131
11206
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11132
11207
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11208
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11133
11209
|
*/
|
|
11134
11210
|
getConversationsMessagingIntegrationsOpen(opts) {
|
|
11135
11211
|
opts = opts || {};
|
|
@@ -11139,7 +11215,7 @@ class ConversationsApi {
|
|
|
11139
11215
|
'/api/v2/conversations/messaging/integrations/open',
|
|
11140
11216
|
'GET',
|
|
11141
11217
|
{ },
|
|
11142
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11218
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11143
11219
|
{ },
|
|
11144
11220
|
{ },
|
|
11145
11221
|
null,
|
|
@@ -11186,6 +11262,7 @@ class ConversationsApi {
|
|
|
11186
11262
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11187
11263
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11188
11264
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11265
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11189
11266
|
*/
|
|
11190
11267
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
11191
11268
|
opts = opts || {};
|
|
@@ -11195,7 +11272,7 @@ class ConversationsApi {
|
|
|
11195
11272
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
11196
11273
|
'GET',
|
|
11197
11274
|
{ },
|
|
11198
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11275
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11199
11276
|
{ },
|
|
11200
11277
|
{ },
|
|
11201
11278
|
null,
|
|
@@ -11242,6 +11319,7 @@ class ConversationsApi {
|
|
|
11242
11319
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11243
11320
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
11244
11321
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
11322
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
11245
11323
|
*/
|
|
11246
11324
|
getConversationsMessagingIntegrationsWhatsapp(opts) {
|
|
11247
11325
|
opts = opts || {};
|
|
@@ -11251,7 +11329,7 @@ class ConversationsApi {
|
|
|
11251
11329
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
11252
11330
|
'GET',
|
|
11253
11331
|
{ },
|
|
11254
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
11332
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
11255
11333
|
{ },
|
|
11256
11334
|
{ },
|
|
11257
11335
|
null,
|
|
@@ -14527,7 +14605,7 @@ class DataExtensionsApi {
|
|
|
14527
14605
|
/**
|
|
14528
14606
|
* DataExtensions service.
|
|
14529
14607
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14530
|
-
* @version
|
|
14608
|
+
* @version 153.0.0
|
|
14531
14609
|
*/
|
|
14532
14610
|
|
|
14533
14611
|
/**
|
|
@@ -14613,7 +14691,7 @@ class DownloadsApi {
|
|
|
14613
14691
|
/**
|
|
14614
14692
|
* Downloads service.
|
|
14615
14693
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14616
|
-
* @version
|
|
14694
|
+
* @version 153.0.0
|
|
14617
14695
|
*/
|
|
14618
14696
|
|
|
14619
14697
|
/**
|
|
@@ -14665,7 +14743,7 @@ class EventsApi {
|
|
|
14665
14743
|
/**
|
|
14666
14744
|
* Events service.
|
|
14667
14745
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14668
|
-
* @version
|
|
14746
|
+
* @version 153.0.0
|
|
14669
14747
|
*/
|
|
14670
14748
|
|
|
14671
14749
|
/**
|
|
@@ -14761,7 +14839,7 @@ class ExternalContactsApi {
|
|
|
14761
14839
|
/**
|
|
14762
14840
|
* ExternalContacts service.
|
|
14763
14841
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14764
|
-
* @version
|
|
14842
|
+
* @version 153.0.0
|
|
14765
14843
|
*/
|
|
14766
14844
|
|
|
14767
14845
|
/**
|
|
@@ -16719,7 +16797,7 @@ class FaxApi {
|
|
|
16719
16797
|
/**
|
|
16720
16798
|
* Fax service.
|
|
16721
16799
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16722
|
-
* @version
|
|
16800
|
+
* @version 153.0.0
|
|
16723
16801
|
*/
|
|
16724
16802
|
|
|
16725
16803
|
/**
|
|
@@ -16890,7 +16968,7 @@ class FlowsApi {
|
|
|
16890
16968
|
/**
|
|
16891
16969
|
* Flows service.
|
|
16892
16970
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16893
|
-
* @version
|
|
16971
|
+
* @version 153.0.0
|
|
16894
16972
|
*/
|
|
16895
16973
|
|
|
16896
16974
|
/**
|
|
@@ -16961,7 +17039,7 @@ class GamificationApi {
|
|
|
16961
17039
|
/**
|
|
16962
17040
|
* Gamification service.
|
|
16963
17041
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16964
|
-
* @version
|
|
17042
|
+
* @version 153.0.0
|
|
16965
17043
|
*/
|
|
16966
17044
|
|
|
16967
17045
|
/**
|
|
@@ -17179,36 +17257,6 @@ class GamificationApi {
|
|
|
17179
17257
|
);
|
|
17180
17258
|
}
|
|
17181
17259
|
|
|
17182
|
-
/**
|
|
17183
|
-
* Gamified metric by id
|
|
17184
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
17185
|
-
* @param {String} metricId metric Id
|
|
17186
|
-
* @param {Object} opts Optional parameters
|
|
17187
|
-
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17188
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
17189
|
-
*/
|
|
17190
|
-
getGamificationMetric(metricId, opts) {
|
|
17191
|
-
opts = opts || {};
|
|
17192
|
-
|
|
17193
|
-
// verify the required parameter 'metricId' is set
|
|
17194
|
-
if (metricId === undefined || metricId === null) {
|
|
17195
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
17196
|
-
}
|
|
17197
|
-
|
|
17198
|
-
return this.apiClient.callApi(
|
|
17199
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
17200
|
-
'GET',
|
|
17201
|
-
{ 'metricId': metricId },
|
|
17202
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
17203
|
-
{ },
|
|
17204
|
-
{ },
|
|
17205
|
-
null,
|
|
17206
|
-
['PureCloud OAuth'],
|
|
17207
|
-
['application/json'],
|
|
17208
|
-
['application/json']
|
|
17209
|
-
);
|
|
17210
|
-
}
|
|
17211
|
-
|
|
17212
17260
|
/**
|
|
17213
17261
|
* Metric definition by id
|
|
17214
17262
|
*
|
|
@@ -18513,40 +18561,6 @@ class GamificationApi {
|
|
|
18513
18561
|
);
|
|
18514
18562
|
}
|
|
18515
18563
|
|
|
18516
|
-
/**
|
|
18517
|
-
* Updates a metric
|
|
18518
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
18519
|
-
* @param {String} metricId metric Id
|
|
18520
|
-
* @param {Object} body Metric
|
|
18521
|
-
* @param {Object} opts Optional parameters
|
|
18522
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
18523
|
-
*/
|
|
18524
|
-
putGamificationMetric(metricId, body, opts) {
|
|
18525
|
-
opts = opts || {};
|
|
18526
|
-
|
|
18527
|
-
// verify the required parameter 'metricId' is set
|
|
18528
|
-
if (metricId === undefined || metricId === null) {
|
|
18529
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
18530
|
-
}
|
|
18531
|
-
// verify the required parameter 'body' is set
|
|
18532
|
-
if (body === undefined || body === null) {
|
|
18533
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
18534
|
-
}
|
|
18535
|
-
|
|
18536
|
-
return this.apiClient.callApi(
|
|
18537
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
18538
|
-
'PUT',
|
|
18539
|
-
{ 'metricId': metricId },
|
|
18540
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
18541
|
-
{ },
|
|
18542
|
-
{ },
|
|
18543
|
-
body,
|
|
18544
|
-
['PureCloud OAuth'],
|
|
18545
|
-
['application/json'],
|
|
18546
|
-
['application/json']
|
|
18547
|
-
);
|
|
18548
|
-
}
|
|
18549
|
-
|
|
18550
18564
|
/**
|
|
18551
18565
|
* Updates a performance profile
|
|
18552
18566
|
*
|
|
@@ -18642,7 +18656,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18642
18656
|
/**
|
|
18643
18657
|
* GeneralDataProtectionRegulation service.
|
|
18644
18658
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18645
|
-
* @version
|
|
18659
|
+
* @version 153.0.0
|
|
18646
18660
|
*/
|
|
18647
18661
|
|
|
18648
18662
|
/**
|
|
@@ -18772,7 +18786,7 @@ class GeolocationApi {
|
|
|
18772
18786
|
/**
|
|
18773
18787
|
* Geolocation service.
|
|
18774
18788
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18775
|
-
* @version
|
|
18789
|
+
* @version 153.0.0
|
|
18776
18790
|
*/
|
|
18777
18791
|
|
|
18778
18792
|
/**
|
|
@@ -18903,7 +18917,7 @@ class GreetingsApi {
|
|
|
18903
18917
|
/**
|
|
18904
18918
|
* Greetings service.
|
|
18905
18919
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18906
|
-
* @version
|
|
18920
|
+
* @version 153.0.0
|
|
18907
18921
|
*/
|
|
18908
18922
|
|
|
18909
18923
|
/**
|
|
@@ -19358,7 +19372,7 @@ class GroupsApi {
|
|
|
19358
19372
|
/**
|
|
19359
19373
|
* Groups service.
|
|
19360
19374
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19361
|
-
* @version
|
|
19375
|
+
* @version 153.0.0
|
|
19362
19376
|
*/
|
|
19363
19377
|
|
|
19364
19378
|
/**
|
|
@@ -19764,7 +19778,7 @@ class IdentityProviderApi {
|
|
|
19764
19778
|
/**
|
|
19765
19779
|
* IdentityProvider service.
|
|
19766
19780
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19767
|
-
* @version
|
|
19781
|
+
* @version 153.0.0
|
|
19768
19782
|
*/
|
|
19769
19783
|
|
|
19770
19784
|
/**
|
|
@@ -20520,7 +20534,7 @@ class IntegrationsApi {
|
|
|
20520
20534
|
/**
|
|
20521
20535
|
* Integrations service.
|
|
20522
20536
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20523
|
-
* @version
|
|
20537
|
+
* @version 153.0.0
|
|
20524
20538
|
*/
|
|
20525
20539
|
|
|
20526
20540
|
/**
|
|
@@ -22120,7 +22134,7 @@ class JourneyApi {
|
|
|
22120
22134
|
/**
|
|
22121
22135
|
* Journey service.
|
|
22122
22136
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22123
|
-
* @version
|
|
22137
|
+
* @version 153.0.0
|
|
22124
22138
|
*/
|
|
22125
22139
|
|
|
22126
22140
|
/**
|
|
@@ -22906,7 +22920,7 @@ class KnowledgeApi {
|
|
|
22906
22920
|
/**
|
|
22907
22921
|
* Knowledge service.
|
|
22908
22922
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22909
|
-
* @version
|
|
22923
|
+
* @version 153.0.0
|
|
22910
22924
|
*/
|
|
22911
22925
|
|
|
22912
22926
|
/**
|
|
@@ -23309,8 +23323,8 @@ class KnowledgeApi {
|
|
|
23309
23323
|
* @param {String} sessionId Knowledge guest session ID.
|
|
23310
23324
|
* @param {Object} opts Optional parameters
|
|
23311
23325
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23312
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23313
|
-
* @param {
|
|
23326
|
+
* @param {Boolean} opts.includeSubcategories Deprecated - Do Not Use. Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23327
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
23314
23328
|
*/
|
|
23315
23329
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
23316
23330
|
opts = opts || {};
|
|
@@ -25339,7 +25353,7 @@ class LanguageUnderstandingApi {
|
|
|
25339
25353
|
/**
|
|
25340
25354
|
* LanguageUnderstanding service.
|
|
25341
25355
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25342
|
-
* @version
|
|
25356
|
+
* @version 153.0.0
|
|
25343
25357
|
*/
|
|
25344
25358
|
|
|
25345
25359
|
/**
|
|
@@ -26243,7 +26257,7 @@ class LanguagesApi {
|
|
|
26243
26257
|
/**
|
|
26244
26258
|
* Languages service.
|
|
26245
26259
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26246
|
-
* @version
|
|
26260
|
+
* @version 153.0.0
|
|
26247
26261
|
*/
|
|
26248
26262
|
|
|
26249
26263
|
/**
|
|
@@ -26511,7 +26525,7 @@ class LearningApi {
|
|
|
26511
26525
|
/**
|
|
26512
26526
|
* Learning service.
|
|
26513
26527
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26514
|
-
* @version
|
|
26528
|
+
* @version 153.0.0
|
|
26515
26529
|
*/
|
|
26516
26530
|
|
|
26517
26531
|
/**
|
|
@@ -27271,7 +27285,7 @@ class LicenseApi {
|
|
|
27271
27285
|
/**
|
|
27272
27286
|
* License service.
|
|
27273
27287
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27274
|
-
* @version
|
|
27288
|
+
* @version 153.0.0
|
|
27275
27289
|
*/
|
|
27276
27290
|
|
|
27277
27291
|
/**
|
|
@@ -27509,7 +27523,7 @@ class LocationsApi {
|
|
|
27509
27523
|
/**
|
|
27510
27524
|
* Locations service.
|
|
27511
27525
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27512
|
-
* @version
|
|
27526
|
+
* @version 153.0.0
|
|
27513
27527
|
*/
|
|
27514
27528
|
|
|
27515
27529
|
/**
|
|
@@ -27745,7 +27759,7 @@ class MessagingApi {
|
|
|
27745
27759
|
/**
|
|
27746
27760
|
* Messaging service.
|
|
27747
27761
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27748
|
-
* @version
|
|
27762
|
+
* @version 153.0.0
|
|
27749
27763
|
*/
|
|
27750
27764
|
|
|
27751
27765
|
/**
|
|
@@ -27896,7 +27910,7 @@ class MobileDevicesApi {
|
|
|
27896
27910
|
/**
|
|
27897
27911
|
* MobileDevices service.
|
|
27898
27912
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27899
|
-
* @version
|
|
27913
|
+
* @version 153.0.0
|
|
27900
27914
|
*/
|
|
27901
27915
|
|
|
27902
27916
|
/**
|
|
@@ -28047,7 +28061,7 @@ class NotificationsApi {
|
|
|
28047
28061
|
/**
|
|
28048
28062
|
* Notifications service.
|
|
28049
28063
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28050
|
-
* @version
|
|
28064
|
+
* @version 153.0.0
|
|
28051
28065
|
*/
|
|
28052
28066
|
|
|
28053
28067
|
/**
|
|
@@ -28272,7 +28286,7 @@ class OAuthApi {
|
|
|
28272
28286
|
/**
|
|
28273
28287
|
* OAuth service.
|
|
28274
28288
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28275
|
-
* @version
|
|
28289
|
+
* @version 153.0.0
|
|
28276
28290
|
*/
|
|
28277
28291
|
|
|
28278
28292
|
/**
|
|
@@ -28638,7 +28652,7 @@ class ObjectsApi {
|
|
|
28638
28652
|
/**
|
|
28639
28653
|
* Objects service.
|
|
28640
28654
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28641
|
-
* @version
|
|
28655
|
+
* @version 153.0.0
|
|
28642
28656
|
*/
|
|
28643
28657
|
|
|
28644
28658
|
/**
|
|
@@ -28909,7 +28923,7 @@ class OrganizationApi {
|
|
|
28909
28923
|
/**
|
|
28910
28924
|
* Organization service.
|
|
28911
28925
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28912
|
-
* @version
|
|
28926
|
+
* @version 153.0.0
|
|
28913
28927
|
*/
|
|
28914
28928
|
|
|
28915
28929
|
/**
|
|
@@ -29312,7 +29326,7 @@ class OrganizationAuthorizationApi {
|
|
|
29312
29326
|
/**
|
|
29313
29327
|
* OrganizationAuthorization service.
|
|
29314
29328
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29315
|
-
* @version
|
|
29329
|
+
* @version 153.0.0
|
|
29316
29330
|
*/
|
|
29317
29331
|
|
|
29318
29332
|
/**
|
|
@@ -30237,7 +30251,7 @@ class OutboundApi {
|
|
|
30237
30251
|
/**
|
|
30238
30252
|
* Outbound service.
|
|
30239
30253
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30240
|
-
* @version
|
|
30254
|
+
* @version 153.0.0
|
|
30241
30255
|
*/
|
|
30242
30256
|
|
|
30243
30257
|
/**
|
|
@@ -33626,7 +33640,7 @@ class PresenceApi {
|
|
|
33626
33640
|
/**
|
|
33627
33641
|
* Presence service.
|
|
33628
33642
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33629
|
-
* @version
|
|
33643
|
+
* @version 153.0.0
|
|
33630
33644
|
*/
|
|
33631
33645
|
|
|
33632
33646
|
/**
|
|
@@ -34132,7 +34146,7 @@ class ProcessAutomationApi {
|
|
|
34132
34146
|
/**
|
|
34133
34147
|
* ProcessAutomation service.
|
|
34134
34148
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34135
|
-
* @version
|
|
34149
|
+
* @version 153.0.0
|
|
34136
34150
|
*/
|
|
34137
34151
|
|
|
34138
34152
|
/**
|
|
@@ -34370,7 +34384,7 @@ class QualityApi {
|
|
|
34370
34384
|
/**
|
|
34371
34385
|
* Quality service.
|
|
34372
34386
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34373
|
-
* @version
|
|
34387
|
+
* @version 153.0.0
|
|
34374
34388
|
*/
|
|
34375
34389
|
|
|
34376
34390
|
/**
|
|
@@ -35948,7 +35962,7 @@ class RecordingApi {
|
|
|
35948
35962
|
/**
|
|
35949
35963
|
* Recording service.
|
|
35950
35964
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35951
|
-
* @version
|
|
35965
|
+
* @version 153.0.0
|
|
35952
35966
|
*/
|
|
35953
35967
|
|
|
35954
35968
|
/**
|
|
@@ -37635,7 +37649,7 @@ class ResponseManagementApi {
|
|
|
37635
37649
|
/**
|
|
37636
37650
|
* ResponseManagement service.
|
|
37637
37651
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37638
|
-
* @version
|
|
37652
|
+
* @version 153.0.0
|
|
37639
37653
|
*/
|
|
37640
37654
|
|
|
37641
37655
|
/**
|
|
@@ -38119,7 +38133,7 @@ class RoutingApi {
|
|
|
38119
38133
|
/**
|
|
38120
38134
|
* Routing service.
|
|
38121
38135
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38122
|
-
* @version
|
|
38136
|
+
* @version 153.0.0
|
|
38123
38137
|
*/
|
|
38124
38138
|
|
|
38125
38139
|
/**
|
|
@@ -38428,6 +38442,31 @@ class RoutingApi {
|
|
|
38428
38442
|
);
|
|
38429
38443
|
}
|
|
38430
38444
|
|
|
38445
|
+
/**
|
|
38446
|
+
* Remove skill group definition
|
|
38447
|
+
*
|
|
38448
|
+
* @param {String} skillGroupId Skill Group ID
|
|
38449
|
+
*/
|
|
38450
|
+
deleteRoutingSkillgroup(skillGroupId) {
|
|
38451
|
+
// verify the required parameter 'skillGroupId' is set
|
|
38452
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
38453
|
+
throw 'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';
|
|
38454
|
+
}
|
|
38455
|
+
|
|
38456
|
+
return this.apiClient.callApi(
|
|
38457
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
38458
|
+
'DELETE',
|
|
38459
|
+
{ 'skillGroupId': skillGroupId },
|
|
38460
|
+
{ },
|
|
38461
|
+
{ },
|
|
38462
|
+
{ },
|
|
38463
|
+
null,
|
|
38464
|
+
['PureCloud OAuth'],
|
|
38465
|
+
['application/json'],
|
|
38466
|
+
['application/json']
|
|
38467
|
+
);
|
|
38468
|
+
}
|
|
38469
|
+
|
|
38431
38470
|
/**
|
|
38432
38471
|
* Delete an Address by Id for SMS
|
|
38433
38472
|
*
|
|
@@ -38820,6 +38859,8 @@ class RoutingApi {
|
|
|
38820
38859
|
* Get domains
|
|
38821
38860
|
*
|
|
38822
38861
|
* @param {Object} opts Optional parameters
|
|
38862
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38863
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38823
38864
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
38824
38865
|
*/
|
|
38825
38866
|
getRoutingEmailDomains(opts) {
|
|
@@ -38830,7 +38871,7 @@ class RoutingApi {
|
|
|
38830
38871
|
'/api/v2/routing/email/domains',
|
|
38831
38872
|
'GET',
|
|
38832
38873
|
{ },
|
|
38833
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
38874
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
38834
38875
|
{ },
|
|
38835
38876
|
{ },
|
|
38836
38877
|
null,
|
|
@@ -39613,6 +39654,119 @@ class RoutingApi {
|
|
|
39613
39654
|
);
|
|
39614
39655
|
}
|
|
39615
39656
|
|
|
39657
|
+
/**
|
|
39658
|
+
* Get skill group
|
|
39659
|
+
*
|
|
39660
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39661
|
+
*/
|
|
39662
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
39663
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39664
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39665
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
39666
|
+
}
|
|
39667
|
+
|
|
39668
|
+
return this.apiClient.callApi(
|
|
39669
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
39670
|
+
'GET',
|
|
39671
|
+
{ 'skillGroupId': skillGroupId },
|
|
39672
|
+
{ },
|
|
39673
|
+
{ },
|
|
39674
|
+
{ },
|
|
39675
|
+
null,
|
|
39676
|
+
['PureCloud OAuth'],
|
|
39677
|
+
['application/json'],
|
|
39678
|
+
['application/json']
|
|
39679
|
+
);
|
|
39680
|
+
}
|
|
39681
|
+
|
|
39682
|
+
/**
|
|
39683
|
+
* Get skill group members
|
|
39684
|
+
*
|
|
39685
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39686
|
+
* @param {Object} opts Optional parameters
|
|
39687
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39688
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
39689
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
39690
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
39691
|
+
*/
|
|
39692
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
39693
|
+
opts = opts || {};
|
|
39694
|
+
|
|
39695
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39696
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39697
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
39698
|
+
}
|
|
39699
|
+
|
|
39700
|
+
return this.apiClient.callApi(
|
|
39701
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
39702
|
+
'GET',
|
|
39703
|
+
{ 'skillGroupId': skillGroupId },
|
|
39704
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
39705
|
+
{ },
|
|
39706
|
+
{ },
|
|
39707
|
+
null,
|
|
39708
|
+
['PureCloud OAuth'],
|
|
39709
|
+
['application/json'],
|
|
39710
|
+
['application/json']
|
|
39711
|
+
);
|
|
39712
|
+
}
|
|
39713
|
+
|
|
39714
|
+
/**
|
|
39715
|
+
* Get list of member divisions for this skill group.
|
|
39716
|
+
*
|
|
39717
|
+
* @param {String} skillGroupId Skill Group ID
|
|
39718
|
+
* @param {Object} opts Optional parameters
|
|
39719
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
39720
|
+
*/
|
|
39721
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
39722
|
+
opts = opts || {};
|
|
39723
|
+
|
|
39724
|
+
// verify the required parameter 'skillGroupId' is set
|
|
39725
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
39726
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
39727
|
+
}
|
|
39728
|
+
|
|
39729
|
+
return this.apiClient.callApi(
|
|
39730
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
39731
|
+
'GET',
|
|
39732
|
+
{ 'skillGroupId': skillGroupId },
|
|
39733
|
+
{ 'expand': opts['expand'] },
|
|
39734
|
+
{ },
|
|
39735
|
+
{ },
|
|
39736
|
+
null,
|
|
39737
|
+
['PureCloud OAuth'],
|
|
39738
|
+
['application/json'],
|
|
39739
|
+
['application/json']
|
|
39740
|
+
);
|
|
39741
|
+
}
|
|
39742
|
+
|
|
39743
|
+
/**
|
|
39744
|
+
* Get skill group listing
|
|
39745
|
+
*
|
|
39746
|
+
* @param {Object} opts Optional parameters
|
|
39747
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39748
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
39749
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
39750
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
39751
|
+
*/
|
|
39752
|
+
getRoutingSkillgroups(opts) {
|
|
39753
|
+
opts = opts || {};
|
|
39754
|
+
|
|
39755
|
+
|
|
39756
|
+
return this.apiClient.callApi(
|
|
39757
|
+
'/api/v2/routing/skillgroups',
|
|
39758
|
+
'GET',
|
|
39759
|
+
{ },
|
|
39760
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
39761
|
+
{ },
|
|
39762
|
+
{ },
|
|
39763
|
+
null,
|
|
39764
|
+
['PureCloud OAuth'],
|
|
39765
|
+
['application/json'],
|
|
39766
|
+
['application/json']
|
|
39767
|
+
);
|
|
39768
|
+
}
|
|
39769
|
+
|
|
39616
39770
|
/**
|
|
39617
39771
|
* Get the list of routing skills.
|
|
39618
39772
|
*
|
|
@@ -40251,6 +40405,36 @@ class RoutingApi {
|
|
|
40251
40405
|
);
|
|
40252
40406
|
}
|
|
40253
40407
|
|
|
40408
|
+
/**
|
|
40409
|
+
* Update skill group definition
|
|
40410
|
+
*
|
|
40411
|
+
* @param {String} skillGroupId Skill Group ID
|
|
40412
|
+
* @param {Object} body Update skill groups
|
|
40413
|
+
*/
|
|
40414
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
40415
|
+
// verify the required parameter 'skillGroupId' is set
|
|
40416
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
40417
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
40418
|
+
}
|
|
40419
|
+
// verify the required parameter 'body' is set
|
|
40420
|
+
if (body === undefined || body === null) {
|
|
40421
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
40422
|
+
}
|
|
40423
|
+
|
|
40424
|
+
return this.apiClient.callApi(
|
|
40425
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
40426
|
+
'PATCH',
|
|
40427
|
+
{ 'skillGroupId': skillGroupId },
|
|
40428
|
+
{ },
|
|
40429
|
+
{ },
|
|
40430
|
+
{ },
|
|
40431
|
+
body,
|
|
40432
|
+
['PureCloud OAuth'],
|
|
40433
|
+
['application/json'],
|
|
40434
|
+
['application/json']
|
|
40435
|
+
);
|
|
40436
|
+
}
|
|
40437
|
+
|
|
40254
40438
|
/**
|
|
40255
40439
|
* Join or unjoin a queue for a user
|
|
40256
40440
|
*
|
|
@@ -40794,6 +40978,60 @@ class RoutingApi {
|
|
|
40794
40978
|
);
|
|
40795
40979
|
}
|
|
40796
40980
|
|
|
40981
|
+
/**
|
|
40982
|
+
* Add or remove member divisions for this skill group.
|
|
40983
|
+
*
|
|
40984
|
+
* @param {String} skillGroupId Skill Group ID
|
|
40985
|
+
* @param {Object} opts Optional parameters
|
|
40986
|
+
* @param {Object} opts.body
|
|
40987
|
+
*/
|
|
40988
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
40989
|
+
opts = opts || {};
|
|
40990
|
+
|
|
40991
|
+
// verify the required parameter 'skillGroupId' is set
|
|
40992
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
40993
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
40994
|
+
}
|
|
40995
|
+
|
|
40996
|
+
return this.apiClient.callApi(
|
|
40997
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
40998
|
+
'POST',
|
|
40999
|
+
{ 'skillGroupId': skillGroupId },
|
|
41000
|
+
{ },
|
|
41001
|
+
{ },
|
|
41002
|
+
{ },
|
|
41003
|
+
opts['body'],
|
|
41004
|
+
['PureCloud OAuth'],
|
|
41005
|
+
['application/json'],
|
|
41006
|
+
['application/json']
|
|
41007
|
+
);
|
|
41008
|
+
}
|
|
41009
|
+
|
|
41010
|
+
/**
|
|
41011
|
+
* Create a skill group
|
|
41012
|
+
*
|
|
41013
|
+
* @param {Object} body Create skill group
|
|
41014
|
+
*/
|
|
41015
|
+
postRoutingSkillgroups(body) {
|
|
41016
|
+
// verify the required parameter 'body' is set
|
|
41017
|
+
if (body === undefined || body === null) {
|
|
41018
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
41019
|
+
}
|
|
41020
|
+
|
|
41021
|
+
return this.apiClient.callApi(
|
|
41022
|
+
'/api/v2/routing/skillgroups',
|
|
41023
|
+
'POST',
|
|
41024
|
+
{ },
|
|
41025
|
+
{ },
|
|
41026
|
+
{ },
|
|
41027
|
+
{ },
|
|
41028
|
+
body,
|
|
41029
|
+
['PureCloud OAuth'],
|
|
41030
|
+
['application/json'],
|
|
41031
|
+
['application/json']
|
|
41032
|
+
);
|
|
41033
|
+
}
|
|
41034
|
+
|
|
40797
41035
|
/**
|
|
40798
41036
|
* Create Skill
|
|
40799
41037
|
*
|
|
@@ -41310,7 +41548,7 @@ class SCIMApi {
|
|
|
41310
41548
|
/**
|
|
41311
41549
|
* SCIM service.
|
|
41312
41550
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41313
|
-
* @version
|
|
41551
|
+
* @version 153.0.0
|
|
41314
41552
|
*/
|
|
41315
41553
|
|
|
41316
41554
|
/**
|
|
@@ -42187,7 +42425,7 @@ class ScriptsApi {
|
|
|
42187
42425
|
/**
|
|
42188
42426
|
* Scripts service.
|
|
42189
42427
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42190
|
-
* @version
|
|
42428
|
+
* @version 153.0.0
|
|
42191
42429
|
*/
|
|
42192
42430
|
|
|
42193
42431
|
/**
|
|
@@ -42606,7 +42844,7 @@ class SearchApi {
|
|
|
42606
42844
|
/**
|
|
42607
42845
|
* Search service.
|
|
42608
42846
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42609
|
-
* @version
|
|
42847
|
+
* @version 153.0.0
|
|
42610
42848
|
*/
|
|
42611
42849
|
|
|
42612
42850
|
/**
|
|
@@ -43191,7 +43429,7 @@ class SpeechTextAnalyticsApi {
|
|
|
43191
43429
|
/**
|
|
43192
43430
|
* SpeechTextAnalytics service.
|
|
43193
43431
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43194
|
-
* @version
|
|
43432
|
+
* @version 153.0.0
|
|
43195
43433
|
*/
|
|
43196
43434
|
|
|
43197
43435
|
/**
|
|
@@ -44045,7 +44283,7 @@ class StationsApi {
|
|
|
44045
44283
|
/**
|
|
44046
44284
|
* Stations service.
|
|
44047
44285
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44048
|
-
* @version
|
|
44286
|
+
* @version 153.0.0
|
|
44049
44287
|
*/
|
|
44050
44288
|
|
|
44051
44289
|
/**
|
|
@@ -44192,7 +44430,7 @@ class SuggestApi {
|
|
|
44192
44430
|
/**
|
|
44193
44431
|
* Suggest service.
|
|
44194
44432
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44195
|
-
* @version
|
|
44433
|
+
* @version 153.0.0
|
|
44196
44434
|
*/
|
|
44197
44435
|
|
|
44198
44436
|
/**
|
|
@@ -44331,7 +44569,7 @@ class TeamsApi {
|
|
|
44331
44569
|
/**
|
|
44332
44570
|
* Teams service.
|
|
44333
44571
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44334
|
-
* @version
|
|
44572
|
+
* @version 153.0.0
|
|
44335
44573
|
*/
|
|
44336
44574
|
|
|
44337
44575
|
/**
|
|
@@ -44602,7 +44840,7 @@ class TelephonyApi {
|
|
|
44602
44840
|
/**
|
|
44603
44841
|
* Telephony service.
|
|
44604
44842
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44605
|
-
* @version
|
|
44843
|
+
* @version 153.0.0
|
|
44606
44844
|
*/
|
|
44607
44845
|
|
|
44608
44846
|
/**
|
|
@@ -44710,7 +44948,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
44710
44948
|
/**
|
|
44711
44949
|
* TelephonyProvidersEdge service.
|
|
44712
44950
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44713
|
-
* @version
|
|
44951
|
+
* @version 153.0.0
|
|
44714
44952
|
*/
|
|
44715
44953
|
|
|
44716
44954
|
/**
|
|
@@ -48343,7 +48581,7 @@ class TextbotsApi {
|
|
|
48343
48581
|
/**
|
|
48344
48582
|
* Textbots service.
|
|
48345
48583
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48346
|
-
* @version
|
|
48584
|
+
* @version 153.0.0
|
|
48347
48585
|
*/
|
|
48348
48586
|
|
|
48349
48587
|
/**
|
|
@@ -48471,7 +48709,7 @@ class TokensApi {
|
|
|
48471
48709
|
/**
|
|
48472
48710
|
* Tokens service.
|
|
48473
48711
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48474
|
-
* @version
|
|
48712
|
+
* @version 153.0.0
|
|
48475
48713
|
*/
|
|
48476
48714
|
|
|
48477
48715
|
/**
|
|
@@ -48577,7 +48815,7 @@ class UploadsApi {
|
|
|
48577
48815
|
/**
|
|
48578
48816
|
* Uploads service.
|
|
48579
48817
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48580
|
-
* @version
|
|
48818
|
+
* @version 153.0.0
|
|
48581
48819
|
*/
|
|
48582
48820
|
|
|
48583
48821
|
/**
|
|
@@ -48753,7 +48991,7 @@ class UsageApi {
|
|
|
48753
48991
|
/**
|
|
48754
48992
|
* Usage service.
|
|
48755
48993
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48756
|
-
* @version
|
|
48994
|
+
* @version 153.0.0
|
|
48757
48995
|
*/
|
|
48758
48996
|
|
|
48759
48997
|
/**
|
|
@@ -48824,7 +49062,7 @@ class UserRecordingsApi {
|
|
|
48824
49062
|
/**
|
|
48825
49063
|
* UserRecordings service.
|
|
48826
49064
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
48827
|
-
* @version
|
|
49065
|
+
* @version 153.0.0
|
|
48828
49066
|
*/
|
|
48829
49067
|
|
|
48830
49068
|
/**
|
|
@@ -49009,7 +49247,7 @@ class UsersApi {
|
|
|
49009
49247
|
/**
|
|
49010
49248
|
* Users service.
|
|
49011
49249
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49012
|
-
* @version
|
|
49250
|
+
* @version 153.0.0
|
|
49013
49251
|
*/
|
|
49014
49252
|
|
|
49015
49253
|
/**
|
|
@@ -51366,7 +51604,7 @@ class UtilitiesApi {
|
|
|
51366
51604
|
/**
|
|
51367
51605
|
* Utilities service.
|
|
51368
51606
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51369
|
-
* @version
|
|
51607
|
+
* @version 153.0.0
|
|
51370
51608
|
*/
|
|
51371
51609
|
|
|
51372
51610
|
/**
|
|
@@ -51477,7 +51715,7 @@ class VoicemailApi {
|
|
|
51477
51715
|
/**
|
|
51478
51716
|
* Voicemail service.
|
|
51479
51717
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51480
|
-
* @version
|
|
51718
|
+
* @version 153.0.0
|
|
51481
51719
|
*/
|
|
51482
51720
|
|
|
51483
51721
|
/**
|
|
@@ -52144,7 +52382,7 @@ class WebChatApi {
|
|
|
52144
52382
|
/**
|
|
52145
52383
|
* WebChat service.
|
|
52146
52384
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52147
|
-
* @version
|
|
52385
|
+
* @version 153.0.0
|
|
52148
52386
|
*/
|
|
52149
52387
|
|
|
52150
52388
|
/**
|
|
@@ -52688,7 +52926,7 @@ class WebDeploymentsApi {
|
|
|
52688
52926
|
/**
|
|
52689
52927
|
* WebDeployments service.
|
|
52690
52928
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52691
|
-
* @version
|
|
52929
|
+
* @version 153.0.0
|
|
52692
52930
|
*/
|
|
52693
52931
|
|
|
52694
52932
|
/**
|
|
@@ -53076,7 +53314,7 @@ class WebMessagingApi {
|
|
|
53076
53314
|
/**
|
|
53077
53315
|
* WebMessaging service.
|
|
53078
53316
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53079
|
-
* @version
|
|
53317
|
+
* @version 153.0.0
|
|
53080
53318
|
*/
|
|
53081
53319
|
|
|
53082
53320
|
/**
|
|
@@ -53122,7 +53360,7 @@ class WidgetsApi {
|
|
|
53122
53360
|
/**
|
|
53123
53361
|
* Widgets service.
|
|
53124
53362
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53125
|
-
* @version
|
|
53363
|
+
* @version 153.0.0
|
|
53126
53364
|
*/
|
|
53127
53365
|
|
|
53128
53366
|
/**
|
|
@@ -53268,7 +53506,7 @@ class WorkforceManagementApi {
|
|
|
53268
53506
|
/**
|
|
53269
53507
|
* WorkforceManagement service.
|
|
53270
53508
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53271
|
-
* @version
|
|
53509
|
+
* @version 153.0.0
|
|
53272
53510
|
*/
|
|
53273
53511
|
|
|
53274
53512
|
/**
|
|
@@ -53688,6 +53926,56 @@ class WorkforceManagementApi {
|
|
|
53688
53926
|
);
|
|
53689
53927
|
}
|
|
53690
53928
|
|
|
53929
|
+
/**
|
|
53930
|
+
* Get an adherence explanation for the current user
|
|
53931
|
+
*
|
|
53932
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
53933
|
+
*/
|
|
53934
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
53935
|
+
// verify the required parameter 'explanationId' is set
|
|
53936
|
+
if (explanationId === undefined || explanationId === null) {
|
|
53937
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
53938
|
+
}
|
|
53939
|
+
|
|
53940
|
+
return this.apiClient.callApi(
|
|
53941
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
53942
|
+
'GET',
|
|
53943
|
+
{ 'explanationId': explanationId },
|
|
53944
|
+
{ },
|
|
53945
|
+
{ },
|
|
53946
|
+
{ },
|
|
53947
|
+
null,
|
|
53948
|
+
['PureCloud OAuth'],
|
|
53949
|
+
['application/json'],
|
|
53950
|
+
['application/json']
|
|
53951
|
+
);
|
|
53952
|
+
}
|
|
53953
|
+
|
|
53954
|
+
/**
|
|
53955
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
53956
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
53957
|
+
* @param {String} jobId The ID of the job
|
|
53958
|
+
*/
|
|
53959
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
53960
|
+
// verify the required parameter 'jobId' is set
|
|
53961
|
+
if (jobId === undefined || jobId === null) {
|
|
53962
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
53963
|
+
}
|
|
53964
|
+
|
|
53965
|
+
return this.apiClient.callApi(
|
|
53966
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
53967
|
+
'GET',
|
|
53968
|
+
{ 'jobId': jobId },
|
|
53969
|
+
{ },
|
|
53970
|
+
{ },
|
|
53971
|
+
{ },
|
|
53972
|
+
null,
|
|
53973
|
+
['PureCloud OAuth'],
|
|
53974
|
+
['application/json'],
|
|
53975
|
+
['application/json']
|
|
53976
|
+
);
|
|
53977
|
+
}
|
|
53978
|
+
|
|
53691
53979
|
/**
|
|
53692
53980
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
53693
53981
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -53738,6 +54026,36 @@ class WorkforceManagementApi {
|
|
|
53738
54026
|
);
|
|
53739
54027
|
}
|
|
53740
54028
|
|
|
54029
|
+
/**
|
|
54030
|
+
* Get an adherence explanation
|
|
54031
|
+
*
|
|
54032
|
+
* @param {String} agentId The ID of the agent to query
|
|
54033
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
54034
|
+
*/
|
|
54035
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
54036
|
+
// verify the required parameter 'agentId' is set
|
|
54037
|
+
if (agentId === undefined || agentId === null) {
|
|
54038
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54039
|
+
}
|
|
54040
|
+
// verify the required parameter 'explanationId' is set
|
|
54041
|
+
if (explanationId === undefined || explanationId === null) {
|
|
54042
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54043
|
+
}
|
|
54044
|
+
|
|
54045
|
+
return this.apiClient.callApi(
|
|
54046
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
54047
|
+
'GET',
|
|
54048
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
54049
|
+
{ },
|
|
54050
|
+
{ },
|
|
54051
|
+
{ },
|
|
54052
|
+
null,
|
|
54053
|
+
['PureCloud OAuth'],
|
|
54054
|
+
['application/json'],
|
|
54055
|
+
['application/json']
|
|
54056
|
+
);
|
|
54057
|
+
}
|
|
54058
|
+
|
|
53741
54059
|
/**
|
|
53742
54060
|
* Get the management unit to which the agent belongs
|
|
53743
54061
|
*
|
|
@@ -55457,6 +55775,31 @@ class WorkforceManagementApi {
|
|
|
55457
55775
|
);
|
|
55458
55776
|
}
|
|
55459
55777
|
|
|
55778
|
+
/**
|
|
55779
|
+
* Request to fetch the status of the historical shrinkage query
|
|
55780
|
+
*
|
|
55781
|
+
* @param {String} jobId jobId
|
|
55782
|
+
*/
|
|
55783
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
55784
|
+
// verify the required parameter 'jobId' is set
|
|
55785
|
+
if (jobId === undefined || jobId === null) {
|
|
55786
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
55787
|
+
}
|
|
55788
|
+
|
|
55789
|
+
return this.apiClient.callApi(
|
|
55790
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
55791
|
+
'GET',
|
|
55792
|
+
{ 'jobId': jobId },
|
|
55793
|
+
{ },
|
|
55794
|
+
{ },
|
|
55795
|
+
{ },
|
|
55796
|
+
null,
|
|
55797
|
+
['PureCloud OAuth'],
|
|
55798
|
+
['application/json'],
|
|
55799
|
+
['application/json']
|
|
55800
|
+
);
|
|
55801
|
+
}
|
|
55802
|
+
|
|
55460
55803
|
/**
|
|
55461
55804
|
* Get a time off request for the current user
|
|
55462
55805
|
*
|
|
@@ -55531,6 +55874,41 @@ class WorkforceManagementApi {
|
|
|
55531
55874
|
);
|
|
55532
55875
|
}
|
|
55533
55876
|
|
|
55877
|
+
/**
|
|
55878
|
+
* Update an adherence explanation
|
|
55879
|
+
*
|
|
55880
|
+
* @param {String} agentId The ID of the agent to query
|
|
55881
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55882
|
+
* @param {Object} body The request body
|
|
55883
|
+
*/
|
|
55884
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
55885
|
+
// verify the required parameter 'agentId' is set
|
|
55886
|
+
if (agentId === undefined || agentId === null) {
|
|
55887
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55888
|
+
}
|
|
55889
|
+
// verify the required parameter 'explanationId' is set
|
|
55890
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55891
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55892
|
+
}
|
|
55893
|
+
// verify the required parameter 'body' is set
|
|
55894
|
+
if (body === undefined || body === null) {
|
|
55895
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55896
|
+
}
|
|
55897
|
+
|
|
55898
|
+
return this.apiClient.callApi(
|
|
55899
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
55900
|
+
'PATCH',
|
|
55901
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
55902
|
+
{ },
|
|
55903
|
+
{ },
|
|
55904
|
+
{ },
|
|
55905
|
+
body,
|
|
55906
|
+
['PureCloud OAuth'],
|
|
55907
|
+
['application/json'],
|
|
55908
|
+
['application/json']
|
|
55909
|
+
);
|
|
55910
|
+
}
|
|
55911
|
+
|
|
55534
55912
|
/**
|
|
55535
55913
|
* Update business unit
|
|
55536
55914
|
*
|
|
@@ -55970,6 +56348,61 @@ class WorkforceManagementApi {
|
|
|
55970
56348
|
);
|
|
55971
56349
|
}
|
|
55972
56350
|
|
|
56351
|
+
/**
|
|
56352
|
+
* Submit an adherence explanation for the current user
|
|
56353
|
+
*
|
|
56354
|
+
* @param {Object} body The request body
|
|
56355
|
+
*/
|
|
56356
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
56357
|
+
// verify the required parameter 'body' is set
|
|
56358
|
+
if (body === undefined || body === null) {
|
|
56359
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
56360
|
+
}
|
|
56361
|
+
|
|
56362
|
+
return this.apiClient.callApi(
|
|
56363
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
56364
|
+
'POST',
|
|
56365
|
+
{ },
|
|
56366
|
+
{ },
|
|
56367
|
+
{ },
|
|
56368
|
+
{ },
|
|
56369
|
+
body,
|
|
56370
|
+
['PureCloud OAuth'],
|
|
56371
|
+
['application/json'],
|
|
56372
|
+
['application/json']
|
|
56373
|
+
);
|
|
56374
|
+
}
|
|
56375
|
+
|
|
56376
|
+
/**
|
|
56377
|
+
* Query adherence explanations for the current user
|
|
56378
|
+
*
|
|
56379
|
+
* @param {Object} body The request body
|
|
56380
|
+
* @param {Object} opts Optional parameters
|
|
56381
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56382
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56383
|
+
*/
|
|
56384
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
56385
|
+
opts = opts || {};
|
|
56386
|
+
|
|
56387
|
+
// verify the required parameter 'body' is set
|
|
56388
|
+
if (body === undefined || body === null) {
|
|
56389
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
56390
|
+
}
|
|
56391
|
+
|
|
56392
|
+
return this.apiClient.callApi(
|
|
56393
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
56394
|
+
'POST',
|
|
56395
|
+
{ },
|
|
56396
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56397
|
+
{ },
|
|
56398
|
+
{ },
|
|
56399
|
+
body,
|
|
56400
|
+
['PureCloud OAuth'],
|
|
56401
|
+
['application/json'],
|
|
56402
|
+
['application/json']
|
|
56403
|
+
);
|
|
56404
|
+
}
|
|
56405
|
+
|
|
55973
56406
|
/**
|
|
55974
56407
|
* Request a historical adherence report for users across management units
|
|
55975
56408
|
*
|
|
@@ -55994,6 +56427,71 @@ class WorkforceManagementApi {
|
|
|
55994
56427
|
);
|
|
55995
56428
|
}
|
|
55996
56429
|
|
|
56430
|
+
/**
|
|
56431
|
+
* Add an adherence explanation for the requested user
|
|
56432
|
+
*
|
|
56433
|
+
* @param {String} agentId The ID of the agent to query
|
|
56434
|
+
* @param {Object} body The request body
|
|
56435
|
+
*/
|
|
56436
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
56437
|
+
// verify the required parameter 'agentId' is set
|
|
56438
|
+
if (agentId === undefined || agentId === null) {
|
|
56439
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56440
|
+
}
|
|
56441
|
+
// verify the required parameter 'body' is set
|
|
56442
|
+
if (body === undefined || body === null) {
|
|
56443
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56444
|
+
}
|
|
56445
|
+
|
|
56446
|
+
return this.apiClient.callApi(
|
|
56447
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
56448
|
+
'POST',
|
|
56449
|
+
{ 'agentId': agentId },
|
|
56450
|
+
{ },
|
|
56451
|
+
{ },
|
|
56452
|
+
{ },
|
|
56453
|
+
body,
|
|
56454
|
+
['PureCloud OAuth'],
|
|
56455
|
+
['application/json'],
|
|
56456
|
+
['application/json']
|
|
56457
|
+
);
|
|
56458
|
+
}
|
|
56459
|
+
|
|
56460
|
+
/**
|
|
56461
|
+
* Query adherence explanations for the given agent across a specified range
|
|
56462
|
+
*
|
|
56463
|
+
* @param {String} agentId The ID of the agent to query
|
|
56464
|
+
* @param {Object} body The request body
|
|
56465
|
+
* @param {Object} opts Optional parameters
|
|
56466
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56467
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56468
|
+
*/
|
|
56469
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
56470
|
+
opts = opts || {};
|
|
56471
|
+
|
|
56472
|
+
// verify the required parameter 'agentId' is set
|
|
56473
|
+
if (agentId === undefined || agentId === null) {
|
|
56474
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56475
|
+
}
|
|
56476
|
+
// verify the required parameter 'body' is set
|
|
56477
|
+
if (body === undefined || body === null) {
|
|
56478
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56479
|
+
}
|
|
56480
|
+
|
|
56481
|
+
return this.apiClient.callApi(
|
|
56482
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
56483
|
+
'POST',
|
|
56484
|
+
{ 'agentId': agentId },
|
|
56485
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56486
|
+
{ },
|
|
56487
|
+
{ },
|
|
56488
|
+
body,
|
|
56489
|
+
['PureCloud OAuth'],
|
|
56490
|
+
['application/json'],
|
|
56491
|
+
['application/json']
|
|
56492
|
+
);
|
|
56493
|
+
}
|
|
56494
|
+
|
|
55997
56495
|
/**
|
|
55998
56496
|
* Get published schedule for the current user
|
|
55999
56497
|
*
|
|
@@ -56047,6 +56545,41 @@ class WorkforceManagementApi {
|
|
|
56047
56545
|
);
|
|
56048
56546
|
}
|
|
56049
56547
|
|
|
56548
|
+
/**
|
|
56549
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
56550
|
+
*
|
|
56551
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
56552
|
+
* @param {Object} body The request body
|
|
56553
|
+
* @param {Object} opts Optional parameters
|
|
56554
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56555
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56556
|
+
*/
|
|
56557
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
56558
|
+
opts = opts || {};
|
|
56559
|
+
|
|
56560
|
+
// verify the required parameter 'businessUnitId' is set
|
|
56561
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
56562
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56563
|
+
}
|
|
56564
|
+
// verify the required parameter 'body' is set
|
|
56565
|
+
if (body === undefined || body === null) {
|
|
56566
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56567
|
+
}
|
|
56568
|
+
|
|
56569
|
+
return this.apiClient.callApi(
|
|
56570
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
56571
|
+
'POST',
|
|
56572
|
+
{ 'businessUnitId': businessUnitId },
|
|
56573
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56574
|
+
{ },
|
|
56575
|
+
{ },
|
|
56576
|
+
body,
|
|
56577
|
+
['PureCloud OAuth'],
|
|
56578
|
+
['application/json'],
|
|
56579
|
+
['application/json']
|
|
56580
|
+
);
|
|
56581
|
+
}
|
|
56582
|
+
|
|
56050
56583
|
/**
|
|
56051
56584
|
* Search published schedules
|
|
56052
56585
|
*
|
|
@@ -56874,6 +57407,35 @@ class WorkforceManagementApi {
|
|
|
56874
57407
|
);
|
|
56875
57408
|
}
|
|
56876
57409
|
|
|
57410
|
+
/**
|
|
57411
|
+
* Request a historical shrinkage report
|
|
57412
|
+
* 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.
|
|
57413
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57414
|
+
* @param {Object} opts Optional parameters
|
|
57415
|
+
* @param {Object} opts.body body
|
|
57416
|
+
*/
|
|
57417
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
57418
|
+
opts = opts || {};
|
|
57419
|
+
|
|
57420
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57421
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57422
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
57423
|
+
}
|
|
57424
|
+
|
|
57425
|
+
return this.apiClient.callApi(
|
|
57426
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
57427
|
+
'POST',
|
|
57428
|
+
{ 'managementUnitId': managementUnitId },
|
|
57429
|
+
{ },
|
|
57430
|
+
{ },
|
|
57431
|
+
{ },
|
|
57432
|
+
opts['body'],
|
|
57433
|
+
['PureCloud OAuth'],
|
|
57434
|
+
['application/json'],
|
|
57435
|
+
['application/json']
|
|
57436
|
+
);
|
|
57437
|
+
}
|
|
57438
|
+
|
|
56877
57439
|
/**
|
|
56878
57440
|
* Creates a new time off limit object under management unit.
|
|
56879
57441
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -57614,7 +58176,7 @@ class WorkforceManagementApi {
|
|
|
57614
58176
|
* </pre>
|
|
57615
58177
|
* </p>
|
|
57616
58178
|
* @module purecloud-platform-client-v2/index
|
|
57617
|
-
* @version
|
|
58179
|
+
* @version 153.0.0
|
|
57618
58180
|
*/
|
|
57619
58181
|
class platformClient {
|
|
57620
58182
|
constructor() {
|