purecloud-platform-client-v2 200.0.0 → 202.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 +1349 -125
- package/dist/web-amd/purecloud-platform-client-v2.js +1349 -125
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +432 -133
- package/dist/web-cjs/purecloud-platform-client-v2.js +548 -165
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1121 -241
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- 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/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +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/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +21 -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 +4 -4
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +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/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +68 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +56 -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 +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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/TaskManagementApi.js +36 -31
- 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 +32 -2
- package/src/purecloud-platform-client-v2/api/UsersApi.js +4 -4
- 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 +1080 -33
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -405,7 +405,7 @@ class Configuration {
|
|
|
405
405
|
|
|
406
406
|
/**
|
|
407
407
|
* @module purecloud-platform-client-v2/ApiClient
|
|
408
|
-
* @version
|
|
408
|
+
* @version 202.0.0
|
|
409
409
|
*/
|
|
410
410
|
class ApiClient {
|
|
411
411
|
/**
|
|
@@ -1827,7 +1827,7 @@ class AgentUIApi {
|
|
|
1827
1827
|
/**
|
|
1828
1828
|
* AgentUI service.
|
|
1829
1829
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1830
|
-
* @version
|
|
1830
|
+
* @version 202.0.0
|
|
1831
1831
|
*/
|
|
1832
1832
|
|
|
1833
1833
|
/**
|
|
@@ -1958,7 +1958,7 @@ class AlertingApi {
|
|
|
1958
1958
|
/**
|
|
1959
1959
|
* Alerting service.
|
|
1960
1960
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1961
|
-
* @version
|
|
1961
|
+
* @version 202.0.0
|
|
1962
1962
|
*/
|
|
1963
1963
|
|
|
1964
1964
|
/**
|
|
@@ -2619,7 +2619,7 @@ class AnalyticsApi {
|
|
|
2619
2619
|
/**
|
|
2620
2620
|
* Analytics service.
|
|
2621
2621
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2622
|
-
* @version
|
|
2622
|
+
* @version 202.0.0
|
|
2623
2623
|
*/
|
|
2624
2624
|
|
|
2625
2625
|
/**
|
|
@@ -4680,8 +4680,8 @@ class AnalyticsApi {
|
|
|
4680
4680
|
}
|
|
4681
4681
|
|
|
4682
4682
|
/**
|
|
4683
|
-
* Query for limits rate limit aggregates. Data populated when limits
|
|
4684
|
-
* The max property can be used to determine estimated rate limit value hit.
|
|
4683
|
+
* Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate.
|
|
4684
|
+
* The max property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
4685
4685
|
* @param {Object} body query
|
|
4686
4686
|
*/
|
|
4687
4687
|
postAnalyticsRatelimitsAggregatesQuery(body) {
|
|
@@ -5231,7 +5231,7 @@ class ArchitectApi {
|
|
|
5231
5231
|
/**
|
|
5232
5232
|
* Architect service.
|
|
5233
5233
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5234
|
-
* @version
|
|
5234
|
+
* @version 202.0.0
|
|
5235
5235
|
*/
|
|
5236
5236
|
|
|
5237
5237
|
/**
|
|
@@ -9377,7 +9377,7 @@ class AuditApi {
|
|
|
9377
9377
|
/**
|
|
9378
9378
|
* Audit service.
|
|
9379
9379
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9380
|
-
* @version
|
|
9380
|
+
* @version 202.0.0
|
|
9381
9381
|
*/
|
|
9382
9382
|
|
|
9383
9383
|
/**
|
|
@@ -9578,7 +9578,7 @@ class AuthorizationApi {
|
|
|
9578
9578
|
/**
|
|
9579
9579
|
* Authorization service.
|
|
9580
9580
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9581
|
-
* @version
|
|
9581
|
+
* @version 202.0.0
|
|
9582
9582
|
*/
|
|
9583
9583
|
|
|
9584
9584
|
/**
|
|
@@ -10816,7 +10816,7 @@ class BillingApi {
|
|
|
10816
10816
|
/**
|
|
10817
10817
|
* Billing service.
|
|
10818
10818
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10819
|
-
* @version
|
|
10819
|
+
* @version 202.0.0
|
|
10820
10820
|
*/
|
|
10821
10821
|
|
|
10822
10822
|
/**
|
|
@@ -10896,7 +10896,7 @@ class CarrierServicesApi {
|
|
|
10896
10896
|
/**
|
|
10897
10897
|
* CarrierServices service.
|
|
10898
10898
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10899
|
-
* @version
|
|
10899
|
+
* @version 202.0.0
|
|
10900
10900
|
*/
|
|
10901
10901
|
|
|
10902
10902
|
/**
|
|
@@ -10966,7 +10966,7 @@ class ChatApi {
|
|
|
10966
10966
|
/**
|
|
10967
10967
|
* Chat service.
|
|
10968
10968
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10969
|
-
* @version
|
|
10969
|
+
* @version 202.0.0
|
|
10970
10970
|
*/
|
|
10971
10971
|
|
|
10972
10972
|
/**
|
|
@@ -11902,7 +11902,7 @@ class CoachingApi {
|
|
|
11902
11902
|
/**
|
|
11903
11903
|
* Coaching service.
|
|
11904
11904
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11905
|
-
* @version
|
|
11905
|
+
* @version 202.0.0
|
|
11906
11906
|
*/
|
|
11907
11907
|
|
|
11908
11908
|
/**
|
|
@@ -12479,7 +12479,7 @@ class ContentManagementApi {
|
|
|
12479
12479
|
/**
|
|
12480
12480
|
* ContentManagement service.
|
|
12481
12481
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12482
|
-
* @version
|
|
12482
|
+
* @version 202.0.0
|
|
12483
12483
|
*/
|
|
12484
12484
|
|
|
12485
12485
|
/**
|
|
@@ -13561,7 +13561,7 @@ class ConversationsApi {
|
|
|
13561
13561
|
/**
|
|
13562
13562
|
* Conversations service.
|
|
13563
13563
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13564
|
-
* @version
|
|
13564
|
+
* @version 202.0.0
|
|
13565
13565
|
*/
|
|
13566
13566
|
|
|
13567
13567
|
/**
|
|
@@ -20674,7 +20674,7 @@ class DataExtensionsApi {
|
|
|
20674
20674
|
/**
|
|
20675
20675
|
* DataExtensions service.
|
|
20676
20676
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20677
|
-
* @version
|
|
20677
|
+
* @version 202.0.0
|
|
20678
20678
|
*/
|
|
20679
20679
|
|
|
20680
20680
|
/**
|
|
@@ -20760,7 +20760,7 @@ class DownloadsApi {
|
|
|
20760
20760
|
/**
|
|
20761
20761
|
* Downloads service.
|
|
20762
20762
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20763
|
-
* @version
|
|
20763
|
+
* @version 202.0.0
|
|
20764
20764
|
*/
|
|
20765
20765
|
|
|
20766
20766
|
/**
|
|
@@ -20812,7 +20812,7 @@ class EmailsApi {
|
|
|
20812
20812
|
/**
|
|
20813
20813
|
* Emails service.
|
|
20814
20814
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20815
|
-
* @version
|
|
20815
|
+
* @version 202.0.0
|
|
20816
20816
|
*/
|
|
20817
20817
|
|
|
20818
20818
|
/**
|
|
@@ -20877,7 +20877,7 @@ class EmployeeEngagementApi {
|
|
|
20877
20877
|
/**
|
|
20878
20878
|
* EmployeeEngagement service.
|
|
20879
20879
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20880
|
-
* @version
|
|
20880
|
+
* @version 202.0.0
|
|
20881
20881
|
*/
|
|
20882
20882
|
|
|
20883
20883
|
/**
|
|
@@ -21028,7 +21028,7 @@ class EventsApi {
|
|
|
21028
21028
|
/**
|
|
21029
21029
|
* Events service.
|
|
21030
21030
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21031
|
-
* @version
|
|
21031
|
+
* @version 202.0.0
|
|
21032
21032
|
*/
|
|
21033
21033
|
|
|
21034
21034
|
/**
|
|
@@ -21124,7 +21124,7 @@ class ExternalContactsApi {
|
|
|
21124
21124
|
/**
|
|
21125
21125
|
* ExternalContacts service.
|
|
21126
21126
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21127
|
-
* @version
|
|
21127
|
+
* @version 202.0.0
|
|
21128
21128
|
*/
|
|
21129
21129
|
|
|
21130
21130
|
/**
|
|
@@ -23086,7 +23086,7 @@ class FaxApi {
|
|
|
23086
23086
|
/**
|
|
23087
23087
|
* Fax service.
|
|
23088
23088
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23089
|
-
* @version
|
|
23089
|
+
* @version 202.0.0
|
|
23090
23090
|
*/
|
|
23091
23091
|
|
|
23092
23092
|
/**
|
|
@@ -23301,7 +23301,7 @@ class FlowsApi {
|
|
|
23301
23301
|
/**
|
|
23302
23302
|
* Flows service.
|
|
23303
23303
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23304
|
-
* @version
|
|
23304
|
+
* @version 202.0.0
|
|
23305
23305
|
*/
|
|
23306
23306
|
|
|
23307
23307
|
/**
|
|
@@ -23484,7 +23484,7 @@ class GamificationApi {
|
|
|
23484
23484
|
/**
|
|
23485
23485
|
* Gamification service.
|
|
23486
23486
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23487
|
-
* @version
|
|
23487
|
+
* @version 202.0.0
|
|
23488
23488
|
*/
|
|
23489
23489
|
|
|
23490
23490
|
/**
|
|
@@ -25570,7 +25570,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25570
25570
|
/**
|
|
25571
25571
|
* GeneralDataProtectionRegulation service.
|
|
25572
25572
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25573
|
-
* @version
|
|
25573
|
+
* @version 202.0.0
|
|
25574
25574
|
*/
|
|
25575
25575
|
|
|
25576
25576
|
/**
|
|
@@ -25700,7 +25700,7 @@ class GeolocationApi {
|
|
|
25700
25700
|
/**
|
|
25701
25701
|
* Geolocation service.
|
|
25702
25702
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25703
|
-
* @version
|
|
25703
|
+
* @version 202.0.0
|
|
25704
25704
|
*/
|
|
25705
25705
|
|
|
25706
25706
|
/**
|
|
@@ -25831,7 +25831,7 @@ class GreetingsApi {
|
|
|
25831
25831
|
/**
|
|
25832
25832
|
* Greetings service.
|
|
25833
25833
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25834
|
-
* @version
|
|
25834
|
+
* @version 202.0.0
|
|
25835
25835
|
*/
|
|
25836
25836
|
|
|
25837
25837
|
/**
|
|
@@ -26286,7 +26286,7 @@ class GroupsApi {
|
|
|
26286
26286
|
/**
|
|
26287
26287
|
* Groups service.
|
|
26288
26288
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26289
|
-
* @version
|
|
26289
|
+
* @version 202.0.0
|
|
26290
26290
|
*/
|
|
26291
26291
|
|
|
26292
26292
|
/**
|
|
@@ -26805,7 +26805,7 @@ class IdentityProviderApi {
|
|
|
26805
26805
|
/**
|
|
26806
26806
|
* IdentityProvider service.
|
|
26807
26807
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26808
|
-
* @version
|
|
26808
|
+
* @version 202.0.0
|
|
26809
26809
|
*/
|
|
26810
26810
|
|
|
26811
26811
|
/**
|
|
@@ -27666,7 +27666,7 @@ class InfrastructureAsCodeApi {
|
|
|
27666
27666
|
/**
|
|
27667
27667
|
* InfrastructureAsCode service.
|
|
27668
27668
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27669
|
-
* @version
|
|
27669
|
+
* @version 202.0.0
|
|
27670
27670
|
*/
|
|
27671
27671
|
|
|
27672
27672
|
/**
|
|
@@ -27833,7 +27833,7 @@ class IntegrationsApi {
|
|
|
27833
27833
|
/**
|
|
27834
27834
|
* Integrations service.
|
|
27835
27835
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27836
|
-
* @version
|
|
27836
|
+
* @version 202.0.0
|
|
27837
27837
|
*/
|
|
27838
27838
|
|
|
27839
27839
|
/**
|
|
@@ -28382,6 +28382,26 @@ class IntegrationsApi {
|
|
|
28382
28382
|
);
|
|
28383
28383
|
}
|
|
28384
28384
|
|
|
28385
|
+
/**
|
|
28386
|
+
* Retrieves basic info about trusted root CA certificates
|
|
28387
|
+
*
|
|
28388
|
+
*/
|
|
28389
|
+
getIntegrationsActionsCertificatesTruststore() {
|
|
28390
|
+
|
|
28391
|
+
return this.apiClient.callApi(
|
|
28392
|
+
'/api/v2/integrations/actions/certificates/truststore',
|
|
28393
|
+
'GET',
|
|
28394
|
+
{ },
|
|
28395
|
+
{ },
|
|
28396
|
+
{ },
|
|
28397
|
+
{ },
|
|
28398
|
+
null,
|
|
28399
|
+
['PureCloud OAuth'],
|
|
28400
|
+
['application/json'],
|
|
28401
|
+
['application/json']
|
|
28402
|
+
);
|
|
28403
|
+
}
|
|
28404
|
+
|
|
28385
28405
|
/**
|
|
28386
28406
|
* Retrieves all action drafts associated with the filters passed in via query param.
|
|
28387
28407
|
*
|
|
@@ -30185,7 +30205,7 @@ class JourneyApi {
|
|
|
30185
30205
|
/**
|
|
30186
30206
|
* Journey service.
|
|
30187
30207
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30188
|
-
* @version
|
|
30208
|
+
* @version 202.0.0
|
|
30189
30209
|
*/
|
|
30190
30210
|
|
|
30191
30211
|
/**
|
|
@@ -31838,7 +31858,7 @@ class KnowledgeApi {
|
|
|
31838
31858
|
/**
|
|
31839
31859
|
* Knowledge service.
|
|
31840
31860
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31841
|
-
* @version
|
|
31861
|
+
* @version 202.0.0
|
|
31842
31862
|
*/
|
|
31843
31863
|
|
|
31844
31864
|
/**
|
|
@@ -35082,7 +35102,7 @@ class LanguageUnderstandingApi {
|
|
|
35082
35102
|
/**
|
|
35083
35103
|
* LanguageUnderstanding service.
|
|
35084
35104
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
35085
|
-
* @version
|
|
35105
|
+
* @version 202.0.0
|
|
35086
35106
|
*/
|
|
35087
35107
|
|
|
35088
35108
|
/**
|
|
@@ -36116,7 +36136,7 @@ class LanguagesApi {
|
|
|
36116
36136
|
/**
|
|
36117
36137
|
* Languages service.
|
|
36118
36138
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
36119
|
-
* @version
|
|
36139
|
+
* @version 202.0.0
|
|
36120
36140
|
*/
|
|
36121
36141
|
|
|
36122
36142
|
/**
|
|
@@ -36338,7 +36358,7 @@ class LearningApi {
|
|
|
36338
36358
|
/**
|
|
36339
36359
|
* Learning service.
|
|
36340
36360
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36341
|
-
* @version
|
|
36361
|
+
* @version 202.0.0
|
|
36342
36362
|
*/
|
|
36343
36363
|
|
|
36344
36364
|
/**
|
|
@@ -36484,7 +36504,7 @@ class LearningApi {
|
|
|
36484
36504
|
* @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
36485
36505
|
* @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
|
|
36486
36506
|
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs.
|
|
36487
|
-
* @param {Array.<String>} opts.types Specifies the module types to filter by
|
|
36507
|
+
* @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
|
|
36488
36508
|
* @param {Array.<String>} opts.states Specifies the assignment states to filter by
|
|
36489
36509
|
* @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
|
|
36490
36510
|
*/
|
|
@@ -36521,7 +36541,7 @@ class LearningApi {
|
|
|
36521
36541
|
* @param {Number} opts.maxPercentageScore The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
|
|
36522
36542
|
* @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
36523
36543
|
* @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
|
|
36524
|
-
* @param {Array.<String>} opts.types Specifies the module types to filter by
|
|
36544
|
+
* @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
|
|
36525
36545
|
* @param {Array.<String>} opts.states Specifies the assignment states to filter by
|
|
36526
36546
|
* @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
|
|
36527
36547
|
*/
|
|
@@ -36691,7 +36711,7 @@ class LearningApi {
|
|
|
36691
36711
|
*
|
|
36692
36712
|
* @param {Object} opts Optional parameters
|
|
36693
36713
|
* @param {Boolean} opts.isArchived Archive status (default to false)
|
|
36694
|
-
* @param {Array.<String>} opts.types Specifies the module types.
|
|
36714
|
+
* @param {Array.<String>} opts.types Specifies the module types. Informational, AssessedContent and Assessment are deprecated
|
|
36695
36715
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
36696
36716
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
36697
36717
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
@@ -37367,7 +37387,7 @@ class LicenseApi {
|
|
|
37367
37387
|
/**
|
|
37368
37388
|
* License service.
|
|
37369
37389
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37370
|
-
* @version
|
|
37390
|
+
* @version 202.0.0
|
|
37371
37391
|
*/
|
|
37372
37392
|
|
|
37373
37393
|
/**
|
|
@@ -37605,7 +37625,7 @@ class LocationsApi {
|
|
|
37605
37625
|
/**
|
|
37606
37626
|
* Locations service.
|
|
37607
37627
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37608
|
-
* @version
|
|
37628
|
+
* @version 202.0.0
|
|
37609
37629
|
*/
|
|
37610
37630
|
|
|
37611
37631
|
/**
|
|
@@ -37841,7 +37861,7 @@ class LogCaptureApi {
|
|
|
37841
37861
|
/**
|
|
37842
37862
|
* LogCapture service.
|
|
37843
37863
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37844
|
-
* @version
|
|
37864
|
+
* @version 202.0.0
|
|
37845
37865
|
*/
|
|
37846
37866
|
|
|
37847
37867
|
/**
|
|
@@ -38041,7 +38061,7 @@ class MessagingApi {
|
|
|
38041
38061
|
/**
|
|
38042
38062
|
* Messaging service.
|
|
38043
38063
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
38044
|
-
* @version
|
|
38064
|
+
* @version 202.0.0
|
|
38045
38065
|
*/
|
|
38046
38066
|
|
|
38047
38067
|
/**
|
|
@@ -38400,7 +38420,7 @@ class MobileDevicesApi {
|
|
|
38400
38420
|
/**
|
|
38401
38421
|
* MobileDevices service.
|
|
38402
38422
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38403
|
-
* @version
|
|
38423
|
+
* @version 202.0.0
|
|
38404
38424
|
*/
|
|
38405
38425
|
|
|
38406
38426
|
/**
|
|
@@ -38551,7 +38571,7 @@ class NotificationsApi {
|
|
|
38551
38571
|
/**
|
|
38552
38572
|
* Notifications service.
|
|
38553
38573
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38554
|
-
* @version
|
|
38574
|
+
* @version 202.0.0
|
|
38555
38575
|
*/
|
|
38556
38576
|
|
|
38557
38577
|
/**
|
|
@@ -38784,7 +38804,7 @@ class OAuthApi {
|
|
|
38784
38804
|
/**
|
|
38785
38805
|
* OAuth service.
|
|
38786
38806
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38787
|
-
* @version
|
|
38807
|
+
* @version 202.0.0
|
|
38788
38808
|
*/
|
|
38789
38809
|
|
|
38790
38810
|
/**
|
|
@@ -39150,7 +39170,7 @@ class ObjectsApi {
|
|
|
39150
39170
|
/**
|
|
39151
39171
|
* Objects service.
|
|
39152
39172
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
39153
|
-
* @version
|
|
39173
|
+
* @version 202.0.0
|
|
39154
39174
|
*/
|
|
39155
39175
|
|
|
39156
39176
|
/**
|
|
@@ -39420,7 +39440,7 @@ class OperationalEventsApi {
|
|
|
39420
39440
|
/**
|
|
39421
39441
|
* OperationalEvents service.
|
|
39422
39442
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39423
|
-
* @version
|
|
39443
|
+
* @version 202.0.0
|
|
39424
39444
|
*/
|
|
39425
39445
|
|
|
39426
39446
|
/**
|
|
@@ -39486,7 +39506,7 @@ class OrganizationApi {
|
|
|
39486
39506
|
/**
|
|
39487
39507
|
* Organization service.
|
|
39488
39508
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39489
|
-
* @version
|
|
39509
|
+
* @version 202.0.0
|
|
39490
39510
|
*/
|
|
39491
39511
|
|
|
39492
39512
|
/**
|
|
@@ -39707,6 +39727,37 @@ class OrganizationApi {
|
|
|
39707
39727
|
);
|
|
39708
39728
|
}
|
|
39709
39729
|
|
|
39730
|
+
/**
|
|
39731
|
+
* Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
|
|
39732
|
+
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
39733
|
+
* @param {String} namespaceName The namespace to get
|
|
39734
|
+
* @param {Object} opts Optional parameters
|
|
39735
|
+
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
39736
|
+
* @param {String} opts.entityId entity id of the count
|
|
39737
|
+
* @param {String} opts.userId userid of the count
|
|
39738
|
+
*/
|
|
39739
|
+
getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
|
|
39740
|
+
opts = opts || {};
|
|
39741
|
+
|
|
39742
|
+
// verify the required parameter 'namespaceName' is set
|
|
39743
|
+
if (namespaceName === undefined || namespaceName === null) {
|
|
39744
|
+
throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';
|
|
39745
|
+
}
|
|
39746
|
+
|
|
39747
|
+
return this.apiClient.callApi(
|
|
39748
|
+
'/api/v2/organizations/limits/namespaces/{namespaceName}/counts',
|
|
39749
|
+
'GET',
|
|
39750
|
+
{ 'namespaceName': namespaceName },
|
|
39751
|
+
{ 'cursor': opts['cursor'],'entityId': opts['entityId'],'userId': opts['userId'] },
|
|
39752
|
+
{ },
|
|
39753
|
+
{ },
|
|
39754
|
+
null,
|
|
39755
|
+
['PureCloud OAuth'],
|
|
39756
|
+
['application/json'],
|
|
39757
|
+
['application/json']
|
|
39758
|
+
);
|
|
39759
|
+
}
|
|
39760
|
+
|
|
39710
39761
|
/**
|
|
39711
39762
|
* Get the default limits in a namespace for an organization
|
|
39712
39763
|
*
|
|
@@ -39732,6 +39783,42 @@ class OrganizationApi {
|
|
|
39732
39783
|
);
|
|
39733
39784
|
}
|
|
39734
39785
|
|
|
39786
|
+
/**
|
|
39787
|
+
* Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
|
|
39788
|
+
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
39789
|
+
* @param {String} namespaceName The namespace to get
|
|
39790
|
+
* @param {String} limitName The limit to get
|
|
39791
|
+
* @param {Object} opts Optional parameters
|
|
39792
|
+
* @param {String} opts.entityId entity id of the count
|
|
39793
|
+
* @param {String} opts.userId userid of the count
|
|
39794
|
+
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
39795
|
+
*/
|
|
39796
|
+
getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
|
|
39797
|
+
opts = opts || {};
|
|
39798
|
+
|
|
39799
|
+
// verify the required parameter 'namespaceName' is set
|
|
39800
|
+
if (namespaceName === undefined || namespaceName === null) {
|
|
39801
|
+
throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';
|
|
39802
|
+
}
|
|
39803
|
+
// verify the required parameter 'limitName' is set
|
|
39804
|
+
if (limitName === undefined || limitName === null) {
|
|
39805
|
+
throw 'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';
|
|
39806
|
+
}
|
|
39807
|
+
|
|
39808
|
+
return this.apiClient.callApi(
|
|
39809
|
+
'/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts',
|
|
39810
|
+
'GET',
|
|
39811
|
+
{ 'namespaceName': namespaceName,'limitName': limitName },
|
|
39812
|
+
{ 'entityId': opts['entityId'],'userId': opts['userId'],'cursor': opts['cursor'] },
|
|
39813
|
+
{ },
|
|
39814
|
+
{ },
|
|
39815
|
+
null,
|
|
39816
|
+
['PureCloud OAuth'],
|
|
39817
|
+
['application/json'],
|
|
39818
|
+
['application/json']
|
|
39819
|
+
);
|
|
39820
|
+
}
|
|
39821
|
+
|
|
39735
39822
|
/**
|
|
39736
39823
|
* Get the available limit namespaces
|
|
39737
39824
|
*
|
|
@@ -39961,7 +40048,7 @@ class OrganizationAuthorizationApi {
|
|
|
39961
40048
|
/**
|
|
39962
40049
|
* OrganizationAuthorization service.
|
|
39963
40050
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39964
|
-
* @version
|
|
40051
|
+
* @version 202.0.0
|
|
39965
40052
|
*/
|
|
39966
40053
|
|
|
39967
40054
|
/**
|
|
@@ -41308,7 +41395,7 @@ class OutboundApi {
|
|
|
41308
41395
|
/**
|
|
41309
41396
|
* Outbound service.
|
|
41310
41397
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
41311
|
-
* @version
|
|
41398
|
+
* @version 202.0.0
|
|
41312
41399
|
*/
|
|
41313
41400
|
|
|
41314
41401
|
/**
|
|
@@ -42710,6 +42797,61 @@ class OutboundApi {
|
|
|
42710
42797
|
);
|
|
42711
42798
|
}
|
|
42712
42799
|
|
|
42800
|
+
/**
|
|
42801
|
+
* Get bulk operation job.
|
|
42802
|
+
*
|
|
42803
|
+
* @param {String} contactListId Contact List ID
|
|
42804
|
+
* @param {String} jobId Job ID
|
|
42805
|
+
*/
|
|
42806
|
+
getOutboundContactlistContactsBulkJob(contactListId, jobId) {
|
|
42807
|
+
// verify the required parameter 'contactListId' is set
|
|
42808
|
+
if (contactListId === undefined || contactListId === null) {
|
|
42809
|
+
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContactsBulkJob';
|
|
42810
|
+
}
|
|
42811
|
+
// verify the required parameter 'jobId' is set
|
|
42812
|
+
if (jobId === undefined || jobId === null) {
|
|
42813
|
+
throw 'Missing the required parameter "jobId" when calling getOutboundContactlistContactsBulkJob';
|
|
42814
|
+
}
|
|
42815
|
+
|
|
42816
|
+
return this.apiClient.callApi(
|
|
42817
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId}',
|
|
42818
|
+
'GET',
|
|
42819
|
+
{ 'contactListId': contactListId,'jobId': jobId },
|
|
42820
|
+
{ },
|
|
42821
|
+
{ },
|
|
42822
|
+
{ },
|
|
42823
|
+
null,
|
|
42824
|
+
['PureCloud OAuth'],
|
|
42825
|
+
['application/json'],
|
|
42826
|
+
['application/json']
|
|
42827
|
+
);
|
|
42828
|
+
}
|
|
42829
|
+
|
|
42830
|
+
/**
|
|
42831
|
+
* Get 10 most recent bulk operation jobs associated with contact list.
|
|
42832
|
+
*
|
|
42833
|
+
* @param {String} contactListId Contact List ID
|
|
42834
|
+
*/
|
|
42835
|
+
getOutboundContactlistContactsBulkJobs(contactListId) {
|
|
42836
|
+
// verify the required parameter 'contactListId' is set
|
|
42837
|
+
if (contactListId === undefined || contactListId === null) {
|
|
42838
|
+
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContactsBulkJobs';
|
|
42839
|
+
}
|
|
42840
|
+
|
|
42841
|
+
return this.apiClient.callApi(
|
|
42842
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs',
|
|
42843
|
+
'GET',
|
|
42844
|
+
{ 'contactListId': contactListId },
|
|
42845
|
+
{ },
|
|
42846
|
+
{ },
|
|
42847
|
+
{ },
|
|
42848
|
+
null,
|
|
42849
|
+
['PureCloud OAuth'],
|
|
42850
|
+
['application/json'],
|
|
42851
|
+
['application/json']
|
|
42852
|
+
);
|
|
42853
|
+
}
|
|
42854
|
+
|
|
42713
42855
|
/**
|
|
42714
42856
|
* Get the URI of a contact list export.
|
|
42715
42857
|
*
|
|
@@ -45670,7 +45812,7 @@ class PresenceApi {
|
|
|
45670
45812
|
/**
|
|
45671
45813
|
* Presence service.
|
|
45672
45814
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45673
|
-
* @version
|
|
45815
|
+
* @version 202.0.0
|
|
45674
45816
|
*/
|
|
45675
45817
|
|
|
45676
45818
|
/**
|
|
@@ -46414,7 +46556,7 @@ class ProcessAutomationApi {
|
|
|
46414
46556
|
/**
|
|
46415
46557
|
* ProcessAutomation service.
|
|
46416
46558
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
46417
|
-
* @version
|
|
46559
|
+
* @version 202.0.0
|
|
46418
46560
|
*/
|
|
46419
46561
|
|
|
46420
46562
|
/**
|
|
@@ -46653,7 +46795,7 @@ class QualityApi {
|
|
|
46653
46795
|
/**
|
|
46654
46796
|
* Quality service.
|
|
46655
46797
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46656
|
-
* @version
|
|
46798
|
+
* @version 202.0.0
|
|
46657
46799
|
*/
|
|
46658
46800
|
|
|
46659
46801
|
/**
|
|
@@ -48439,7 +48581,7 @@ class RecordingApi {
|
|
|
48439
48581
|
/**
|
|
48440
48582
|
* Recording service.
|
|
48441
48583
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
48442
|
-
* @version
|
|
48584
|
+
* @version 202.0.0
|
|
48443
48585
|
*/
|
|
48444
48586
|
|
|
48445
48587
|
/**
|
|
@@ -48924,7 +49066,7 @@ class RecordingApi {
|
|
|
48924
49066
|
}
|
|
48925
49067
|
|
|
48926
49068
|
/**
|
|
48927
|
-
* Get the status and results for a batch request job, only the user that submitted the job may retrieve results
|
|
49069
|
+
* Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results.
|
|
48928
49070
|
*
|
|
48929
49071
|
* @param {String} jobId jobId
|
|
48930
49072
|
*/
|
|
@@ -50098,7 +50240,7 @@ class ResponseManagementApi {
|
|
|
50098
50240
|
/**
|
|
50099
50241
|
* ResponseManagement service.
|
|
50100
50242
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
50101
|
-
* @version
|
|
50243
|
+
* @version 202.0.0
|
|
50102
50244
|
*/
|
|
50103
50245
|
|
|
50104
50246
|
/**
|
|
@@ -50608,7 +50750,7 @@ class RoutingApi {
|
|
|
50608
50750
|
/**
|
|
50609
50751
|
* Routing service.
|
|
50610
50752
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50611
|
-
* @version
|
|
50753
|
+
* @version 202.0.0
|
|
50612
50754
|
*/
|
|
50613
50755
|
|
|
50614
50756
|
/**
|
|
@@ -54727,7 +54869,7 @@ class SCIMApi {
|
|
|
54727
54869
|
/**
|
|
54728
54870
|
* SCIM service.
|
|
54729
54871
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54730
|
-
* @version
|
|
54872
|
+
* @version 202.0.0
|
|
54731
54873
|
*/
|
|
54732
54874
|
|
|
54733
54875
|
/**
|
|
@@ -55604,7 +55746,7 @@ class ScreenRecordingApi {
|
|
|
55604
55746
|
/**
|
|
55605
55747
|
* ScreenRecording service.
|
|
55606
55748
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
55607
|
-
* @version
|
|
55749
|
+
* @version 202.0.0
|
|
55608
55750
|
*/
|
|
55609
55751
|
|
|
55610
55752
|
/**
|
|
@@ -55649,7 +55791,7 @@ class ScriptsApi {
|
|
|
55649
55791
|
/**
|
|
55650
55792
|
* Scripts service.
|
|
55651
55793
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55652
|
-
* @version
|
|
55794
|
+
* @version 202.0.0
|
|
55653
55795
|
*/
|
|
55654
55796
|
|
|
55655
55797
|
/**
|
|
@@ -56093,7 +56235,7 @@ class SearchApi {
|
|
|
56093
56235
|
/**
|
|
56094
56236
|
* Search service.
|
|
56095
56237
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
56096
|
-
* @version
|
|
56238
|
+
* @version 202.0.0
|
|
56097
56239
|
*/
|
|
56098
56240
|
|
|
56099
56241
|
/**
|
|
@@ -56782,7 +56924,7 @@ class SettingsApi {
|
|
|
56782
56924
|
/**
|
|
56783
56925
|
* Settings service.
|
|
56784
56926
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56785
|
-
* @version
|
|
56927
|
+
* @version 202.0.0
|
|
56786
56928
|
*/
|
|
56787
56929
|
|
|
56788
56930
|
/**
|
|
@@ -57004,7 +57146,7 @@ class SpeechTextAnalyticsApi {
|
|
|
57004
57146
|
/**
|
|
57005
57147
|
* SpeechTextAnalytics service.
|
|
57006
57148
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
57007
|
-
* @version
|
|
57149
|
+
* @version 202.0.0
|
|
57008
57150
|
*/
|
|
57009
57151
|
|
|
57010
57152
|
/**
|
|
@@ -58282,7 +58424,7 @@ class StationsApi {
|
|
|
58282
58424
|
/**
|
|
58283
58425
|
* Stations service.
|
|
58284
58426
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
58285
|
-
* @version
|
|
58427
|
+
* @version 202.0.0
|
|
58286
58428
|
*/
|
|
58287
58429
|
|
|
58288
58430
|
/**
|
|
@@ -58384,7 +58526,7 @@ class SuggestApi {
|
|
|
58384
58526
|
/**
|
|
58385
58527
|
* Suggest service.
|
|
58386
58528
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
58387
|
-
* @version
|
|
58529
|
+
* @version 202.0.0
|
|
58388
58530
|
*/
|
|
58389
58531
|
|
|
58390
58532
|
/**
|
|
@@ -58523,7 +58665,7 @@ class TaskManagementApi {
|
|
|
58523
58665
|
/**
|
|
58524
58666
|
* TaskManagement service.
|
|
58525
58667
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
58526
|
-
* @version
|
|
58668
|
+
* @version 202.0.0
|
|
58527
58669
|
*/
|
|
58528
58670
|
|
|
58529
58671
|
/**
|
|
@@ -59470,16 +59612,17 @@ class TaskManagementApi {
|
|
|
59470
59612
|
* Update the attributes of a worktype
|
|
59471
59613
|
*
|
|
59472
59614
|
* @param {String} worktypeId Worktype id
|
|
59473
|
-
* @param {Object}
|
|
59474
|
-
* @param {Object} opts.body body
|
|
59615
|
+
* @param {Object} body Worktype
|
|
59475
59616
|
*/
|
|
59476
|
-
patchTaskmanagementWorktype(worktypeId,
|
|
59477
|
-
opts = opts || {};
|
|
59478
|
-
|
|
59617
|
+
patchTaskmanagementWorktype(worktypeId, body) {
|
|
59479
59618
|
// verify the required parameter 'worktypeId' is set
|
|
59480
59619
|
if (worktypeId === undefined || worktypeId === null) {
|
|
59481
59620
|
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';
|
|
59482
59621
|
}
|
|
59622
|
+
// verify the required parameter 'body' is set
|
|
59623
|
+
if (body === undefined || body === null) {
|
|
59624
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktype';
|
|
59625
|
+
}
|
|
59483
59626
|
|
|
59484
59627
|
return this.apiClient.callApi(
|
|
59485
59628
|
'/api/v2/taskmanagement/worktypes/{worktypeId}',
|
|
@@ -59488,7 +59631,7 @@ class TaskManagementApi {
|
|
|
59488
59631
|
{ },
|
|
59489
59632
|
{ },
|
|
59490
59633
|
{ },
|
|
59491
|
-
|
|
59634
|
+
body,
|
|
59492
59635
|
['PureCloud OAuth'],
|
|
59493
59636
|
['application/json'],
|
|
59494
59637
|
['application/json']
|
|
@@ -59500,12 +59643,9 @@ class TaskManagementApi {
|
|
|
59500
59643
|
*
|
|
59501
59644
|
* @param {String} worktypeId Worktype id
|
|
59502
59645
|
* @param {String} statusId Status id
|
|
59503
|
-
* @param {Object}
|
|
59504
|
-
* @param {Object} opts.body body
|
|
59646
|
+
* @param {Object} body Status
|
|
59505
59647
|
*/
|
|
59506
|
-
patchTaskmanagementWorktypeStatus(worktypeId, statusId,
|
|
59507
|
-
opts = opts || {};
|
|
59508
|
-
|
|
59648
|
+
patchTaskmanagementWorktypeStatus(worktypeId, statusId, body) {
|
|
59509
59649
|
// verify the required parameter 'worktypeId' is set
|
|
59510
59650
|
if (worktypeId === undefined || worktypeId === null) {
|
|
59511
59651
|
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeStatus';
|
|
@@ -59514,6 +59654,10 @@ class TaskManagementApi {
|
|
|
59514
59654
|
if (statusId === undefined || statusId === null) {
|
|
59515
59655
|
throw 'Missing the required parameter "statusId" when calling patchTaskmanagementWorktypeStatus';
|
|
59516
59656
|
}
|
|
59657
|
+
// verify the required parameter 'body' is set
|
|
59658
|
+
if (body === undefined || body === null) {
|
|
59659
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeStatus';
|
|
59660
|
+
}
|
|
59517
59661
|
|
|
59518
59662
|
return this.apiClient.callApi(
|
|
59519
59663
|
'/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}',
|
|
@@ -59522,7 +59666,7 @@ class TaskManagementApi {
|
|
|
59522
59666
|
{ },
|
|
59523
59667
|
{ },
|
|
59524
59668
|
{ },
|
|
59525
|
-
|
|
59669
|
+
body,
|
|
59526
59670
|
['PureCloud OAuth'],
|
|
59527
59671
|
['application/json'],
|
|
59528
59672
|
['application/json']
|
|
@@ -59532,12 +59676,13 @@ class TaskManagementApi {
|
|
|
59532
59676
|
/**
|
|
59533
59677
|
* Create a workbin
|
|
59534
59678
|
*
|
|
59535
|
-
* @param {Object}
|
|
59536
|
-
* @param {Object} opts.body body
|
|
59679
|
+
* @param {Object} body Workbin
|
|
59537
59680
|
*/
|
|
59538
|
-
postTaskmanagementWorkbins(
|
|
59539
|
-
|
|
59540
|
-
|
|
59681
|
+
postTaskmanagementWorkbins(body) {
|
|
59682
|
+
// verify the required parameter 'body' is set
|
|
59683
|
+
if (body === undefined || body === null) {
|
|
59684
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkbins';
|
|
59685
|
+
}
|
|
59541
59686
|
|
|
59542
59687
|
return this.apiClient.callApi(
|
|
59543
59688
|
'/api/v2/taskmanagement/workbins',
|
|
@@ -59546,7 +59691,7 @@ class TaskManagementApi {
|
|
|
59546
59691
|
{ },
|
|
59547
59692
|
{ },
|
|
59548
59693
|
{ },
|
|
59549
|
-
|
|
59694
|
+
body,
|
|
59550
59695
|
['PureCloud OAuth'],
|
|
59551
59696
|
['application/json'],
|
|
59552
59697
|
['application/json']
|
|
@@ -59762,16 +59907,17 @@ class TaskManagementApi {
|
|
|
59762
59907
|
* Add a status to a worktype
|
|
59763
59908
|
*
|
|
59764
59909
|
* @param {String} worktypeId Worktype id
|
|
59765
|
-
* @param {Object}
|
|
59766
|
-
* @param {Object} opts.body body
|
|
59910
|
+
* @param {Object} body Status
|
|
59767
59911
|
*/
|
|
59768
|
-
postTaskmanagementWorktypeStatuses(worktypeId,
|
|
59769
|
-
opts = opts || {};
|
|
59770
|
-
|
|
59912
|
+
postTaskmanagementWorktypeStatuses(worktypeId, body) {
|
|
59771
59913
|
// verify the required parameter 'worktypeId' is set
|
|
59772
59914
|
if (worktypeId === undefined || worktypeId === null) {
|
|
59773
59915
|
throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeStatuses';
|
|
59774
59916
|
}
|
|
59917
|
+
// verify the required parameter 'body' is set
|
|
59918
|
+
if (body === undefined || body === null) {
|
|
59919
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeStatuses';
|
|
59920
|
+
}
|
|
59775
59921
|
|
|
59776
59922
|
return this.apiClient.callApi(
|
|
59777
59923
|
'/api/v2/taskmanagement/worktypes/{worktypeId}/statuses',
|
|
@@ -59780,7 +59926,7 @@ class TaskManagementApi {
|
|
|
59780
59926
|
{ },
|
|
59781
59927
|
{ },
|
|
59782
59928
|
{ },
|
|
59783
|
-
|
|
59929
|
+
body,
|
|
59784
59930
|
['PureCloud OAuth'],
|
|
59785
59931
|
['application/json'],
|
|
59786
59932
|
['application/json']
|
|
@@ -59790,12 +59936,13 @@ class TaskManagementApi {
|
|
|
59790
59936
|
/**
|
|
59791
59937
|
* Create a worktype
|
|
59792
59938
|
*
|
|
59793
|
-
* @param {Object}
|
|
59794
|
-
* @param {Object} opts.body body
|
|
59939
|
+
* @param {Object} body Worktype
|
|
59795
59940
|
*/
|
|
59796
|
-
postTaskmanagementWorktypes(
|
|
59797
|
-
|
|
59798
|
-
|
|
59941
|
+
postTaskmanagementWorktypes(body) {
|
|
59942
|
+
// verify the required parameter 'body' is set
|
|
59943
|
+
if (body === undefined || body === null) {
|
|
59944
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypes';
|
|
59945
|
+
}
|
|
59799
59946
|
|
|
59800
59947
|
return this.apiClient.callApi(
|
|
59801
59948
|
'/api/v2/taskmanagement/worktypes',
|
|
@@ -59804,7 +59951,7 @@ class TaskManagementApi {
|
|
|
59804
59951
|
{ },
|
|
59805
59952
|
{ },
|
|
59806
59953
|
{ },
|
|
59807
|
-
|
|
59954
|
+
body,
|
|
59808
59955
|
['PureCloud OAuth'],
|
|
59809
59956
|
['application/json'],
|
|
59810
59957
|
['application/json']
|
|
@@ -59872,7 +60019,7 @@ class TeamsApi {
|
|
|
59872
60019
|
/**
|
|
59873
60020
|
* Teams service.
|
|
59874
60021
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59875
|
-
* @version
|
|
60022
|
+
* @version 202.0.0
|
|
59876
60023
|
*/
|
|
59877
60024
|
|
|
59878
60025
|
/**
|
|
@@ -60173,7 +60320,7 @@ class TelephonyApi {
|
|
|
60173
60320
|
/**
|
|
60174
60321
|
* Telephony service.
|
|
60175
60322
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
60176
|
-
* @version
|
|
60323
|
+
* @version 202.0.0
|
|
60177
60324
|
*/
|
|
60178
60325
|
|
|
60179
60326
|
/**
|
|
@@ -60355,7 +60502,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
60355
60502
|
/**
|
|
60356
60503
|
* TelephonyProvidersEdge service.
|
|
60357
60504
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
60358
|
-
* @version
|
|
60505
|
+
* @version 202.0.0
|
|
60359
60506
|
*/
|
|
60360
60507
|
|
|
60361
60508
|
/**
|
|
@@ -63683,7 +63830,7 @@ class TextbotsApi {
|
|
|
63683
63830
|
/**
|
|
63684
63831
|
* Textbots service.
|
|
63685
63832
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
63686
|
-
* @version
|
|
63833
|
+
* @version 202.0.0
|
|
63687
63834
|
*/
|
|
63688
63835
|
|
|
63689
63836
|
/**
|
|
@@ -63811,7 +63958,7 @@ class TokensApi {
|
|
|
63811
63958
|
/**
|
|
63812
63959
|
* Tokens service.
|
|
63813
63960
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63814
|
-
* @version
|
|
63961
|
+
* @version 202.0.0
|
|
63815
63962
|
*/
|
|
63816
63963
|
|
|
63817
63964
|
/**
|
|
@@ -63965,7 +64112,7 @@ class UploadsApi {
|
|
|
63965
64112
|
/**
|
|
63966
64113
|
* Uploads service.
|
|
63967
64114
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63968
|
-
* @version
|
|
64115
|
+
* @version 202.0.0
|
|
63969
64116
|
*/
|
|
63970
64117
|
|
|
63971
64118
|
/**
|
|
@@ -64234,7 +64381,7 @@ class UsageApi {
|
|
|
64234
64381
|
/**
|
|
64235
64382
|
* Usage service.
|
|
64236
64383
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
64237
|
-
* @version
|
|
64384
|
+
* @version 202.0.0
|
|
64238
64385
|
*/
|
|
64239
64386
|
|
|
64240
64387
|
/**
|
|
@@ -64449,7 +64596,7 @@ class UserRecordingsApi {
|
|
|
64449
64596
|
/**
|
|
64450
64597
|
* UserRecordings service.
|
|
64451
64598
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
64452
|
-
* @version
|
|
64599
|
+
* @version 202.0.0
|
|
64453
64600
|
*/
|
|
64454
64601
|
|
|
64455
64602
|
/**
|
|
@@ -64520,11 +64667,12 @@ class UserRecordingsApi {
|
|
|
64520
64667
|
|
|
64521
64668
|
/**
|
|
64522
64669
|
* Download a user recording.
|
|
64523
|
-
*
|
|
64670
|
+
* API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
|
|
64524
64671
|
* @param {String} recordingId User Recording ID
|
|
64525
64672
|
* @param {Object} opts Optional parameters
|
|
64526
64673
|
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
64527
64674
|
* @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
|
|
64675
|
+
* @deprecated
|
|
64528
64676
|
*/
|
|
64529
64677
|
getUserrecordingMedia(recordingId, opts) {
|
|
64530
64678
|
opts = opts || {};
|
|
@@ -64548,6 +64696,35 @@ class UserRecordingsApi {
|
|
|
64548
64696
|
);
|
|
64549
64697
|
}
|
|
64550
64698
|
|
|
64699
|
+
/**
|
|
64700
|
+
* Download a user recording.
|
|
64701
|
+
*
|
|
64702
|
+
* @param {String} recordingId User Recording ID
|
|
64703
|
+
* @param {Object} opts Optional parameters
|
|
64704
|
+
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
64705
|
+
*/
|
|
64706
|
+
getUserrecordingTranscoding(recordingId, opts) {
|
|
64707
|
+
opts = opts || {};
|
|
64708
|
+
|
|
64709
|
+
// verify the required parameter 'recordingId' is set
|
|
64710
|
+
if (recordingId === undefined || recordingId === null) {
|
|
64711
|
+
throw 'Missing the required parameter "recordingId" when calling getUserrecordingTranscoding';
|
|
64712
|
+
}
|
|
64713
|
+
|
|
64714
|
+
return this.apiClient.callApi(
|
|
64715
|
+
'/api/v2/userrecordings/{recordingId}/transcoding',
|
|
64716
|
+
'GET',
|
|
64717
|
+
{ 'recordingId': recordingId },
|
|
64718
|
+
{ 'formatId': opts['formatId'] },
|
|
64719
|
+
{ },
|
|
64720
|
+
{ },
|
|
64721
|
+
null,
|
|
64722
|
+
['PureCloud OAuth'],
|
|
64723
|
+
['application/json'],
|
|
64724
|
+
['application/json']
|
|
64725
|
+
);
|
|
64726
|
+
}
|
|
64727
|
+
|
|
64551
64728
|
/**
|
|
64552
64729
|
* Get a list of user recordings.
|
|
64553
64730
|
*
|
|
@@ -64634,7 +64811,7 @@ class UsersApi {
|
|
|
64634
64811
|
/**
|
|
64635
64812
|
* Users service.
|
|
64636
64813
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
64637
|
-
* @version
|
|
64814
|
+
* @version 202.0.0
|
|
64638
64815
|
*/
|
|
64639
64816
|
|
|
64640
64817
|
/**
|
|
@@ -65962,7 +66139,7 @@ class UsersApi {
|
|
|
65962
66139
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
65963
66140
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
65964
66141
|
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
65965
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
66142
|
+
* @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
|
|
65966
66143
|
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
65967
66144
|
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.
|
|
65968
66145
|
*/
|
|
@@ -65996,7 +66173,7 @@ class UsersApi {
|
|
|
65996
66173
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
65997
66174
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
65998
66175
|
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
65999
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
66176
|
+
* @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
|
|
66000
66177
|
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
66001
66178
|
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.
|
|
66002
66179
|
*/
|
|
@@ -66022,7 +66199,7 @@ class UsersApi {
|
|
|
66022
66199
|
* Get a Development Activity
|
|
66023
66200
|
* Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.
|
|
66024
66201
|
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
66025
|
-
* @param {Object} type Specifies the activity type.
|
|
66202
|
+
* @param {Object} type Specifies the activity type. Informational, AssessedContent and Assessment are deprecated
|
|
66026
66203
|
*/
|
|
66027
66204
|
getUsersDevelopmentActivity(activityId, type) {
|
|
66028
66205
|
// verify the required parameter 'activityId' is set
|
|
@@ -67437,7 +67614,7 @@ class UtilitiesApi {
|
|
|
67437
67614
|
/**
|
|
67438
67615
|
* Utilities service.
|
|
67439
67616
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
67440
|
-
* @version
|
|
67617
|
+
* @version 202.0.0
|
|
67441
67618
|
*/
|
|
67442
67619
|
|
|
67443
67620
|
/**
|
|
@@ -67548,7 +67725,7 @@ class VoicemailApi {
|
|
|
67548
67725
|
/**
|
|
67549
67726
|
* Voicemail service.
|
|
67550
67727
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
67551
|
-
* @version
|
|
67728
|
+
* @version 202.0.0
|
|
67552
67729
|
*/
|
|
67553
67730
|
|
|
67554
67731
|
/**
|
|
@@ -68215,7 +68392,7 @@ class WebChatApi {
|
|
|
68215
68392
|
/**
|
|
68216
68393
|
* WebChat service.
|
|
68217
68394
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
68218
|
-
* @version
|
|
68395
|
+
* @version 202.0.0
|
|
68219
68396
|
*/
|
|
68220
68397
|
|
|
68221
68398
|
/**
|
|
@@ -68766,7 +68943,7 @@ class WebDeploymentsApi {
|
|
|
68766
68943
|
/**
|
|
68767
68944
|
* WebDeployments service.
|
|
68768
68945
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
68769
|
-
* @version
|
|
68946
|
+
* @version 202.0.0
|
|
68770
68947
|
*/
|
|
68771
68948
|
|
|
68772
68949
|
/**
|
|
@@ -69293,7 +69470,7 @@ class WebMessagingApi {
|
|
|
69293
69470
|
/**
|
|
69294
69471
|
* WebMessaging service.
|
|
69295
69472
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
69296
|
-
* @version
|
|
69473
|
+
* @version 202.0.0
|
|
69297
69474
|
*/
|
|
69298
69475
|
|
|
69299
69476
|
/**
|
|
@@ -69339,7 +69516,7 @@ class WidgetsApi {
|
|
|
69339
69516
|
/**
|
|
69340
69517
|
* Widgets service.
|
|
69341
69518
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
69342
|
-
* @version
|
|
69519
|
+
* @version 202.0.0
|
|
69343
69520
|
*/
|
|
69344
69521
|
|
|
69345
69522
|
/**
|
|
@@ -69485,7 +69662,7 @@ class WorkforceManagementApi {
|
|
|
69485
69662
|
/**
|
|
69486
69663
|
* WorkforceManagement service.
|
|
69487
69664
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
69488
|
-
* @version
|
|
69665
|
+
* @version 202.0.0
|
|
69489
69666
|
*/
|
|
69490
69667
|
|
|
69491
69668
|
/**
|
|
@@ -69805,6 +69982,71 @@ class WorkforceManagementApi {
|
|
|
69805
69982
|
);
|
|
69806
69983
|
}
|
|
69807
69984
|
|
|
69985
|
+
/**
|
|
69986
|
+
* Delete a work plan bid
|
|
69987
|
+
*
|
|
69988
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69989
|
+
* @param {String} bidId The ID of the work plan bid
|
|
69990
|
+
*/
|
|
69991
|
+
deleteWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
|
|
69992
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69993
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69994
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
|
|
69995
|
+
}
|
|
69996
|
+
// verify the required parameter 'bidId' is set
|
|
69997
|
+
if (bidId === undefined || bidId === null) {
|
|
69998
|
+
throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
|
|
69999
|
+
}
|
|
70000
|
+
|
|
70001
|
+
return this.apiClient.callApi(
|
|
70002
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
|
|
70003
|
+
'DELETE',
|
|
70004
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
70005
|
+
{ },
|
|
70006
|
+
{ },
|
|
70007
|
+
{ },
|
|
70008
|
+
null,
|
|
70009
|
+
['PureCloud OAuth'],
|
|
70010
|
+
['application/json'],
|
|
70011
|
+
['application/json']
|
|
70012
|
+
);
|
|
70013
|
+
}
|
|
70014
|
+
|
|
70015
|
+
/**
|
|
70016
|
+
* Delete a bid group by bid group Id
|
|
70017
|
+
*
|
|
70018
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70019
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
70020
|
+
* @param {String} bidGroupId Work Plan Bid Group id
|
|
70021
|
+
*/
|
|
70022
|
+
deleteWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
|
|
70023
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70024
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70025
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
70026
|
+
}
|
|
70027
|
+
// verify the required parameter 'bidId' is set
|
|
70028
|
+
if (bidId === undefined || bidId === null) {
|
|
70029
|
+
throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
70030
|
+
}
|
|
70031
|
+
// verify the required parameter 'bidGroupId' is set
|
|
70032
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
70033
|
+
throw 'Missing the required parameter "bidGroupId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
70034
|
+
}
|
|
70035
|
+
|
|
70036
|
+
return this.apiClient.callApi(
|
|
70037
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
70038
|
+
'DELETE',
|
|
70039
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
70040
|
+
{ },
|
|
70041
|
+
{ },
|
|
70042
|
+
{ },
|
|
70043
|
+
null,
|
|
70044
|
+
['PureCloud OAuth'],
|
|
70045
|
+
['application/json'],
|
|
70046
|
+
['application/json']
|
|
70047
|
+
);
|
|
70048
|
+
}
|
|
70049
|
+
|
|
69808
70050
|
/**
|
|
69809
70051
|
* Disable generated calendar link for the current user
|
|
69810
70052
|
*
|
|
@@ -70170,6 +70412,175 @@ class WorkforceManagementApi {
|
|
|
70170
70412
|
);
|
|
70171
70413
|
}
|
|
70172
70414
|
|
|
70415
|
+
/**
|
|
70416
|
+
* Query the status of an alternative shift offers operation. Only the user who started the operation can query the status
|
|
70417
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
70418
|
+
* @param {String} jobId The ID of the job
|
|
70419
|
+
*/
|
|
70420
|
+
getWorkforcemanagementAlternativeshiftsOffersJob(jobId) {
|
|
70421
|
+
// verify the required parameter 'jobId' is set
|
|
70422
|
+
if (jobId === undefined || jobId === null) {
|
|
70423
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersJob';
|
|
70424
|
+
}
|
|
70425
|
+
|
|
70426
|
+
return this.apiClient.callApi(
|
|
70427
|
+
'/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}',
|
|
70428
|
+
'GET',
|
|
70429
|
+
{ 'jobId': jobId },
|
|
70430
|
+
{ },
|
|
70431
|
+
{ },
|
|
70432
|
+
{ },
|
|
70433
|
+
null,
|
|
70434
|
+
['PureCloud OAuth'],
|
|
70435
|
+
['application/json'],
|
|
70436
|
+
['application/json']
|
|
70437
|
+
);
|
|
70438
|
+
}
|
|
70439
|
+
|
|
70440
|
+
/**
|
|
70441
|
+
* Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status
|
|
70442
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
70443
|
+
* @param {String} jobId The ID of the job
|
|
70444
|
+
*/
|
|
70445
|
+
getWorkforcemanagementAlternativeshiftsOffersSearchJob(jobId) {
|
|
70446
|
+
// verify the required parameter 'jobId' is set
|
|
70447
|
+
if (jobId === undefined || jobId === null) {
|
|
70448
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersSearchJob';
|
|
70449
|
+
}
|
|
70450
|
+
|
|
70451
|
+
return this.apiClient.callApi(
|
|
70452
|
+
'/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}',
|
|
70453
|
+
'GET',
|
|
70454
|
+
{ 'jobId': jobId },
|
|
70455
|
+
{ },
|
|
70456
|
+
{ },
|
|
70457
|
+
{ },
|
|
70458
|
+
null,
|
|
70459
|
+
['PureCloud OAuth'],
|
|
70460
|
+
['application/json'],
|
|
70461
|
+
['application/json']
|
|
70462
|
+
);
|
|
70463
|
+
}
|
|
70464
|
+
|
|
70465
|
+
/**
|
|
70466
|
+
* Get alternative shifts settings from the current logged in agent’s business unit
|
|
70467
|
+
*
|
|
70468
|
+
*/
|
|
70469
|
+
getWorkforcemanagementAlternativeshiftsSettings() {
|
|
70470
|
+
|
|
70471
|
+
return this.apiClient.callApi(
|
|
70472
|
+
'/api/v2/workforcemanagement/alternativeshifts/settings',
|
|
70473
|
+
'GET',
|
|
70474
|
+
{ },
|
|
70475
|
+
{ },
|
|
70476
|
+
{ },
|
|
70477
|
+
{ },
|
|
70478
|
+
null,
|
|
70479
|
+
['PureCloud OAuth'],
|
|
70480
|
+
['application/json'],
|
|
70481
|
+
['application/json']
|
|
70482
|
+
);
|
|
70483
|
+
}
|
|
70484
|
+
|
|
70485
|
+
/**
|
|
70486
|
+
* Get my alternative shift trade by trade ID
|
|
70487
|
+
*
|
|
70488
|
+
* @param {String} tradeId The ID of the alternative shift trade
|
|
70489
|
+
*/
|
|
70490
|
+
getWorkforcemanagementAlternativeshiftsTrade(tradeId) {
|
|
70491
|
+
// verify the required parameter 'tradeId' is set
|
|
70492
|
+
if (tradeId === undefined || tradeId === null) {
|
|
70493
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementAlternativeshiftsTrade';
|
|
70494
|
+
}
|
|
70495
|
+
|
|
70496
|
+
return this.apiClient.callApi(
|
|
70497
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
|
|
70498
|
+
'GET',
|
|
70499
|
+
{ 'tradeId': tradeId },
|
|
70500
|
+
{ },
|
|
70501
|
+
{ },
|
|
70502
|
+
{ },
|
|
70503
|
+
null,
|
|
70504
|
+
['PureCloud OAuth'],
|
|
70505
|
+
['application/json'],
|
|
70506
|
+
['application/json']
|
|
70507
|
+
);
|
|
70508
|
+
}
|
|
70509
|
+
|
|
70510
|
+
/**
|
|
70511
|
+
* Get a list of my alternative shifts trades
|
|
70512
|
+
*
|
|
70513
|
+
* @param {Object} opts Optional parameters
|
|
70514
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
70515
|
+
*/
|
|
70516
|
+
getWorkforcemanagementAlternativeshiftsTrades(opts) {
|
|
70517
|
+
opts = opts || {};
|
|
70518
|
+
|
|
70519
|
+
|
|
70520
|
+
return this.apiClient.callApi(
|
|
70521
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades',
|
|
70522
|
+
'GET',
|
|
70523
|
+
{ },
|
|
70524
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
70525
|
+
{ },
|
|
70526
|
+
{ },
|
|
70527
|
+
null,
|
|
70528
|
+
['PureCloud OAuth'],
|
|
70529
|
+
['application/json'],
|
|
70530
|
+
['application/json']
|
|
70531
|
+
);
|
|
70532
|
+
}
|
|
70533
|
+
|
|
70534
|
+
/**
|
|
70535
|
+
* Query the status of an alternative shift trades operation. Only the user who started the operation can query the status
|
|
70536
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
70537
|
+
* @param {String} jobId The ID of the job
|
|
70538
|
+
*/
|
|
70539
|
+
getWorkforcemanagementAlternativeshiftsTradesJob(jobId) {
|
|
70540
|
+
// verify the required parameter 'jobId' is set
|
|
70541
|
+
if (jobId === undefined || jobId === null) {
|
|
70542
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesJob';
|
|
70543
|
+
}
|
|
70544
|
+
|
|
70545
|
+
return this.apiClient.callApi(
|
|
70546
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}',
|
|
70547
|
+
'GET',
|
|
70548
|
+
{ 'jobId': jobId },
|
|
70549
|
+
{ },
|
|
70550
|
+
{ },
|
|
70551
|
+
{ },
|
|
70552
|
+
null,
|
|
70553
|
+
['PureCloud OAuth'],
|
|
70554
|
+
['application/json'],
|
|
70555
|
+
['application/json']
|
|
70556
|
+
);
|
|
70557
|
+
}
|
|
70558
|
+
|
|
70559
|
+
/**
|
|
70560
|
+
* Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status
|
|
70561
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
70562
|
+
* @param {String} jobId The ID of the job
|
|
70563
|
+
*/
|
|
70564
|
+
getWorkforcemanagementAlternativeshiftsTradesStateJob(jobId) {
|
|
70565
|
+
// verify the required parameter 'jobId' is set
|
|
70566
|
+
if (jobId === undefined || jobId === null) {
|
|
70567
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesStateJob';
|
|
70568
|
+
}
|
|
70569
|
+
|
|
70570
|
+
return this.apiClient.callApi(
|
|
70571
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}',
|
|
70572
|
+
'GET',
|
|
70573
|
+
{ 'jobId': jobId },
|
|
70574
|
+
{ },
|
|
70575
|
+
{ },
|
|
70576
|
+
{ },
|
|
70577
|
+
null,
|
|
70578
|
+
['PureCloud OAuth'],
|
|
70579
|
+
['application/json'],
|
|
70580
|
+
['application/json']
|
|
70581
|
+
);
|
|
70582
|
+
}
|
|
70583
|
+
|
|
70173
70584
|
/**
|
|
70174
70585
|
* Get business unit
|
|
70175
70586
|
* Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
|
|
@@ -70263,7 +70674,6 @@ class WorkforceManagementApi {
|
|
|
70263
70674
|
*
|
|
70264
70675
|
* @param {String} businessUnitId The ID of the business unit
|
|
70265
70676
|
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
70266
|
-
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70267
70677
|
*/
|
|
70268
70678
|
getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
|
|
70269
70679
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -70295,7 +70705,6 @@ class WorkforceManagementApi {
|
|
|
70295
70705
|
* @param {String} businessUnitId The ID of the business unit
|
|
70296
70706
|
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
70297
70707
|
* @param {String} jobId The ID of the activity plan run job
|
|
70298
|
-
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70299
70708
|
*/
|
|
70300
70709
|
getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
|
|
70301
70710
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -70331,7 +70740,6 @@ class WorkforceManagementApi {
|
|
|
70331
70740
|
* @param {String} businessUnitId The ID of the business unit
|
|
70332
70741
|
* @param {Object} opts Optional parameters
|
|
70333
70742
|
* @param {Object} opts.state Optionally filter by activity plan state
|
|
70334
|
-
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70335
70743
|
*/
|
|
70336
70744
|
getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
|
|
70337
70745
|
opts = opts || {};
|
|
@@ -70359,7 +70767,6 @@ class WorkforceManagementApi {
|
|
|
70359
70767
|
* Gets the latest job for all activity plans in the business unit
|
|
70360
70768
|
*
|
|
70361
70769
|
* @param {String} businessUnitId The ID of the business unit
|
|
70362
|
-
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70363
70770
|
*/
|
|
70364
70771
|
getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
|
|
70365
70772
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -70381,6 +70788,91 @@ class WorkforceManagementApi {
|
|
|
70381
70788
|
);
|
|
70382
70789
|
}
|
|
70383
70790
|
|
|
70791
|
+
/**
|
|
70792
|
+
* Get alternative shifts settings for a business unit
|
|
70793
|
+
*
|
|
70794
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70795
|
+
*/
|
|
70796
|
+
getWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId) {
|
|
70797
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70798
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70799
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
70800
|
+
}
|
|
70801
|
+
|
|
70802
|
+
return this.apiClient.callApi(
|
|
70803
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
|
|
70804
|
+
'GET',
|
|
70805
|
+
{ 'businessUnitId': businessUnitId },
|
|
70806
|
+
{ },
|
|
70807
|
+
{ },
|
|
70808
|
+
{ },
|
|
70809
|
+
null,
|
|
70810
|
+
['PureCloud OAuth'],
|
|
70811
|
+
['application/json'],
|
|
70812
|
+
['application/json']
|
|
70813
|
+
);
|
|
70814
|
+
}
|
|
70815
|
+
|
|
70816
|
+
/**
|
|
70817
|
+
* Get an alternative shifts trade in a business unit for a given trade ID
|
|
70818
|
+
*
|
|
70819
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70820
|
+
* @param {String} tradeId The ID of the alternative shift trade
|
|
70821
|
+
*/
|
|
70822
|
+
getWorkforcemanagementBusinessunitAlternativeshiftsTrade(businessUnitId, tradeId) {
|
|
70823
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70824
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70825
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
|
|
70826
|
+
}
|
|
70827
|
+
// verify the required parameter 'tradeId' is set
|
|
70828
|
+
if (tradeId === undefined || tradeId === null) {
|
|
70829
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
|
|
70830
|
+
}
|
|
70831
|
+
|
|
70832
|
+
return this.apiClient.callApi(
|
|
70833
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}',
|
|
70834
|
+
'GET',
|
|
70835
|
+
{ 'businessUnitId': businessUnitId,'tradeId': tradeId },
|
|
70836
|
+
{ },
|
|
70837
|
+
{ },
|
|
70838
|
+
{ },
|
|
70839
|
+
null,
|
|
70840
|
+
['PureCloud OAuth'],
|
|
70841
|
+
['application/json'],
|
|
70842
|
+
['application/json']
|
|
70843
|
+
);
|
|
70844
|
+
}
|
|
70845
|
+
|
|
70846
|
+
/**
|
|
70847
|
+
* Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status
|
|
70848
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
70849
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70850
|
+
* @param {String} jobId The ID of the job
|
|
70851
|
+
*/
|
|
70852
|
+
getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(businessUnitId, jobId) {
|
|
70853
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70854
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70855
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
|
|
70856
|
+
}
|
|
70857
|
+
// verify the required parameter 'jobId' is set
|
|
70858
|
+
if (jobId === undefined || jobId === null) {
|
|
70859
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
|
|
70860
|
+
}
|
|
70861
|
+
|
|
70862
|
+
return this.apiClient.callApi(
|
|
70863
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}',
|
|
70864
|
+
'GET',
|
|
70865
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
70866
|
+
{ },
|
|
70867
|
+
{ },
|
|
70868
|
+
{ },
|
|
70869
|
+
null,
|
|
70870
|
+
['PureCloud OAuth'],
|
|
70871
|
+
['application/json'],
|
|
70872
|
+
['application/json']
|
|
70873
|
+
);
|
|
70874
|
+
}
|
|
70875
|
+
|
|
70384
70876
|
/**
|
|
70385
70877
|
* Get intraday planning groups for the given date
|
|
70386
70878
|
*
|
|
@@ -71352,6 +71844,161 @@ class WorkforceManagementApi {
|
|
|
71352
71844
|
);
|
|
71353
71845
|
}
|
|
71354
71846
|
|
|
71847
|
+
/**
|
|
71848
|
+
* Get a work plan bid
|
|
71849
|
+
*
|
|
71850
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71851
|
+
* @param {String} bidId The id of the workplanbid
|
|
71852
|
+
*/
|
|
71853
|
+
getWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
|
|
71854
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71855
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71856
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
|
|
71857
|
+
}
|
|
71858
|
+
// verify the required parameter 'bidId' is set
|
|
71859
|
+
if (bidId === undefined || bidId === null) {
|
|
71860
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
|
|
71861
|
+
}
|
|
71862
|
+
|
|
71863
|
+
return this.apiClient.callApi(
|
|
71864
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
|
|
71865
|
+
'GET',
|
|
71866
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
71867
|
+
{ },
|
|
71868
|
+
{ },
|
|
71869
|
+
{ },
|
|
71870
|
+
null,
|
|
71871
|
+
['PureCloud OAuth'],
|
|
71872
|
+
['application/json'],
|
|
71873
|
+
['application/json']
|
|
71874
|
+
);
|
|
71875
|
+
}
|
|
71876
|
+
|
|
71877
|
+
/**
|
|
71878
|
+
* Get a bid group by bid group Id
|
|
71879
|
+
*
|
|
71880
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71881
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
71882
|
+
* @param {String} bidGroupId Work Plan Bid Group id
|
|
71883
|
+
*/
|
|
71884
|
+
getWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
|
|
71885
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71886
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71887
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
71888
|
+
}
|
|
71889
|
+
// verify the required parameter 'bidId' is set
|
|
71890
|
+
if (bidId === undefined || bidId === null) {
|
|
71891
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
71892
|
+
}
|
|
71893
|
+
// verify the required parameter 'bidGroupId' is set
|
|
71894
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
71895
|
+
throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
71896
|
+
}
|
|
71897
|
+
|
|
71898
|
+
return this.apiClient.callApi(
|
|
71899
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
71900
|
+
'GET',
|
|
71901
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
71902
|
+
{ },
|
|
71903
|
+
{ },
|
|
71904
|
+
{ },
|
|
71905
|
+
null,
|
|
71906
|
+
['PureCloud OAuth'],
|
|
71907
|
+
['application/json'],
|
|
71908
|
+
['application/json']
|
|
71909
|
+
);
|
|
71910
|
+
}
|
|
71911
|
+
|
|
71912
|
+
/**
|
|
71913
|
+
* Gets the work plan preferences of all the agents in the work plan bid group
|
|
71914
|
+
*
|
|
71915
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71916
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
71917
|
+
* @param {String} bidGroupId The ID of the work plan bid group
|
|
71918
|
+
*/
|
|
71919
|
+
getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId) {
|
|
71920
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71921
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71922
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
71923
|
+
}
|
|
71924
|
+
// verify the required parameter 'bidId' is set
|
|
71925
|
+
if (bidId === undefined || bidId === null) {
|
|
71926
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
71927
|
+
}
|
|
71928
|
+
// verify the required parameter 'bidGroupId' is set
|
|
71929
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
71930
|
+
throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
71931
|
+
}
|
|
71932
|
+
|
|
71933
|
+
return this.apiClient.callApi(
|
|
71934
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
|
|
71935
|
+
'GET',
|
|
71936
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
71937
|
+
{ },
|
|
71938
|
+
{ },
|
|
71939
|
+
{ },
|
|
71940
|
+
null,
|
|
71941
|
+
['PureCloud OAuth'],
|
|
71942
|
+
['application/json'],
|
|
71943
|
+
['application/json']
|
|
71944
|
+
);
|
|
71945
|
+
}
|
|
71946
|
+
|
|
71947
|
+
/**
|
|
71948
|
+
* Get summary of bid groups that belong to a work plan bid
|
|
71949
|
+
*
|
|
71950
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71951
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
71952
|
+
*/
|
|
71953
|
+
getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(businessUnitId, bidId) {
|
|
71954
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71955
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71956
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
|
|
71957
|
+
}
|
|
71958
|
+
// verify the required parameter 'bidId' is set
|
|
71959
|
+
if (bidId === undefined || bidId === null) {
|
|
71960
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
|
|
71961
|
+
}
|
|
71962
|
+
|
|
71963
|
+
return this.apiClient.callApi(
|
|
71964
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary',
|
|
71965
|
+
'GET',
|
|
71966
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
71967
|
+
{ },
|
|
71968
|
+
{ },
|
|
71969
|
+
{ },
|
|
71970
|
+
null,
|
|
71971
|
+
['PureCloud OAuth'],
|
|
71972
|
+
['application/json'],
|
|
71973
|
+
['application/json']
|
|
71974
|
+
);
|
|
71975
|
+
}
|
|
71976
|
+
|
|
71977
|
+
/**
|
|
71978
|
+
* Get list of work plan bids
|
|
71979
|
+
*
|
|
71980
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
71981
|
+
*/
|
|
71982
|
+
getWorkforcemanagementBusinessunitWorkplanbids(businessUnitId) {
|
|
71983
|
+
// verify the required parameter 'businessUnitId' is set
|
|
71984
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
71985
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbids';
|
|
71986
|
+
}
|
|
71987
|
+
|
|
71988
|
+
return this.apiClient.callApi(
|
|
71989
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
|
|
71990
|
+
'GET',
|
|
71991
|
+
{ 'businessUnitId': businessUnitId },
|
|
71992
|
+
{ },
|
|
71993
|
+
{ },
|
|
71994
|
+
{ },
|
|
71995
|
+
null,
|
|
71996
|
+
['PureCloud OAuth'],
|
|
71997
|
+
['application/json'],
|
|
71998
|
+
['application/json']
|
|
71999
|
+
);
|
|
72000
|
+
}
|
|
72001
|
+
|
|
71355
72002
|
/**
|
|
71356
72003
|
* Get business units
|
|
71357
72004
|
*
|
|
@@ -72446,6 +73093,101 @@ class WorkforceManagementApi {
|
|
|
72446
73093
|
);
|
|
72447
73094
|
}
|
|
72448
73095
|
|
|
73096
|
+
/**
|
|
73097
|
+
* Get work plan bid ranks for a user
|
|
73098
|
+
*
|
|
73099
|
+
* @param {String} userId The userId to whom the work plan bid ranks apply.
|
|
73100
|
+
*/
|
|
73101
|
+
getWorkforcemanagementUserWorkplanbidranks(userId) {
|
|
73102
|
+
// verify the required parameter 'userId' is set
|
|
73103
|
+
if (userId === undefined || userId === null) {
|
|
73104
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementUserWorkplanbidranks';
|
|
73105
|
+
}
|
|
73106
|
+
|
|
73107
|
+
return this.apiClient.callApi(
|
|
73108
|
+
'/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
|
|
73109
|
+
'GET',
|
|
73110
|
+
{ 'userId': userId },
|
|
73111
|
+
{ },
|
|
73112
|
+
{ },
|
|
73113
|
+
{ },
|
|
73114
|
+
null,
|
|
73115
|
+
['PureCloud OAuth'],
|
|
73116
|
+
['application/json'],
|
|
73117
|
+
['application/json']
|
|
73118
|
+
);
|
|
73119
|
+
}
|
|
73120
|
+
|
|
73121
|
+
/**
|
|
73122
|
+
* Gets an agent's work plan bidding preference
|
|
73123
|
+
*
|
|
73124
|
+
* @param {String} bidId The ID of the work plan bid
|
|
73125
|
+
*/
|
|
73126
|
+
getWorkforcemanagementWorkplanbidPreferences(bidId) {
|
|
73127
|
+
// verify the required parameter 'bidId' is set
|
|
73128
|
+
if (bidId === undefined || bidId === null) {
|
|
73129
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidPreferences';
|
|
73130
|
+
}
|
|
73131
|
+
|
|
73132
|
+
return this.apiClient.callApi(
|
|
73133
|
+
'/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
|
|
73134
|
+
'GET',
|
|
73135
|
+
{ 'bidId': bidId },
|
|
73136
|
+
{ },
|
|
73137
|
+
{ },
|
|
73138
|
+
{ },
|
|
73139
|
+
null,
|
|
73140
|
+
['PureCloud OAuth'],
|
|
73141
|
+
['application/json'],
|
|
73142
|
+
['application/json']
|
|
73143
|
+
);
|
|
73144
|
+
}
|
|
73145
|
+
|
|
73146
|
+
/**
|
|
73147
|
+
* Gets an agent's work plans for a bid
|
|
73148
|
+
*
|
|
73149
|
+
* @param {String} bidId The ID of the work plan bid
|
|
73150
|
+
*/
|
|
73151
|
+
getWorkforcemanagementWorkplanbidWorkplans(bidId) {
|
|
73152
|
+
// verify the required parameter 'bidId' is set
|
|
73153
|
+
if (bidId === undefined || bidId === null) {
|
|
73154
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidWorkplans';
|
|
73155
|
+
}
|
|
73156
|
+
|
|
73157
|
+
return this.apiClient.callApi(
|
|
73158
|
+
'/api/v2/workforcemanagement/workplanbids/{bidId}/workplans',
|
|
73159
|
+
'GET',
|
|
73160
|
+
{ 'bidId': bidId },
|
|
73161
|
+
{ },
|
|
73162
|
+
{ },
|
|
73163
|
+
{ },
|
|
73164
|
+
null,
|
|
73165
|
+
['PureCloud OAuth'],
|
|
73166
|
+
['application/json'],
|
|
73167
|
+
['application/json']
|
|
73168
|
+
);
|
|
73169
|
+
}
|
|
73170
|
+
|
|
73171
|
+
/**
|
|
73172
|
+
* Gets the list of work plan bids that belong to an agent
|
|
73173
|
+
*
|
|
73174
|
+
*/
|
|
73175
|
+
getWorkforcemanagementWorkplanbids() {
|
|
73176
|
+
|
|
73177
|
+
return this.apiClient.callApi(
|
|
73178
|
+
'/api/v2/workforcemanagement/workplanbids',
|
|
73179
|
+
'GET',
|
|
73180
|
+
{ },
|
|
73181
|
+
{ },
|
|
73182
|
+
{ },
|
|
73183
|
+
{ },
|
|
73184
|
+
null,
|
|
73185
|
+
['PureCloud OAuth'],
|
|
73186
|
+
['application/json'],
|
|
73187
|
+
['application/json']
|
|
73188
|
+
);
|
|
73189
|
+
}
|
|
73190
|
+
|
|
72449
73191
|
/**
|
|
72450
73192
|
* Update an adherence explanation
|
|
72451
73193
|
*
|
|
@@ -72481,6 +73223,60 @@ class WorkforceManagementApi {
|
|
|
72481
73223
|
);
|
|
72482
73224
|
}
|
|
72483
73225
|
|
|
73226
|
+
/**
|
|
73227
|
+
* Update my alternative shifts trade by trade ID
|
|
73228
|
+
*
|
|
73229
|
+
* @param {String} tradeId The ID of the alternative shift trade
|
|
73230
|
+
* @param {Object} opts Optional parameters
|
|
73231
|
+
* @param {Object} opts.body body
|
|
73232
|
+
*/
|
|
73233
|
+
patchWorkforcemanagementAlternativeshiftsTrade(tradeId, opts) {
|
|
73234
|
+
opts = opts || {};
|
|
73235
|
+
|
|
73236
|
+
// verify the required parameter 'tradeId' is set
|
|
73237
|
+
if (tradeId === undefined || tradeId === null) {
|
|
73238
|
+
throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
|
|
73239
|
+
}
|
|
73240
|
+
|
|
73241
|
+
return this.apiClient.callApi(
|
|
73242
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
|
|
73243
|
+
'PATCH',
|
|
73244
|
+
{ 'tradeId': tradeId },
|
|
73245
|
+
{ },
|
|
73246
|
+
{ },
|
|
73247
|
+
{ },
|
|
73248
|
+
opts['body'],
|
|
73249
|
+
['PureCloud OAuth'],
|
|
73250
|
+
['application/json'],
|
|
73251
|
+
['application/json']
|
|
73252
|
+
);
|
|
73253
|
+
}
|
|
73254
|
+
|
|
73255
|
+
/**
|
|
73256
|
+
* Bulk update alternative shift trade states
|
|
73257
|
+
*
|
|
73258
|
+
* @param {Object} body The request body
|
|
73259
|
+
*/
|
|
73260
|
+
patchWorkforcemanagementAlternativeshiftsTradesStateJobs(body) {
|
|
73261
|
+
// verify the required parameter 'body' is set
|
|
73262
|
+
if (body === undefined || body === null) {
|
|
73263
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTradesStateJobs';
|
|
73264
|
+
}
|
|
73265
|
+
|
|
73266
|
+
return this.apiClient.callApi(
|
|
73267
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs',
|
|
73268
|
+
'PATCH',
|
|
73269
|
+
{ },
|
|
73270
|
+
{ },
|
|
73271
|
+
{ },
|
|
73272
|
+
{ },
|
|
73273
|
+
body,
|
|
73274
|
+
['PureCloud OAuth'],
|
|
73275
|
+
['application/json'],
|
|
73276
|
+
['application/json']
|
|
73277
|
+
);
|
|
73278
|
+
}
|
|
73279
|
+
|
|
72484
73280
|
/**
|
|
72485
73281
|
* Update business unit
|
|
72486
73282
|
*
|
|
@@ -72550,7 +73346,6 @@ class WorkforceManagementApi {
|
|
|
72550
73346
|
* @param {String} businessUnitId The ID of the business unit
|
|
72551
73347
|
* @param {String} activityPlanId The ID of the activity plan to update
|
|
72552
73348
|
* @param {Object} body body
|
|
72553
|
-
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
72554
73349
|
*/
|
|
72555
73350
|
patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
|
|
72556
73351
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -72580,6 +73375,35 @@ class WorkforceManagementApi {
|
|
|
72580
73375
|
);
|
|
72581
73376
|
}
|
|
72582
73377
|
|
|
73378
|
+
/**
|
|
73379
|
+
* Update alternative shifts settings for a business unit
|
|
73380
|
+
*
|
|
73381
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73382
|
+
* @param {Object} opts Optional parameters
|
|
73383
|
+
* @param {Object} opts.body body
|
|
73384
|
+
*/
|
|
73385
|
+
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, opts) {
|
|
73386
|
+
opts = opts || {};
|
|
73387
|
+
|
|
73388
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73389
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73390
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
73391
|
+
}
|
|
73392
|
+
|
|
73393
|
+
return this.apiClient.callApi(
|
|
73394
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
|
|
73395
|
+
'PATCH',
|
|
73396
|
+
{ 'businessUnitId': businessUnitId },
|
|
73397
|
+
{ },
|
|
73398
|
+
{ },
|
|
73399
|
+
{ },
|
|
73400
|
+
opts['body'],
|
|
73401
|
+
['PureCloud OAuth'],
|
|
73402
|
+
['application/json'],
|
|
73403
|
+
['application/json']
|
|
73404
|
+
);
|
|
73405
|
+
}
|
|
73406
|
+
|
|
72583
73407
|
/**
|
|
72584
73408
|
* Updates the planning group
|
|
72585
73409
|
*
|
|
@@ -72750,6 +73574,119 @@ class WorkforceManagementApi {
|
|
|
72750
73574
|
);
|
|
72751
73575
|
}
|
|
72752
73576
|
|
|
73577
|
+
/**
|
|
73578
|
+
* Update work plan bid
|
|
73579
|
+
*
|
|
73580
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73581
|
+
* @param {String} bidId The id of the workplanbid
|
|
73582
|
+
* @param {Object} body The work plan bid to be updated
|
|
73583
|
+
*/
|
|
73584
|
+
patchWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId, body) {
|
|
73585
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73586
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73587
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
|
|
73588
|
+
}
|
|
73589
|
+
// verify the required parameter 'bidId' is set
|
|
73590
|
+
if (bidId === undefined || bidId === null) {
|
|
73591
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
|
|
73592
|
+
}
|
|
73593
|
+
// verify the required parameter 'body' is set
|
|
73594
|
+
if (body === undefined || body === null) {
|
|
73595
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
|
|
73596
|
+
}
|
|
73597
|
+
|
|
73598
|
+
return this.apiClient.callApi(
|
|
73599
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
|
|
73600
|
+
'PATCH',
|
|
73601
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
73602
|
+
{ },
|
|
73603
|
+
{ },
|
|
73604
|
+
{ },
|
|
73605
|
+
body,
|
|
73606
|
+
['PureCloud OAuth'],
|
|
73607
|
+
['application/json'],
|
|
73608
|
+
['application/json']
|
|
73609
|
+
);
|
|
73610
|
+
}
|
|
73611
|
+
|
|
73612
|
+
/**
|
|
73613
|
+
* Update a bid group by bid group Id
|
|
73614
|
+
*
|
|
73615
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73616
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
73617
|
+
* @param {String} bidGroupId Work Plan Bid Group id
|
|
73618
|
+
* @param {Object} opts Optional parameters
|
|
73619
|
+
* @param {Object} opts.body body
|
|
73620
|
+
*/
|
|
73621
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, opts) {
|
|
73622
|
+
opts = opts || {};
|
|
73623
|
+
|
|
73624
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73625
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73626
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
73627
|
+
}
|
|
73628
|
+
// verify the required parameter 'bidId' is set
|
|
73629
|
+
if (bidId === undefined || bidId === null) {
|
|
73630
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
73631
|
+
}
|
|
73632
|
+
// verify the required parameter 'bidGroupId' is set
|
|
73633
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
73634
|
+
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
73635
|
+
}
|
|
73636
|
+
|
|
73637
|
+
return this.apiClient.callApi(
|
|
73638
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
73639
|
+
'PATCH',
|
|
73640
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
73641
|
+
{ },
|
|
73642
|
+
{ },
|
|
73643
|
+
{ },
|
|
73644
|
+
opts['body'],
|
|
73645
|
+
['PureCloud OAuth'],
|
|
73646
|
+
['application/json'],
|
|
73647
|
+
['application/json']
|
|
73648
|
+
);
|
|
73649
|
+
}
|
|
73650
|
+
|
|
73651
|
+
/**
|
|
73652
|
+
* Overrides the assigned work plan for the specified agents
|
|
73653
|
+
*
|
|
73654
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73655
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
73656
|
+
* @param {String} bidGroupId The ID of the work plan bid group
|
|
73657
|
+
* @param {Object} opts Optional parameters
|
|
73658
|
+
* @param {Object} opts.body body
|
|
73659
|
+
*/
|
|
73660
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, opts) {
|
|
73661
|
+
opts = opts || {};
|
|
73662
|
+
|
|
73663
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73664
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73665
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
73666
|
+
}
|
|
73667
|
+
// verify the required parameter 'bidId' is set
|
|
73668
|
+
if (bidId === undefined || bidId === null) {
|
|
73669
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
73670
|
+
}
|
|
73671
|
+
// verify the required parameter 'bidGroupId' is set
|
|
73672
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
73673
|
+
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
73674
|
+
}
|
|
73675
|
+
|
|
73676
|
+
return this.apiClient.callApi(
|
|
73677
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
|
|
73678
|
+
'PATCH',
|
|
73679
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
73680
|
+
{ },
|
|
73681
|
+
{ },
|
|
73682
|
+
{ },
|
|
73683
|
+
opts['body'],
|
|
73684
|
+
['PureCloud OAuth'],
|
|
73685
|
+
['application/json'],
|
|
73686
|
+
['application/json']
|
|
73687
|
+
);
|
|
73688
|
+
}
|
|
73689
|
+
|
|
72753
73690
|
/**
|
|
72754
73691
|
* Update the requested management unit
|
|
72755
73692
|
*
|
|
@@ -73092,6 +74029,89 @@ class WorkforceManagementApi {
|
|
|
73092
74029
|
);
|
|
73093
74030
|
}
|
|
73094
74031
|
|
|
74032
|
+
/**
|
|
74033
|
+
* Update work plan bid ranks for a user
|
|
74034
|
+
*
|
|
74035
|
+
* @param {String} userId The userId to whom the work plan bid ranks apply.
|
|
74036
|
+
* @param {Object} opts Optional parameters
|
|
74037
|
+
* @param {Object} opts.body body
|
|
74038
|
+
*/
|
|
74039
|
+
patchWorkforcemanagementUserWorkplanbidranks(userId, opts) {
|
|
74040
|
+
opts = opts || {};
|
|
74041
|
+
|
|
74042
|
+
// verify the required parameter 'userId' is set
|
|
74043
|
+
if (userId === undefined || userId === null) {
|
|
74044
|
+
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
|
|
74045
|
+
}
|
|
74046
|
+
|
|
74047
|
+
return this.apiClient.callApi(
|
|
74048
|
+
'/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
|
|
74049
|
+
'PATCH',
|
|
74050
|
+
{ 'userId': userId },
|
|
74051
|
+
{ },
|
|
74052
|
+
{ },
|
|
74053
|
+
{ },
|
|
74054
|
+
opts['body'],
|
|
74055
|
+
['PureCloud OAuth'],
|
|
74056
|
+
['application/json'],
|
|
74057
|
+
['application/json']
|
|
74058
|
+
);
|
|
74059
|
+
}
|
|
74060
|
+
|
|
74061
|
+
/**
|
|
74062
|
+
* Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
|
|
74063
|
+
*
|
|
74064
|
+
* @param {Array.<Object>} body Users
|
|
74065
|
+
*/
|
|
74066
|
+
patchWorkforcemanagementUsersWorkplanbidranksBulk(body) {
|
|
74067
|
+
// verify the required parameter 'body' is set
|
|
74068
|
+
if (body === undefined || body === null) {
|
|
74069
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUsersWorkplanbidranksBulk';
|
|
74070
|
+
}
|
|
74071
|
+
|
|
74072
|
+
return this.apiClient.callApi(
|
|
74073
|
+
'/api/v2/workforcemanagement/users/workplanbidranks/bulk',
|
|
74074
|
+
'PATCH',
|
|
74075
|
+
{ },
|
|
74076
|
+
{ },
|
|
74077
|
+
{ },
|
|
74078
|
+
{ },
|
|
74079
|
+
body,
|
|
74080
|
+
['PureCloud OAuth'],
|
|
74081
|
+
['application/json'],
|
|
74082
|
+
['application/json']
|
|
74083
|
+
);
|
|
74084
|
+
}
|
|
74085
|
+
|
|
74086
|
+
/**
|
|
74087
|
+
* Update an agent's work plan bidding preference
|
|
74088
|
+
*
|
|
74089
|
+
* @param {String} bidId The ID of the work plan bid
|
|
74090
|
+
* @param {Object} opts Optional parameters
|
|
74091
|
+
* @param {Object} opts.body body
|
|
74092
|
+
*/
|
|
74093
|
+
patchWorkforcemanagementWorkplanbidPreferences(bidId, opts) {
|
|
74094
|
+
opts = opts || {};
|
|
74095
|
+
|
|
74096
|
+
// verify the required parameter 'bidId' is set
|
|
74097
|
+
if (bidId === undefined || bidId === null) {
|
|
74098
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
|
|
74099
|
+
}
|
|
74100
|
+
|
|
74101
|
+
return this.apiClient.callApi(
|
|
74102
|
+
'/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
|
|
74103
|
+
'PATCH',
|
|
74104
|
+
{ 'bidId': bidId },
|
|
74105
|
+
{ },
|
|
74106
|
+
{ },
|
|
74107
|
+
{ },
|
|
74108
|
+
opts['body'],
|
|
74109
|
+
['PureCloud OAuth'],
|
|
74110
|
+
['application/json'],
|
|
74111
|
+
['application/json']
|
|
74112
|
+
);
|
|
74113
|
+
}
|
|
74114
|
+
|
|
73095
74115
|
/**
|
|
73096
74116
|
* Submit an adherence explanation for the current user
|
|
73097
74117
|
*
|
|
@@ -73358,6 +74378,81 @@ class WorkforceManagementApi {
|
|
|
73358
74378
|
);
|
|
73359
74379
|
}
|
|
73360
74380
|
|
|
74381
|
+
/**
|
|
74382
|
+
* Request a list of alternative shift offers for a given schedule
|
|
74383
|
+
*
|
|
74384
|
+
* @param {Object} body The request body
|
|
74385
|
+
*/
|
|
74386
|
+
postWorkforcemanagementAlternativeshiftsOffersJobs(body) {
|
|
74387
|
+
// verify the required parameter 'body' is set
|
|
74388
|
+
if (body === undefined || body === null) {
|
|
74389
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersJobs';
|
|
74390
|
+
}
|
|
74391
|
+
|
|
74392
|
+
return this.apiClient.callApi(
|
|
74393
|
+
'/api/v2/workforcemanagement/alternativeshifts/offers/jobs',
|
|
74394
|
+
'POST',
|
|
74395
|
+
{ },
|
|
74396
|
+
{ },
|
|
74397
|
+
{ },
|
|
74398
|
+
{ },
|
|
74399
|
+
body,
|
|
74400
|
+
['PureCloud OAuth'],
|
|
74401
|
+
['application/json'],
|
|
74402
|
+
['application/json']
|
|
74403
|
+
);
|
|
74404
|
+
}
|
|
74405
|
+
|
|
74406
|
+
/**
|
|
74407
|
+
* Request a search of alternative shift offers for a given shift
|
|
74408
|
+
*
|
|
74409
|
+
* @param {Object} body The request body
|
|
74410
|
+
*/
|
|
74411
|
+
postWorkforcemanagementAlternativeshiftsOffersSearchJobs(body) {
|
|
74412
|
+
// verify the required parameter 'body' is set
|
|
74413
|
+
if (body === undefined || body === null) {
|
|
74414
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersSearchJobs';
|
|
74415
|
+
}
|
|
74416
|
+
|
|
74417
|
+
return this.apiClient.callApi(
|
|
74418
|
+
'/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs',
|
|
74419
|
+
'POST',
|
|
74420
|
+
{ },
|
|
74421
|
+
{ },
|
|
74422
|
+
{ },
|
|
74423
|
+
{ },
|
|
74424
|
+
body,
|
|
74425
|
+
['PureCloud OAuth'],
|
|
74426
|
+
['application/json'],
|
|
74427
|
+
['application/json']
|
|
74428
|
+
);
|
|
74429
|
+
}
|
|
74430
|
+
|
|
74431
|
+
/**
|
|
74432
|
+
* Create my alternative shift trade using an existing offer's jobId
|
|
74433
|
+
*
|
|
74434
|
+
* @param {Object} body The request body
|
|
74435
|
+
*/
|
|
74436
|
+
postWorkforcemanagementAlternativeshiftsTrades(body) {
|
|
74437
|
+
// verify the required parameter 'body' is set
|
|
74438
|
+
if (body === undefined || body === null) {
|
|
74439
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsTrades';
|
|
74440
|
+
}
|
|
74441
|
+
|
|
74442
|
+
return this.apiClient.callApi(
|
|
74443
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades',
|
|
74444
|
+
'POST',
|
|
74445
|
+
{ },
|
|
74446
|
+
{ },
|
|
74447
|
+
{ },
|
|
74448
|
+
{ },
|
|
74449
|
+
body,
|
|
74450
|
+
['PureCloud OAuth'],
|
|
74451
|
+
['application/json'],
|
|
74452
|
+
['application/json']
|
|
74453
|
+
);
|
|
74454
|
+
}
|
|
74455
|
+
|
|
73361
74456
|
/**
|
|
73362
74457
|
* Create a new activity code
|
|
73363
74458
|
*
|
|
@@ -73392,7 +74487,6 @@ class WorkforceManagementApi {
|
|
|
73392
74487
|
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
73393
74488
|
* @param {String} businessUnitId The ID of the business unit
|
|
73394
74489
|
* @param {String} activityPlanId The ID of the activity plan to run
|
|
73395
|
-
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73396
74490
|
*/
|
|
73397
74491
|
postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
|
|
73398
74492
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -73423,7 +74517,6 @@ class WorkforceManagementApi {
|
|
|
73423
74517
|
*
|
|
73424
74518
|
* @param {String} businessUnitId The ID of the business unit
|
|
73425
74519
|
* @param {Object} body body
|
|
73426
|
-
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73427
74520
|
*/
|
|
73428
74521
|
postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
|
|
73429
74522
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -73515,6 +74608,40 @@ class WorkforceManagementApi {
|
|
|
73515
74608
|
);
|
|
73516
74609
|
}
|
|
73517
74610
|
|
|
74611
|
+
/**
|
|
74612
|
+
* List alternative shifts trades for a given management unit or agent
|
|
74613
|
+
*
|
|
74614
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
74615
|
+
* @param {Object} body The request body
|
|
74616
|
+
* @param {Object} opts Optional parameters
|
|
74617
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
74618
|
+
*/
|
|
74619
|
+
postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(businessUnitId, body, opts) {
|
|
74620
|
+
opts = opts || {};
|
|
74621
|
+
|
|
74622
|
+
// verify the required parameter 'businessUnitId' is set
|
|
74623
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
74624
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
|
|
74625
|
+
}
|
|
74626
|
+
// verify the required parameter 'body' is set
|
|
74627
|
+
if (body === undefined || body === null) {
|
|
74628
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
|
|
74629
|
+
}
|
|
74630
|
+
|
|
74631
|
+
return this.apiClient.callApi(
|
|
74632
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search',
|
|
74633
|
+
'POST',
|
|
74634
|
+
{ 'businessUnitId': businessUnitId },
|
|
74635
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
74636
|
+
{ },
|
|
74637
|
+
{ },
|
|
74638
|
+
body,
|
|
74639
|
+
['PureCloud OAuth'],
|
|
74640
|
+
['application/json'],
|
|
74641
|
+
['application/json']
|
|
74642
|
+
);
|
|
74643
|
+
}
|
|
74644
|
+
|
|
73518
74645
|
/**
|
|
73519
74646
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
73520
74647
|
*
|
|
@@ -74324,6 +75451,103 @@ class WorkforceManagementApi {
|
|
|
74324
75451
|
);
|
|
74325
75452
|
}
|
|
74326
75453
|
|
|
75454
|
+
/**
|
|
75455
|
+
* Copy a work plan bid
|
|
75456
|
+
*
|
|
75457
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
75458
|
+
* @param {String} bidId The ID of the work plan bid to copy
|
|
75459
|
+
* @param {Object} opts Optional parameters
|
|
75460
|
+
* @param {Object} opts.body body
|
|
75461
|
+
*/
|
|
75462
|
+
postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, opts) {
|
|
75463
|
+
opts = opts || {};
|
|
75464
|
+
|
|
75465
|
+
// verify the required parameter 'businessUnitId' is set
|
|
75466
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
75467
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
75468
|
+
}
|
|
75469
|
+
// verify the required parameter 'bidId' is set
|
|
75470
|
+
if (bidId === undefined || bidId === null) {
|
|
75471
|
+
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
75472
|
+
}
|
|
75473
|
+
|
|
75474
|
+
return this.apiClient.callApi(
|
|
75475
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
|
|
75476
|
+
'POST',
|
|
75477
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
75478
|
+
{ },
|
|
75479
|
+
{ },
|
|
75480
|
+
{ },
|
|
75481
|
+
opts['body'],
|
|
75482
|
+
['PureCloud OAuth'],
|
|
75483
|
+
['application/json'],
|
|
75484
|
+
['application/json']
|
|
75485
|
+
);
|
|
75486
|
+
}
|
|
75487
|
+
|
|
75488
|
+
/**
|
|
75489
|
+
* Add a bid group in a given work plan bid
|
|
75490
|
+
*
|
|
75491
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
75492
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
75493
|
+
* @param {Object} opts Optional parameters
|
|
75494
|
+
* @param {Object} opts.body body
|
|
75495
|
+
*/
|
|
75496
|
+
postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, opts) {
|
|
75497
|
+
opts = opts || {};
|
|
75498
|
+
|
|
75499
|
+
// verify the required parameter 'businessUnitId' is set
|
|
75500
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
75501
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
75502
|
+
}
|
|
75503
|
+
// verify the required parameter 'bidId' is set
|
|
75504
|
+
if (bidId === undefined || bidId === null) {
|
|
75505
|
+
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
75506
|
+
}
|
|
75507
|
+
|
|
75508
|
+
return this.apiClient.callApi(
|
|
75509
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
|
|
75510
|
+
'POST',
|
|
75511
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
75512
|
+
{ },
|
|
75513
|
+
{ },
|
|
75514
|
+
{ },
|
|
75515
|
+
opts['body'],
|
|
75516
|
+
['PureCloud OAuth'],
|
|
75517
|
+
['application/json'],
|
|
75518
|
+
['application/json']
|
|
75519
|
+
);
|
|
75520
|
+
}
|
|
75521
|
+
|
|
75522
|
+
/**
|
|
75523
|
+
* Create a new work plan bid
|
|
75524
|
+
*
|
|
75525
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
75526
|
+
* @param {Object} opts Optional parameters
|
|
75527
|
+
* @param {Object} opts.body The work plan bid to be created
|
|
75528
|
+
*/
|
|
75529
|
+
postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, opts) {
|
|
75530
|
+
opts = opts || {};
|
|
75531
|
+
|
|
75532
|
+
// verify the required parameter 'businessUnitId' is set
|
|
75533
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
75534
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
|
|
75535
|
+
}
|
|
75536
|
+
|
|
75537
|
+
return this.apiClient.callApi(
|
|
75538
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
|
|
75539
|
+
'POST',
|
|
75540
|
+
{ 'businessUnitId': businessUnitId },
|
|
75541
|
+
{ },
|
|
75542
|
+
{ },
|
|
75543
|
+
{ },
|
|
75544
|
+
opts['body'],
|
|
75545
|
+
['PureCloud OAuth'],
|
|
75546
|
+
['application/json'],
|
|
75547
|
+
['application/json']
|
|
75548
|
+
);
|
|
75549
|
+
}
|
|
75550
|
+
|
|
74327
75551
|
/**
|
|
74328
75552
|
* Add a new business unit
|
|
74329
75553
|
* It may take a minute or two for a new business unit to be available for api operations
|
|
@@ -75593,7 +76817,7 @@ class WorkforceManagementApi {
|
|
|
75593
76817
|
* </pre>
|
|
75594
76818
|
* </p>
|
|
75595
76819
|
* @module purecloud-platform-client-v2/index
|
|
75596
|
-
* @version
|
|
76820
|
+
* @version 202.0.0
|
|
75597
76821
|
*/
|
|
75598
76822
|
class platformClient {
|
|
75599
76823
|
constructor() {
|