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/TokensApi.md
CHANGED
@@ -14,7 +14,7 @@ Method | Description
|
|
14
14
|
|
15
15
|
<a name="delete_tokens_me"></a>
|
16
16
|
|
17
|
-
##
|
17
|
+
## delete_tokens_me
|
18
18
|
|
19
19
|
|
20
20
|
|
@@ -29,7 +29,7 @@ Requires NO permissions:
|
|
29
29
|
|
30
30
|
|
31
31
|
### Example
|
32
|
-
|
32
|
+
```{"language":"ruby"}
|
33
33
|
# load the gem
|
34
34
|
require 'purecloudplatformclientv2'
|
35
35
|
# setup authorization
|
@@ -51,7 +51,7 @@ begin
|
|
51
51
|
rescue PureCloud::ApiError => e
|
52
52
|
puts "Exception when calling TokensApi->delete_tokens_me: #{e}"
|
53
53
|
end
|
54
|
-
|
54
|
+
```
|
55
55
|
|
56
56
|
### Parameters
|
57
57
|
This endpoint does not need any parameter.
|
@@ -71,7 +71,7 @@ nil (empty response body)
|
|
71
71
|
|
72
72
|
<a name="get_tokens_me"></a>
|
73
73
|
|
74
|
-
##
|
74
|
+
## [**TokenInfo**](TokenInfo.html) get_tokens_me
|
75
75
|
|
76
76
|
|
77
77
|
|
@@ -86,7 +86,7 @@ Requires NO permissions:
|
|
86
86
|
|
87
87
|
|
88
88
|
### Example
|
89
|
-
|
89
|
+
```{"language":"ruby"}
|
90
90
|
# load the gem
|
91
91
|
require 'purecloudplatformclientv2'
|
92
92
|
# setup authorization
|
@@ -109,7 +109,7 @@ begin
|
|
109
109
|
rescue PureCloud::ApiError => e
|
110
110
|
puts "Exception when calling TokensApi->get_tokens_me: #{e}"
|
111
111
|
end
|
112
|
-
|
112
|
+
```
|
113
113
|
|
114
114
|
### Parameters
|
115
115
|
This endpoint does not need any parameter.
|
data/docs/UserRecordingsApi.md
CHANGED
@@ -18,7 +18,7 @@ Method | Description
|
|
18
18
|
|
19
19
|
<a name="delete_userrecording"></a>
|
20
20
|
|
21
|
-
##
|
21
|
+
## delete_userrecording(recording_id)
|
22
22
|
|
23
23
|
|
24
24
|
|
@@ -33,7 +33,7 @@ Requires NO permissions:
|
|
33
33
|
|
34
34
|
|
35
35
|
### Example
|
36
|
-
|
36
|
+
```{"language":"ruby"}
|
37
37
|
# load the gem
|
38
38
|
require 'purecloudplatformclientv2'
|
39
39
|
# setup authorization
|
@@ -58,7 +58,7 @@ begin
|
|
58
58
|
rescue PureCloud::ApiError => e
|
59
59
|
puts "Exception when calling UserRecordingsApi->delete_userrecording: #{e}"
|
60
60
|
end
|
61
|
-
|
61
|
+
```
|
62
62
|
|
63
63
|
### Parameters
|
64
64
|
|
@@ -81,7 +81,7 @@ nil (empty response body)
|
|
81
81
|
|
82
82
|
<a name="get_userrecording"></a>
|
83
83
|
|
84
|
-
##
|
84
|
+
## [**UserRecording**](UserRecording.html) get_userrecording(recording_id, opts)
|
85
85
|
|
86
86
|
|
87
87
|
|
@@ -96,7 +96,7 @@ Requires NO permissions:
|
|
96
96
|
|
97
97
|
|
98
98
|
### Example
|
99
|
-
|
99
|
+
```{"language":"ruby"}
|
100
100
|
# load the gem
|
101
101
|
require 'purecloudplatformclientv2'
|
102
102
|
# setup authorization
|
@@ -125,7 +125,7 @@ begin
|
|
125
125
|
rescue PureCloud::ApiError => e
|
126
126
|
puts "Exception when calling UserRecordingsApi->get_userrecording: #{e}"
|
127
127
|
end
|
128
|
-
|
128
|
+
```
|
129
129
|
|
130
130
|
### Parameters
|
131
131
|
|
@@ -149,7 +149,7 @@ Name | Type | Description | Notes
|
|
149
149
|
|
150
150
|
<a name="get_userrecording_media"></a>
|
151
151
|
|
152
|
-
##
|
152
|
+
## [**DownloadResponse**](DownloadResponse.html) get_userrecording_media(recording_id, opts)
|
153
153
|
|
154
154
|
|
155
155
|
|
@@ -164,7 +164,7 @@ Requires NO permissions:
|
|
164
164
|
|
165
165
|
|
166
166
|
### Example
|
167
|
-
|
167
|
+
```{"language":"ruby"}
|
168
168
|
# load the gem
|
169
169
|
require 'purecloudplatformclientv2'
|
170
170
|
# setup authorization
|
@@ -193,7 +193,7 @@ begin
|
|
193
193
|
rescue PureCloud::ApiError => e
|
194
194
|
puts "Exception when calling UserRecordingsApi->get_userrecording_media: #{e}"
|
195
195
|
end
|
196
|
-
|
196
|
+
```
|
197
197
|
|
198
198
|
### Parameters
|
199
199
|
|
@@ -217,7 +217,7 @@ Name | Type | Description | Notes
|
|
217
217
|
|
218
218
|
<a name="get_userrecordings"></a>
|
219
219
|
|
220
|
-
##
|
220
|
+
## [**UserRecordingEntityListing**](UserRecordingEntityListing.html) get_userrecordings(opts)
|
221
221
|
|
222
222
|
|
223
223
|
|
@@ -232,7 +232,7 @@ Requires NO permissions:
|
|
232
232
|
|
233
233
|
|
234
234
|
### Example
|
235
|
-
|
235
|
+
```{"language":"ruby"}
|
236
236
|
# load the gem
|
237
237
|
require 'purecloudplatformclientv2'
|
238
238
|
# setup authorization
|
@@ -261,7 +261,7 @@ begin
|
|
261
261
|
rescue PureCloud::ApiError => e
|
262
262
|
puts "Exception when calling UserRecordingsApi->get_userrecordings: #{e}"
|
263
263
|
end
|
264
|
-
|
264
|
+
```
|
265
265
|
|
266
266
|
### Parameters
|
267
267
|
|
@@ -286,7 +286,7 @@ Name | Type | Description | Notes
|
|
286
286
|
|
287
287
|
<a name="get_userrecordings_summary"></a>
|
288
288
|
|
289
|
-
##
|
289
|
+
## [**FaxSummary**](FaxSummary.html) get_userrecordings_summary
|
290
290
|
|
291
291
|
|
292
292
|
|
@@ -301,7 +301,7 @@ Requires NO permissions:
|
|
301
301
|
|
302
302
|
|
303
303
|
### Example
|
304
|
-
|
304
|
+
```{"language":"ruby"}
|
305
305
|
# load the gem
|
306
306
|
require 'purecloudplatformclientv2'
|
307
307
|
# setup authorization
|
@@ -324,7 +324,7 @@ begin
|
|
324
324
|
rescue PureCloud::ApiError => e
|
325
325
|
puts "Exception when calling UserRecordingsApi->get_userrecordings_summary: #{e}"
|
326
326
|
end
|
327
|
-
|
327
|
+
```
|
328
328
|
|
329
329
|
### Parameters
|
330
330
|
This endpoint does not need any parameter.
|
@@ -344,7 +344,7 @@ This endpoint does not need any parameter.
|
|
344
344
|
|
345
345
|
<a name="put_userrecording"></a>
|
346
346
|
|
347
|
-
##
|
347
|
+
## [**UserRecording**](UserRecording.html) put_userrecording(recording_id, body, opts)
|
348
348
|
|
349
349
|
|
350
350
|
|
@@ -359,7 +359,7 @@ Requires NO permissions:
|
|
359
359
|
|
360
360
|
|
361
361
|
### Example
|
362
|
-
|
362
|
+
```{"language":"ruby"}
|
363
363
|
# load the gem
|
364
364
|
require 'purecloudplatformclientv2'
|
365
365
|
# setup authorization
|
@@ -390,7 +390,7 @@ begin
|
|
390
390
|
rescue PureCloud::ApiError => e
|
391
391
|
puts "Exception when calling UserRecordingsApi->put_userrecording: #{e}"
|
392
392
|
end
|
393
|
-
|
393
|
+
```
|
394
394
|
|
395
395
|
### Parameters
|
396
396
|
|
data/docs/UsersApi.md
CHANGED
@@ -73,7 +73,7 @@ Method | Description
|
|
73
73
|
|
74
74
|
<a name="delete_authorization_subject_division_role"></a>
|
75
75
|
|
76
|
-
##
|
76
|
+
## delete_authorization_subject_division_role(subject_id, division_id, role_id)
|
77
77
|
|
78
78
|
|
79
79
|
|
@@ -89,7 +89,7 @@ Requires ANY permissions:
|
|
89
89
|
|
90
90
|
|
91
91
|
### Example
|
92
|
-
|
92
|
+
```{"language":"ruby"}
|
93
93
|
# load the gem
|
94
94
|
require 'purecloudplatformclientv2'
|
95
95
|
# setup authorization
|
@@ -118,7 +118,7 @@ begin
|
|
118
118
|
rescue PureCloud::ApiError => e
|
119
119
|
puts "Exception when calling UsersApi->delete_authorization_subject_division_role: #{e}"
|
120
120
|
end
|
121
|
-
|
121
|
+
```
|
122
122
|
|
123
123
|
### Parameters
|
124
124
|
|
@@ -143,7 +143,7 @@ nil (empty response body)
|
|
143
143
|
|
144
144
|
<a name="delete_user"></a>
|
145
145
|
|
146
|
-
##
|
146
|
+
## [**Empty**](Empty.html) delete_user(user_id)
|
147
147
|
|
148
148
|
|
149
149
|
|
@@ -161,7 +161,7 @@ Requires ANY permissions:
|
|
161
161
|
|
162
162
|
|
163
163
|
### Example
|
164
|
-
|
164
|
+
```{"language":"ruby"}
|
165
165
|
# load the gem
|
166
166
|
require 'purecloudplatformclientv2'
|
167
167
|
# setup authorization
|
@@ -187,7 +187,7 @@ begin
|
|
187
187
|
rescue PureCloud::ApiError => e
|
188
188
|
puts "Exception when calling UsersApi->delete_user: #{e}"
|
189
189
|
end
|
190
|
-
|
190
|
+
```
|
191
191
|
|
192
192
|
### Parameters
|
193
193
|
|
@@ -210,7 +210,7 @@ Name | Type | Description | Notes
|
|
210
210
|
|
211
211
|
<a name="delete_user_roles"></a>
|
212
212
|
|
213
|
-
##
|
213
|
+
## delete_user_roles(user_id)
|
214
214
|
|
215
215
|
|
216
216
|
|
@@ -228,7 +228,7 @@ Requires ANY permissions:
|
|
228
228
|
|
229
229
|
|
230
230
|
### Example
|
231
|
-
|
231
|
+
```{"language":"ruby"}
|
232
232
|
# load the gem
|
233
233
|
require 'purecloudplatformclientv2'
|
234
234
|
# setup authorization
|
@@ -253,7 +253,7 @@ begin
|
|
253
253
|
rescue PureCloud::ApiError => e
|
254
254
|
puts "Exception when calling UsersApi->delete_user_roles: #{e}"
|
255
255
|
end
|
256
|
-
|
256
|
+
```
|
257
257
|
|
258
258
|
### Parameters
|
259
259
|
|
@@ -276,7 +276,7 @@ nil (empty response body)
|
|
276
276
|
|
277
277
|
<a name="delete_user_routinglanguage"></a>
|
278
278
|
|
279
|
-
##
|
279
|
+
## delete_user_routinglanguage(user_id, language_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 UsersApi->delete_user_routinglanguage: #{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_user_routingskill"></a>
|
346
346
|
|
347
|
-
##
|
347
|
+
## delete_user_routingskill(user_id, skill_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
|
@@ -388,7 +388,7 @@ begin
|
|
388
388
|
rescue PureCloud::ApiError => e
|
389
389
|
puts "Exception when calling UsersApi->delete_user_routingskill: #{e}"
|
390
390
|
end
|
391
|
-
|
391
|
+
```
|
392
392
|
|
393
393
|
### Parameters
|
394
394
|
|
@@ -412,7 +412,7 @@ nil (empty response body)
|
|
412
412
|
|
413
413
|
<a name="delete_user_station_associatedstation"></a>
|
414
414
|
|
415
|
-
##
|
415
|
+
## delete_user_station_associatedstation(user_id)
|
416
416
|
|
417
417
|
|
418
418
|
|
@@ -427,7 +427,7 @@ Requires NO permissions:
|
|
427
427
|
|
428
428
|
|
429
429
|
### Example
|
430
|
-
|
430
|
+
```{"language":"ruby"}
|
431
431
|
# load the gem
|
432
432
|
require 'purecloudplatformclientv2'
|
433
433
|
# setup authorization
|
@@ -452,7 +452,7 @@ begin
|
|
452
452
|
rescue PureCloud::ApiError => e
|
453
453
|
puts "Exception when calling UsersApi->delete_user_station_associatedstation: #{e}"
|
454
454
|
end
|
455
|
-
|
455
|
+
```
|
456
456
|
|
457
457
|
### Parameters
|
458
458
|
|
@@ -475,7 +475,7 @@ nil (empty response body)
|
|
475
475
|
|
476
476
|
<a name="delete_user_station_defaultstation"></a>
|
477
477
|
|
478
|
-
##
|
478
|
+
## delete_user_station_defaultstation(user_id)
|
479
479
|
|
480
480
|
|
481
481
|
|
@@ -492,7 +492,7 @@ Requires ANY permissions:
|
|
492
492
|
|
493
493
|
|
494
494
|
### Example
|
495
|
-
|
495
|
+
```{"language":"ruby"}
|
496
496
|
# load the gem
|
497
497
|
require 'purecloudplatformclientv2'
|
498
498
|
# setup authorization
|
@@ -517,7 +517,7 @@ begin
|
|
517
517
|
rescue PureCloud::ApiError => e
|
518
518
|
puts "Exception when calling UsersApi->delete_user_station_defaultstation: #{e}"
|
519
519
|
end
|
520
|
-
|
520
|
+
```
|
521
521
|
|
522
522
|
### Parameters
|
523
523
|
|
@@ -540,7 +540,7 @@ nil (empty response body)
|
|
540
540
|
|
541
541
|
<a name="get_authorization_divisionspermitted_me"></a>
|
542
542
|
|
543
|
-
##
|
543
|
+
## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
|
544
544
|
|
545
545
|
|
546
546
|
|
@@ -555,7 +555,7 @@ Requires NO permissions:
|
|
555
555
|
|
556
556
|
|
557
557
|
### Example
|
558
|
-
|
558
|
+
```{"language":"ruby"}
|
559
559
|
# load the gem
|
560
560
|
require 'purecloudplatformclientv2'
|
561
561
|
# setup authorization
|
@@ -584,7 +584,7 @@ begin
|
|
584
584
|
rescue PureCloud::ApiError => e
|
585
585
|
puts "Exception when calling UsersApi->get_authorization_divisionspermitted_me: #{e}"
|
586
586
|
end
|
587
|
-
|
587
|
+
```
|
588
588
|
|
589
589
|
### Parameters
|
590
590
|
|
@@ -608,7 +608,7 @@ Name | Type | Description | Notes
|
|
608
608
|
|
609
609
|
<a name="get_authorization_divisionspermitted_subject_id"></a>
|
610
610
|
|
611
|
-
##
|
611
|
+
## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
|
612
612
|
|
613
613
|
|
614
614
|
|
@@ -623,7 +623,7 @@ Requires NO permissions:
|
|
623
623
|
|
624
624
|
|
625
625
|
### Example
|
626
|
-
|
626
|
+
```{"language":"ruby"}
|
627
627
|
# load the gem
|
628
628
|
require 'purecloudplatformclientv2'
|
629
629
|
# setup authorization
|
@@ -654,7 +654,7 @@ begin
|
|
654
654
|
rescue PureCloud::ApiError => e
|
655
655
|
puts "Exception when calling UsersApi->get_authorization_divisionspermitted_subject_id: #{e}"
|
656
656
|
end
|
657
|
-
|
657
|
+
```
|
658
658
|
|
659
659
|
### Parameters
|
660
660
|
|
@@ -679,7 +679,7 @@ Name | Type | Description | Notes
|
|
679
679
|
|
680
680
|
<a name="get_authorization_subject"></a>
|
681
681
|
|
682
|
-
##
|
682
|
+
## [**AuthzSubject**](AuthzSubject.html) get_authorization_subject(subject_id)
|
683
683
|
|
684
684
|
|
685
685
|
|
@@ -695,7 +695,7 @@ Requires ANY permissions:
|
|
695
695
|
|
696
696
|
|
697
697
|
### Example
|
698
|
-
|
698
|
+
```{"language":"ruby"}
|
699
699
|
# load the gem
|
700
700
|
require 'purecloudplatformclientv2'
|
701
701
|
# setup authorization
|
@@ -721,7 +721,7 @@ begin
|
|
721
721
|
rescue PureCloud::ApiError => e
|
722
722
|
puts "Exception when calling UsersApi->get_authorization_subject: #{e}"
|
723
723
|
end
|
724
|
-
|
724
|
+
```
|
725
725
|
|
726
726
|
### Parameters
|
727
727
|
|
@@ -744,7 +744,7 @@ Name | Type | Description | Notes
|
|
744
744
|
|
745
745
|
<a name="get_authorization_subjects_me"></a>
|
746
746
|
|
747
|
-
##
|
747
|
+
## [**AuthzSubject**](AuthzSubject.html) get_authorization_subjects_me
|
748
748
|
|
749
749
|
|
750
750
|
|
@@ -759,7 +759,7 @@ Requires NO permissions:
|
|
759
759
|
|
760
760
|
|
761
761
|
### Example
|
762
|
-
|
762
|
+
```{"language":"ruby"}
|
763
763
|
# load the gem
|
764
764
|
require 'purecloudplatformclientv2'
|
765
765
|
# setup authorization
|
@@ -782,7 +782,7 @@ begin
|
|
782
782
|
rescue PureCloud::ApiError => e
|
783
783
|
puts "Exception when calling UsersApi->get_authorization_subjects_me: #{e}"
|
784
784
|
end
|
785
|
-
|
785
|
+
```
|
786
786
|
|
787
787
|
### Parameters
|
788
788
|
This endpoint does not need any parameter.
|
@@ -802,7 +802,7 @@ This endpoint does not need any parameter.
|
|
802
802
|
|
803
803
|
<a name="get_fieldconfig"></a>
|
804
804
|
|
805
|
-
##
|
805
|
+
## [**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
|
806
806
|
|
807
807
|
|
808
808
|
|
@@ -817,7 +817,7 @@ Requires NO permissions:
|
|
817
817
|
|
818
818
|
|
819
819
|
### Example
|
820
|
-
|
820
|
+
```{"language":"ruby"}
|
821
821
|
# load the gem
|
822
822
|
require 'purecloudplatformclientv2'
|
823
823
|
# setup authorization
|
@@ -843,7 +843,7 @@ begin
|
|
843
843
|
rescue PureCloud::ApiError => e
|
844
844
|
puts "Exception when calling UsersApi->get_fieldconfig: #{e}"
|
845
845
|
end
|
846
|
-
|
846
|
+
```
|
847
847
|
|
848
848
|
### Parameters
|
849
849
|
|
@@ -866,7 +866,7 @@ Name | Type | Description | Notes
|
|
866
866
|
|
867
867
|
<a name="get_profiles_users"></a>
|
868
868
|
|
869
|
-
##
|
869
|
+
## [**UserProfileEntityListing**](UserProfileEntityListing.html) get_profiles_users(opts)
|
870
870
|
|
871
871
|
|
872
872
|
|
@@ -881,7 +881,7 @@ Requires NO permissions:
|
|
881
881
|
|
882
882
|
|
883
883
|
### Example
|
884
|
-
|
884
|
+
```{"language":"ruby"}
|
885
885
|
# load the gem
|
886
886
|
require 'purecloudplatformclientv2'
|
887
887
|
# setup authorization
|
@@ -914,7 +914,7 @@ begin
|
|
914
914
|
rescue PureCloud::ApiError => e
|
915
915
|
puts "Exception when calling UsersApi->get_profiles_users: #{e}"
|
916
916
|
end
|
917
|
-
|
917
|
+
```
|
918
918
|
|
919
919
|
### Parameters
|
920
920
|
|
@@ -943,7 +943,7 @@ Name | Type | Description | Notes
|
|
943
943
|
|
944
944
|
<a name="get_user"></a>
|
945
945
|
|
946
|
-
##
|
946
|
+
## [**User**](User.html) get_user(user_id, opts)
|
947
947
|
|
948
948
|
|
949
949
|
|
@@ -958,7 +958,7 @@ Requires NO permissions:
|
|
958
958
|
|
959
959
|
|
960
960
|
### Example
|
961
|
-
|
961
|
+
```{"language":"ruby"}
|
962
962
|
# load the gem
|
963
963
|
require 'purecloudplatformclientv2'
|
964
964
|
# setup authorization
|
@@ -988,7 +988,7 @@ begin
|
|
988
988
|
rescue PureCloud::ApiError => e
|
989
989
|
puts "Exception when calling UsersApi->get_user: #{e}"
|
990
990
|
end
|
991
|
-
|
991
|
+
```
|
992
992
|
|
993
993
|
### Parameters
|
994
994
|
|
@@ -1013,7 +1013,7 @@ Name | Type | Description | Notes
|
|
1013
1013
|
|
1014
1014
|
<a name="get_user_adjacents"></a>
|
1015
1015
|
|
1016
|
-
##
|
1016
|
+
## [**Adjacents**](Adjacents.html) get_user_adjacents(user_id, opts)
|
1017
1017
|
|
1018
1018
|
|
1019
1019
|
|
@@ -1028,7 +1028,7 @@ Requires NO permissions:
|
|
1028
1028
|
|
1029
1029
|
|
1030
1030
|
### Example
|
1031
|
-
|
1031
|
+
```{"language":"ruby"}
|
1032
1032
|
# load the gem
|
1033
1033
|
require 'purecloudplatformclientv2'
|
1034
1034
|
# setup authorization
|
@@ -1057,7 +1057,7 @@ begin
|
|
1057
1057
|
rescue PureCloud::ApiError => e
|
1058
1058
|
puts "Exception when calling UsersApi->get_user_adjacents: #{e}"
|
1059
1059
|
end
|
1060
|
-
|
1060
|
+
```
|
1061
1061
|
|
1062
1062
|
### Parameters
|
1063
1063
|
|
@@ -1081,7 +1081,7 @@ Name | Type | Description | Notes
|
|
1081
1081
|
|
1082
1082
|
<a name="get_user_callforwarding"></a>
|
1083
1083
|
|
1084
|
-
##
|
1084
|
+
## [**CallForwarding**](CallForwarding.html) get_user_callforwarding(user_id)
|
1085
1085
|
|
1086
1086
|
|
1087
1087
|
|
@@ -1096,7 +1096,7 @@ Requires NO permissions:
|
|
1096
1096
|
|
1097
1097
|
|
1098
1098
|
### Example
|
1099
|
-
|
1099
|
+
```{"language":"ruby"}
|
1100
1100
|
# load the gem
|
1101
1101
|
require 'purecloudplatformclientv2'
|
1102
1102
|
# setup authorization
|
@@ -1122,7 +1122,7 @@ begin
|
|
1122
1122
|
rescue PureCloud::ApiError => e
|
1123
1123
|
puts "Exception when calling UsersApi->get_user_callforwarding: #{e}"
|
1124
1124
|
end
|
1125
|
-
|
1125
|
+
```
|
1126
1126
|
|
1127
1127
|
### Parameters
|
1128
1128
|
|
@@ -1145,7 +1145,7 @@ Name | Type | Description | Notes
|
|
1145
1145
|
|
1146
1146
|
<a name="get_user_directreports"></a>
|
1147
1147
|
|
1148
|
-
##
|
1148
|
+
## [**Array<User>**](User.html) get_user_directreports(user_id, opts)
|
1149
1149
|
|
1150
1150
|
|
1151
1151
|
|
@@ -1160,7 +1160,7 @@ Requires NO permissions:
|
|
1160
1160
|
|
1161
1161
|
|
1162
1162
|
### Example
|
1163
|
-
|
1163
|
+
```{"language":"ruby"}
|
1164
1164
|
# load the gem
|
1165
1165
|
require 'purecloudplatformclientv2'
|
1166
1166
|
# setup authorization
|
@@ -1189,7 +1189,7 @@ begin
|
|
1189
1189
|
rescue PureCloud::ApiError => e
|
1190
1190
|
puts "Exception when calling UsersApi->get_user_directreports: #{e}"
|
1191
1191
|
end
|
1192
|
-
|
1192
|
+
```
|
1193
1193
|
|
1194
1194
|
### Parameters
|
1195
1195
|
|
@@ -1213,7 +1213,7 @@ Name | Type | Description | Notes
|
|
1213
1213
|
|
1214
1214
|
<a name="get_user_favorites"></a>
|
1215
1215
|
|
1216
|
-
##
|
1216
|
+
## [**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts)
|
1217
1217
|
|
1218
1218
|
|
1219
1219
|
|
@@ -1228,7 +1228,7 @@ Requires NO permissions:
|
|
1228
1228
|
|
1229
1229
|
|
1230
1230
|
### Example
|
1231
|
-
|
1231
|
+
```{"language":"ruby"}
|
1232
1232
|
# load the gem
|
1233
1233
|
require 'purecloudplatformclientv2'
|
1234
1234
|
# setup authorization
|
@@ -1260,7 +1260,7 @@ begin
|
|
1260
1260
|
rescue PureCloud::ApiError => e
|
1261
1261
|
puts "Exception when calling UsersApi->get_user_favorites: #{e}"
|
1262
1262
|
end
|
1263
|
-
|
1263
|
+
```
|
1264
1264
|
|
1265
1265
|
### Parameters
|
1266
1266
|
|
@@ -1287,7 +1287,7 @@ Name | Type | Description | Notes
|
|
1287
1287
|
|
1288
1288
|
<a name="get_user_geolocation"></a>
|
1289
1289
|
|
1290
|
-
##
|
1290
|
+
## [**Geolocation**](Geolocation.html) get_user_geolocation(user_id, client_id)
|
1291
1291
|
|
1292
1292
|
|
1293
1293
|
|
@@ -1302,7 +1302,7 @@ Requires NO permissions:
|
|
1302
1302
|
|
1303
1303
|
|
1304
1304
|
### Example
|
1305
|
-
|
1305
|
+
```{"language":"ruby"}
|
1306
1306
|
# load the gem
|
1307
1307
|
require 'purecloudplatformclientv2'
|
1308
1308
|
# setup authorization
|
@@ -1330,7 +1330,7 @@ begin
|
|
1330
1330
|
rescue PureCloud::ApiError => e
|
1331
1331
|
puts "Exception when calling UsersApi->get_user_geolocation: #{e}"
|
1332
1332
|
end
|
1333
|
-
|
1333
|
+
```
|
1334
1334
|
|
1335
1335
|
### Parameters
|
1336
1336
|
|
@@ -1354,7 +1354,7 @@ Name | Type | Description | Notes
|
|
1354
1354
|
|
1355
1355
|
<a name="get_user_outofoffice"></a>
|
1356
1356
|
|
1357
|
-
##
|
1357
|
+
## [**OutOfOffice**](OutOfOffice.html) get_user_outofoffice(user_id)
|
1358
1358
|
|
1359
1359
|
|
1360
1360
|
|
@@ -1369,7 +1369,7 @@ Requires NO permissions:
|
|
1369
1369
|
|
1370
1370
|
|
1371
1371
|
### Example
|
1372
|
-
|
1372
|
+
```{"language":"ruby"}
|
1373
1373
|
# load the gem
|
1374
1374
|
require 'purecloudplatformclientv2'
|
1375
1375
|
# setup authorization
|
@@ -1395,7 +1395,7 @@ begin
|
|
1395
1395
|
rescue PureCloud::ApiError => e
|
1396
1396
|
puts "Exception when calling UsersApi->get_user_outofoffice: #{e}"
|
1397
1397
|
end
|
1398
|
-
|
1398
|
+
```
|
1399
1399
|
|
1400
1400
|
### Parameters
|
1401
1401
|
|
@@ -1418,7 +1418,7 @@ Name | Type | Description | Notes
|
|
1418
1418
|
|
1419
1419
|
<a name="get_user_profile"></a>
|
1420
1420
|
|
1421
|
-
##
|
1421
|
+
## [**UserProfile**](UserProfile.html) get_user_profile(user_id, opts)
|
1422
1422
|
|
1423
1423
|
|
1424
1424
|
|
@@ -1433,7 +1433,7 @@ Requires NO permissions:
|
|
1433
1433
|
|
1434
1434
|
|
1435
1435
|
### Example
|
1436
|
-
|
1436
|
+
```{"language":"ruby"}
|
1437
1437
|
# load the gem
|
1438
1438
|
require 'purecloudplatformclientv2'
|
1439
1439
|
# setup authorization
|
@@ -1462,7 +1462,7 @@ begin
|
|
1462
1462
|
rescue PureCloud::ApiError => e
|
1463
1463
|
puts "Exception when calling UsersApi->get_user_profile: #{e}"
|
1464
1464
|
end
|
1465
|
-
|
1465
|
+
```
|
1466
1466
|
|
1467
1467
|
### Parameters
|
1468
1468
|
|
@@ -1486,7 +1486,7 @@ Name | Type | Description | Notes
|
|
1486
1486
|
|
1487
1487
|
<a name="get_user_profileskills"></a>
|
1488
1488
|
|
1489
|
-
##
|
1489
|
+
## Array<String>** get_user_profileskills(user_id)
|
1490
1490
|
|
1491
1491
|
|
1492
1492
|
|
@@ -1502,7 +1502,7 @@ Requires ANY permissions:
|
|
1502
1502
|
|
1503
1503
|
|
1504
1504
|
### Example
|
1505
|
-
|
1505
|
+
```{"language":"ruby"}
|
1506
1506
|
# load the gem
|
1507
1507
|
require 'purecloudplatformclientv2'
|
1508
1508
|
# setup authorization
|
@@ -1528,7 +1528,7 @@ begin
|
|
1528
1528
|
rescue PureCloud::ApiError => e
|
1529
1529
|
puts "Exception when calling UsersApi->get_user_profileskills: #{e}"
|
1530
1530
|
end
|
1531
|
-
|
1531
|
+
```
|
1532
1532
|
|
1533
1533
|
### Parameters
|
1534
1534
|
|
@@ -1551,7 +1551,7 @@ Name | Type | Description | Notes
|
|
1551
1551
|
|
1552
1552
|
<a name="get_user_queues"></a>
|
1553
1553
|
|
1554
|
-
##
|
1554
|
+
## [**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_queues(user_id, opts)
|
1555
1555
|
|
1556
1556
|
|
1557
1557
|
|
@@ -1567,7 +1567,7 @@ Requires ANY permissions:
|
|
1567
1567
|
|
1568
1568
|
|
1569
1569
|
### Example
|
1570
|
-
|
1570
|
+
```{"language":"ruby"}
|
1571
1571
|
# load the gem
|
1572
1572
|
require 'purecloudplatformclientv2'
|
1573
1573
|
# setup authorization
|
@@ -1599,7 +1599,7 @@ begin
|
|
1599
1599
|
rescue PureCloud::ApiError => e
|
1600
1600
|
puts "Exception when calling UsersApi->get_user_queues: #{e}"
|
1601
1601
|
end
|
1602
|
-
|
1602
|
+
```
|
1603
1603
|
|
1604
1604
|
### Parameters
|
1605
1605
|
|
@@ -1626,7 +1626,7 @@ Name | Type | Description | Notes
|
|
1626
1626
|
|
1627
1627
|
<a name="get_user_roles"></a>
|
1628
1628
|
|
1629
|
-
##
|
1629
|
+
## [**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
|
1630
1630
|
|
1631
1631
|
|
1632
1632
|
|
@@ -1642,7 +1642,7 @@ Requires ANY permissions:
|
|
1642
1642
|
|
1643
1643
|
|
1644
1644
|
### Example
|
1645
|
-
|
1645
|
+
```{"language":"ruby"}
|
1646
1646
|
# load the gem
|
1647
1647
|
require 'purecloudplatformclientv2'
|
1648
1648
|
# setup authorization
|
@@ -1668,7 +1668,7 @@ begin
|
|
1668
1668
|
rescue PureCloud::ApiError => e
|
1669
1669
|
puts "Exception when calling UsersApi->get_user_roles: #{e}"
|
1670
1670
|
end
|
1671
|
-
|
1671
|
+
```
|
1672
1672
|
|
1673
1673
|
### Parameters
|
1674
1674
|
|
@@ -1691,7 +1691,7 @@ Name | Type | Description | Notes
|
|
1691
1691
|
|
1692
1692
|
<a name="get_user_routinglanguages"></a>
|
1693
1693
|
|
1694
|
-
##
|
1694
|
+
## [**UserLanguageEntityListing**](UserLanguageEntityListing.html) get_user_routinglanguages(user_id, opts)
|
1695
1695
|
|
1696
1696
|
|
1697
1697
|
|
@@ -1706,7 +1706,7 @@ Requires NO permissions:
|
|
1706
1706
|
|
1707
1707
|
|
1708
1708
|
### Example
|
1709
|
-
|
1709
|
+
```{"language":"ruby"}
|
1710
1710
|
# load the gem
|
1711
1711
|
require 'purecloudplatformclientv2'
|
1712
1712
|
# setup authorization
|
@@ -1737,7 +1737,7 @@ begin
|
|
1737
1737
|
rescue PureCloud::ApiError => e
|
1738
1738
|
puts "Exception when calling UsersApi->get_user_routinglanguages: #{e}"
|
1739
1739
|
end
|
1740
|
-
|
1740
|
+
```
|
1741
1741
|
|
1742
1742
|
### Parameters
|
1743
1743
|
|
@@ -1763,7 +1763,7 @@ Name | Type | Description | Notes
|
|
1763
1763
|
|
1764
1764
|
<a name="get_user_routingskills"></a>
|
1765
1765
|
|
1766
|
-
##
|
1766
|
+
## [**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_routingskills(user_id, opts)
|
1767
1767
|
|
1768
1768
|
|
1769
1769
|
|
@@ -1778,7 +1778,7 @@ Requires NO permissions:
|
|
1778
1778
|
|
1779
1779
|
|
1780
1780
|
### Example
|
1781
|
-
|
1781
|
+
```{"language":"ruby"}
|
1782
1782
|
# load the gem
|
1783
1783
|
require 'purecloudplatformclientv2'
|
1784
1784
|
# setup authorization
|
@@ -1809,7 +1809,7 @@ begin
|
|
1809
1809
|
rescue PureCloud::ApiError => e
|
1810
1810
|
puts "Exception when calling UsersApi->get_user_routingskills: #{e}"
|
1811
1811
|
end
|
1812
|
-
|
1812
|
+
```
|
1813
1813
|
|
1814
1814
|
### Parameters
|
1815
1815
|
|
@@ -1835,7 +1835,7 @@ Name | Type | Description | Notes
|
|
1835
1835
|
|
1836
1836
|
<a name="get_user_routingstatus"></a>
|
1837
1837
|
|
1838
|
-
##
|
1838
|
+
## [**RoutingStatus**](RoutingStatus.html) get_user_routingstatus(user_id)
|
1839
1839
|
|
1840
1840
|
|
1841
1841
|
|
@@ -1850,7 +1850,7 @@ Requires NO permissions:
|
|
1850
1850
|
|
1851
1851
|
|
1852
1852
|
### Example
|
1853
|
-
|
1853
|
+
```{"language":"ruby"}
|
1854
1854
|
# load the gem
|
1855
1855
|
require 'purecloudplatformclientv2'
|
1856
1856
|
# setup authorization
|
@@ -1876,7 +1876,7 @@ begin
|
|
1876
1876
|
rescue PureCloud::ApiError => e
|
1877
1877
|
puts "Exception when calling UsersApi->get_user_routingstatus: #{e}"
|
1878
1878
|
end
|
1879
|
-
|
1879
|
+
```
|
1880
1880
|
|
1881
1881
|
### Parameters
|
1882
1882
|
|
@@ -1899,7 +1899,7 @@ Name | Type | Description | Notes
|
|
1899
1899
|
|
1900
1900
|
<a name="get_user_station"></a>
|
1901
1901
|
|
1902
|
-
##
|
1902
|
+
## [**UserStations**](UserStations.html) get_user_station(user_id)
|
1903
1903
|
|
1904
1904
|
|
1905
1905
|
|
@@ -1914,7 +1914,7 @@ Requires NO permissions:
|
|
1914
1914
|
|
1915
1915
|
|
1916
1916
|
### Example
|
1917
|
-
|
1917
|
+
```{"language":"ruby"}
|
1918
1918
|
# load the gem
|
1919
1919
|
require 'purecloudplatformclientv2'
|
1920
1920
|
# setup authorization
|
@@ -1940,7 +1940,7 @@ begin
|
|
1940
1940
|
rescue PureCloud::ApiError => e
|
1941
1941
|
puts "Exception when calling UsersApi->get_user_station: #{e}"
|
1942
1942
|
end
|
1943
|
-
|
1943
|
+
```
|
1944
1944
|
|
1945
1945
|
### Parameters
|
1946
1946
|
|
@@ -1963,7 +1963,7 @@ Name | Type | Description | Notes
|
|
1963
1963
|
|
1964
1964
|
<a name="get_user_superiors"></a>
|
1965
1965
|
|
1966
|
-
##
|
1966
|
+
## [**Array<User>**](User.html) get_user_superiors(user_id, opts)
|
1967
1967
|
|
1968
1968
|
|
1969
1969
|
|
@@ -1978,7 +1978,7 @@ Requires NO permissions:
|
|
1978
1978
|
|
1979
1979
|
|
1980
1980
|
### Example
|
1981
|
-
|
1981
|
+
```{"language":"ruby"}
|
1982
1982
|
# load the gem
|
1983
1983
|
require 'purecloudplatformclientv2'
|
1984
1984
|
# setup authorization
|
@@ -2007,7 +2007,7 @@ begin
|
|
2007
2007
|
rescue PureCloud::ApiError => e
|
2008
2008
|
puts "Exception when calling UsersApi->get_user_superiors: #{e}"
|
2009
2009
|
end
|
2010
|
-
|
2010
|
+
```
|
2011
2011
|
|
2012
2012
|
### Parameters
|
2013
2013
|
|
@@ -2031,7 +2031,7 @@ Name | Type | Description | Notes
|
|
2031
2031
|
|
2032
2032
|
<a name="get_user_trustors"></a>
|
2033
2033
|
|
2034
|
-
##
|
2034
|
+
## [**TrustorEntityListing**](TrustorEntityListing.html) get_user_trustors(user_id, opts)
|
2035
2035
|
|
2036
2036
|
|
2037
2037
|
|
@@ -2047,7 +2047,7 @@ Requires ANY permissions:
|
|
2047
2047
|
|
2048
2048
|
|
2049
2049
|
### Example
|
2050
|
-
|
2050
|
+
```{"language":"ruby"}
|
2051
2051
|
# load the gem
|
2052
2052
|
require 'purecloudplatformclientv2'
|
2053
2053
|
# setup authorization
|
@@ -2077,7 +2077,7 @@ begin
|
|
2077
2077
|
rescue PureCloud::ApiError => e
|
2078
2078
|
puts "Exception when calling UsersApi->get_user_trustors: #{e}"
|
2079
2079
|
end
|
2080
|
-
|
2080
|
+
```
|
2081
2081
|
|
2082
2082
|
### Parameters
|
2083
2083
|
|
@@ -2102,7 +2102,7 @@ Name | Type | Description | Notes
|
|
2102
2102
|
|
2103
2103
|
<a name="get_users"></a>
|
2104
2104
|
|
2105
|
-
##
|
2105
|
+
## [**UserEntityListing**](UserEntityListing.html) get_users(opts)
|
2106
2106
|
|
2107
2107
|
|
2108
2108
|
|
@@ -2117,7 +2117,7 @@ Requires NO permissions:
|
|
2117
2117
|
|
2118
2118
|
|
2119
2119
|
### Example
|
2120
|
-
|
2120
|
+
```{"language":"ruby"}
|
2121
2121
|
# load the gem
|
2122
2122
|
require 'purecloudplatformclientv2'
|
2123
2123
|
# setup authorization
|
@@ -2149,7 +2149,7 @@ begin
|
|
2149
2149
|
rescue PureCloud::ApiError => e
|
2150
2150
|
puts "Exception when calling UsersApi->get_users: #{e}"
|
2151
2151
|
end
|
2152
|
-
|
2152
|
+
```
|
2153
2153
|
|
2154
2154
|
### Parameters
|
2155
2155
|
|
@@ -2177,7 +2177,7 @@ Name | Type | Description | Notes
|
|
2177
2177
|
|
2178
2178
|
<a name="get_users_me"></a>
|
2179
2179
|
|
2180
|
-
##
|
2180
|
+
## [**UserMe**](UserMe.html) get_users_me(opts)
|
2181
2181
|
|
2182
2182
|
|
2183
2183
|
|
@@ -2192,7 +2192,7 @@ Requires NO permissions:
|
|
2192
2192
|
|
2193
2193
|
|
2194
2194
|
### Example
|
2195
|
-
|
2195
|
+
```{"language":"ruby"}
|
2196
2196
|
# load the gem
|
2197
2197
|
require 'purecloudplatformclientv2'
|
2198
2198
|
# setup authorization
|
@@ -2219,7 +2219,7 @@ begin
|
|
2219
2219
|
rescue PureCloud::ApiError => e
|
2220
2220
|
puts "Exception when calling UsersApi->get_users_me: #{e}"
|
2221
2221
|
end
|
2222
|
-
|
2222
|
+
```
|
2223
2223
|
|
2224
2224
|
### Parameters
|
2225
2225
|
|
@@ -2242,7 +2242,7 @@ Name | Type | Description | Notes
|
|
2242
2242
|
|
2243
2243
|
<a name="get_users_search"></a>
|
2244
2244
|
|
2245
|
-
##
|
2245
|
+
## [**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
|
2246
2246
|
|
2247
2247
|
|
2248
2248
|
|
@@ -2257,7 +2257,7 @@ Requires NO permissions:
|
|
2257
2257
|
|
2258
2258
|
|
2259
2259
|
### Example
|
2260
|
-
|
2260
|
+
```{"language":"ruby"}
|
2261
2261
|
# load the gem
|
2262
2262
|
require 'purecloudplatformclientv2'
|
2263
2263
|
# setup authorization
|
@@ -2286,7 +2286,7 @@ begin
|
|
2286
2286
|
rescue PureCloud::ApiError => e
|
2287
2287
|
puts "Exception when calling UsersApi->get_users_search: #{e}"
|
2288
2288
|
end
|
2289
|
-
|
2289
|
+
```
|
2290
2290
|
|
2291
2291
|
### Parameters
|
2292
2292
|
|
@@ -2310,7 +2310,7 @@ Name | Type | Description | Notes
|
|
2310
2310
|
|
2311
2311
|
<a name="patch_user"></a>
|
2312
2312
|
|
2313
|
-
##
|
2313
|
+
## [**User**](User.html) patch_user(user_id, body)
|
2314
2314
|
|
2315
2315
|
|
2316
2316
|
|
@@ -2328,7 +2328,7 @@ Requires ANY permissions:
|
|
2328
2328
|
|
2329
2329
|
|
2330
2330
|
### Example
|
2331
|
-
|
2331
|
+
```{"language":"ruby"}
|
2332
2332
|
# load the gem
|
2333
2333
|
require 'purecloudplatformclientv2'
|
2334
2334
|
# setup authorization
|
@@ -2356,7 +2356,7 @@ begin
|
|
2356
2356
|
rescue PureCloud::ApiError => e
|
2357
2357
|
puts "Exception when calling UsersApi->patch_user: #{e}"
|
2358
2358
|
end
|
2359
|
-
|
2359
|
+
```
|
2360
2360
|
|
2361
2361
|
### Parameters
|
2362
2362
|
|
@@ -2380,7 +2380,7 @@ Name | Type | Description | Notes
|
|
2380
2380
|
|
2381
2381
|
<a name="patch_user_callforwarding"></a>
|
2382
2382
|
|
2383
|
-
##
|
2383
|
+
## [**CallForwarding**](CallForwarding.html) patch_user_callforwarding(user_id, body)
|
2384
2384
|
|
2385
2385
|
|
2386
2386
|
|
@@ -2395,7 +2395,7 @@ Requires NO permissions:
|
|
2395
2395
|
|
2396
2396
|
|
2397
2397
|
### Example
|
2398
|
-
|
2398
|
+
```{"language":"ruby"}
|
2399
2399
|
# load the gem
|
2400
2400
|
require 'purecloudplatformclientv2'
|
2401
2401
|
# setup authorization
|
@@ -2423,7 +2423,7 @@ begin
|
|
2423
2423
|
rescue PureCloud::ApiError => e
|
2424
2424
|
puts "Exception when calling UsersApi->patch_user_callforwarding: #{e}"
|
2425
2425
|
end
|
2426
|
-
|
2426
|
+
```
|
2427
2427
|
|
2428
2428
|
### Parameters
|
2429
2429
|
|
@@ -2447,7 +2447,7 @@ Name | Type | Description | Notes
|
|
2447
2447
|
|
2448
2448
|
<a name="patch_user_geolocation"></a>
|
2449
2449
|
|
2450
|
-
##
|
2450
|
+
## [**Geolocation**](Geolocation.html) patch_user_geolocation(user_id, client_id, body)
|
2451
2451
|
|
2452
2452
|
|
2453
2453
|
|
@@ -2462,7 +2462,7 @@ Requires NO permissions:
|
|
2462
2462
|
|
2463
2463
|
|
2464
2464
|
### Example
|
2465
|
-
|
2465
|
+
```{"language":"ruby"}
|
2466
2466
|
# load the gem
|
2467
2467
|
require 'purecloudplatformclientv2'
|
2468
2468
|
# setup authorization
|
@@ -2492,7 +2492,7 @@ begin
|
|
2492
2492
|
rescue PureCloud::ApiError => e
|
2493
2493
|
puts "Exception when calling UsersApi->patch_user_geolocation: #{e}"
|
2494
2494
|
end
|
2495
|
-
|
2495
|
+
```
|
2496
2496
|
|
2497
2497
|
### Parameters
|
2498
2498
|
|
@@ -2517,7 +2517,7 @@ Name | Type | Description | Notes
|
|
2517
2517
|
|
2518
2518
|
<a name="patch_user_queue"></a>
|
2519
2519
|
|
2520
|
-
##
|
2520
|
+
## [**UserQueue**](UserQueue.html) patch_user_queue(queue_id, user_id, body)
|
2521
2521
|
|
2522
2522
|
|
2523
2523
|
|
@@ -2533,7 +2533,7 @@ Requires ANY permissions:
|
|
2533
2533
|
|
2534
2534
|
|
2535
2535
|
### Example
|
2536
|
-
|
2536
|
+
```{"language":"ruby"}
|
2537
2537
|
# load the gem
|
2538
2538
|
require 'purecloudplatformclientv2'
|
2539
2539
|
# setup authorization
|
@@ -2563,7 +2563,7 @@ begin
|
|
2563
2563
|
rescue PureCloud::ApiError => e
|
2564
2564
|
puts "Exception when calling UsersApi->patch_user_queue: #{e}"
|
2565
2565
|
end
|
2566
|
-
|
2566
|
+
```
|
2567
2567
|
|
2568
2568
|
### Parameters
|
2569
2569
|
|
@@ -2588,7 +2588,7 @@ Name | Type | Description | Notes
|
|
2588
2588
|
|
2589
2589
|
<a name="patch_user_queues"></a>
|
2590
2590
|
|
2591
|
-
##
|
2591
|
+
## [**UserQueueEntityListing**](UserQueueEntityListing.html) patch_user_queues(user_id, body, opts)
|
2592
2592
|
|
2593
2593
|
|
2594
2594
|
|
@@ -2604,7 +2604,7 @@ Requires ANY permissions:
|
|
2604
2604
|
|
2605
2605
|
|
2606
2606
|
### Example
|
2607
|
-
|
2607
|
+
```{"language":"ruby"}
|
2608
2608
|
# load the gem
|
2609
2609
|
require 'purecloudplatformclientv2'
|
2610
2610
|
# setup authorization
|
@@ -2635,7 +2635,7 @@ begin
|
|
2635
2635
|
rescue PureCloud::ApiError => e
|
2636
2636
|
puts "Exception when calling UsersApi->patch_user_queues: #{e}"
|
2637
2637
|
end
|
2638
|
-
|
2638
|
+
```
|
2639
2639
|
|
2640
2640
|
### Parameters
|
2641
2641
|
|
@@ -2660,7 +2660,7 @@ Name | Type | Description | Notes
|
|
2660
2660
|
|
2661
2661
|
<a name="patch_user_routinglanguage"></a>
|
2662
2662
|
|
2663
|
-
##
|
2663
|
+
## [**UserRoutingLanguage**](UserRoutingLanguage.html) patch_user_routinglanguage(user_id, language_id, body)
|
2664
2664
|
|
2665
2665
|
|
2666
2666
|
|
@@ -2677,7 +2677,7 @@ Requires ANY permissions:
|
|
2677
2677
|
|
2678
2678
|
|
2679
2679
|
### Example
|
2680
|
-
|
2680
|
+
```{"language":"ruby"}
|
2681
2681
|
# load the gem
|
2682
2682
|
require 'purecloudplatformclientv2'
|
2683
2683
|
# setup authorization
|
@@ -2707,7 +2707,7 @@ begin
|
|
2707
2707
|
rescue PureCloud::ApiError => e
|
2708
2708
|
puts "Exception when calling UsersApi->patch_user_routinglanguage: #{e}"
|
2709
2709
|
end
|
2710
|
-
|
2710
|
+
```
|
2711
2711
|
|
2712
2712
|
### Parameters
|
2713
2713
|
|
@@ -2732,7 +2732,7 @@ Name | Type | Description | Notes
|
|
2732
2732
|
|
2733
2733
|
<a name="patch_user_routinglanguages_bulk"></a>
|
2734
2734
|
|
2735
|
-
##
|
2735
|
+
## [**UserLanguageEntityListing**](UserLanguageEntityListing.html) patch_user_routinglanguages_bulk(user_id, body)
|
2736
2736
|
|
2737
2737
|
|
2738
2738
|
|
@@ -2749,7 +2749,7 @@ Requires ANY permissions:
|
|
2749
2749
|
|
2750
2750
|
|
2751
2751
|
### Example
|
2752
|
-
|
2752
|
+
```{"language":"ruby"}
|
2753
2753
|
# load the gem
|
2754
2754
|
require 'purecloudplatformclientv2'
|
2755
2755
|
# setup authorization
|
@@ -2777,7 +2777,7 @@ begin
|
|
2777
2777
|
rescue PureCloud::ApiError => e
|
2778
2778
|
puts "Exception when calling UsersApi->patch_user_routinglanguages_bulk: #{e}"
|
2779
2779
|
end
|
2780
|
-
|
2780
|
+
```
|
2781
2781
|
|
2782
2782
|
### Parameters
|
2783
2783
|
|
@@ -2801,7 +2801,7 @@ Name | Type | Description | Notes
|
|
2801
2801
|
|
2802
2802
|
<a name="patch_user_routingskills_bulk"></a>
|
2803
2803
|
|
2804
|
-
##
|
2804
|
+
## [**UserSkillEntityListing**](UserSkillEntityListing.html) patch_user_routingskills_bulk(user_id, body)
|
2805
2805
|
|
2806
2806
|
|
2807
2807
|
|
@@ -2818,7 +2818,7 @@ Requires ANY permissions:
|
|
2818
2818
|
|
2819
2819
|
|
2820
2820
|
### Example
|
2821
|
-
|
2821
|
+
```{"language":"ruby"}
|
2822
2822
|
# load the gem
|
2823
2823
|
require 'purecloudplatformclientv2'
|
2824
2824
|
# setup authorization
|
@@ -2846,7 +2846,7 @@ begin
|
|
2846
2846
|
rescue PureCloud::ApiError => e
|
2847
2847
|
puts "Exception when calling UsersApi->patch_user_routingskills_bulk: #{e}"
|
2848
2848
|
end
|
2849
|
-
|
2849
|
+
```
|
2850
2850
|
|
2851
2851
|
### Parameters
|
2852
2852
|
|
@@ -2870,7 +2870,7 @@ Name | Type | Description | Notes
|
|
2870
2870
|
|
2871
2871
|
<a name="patch_users_bulk"></a>
|
2872
2872
|
|
2873
|
-
##
|
2873
|
+
## [**UserEntityListing**](UserEntityListing.html) patch_users_bulk(body)
|
2874
2874
|
|
2875
2875
|
|
2876
2876
|
|
@@ -2889,7 +2889,7 @@ Requires ANY permissions:
|
|
2889
2889
|
|
2890
2890
|
|
2891
2891
|
### Example
|
2892
|
-
|
2892
|
+
```{"language":"ruby"}
|
2893
2893
|
# load the gem
|
2894
2894
|
require 'purecloudplatformclientv2'
|
2895
2895
|
# setup authorization
|
@@ -2915,7 +2915,7 @@ begin
|
|
2915
2915
|
rescue PureCloud::ApiError => e
|
2916
2916
|
puts "Exception when calling UsersApi->patch_users_bulk: #{e}"
|
2917
2917
|
end
|
2918
|
-
|
2918
|
+
```
|
2919
2919
|
|
2920
2920
|
### Parameters
|
2921
2921
|
|
@@ -2938,7 +2938,7 @@ Name | Type | Description | Notes
|
|
2938
2938
|
|
2939
2939
|
<a name="post_analytics_users_aggregates_query"></a>
|
2940
2940
|
|
2941
|
-
##
|
2941
|
+
## [**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
|
2942
2942
|
|
2943
2943
|
|
2944
2944
|
|
@@ -2954,7 +2954,7 @@ Requires ANY permissions:
|
|
2954
2954
|
|
2955
2955
|
|
2956
2956
|
### Example
|
2957
|
-
|
2957
|
+
```{"language":"ruby"}
|
2958
2958
|
# load the gem
|
2959
2959
|
require 'purecloudplatformclientv2'
|
2960
2960
|
# setup authorization
|
@@ -2980,7 +2980,7 @@ begin
|
|
2980
2980
|
rescue PureCloud::ApiError => e
|
2981
2981
|
puts "Exception when calling UsersApi->post_analytics_users_aggregates_query: #{e}"
|
2982
2982
|
end
|
2983
|
-
|
2983
|
+
```
|
2984
2984
|
|
2985
2985
|
### Parameters
|
2986
2986
|
|
@@ -3003,7 +3003,7 @@ Name | Type | Description | Notes
|
|
3003
3003
|
|
3004
3004
|
<a name="post_analytics_users_details_query"></a>
|
3005
3005
|
|
3006
|
-
##
|
3006
|
+
## [**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
|
3007
3007
|
|
3008
3008
|
|
3009
3009
|
|
@@ -3019,7 +3019,7 @@ Requires ANY permissions:
|
|
3019
3019
|
|
3020
3020
|
|
3021
3021
|
### Example
|
3022
|
-
|
3022
|
+
```{"language":"ruby"}
|
3023
3023
|
# load the gem
|
3024
3024
|
require 'purecloudplatformclientv2'
|
3025
3025
|
# setup authorization
|
@@ -3045,7 +3045,7 @@ begin
|
|
3045
3045
|
rescue PureCloud::ApiError => e
|
3046
3046
|
puts "Exception when calling UsersApi->post_analytics_users_details_query: #{e}"
|
3047
3047
|
end
|
3048
|
-
|
3048
|
+
```
|
3049
3049
|
|
3050
3050
|
### Parameters
|
3051
3051
|
|
@@ -3068,7 +3068,7 @@ Name | Type | Description | Notes
|
|
3068
3068
|
|
3069
3069
|
<a name="post_analytics_users_observations_query"></a>
|
3070
3070
|
|
3071
|
-
##
|
3071
|
+
## [**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
|
3072
3072
|
|
3073
3073
|
|
3074
3074
|
|
@@ -3084,7 +3084,7 @@ Requires ANY permissions:
|
|
3084
3084
|
|
3085
3085
|
|
3086
3086
|
### Example
|
3087
|
-
|
3087
|
+
```{"language":"ruby"}
|
3088
3088
|
# load the gem
|
3089
3089
|
require 'purecloudplatformclientv2'
|
3090
3090
|
# setup authorization
|
@@ -3110,7 +3110,7 @@ begin
|
|
3110
3110
|
rescue PureCloud::ApiError => e
|
3111
3111
|
puts "Exception when calling UsersApi->post_analytics_users_observations_query: #{e}"
|
3112
3112
|
end
|
3113
|
-
|
3113
|
+
```
|
3114
3114
|
|
3115
3115
|
### Parameters
|
3116
3116
|
|
@@ -3133,7 +3133,7 @@ Name | Type | Description | Notes
|
|
3133
3133
|
|
3134
3134
|
<a name="post_authorization_subject_division_role"></a>
|
3135
3135
|
|
3136
|
-
##
|
3136
|
+
## post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
|
3137
3137
|
|
3138
3138
|
|
3139
3139
|
|
@@ -3149,7 +3149,7 @@ Requires ANY permissions:
|
|
3149
3149
|
|
3150
3150
|
|
3151
3151
|
### Example
|
3152
|
-
|
3152
|
+
```{"language":"ruby"}
|
3153
3153
|
# load the gem
|
3154
3154
|
require 'purecloudplatformclientv2'
|
3155
3155
|
# setup authorization
|
@@ -3181,7 +3181,7 @@ begin
|
|
3181
3181
|
rescue PureCloud::ApiError => e
|
3182
3182
|
puts "Exception when calling UsersApi->post_authorization_subject_division_role: #{e}"
|
3183
3183
|
end
|
3184
|
-
|
3184
|
+
```
|
3185
3185
|
|
3186
3186
|
### Parameters
|
3187
3187
|
|
@@ -3207,7 +3207,7 @@ nil (empty response body)
|
|
3207
3207
|
|
3208
3208
|
<a name="post_user_invite"></a>
|
3209
3209
|
|
3210
|
-
##
|
3210
|
+
## post_user_invite(user_id, opts)
|
3211
3211
|
|
3212
3212
|
|
3213
3213
|
|
@@ -3225,7 +3225,7 @@ Requires ANY permissions:
|
|
3225
3225
|
|
3226
3226
|
|
3227
3227
|
### Example
|
3228
|
-
|
3228
|
+
```{"language":"ruby"}
|
3229
3229
|
# load the gem
|
3230
3230
|
require 'purecloudplatformclientv2'
|
3231
3231
|
# setup authorization
|
@@ -3253,7 +3253,7 @@ begin
|
|
3253
3253
|
rescue PureCloud::ApiError => e
|
3254
3254
|
puts "Exception when calling UsersApi->post_user_invite: #{e}"
|
3255
3255
|
end
|
3256
|
-
|
3256
|
+
```
|
3257
3257
|
|
3258
3258
|
### Parameters
|
3259
3259
|
|
@@ -3277,7 +3277,7 @@ nil (empty response body)
|
|
3277
3277
|
|
3278
3278
|
<a name="post_user_password"></a>
|
3279
3279
|
|
3280
|
-
##
|
3280
|
+
## post_user_password(user_id, body)
|
3281
3281
|
|
3282
3282
|
|
3283
3283
|
|
@@ -3294,7 +3294,7 @@ Requires ANY permissions:
|
|
3294
3294
|
|
3295
3295
|
|
3296
3296
|
### Example
|
3297
|
-
|
3297
|
+
```{"language":"ruby"}
|
3298
3298
|
# load the gem
|
3299
3299
|
require 'purecloudplatformclientv2'
|
3300
3300
|
# setup authorization
|
@@ -3321,7 +3321,7 @@ begin
|
|
3321
3321
|
rescue PureCloud::ApiError => e
|
3322
3322
|
puts "Exception when calling UsersApi->post_user_password: #{e}"
|
3323
3323
|
end
|
3324
|
-
|
3324
|
+
```
|
3325
3325
|
|
3326
3326
|
### Parameters
|
3327
3327
|
|
@@ -3345,7 +3345,7 @@ nil (empty response body)
|
|
3345
3345
|
|
3346
3346
|
<a name="post_user_routinglanguages"></a>
|
3347
3347
|
|
3348
|
-
##
|
3348
|
+
## [**UserRoutingLanguage**](UserRoutingLanguage.html) post_user_routinglanguages(user_id, body)
|
3349
3349
|
|
3350
3350
|
|
3351
3351
|
|
@@ -3362,7 +3362,7 @@ Requires ANY permissions:
|
|
3362
3362
|
|
3363
3363
|
|
3364
3364
|
### Example
|
3365
|
-
|
3365
|
+
```{"language":"ruby"}
|
3366
3366
|
# load the gem
|
3367
3367
|
require 'purecloudplatformclientv2'
|
3368
3368
|
# setup authorization
|
@@ -3390,7 +3390,7 @@ begin
|
|
3390
3390
|
rescue PureCloud::ApiError => e
|
3391
3391
|
puts "Exception when calling UsersApi->post_user_routinglanguages: #{e}"
|
3392
3392
|
end
|
3393
|
-
|
3393
|
+
```
|
3394
3394
|
|
3395
3395
|
### Parameters
|
3396
3396
|
|
@@ -3414,7 +3414,7 @@ Name | Type | Description | Notes
|
|
3414
3414
|
|
3415
3415
|
<a name="post_user_routingskills"></a>
|
3416
3416
|
|
3417
|
-
##
|
3417
|
+
## [**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)
|
3418
3418
|
|
3419
3419
|
|
3420
3420
|
|
@@ -3431,7 +3431,7 @@ Requires ANY permissions:
|
|
3431
3431
|
|
3432
3432
|
|
3433
3433
|
### Example
|
3434
|
-
|
3434
|
+
```{"language":"ruby"}
|
3435
3435
|
# load the gem
|
3436
3436
|
require 'purecloudplatformclientv2'
|
3437
3437
|
# setup authorization
|
@@ -3459,7 +3459,7 @@ begin
|
|
3459
3459
|
rescue PureCloud::ApiError => e
|
3460
3460
|
puts "Exception when calling UsersApi->post_user_routingskills: #{e}"
|
3461
3461
|
end
|
3462
|
-
|
3462
|
+
```
|
3463
3463
|
|
3464
3464
|
### Parameters
|
3465
3465
|
|
@@ -3483,7 +3483,7 @@ Name | Type | Description | Notes
|
|
3483
3483
|
|
3484
3484
|
<a name="post_users"></a>
|
3485
3485
|
|
3486
|
-
##
|
3486
|
+
## [**User**](User.html) post_users(body)
|
3487
3487
|
|
3488
3488
|
|
3489
3489
|
|
@@ -3499,7 +3499,7 @@ Requires ANY permissions:
|
|
3499
3499
|
|
3500
3500
|
|
3501
3501
|
### Example
|
3502
|
-
|
3502
|
+
```{"language":"ruby"}
|
3503
3503
|
# load the gem
|
3504
3504
|
require 'purecloudplatformclientv2'
|
3505
3505
|
# setup authorization
|
@@ -3525,7 +3525,7 @@ begin
|
|
3525
3525
|
rescue PureCloud::ApiError => e
|
3526
3526
|
puts "Exception when calling UsersApi->post_users: #{e}"
|
3527
3527
|
end
|
3528
|
-
|
3528
|
+
```
|
3529
3529
|
|
3530
3530
|
### Parameters
|
3531
3531
|
|
@@ -3548,7 +3548,7 @@ Name | Type | Description | Notes
|
|
3548
3548
|
|
3549
3549
|
<a name="post_users_me_password"></a>
|
3550
3550
|
|
3551
|
-
##
|
3551
|
+
## post_users_me_password(body)
|
3552
3552
|
|
3553
3553
|
|
3554
3554
|
|
@@ -3563,7 +3563,7 @@ Requires NO permissions:
|
|
3563
3563
|
|
3564
3564
|
|
3565
3565
|
### Example
|
3566
|
-
|
3566
|
+
```{"language":"ruby"}
|
3567
3567
|
# load the gem
|
3568
3568
|
require 'purecloudplatformclientv2'
|
3569
3569
|
# setup authorization
|
@@ -3588,7 +3588,7 @@ begin
|
|
3588
3588
|
rescue PureCloud::ApiError => e
|
3589
3589
|
puts "Exception when calling UsersApi->post_users_me_password: #{e}"
|
3590
3590
|
end
|
3591
|
-
|
3591
|
+
```
|
3592
3592
|
|
3593
3593
|
### Parameters
|
3594
3594
|
|
@@ -3611,7 +3611,7 @@ nil (empty response body)
|
|
3611
3611
|
|
3612
3612
|
<a name="post_users_search"></a>
|
3613
3613
|
|
3614
|
-
##
|
3614
|
+
## [**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
|
3615
3615
|
|
3616
3616
|
|
3617
3617
|
|
@@ -3626,7 +3626,7 @@ Requires NO permissions:
|
|
3626
3626
|
|
3627
3627
|
|
3628
3628
|
### Example
|
3629
|
-
|
3629
|
+
```{"language":"ruby"}
|
3630
3630
|
# load the gem
|
3631
3631
|
require 'purecloudplatformclientv2'
|
3632
3632
|
# setup authorization
|
@@ -3652,7 +3652,7 @@ begin
|
|
3652
3652
|
rescue PureCloud::ApiError => e
|
3653
3653
|
puts "Exception when calling UsersApi->post_users_search: #{e}"
|
3654
3654
|
end
|
3655
|
-
|
3655
|
+
```
|
3656
3656
|
|
3657
3657
|
### Parameters
|
3658
3658
|
|
@@ -3675,7 +3675,7 @@ Name | Type | Description | Notes
|
|
3675
3675
|
|
3676
3676
|
<a name="put_user_callforwarding"></a>
|
3677
3677
|
|
3678
|
-
##
|
3678
|
+
## [**CallForwarding**](CallForwarding.html) put_user_callforwarding(user_id, body)
|
3679
3679
|
|
3680
3680
|
|
3681
3681
|
|
@@ -3690,7 +3690,7 @@ Requires NO permissions:
|
|
3690
3690
|
|
3691
3691
|
|
3692
3692
|
### Example
|
3693
|
-
|
3693
|
+
```{"language":"ruby"}
|
3694
3694
|
# load the gem
|
3695
3695
|
require 'purecloudplatformclientv2'
|
3696
3696
|
# setup authorization
|
@@ -3718,7 +3718,7 @@ begin
|
|
3718
3718
|
rescue PureCloud::ApiError => e
|
3719
3719
|
puts "Exception when calling UsersApi->put_user_callforwarding: #{e}"
|
3720
3720
|
end
|
3721
|
-
|
3721
|
+
```
|
3722
3722
|
|
3723
3723
|
### Parameters
|
3724
3724
|
|
@@ -3742,7 +3742,7 @@ Name | Type | Description | Notes
|
|
3742
3742
|
|
3743
3743
|
<a name="put_user_outofoffice"></a>
|
3744
3744
|
|
3745
|
-
##
|
3745
|
+
## [**OutOfOffice**](OutOfOffice.html) put_user_outofoffice(user_id, body)
|
3746
3746
|
|
3747
3747
|
|
3748
3748
|
|
@@ -3757,7 +3757,7 @@ Requires NO permissions:
|
|
3757
3757
|
|
3758
3758
|
|
3759
3759
|
### Example
|
3760
|
-
|
3760
|
+
```{"language":"ruby"}
|
3761
3761
|
# load the gem
|
3762
3762
|
require 'purecloudplatformclientv2'
|
3763
3763
|
# setup authorization
|
@@ -3785,7 +3785,7 @@ begin
|
|
3785
3785
|
rescue PureCloud::ApiError => e
|
3786
3786
|
puts "Exception when calling UsersApi->put_user_outofoffice: #{e}"
|
3787
3787
|
end
|
3788
|
-
|
3788
|
+
```
|
3789
3789
|
|
3790
3790
|
### Parameters
|
3791
3791
|
|
@@ -3809,7 +3809,7 @@ Name | Type | Description | Notes
|
|
3809
3809
|
|
3810
3810
|
<a name="put_user_profileskills"></a>
|
3811
3811
|
|
3812
|
-
##
|
3812
|
+
## Array<String>** put_user_profileskills(user_id, body)
|
3813
3813
|
|
3814
3814
|
|
3815
3815
|
|
@@ -3828,7 +3828,7 @@ Requires ANY permissions:
|
|
3828
3828
|
|
3829
3829
|
|
3830
3830
|
### Example
|
3831
|
-
|
3831
|
+
```{"language":"ruby"}
|
3832
3832
|
# load the gem
|
3833
3833
|
require 'purecloudplatformclientv2'
|
3834
3834
|
# setup authorization
|
@@ -3856,7 +3856,7 @@ begin
|
|
3856
3856
|
rescue PureCloud::ApiError => e
|
3857
3857
|
puts "Exception when calling UsersApi->put_user_profileskills: #{e}"
|
3858
3858
|
end
|
3859
|
-
|
3859
|
+
```
|
3860
3860
|
|
3861
3861
|
### Parameters
|
3862
3862
|
|
@@ -3880,7 +3880,7 @@ Name | Type | Description | Notes
|
|
3880
3880
|
|
3881
3881
|
<a name="put_user_roles"></a>
|
3882
3882
|
|
3883
|
-
##
|
3883
|
+
## [**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
|
3884
3884
|
|
3885
3885
|
|
3886
3886
|
|
@@ -3898,7 +3898,7 @@ Requires ANY permissions:
|
|
3898
3898
|
|
3899
3899
|
|
3900
3900
|
### Example
|
3901
|
-
|
3901
|
+
```{"language":"ruby"}
|
3902
3902
|
# load the gem
|
3903
3903
|
require 'purecloudplatformclientv2'
|
3904
3904
|
# setup authorization
|
@@ -3926,7 +3926,7 @@ begin
|
|
3926
3926
|
rescue PureCloud::ApiError => e
|
3927
3927
|
puts "Exception when calling UsersApi->put_user_roles: #{e}"
|
3928
3928
|
end
|
3929
|
-
|
3929
|
+
```
|
3930
3930
|
|
3931
3931
|
### Parameters
|
3932
3932
|
|
@@ -3950,7 +3950,7 @@ Name | Type | Description | Notes
|
|
3950
3950
|
|
3951
3951
|
<a name="put_user_routingskill"></a>
|
3952
3952
|
|
3953
|
-
##
|
3953
|
+
## [**UserRoutingSkill**](UserRoutingSkill.html) put_user_routingskill(user_id, skill_id, body)
|
3954
3954
|
|
3955
3955
|
|
3956
3956
|
|
@@ -3967,7 +3967,7 @@ Requires ANY permissions:
|
|
3967
3967
|
|
3968
3968
|
|
3969
3969
|
### Example
|
3970
|
-
|
3970
|
+
```{"language":"ruby"}
|
3971
3971
|
# load the gem
|
3972
3972
|
require 'purecloudplatformclientv2'
|
3973
3973
|
# setup authorization
|
@@ -3997,7 +3997,7 @@ begin
|
|
3997
3997
|
rescue PureCloud::ApiError => e
|
3998
3998
|
puts "Exception when calling UsersApi->put_user_routingskill: #{e}"
|
3999
3999
|
end
|
4000
|
-
|
4000
|
+
```
|
4001
4001
|
|
4002
4002
|
### Parameters
|
4003
4003
|
|
@@ -4022,7 +4022,7 @@ Name | Type | Description | Notes
|
|
4022
4022
|
|
4023
4023
|
<a name="put_user_routingstatus"></a>
|
4024
4024
|
|
4025
|
-
##
|
4025
|
+
## [**RoutingStatus**](RoutingStatus.html) put_user_routingstatus(user_id, body)
|
4026
4026
|
|
4027
4027
|
|
4028
4028
|
|
@@ -4037,7 +4037,7 @@ Requires NO permissions:
|
|
4037
4037
|
|
4038
4038
|
|
4039
4039
|
### Example
|
4040
|
-
|
4040
|
+
```{"language":"ruby"}
|
4041
4041
|
# load the gem
|
4042
4042
|
require 'purecloudplatformclientv2'
|
4043
4043
|
# setup authorization
|
@@ -4065,7 +4065,7 @@ begin
|
|
4065
4065
|
rescue PureCloud::ApiError => e
|
4066
4066
|
puts "Exception when calling UsersApi->put_user_routingstatus: #{e}"
|
4067
4067
|
end
|
4068
|
-
|
4068
|
+
```
|
4069
4069
|
|
4070
4070
|
### Parameters
|
4071
4071
|
|
@@ -4089,7 +4089,7 @@ Name | Type | Description | Notes
|
|
4089
4089
|
|
4090
4090
|
<a name="put_user_station_associatedstation_station_id"></a>
|
4091
4091
|
|
4092
|
-
##
|
4092
|
+
## put_user_station_associatedstation_station_id(user_id, station_id)
|
4093
4093
|
|
4094
4094
|
|
4095
4095
|
|
@@ -4104,7 +4104,7 @@ Requires NO permissions:
|
|
4104
4104
|
|
4105
4105
|
|
4106
4106
|
### Example
|
4107
|
-
|
4107
|
+
```{"language":"ruby"}
|
4108
4108
|
# load the gem
|
4109
4109
|
require 'purecloudplatformclientv2'
|
4110
4110
|
# setup authorization
|
@@ -4131,7 +4131,7 @@ begin
|
|
4131
4131
|
rescue PureCloud::ApiError => e
|
4132
4132
|
puts "Exception when calling UsersApi->put_user_station_associatedstation_station_id: #{e}"
|
4133
4133
|
end
|
4134
|
-
|
4134
|
+
```
|
4135
4135
|
|
4136
4136
|
### Parameters
|
4137
4137
|
|
@@ -4155,7 +4155,7 @@ nil (empty response body)
|
|
4155
4155
|
|
4156
4156
|
<a name="put_user_station_defaultstation_station_id"></a>
|
4157
4157
|
|
4158
|
-
##
|
4158
|
+
## put_user_station_defaultstation_station_id(user_id, station_id)
|
4159
4159
|
|
4160
4160
|
|
4161
4161
|
|
@@ -4172,7 +4172,7 @@ Requires ANY permissions:
|
|
4172
4172
|
|
4173
4173
|
|
4174
4174
|
### Example
|
4175
|
-
|
4175
|
+
```{"language":"ruby"}
|
4176
4176
|
# load the gem
|
4177
4177
|
require 'purecloudplatformclientv2'
|
4178
4178
|
# setup authorization
|
@@ -4199,7 +4199,7 @@ begin
|
|
4199
4199
|
rescue PureCloud::ApiError => e
|
4200
4200
|
puts "Exception when calling UsersApi->put_user_station_defaultstation_station_id: #{e}"
|
4201
4201
|
end
|
4202
|
-
|
4202
|
+
```
|
4203
4203
|
|
4204
4204
|
### Parameters
|
4205
4205
|
|