docs/UsersApi.md in purecloudplatformclientv2-49.0.0 vs docs/UsersApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -71,11 +71,11 @@
[**put_user_station_defaultstation_station_id**](UsersApi.html#put_user_station_defaultstation_station_id) | Set default station
{: class="table table-striped"}
<a name="delete_authorization_subject_division_role"></a>
-## - delete_authorization_subject_division_role(subject_id, division_id, role_id)
+## delete_authorization_subject_division_role(subject_id, division_id, role_id)
Delete a grant of a role in a division
@@ -87,11 +87,11 @@
* authorization:grant:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -116,11 +116,11 @@
#Delete a grant of a role in a division
api_instance.delete_authorization_subject_division_role(subject_id, division_id, role_id)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->delete_authorization_subject_division_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -141,11 +141,11 @@
<a name="delete_user"></a>
-## -[**Empty**](Empty.html) delete_user(user_id)
+## [**Empty**](Empty.html) delete_user(user_id)
Delete user
@@ -159,11 +159,11 @@
* user_manager
* user_administration
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -185,11 +185,11 @@
result = api_instance.delete_user(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->delete_user: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -208,11 +208,11 @@
<a name="delete_user_roles"></a>
-## - delete_user_roles(user_id)
+## delete_user_roles(user_id)
Removes all the roles from the user.
@@ -226,11 +226,11 @@
* role_manager
* authorization:grant:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -251,11 +251,11 @@
#Removes all the roles from the user.
api_instance.delete_user_roles(user_id)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->delete_user_roles: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -274,11 +274,11 @@
<a name="delete_user_routinglanguage"></a>
-## - delete_user_routinglanguage(user_id, language_id)
+## delete_user_routinglanguage(user_id, language_id)
Remove routing language from user
@@ -291,11 +291,11 @@
* routing:skill:assign
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -318,11 +318,11 @@
#Remove routing language from user
api_instance.delete_user_routinglanguage(user_id, language_id)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->delete_user_routinglanguage: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -342,11 +342,11 @@
<a name="delete_user_routingskill"></a>
-## - delete_user_routingskill(user_id, skill_id)
+## delete_user_routingskill(user_id, skill_id)
Remove routing skill from user
@@ -359,11 +359,11 @@
* routing:skill:assign
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -386,11 +386,11 @@
#Remove routing skill from user
api_instance.delete_user_routingskill(user_id, skill_id)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->delete_user_routingskill: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -410,11 +410,11 @@
<a name="delete_user_station_associatedstation"></a>
-## - delete_user_station_associatedstation(user_id)
+## delete_user_station_associatedstation(user_id)
Clear associated station
@@ -425,11 +425,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -450,11 +450,11 @@
#Clear associated station
api_instance.delete_user_station_associatedstation(user_id)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->delete_user_station_associatedstation: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -473,11 +473,11 @@
<a name="delete_user_station_defaultstation"></a>
-## - delete_user_station_defaultstation(user_id)
+## delete_user_station_defaultstation(user_id)
Clear default station
@@ -490,11 +490,11 @@
* telephony:plugin:all
* telephony:phone:assign
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -515,11 +515,11 @@
#Clear default station
api_instance.delete_user_station_defaultstation(user_id)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->delete_user_station_defaultstation: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -538,11 +538,11 @@
<a name="get_authorization_divisionspermitted_me"></a>
-## -[**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
+## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
Returns whether or not current user can perform the specified action(s).
@@ -553,11 +553,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -582,11 +582,11 @@
result = api_instance.get_authorization_divisionspermitted_me(permission, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_authorization_divisionspermitted_me: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -606,11 +606,11 @@
<a name="get_authorization_divisionspermitted_subject_id"></a>
-## -[**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
+## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
Returns whether or not specified user can perform the specified action(s).
@@ -621,11 +621,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -652,11 +652,11 @@
result = api_instance.get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_authorization_divisionspermitted_subject_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -677,11 +677,11 @@
<a name="get_authorization_subject"></a>
-## -[**AuthzSubject**](AuthzSubject.html) get_authorization_subject(subject_id)
+## [**AuthzSubject**](AuthzSubject.html) get_authorization_subject(subject_id)
Returns a listing of roles and permissions for a user.
@@ -693,11 +693,11 @@
* authorization:grant:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -719,11 +719,11 @@
result = api_instance.get_authorization_subject(subject_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_authorization_subject: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -742,11 +742,11 @@
<a name="get_authorization_subjects_me"></a>
-## -[**AuthzSubject**](AuthzSubject.html) get_authorization_subjects_me
+## [**AuthzSubject**](AuthzSubject.html) get_authorization_subjects_me
Returns a listing of roles and permissions for the currently authenticated user.
@@ -757,11 +757,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -780,11 +780,11 @@
result = api_instance.get_authorization_subjects_me
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_authorization_subjects_me: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -800,11 +800,11 @@
<a name="get_fieldconfig"></a>
-## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
+## [**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
Fetch field config for an entity type
@@ -815,11 +815,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -841,11 +841,11 @@
result = api_instance.get_fieldconfig(type)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_fieldconfig: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -864,11 +864,11 @@
<a name="get_profiles_users"></a>
-## -[**UserProfileEntityListing**](UserProfileEntityListing.html) get_profiles_users(opts)
+## [**UserProfileEntityListing**](UserProfileEntityListing.html) get_profiles_users(opts)
Get a user profile listing
@@ -879,11 +879,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -912,11 +912,11 @@
result = api_instance.get_profiles_users(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_profiles_users: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -941,11 +941,11 @@
<a name="get_user"></a>
-## -[**User**](User.html) get_user(user_id, opts)
+## [**User**](User.html) get_user(user_id, opts)
Get user.
@@ -956,11 +956,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -986,11 +986,11 @@
result = api_instance.get_user(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1011,11 +1011,11 @@
<a name="get_user_adjacents"></a>
-## -[**Adjacents**](Adjacents.html) get_user_adjacents(user_id, opts)
+## [**Adjacents**](Adjacents.html) get_user_adjacents(user_id, opts)
Get adjacents
@@ -1026,11 +1026,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1055,11 +1055,11 @@
result = api_instance.get_user_adjacents(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_adjacents: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1079,11 +1079,11 @@
<a name="get_user_callforwarding"></a>
-## -[**CallForwarding**](CallForwarding.html) get_user_callforwarding(user_id)
+## [**CallForwarding**](CallForwarding.html) get_user_callforwarding(user_id)
Get a user's CallForwarding
@@ -1094,11 +1094,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1120,11 +1120,11 @@
result = api_instance.get_user_callforwarding(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_callforwarding: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1143,11 +1143,11 @@
<a name="get_user_directreports"></a>
-## -[**Array<User>**](User.html) get_user_directreports(user_id, opts)
+## [**Array<User>**](User.html) get_user_directreports(user_id, opts)
Get direct reports
@@ -1158,11 +1158,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1187,11 +1187,11 @@
result = api_instance.get_user_directreports(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_directreports: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1211,11 +1211,11 @@
<a name="get_user_favorites"></a>
-## -[**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts)
+## [**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts)
Get favorites
@@ -1226,11 +1226,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1258,11 +1258,11 @@
result = api_instance.get_user_favorites(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_favorites: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1285,11 +1285,11 @@
<a name="get_user_geolocation"></a>
-## -[**Geolocation**](Geolocation.html) get_user_geolocation(user_id, client_id)
+## [**Geolocation**](Geolocation.html) get_user_geolocation(user_id, client_id)
Get a user's Geolocation
@@ -1300,11 +1300,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1328,11 +1328,11 @@
result = api_instance.get_user_geolocation(user_id, client_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_geolocation: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1352,11 +1352,11 @@
<a name="get_user_outofoffice"></a>
-## -[**OutOfOffice**](OutOfOffice.html) get_user_outofoffice(user_id)
+## [**OutOfOffice**](OutOfOffice.html) get_user_outofoffice(user_id)
Get a OutOfOffice
@@ -1367,11 +1367,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1393,11 +1393,11 @@
result = api_instance.get_user_outofoffice(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_outofoffice: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1416,11 +1416,11 @@
<a name="get_user_profile"></a>
-## -[**UserProfile**](UserProfile.html) get_user_profile(user_id, opts)
+## [**UserProfile**](UserProfile.html) get_user_profile(user_id, opts)
Get user profile
@@ -1431,11 +1431,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1460,11 +1460,11 @@
result = api_instance.get_user_profile(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_profile: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1484,11 +1484,11 @@
<a name="get_user_profileskills"></a>
-## -Array<String>** get_user_profileskills(user_id)
+## Array<String>** get_user_profileskills(user_id)
List profile skills for a user
@@ -1500,11 +1500,11 @@
* directory:userProfile:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1526,11 +1526,11 @@
result = api_instance.get_user_profileskills(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_profileskills: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1549,11 +1549,11 @@
<a name="get_user_queues"></a>
-## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_queues(user_id, opts)
+## [**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_queues(user_id, opts)
Get queues for user
@@ -1565,11 +1565,11 @@
* routing:queue:join
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1597,11 +1597,11 @@
result = api_instance.get_user_queues(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_queues: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1624,11 +1624,11 @@
<a name="get_user_roles"></a>
-## -[**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
+## [**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
Returns a listing of roles and permissions for a user.
@@ -1640,11 +1640,11 @@
* authorization:grant:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1666,11 +1666,11 @@
result = api_instance.get_user_roles(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_roles: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1689,11 +1689,11 @@
<a name="get_user_routinglanguages"></a>
-## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) get_user_routinglanguages(user_id, opts)
+## [**UserLanguageEntityListing**](UserLanguageEntityListing.html) get_user_routinglanguages(user_id, opts)
List routing language for user
@@ -1704,11 +1704,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1735,11 +1735,11 @@
result = api_instance.get_user_routinglanguages(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_routinglanguages: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1761,11 +1761,11 @@
<a name="get_user_routingskills"></a>
-## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_routingskills(user_id, opts)
+## [**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_routingskills(user_id, opts)
List routing skills for user
@@ -1776,11 +1776,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1807,11 +1807,11 @@
result = api_instance.get_user_routingskills(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_routingskills: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1833,11 +1833,11 @@
<a name="get_user_routingstatus"></a>
-## -[**RoutingStatus**](RoutingStatus.html) get_user_routingstatus(user_id)
+## [**RoutingStatus**](RoutingStatus.html) get_user_routingstatus(user_id)
Fetch the routing status of a user
@@ -1848,11 +1848,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1874,11 +1874,11 @@
result = api_instance.get_user_routingstatus(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_routingstatus: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1897,11 +1897,11 @@
<a name="get_user_station"></a>
-## -[**UserStations**](UserStations.html) get_user_station(user_id)
+## [**UserStations**](UserStations.html) get_user_station(user_id)
Get station information for user
@@ -1912,11 +1912,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1938,11 +1938,11 @@
result = api_instance.get_user_station(user_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_station: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1961,11 +1961,11 @@
<a name="get_user_superiors"></a>
-## -[**Array<User>**](User.html) get_user_superiors(user_id, opts)
+## [**Array<User>**](User.html) get_user_superiors(user_id, opts)
Get superiors
@@ -1976,11 +1976,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2005,11 +2005,11 @@
result = api_instance.get_user_superiors(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_superiors: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2029,11 +2029,11 @@
<a name="get_user_trustors"></a>
-## -[**TrustorEntityListing**](TrustorEntityListing.html) get_user_trustors(user_id, opts)
+## [**TrustorEntityListing**](TrustorEntityListing.html) get_user_trustors(user_id, opts)
List the organizations that have authorized/trusted the user.
@@ -2045,11 +2045,11 @@
* authorization:orgTrustor:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2075,11 +2075,11 @@
result = api_instance.get_user_trustors(user_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_user_trustors: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2100,11 +2100,11 @@
<a name="get_users"></a>
-## -[**UserEntityListing**](UserEntityListing.html) get_users(opts)
+## [**UserEntityListing**](UserEntityListing.html) get_users(opts)
Get the list of available users.
@@ -2115,11 +2115,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2147,11 +2147,11 @@
result = api_instance.get_users(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_users: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2175,11 +2175,11 @@
<a name="get_users_me"></a>
-## -[**UserMe**](UserMe.html) get_users_me(opts)
+## [**UserMe**](UserMe.html) get_users_me(opts)
Get current user details.
@@ -2190,11 +2190,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2217,11 +2217,11 @@
result = api_instance.get_users_me(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_users_me: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2240,11 +2240,11 @@
<a name="get_users_search"></a>
-## -[**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
+## [**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
Search users using the q64 value returned from a previous search
@@ -2255,11 +2255,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2284,11 +2284,11 @@
result = api_instance.get_users_search(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->get_users_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2308,11 +2308,11 @@
<a name="patch_user"></a>
-## -[**User**](User.html) patch_user(user_id, body)
+## [**User**](User.html) patch_user(user_id, body)
Update user
@@ -2326,11 +2326,11 @@
* user_manager
* user_administration
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2354,11 +2354,11 @@
result = api_instance.patch_user(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2378,11 +2378,11 @@
<a name="patch_user_callforwarding"></a>
-## -[**CallForwarding**](CallForwarding.html) patch_user_callforwarding(user_id, body)
+## [**CallForwarding**](CallForwarding.html) patch_user_callforwarding(user_id, body)
Patch a user's CallForwarding
@@ -2393,11 +2393,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2421,11 +2421,11 @@
result = api_instance.patch_user_callforwarding(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user_callforwarding: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2445,11 +2445,11 @@
<a name="patch_user_geolocation"></a>
-## -[**Geolocation**](Geolocation.html) patch_user_geolocation(user_id, client_id, body)
+## [**Geolocation**](Geolocation.html) patch_user_geolocation(user_id, client_id, body)
Patch a user's Geolocation
@@ -2460,11 +2460,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2490,11 +2490,11 @@
result = api_instance.patch_user_geolocation(user_id, client_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user_geolocation: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2515,11 +2515,11 @@
<a name="patch_user_queue"></a>
-## -[**UserQueue**](UserQueue.html) patch_user_queue(queue_id, user_id, body)
+## [**UserQueue**](UserQueue.html) patch_user_queue(queue_id, user_id, body)
Join or unjoin a queue for a user
@@ -2531,11 +2531,11 @@
* routing:queue:join
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2561,11 +2561,11 @@
result = api_instance.patch_user_queue(queue_id, user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user_queue: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2586,11 +2586,11 @@
<a name="patch_user_queues"></a>
-## -[**UserQueueEntityListing**](UserQueueEntityListing.html) patch_user_queues(user_id, body, opts)
+## [**UserQueueEntityListing**](UserQueueEntityListing.html) patch_user_queues(user_id, body, opts)
Join or unjoin a set of queues for a user
@@ -2602,11 +2602,11 @@
* routing:queue:join
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2633,11 +2633,11 @@
result = api_instance.patch_user_queues(user_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user_queues: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2658,11 +2658,11 @@
<a name="patch_user_routinglanguage"></a>
-## -[**UserRoutingLanguage**](UserRoutingLanguage.html) patch_user_routinglanguage(user_id, language_id, body)
+## [**UserRoutingLanguage**](UserRoutingLanguage.html) patch_user_routinglanguage(user_id, language_id, body)
Update routing language proficiency or state.
@@ -2675,11 +2675,11 @@
* routing:skill:assign
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2705,11 +2705,11 @@
result = api_instance.patch_user_routinglanguage(user_id, language_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user_routinglanguage: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2730,11 +2730,11 @@
<a name="patch_user_routinglanguages_bulk"></a>
-## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) patch_user_routinglanguages_bulk(user_id, body)
+## [**UserLanguageEntityListing**](UserLanguageEntityListing.html) patch_user_routinglanguages_bulk(user_id, body)
Add bulk routing language to user. Max limit 50 languages
@@ -2747,11 +2747,11 @@
* routing:skill:assign
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2775,11 +2775,11 @@
result = api_instance.patch_user_routinglanguages_bulk(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user_routinglanguages_bulk: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2799,11 +2799,11 @@
<a name="patch_user_routingskills_bulk"></a>
-## -[**UserSkillEntityListing**](UserSkillEntityListing.html) patch_user_routingskills_bulk(user_id, body)
+## [**UserSkillEntityListing**](UserSkillEntityListing.html) patch_user_routingskills_bulk(user_id, body)
Add bulk routing skills to user
@@ -2816,11 +2816,11 @@
* routing:skill:assign
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2844,11 +2844,11 @@
result = api_instance.patch_user_routingskills_bulk(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_user_routingskills_bulk: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2868,11 +2868,11 @@
<a name="patch_users_bulk"></a>
-## -[**UserEntityListing**](UserEntityListing.html) patch_users_bulk(body)
+## [**UserEntityListing**](UserEntityListing.html) patch_users_bulk(body)
Update bulk acd autoanswer on users
@@ -2887,11 +2887,11 @@
* user_administration
* directory:user:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2913,11 +2913,11 @@
result = api_instance.patch_users_bulk(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->patch_users_bulk: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2936,11 +2936,11 @@
<a name="post_analytics_users_aggregates_query"></a>
-## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
+## [**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
Query for user aggregates
@@ -2952,11 +2952,11 @@
* analytics:userAggregate:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2978,11 +2978,11 @@
result = api_instance.post_analytics_users_aggregates_query(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_analytics_users_aggregates_query: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3001,11 +3001,11 @@
<a name="post_analytics_users_details_query"></a>
-## -[**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
+## [**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
Query for user details
@@ -3017,11 +3017,11 @@
* analytics:userObservation:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3043,11 +3043,11 @@
result = api_instance.post_analytics_users_details_query(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_analytics_users_details_query: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3066,11 +3066,11 @@
<a name="post_analytics_users_observations_query"></a>
-## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
+## [**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
Query for user observations
@@ -3082,11 +3082,11 @@
* analytics:userObservation:view
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3108,11 +3108,11 @@
result = api_instance.post_analytics_users_observations_query(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_analytics_users_observations_query: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3131,11 +3131,11 @@
<a name="post_authorization_subject_division_role"></a>
-## - post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
+## post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
Make a grant of a role in a division
@@ -3147,11 +3147,11 @@
* authorization:grant:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3179,11 +3179,11 @@
#Make a grant of a role in a division
api_instance.post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_authorization_subject_division_role: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3205,11 +3205,11 @@
<a name="post_user_invite"></a>
-## - post_user_invite(user_id, opts)
+## post_user_invite(user_id, opts)
Send an activation email to the user
@@ -3223,11 +3223,11 @@
* user_manager
* user_administration
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3251,11 +3251,11 @@
#Send an activation email to the user
api_instance.post_user_invite(user_id, opts)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_user_invite: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3275,11 +3275,11 @@
<a name="post_user_password"></a>
-## - post_user_password(user_id, body)
+## post_user_password(user_id, body)
Change a users password
@@ -3292,11 +3292,11 @@
* user_administration
* directory:userPassword:edit
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3319,11 +3319,11 @@
#Change a users password
api_instance.post_user_password(user_id, body)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_user_password: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3343,11 +3343,11 @@
<a name="post_user_routinglanguages"></a>
-## -[**UserRoutingLanguage**](UserRoutingLanguage.html) post_user_routinglanguages(user_id, body)
+## [**UserRoutingLanguage**](UserRoutingLanguage.html) post_user_routinglanguages(user_id, body)
Add routing language to user
@@ -3360,11 +3360,11 @@
* routing:skill:assign
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3388,11 +3388,11 @@
result = api_instance.post_user_routinglanguages(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_user_routinglanguages: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3412,11 +3412,11 @@
<a name="post_user_routingskills"></a>
-## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)
+## [**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)
Add routing skill to user
@@ -3429,11 +3429,11 @@
* routing:skill:assign
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3457,11 +3457,11 @@
result = api_instance.post_user_routingskills(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_user_routingskills: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3481,11 +3481,11 @@
<a name="post_users"></a>
-## -[**User**](User.html) post_users(body)
+## [**User**](User.html) post_users(body)
Create user
@@ -3497,11 +3497,11 @@
* directory:user:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3523,11 +3523,11 @@
result = api_instance.post_users(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_users: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3546,11 +3546,11 @@
<a name="post_users_me_password"></a>
-## - post_users_me_password(body)
+## post_users_me_password(body)
Change your password
@@ -3561,11 +3561,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3586,11 +3586,11 @@
#Change your password
api_instance.post_users_me_password(body)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_users_me_password: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3609,11 +3609,11 @@
<a name="post_users_search"></a>
-## -[**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
+## [**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
Search users
@@ -3624,11 +3624,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3650,11 +3650,11 @@
result = api_instance.post_users_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->post_users_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3673,11 +3673,11 @@
<a name="put_user_callforwarding"></a>
-## -[**CallForwarding**](CallForwarding.html) put_user_callforwarding(user_id, body)
+## [**CallForwarding**](CallForwarding.html) put_user_callforwarding(user_id, body)
Update a user's CallForwarding
@@ -3688,11 +3688,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3716,11 +3716,11 @@
result = api_instance.put_user_callforwarding(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->put_user_callforwarding: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3740,11 +3740,11 @@
<a name="put_user_outofoffice"></a>
-## -[**OutOfOffice**](OutOfOffice.html) put_user_outofoffice(user_id, body)
+## [**OutOfOffice**](OutOfOffice.html) put_user_outofoffice(user_id, body)
Update an OutOfOffice
@@ -3755,11 +3755,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3783,11 +3783,11 @@
result = api_instance.put_user_outofoffice(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->put_user_outofoffice: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3807,11 +3807,11 @@
<a name="put_user_profileskills"></a>
-## -Array<String>** put_user_profileskills(user_id, body)
+## Array<String>** put_user_profileskills(user_id, body)
Update profile skills for a user
@@ -3826,11 +3826,11 @@
* user_manager
* user_administration
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3854,11 +3854,11 @@
result = api_instance.put_user_profileskills(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->put_user_profileskills: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3878,11 +3878,11 @@
<a name="put_user_roles"></a>
-## -[**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
+## [**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
Sets the user's roles
@@ -3896,11 +3896,11 @@
* role_manager
* authorization:grant:add
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3924,11 +3924,11 @@
result = api_instance.put_user_roles(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->put_user_roles: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -3948,11 +3948,11 @@
<a name="put_user_routingskill"></a>
-## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_routingskill(user_id, skill_id, body)
+## [**UserRoutingSkill**](UserRoutingSkill.html) put_user_routingskill(user_id, skill_id, body)
Update routing skill proficiency or state.
@@ -3965,11 +3965,11 @@
* routing:skill:assign
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -3995,11 +3995,11 @@
result = api_instance.put_user_routingskill(user_id, skill_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->put_user_routingskill: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4020,11 +4020,11 @@
<a name="put_user_routingstatus"></a>
-## -[**RoutingStatus**](RoutingStatus.html) put_user_routingstatus(user_id, body)
+## [**RoutingStatus**](RoutingStatus.html) put_user_routingstatus(user_id, body)
Update the routing status of a user
@@ -4035,11 +4035,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4063,11 +4063,11 @@
result = api_instance.put_user_routingstatus(user_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->put_user_routingstatus: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4087,11 +4087,11 @@
<a name="put_user_station_associatedstation_station_id"></a>
-## - put_user_station_associatedstation_station_id(user_id, station_id)
+## put_user_station_associatedstation_station_id(user_id, station_id)
Set associated station
@@ -4102,11 +4102,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4129,11 +4129,11 @@
#Set associated station
api_instance.put_user_station_associatedstation_station_id(user_id, station_id)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->put_user_station_associatedstation_station_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -4153,11 +4153,11 @@
<a name="put_user_station_defaultstation_station_id"></a>
-## - put_user_station_defaultstation_station_id(user_id, station_id)
+## put_user_station_defaultstation_station_id(user_id, station_id)
Set default station
@@ -4170,11 +4170,11 @@
* telephony:plugin:all
* telephony:phone:assign
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -4197,10 +4197,10 @@
#Set default station
api_instance.put_user_station_defaultstation_station_id(user_id, station_id)
rescue PureCloud::ApiError => e
puts "Exception when calling UsersApi->put_user_station_defaultstation_station_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------