purecloud-platform-client-v2 152.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 +444 -73
- package/dist/web-amd/purecloud-platform-client-v2.js +444 -73
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +444 -73
- package/dist/web-cjs/purecloud-platform-client-v2.js +444 -73
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +212 -3
- 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 +3 -3
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +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 +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 +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 153.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 153.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 153.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
|
*/
|
|
@@ -1990,7 +1990,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1990
1990
|
}
|
|
1991
1991
|
|
|
1992
1992
|
/**
|
|
1993
|
-
* Fetch a page of results for an async
|
|
1993
|
+
* Fetch a page of results for an async details job
|
|
1994
1994
|
*
|
|
1995
1995
|
* @param {String} jobId jobId
|
|
1996
1996
|
* @param {Object} opts Optional parameters
|
|
@@ -3045,7 +3045,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3045
3045
|
/**
|
|
3046
3046
|
* Architect service.
|
|
3047
3047
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3048
|
-
* @version
|
|
3048
|
+
* @version 153.0.0
|
|
3049
3049
|
*/
|
|
3050
3050
|
|
|
3051
3051
|
/**
|
|
@@ -6092,7 +6092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6092
6092
|
/**
|
|
6093
6093
|
* Audit service.
|
|
6094
6094
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6095
|
-
* @version
|
|
6095
|
+
* @version 153.0.0
|
|
6096
6096
|
*/
|
|
6097
6097
|
|
|
6098
6098
|
/**
|
|
@@ -6263,7 +6263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6263
6263
|
/**
|
|
6264
6264
|
* Authorization service.
|
|
6265
6265
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6266
|
-
* @version
|
|
6266
|
+
* @version 153.0.0
|
|
6267
6267
|
*/
|
|
6268
6268
|
|
|
6269
6269
|
/**
|
|
@@ -6796,6 +6796,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6796
6796
|
);
|
|
6797
6797
|
}
|
|
6798
6798
|
|
|
6799
|
+
/**
|
|
6800
|
+
* Get authorization settings
|
|
6801
|
+
*
|
|
6802
|
+
*/
|
|
6803
|
+
getAuthorizationSettings() {
|
|
6804
|
+
|
|
6805
|
+
return this.apiClient.callApi(
|
|
6806
|
+
'/api/v2/authorization/settings',
|
|
6807
|
+
'GET',
|
|
6808
|
+
{ },
|
|
6809
|
+
{ },
|
|
6810
|
+
{ },
|
|
6811
|
+
{ },
|
|
6812
|
+
null,
|
|
6813
|
+
['PureCloud OAuth'],
|
|
6814
|
+
['application/json'],
|
|
6815
|
+
['application/json']
|
|
6816
|
+
);
|
|
6817
|
+
}
|
|
6818
|
+
|
|
6799
6819
|
/**
|
|
6800
6820
|
* Returns a listing of roles and permissions for a user.
|
|
6801
6821
|
*
|
|
@@ -6920,6 +6940,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6920
6940
|
);
|
|
6921
6941
|
}
|
|
6922
6942
|
|
|
6943
|
+
/**
|
|
6944
|
+
* Change authorization settings
|
|
6945
|
+
* Change authorization settings
|
|
6946
|
+
* @param {Object} body Authorization Settings
|
|
6947
|
+
*/
|
|
6948
|
+
patchAuthorizationSettings(body) {
|
|
6949
|
+
// verify the required parameter 'body' is set
|
|
6950
|
+
if (body === undefined || body === null) {
|
|
6951
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
6952
|
+
}
|
|
6953
|
+
|
|
6954
|
+
return this.apiClient.callApi(
|
|
6955
|
+
'/api/v2/authorization/settings',
|
|
6956
|
+
'PATCH',
|
|
6957
|
+
{ },
|
|
6958
|
+
{ },
|
|
6959
|
+
{ },
|
|
6960
|
+
{ },
|
|
6961
|
+
body,
|
|
6962
|
+
['PureCloud OAuth'],
|
|
6963
|
+
['application/json'],
|
|
6964
|
+
['application/json']
|
|
6965
|
+
);
|
|
6966
|
+
}
|
|
6967
|
+
|
|
6923
6968
|
/**
|
|
6924
6969
|
* Assign a list of objects to a division
|
|
6925
6970
|
* 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 +7491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7446
7491
|
/**
|
|
7447
7492
|
* Billing service.
|
|
7448
7493
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7449
|
-
* @version
|
|
7494
|
+
* @version 153.0.0
|
|
7450
7495
|
*/
|
|
7451
7496
|
|
|
7452
7497
|
/**
|
|
@@ -7526,7 +7571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7526
7571
|
/**
|
|
7527
7572
|
* Chat service.
|
|
7528
7573
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7529
|
-
* @version
|
|
7574
|
+
* @version 153.0.0
|
|
7530
7575
|
*/
|
|
7531
7576
|
|
|
7532
7577
|
/**
|
|
@@ -7617,7 +7662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7617
7662
|
/**
|
|
7618
7663
|
* Coaching service.
|
|
7619
7664
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7620
|
-
* @version
|
|
7665
|
+
* @version 153.0.0
|
|
7621
7666
|
*/
|
|
7622
7667
|
|
|
7623
7668
|
/**
|
|
@@ -8194,7 +8239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8194
8239
|
/**
|
|
8195
8240
|
* ContentManagement service.
|
|
8196
8241
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8197
|
-
* @version
|
|
8242
|
+
* @version 153.0.0
|
|
8198
8243
|
*/
|
|
8199
8244
|
|
|
8200
8245
|
/**
|
|
@@ -9334,7 +9379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9334
9379
|
/**
|
|
9335
9380
|
* Conversations service.
|
|
9336
9381
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9337
|
-
* @version
|
|
9382
|
+
* @version 153.0.0
|
|
9338
9383
|
*/
|
|
9339
9384
|
|
|
9340
9385
|
/**
|
|
@@ -9350,7 +9395,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9350
9395
|
|
|
9351
9396
|
|
|
9352
9397
|
/**
|
|
9353
|
-
* Delete/cancel an async
|
|
9398
|
+
* Delete/cancel an async details job
|
|
9354
9399
|
*
|
|
9355
9400
|
* @param {String} jobId jobId
|
|
9356
9401
|
*/
|
|
@@ -9724,7 +9769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9724
9769
|
}
|
|
9725
9770
|
|
|
9726
9771
|
/**
|
|
9727
|
-
* Fetch a page of results for an async
|
|
9772
|
+
* Fetch a page of results for an async details job
|
|
9728
9773
|
*
|
|
9729
9774
|
* @param {String} jobId jobId
|
|
9730
9775
|
* @param {Object} opts Optional parameters
|
|
@@ -14557,7 +14602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14557
14602
|
/**
|
|
14558
14603
|
* DataExtensions service.
|
|
14559
14604
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14560
|
-
* @version
|
|
14605
|
+
* @version 153.0.0
|
|
14561
14606
|
*/
|
|
14562
14607
|
|
|
14563
14608
|
/**
|
|
@@ -14643,7 +14688,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14643
14688
|
/**
|
|
14644
14689
|
* Downloads service.
|
|
14645
14690
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
14646
|
-
* @version
|
|
14691
|
+
* @version 153.0.0
|
|
14647
14692
|
*/
|
|
14648
14693
|
|
|
14649
14694
|
/**
|
|
@@ -14695,7 +14740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14695
14740
|
/**
|
|
14696
14741
|
* Events service.
|
|
14697
14742
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
14698
|
-
* @version
|
|
14743
|
+
* @version 153.0.0
|
|
14699
14744
|
*/
|
|
14700
14745
|
|
|
14701
14746
|
/**
|
|
@@ -14791,7 +14836,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14791
14836
|
/**
|
|
14792
14837
|
* ExternalContacts service.
|
|
14793
14838
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14794
|
-
* @version
|
|
14839
|
+
* @version 153.0.0
|
|
14795
14840
|
*/
|
|
14796
14841
|
|
|
14797
14842
|
/**
|
|
@@ -16749,7 +16794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16749
16794
|
/**
|
|
16750
16795
|
* Fax service.
|
|
16751
16796
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16752
|
-
* @version
|
|
16797
|
+
* @version 153.0.0
|
|
16753
16798
|
*/
|
|
16754
16799
|
|
|
16755
16800
|
/**
|
|
@@ -16920,7 +16965,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16920
16965
|
/**
|
|
16921
16966
|
* Flows service.
|
|
16922
16967
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16923
|
-
* @version
|
|
16968
|
+
* @version 153.0.0
|
|
16924
16969
|
*/
|
|
16925
16970
|
|
|
16926
16971
|
/**
|
|
@@ -16991,7 +17036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16991
17036
|
/**
|
|
16992
17037
|
* Gamification service.
|
|
16993
17038
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16994
|
-
* @version
|
|
17039
|
+
* @version 153.0.0
|
|
16995
17040
|
*/
|
|
16996
17041
|
|
|
16997
17042
|
/**
|
|
@@ -18608,7 +18653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18608
18653
|
/**
|
|
18609
18654
|
* GeneralDataProtectionRegulation service.
|
|
18610
18655
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18611
|
-
* @version
|
|
18656
|
+
* @version 153.0.0
|
|
18612
18657
|
*/
|
|
18613
18658
|
|
|
18614
18659
|
/**
|
|
@@ -18738,7 +18783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18738
18783
|
/**
|
|
18739
18784
|
* Geolocation service.
|
|
18740
18785
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18741
|
-
* @version
|
|
18786
|
+
* @version 153.0.0
|
|
18742
18787
|
*/
|
|
18743
18788
|
|
|
18744
18789
|
/**
|
|
@@ -18869,7 +18914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18869
18914
|
/**
|
|
18870
18915
|
* Greetings service.
|
|
18871
18916
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18872
|
-
* @version
|
|
18917
|
+
* @version 153.0.0
|
|
18873
18918
|
*/
|
|
18874
18919
|
|
|
18875
18920
|
/**
|
|
@@ -19324,7 +19369,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19324
19369
|
/**
|
|
19325
19370
|
* Groups service.
|
|
19326
19371
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19327
|
-
* @version
|
|
19372
|
+
* @version 153.0.0
|
|
19328
19373
|
*/
|
|
19329
19374
|
|
|
19330
19375
|
/**
|
|
@@ -19730,7 +19775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19730
19775
|
/**
|
|
19731
19776
|
* IdentityProvider service.
|
|
19732
19777
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19733
|
-
* @version
|
|
19778
|
+
* @version 153.0.0
|
|
19734
19779
|
*/
|
|
19735
19780
|
|
|
19736
19781
|
/**
|
|
@@ -20486,7 +20531,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20486
20531
|
/**
|
|
20487
20532
|
* Integrations service.
|
|
20488
20533
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20489
|
-
* @version
|
|
20534
|
+
* @version 153.0.0
|
|
20490
20535
|
*/
|
|
20491
20536
|
|
|
20492
20537
|
/**
|
|
@@ -22086,7 +22131,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22086
22131
|
/**
|
|
22087
22132
|
* Journey service.
|
|
22088
22133
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22089
|
-
* @version
|
|
22134
|
+
* @version 153.0.0
|
|
22090
22135
|
*/
|
|
22091
22136
|
|
|
22092
22137
|
/**
|
|
@@ -22872,7 +22917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22872
22917
|
/**
|
|
22873
22918
|
* Knowledge service.
|
|
22874
22919
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22875
|
-
* @version
|
|
22920
|
+
* @version 153.0.0
|
|
22876
22921
|
*/
|
|
22877
22922
|
|
|
22878
22923
|
/**
|
|
@@ -25305,7 +25350,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25305
25350
|
/**
|
|
25306
25351
|
* LanguageUnderstanding service.
|
|
25307
25352
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25308
|
-
* @version
|
|
25353
|
+
* @version 153.0.0
|
|
25309
25354
|
*/
|
|
25310
25355
|
|
|
25311
25356
|
/**
|
|
@@ -26209,7 +26254,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26209
26254
|
/**
|
|
26210
26255
|
* Languages service.
|
|
26211
26256
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26212
|
-
* @version
|
|
26257
|
+
* @version 153.0.0
|
|
26213
26258
|
*/
|
|
26214
26259
|
|
|
26215
26260
|
/**
|
|
@@ -26477,7 +26522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26477
26522
|
/**
|
|
26478
26523
|
* Learning service.
|
|
26479
26524
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26480
|
-
* @version
|
|
26525
|
+
* @version 153.0.0
|
|
26481
26526
|
*/
|
|
26482
26527
|
|
|
26483
26528
|
/**
|
|
@@ -27237,7 +27282,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27237
27282
|
/**
|
|
27238
27283
|
* License service.
|
|
27239
27284
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27240
|
-
* @version
|
|
27285
|
+
* @version 153.0.0
|
|
27241
27286
|
*/
|
|
27242
27287
|
|
|
27243
27288
|
/**
|
|
@@ -27475,7 +27520,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27475
27520
|
/**
|
|
27476
27521
|
* Locations service.
|
|
27477
27522
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27478
|
-
* @version
|
|
27523
|
+
* @version 153.0.0
|
|
27479
27524
|
*/
|
|
27480
27525
|
|
|
27481
27526
|
/**
|
|
@@ -27711,7 +27756,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27711
27756
|
/**
|
|
27712
27757
|
* Messaging service.
|
|
27713
27758
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27714
|
-
* @version
|
|
27759
|
+
* @version 153.0.0
|
|
27715
27760
|
*/
|
|
27716
27761
|
|
|
27717
27762
|
/**
|
|
@@ -27862,7 +27907,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27862
27907
|
/**
|
|
27863
27908
|
* MobileDevices service.
|
|
27864
27909
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27865
|
-
* @version
|
|
27910
|
+
* @version 153.0.0
|
|
27866
27911
|
*/
|
|
27867
27912
|
|
|
27868
27913
|
/**
|
|
@@ -28013,7 +28058,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28013
28058
|
/**
|
|
28014
28059
|
* Notifications service.
|
|
28015
28060
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
28016
|
-
* @version
|
|
28061
|
+
* @version 153.0.0
|
|
28017
28062
|
*/
|
|
28018
28063
|
|
|
28019
28064
|
/**
|
|
@@ -28238,7 +28283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28238
28283
|
/**
|
|
28239
28284
|
* OAuth service.
|
|
28240
28285
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28241
|
-
* @version
|
|
28286
|
+
* @version 153.0.0
|
|
28242
28287
|
*/
|
|
28243
28288
|
|
|
28244
28289
|
/**
|
|
@@ -28604,7 +28649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28604
28649
|
/**
|
|
28605
28650
|
* Objects service.
|
|
28606
28651
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28607
|
-
* @version
|
|
28652
|
+
* @version 153.0.0
|
|
28608
28653
|
*/
|
|
28609
28654
|
|
|
28610
28655
|
/**
|
|
@@ -28875,7 +28920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28875
28920
|
/**
|
|
28876
28921
|
* Organization service.
|
|
28877
28922
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28878
|
-
* @version
|
|
28923
|
+
* @version 153.0.0
|
|
28879
28924
|
*/
|
|
28880
28925
|
|
|
28881
28926
|
/**
|
|
@@ -29278,7 +29323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29278
29323
|
/**
|
|
29279
29324
|
* OrganizationAuthorization service.
|
|
29280
29325
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29281
|
-
* @version
|
|
29326
|
+
* @version 153.0.0
|
|
29282
29327
|
*/
|
|
29283
29328
|
|
|
29284
29329
|
/**
|
|
@@ -30203,7 +30248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30203
30248
|
/**
|
|
30204
30249
|
* Outbound service.
|
|
30205
30250
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30206
|
-
* @version
|
|
30251
|
+
* @version 153.0.0
|
|
30207
30252
|
*/
|
|
30208
30253
|
|
|
30209
30254
|
/**
|
|
@@ -33592,7 +33637,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33592
33637
|
/**
|
|
33593
33638
|
* Presence service.
|
|
33594
33639
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33595
|
-
* @version
|
|
33640
|
+
* @version 153.0.0
|
|
33596
33641
|
*/
|
|
33597
33642
|
|
|
33598
33643
|
/**
|
|
@@ -34098,7 +34143,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34098
34143
|
/**
|
|
34099
34144
|
* ProcessAutomation service.
|
|
34100
34145
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
34101
|
-
* @version
|
|
34146
|
+
* @version 153.0.0
|
|
34102
34147
|
*/
|
|
34103
34148
|
|
|
34104
34149
|
/**
|
|
@@ -34336,7 +34381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34336
34381
|
/**
|
|
34337
34382
|
* Quality service.
|
|
34338
34383
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
34339
|
-
* @version
|
|
34384
|
+
* @version 153.0.0
|
|
34340
34385
|
*/
|
|
34341
34386
|
|
|
34342
34387
|
/**
|
|
@@ -35914,7 +35959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35914
35959
|
/**
|
|
35915
35960
|
* Recording service.
|
|
35916
35961
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35917
|
-
* @version
|
|
35962
|
+
* @version 153.0.0
|
|
35918
35963
|
*/
|
|
35919
35964
|
|
|
35920
35965
|
/**
|
|
@@ -37601,7 +37646,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37601
37646
|
/**
|
|
37602
37647
|
* ResponseManagement service.
|
|
37603
37648
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
37604
|
-
* @version
|
|
37649
|
+
* @version 153.0.0
|
|
37605
37650
|
*/
|
|
37606
37651
|
|
|
37607
37652
|
/**
|
|
@@ -38085,7 +38130,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38085
38130
|
/**
|
|
38086
38131
|
* Routing service.
|
|
38087
38132
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
38088
|
-
* @version
|
|
38133
|
+
* @version 153.0.0
|
|
38089
38134
|
*/
|
|
38090
38135
|
|
|
38091
38136
|
/**
|
|
@@ -38811,6 +38856,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38811
38856
|
* Get domains
|
|
38812
38857
|
*
|
|
38813
38858
|
* @param {Object} opts Optional parameters
|
|
38859
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38860
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38814
38861
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
38815
38862
|
*/
|
|
38816
38863
|
getRoutingEmailDomains(opts) {
|
|
@@ -38821,7 +38868,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38821
38868
|
'/api/v2/routing/email/domains',
|
|
38822
38869
|
'GET',
|
|
38823
38870
|
{ },
|
|
38824
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
38871
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
38825
38872
|
{ },
|
|
38826
38873
|
{ },
|
|
38827
38874
|
null,
|
|
@@ -41498,7 +41545,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41498
41545
|
/**
|
|
41499
41546
|
* SCIM service.
|
|
41500
41547
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
41501
|
-
* @version
|
|
41548
|
+
* @version 153.0.0
|
|
41502
41549
|
*/
|
|
41503
41550
|
|
|
41504
41551
|
/**
|
|
@@ -42375,7 +42422,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42375
42422
|
/**
|
|
42376
42423
|
* Scripts service.
|
|
42377
42424
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
42378
|
-
* @version
|
|
42425
|
+
* @version 153.0.0
|
|
42379
42426
|
*/
|
|
42380
42427
|
|
|
42381
42428
|
/**
|
|
@@ -42794,7 +42841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42794
42841
|
/**
|
|
42795
42842
|
* Search service.
|
|
42796
42843
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
42797
|
-
* @version
|
|
42844
|
+
* @version 153.0.0
|
|
42798
42845
|
*/
|
|
42799
42846
|
|
|
42800
42847
|
/**
|
|
@@ -43379,7 +43426,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43379
43426
|
/**
|
|
43380
43427
|
* SpeechTextAnalytics service.
|
|
43381
43428
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
43382
|
-
* @version
|
|
43429
|
+
* @version 153.0.0
|
|
43383
43430
|
*/
|
|
43384
43431
|
|
|
43385
43432
|
/**
|
|
@@ -44233,7 +44280,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44233
44280
|
/**
|
|
44234
44281
|
* Stations service.
|
|
44235
44282
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
44236
|
-
* @version
|
|
44283
|
+
* @version 153.0.0
|
|
44237
44284
|
*/
|
|
44238
44285
|
|
|
44239
44286
|
/**
|
|
@@ -44380,7 +44427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44380
44427
|
/**
|
|
44381
44428
|
* Suggest service.
|
|
44382
44429
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
44383
|
-
* @version
|
|
44430
|
+
* @version 153.0.0
|
|
44384
44431
|
*/
|
|
44385
44432
|
|
|
44386
44433
|
/**
|
|
@@ -44519,7 +44566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44519
44566
|
/**
|
|
44520
44567
|
* Teams service.
|
|
44521
44568
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
44522
|
-
* @version
|
|
44569
|
+
* @version 153.0.0
|
|
44523
44570
|
*/
|
|
44524
44571
|
|
|
44525
44572
|
/**
|
|
@@ -44790,7 +44837,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44790
44837
|
/**
|
|
44791
44838
|
* Telephony service.
|
|
44792
44839
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
44793
|
-
* @version
|
|
44840
|
+
* @version 153.0.0
|
|
44794
44841
|
*/
|
|
44795
44842
|
|
|
44796
44843
|
/**
|
|
@@ -44898,7 +44945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44898
44945
|
/**
|
|
44899
44946
|
* TelephonyProvidersEdge service.
|
|
44900
44947
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
44901
|
-
* @version
|
|
44948
|
+
* @version 153.0.0
|
|
44902
44949
|
*/
|
|
44903
44950
|
|
|
44904
44951
|
/**
|
|
@@ -48531,7 +48578,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48531
48578
|
/**
|
|
48532
48579
|
* Textbots service.
|
|
48533
48580
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
48534
|
-
* @version
|
|
48581
|
+
* @version 153.0.0
|
|
48535
48582
|
*/
|
|
48536
48583
|
|
|
48537
48584
|
/**
|
|
@@ -48659,7 +48706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48659
48706
|
/**
|
|
48660
48707
|
* Tokens service.
|
|
48661
48708
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
48662
|
-
* @version
|
|
48709
|
+
* @version 153.0.0
|
|
48663
48710
|
*/
|
|
48664
48711
|
|
|
48665
48712
|
/**
|
|
@@ -48765,7 +48812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48765
48812
|
/**
|
|
48766
48813
|
* Uploads service.
|
|
48767
48814
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
48768
|
-
* @version
|
|
48815
|
+
* @version 153.0.0
|
|
48769
48816
|
*/
|
|
48770
48817
|
|
|
48771
48818
|
/**
|
|
@@ -48941,7 +48988,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48941
48988
|
/**
|
|
48942
48989
|
* Usage service.
|
|
48943
48990
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
48944
|
-
* @version
|
|
48991
|
+
* @version 153.0.0
|
|
48945
48992
|
*/
|
|
48946
48993
|
|
|
48947
48994
|
/**
|
|
@@ -49012,7 +49059,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49012
49059
|
/**
|
|
49013
49060
|
* UserRecordings service.
|
|
49014
49061
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
49015
|
-
* @version
|
|
49062
|
+
* @version 153.0.0
|
|
49016
49063
|
*/
|
|
49017
49064
|
|
|
49018
49065
|
/**
|
|
@@ -49197,7 +49244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49197
49244
|
/**
|
|
49198
49245
|
* Users service.
|
|
49199
49246
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
49200
|
-
* @version
|
|
49247
|
+
* @version 153.0.0
|
|
49201
49248
|
*/
|
|
49202
49249
|
|
|
49203
49250
|
/**
|
|
@@ -51554,7 +51601,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51554
51601
|
/**
|
|
51555
51602
|
* Utilities service.
|
|
51556
51603
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
51557
|
-
* @version
|
|
51604
|
+
* @version 153.0.0
|
|
51558
51605
|
*/
|
|
51559
51606
|
|
|
51560
51607
|
/**
|
|
@@ -51665,7 +51712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51665
51712
|
/**
|
|
51666
51713
|
* Voicemail service.
|
|
51667
51714
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
51668
|
-
* @version
|
|
51715
|
+
* @version 153.0.0
|
|
51669
51716
|
*/
|
|
51670
51717
|
|
|
51671
51718
|
/**
|
|
@@ -52332,7 +52379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52332
52379
|
/**
|
|
52333
52380
|
* WebChat service.
|
|
52334
52381
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
52335
|
-
* @version
|
|
52382
|
+
* @version 153.0.0
|
|
52336
52383
|
*/
|
|
52337
52384
|
|
|
52338
52385
|
/**
|
|
@@ -52876,7 +52923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52876
52923
|
/**
|
|
52877
52924
|
* WebDeployments service.
|
|
52878
52925
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
52879
|
-
* @version
|
|
52926
|
+
* @version 153.0.0
|
|
52880
52927
|
*/
|
|
52881
52928
|
|
|
52882
52929
|
/**
|
|
@@ -53264,7 +53311,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53264
53311
|
/**
|
|
53265
53312
|
* WebMessaging service.
|
|
53266
53313
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
53267
|
-
* @version
|
|
53314
|
+
* @version 153.0.0
|
|
53268
53315
|
*/
|
|
53269
53316
|
|
|
53270
53317
|
/**
|
|
@@ -53310,7 +53357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53310
53357
|
/**
|
|
53311
53358
|
* Widgets service.
|
|
53312
53359
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
53313
|
-
* @version
|
|
53360
|
+
* @version 153.0.0
|
|
53314
53361
|
*/
|
|
53315
53362
|
|
|
53316
53363
|
/**
|
|
@@ -53456,7 +53503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53456
53503
|
/**
|
|
53457
53504
|
* WorkforceManagement service.
|
|
53458
53505
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
53459
|
-
* @version
|
|
53506
|
+
* @version 153.0.0
|
|
53460
53507
|
*/
|
|
53461
53508
|
|
|
53462
53509
|
/**
|
|
@@ -53876,6 +53923,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53876
53923
|
);
|
|
53877
53924
|
}
|
|
53878
53925
|
|
|
53926
|
+
/**
|
|
53927
|
+
* Get an adherence explanation for the current user
|
|
53928
|
+
*
|
|
53929
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
53930
|
+
*/
|
|
53931
|
+
getWorkforcemanagementAdherenceExplanation(explanationId) {
|
|
53932
|
+
// verify the required parameter 'explanationId' is set
|
|
53933
|
+
if (explanationId === undefined || explanationId === null) {
|
|
53934
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';
|
|
53935
|
+
}
|
|
53936
|
+
|
|
53937
|
+
return this.apiClient.callApi(
|
|
53938
|
+
'/api/v2/workforcemanagement/adherence/explanations/{explanationId}',
|
|
53939
|
+
'GET',
|
|
53940
|
+
{ 'explanationId': explanationId },
|
|
53941
|
+
{ },
|
|
53942
|
+
{ },
|
|
53943
|
+
{ },
|
|
53944
|
+
null,
|
|
53945
|
+
['PureCloud OAuth'],
|
|
53946
|
+
['application/json'],
|
|
53947
|
+
['application/json']
|
|
53948
|
+
);
|
|
53949
|
+
}
|
|
53950
|
+
|
|
53951
|
+
/**
|
|
53952
|
+
* Query the status of an adherence explanation operation. Only the user who started the operation can query the status
|
|
53953
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
53954
|
+
* @param {String} jobId The ID of the job
|
|
53955
|
+
*/
|
|
53956
|
+
getWorkforcemanagementAdherenceExplanationsJob(jobId) {
|
|
53957
|
+
// verify the required parameter 'jobId' is set
|
|
53958
|
+
if (jobId === undefined || jobId === null) {
|
|
53959
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';
|
|
53960
|
+
}
|
|
53961
|
+
|
|
53962
|
+
return this.apiClient.callApi(
|
|
53963
|
+
'/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}',
|
|
53964
|
+
'GET',
|
|
53965
|
+
{ 'jobId': jobId },
|
|
53966
|
+
{ },
|
|
53967
|
+
{ },
|
|
53968
|
+
{ },
|
|
53969
|
+
null,
|
|
53970
|
+
['PureCloud OAuth'],
|
|
53971
|
+
['application/json'],
|
|
53972
|
+
['application/json']
|
|
53973
|
+
);
|
|
53974
|
+
}
|
|
53975
|
+
|
|
53879
53976
|
/**
|
|
53880
53977
|
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
53881
53978
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -53926,6 +54023,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53926
54023
|
);
|
|
53927
54024
|
}
|
|
53928
54025
|
|
|
54026
|
+
/**
|
|
54027
|
+
* Get an adherence explanation
|
|
54028
|
+
*
|
|
54029
|
+
* @param {String} agentId The ID of the agent to query
|
|
54030
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
54031
|
+
*/
|
|
54032
|
+
getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId) {
|
|
54033
|
+
// verify the required parameter 'agentId' is set
|
|
54034
|
+
if (agentId === undefined || agentId === null) {
|
|
54035
|
+
throw 'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54036
|
+
}
|
|
54037
|
+
// verify the required parameter 'explanationId' is set
|
|
54038
|
+
if (explanationId === undefined || explanationId === null) {
|
|
54039
|
+
throw 'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';
|
|
54040
|
+
}
|
|
54041
|
+
|
|
54042
|
+
return this.apiClient.callApi(
|
|
54043
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
54044
|
+
'GET',
|
|
54045
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
54046
|
+
{ },
|
|
54047
|
+
{ },
|
|
54048
|
+
{ },
|
|
54049
|
+
null,
|
|
54050
|
+
['PureCloud OAuth'],
|
|
54051
|
+
['application/json'],
|
|
54052
|
+
['application/json']
|
|
54053
|
+
);
|
|
54054
|
+
}
|
|
54055
|
+
|
|
53929
54056
|
/**
|
|
53930
54057
|
* Get the management unit to which the agent belongs
|
|
53931
54058
|
*
|
|
@@ -55645,6 +55772,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55645
55772
|
);
|
|
55646
55773
|
}
|
|
55647
55774
|
|
|
55775
|
+
/**
|
|
55776
|
+
* Request to fetch the status of the historical shrinkage query
|
|
55777
|
+
*
|
|
55778
|
+
* @param {String} jobId jobId
|
|
55779
|
+
*/
|
|
55780
|
+
getWorkforcemanagementShrinkageJob(jobId) {
|
|
55781
|
+
// verify the required parameter 'jobId' is set
|
|
55782
|
+
if (jobId === undefined || jobId === null) {
|
|
55783
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';
|
|
55784
|
+
}
|
|
55785
|
+
|
|
55786
|
+
return this.apiClient.callApi(
|
|
55787
|
+
'/api/v2/workforcemanagement/shrinkage/jobs/{jobId}',
|
|
55788
|
+
'GET',
|
|
55789
|
+
{ 'jobId': jobId },
|
|
55790
|
+
{ },
|
|
55791
|
+
{ },
|
|
55792
|
+
{ },
|
|
55793
|
+
null,
|
|
55794
|
+
['PureCloud OAuth'],
|
|
55795
|
+
['application/json'],
|
|
55796
|
+
['application/json']
|
|
55797
|
+
);
|
|
55798
|
+
}
|
|
55799
|
+
|
|
55648
55800
|
/**
|
|
55649
55801
|
* Get a time off request for the current user
|
|
55650
55802
|
*
|
|
@@ -55719,6 +55871,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55719
55871
|
);
|
|
55720
55872
|
}
|
|
55721
55873
|
|
|
55874
|
+
/**
|
|
55875
|
+
* Update an adherence explanation
|
|
55876
|
+
*
|
|
55877
|
+
* @param {String} agentId The ID of the agent to query
|
|
55878
|
+
* @param {String} explanationId The ID of the explanation to update
|
|
55879
|
+
* @param {Object} body The request body
|
|
55880
|
+
*/
|
|
55881
|
+
patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body) {
|
|
55882
|
+
// verify the required parameter 'agentId' is set
|
|
55883
|
+
if (agentId === undefined || agentId === null) {
|
|
55884
|
+
throw 'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55885
|
+
}
|
|
55886
|
+
// verify the required parameter 'explanationId' is set
|
|
55887
|
+
if (explanationId === undefined || explanationId === null) {
|
|
55888
|
+
throw 'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55889
|
+
}
|
|
55890
|
+
// verify the required parameter 'body' is set
|
|
55891
|
+
if (body === undefined || body === null) {
|
|
55892
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';
|
|
55893
|
+
}
|
|
55894
|
+
|
|
55895
|
+
return this.apiClient.callApi(
|
|
55896
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}',
|
|
55897
|
+
'PATCH',
|
|
55898
|
+
{ 'agentId': agentId,'explanationId': explanationId },
|
|
55899
|
+
{ },
|
|
55900
|
+
{ },
|
|
55901
|
+
{ },
|
|
55902
|
+
body,
|
|
55903
|
+
['PureCloud OAuth'],
|
|
55904
|
+
['application/json'],
|
|
55905
|
+
['application/json']
|
|
55906
|
+
);
|
|
55907
|
+
}
|
|
55908
|
+
|
|
55722
55909
|
/**
|
|
55723
55910
|
* Update business unit
|
|
55724
55911
|
*
|
|
@@ -56158,6 +56345,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56158
56345
|
);
|
|
56159
56346
|
}
|
|
56160
56347
|
|
|
56348
|
+
/**
|
|
56349
|
+
* Submit an adherence explanation for the current user
|
|
56350
|
+
*
|
|
56351
|
+
* @param {Object} body The request body
|
|
56352
|
+
*/
|
|
56353
|
+
postWorkforcemanagementAdherenceExplanations(body) {
|
|
56354
|
+
// verify the required parameter 'body' is set
|
|
56355
|
+
if (body === undefined || body === null) {
|
|
56356
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';
|
|
56357
|
+
}
|
|
56358
|
+
|
|
56359
|
+
return this.apiClient.callApi(
|
|
56360
|
+
'/api/v2/workforcemanagement/adherence/explanations',
|
|
56361
|
+
'POST',
|
|
56362
|
+
{ },
|
|
56363
|
+
{ },
|
|
56364
|
+
{ },
|
|
56365
|
+
{ },
|
|
56366
|
+
body,
|
|
56367
|
+
['PureCloud OAuth'],
|
|
56368
|
+
['application/json'],
|
|
56369
|
+
['application/json']
|
|
56370
|
+
);
|
|
56371
|
+
}
|
|
56372
|
+
|
|
56373
|
+
/**
|
|
56374
|
+
* Query adherence explanations for the current user
|
|
56375
|
+
*
|
|
56376
|
+
* @param {Object} body The request body
|
|
56377
|
+
* @param {Object} opts Optional parameters
|
|
56378
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56379
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56380
|
+
*/
|
|
56381
|
+
postWorkforcemanagementAdherenceExplanationsQuery(body, opts) {
|
|
56382
|
+
opts = opts || {};
|
|
56383
|
+
|
|
56384
|
+
// verify the required parameter 'body' is set
|
|
56385
|
+
if (body === undefined || body === null) {
|
|
56386
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';
|
|
56387
|
+
}
|
|
56388
|
+
|
|
56389
|
+
return this.apiClient.callApi(
|
|
56390
|
+
'/api/v2/workforcemanagement/adherence/explanations/query',
|
|
56391
|
+
'POST',
|
|
56392
|
+
{ },
|
|
56393
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56394
|
+
{ },
|
|
56395
|
+
{ },
|
|
56396
|
+
body,
|
|
56397
|
+
['PureCloud OAuth'],
|
|
56398
|
+
['application/json'],
|
|
56399
|
+
['application/json']
|
|
56400
|
+
);
|
|
56401
|
+
}
|
|
56402
|
+
|
|
56161
56403
|
/**
|
|
56162
56404
|
* Request a historical adherence report for users across management units
|
|
56163
56405
|
*
|
|
@@ -56182,6 +56424,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56182
56424
|
);
|
|
56183
56425
|
}
|
|
56184
56426
|
|
|
56427
|
+
/**
|
|
56428
|
+
* Add an adherence explanation for the requested user
|
|
56429
|
+
*
|
|
56430
|
+
* @param {String} agentId The ID of the agent to query
|
|
56431
|
+
* @param {Object} body The request body
|
|
56432
|
+
*/
|
|
56433
|
+
postWorkforcemanagementAgentAdherenceExplanations(agentId, body) {
|
|
56434
|
+
// verify the required parameter 'agentId' is set
|
|
56435
|
+
if (agentId === undefined || agentId === null) {
|
|
56436
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56437
|
+
}
|
|
56438
|
+
// verify the required parameter 'body' is set
|
|
56439
|
+
if (body === undefined || body === null) {
|
|
56440
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';
|
|
56441
|
+
}
|
|
56442
|
+
|
|
56443
|
+
return this.apiClient.callApi(
|
|
56444
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations',
|
|
56445
|
+
'POST',
|
|
56446
|
+
{ 'agentId': agentId },
|
|
56447
|
+
{ },
|
|
56448
|
+
{ },
|
|
56449
|
+
{ },
|
|
56450
|
+
body,
|
|
56451
|
+
['PureCloud OAuth'],
|
|
56452
|
+
['application/json'],
|
|
56453
|
+
['application/json']
|
|
56454
|
+
);
|
|
56455
|
+
}
|
|
56456
|
+
|
|
56457
|
+
/**
|
|
56458
|
+
* Query adherence explanations for the given agent across a specified range
|
|
56459
|
+
*
|
|
56460
|
+
* @param {String} agentId The ID of the agent to query
|
|
56461
|
+
* @param {Object} body The request body
|
|
56462
|
+
* @param {Object} opts Optional parameters
|
|
56463
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56464
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56465
|
+
*/
|
|
56466
|
+
postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, opts) {
|
|
56467
|
+
opts = opts || {};
|
|
56468
|
+
|
|
56469
|
+
// verify the required parameter 'agentId' is set
|
|
56470
|
+
if (agentId === undefined || agentId === null) {
|
|
56471
|
+
throw 'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56472
|
+
}
|
|
56473
|
+
// verify the required parameter 'body' is set
|
|
56474
|
+
if (body === undefined || body === null) {
|
|
56475
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';
|
|
56476
|
+
}
|
|
56477
|
+
|
|
56478
|
+
return this.apiClient.callApi(
|
|
56479
|
+
'/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query',
|
|
56480
|
+
'POST',
|
|
56481
|
+
{ 'agentId': agentId },
|
|
56482
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56483
|
+
{ },
|
|
56484
|
+
{ },
|
|
56485
|
+
body,
|
|
56486
|
+
['PureCloud OAuth'],
|
|
56487
|
+
['application/json'],
|
|
56488
|
+
['application/json']
|
|
56489
|
+
);
|
|
56490
|
+
}
|
|
56491
|
+
|
|
56185
56492
|
/**
|
|
56186
56493
|
* Get published schedule for the current user
|
|
56187
56494
|
*
|
|
@@ -56235,6 +56542,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56235
56542
|
);
|
|
56236
56543
|
}
|
|
56237
56544
|
|
|
56545
|
+
/**
|
|
56546
|
+
* Query adherence explanations across an entire business unit for the requested period
|
|
56547
|
+
*
|
|
56548
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
56549
|
+
* @param {Object} body The request body
|
|
56550
|
+
* @param {Object} opts Optional parameters
|
|
56551
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
56552
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
56553
|
+
*/
|
|
56554
|
+
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, opts) {
|
|
56555
|
+
opts = opts || {};
|
|
56556
|
+
|
|
56557
|
+
// verify the required parameter 'businessUnitId' is set
|
|
56558
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
56559
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56560
|
+
}
|
|
56561
|
+
// verify the required parameter 'body' is set
|
|
56562
|
+
if (body === undefined || body === null) {
|
|
56563
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';
|
|
56564
|
+
}
|
|
56565
|
+
|
|
56566
|
+
return this.apiClient.callApi(
|
|
56567
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query',
|
|
56568
|
+
'POST',
|
|
56569
|
+
{ 'businessUnitId': businessUnitId },
|
|
56570
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
56571
|
+
{ },
|
|
56572
|
+
{ },
|
|
56573
|
+
body,
|
|
56574
|
+
['PureCloud OAuth'],
|
|
56575
|
+
['application/json'],
|
|
56576
|
+
['application/json']
|
|
56577
|
+
);
|
|
56578
|
+
}
|
|
56579
|
+
|
|
56238
56580
|
/**
|
|
56239
56581
|
* Search published schedules
|
|
56240
56582
|
*
|
|
@@ -57062,6 +57404,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57062
57404
|
);
|
|
57063
57405
|
}
|
|
57064
57406
|
|
|
57407
|
+
/**
|
|
57408
|
+
* Request a historical shrinkage report
|
|
57409
|
+
* 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.
|
|
57410
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57411
|
+
* @param {Object} opts Optional parameters
|
|
57412
|
+
* @param {Object} opts.body body
|
|
57413
|
+
*/
|
|
57414
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, opts) {
|
|
57415
|
+
opts = opts || {};
|
|
57416
|
+
|
|
57417
|
+
// verify the required parameter 'managementUnitId' is set
|
|
57418
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
57419
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
57420
|
+
}
|
|
57421
|
+
|
|
57422
|
+
return this.apiClient.callApi(
|
|
57423
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
57424
|
+
'POST',
|
|
57425
|
+
{ 'managementUnitId': managementUnitId },
|
|
57426
|
+
{ },
|
|
57427
|
+
{ },
|
|
57428
|
+
{ },
|
|
57429
|
+
opts['body'],
|
|
57430
|
+
['PureCloud OAuth'],
|
|
57431
|
+
['application/json'],
|
|
57432
|
+
['application/json']
|
|
57433
|
+
);
|
|
57434
|
+
}
|
|
57435
|
+
|
|
57065
57436
|
/**
|
|
57066
57437
|
* Creates a new time off limit object under management unit.
|
|
57067
57438
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
@@ -57802,7 +58173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57802
58173
|
* </pre>
|
|
57803
58174
|
* </p>
|
|
57804
58175
|
* @module purecloud-platform-client-v2/index
|
|
57805
|
-
* @version
|
|
58176
|
+
* @version 153.0.0
|
|
57806
58177
|
*/
|
|
57807
58178
|
class platformClient {
|
|
57808
58179
|
constructor() {
|