doc_out/UsersApi.html.md in purecloud-0.54.1 vs doc_out/UsersApi.html.md in purecloud-0.55.1

- old
+ new

@@ -11,10 +11,11 @@ |[**delete_user_id**](UsersApi.html#delete_user_id) | **DELETE** /api/v2/users/{userId} | Delete user| |[**delete_user_id_roles**](UsersApi.html#delete_user_id_roles) | **DELETE** /api/v2/users/{userId}/roles | Removes all the roles from the user.| |[**delete_user_id_routingskills_skill_id**](UsersApi.html#delete_user_id_routingskills_skill_id) | **DELETE** /api/v2/users/{userId}/routingskills/{skillId} | Remove routing skill from user| |[**delete_user_id_station_associatedstation**](UsersApi.html#delete_user_id_station_associatedstation) | **DELETE** /api/v2/users/{userId}/station/associatedstation | Clear associated station| |[**delete_user_id_station_defaultstation**](UsersApi.html#delete_user_id_station_defaultstation) | **DELETE** /api/v2/users/{userId}/station/defaultstation | Clear default station| +|[**get_fieldconfig**](UsersApi.html#get_fieldconfig) | **GET** /api/v2/fieldconfig | Fetch field config for an entity type| |[**get_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get current user details.| |[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search users using the q64 value returned from a previous search| |[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user.| |[**get_user_id_adjacents**](UsersApi.html#get_user_id_adjacents) | **GET** /api/v2/users/{userId}/adjacents | Get adjacents| |[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | **GET** /api/v2/users/{userId}/callforwarding | Get a user&#39;s CallForwarding| @@ -320,9 +321,65 @@ ### Return type nil (empty response body) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_fieldconfig"></a> + +## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type) + +Fetch field config for an entity type + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::UsersApi.new + +type = "type_example" # String | Field type + + +begin + #Fetch field config for an entity type + 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 +------------- | ------------- | ------------- | ------------- + **type** | **String**| Field type | +{: class="table table-striped"} + + +### Return type + +[**FieldConfig**](FieldConfig.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json