purecloudplatformclientv2 49.0.0 → 49.0.1
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.
- checksums.yaml +4 -4
- data/README.md +8 -8
- data/docs/AlertingApi.md +33 -33
- data/docs/AnalyticsApi.md +81 -81
- data/docs/ArchitectApi.md +243 -243
- data/docs/AuthorizationApi.md +102 -102
- data/docs/BillingApi.md +6 -6
- data/docs/ContentManagementApi.md +114 -114
- data/docs/ConversationsApi.md +300 -300
- data/docs/DialerRulesetConfigChangeCondition.md +1 -0
- data/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md +2 -0
- data/docs/ExternalContactsApi.md +90 -90
- data/docs/FaxApi.md +18 -18
- data/docs/FlowsApi.md +3 -3
- data/docs/GeneralDataProtectionRegulationApi.md +12 -12
- data/docs/GeolocationApi.md +12 -12
- data/docs/GreetingsApi.md +48 -48
- data/docs/GroupsApi.md +42 -42
- data/docs/IdentityProviderApi.md +84 -84
- data/docs/IntegrationsApi.md +123 -123
- data/docs/LanguagesApi.md +30 -30
- data/docs/LicenseApi.md +24 -24
- data/docs/LocationsApi.md +21 -21
- data/docs/MessagingApi.md +42 -42
- data/docs/MobileDevicesApi.md +15 -15
- data/docs/NotificationsApi.md +21 -21
- data/docs/OAuthApi.md +18 -18
- data/docs/ObjectsApi.md +24 -24
- data/docs/OrganizationApi.md +18 -18
- data/docs/OrganizationAuthorizationApi.md +69 -69
- data/docs/OutboundApi.md +288 -288
- data/docs/PresenceApi.md +27 -27
- data/docs/QualityApi.md +174 -174
- data/docs/QueueUserEventTopicQueueMember.md +4 -3
- data/docs/RecordingApi.md +111 -111
- data/docs/ResponseManagementApi.md +33 -33
- data/docs/RoutingApi.md +189 -189
- data/docs/ScriptsApi.md +33 -33
- data/docs/SearchApi.md +48 -48
- data/docs/StationsApi.md +15 -15
- data/docs/SuggestApi.md +12 -12
- data/docs/TelephonyProvidersEdgeApi.md +375 -375
- data/docs/TokensApi.md +6 -6
- data/docs/UserRecordingsApi.md +18 -18
- data/docs/UsersApi.md +183 -183
- data/docs/UtilitiesApi.md +12 -12
- data/docs/VoicemailApi.md +72 -72
- data/docs/WebChatApi.md +24 -24
- data/docs/WorkforceManagementApi.md +192 -192
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_condition.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_data_action_condition_predicate.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +50 -25
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +2 -2
data/docs/WebChatApi.md
CHANGED
@@ -20,7 +20,7 @@ Method | Description
|
|
20
20
|
|
21
21
|
<a name="delete_webchat_deployment"></a>
|
22
22
|
|
23
|
-
##
|
23
|
+
## delete_webchat_deployment(deployment_id)
|
24
24
|
|
25
25
|
|
26
26
|
|
@@ -36,7 +36,7 @@ Requires ANY permissions:
|
|
36
36
|
|
37
37
|
|
38
38
|
### Example
|
39
|
-
|
39
|
+
```{"language":"ruby"}
|
40
40
|
# load the gem
|
41
41
|
require 'purecloudplatformclientv2'
|
42
42
|
# setup authorization
|
@@ -61,7 +61,7 @@ begin
|
|
61
61
|
rescue PureCloud::ApiError => e
|
62
62
|
puts "Exception when calling WebChatApi->delete_webchat_deployment: #{e}"
|
63
63
|
end
|
64
|
-
|
64
|
+
```
|
65
65
|
|
66
66
|
### Parameters
|
67
67
|
|
@@ -84,7 +84,7 @@ nil (empty response body)
|
|
84
84
|
|
85
85
|
<a name="delete_webchat_settings"></a>
|
86
86
|
|
87
|
-
##
|
87
|
+
## delete_webchat_settings
|
88
88
|
|
89
89
|
|
90
90
|
|
@@ -100,7 +100,7 @@ Requires ANY permissions:
|
|
100
100
|
|
101
101
|
|
102
102
|
### Example
|
103
|
-
|
103
|
+
```{"language":"ruby"}
|
104
104
|
# load the gem
|
105
105
|
require 'purecloudplatformclientv2'
|
106
106
|
# setup authorization
|
@@ -122,7 +122,7 @@ begin
|
|
122
122
|
rescue PureCloud::ApiError => e
|
123
123
|
puts "Exception when calling WebChatApi->delete_webchat_settings: #{e}"
|
124
124
|
end
|
125
|
-
|
125
|
+
```
|
126
126
|
|
127
127
|
### Parameters
|
128
128
|
This endpoint does not need any parameter.
|
@@ -142,7 +142,7 @@ nil (empty response body)
|
|
142
142
|
|
143
143
|
<a name="get_webchat_deployment"></a>
|
144
144
|
|
145
|
-
##
|
145
|
+
## [**WebChatDeployment**](WebChatDeployment.html) get_webchat_deployment(deployment_id)
|
146
146
|
|
147
147
|
|
148
148
|
|
@@ -158,7 +158,7 @@ Requires ANY permissions:
|
|
158
158
|
|
159
159
|
|
160
160
|
### Example
|
161
|
-
|
161
|
+
```{"language":"ruby"}
|
162
162
|
# load the gem
|
163
163
|
require 'purecloudplatformclientv2'
|
164
164
|
# setup authorization
|
@@ -184,7 +184,7 @@ begin
|
|
184
184
|
rescue PureCloud::ApiError => e
|
185
185
|
puts "Exception when calling WebChatApi->get_webchat_deployment: #{e}"
|
186
186
|
end
|
187
|
-
|
187
|
+
```
|
188
188
|
|
189
189
|
### Parameters
|
190
190
|
|
@@ -207,7 +207,7 @@ Name | Type | Description | Notes
|
|
207
207
|
|
208
208
|
<a name="get_webchat_deployments"></a>
|
209
209
|
|
210
|
-
##
|
210
|
+
## [**WebChatDeploymentEntityListing**](WebChatDeploymentEntityListing.html) get_webchat_deployments
|
211
211
|
|
212
212
|
|
213
213
|
|
@@ -223,7 +223,7 @@ Requires ANY permissions:
|
|
223
223
|
|
224
224
|
|
225
225
|
### Example
|
226
|
-
|
226
|
+
```{"language":"ruby"}
|
227
227
|
# load the gem
|
228
228
|
require 'purecloudplatformclientv2'
|
229
229
|
# setup authorization
|
@@ -246,7 +246,7 @@ begin
|
|
246
246
|
rescue PureCloud::ApiError => e
|
247
247
|
puts "Exception when calling WebChatApi->get_webchat_deployments: #{e}"
|
248
248
|
end
|
249
|
-
|
249
|
+
```
|
250
250
|
|
251
251
|
### Parameters
|
252
252
|
This endpoint does not need any parameter.
|
@@ -266,7 +266,7 @@ This endpoint does not need any parameter.
|
|
266
266
|
|
267
267
|
<a name="get_webchat_settings"></a>
|
268
268
|
|
269
|
-
##
|
269
|
+
## [**WebChatSettings**](WebChatSettings.html) get_webchat_settings
|
270
270
|
|
271
271
|
|
272
272
|
|
@@ -282,7 +282,7 @@ Requires ANY permissions:
|
|
282
282
|
|
283
283
|
|
284
284
|
### Example
|
285
|
-
|
285
|
+
```{"language":"ruby"}
|
286
286
|
# load the gem
|
287
287
|
require 'purecloudplatformclientv2'
|
288
288
|
# setup authorization
|
@@ -305,7 +305,7 @@ begin
|
|
305
305
|
rescue PureCloud::ApiError => e
|
306
306
|
puts "Exception when calling WebChatApi->get_webchat_settings: #{e}"
|
307
307
|
end
|
308
|
-
|
308
|
+
```
|
309
309
|
|
310
310
|
### Parameters
|
311
311
|
This endpoint does not need any parameter.
|
@@ -325,7 +325,7 @@ This endpoint does not need any parameter.
|
|
325
325
|
|
326
326
|
<a name="post_webchat_deployments"></a>
|
327
327
|
|
328
|
-
##
|
328
|
+
## [**WebChatDeployment**](WebChatDeployment.html) post_webchat_deployments(body)
|
329
329
|
|
330
330
|
|
331
331
|
|
@@ -341,7 +341,7 @@ Requires ANY permissions:
|
|
341
341
|
|
342
342
|
|
343
343
|
### Example
|
344
|
-
|
344
|
+
```{"language":"ruby"}
|
345
345
|
# load the gem
|
346
346
|
require 'purecloudplatformclientv2'
|
347
347
|
# setup authorization
|
@@ -367,7 +367,7 @@ begin
|
|
367
367
|
rescue PureCloud::ApiError => e
|
368
368
|
puts "Exception when calling WebChatApi->post_webchat_deployments: #{e}"
|
369
369
|
end
|
370
|
-
|
370
|
+
```
|
371
371
|
|
372
372
|
### Parameters
|
373
373
|
|
@@ -390,7 +390,7 @@ Name | Type | Description | Notes
|
|
390
390
|
|
391
391
|
<a name="put_webchat_deployment"></a>
|
392
392
|
|
393
|
-
##
|
393
|
+
## [**WebChatDeployment**](WebChatDeployment.html) put_webchat_deployment(deployment_id, body)
|
394
394
|
|
395
395
|
|
396
396
|
|
@@ -406,7 +406,7 @@ Requires ANY permissions:
|
|
406
406
|
|
407
407
|
|
408
408
|
### Example
|
409
|
-
|
409
|
+
```{"language":"ruby"}
|
410
410
|
# load the gem
|
411
411
|
require 'purecloudplatformclientv2'
|
412
412
|
# setup authorization
|
@@ -434,7 +434,7 @@ begin
|
|
434
434
|
rescue PureCloud::ApiError => e
|
435
435
|
puts "Exception when calling WebChatApi->put_webchat_deployment: #{e}"
|
436
436
|
end
|
437
|
-
|
437
|
+
```
|
438
438
|
|
439
439
|
### Parameters
|
440
440
|
|
@@ -458,7 +458,7 @@ Name | Type | Description | Notes
|
|
458
458
|
|
459
459
|
<a name="put_webchat_settings"></a>
|
460
460
|
|
461
|
-
##
|
461
|
+
## [**WebChatSettings**](WebChatSettings.html) put_webchat_settings(body)
|
462
462
|
|
463
463
|
|
464
464
|
|
@@ -474,7 +474,7 @@ Requires ANY permissions:
|
|
474
474
|
|
475
475
|
|
476
476
|
### Example
|
477
|
-
|
477
|
+
```{"language":"ruby"}
|
478
478
|
# load the gem
|
479
479
|
require 'purecloudplatformclientv2'
|
480
480
|
# setup authorization
|
@@ -500,7 +500,7 @@ begin
|
|
500
500
|
rescue PureCloud::ApiError => e
|
501
501
|
puts "Exception when calling WebChatApi->put_webchat_settings: #{e}"
|
502
502
|
end
|
503
|
-
|
503
|
+
```
|
504
504
|
|
505
505
|
### Parameters
|
506
506
|
|
@@ -76,7 +76,7 @@ Method | Description
|
|
76
76
|
|
77
77
|
<a name="delete_workforcemanagement_managementunit"></a>
|
78
78
|
|
79
|
-
##
|
79
|
+
## delete_workforcemanagement_managementunit(mu_id)
|
80
80
|
|
81
81
|
|
82
82
|
|
@@ -93,7 +93,7 @@ Requires ANY permissions:
|
|
93
93
|
|
94
94
|
|
95
95
|
### Example
|
96
|
-
|
96
|
+
```{"language":"ruby"}
|
97
97
|
# load the gem
|
98
98
|
require 'purecloudplatformclientv2'
|
99
99
|
# setup authorization
|
@@ -118,7 +118,7 @@ begin
|
|
118
118
|
rescue PureCloud::ApiError => e
|
119
119
|
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit: #{e}"
|
120
120
|
end
|
121
|
-
|
121
|
+
```
|
122
122
|
|
123
123
|
### Parameters
|
124
124
|
|
@@ -141,7 +141,7 @@ nil (empty response body)
|
|
141
141
|
|
142
142
|
<a name="delete_workforcemanagement_managementunit_activitycode"></a>
|
143
143
|
|
144
|
-
##
|
144
|
+
## delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
|
145
145
|
|
146
146
|
|
147
147
|
|
@@ -158,7 +158,7 @@ Requires ANY permissions:
|
|
158
158
|
|
159
159
|
|
160
160
|
### Example
|
161
|
-
|
161
|
+
```{"language":"ruby"}
|
162
162
|
# load the gem
|
163
163
|
require 'purecloudplatformclientv2'
|
164
164
|
# setup authorization
|
@@ -185,7 +185,7 @@ begin
|
|
185
185
|
rescue PureCloud::ApiError => e
|
186
186
|
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_activitycode: #{e}"
|
187
187
|
end
|
188
|
-
|
188
|
+
```
|
189
189
|
|
190
190
|
### Parameters
|
191
191
|
|
@@ -209,7 +209,7 @@ nil (empty response body)
|
|
209
209
|
|
210
210
|
<a name="delete_workforcemanagement_managementunit_scheduling_run"></a>
|
211
211
|
|
212
|
-
##
|
212
|
+
## delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
|
213
213
|
|
214
214
|
|
215
215
|
|
@@ -225,7 +225,7 @@ Requires ANY permissions:
|
|
225
225
|
|
226
226
|
|
227
227
|
### Example
|
228
|
-
|
228
|
+
```{"language":"ruby"}
|
229
229
|
# load the gem
|
230
230
|
require 'purecloudplatformclientv2'
|
231
231
|
# setup authorization
|
@@ -252,7 +252,7 @@ begin
|
|
252
252
|
rescue PureCloud::ApiError => e
|
253
253
|
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_scheduling_run: #{e}"
|
254
254
|
end
|
255
|
-
|
255
|
+
```
|
256
256
|
|
257
257
|
### Parameters
|
258
258
|
|
@@ -276,7 +276,7 @@ nil (empty response body)
|
|
276
276
|
|
277
277
|
<a name="delete_workforcemanagement_managementunit_servicegoalgroup"></a>
|
278
278
|
|
279
|
-
##
|
279
|
+
## delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
|
280
280
|
|
281
281
|
|
282
282
|
|
@@ -293,7 +293,7 @@ Requires ANY permissions:
|
|
293
293
|
|
294
294
|
|
295
295
|
### Example
|
296
|
-
|
296
|
+
```{"language":"ruby"}
|
297
297
|
# load the gem
|
298
298
|
require 'purecloudplatformclientv2'
|
299
299
|
# setup authorization
|
@@ -320,7 +320,7 @@ begin
|
|
320
320
|
rescue PureCloud::ApiError => e
|
321
321
|
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_servicegoalgroup: #{e}"
|
322
322
|
end
|
323
|
-
|
323
|
+
```
|
324
324
|
|
325
325
|
### Parameters
|
326
326
|
|
@@ -344,7 +344,7 @@ nil (empty response body)
|
|
344
344
|
|
345
345
|
<a name="delete_workforcemanagement_managementunit_week_schedule"></a>
|
346
346
|
|
347
|
-
##
|
347
|
+
## delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id)
|
348
348
|
|
349
349
|
|
350
350
|
|
@@ -361,7 +361,7 @@ Requires ANY permissions:
|
|
361
361
|
|
362
362
|
|
363
363
|
### Example
|
364
|
-
|
364
|
+
```{"language":"ruby"}
|
365
365
|
# load the gem
|
366
366
|
require 'purecloudplatformclientv2'
|
367
367
|
# setup authorization
|
@@ -390,7 +390,7 @@ begin
|
|
390
390
|
rescue PureCloud::ApiError => e
|
391
391
|
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_week_schedule: #{e}"
|
392
392
|
end
|
393
|
-
|
393
|
+
```
|
394
394
|
|
395
395
|
### Parameters
|
396
396
|
|
@@ -415,7 +415,7 @@ nil (empty response body)
|
|
415
415
|
|
416
416
|
<a name="delete_workforcemanagement_managementunit_week_shorttermforecast"></a>
|
417
417
|
|
418
|
-
##
|
418
|
+
## delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id)
|
419
419
|
|
420
420
|
|
421
421
|
|
@@ -432,7 +432,7 @@ Requires ANY permissions:
|
|
432
432
|
|
433
433
|
|
434
434
|
### Example
|
435
|
-
|
435
|
+
```{"language":"ruby"}
|
436
436
|
# load the gem
|
437
437
|
require 'purecloudplatformclientv2'
|
438
438
|
# setup authorization
|
@@ -461,7 +461,7 @@ begin
|
|
461
461
|
rescue PureCloud::ApiError => e
|
462
462
|
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_week_shorttermforecast: #{e}"
|
463
463
|
end
|
464
|
-
|
464
|
+
```
|
465
465
|
|
466
466
|
### Parameters
|
467
467
|
|
@@ -486,7 +486,7 @@ nil (empty response body)
|
|
486
486
|
|
487
487
|
<a name="delete_workforcemanagement_managementunit_workplan"></a>
|
488
488
|
|
489
|
-
##
|
489
|
+
## delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
|
490
490
|
|
491
491
|
|
492
492
|
|
@@ -503,7 +503,7 @@ Requires ANY permissions:
|
|
503
503
|
|
504
504
|
|
505
505
|
### Example
|
506
|
-
|
506
|
+
```{"language":"ruby"}
|
507
507
|
# load the gem
|
508
508
|
require 'purecloudplatformclientv2'
|
509
509
|
# setup authorization
|
@@ -530,7 +530,7 @@ begin
|
|
530
530
|
rescue PureCloud::ApiError => e
|
531
531
|
puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_workplan: #{e}"
|
532
532
|
end
|
533
|
-
|
533
|
+
```
|
534
534
|
|
535
535
|
### Parameters
|
536
536
|
|
@@ -554,7 +554,7 @@ nil (empty response body)
|
|
554
554
|
|
555
555
|
<a name="get_workforcemanagement_adherence"></a>
|
556
556
|
|
557
|
-
##
|
557
|
+
## [**Array<UserScheduleAdherence>**](UserScheduleAdherence.html) get_workforcemanagement_adherence(user_id)
|
558
558
|
|
559
559
|
|
560
560
|
|
@@ -570,7 +570,7 @@ Requires ANY permissions:
|
|
570
570
|
|
571
571
|
|
572
572
|
### Example
|
573
|
-
|
573
|
+
```{"language":"ruby"}
|
574
574
|
# load the gem
|
575
575
|
require 'purecloudplatformclientv2'
|
576
576
|
# setup authorization
|
@@ -596,7 +596,7 @@ begin
|
|
596
596
|
rescue PureCloud::ApiError => e
|
597
597
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence: #{e}"
|
598
598
|
end
|
599
|
-
|
599
|
+
```
|
600
600
|
|
601
601
|
### Parameters
|
602
602
|
|
@@ -619,7 +619,7 @@ Name | Type | Description | Notes
|
|
619
619
|
|
620
620
|
<a name="get_workforcemanagement_managementunit"></a>
|
621
621
|
|
622
|
-
##
|
622
|
+
## [**ManagementUnit**](ManagementUnit.html) get_workforcemanagement_managementunit(mu_id, opts)
|
623
623
|
|
624
624
|
|
625
625
|
|
@@ -678,7 +678,7 @@ Requires ANY permissions:
|
|
678
678
|
|
679
679
|
|
680
680
|
### Example
|
681
|
-
|
681
|
+
```{"language":"ruby"}
|
682
682
|
# load the gem
|
683
683
|
require 'purecloudplatformclientv2'
|
684
684
|
# setup authorization
|
@@ -707,7 +707,7 @@ begin
|
|
707
707
|
rescue PureCloud::ApiError => e
|
708
708
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit: #{e}"
|
709
709
|
end
|
710
|
-
|
710
|
+
```
|
711
711
|
|
712
712
|
### Parameters
|
713
713
|
|
@@ -731,7 +731,7 @@ Name | Type | Description | Notes
|
|
731
731
|
|
732
732
|
<a name="get_workforcemanagement_managementunit_activitycode"></a>
|
733
733
|
|
734
|
-
##
|
734
|
+
## [**ActivityCode**](ActivityCode.html) get_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
|
735
735
|
|
736
736
|
|
737
737
|
|
@@ -748,7 +748,7 @@ Requires ANY permissions:
|
|
748
748
|
|
749
749
|
|
750
750
|
### Example
|
751
|
-
|
751
|
+
```{"language":"ruby"}
|
752
752
|
# load the gem
|
753
753
|
require 'purecloudplatformclientv2'
|
754
754
|
# setup authorization
|
@@ -776,7 +776,7 @@ begin
|
|
776
776
|
rescue PureCloud::ApiError => e
|
777
777
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_activitycode: #{e}"
|
778
778
|
end
|
779
|
-
|
779
|
+
```
|
780
780
|
|
781
781
|
### Parameters
|
782
782
|
|
@@ -800,7 +800,7 @@ Name | Type | Description | Notes
|
|
800
800
|
|
801
801
|
<a name="get_workforcemanagement_managementunit_activitycodes"></a>
|
802
802
|
|
803
|
-
##
|
803
|
+
## [**ActivityCodeContainer**](ActivityCodeContainer.html) get_workforcemanagement_managementunit_activitycodes(mu_id)
|
804
804
|
|
805
805
|
|
806
806
|
|
@@ -859,7 +859,7 @@ Requires ANY permissions:
|
|
859
859
|
|
860
860
|
|
861
861
|
### Example
|
862
|
-
|
862
|
+
```{"language":"ruby"}
|
863
863
|
# load the gem
|
864
864
|
require 'purecloudplatformclientv2'
|
865
865
|
# setup authorization
|
@@ -885,7 +885,7 @@ begin
|
|
885
885
|
rescue PureCloud::ApiError => e
|
886
886
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_activitycodes: #{e}"
|
887
887
|
end
|
888
|
-
|
888
|
+
```
|
889
889
|
|
890
890
|
### Parameters
|
891
891
|
|
@@ -908,7 +908,7 @@ Name | Type | Description | Notes
|
|
908
908
|
|
909
909
|
<a name="get_workforcemanagement_managementunit_agent"></a>
|
910
910
|
|
911
|
-
##
|
911
|
+
## [**WfmAgent**](WfmAgent.html) get_workforcemanagement_managementunit_agent(management_unit_id, agent_id)
|
912
912
|
|
913
913
|
|
914
914
|
|
@@ -925,7 +925,7 @@ Requires ANY permissions:
|
|
925
925
|
|
926
926
|
|
927
927
|
### Example
|
928
|
-
|
928
|
+
```{"language":"ruby"}
|
929
929
|
# load the gem
|
930
930
|
require 'purecloudplatformclientv2'
|
931
931
|
# setup authorization
|
@@ -953,7 +953,7 @@ begin
|
|
953
953
|
rescue PureCloud::ApiError => e
|
954
954
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent: #{e}"
|
955
955
|
end
|
956
|
-
|
956
|
+
```
|
957
957
|
|
958
958
|
### Parameters
|
959
959
|
|
@@ -977,7 +977,7 @@ Name | Type | Description | Notes
|
|
977
977
|
|
978
978
|
<a name="get_workforcemanagement_managementunit_intraday_queues"></a>
|
979
979
|
|
980
|
-
##
|
980
|
+
## [**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
|
981
981
|
|
982
982
|
|
983
983
|
|
@@ -993,7 +993,7 @@ Requires ANY permissions:
|
|
993
993
|
|
994
994
|
|
995
995
|
### Example
|
996
|
-
|
996
|
+
```{"language":"ruby"}
|
997
997
|
# load the gem
|
998
998
|
require 'purecloudplatformclientv2'
|
999
999
|
# setup authorization
|
@@ -1021,7 +1021,7 @@ begin
|
|
1021
1021
|
rescue PureCloud::ApiError => e
|
1022
1022
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_intraday_queues: #{e}"
|
1023
1023
|
end
|
1024
|
-
|
1024
|
+
```
|
1025
1025
|
|
1026
1026
|
### Parameters
|
1027
1027
|
|
@@ -1045,7 +1045,7 @@ Name | Type | Description | Notes
|
|
1045
1045
|
|
1046
1046
|
<a name="get_workforcemanagement_managementunit_scheduling_run"></a>
|
1047
1047
|
|
1048
|
-
##
|
1048
|
+
## [**SchedulingRunResponse**](SchedulingRunResponse.html) get_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
|
1049
1049
|
|
1050
1050
|
|
1051
1051
|
|
@@ -1061,7 +1061,7 @@ Requires ANY permissions:
|
|
1061
1061
|
|
1062
1062
|
|
1063
1063
|
### Example
|
1064
|
-
|
1064
|
+
```{"language":"ruby"}
|
1065
1065
|
# load the gem
|
1066
1066
|
require 'purecloudplatformclientv2'
|
1067
1067
|
# setup authorization
|
@@ -1089,7 +1089,7 @@ begin
|
|
1089
1089
|
rescue PureCloud::ApiError => e
|
1090
1090
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_run: #{e}"
|
1091
1091
|
end
|
1092
|
-
|
1092
|
+
```
|
1093
1093
|
|
1094
1094
|
### Parameters
|
1095
1095
|
|
@@ -1113,7 +1113,7 @@ Name | Type | Description | Notes
|
|
1113
1113
|
|
1114
1114
|
<a name="get_workforcemanagement_managementunit_scheduling_run_result"></a>
|
1115
1115
|
|
1116
|
-
##
|
1116
|
+
## [**RescheduleResult**](RescheduleResult.html) get_workforcemanagement_managementunit_scheduling_run_result(management_unit_id, run_id)
|
1117
1117
|
|
1118
1118
|
|
1119
1119
|
|
@@ -1129,7 +1129,7 @@ Requires ANY permissions:
|
|
1129
1129
|
|
1130
1130
|
|
1131
1131
|
### Example
|
1132
|
-
|
1132
|
+
```{"language":"ruby"}
|
1133
1133
|
# load the gem
|
1134
1134
|
require 'purecloudplatformclientv2'
|
1135
1135
|
# setup authorization
|
@@ -1157,7 +1157,7 @@ begin
|
|
1157
1157
|
rescue PureCloud::ApiError => e
|
1158
1158
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_run_result: #{e}"
|
1159
1159
|
end
|
1160
|
-
|
1160
|
+
```
|
1161
1161
|
|
1162
1162
|
### Parameters
|
1163
1163
|
|
@@ -1181,7 +1181,7 @@ Name | Type | Description | Notes
|
|
1181
1181
|
|
1182
1182
|
<a name="get_workforcemanagement_managementunit_scheduling_runs"></a>
|
1183
1183
|
|
1184
|
-
##
|
1184
|
+
## [**SchedulingRunListResponse**](SchedulingRunListResponse.html) get_workforcemanagement_managementunit_scheduling_runs(management_unit_id)
|
1185
1185
|
|
1186
1186
|
|
1187
1187
|
|
@@ -1197,7 +1197,7 @@ Requires ANY permissions:
|
|
1197
1197
|
|
1198
1198
|
|
1199
1199
|
### Example
|
1200
|
-
|
1200
|
+
```{"language":"ruby"}
|
1201
1201
|
# load the gem
|
1202
1202
|
require 'purecloudplatformclientv2'
|
1203
1203
|
# setup authorization
|
@@ -1223,7 +1223,7 @@ begin
|
|
1223
1223
|
rescue PureCloud::ApiError => e
|
1224
1224
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_runs: #{e}"
|
1225
1225
|
end
|
1226
|
-
|
1226
|
+
```
|
1227
1227
|
|
1228
1228
|
### Parameters
|
1229
1229
|
|
@@ -1246,7 +1246,7 @@ Name | Type | Description | Notes
|
|
1246
1246
|
|
1247
1247
|
<a name="get_workforcemanagement_managementunit_servicegoalgroup"></a>
|
1248
1248
|
|
1249
|
-
##
|
1249
|
+
## [**ServiceGoalGroup**](ServiceGoalGroup.html) get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
|
1250
1250
|
|
1251
1251
|
|
1252
1252
|
|
@@ -1263,7 +1263,7 @@ Requires ANY permissions:
|
|
1263
1263
|
|
1264
1264
|
|
1265
1265
|
### Example
|
1266
|
-
|
1266
|
+
```{"language":"ruby"}
|
1267
1267
|
# load the gem
|
1268
1268
|
require 'purecloudplatformclientv2'
|
1269
1269
|
# setup authorization
|
@@ -1291,7 +1291,7 @@ begin
|
|
1291
1291
|
rescue PureCloud::ApiError => e
|
1292
1292
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_servicegoalgroup: #{e}"
|
1293
1293
|
end
|
1294
|
-
|
1294
|
+
```
|
1295
1295
|
|
1296
1296
|
### Parameters
|
1297
1297
|
|
@@ -1315,7 +1315,7 @@ Name | Type | Description | Notes
|
|
1315
1315
|
|
1316
1316
|
<a name="get_workforcemanagement_managementunit_servicegoalgroups"></a>
|
1317
1317
|
|
1318
|
-
##
|
1318
|
+
## [**ServiceGoalGroupList**](ServiceGoalGroupList.html) get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id)
|
1319
1319
|
|
1320
1320
|
|
1321
1321
|
|
@@ -1334,7 +1334,7 @@ Requires ANY permissions:
|
|
1334
1334
|
|
1335
1335
|
|
1336
1336
|
### Example
|
1337
|
-
|
1337
|
+
```{"language":"ruby"}
|
1338
1338
|
# load the gem
|
1339
1339
|
require 'purecloudplatformclientv2'
|
1340
1340
|
# setup authorization
|
@@ -1360,7 +1360,7 @@ begin
|
|
1360
1360
|
rescue PureCloud::ApiError => e
|
1361
1361
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_servicegoalgroups: #{e}"
|
1362
1362
|
end
|
1363
|
-
|
1363
|
+
```
|
1364
1364
|
|
1365
1365
|
### Parameters
|
1366
1366
|
|
@@ -1383,7 +1383,7 @@ Name | Type | Description | Notes
|
|
1383
1383
|
|
1384
1384
|
<a name="get_workforcemanagement_managementunit_settings"></a>
|
1385
1385
|
|
1386
|
-
##
|
1386
|
+
## [**ManagementUnitSettings**](ManagementUnitSettings.html) get_workforcemanagement_managementunit_settings(mu_id)
|
1387
1387
|
|
1388
1388
|
|
1389
1389
|
|
@@ -1400,7 +1400,7 @@ Requires ANY permissions:
|
|
1400
1400
|
|
1401
1401
|
|
1402
1402
|
### Example
|
1403
|
-
|
1403
|
+
```{"language":"ruby"}
|
1404
1404
|
# load the gem
|
1405
1405
|
require 'purecloudplatformclientv2'
|
1406
1406
|
# setup authorization
|
@@ -1426,7 +1426,7 @@ begin
|
|
1426
1426
|
rescue PureCloud::ApiError => e
|
1427
1427
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_settings: #{e}"
|
1428
1428
|
end
|
1429
|
-
|
1429
|
+
```
|
1430
1430
|
|
1431
1431
|
### Parameters
|
1432
1432
|
|
@@ -1449,7 +1449,7 @@ Name | Type | Description | Notes
|
|
1449
1449
|
|
1450
1450
|
<a name="get_workforcemanagement_managementunit_user_timeoffrequest"></a>
|
1451
1451
|
|
1452
|
-
##
|
1452
|
+
## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
|
1453
1453
|
|
1454
1454
|
|
1455
1455
|
|
@@ -1466,7 +1466,7 @@ Requires ANY permissions:
|
|
1466
1466
|
|
1467
1467
|
|
1468
1468
|
### Example
|
1469
|
-
|
1469
|
+
```{"language":"ruby"}
|
1470
1470
|
# load the gem
|
1471
1471
|
require 'purecloudplatformclientv2'
|
1472
1472
|
# setup authorization
|
@@ -1496,7 +1496,7 @@ begin
|
|
1496
1496
|
rescue PureCloud::ApiError => e
|
1497
1497
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
|
1498
1498
|
end
|
1499
|
-
|
1499
|
+
```
|
1500
1500
|
|
1501
1501
|
### Parameters
|
1502
1502
|
|
@@ -1521,7 +1521,7 @@ Name | Type | Description | Notes
|
|
1521
1521
|
|
1522
1522
|
<a name="get_workforcemanagement_managementunit_user_timeoffrequests"></a>
|
1523
1523
|
|
1524
|
-
##
|
1524
|
+
## [**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
|
1525
1525
|
|
1526
1526
|
|
1527
1527
|
|
@@ -1538,7 +1538,7 @@ Requires ANY permissions:
|
|
1538
1538
|
|
1539
1539
|
|
1540
1540
|
### Example
|
1541
|
-
|
1541
|
+
```{"language":"ruby"}
|
1542
1542
|
# load the gem
|
1543
1543
|
require 'purecloudplatformclientv2'
|
1544
1544
|
# setup authorization
|
@@ -1569,7 +1569,7 @@ begin
|
|
1569
1569
|
rescue PureCloud::ApiError => e
|
1570
1570
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequests: #{e}"
|
1571
1571
|
end
|
1572
|
-
|
1572
|
+
```
|
1573
1573
|
|
1574
1574
|
### Parameters
|
1575
1575
|
|
@@ -1594,7 +1594,7 @@ Name | Type | Description | Notes
|
|
1594
1594
|
|
1595
1595
|
<a name="get_workforcemanagement_managementunit_users"></a>
|
1596
1596
|
|
1597
|
-
##
|
1597
|
+
## [**WfmUserEntityListing**](WfmUserEntityListing.html) get_workforcemanagement_managementunit_users(mu_id)
|
1598
1598
|
|
1599
1599
|
|
1600
1600
|
|
@@ -1620,7 +1620,7 @@ Requires ANY permissions:
|
|
1620
1620
|
|
1621
1621
|
|
1622
1622
|
### Example
|
1623
|
-
|
1623
|
+
```{"language":"ruby"}
|
1624
1624
|
# load the gem
|
1625
1625
|
require 'purecloudplatformclientv2'
|
1626
1626
|
# setup authorization
|
@@ -1646,7 +1646,7 @@ begin
|
|
1646
1646
|
rescue PureCloud::ApiError => e
|
1647
1647
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_users: #{e}"
|
1648
1648
|
end
|
1649
|
-
|
1649
|
+
```
|
1650
1650
|
|
1651
1651
|
### Parameters
|
1652
1652
|
|
@@ -1669,7 +1669,7 @@ Name | Type | Description | Notes
|
|
1669
1669
|
|
1670
1670
|
<a name="get_workforcemanagement_managementunit_week_schedule"></a>
|
1671
1671
|
|
1672
|
-
##
|
1672
|
+
## [**WeekScheduleResponse**](WeekScheduleResponse.html) get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
|
1673
1673
|
|
1674
1674
|
|
1675
1675
|
|
@@ -1687,7 +1687,7 @@ Requires ANY permissions:
|
|
1687
1687
|
|
1688
1688
|
|
1689
1689
|
### Example
|
1690
|
-
|
1690
|
+
```{"language":"ruby"}
|
1691
1691
|
# load the gem
|
1692
1692
|
require 'purecloudplatformclientv2'
|
1693
1693
|
# setup authorization
|
@@ -1721,7 +1721,7 @@ begin
|
|
1721
1721
|
rescue PureCloud::ApiError => e
|
1722
1722
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedule: #{e}"
|
1723
1723
|
end
|
1724
|
-
|
1724
|
+
```
|
1725
1725
|
|
1726
1726
|
### Parameters
|
1727
1727
|
|
@@ -1748,7 +1748,7 @@ Name | Type | Description | Notes
|
|
1748
1748
|
|
1749
1749
|
<a name="get_workforcemanagement_managementunit_week_schedule_generationresults"></a>
|
1750
1750
|
|
1751
|
-
##
|
1751
|
+
## [**WeekScheduleGenerationResult**](WeekScheduleGenerationResult.html) get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id)
|
1752
1752
|
|
1753
1753
|
|
1754
1754
|
|
@@ -1766,7 +1766,7 @@ Requires ANY permissions:
|
|
1766
1766
|
|
1767
1767
|
|
1768
1768
|
### Example
|
1769
|
-
|
1769
|
+
```{"language":"ruby"}
|
1770
1770
|
# load the gem
|
1771
1771
|
require 'purecloudplatformclientv2'
|
1772
1772
|
# setup authorization
|
@@ -1796,7 +1796,7 @@ begin
|
|
1796
1796
|
rescue PureCloud::ApiError => e
|
1797
1797
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedule_generationresults: #{e}"
|
1798
1798
|
end
|
1799
|
-
|
1799
|
+
```
|
1800
1800
|
|
1801
1801
|
### Parameters
|
1802
1802
|
|
@@ -1821,7 +1821,7 @@ Name | Type | Description | Notes
|
|
1821
1821
|
|
1822
1822
|
<a name="get_workforcemanagement_managementunit_week_schedules"></a>
|
1823
1823
|
|
1824
|
-
##
|
1824
|
+
## [**WeekScheduleListResponse**](WeekScheduleListResponse.html) get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id)
|
1825
1825
|
|
1826
1826
|
|
1827
1827
|
|
@@ -1839,7 +1839,7 @@ Requires ANY permissions:
|
|
1839
1839
|
|
1840
1840
|
|
1841
1841
|
### Example
|
1842
|
-
|
1842
|
+
```{"language":"ruby"}
|
1843
1843
|
# load the gem
|
1844
1844
|
require 'purecloudplatformclientv2'
|
1845
1845
|
# setup authorization
|
@@ -1867,7 +1867,7 @@ begin
|
|
1867
1867
|
rescue PureCloud::ApiError => e
|
1868
1868
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedules: #{e}"
|
1869
1869
|
end
|
1870
|
-
|
1870
|
+
```
|
1871
1871
|
|
1872
1872
|
### Parameters
|
1873
1873
|
|
@@ -1891,7 +1891,7 @@ Name | Type | Description | Notes
|
|
1891
1891
|
|
1892
1892
|
<a name="get_workforcemanagement_managementunit_week_shorttermforecast_final"></a>
|
1893
1893
|
|
1894
|
-
##
|
1894
|
+
## [**ForecastResultResponse**](ForecastResultResponse.html) get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
|
1895
1895
|
|
1896
1896
|
|
1897
1897
|
|
@@ -1908,7 +1908,7 @@ Requires ANY permissions:
|
|
1908
1908
|
|
1909
1909
|
|
1910
1910
|
### Example
|
1911
|
-
|
1911
|
+
```{"language":"ruby"}
|
1912
1912
|
# load the gem
|
1913
1913
|
require 'purecloudplatformclientv2'
|
1914
1914
|
# setup authorization
|
@@ -1941,7 +1941,7 @@ begin
|
|
1941
1941
|
rescue PureCloud::ApiError => e
|
1942
1942
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shorttermforecast_final: #{e}"
|
1943
1943
|
end
|
1944
|
-
|
1944
|
+
```
|
1945
1945
|
|
1946
1946
|
### Parameters
|
1947
1947
|
|
@@ -1967,7 +1967,7 @@ Name | Type | Description | Notes
|
|
1967
1967
|
|
1968
1968
|
<a name="get_workforcemanagement_managementunit_week_shorttermforecasts"></a>
|
1969
1969
|
|
1970
|
-
##
|
1970
|
+
## [**ShortTermForecastListResponse**](ShortTermForecastListResponse.html) get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id)
|
1971
1971
|
|
1972
1972
|
|
1973
1973
|
|
@@ -1985,7 +1985,7 @@ Requires ANY permissions:
|
|
1985
1985
|
|
1986
1986
|
|
1987
1987
|
### Example
|
1988
|
-
|
1988
|
+
```{"language":"ruby"}
|
1989
1989
|
# load the gem
|
1990
1990
|
require 'purecloudplatformclientv2'
|
1991
1991
|
# setup authorization
|
@@ -2013,7 +2013,7 @@ begin
|
|
2013
2013
|
rescue PureCloud::ApiError => e
|
2014
2014
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shorttermforecasts: #{e}"
|
2015
2015
|
end
|
2016
|
-
|
2016
|
+
```
|
2017
2017
|
|
2018
2018
|
### Parameters
|
2019
2019
|
|
@@ -2037,7 +2037,7 @@ Name | Type | Description | Notes
|
|
2037
2037
|
|
2038
2038
|
<a name="get_workforcemanagement_managementunit_workplan"></a>
|
2039
2039
|
|
2040
|
-
##
|
2040
|
+
## [**WorkPlan**](WorkPlan.html) get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
|
2041
2041
|
|
2042
2042
|
|
2043
2043
|
|
@@ -2056,7 +2056,7 @@ Requires ANY permissions:
|
|
2056
2056
|
|
2057
2057
|
|
2058
2058
|
### Example
|
2059
|
-
|
2059
|
+
```{"language":"ruby"}
|
2060
2060
|
# load the gem
|
2061
2061
|
require 'purecloudplatformclientv2'
|
2062
2062
|
# setup authorization
|
@@ -2084,7 +2084,7 @@ begin
|
|
2084
2084
|
rescue PureCloud::ApiError => e
|
2085
2085
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplan: #{e}"
|
2086
2086
|
end
|
2087
|
-
|
2087
|
+
```
|
2088
2088
|
|
2089
2089
|
### Parameters
|
2090
2090
|
|
@@ -2108,7 +2108,7 @@ Name | Type | Description | Notes
|
|
2108
2108
|
|
2109
2109
|
<a name="get_workforcemanagement_managementunit_workplans"></a>
|
2110
2110
|
|
2111
|
-
##
|
2111
|
+
## [**WorkPlanListResponse**](WorkPlanListResponse.html) get_workforcemanagement_managementunit_workplans(management_unit_id, opts)
|
2112
2112
|
|
2113
2113
|
|
2114
2114
|
|
@@ -2130,7 +2130,7 @@ Requires ANY permissions:
|
|
2130
2130
|
|
2131
2131
|
|
2132
2132
|
### Example
|
2133
|
-
|
2133
|
+
```{"language":"ruby"}
|
2134
2134
|
# load the gem
|
2135
2135
|
require 'purecloudplatformclientv2'
|
2136
2136
|
# setup authorization
|
@@ -2159,7 +2159,7 @@ begin
|
|
2159
2159
|
rescue PureCloud::ApiError => e
|
2160
2160
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplans: #{e}"
|
2161
2161
|
end
|
2162
|
-
|
2162
|
+
```
|
2163
2163
|
|
2164
2164
|
### Parameters
|
2165
2165
|
|
@@ -2183,7 +2183,7 @@ Name | Type | Description | Notes
|
|
2183
2183
|
|
2184
2184
|
<a name="get_workforcemanagement_managementunits"></a>
|
2185
2185
|
|
2186
|
-
##
|
2186
|
+
## [**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits(opts)
|
2187
2187
|
|
2188
2188
|
|
2189
2189
|
|
@@ -2198,7 +2198,7 @@ Requires NO permissions:
|
|
2198
2198
|
|
2199
2199
|
|
2200
2200
|
### Example
|
2201
|
-
|
2201
|
+
```{"language":"ruby"}
|
2202
2202
|
# load the gem
|
2203
2203
|
require 'purecloudplatformclientv2'
|
2204
2204
|
# setup authorization
|
@@ -2229,7 +2229,7 @@ begin
|
|
2229
2229
|
rescue PureCloud::ApiError => e
|
2230
2230
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits: #{e}"
|
2231
2231
|
end
|
2232
|
-
|
2232
|
+
```
|
2233
2233
|
|
2234
2234
|
### Parameters
|
2235
2235
|
|
@@ -2256,7 +2256,7 @@ Name | Type | Description | Notes
|
|
2256
2256
|
|
2257
2257
|
<a name="get_workforcemanagement_managementunits_divisionviews"></a>
|
2258
2258
|
|
2259
|
-
##
|
2259
|
+
## [**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits_divisionviews(opts)
|
2260
2260
|
|
2261
2261
|
|
2262
2262
|
|
@@ -2272,7 +2272,7 @@ Requires ANY permissions:
|
|
2272
2272
|
|
2273
2273
|
|
2274
2274
|
### Example
|
2275
|
-
|
2275
|
+
```{"language":"ruby"}
|
2276
2276
|
# load the gem
|
2277
2277
|
require 'purecloudplatformclientv2'
|
2278
2278
|
# setup authorization
|
@@ -2299,7 +2299,7 @@ begin
|
|
2299
2299
|
rescue PureCloud::ApiError => e
|
2300
2300
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits_divisionviews: #{e}"
|
2301
2301
|
end
|
2302
|
-
|
2302
|
+
```
|
2303
2303
|
|
2304
2304
|
### Parameters
|
2305
2305
|
|
@@ -2322,7 +2322,7 @@ Name | Type | Description | Notes
|
|
2322
2322
|
|
2323
2323
|
<a name="get_workforcemanagement_timeoffrequest"></a>
|
2324
2324
|
|
2325
|
-
##
|
2325
|
+
## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_timeoffrequest(time_off_request_id)
|
2326
2326
|
|
2327
2327
|
|
2328
2328
|
|
@@ -2339,7 +2339,7 @@ Requires ANY permissions:
|
|
2339
2339
|
|
2340
2340
|
|
2341
2341
|
### Example
|
2342
|
-
|
2342
|
+
```{"language":"ruby"}
|
2343
2343
|
# load the gem
|
2344
2344
|
require 'purecloudplatformclientv2'
|
2345
2345
|
# setup authorization
|
@@ -2365,7 +2365,7 @@ begin
|
|
2365
2365
|
rescue PureCloud::ApiError => e
|
2366
2366
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequest: #{e}"
|
2367
2367
|
end
|
2368
|
-
|
2368
|
+
```
|
2369
2369
|
|
2370
2370
|
### Parameters
|
2371
2371
|
|
@@ -2388,7 +2388,7 @@ Name | Type | Description | Notes
|
|
2388
2388
|
|
2389
2389
|
<a name="get_workforcemanagement_timeoffrequests"></a>
|
2390
2390
|
|
2391
|
-
##
|
2391
|
+
## [**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_timeoffrequests(opts)
|
2392
2392
|
|
2393
2393
|
|
2394
2394
|
|
@@ -2405,7 +2405,7 @@ Requires ANY permissions:
|
|
2405
2405
|
|
2406
2406
|
|
2407
2407
|
### Example
|
2408
|
-
|
2408
|
+
```{"language":"ruby"}
|
2409
2409
|
# load the gem
|
2410
2410
|
require 'purecloudplatformclientv2'
|
2411
2411
|
# setup authorization
|
@@ -2432,7 +2432,7 @@ begin
|
|
2432
2432
|
rescue PureCloud::ApiError => e
|
2433
2433
|
puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequests: #{e}"
|
2434
2434
|
end
|
2435
|
-
|
2435
|
+
```
|
2436
2436
|
|
2437
2437
|
### Parameters
|
2438
2438
|
|
@@ -2455,7 +2455,7 @@ Name | Type | Description | Notes
|
|
2455
2455
|
|
2456
2456
|
<a name="patch_workforcemanagement_managementunit_activitycode"></a>
|
2457
2457
|
|
2458
|
-
##
|
2458
|
+
## [**ActivityCode**](ActivityCode.html) patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
|
2459
2459
|
|
2460
2460
|
|
2461
2461
|
|
@@ -2472,7 +2472,7 @@ Requires ANY permissions:
|
|
2472
2472
|
|
2473
2473
|
|
2474
2474
|
### Example
|
2475
|
-
|
2475
|
+
```{"language":"ruby"}
|
2476
2476
|
# load the gem
|
2477
2477
|
require 'purecloudplatformclientv2'
|
2478
2478
|
# setup authorization
|
@@ -2503,7 +2503,7 @@ begin
|
|
2503
2503
|
rescue PureCloud::ApiError => e
|
2504
2504
|
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_activitycode: #{e}"
|
2505
2505
|
end
|
2506
|
-
|
2506
|
+
```
|
2507
2507
|
|
2508
2508
|
### Parameters
|
2509
2509
|
|
@@ -2528,7 +2528,7 @@ Name | Type | Description | Notes
|
|
2528
2528
|
|
2529
2529
|
<a name="patch_workforcemanagement_managementunit_scheduling_run"></a>
|
2530
2530
|
|
2531
|
-
##
|
2531
|
+
## [**RescheduleResult**](RescheduleResult.html) patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
|
2532
2532
|
|
2533
2533
|
|
2534
2534
|
|
@@ -2544,7 +2544,7 @@ Requires ANY permissions:
|
|
2544
2544
|
|
2545
2545
|
|
2546
2546
|
### Example
|
2547
|
-
|
2547
|
+
```{"language":"ruby"}
|
2548
2548
|
# load the gem
|
2549
2549
|
require 'purecloudplatformclientv2'
|
2550
2550
|
# setup authorization
|
@@ -2575,7 +2575,7 @@ begin
|
|
2575
2575
|
rescue PureCloud::ApiError => e
|
2576
2576
|
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_scheduling_run: #{e}"
|
2577
2577
|
end
|
2578
|
-
|
2578
|
+
```
|
2579
2579
|
|
2580
2580
|
### Parameters
|
2581
2581
|
|
@@ -2600,7 +2600,7 @@ Name | Type | Description | Notes
|
|
2600
2600
|
|
2601
2601
|
<a name="patch_workforcemanagement_managementunit_servicegoalgroup"></a>
|
2602
2602
|
|
2603
|
-
##
|
2603
|
+
## [**ServiceGoalGroup**](ServiceGoalGroup.html) patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
|
2604
2604
|
|
2605
2605
|
|
2606
2606
|
|
@@ -2617,7 +2617,7 @@ Requires ANY permissions:
|
|
2617
2617
|
|
2618
2618
|
|
2619
2619
|
### Example
|
2620
|
-
|
2620
|
+
```{"language":"ruby"}
|
2621
2621
|
# load the gem
|
2622
2622
|
require 'purecloudplatformclientv2'
|
2623
2623
|
# setup authorization
|
@@ -2648,7 +2648,7 @@ begin
|
|
2648
2648
|
rescue PureCloud::ApiError => e
|
2649
2649
|
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_servicegoalgroup: #{e}"
|
2650
2650
|
end
|
2651
|
-
|
2651
|
+
```
|
2652
2652
|
|
2653
2653
|
### Parameters
|
2654
2654
|
|
@@ -2673,7 +2673,7 @@ Name | Type | Description | Notes
|
|
2673
2673
|
|
2674
2674
|
<a name="patch_workforcemanagement_managementunit_settings"></a>
|
2675
2675
|
|
2676
|
-
##
|
2676
|
+
## [**ManagementUnitSettings**](ManagementUnitSettings.html) patch_workforcemanagement_managementunit_settings(mu_id, opts)
|
2677
2677
|
|
2678
2678
|
|
2679
2679
|
|
@@ -2690,7 +2690,7 @@ Requires ANY permissions:
|
|
2690
2690
|
|
2691
2691
|
|
2692
2692
|
### Example
|
2693
|
-
|
2693
|
+
```{"language":"ruby"}
|
2694
2694
|
# load the gem
|
2695
2695
|
require 'purecloudplatformclientv2'
|
2696
2696
|
# setup authorization
|
@@ -2719,7 +2719,7 @@ begin
|
|
2719
2719
|
rescue PureCloud::ApiError => e
|
2720
2720
|
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_settings: #{e}"
|
2721
2721
|
end
|
2722
|
-
|
2722
|
+
```
|
2723
2723
|
|
2724
2724
|
### Parameters
|
2725
2725
|
|
@@ -2743,7 +2743,7 @@ Name | Type | Description | Notes
|
|
2743
2743
|
|
2744
2744
|
<a name="patch_workforcemanagement_managementunit_user_timeoffrequest"></a>
|
2745
2745
|
|
2746
|
-
##
|
2746
|
+
## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
|
2747
2747
|
|
2748
2748
|
|
2749
2749
|
|
@@ -2760,7 +2760,7 @@ Requires ANY permissions:
|
|
2760
2760
|
|
2761
2761
|
|
2762
2762
|
### Example
|
2763
|
-
|
2763
|
+
```{"language":"ruby"}
|
2764
2764
|
# load the gem
|
2765
2765
|
require 'purecloudplatformclientv2'
|
2766
2766
|
# setup authorization
|
@@ -2793,7 +2793,7 @@ begin
|
|
2793
2793
|
rescue PureCloud::ApiError => e
|
2794
2794
|
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
|
2795
2795
|
end
|
2796
|
-
|
2796
|
+
```
|
2797
2797
|
|
2798
2798
|
### Parameters
|
2799
2799
|
|
@@ -2819,7 +2819,7 @@ Name | Type | Description | Notes
|
|
2819
2819
|
|
2820
2820
|
<a name="patch_workforcemanagement_managementunit_week_schedule"></a>
|
2821
2821
|
|
2822
|
-
##
|
2822
|
+
## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
|
2823
2823
|
|
2824
2824
|
|
2825
2825
|
|
@@ -2836,7 +2836,7 @@ Requires ANY permissions:
|
|
2836
2836
|
|
2837
2837
|
|
2838
2838
|
### Example
|
2839
|
-
|
2839
|
+
```{"language":"ruby"}
|
2840
2840
|
# load the gem
|
2841
2841
|
require 'purecloudplatformclientv2'
|
2842
2842
|
# setup authorization
|
@@ -2871,7 +2871,7 @@ begin
|
|
2871
2871
|
rescue PureCloud::ApiError => e
|
2872
2872
|
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_week_schedule: #{e}"
|
2873
2873
|
end
|
2874
|
-
|
2874
|
+
```
|
2875
2875
|
|
2876
2876
|
### Parameters
|
2877
2877
|
|
@@ -2899,7 +2899,7 @@ Name | Type | Description | Notes
|
|
2899
2899
|
|
2900
2900
|
<a name="patch_workforcemanagement_managementunit_workplan"></a>
|
2901
2901
|
|
2902
|
-
##
|
2902
|
+
## [**WorkPlan**](WorkPlan.html) patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
|
2903
2903
|
|
2904
2904
|
|
2905
2905
|
|
@@ -2916,7 +2916,7 @@ Requires ANY permissions:
|
|
2916
2916
|
|
2917
2917
|
|
2918
2918
|
### Example
|
2919
|
-
|
2919
|
+
```{"language":"ruby"}
|
2920
2920
|
# load the gem
|
2921
2921
|
require 'purecloudplatformclientv2'
|
2922
2922
|
# setup authorization
|
@@ -2947,7 +2947,7 @@ begin
|
|
2947
2947
|
rescue PureCloud::ApiError => e
|
2948
2948
|
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_workplan: #{e}"
|
2949
2949
|
end
|
2950
|
-
|
2950
|
+
```
|
2951
2951
|
|
2952
2952
|
### Parameters
|
2953
2953
|
|
@@ -2972,7 +2972,7 @@ Name | Type | Description | Notes
|
|
2972
2972
|
|
2973
2973
|
<a name="patch_workforcemanagement_timeoffrequest"></a>
|
2974
2974
|
|
2975
|
-
##
|
2975
|
+
## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
|
2976
2976
|
|
2977
2977
|
|
2978
2978
|
|
@@ -2988,7 +2988,7 @@ Requires ANY permissions:
|
|
2988
2988
|
|
2989
2989
|
|
2990
2990
|
### Example
|
2991
|
-
|
2991
|
+
```{"language":"ruby"}
|
2992
2992
|
# load the gem
|
2993
2993
|
require 'purecloudplatformclientv2'
|
2994
2994
|
# setup authorization
|
@@ -3017,7 +3017,7 @@ begin
|
|
3017
3017
|
rescue PureCloud::ApiError => e
|
3018
3018
|
puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_timeoffrequest: #{e}"
|
3019
3019
|
end
|
3020
|
-
|
3020
|
+
```
|
3021
3021
|
|
3022
3022
|
### Parameters
|
3023
3023
|
|
@@ -3041,7 +3041,7 @@ Name | Type | Description | Notes
|
|
3041
3041
|
|
3042
3042
|
<a name="post_workforcemanagement_adherence_historical"></a>
|
3043
3043
|
|
3044
|
-
##
|
3044
|
+
## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_adherence_historical(opts)
|
3045
3045
|
|
3046
3046
|
|
3047
3047
|
|
@@ -3057,7 +3057,7 @@ Requires ANY permissions:
|
|
3057
3057
|
|
3058
3058
|
|
3059
3059
|
### Example
|
3060
|
-
|
3060
|
+
```{"language":"ruby"}
|
3061
3061
|
# load the gem
|
3062
3062
|
require 'purecloudplatformclientv2'
|
3063
3063
|
# setup authorization
|
@@ -3084,7 +3084,7 @@ begin
|
|
3084
3084
|
rescue PureCloud::ApiError => e
|
3085
3085
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_adherence_historical: #{e}"
|
3086
3086
|
end
|
3087
|
-
|
3087
|
+
```
|
3088
3088
|
|
3089
3089
|
### Parameters
|
3090
3090
|
|
@@ -3107,7 +3107,7 @@ Name | Type | Description | Notes
|
|
3107
3107
|
|
3108
3108
|
<a name="post_workforcemanagement_managementunit_activitycodes"></a>
|
3109
3109
|
|
3110
|
-
##
|
3110
|
+
## [**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
|
3111
3111
|
|
3112
3112
|
|
3113
3113
|
|
@@ -3124,7 +3124,7 @@ Requires ANY permissions:
|
|
3124
3124
|
|
3125
3125
|
|
3126
3126
|
### Example
|
3127
|
-
|
3127
|
+
```{"language":"ruby"}
|
3128
3128
|
# load the gem
|
3129
3129
|
require 'purecloudplatformclientv2'
|
3130
3130
|
# setup authorization
|
@@ -3153,7 +3153,7 @@ begin
|
|
3153
3153
|
rescue PureCloud::ApiError => e
|
3154
3154
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_activitycodes: #{e}"
|
3155
3155
|
end
|
3156
|
-
|
3156
|
+
```
|
3157
3157
|
|
3158
3158
|
### Parameters
|
3159
3159
|
|
@@ -3177,7 +3177,7 @@ Name | Type | Description | Notes
|
|
3177
3177
|
|
3178
3178
|
<a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
|
3179
3179
|
|
3180
|
-
##
|
3180
|
+
## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
|
3181
3181
|
|
3182
3182
|
|
3183
3183
|
|
@@ -3193,7 +3193,7 @@ Requires ANY permissions:
|
|
3193
3193
|
|
3194
3194
|
|
3195
3195
|
### Example
|
3196
|
-
|
3196
|
+
```{"language":"ruby"}
|
3197
3197
|
# load the gem
|
3198
3198
|
require 'purecloudplatformclientv2'
|
3199
3199
|
# setup authorization
|
@@ -3222,7 +3222,7 @@ begin
|
|
3222
3222
|
rescue PureCloud::ApiError => e
|
3223
3223
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: #{e}"
|
3224
3224
|
end
|
3225
|
-
|
3225
|
+
```
|
3226
3226
|
|
3227
3227
|
### Parameters
|
3228
3228
|
|
@@ -3246,7 +3246,7 @@ Name | Type | Description | Notes
|
|
3246
3246
|
|
3247
3247
|
<a name="post_workforcemanagement_managementunit_intraday"></a>
|
3248
3248
|
|
3249
|
-
##
|
3249
|
+
## [**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
|
3250
3250
|
|
3251
3251
|
|
3252
3252
|
|
@@ -3262,7 +3262,7 @@ Requires ANY permissions:
|
|
3262
3262
|
|
3263
3263
|
|
3264
3264
|
### Example
|
3265
|
-
|
3265
|
+
```{"language":"ruby"}
|
3266
3266
|
# load the gem
|
3267
3267
|
require 'purecloudplatformclientv2'
|
3268
3268
|
# setup authorization
|
@@ -3291,7 +3291,7 @@ begin
|
|
3291
3291
|
rescue PureCloud::ApiError => e
|
3292
3292
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_intraday: #{e}"
|
3293
3293
|
end
|
3294
|
-
|
3294
|
+
```
|
3295
3295
|
|
3296
3296
|
### Parameters
|
3297
3297
|
|
@@ -3315,7 +3315,7 @@ Name | Type | Description | Notes
|
|
3315
3315
|
|
3316
3316
|
<a name="post_workforcemanagement_managementunit_schedules_search"></a>
|
3317
3317
|
|
3318
|
-
##
|
3318
|
+
## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
|
3319
3319
|
|
3320
3320
|
|
3321
3321
|
|
@@ -3333,7 +3333,7 @@ Requires ANY permissions:
|
|
3333
3333
|
|
3334
3334
|
|
3335
3335
|
### Example
|
3336
|
-
|
3336
|
+
```{"language":"ruby"}
|
3337
3337
|
# load the gem
|
3338
3338
|
require 'purecloudplatformclientv2'
|
3339
3339
|
# setup authorization
|
@@ -3362,7 +3362,7 @@ begin
|
|
3362
3362
|
rescue PureCloud::ApiError => e
|
3363
3363
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_schedules_search: #{e}"
|
3364
3364
|
end
|
3365
|
-
|
3365
|
+
```
|
3366
3366
|
|
3367
3367
|
### Parameters
|
3368
3368
|
|
@@ -3386,7 +3386,7 @@ Name | Type | Description | Notes
|
|
3386
3386
|
|
3387
3387
|
<a name="post_workforcemanagement_managementunit_servicegoalgroups"></a>
|
3388
3388
|
|
3389
|
-
##
|
3389
|
+
## [**ServiceGoalGroup**](ServiceGoalGroup.html) post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
|
3390
3390
|
|
3391
3391
|
|
3392
3392
|
|
@@ -3403,7 +3403,7 @@ Requires ANY permissions:
|
|
3403
3403
|
|
3404
3404
|
|
3405
3405
|
### Example
|
3406
|
-
|
3406
|
+
```{"language":"ruby"}
|
3407
3407
|
# load the gem
|
3408
3408
|
require 'purecloudplatformclientv2'
|
3409
3409
|
# setup authorization
|
@@ -3432,7 +3432,7 @@ begin
|
|
3432
3432
|
rescue PureCloud::ApiError => e
|
3433
3433
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_servicegoalgroups: #{e}"
|
3434
3434
|
end
|
3435
|
-
|
3435
|
+
```
|
3436
3436
|
|
3437
3437
|
### Parameters
|
3438
3438
|
|
@@ -3456,7 +3456,7 @@ Name | Type | Description | Notes
|
|
3456
3456
|
|
3457
3457
|
<a name="post_workforcemanagement_managementunit_timeoffrequests"></a>
|
3458
3458
|
|
3459
|
-
##
|
3459
|
+
## [**TimeOffRequestList**](TimeOffRequestList.html) post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
|
3460
3460
|
|
3461
3461
|
|
3462
3462
|
|
@@ -3473,7 +3473,7 @@ Requires ANY permissions:
|
|
3473
3473
|
|
3474
3474
|
|
3475
3475
|
### Example
|
3476
|
-
|
3476
|
+
```{"language":"ruby"}
|
3477
3477
|
# load the gem
|
3478
3478
|
require 'purecloudplatformclientv2'
|
3479
3479
|
# setup authorization
|
@@ -3502,7 +3502,7 @@ begin
|
|
3502
3502
|
rescue PureCloud::ApiError => e
|
3503
3503
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests: #{e}"
|
3504
3504
|
end
|
3505
|
-
|
3505
|
+
```
|
3506
3506
|
|
3507
3507
|
### Parameters
|
3508
3508
|
|
@@ -3526,7 +3526,7 @@ Name | Type | Description | Notes
|
|
3526
3526
|
|
3527
3527
|
<a name="post_workforcemanagement_managementunit_timeoffrequests_fetchdetails"></a>
|
3528
3528
|
|
3529
|
-
##
|
3529
|
+
## [**TimeOffRequestEntityList**](TimeOffRequestEntityList.html) post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
|
3530
3530
|
|
3531
3531
|
|
3532
3532
|
|
@@ -3543,7 +3543,7 @@ Requires ANY permissions:
|
|
3543
3543
|
|
3544
3544
|
|
3545
3545
|
### Example
|
3546
|
-
|
3546
|
+
```{"language":"ruby"}
|
3547
3547
|
# load the gem
|
3548
3548
|
require 'purecloudplatformclientv2'
|
3549
3549
|
# setup authorization
|
@@ -3572,7 +3572,7 @@ begin
|
|
3572
3572
|
rescue PureCloud::ApiError => e
|
3573
3573
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_fetchdetails: #{e}"
|
3574
3574
|
end
|
3575
|
-
|
3575
|
+
```
|
3576
3576
|
|
3577
3577
|
### Parameters
|
3578
3578
|
|
@@ -3596,7 +3596,7 @@ Name | Type | Description | Notes
|
|
3596
3596
|
|
3597
3597
|
<a name="post_workforcemanagement_managementunit_timeoffrequests_query"></a>
|
3598
3598
|
|
3599
|
-
##
|
3599
|
+
## [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html) post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
|
3600
3600
|
|
3601
3601
|
|
3602
3602
|
|
@@ -3613,7 +3613,7 @@ Requires ANY permissions:
|
|
3613
3613
|
|
3614
3614
|
|
3615
3615
|
### Example
|
3616
|
-
|
3616
|
+
```{"language":"ruby"}
|
3617
3617
|
# load the gem
|
3618
3618
|
require 'purecloudplatformclientv2'
|
3619
3619
|
# setup authorization
|
@@ -3642,7 +3642,7 @@ begin
|
|
3642
3642
|
rescue PureCloud::ApiError => e
|
3643
3643
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_query: #{e}"
|
3644
3644
|
end
|
3645
|
-
|
3645
|
+
```
|
3646
3646
|
|
3647
3647
|
### Parameters
|
3648
3648
|
|
@@ -3666,7 +3666,7 @@ Name | Type | Description | Notes
|
|
3666
3666
|
|
3667
3667
|
<a name="post_workforcemanagement_managementunit_week_schedule_copy"></a>
|
3668
3668
|
|
3669
|
-
##
|
3669
|
+
## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
|
3670
3670
|
|
3671
3671
|
|
3672
3672
|
|
@@ -3683,7 +3683,7 @@ Requires ANY permissions:
|
|
3683
3683
|
|
3684
3684
|
|
3685
3685
|
### Example
|
3686
|
-
|
3686
|
+
```{"language":"ruby"}
|
3687
3687
|
# load the gem
|
3688
3688
|
require 'purecloudplatformclientv2'
|
3689
3689
|
# setup authorization
|
@@ -3718,7 +3718,7 @@ begin
|
|
3718
3718
|
rescue PureCloud::ApiError => e
|
3719
3719
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_copy: #{e}"
|
3720
3720
|
end
|
3721
|
-
|
3721
|
+
```
|
3722
3722
|
|
3723
3723
|
### Parameters
|
3724
3724
|
|
@@ -3746,7 +3746,7 @@ Name | Type | Description | Notes
|
|
3746
3746
|
|
3747
3747
|
<a name="post_workforcemanagement_managementunit_week_schedule_reschedule"></a>
|
3748
3748
|
|
3749
|
-
##
|
3749
|
+
## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
|
3750
3750
|
|
3751
3751
|
|
3752
3752
|
|
@@ -3763,7 +3763,7 @@ Requires ANY permissions:
|
|
3763
3763
|
|
3764
3764
|
|
3765
3765
|
### Example
|
3766
|
-
|
3766
|
+
```{"language":"ruby"}
|
3767
3767
|
# load the gem
|
3768
3768
|
require 'purecloudplatformclientv2'
|
3769
3769
|
# setup authorization
|
@@ -3796,7 +3796,7 @@ begin
|
|
3796
3796
|
rescue PureCloud::ApiError => e
|
3797
3797
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_reschedule: #{e}"
|
3798
3798
|
end
|
3799
|
-
|
3799
|
+
```
|
3800
3800
|
|
3801
3801
|
### Parameters
|
3802
3802
|
|
@@ -3822,7 +3822,7 @@ Name | Type | Description | Notes
|
|
3822
3822
|
|
3823
3823
|
<a name="post_workforcemanagement_managementunit_week_schedules"></a>
|
3824
3824
|
|
3825
|
-
##
|
3825
|
+
## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
|
3826
3826
|
|
3827
3827
|
|
3828
3828
|
|
@@ -3839,7 +3839,7 @@ Requires ANY permissions:
|
|
3839
3839
|
|
3840
3840
|
|
3841
3841
|
### Example
|
3842
|
-
|
3842
|
+
```{"language":"ruby"}
|
3843
3843
|
# load the gem
|
3844
3844
|
require 'purecloudplatformclientv2'
|
3845
3845
|
# setup authorization
|
@@ -3872,7 +3872,7 @@ begin
|
|
3872
3872
|
rescue PureCloud::ApiError => e
|
3873
3873
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules: #{e}"
|
3874
3874
|
end
|
3875
|
-
|
3875
|
+
```
|
3876
3876
|
|
3877
3877
|
### Parameters
|
3878
3878
|
|
@@ -3899,7 +3899,7 @@ Name | Type | Description | Notes
|
|
3899
3899
|
|
3900
3900
|
<a name="post_workforcemanagement_managementunit_week_schedules_generate"></a>
|
3901
3901
|
|
3902
|
-
##
|
3902
|
+
## [**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
|
3903
3903
|
|
3904
3904
|
|
3905
3905
|
|
@@ -3915,7 +3915,7 @@ Requires ANY permissions:
|
|
3915
3915
|
|
3916
3916
|
|
3917
3917
|
### Example
|
3918
|
-
|
3918
|
+
```{"language":"ruby"}
|
3919
3919
|
# load the gem
|
3920
3920
|
require 'purecloudplatformclientv2'
|
3921
3921
|
# setup authorization
|
@@ -3946,7 +3946,7 @@ begin
|
|
3946
3946
|
rescue PureCloud::ApiError => e
|
3947
3947
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_generate: #{e}"
|
3948
3948
|
end
|
3949
|
-
|
3949
|
+
```
|
3950
3950
|
|
3951
3951
|
### Parameters
|
3952
3952
|
|
@@ -3971,7 +3971,7 @@ Name | Type | Description | Notes
|
|
3971
3971
|
|
3972
3972
|
<a name="post_workforcemanagement_managementunit_week_schedules_partialupload"></a>
|
3973
3973
|
|
3974
|
-
##
|
3974
|
+
## [**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
|
3975
3975
|
|
3976
3976
|
|
3977
3977
|
|
@@ -3989,7 +3989,7 @@ Requires ANY permissions:
|
|
3989
3989
|
|
3990
3990
|
|
3991
3991
|
### Example
|
3992
|
-
|
3992
|
+
```{"language":"ruby"}
|
3993
3993
|
# load the gem
|
3994
3994
|
require 'purecloudplatformclientv2'
|
3995
3995
|
# setup authorization
|
@@ -4020,7 +4020,7 @@ begin
|
|
4020
4020
|
rescue PureCloud::ApiError => e
|
4021
4021
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_partialupload: #{e}"
|
4022
4022
|
end
|
4023
|
-
|
4023
|
+
```
|
4024
4024
|
|
4025
4025
|
### Parameters
|
4026
4026
|
|
@@ -4045,7 +4045,7 @@ Name | Type | Description | Notes
|
|
4045
4045
|
|
4046
4046
|
<a name="post_workforcemanagement_managementunit_week_shorttermforecast_copy"></a>
|
4047
4047
|
|
4048
|
-
##
|
4048
|
+
## [**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts)
|
4049
4049
|
|
4050
4050
|
|
4051
4051
|
|
@@ -4062,7 +4062,7 @@ Requires ANY permissions:
|
|
4062
4062
|
|
4063
4063
|
|
4064
4064
|
### Example
|
4065
|
-
|
4065
|
+
```{"language":"ruby"}
|
4066
4066
|
# load the gem
|
4067
4067
|
require 'purecloudplatformclientv2'
|
4068
4068
|
# setup authorization
|
@@ -4097,7 +4097,7 @@ begin
|
|
4097
4097
|
rescue PureCloud::ApiError => e
|
4098
4098
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecast_copy: #{e}"
|
4099
4099
|
end
|
4100
|
-
|
4100
|
+
```
|
4101
4101
|
|
4102
4102
|
### Parameters
|
4103
4103
|
|
@@ -4124,7 +4124,7 @@ Name | Type | Description | Notes
|
|
4124
4124
|
|
4125
4125
|
<a name="post_workforcemanagement_managementunit_week_shorttermforecasts"></a>
|
4126
4126
|
|
4127
|
-
##
|
4127
|
+
## [**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, body, opts)
|
4128
4128
|
|
4129
4129
|
|
4130
4130
|
|
@@ -4141,7 +4141,7 @@ Requires ANY permissions:
|
|
4141
4141
|
|
4142
4142
|
|
4143
4143
|
### Example
|
4144
|
-
|
4144
|
+
```{"language":"ruby"}
|
4145
4145
|
# load the gem
|
4146
4146
|
require 'purecloudplatformclientv2'
|
4147
4147
|
# setup authorization
|
@@ -4174,7 +4174,7 @@ begin
|
|
4174
4174
|
rescue PureCloud::ApiError => e
|
4175
4175
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts: #{e}"
|
4176
4176
|
end
|
4177
|
-
|
4177
|
+
```
|
4178
4178
|
|
4179
4179
|
### Parameters
|
4180
4180
|
|
@@ -4200,7 +4200,7 @@ Name | Type | Description | Notes
|
|
4200
4200
|
|
4201
4201
|
<a name="post_workforcemanagement_managementunit_week_shorttermforecasts_generate"></a>
|
4202
4202
|
|
4203
|
-
##
|
4203
|
+
## [**GenerateShortTermForecastResponse**](GenerateShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, body, opts)
|
4204
4204
|
|
4205
4205
|
|
4206
4206
|
|
@@ -4217,7 +4217,7 @@ Requires ANY permissions:
|
|
4217
4217
|
|
4218
4218
|
|
4219
4219
|
### Example
|
4220
|
-
|
4220
|
+
```{"language":"ruby"}
|
4221
4221
|
# load the gem
|
4222
4222
|
require 'purecloudplatformclientv2'
|
4223
4223
|
# setup authorization
|
@@ -4250,7 +4250,7 @@ begin
|
|
4250
4250
|
rescue PureCloud::ApiError => e
|
4251
4251
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts_generate: #{e}"
|
4252
4252
|
end
|
4253
|
-
|
4253
|
+
```
|
4254
4254
|
|
4255
4255
|
### Parameters
|
4256
4256
|
|
@@ -4276,7 +4276,7 @@ Name | Type | Description | Notes
|
|
4276
4276
|
|
4277
4277
|
<a name="post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload"></a>
|
4278
4278
|
|
4279
|
-
##
|
4279
|
+
## [**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, body)
|
4280
4280
|
|
4281
4281
|
|
4282
4282
|
|
@@ -4293,7 +4293,7 @@ Requires ANY permissions:
|
|
4293
4293
|
|
4294
4294
|
|
4295
4295
|
### Example
|
4296
|
-
|
4296
|
+
```{"language":"ruby"}
|
4297
4297
|
# load the gem
|
4298
4298
|
require 'purecloudplatformclientv2'
|
4299
4299
|
# setup authorization
|
@@ -4323,7 +4323,7 @@ begin
|
|
4323
4323
|
rescue PureCloud::ApiError => e
|
4324
4324
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload: #{e}"
|
4325
4325
|
end
|
4326
|
-
|
4326
|
+
```
|
4327
4327
|
|
4328
4328
|
### Parameters
|
4329
4329
|
|
@@ -4348,7 +4348,7 @@ Name | Type | Description | Notes
|
|
4348
4348
|
|
4349
4349
|
<a name="post_workforcemanagement_managementunit_workplan_copy"></a>
|
4350
4350
|
|
4351
|
-
##
|
4351
|
+
## [**WorkPlan**](WorkPlan.html) post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts)
|
4352
4352
|
|
4353
4353
|
|
4354
4354
|
|
@@ -4365,7 +4365,7 @@ Requires ANY permissions:
|
|
4365
4365
|
|
4366
4366
|
|
4367
4367
|
### Example
|
4368
|
-
|
4368
|
+
```{"language":"ruby"}
|
4369
4369
|
# load the gem
|
4370
4370
|
require 'purecloudplatformclientv2'
|
4371
4371
|
# setup authorization
|
@@ -4396,7 +4396,7 @@ begin
|
|
4396
4396
|
rescue PureCloud::ApiError => e
|
4397
4397
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplan_copy: #{e}"
|
4398
4398
|
end
|
4399
|
-
|
4399
|
+
```
|
4400
4400
|
|
4401
4401
|
### Parameters
|
4402
4402
|
|
@@ -4421,7 +4421,7 @@ Name | Type | Description | Notes
|
|
4421
4421
|
|
4422
4422
|
<a name="post_workforcemanagement_managementunit_workplans"></a>
|
4423
4423
|
|
4424
|
-
##
|
4424
|
+
## [**WorkPlan**](WorkPlan.html) post_workforcemanagement_managementunit_workplans(management_unit_id, opts)
|
4425
4425
|
|
4426
4426
|
|
4427
4427
|
|
@@ -4438,7 +4438,7 @@ Requires ANY permissions:
|
|
4438
4438
|
|
4439
4439
|
|
4440
4440
|
### Example
|
4441
|
-
|
4441
|
+
```{"language":"ruby"}
|
4442
4442
|
# load the gem
|
4443
4443
|
require 'purecloudplatformclientv2'
|
4444
4444
|
# setup authorization
|
@@ -4467,7 +4467,7 @@ begin
|
|
4467
4467
|
rescue PureCloud::ApiError => e
|
4468
4468
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplans: #{e}"
|
4469
4469
|
end
|
4470
|
-
|
4470
|
+
```
|
4471
4471
|
|
4472
4472
|
### Parameters
|
4473
4473
|
|
@@ -4491,7 +4491,7 @@ Name | Type | Description | Notes
|
|
4491
4491
|
|
4492
4492
|
<a name="post_workforcemanagement_managementunits"></a>
|
4493
4493
|
|
4494
|
-
##
|
4494
|
+
## [**ManagementUnit**](ManagementUnit.html) post_workforcemanagement_managementunits(opts)
|
4495
4495
|
|
4496
4496
|
|
4497
4497
|
|
@@ -4508,7 +4508,7 @@ Requires ANY permissions:
|
|
4508
4508
|
|
4509
4509
|
|
4510
4510
|
### Example
|
4511
|
-
|
4511
|
+
```{"language":"ruby"}
|
4512
4512
|
# load the gem
|
4513
4513
|
require 'purecloudplatformclientv2'
|
4514
4514
|
# setup authorization
|
@@ -4535,7 +4535,7 @@ begin
|
|
4535
4535
|
rescue PureCloud::ApiError => e
|
4536
4536
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunits: #{e}"
|
4537
4537
|
end
|
4538
|
-
|
4538
|
+
```
|
4539
4539
|
|
4540
4540
|
### Parameters
|
4541
4541
|
|
@@ -4558,7 +4558,7 @@ Name | Type | Description | Notes
|
|
4558
4558
|
|
4559
4559
|
<a name="post_workforcemanagement_schedules"></a>
|
4560
4560
|
|
4561
|
-
##
|
4561
|
+
## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_schedules(opts)
|
4562
4562
|
|
4563
4563
|
|
4564
4564
|
|
@@ -4576,7 +4576,7 @@ Requires ANY permissions:
|
|
4576
4576
|
|
4577
4577
|
|
4578
4578
|
### Example
|
4579
|
-
|
4579
|
+
```{"language":"ruby"}
|
4580
4580
|
# load the gem
|
4581
4581
|
require 'purecloudplatformclientv2'
|
4582
4582
|
# setup authorization
|
@@ -4603,7 +4603,7 @@ begin
|
|
4603
4603
|
rescue PureCloud::ApiError => e
|
4604
4604
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_schedules: #{e}"
|
4605
4605
|
end
|
4606
|
-
|
4606
|
+
```
|
4607
4607
|
|
4608
4608
|
### Parameters
|
4609
4609
|
|
@@ -4626,7 +4626,7 @@ Name | Type | Description | Notes
|
|
4626
4626
|
|
4627
4627
|
<a name="post_workforcemanagement_timeoffrequests"></a>
|
4628
4628
|
|
4629
|
-
##
|
4629
|
+
## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) post_workforcemanagement_timeoffrequests(opts)
|
4630
4630
|
|
4631
4631
|
|
4632
4632
|
|
@@ -4642,7 +4642,7 @@ Requires ANY permissions:
|
|
4642
4642
|
|
4643
4643
|
|
4644
4644
|
### Example
|
4645
|
-
|
4645
|
+
```{"language":"ruby"}
|
4646
4646
|
# load the gem
|
4647
4647
|
require 'purecloudplatformclientv2'
|
4648
4648
|
# setup authorization
|
@@ -4669,7 +4669,7 @@ begin
|
|
4669
4669
|
rescue PureCloud::ApiError => e
|
4670
4670
|
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_timeoffrequests: #{e}"
|
4671
4671
|
end
|
4672
|
-
|
4672
|
+
```
|
4673
4673
|
|
4674
4674
|
### Parameters
|
4675
4675
|
|