lib/purecloud/api/presence_api.rb in purecloud-0.28.0 vs lib/purecloud/api/presence_api.rb in purecloud-0.29.1
- old
+ new
@@ -317,92 +317,25 @@
@api_client.config.logger.debug "API called: PresenceApi#delete_presence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Get an User's list of Presences
+ # Get a user's Presence
#
- # @param user_id User ID
+ # @param user_id user Id
+ # @param source source
# @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_number Page number
- # @option opts [Integer] :page_size Page size
- # @return [UserPresenceEntityListing]
- def get_user_id_presences(user_id, opts = {})
- data, status_code, headers = get_user_id_presences_with_http_info(user_id, opts)
- return data
- end
-
- # Get an User's list of Presences
- #
- # @param user_id User ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_number Page number
- # @option opts [Integer] :page_size Page size
- # @return [Array<(UserPresenceEntityListing, Fixnum, Hash)>] UserPresenceEntityListing data, response status code and response headers
- def get_user_id_presences_with_http_info(user_id, opts = {})
- if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: PresenceApi#get_user_id_presences ..."
- end
-
- # verify the required parameter 'user_id' is set
- fail "Missing the required parameter 'user_id' when calling get_user_id_presences" if user_id.nil?
-
- # resource path
- path = "/api/v2/users/{userId}/presences".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
-
- # query parameters
- query_params = {}
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
-
- # header parameters
- header_params = {}
-
- # HTTP header 'Accept' (if needed)
- _header_accept = ['application/json']
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
-
- # HTTP header 'Content-Type'
- _header_content_type = ['application/json']
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
-
- # form parameters
- form_params = {}
-
- # http body (model)
- post_body = nil
-
-
- auth_names = ['PureCloud Auth']
- data, status_code, headers = @api_client.call_api(:GET, path,
- :header_params => header_params,
- :query_params => query_params,
- :form_params => form_params,
- :body => post_body,
- :auth_names => auth_names,
- :return_type => 'UserPresenceEntityListing')
- if @api_client.config.debugging
- @api_client.config.logger.debug "API called: PresenceApi#get_user_id_presences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
- end
- return data, status_code, headers
- end
-
- # Get a UserPresence
- #
- # @param user_id User ID
- # @param source Source
- # @param [Hash] opts the optional parameters
# @return [UserPresence]
def get_user_id_presences_source(user_id, source, opts = {})
data, status_code, headers = get_user_id_presences_source_with_http_info(user_id, source, opts)
return data
end
- # Get a UserPresence
+ # Get a user's Presence
#
- # @param user_id User ID
- # @param source Source
+ # @param user_id user Id
+ # @param source source
# @param [Hash] opts the optional parameters
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
def get_user_id_presences_source_with_http_info(user_id, source, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: PresenceApi#get_user_id_presences_source ..."
@@ -450,114 +383,40 @@
@api_client.config.logger.debug "API called: PresenceApi#get_user_id_presences_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Update a UserPresence
- #
- # @param user_id User ID
- # @param source Source
- # @param body The updated UserPresence
+ # Patch a user's Presence
+ # The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. Option 3: Provide the message value. Option 1 can be combined with Option2 and/or Option 3.
+ # @param user_id user Id
+ # @param source source
# @param [Hash] opts the optional parameters
+ # @option opts [UserPresence] :body
# @return [UserPresence]
- def put_user_id_presences_source(user_id, source, body, opts = {})
- data, status_code, headers = put_user_id_presences_source_with_http_info(user_id, source, body, opts)
+ def patch_user_id_presences_source(user_id, source, opts = {})
+ data, status_code, headers = patch_user_id_presences_source_with_http_info(user_id, source, opts)
return data
end
- # Update a UserPresence
- #
- # @param user_id User ID
- # @param source Source
- # @param body The updated UserPresence
+ # Patch a user's Presence
+ # The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. Option 3: Provide the message value. Option 1 can be combined with Option2 and/or Option 3.
+ # @param user_id user Id
+ # @param source source
# @param [Hash] opts the optional parameters
+ # @option opts [UserPresence] :body
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
- def put_user_id_presences_source_with_http_info(user_id, source, body, opts = {})
+ def patch_user_id_presences_source_with_http_info(user_id, source, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: PresenceApi#put_user_id_presences_source ..."
- end
-
- # verify the required parameter 'user_id' is set
- fail "Missing the required parameter 'user_id' when calling put_user_id_presences_source" if user_id.nil?
-
- # verify the required parameter 'source' is set
- fail "Missing the required parameter 'source' when calling put_user_id_presences_source" if source.nil?
-
- # verify the required parameter 'body' is set
- fail "Missing the required parameter 'body' when calling put_user_id_presences_source" if body.nil?
-
- # resource path
- path = "/api/v2/users/{userId}/presences/{source}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'source' + '}', source.to_s)
-
- # query parameters
- query_params = {}
-
- # header parameters
- header_params = {}
-
- # HTTP header 'Accept' (if needed)
- _header_accept = ['application/json']
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
-
- # HTTP header 'Content-Type'
- _header_content_type = ['application/json']
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
-
- # form parameters
- form_params = {}
-
- # http body (model)
- post_body = @api_client.object_to_http_body(body)
-
-
- auth_names = ['PureCloud Auth']
- data, status_code, headers = @api_client.call_api(:PUT, path,
- :header_params => header_params,
- :query_params => query_params,
- :form_params => form_params,
- :body => post_body,
- :auth_names => auth_names,
- :return_type => 'UserPresence')
- if @api_client.config.debugging
- @api_client.config.logger.debug "API called: PresenceApi#put_user_id_presences_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
- end
- return data, status_code, headers
- end
-
- # Patch a UserPresence
- #
- # @param user_id User ID
- # @param source Source
- # @param body The patched UserPresence
- # @param [Hash] opts the optional parameters
- # @return [UserPresence]
- def patch_user_id_presences_source(user_id, source, body, opts = {})
- data, status_code, headers = patch_user_id_presences_source_with_http_info(user_id, source, body, opts)
- return data
- end
-
- # Patch a UserPresence
- #
- # @param user_id User ID
- # @param source Source
- # @param body The patched UserPresence
- # @param [Hash] opts the optional parameters
- # @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
- def patch_user_id_presences_source_with_http_info(user_id, source, body, opts = {})
- if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: PresenceApi#patch_user_id_presences_source ..."
end
# verify the required parameter 'user_id' is set
fail "Missing the required parameter 'user_id' when calling patch_user_id_presences_source" if user_id.nil?
# verify the required parameter 'source' is set
fail "Missing the required parameter 'source' when calling patch_user_id_presences_source" if source.nil?
- # verify the required parameter 'body' is set
- fail "Missing the required parameter 'body' when calling patch_user_id_presences_source" if body.nil?
-
# resource path
path = "/api/v2/users/{userId}/presences/{source}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'source' + '}', source.to_s)
# query parameters
query_params = {}
@@ -575,11 +434,11 @@
# form parameters
form_params = {}
# http body (model)
- post_body = @api_client.object_to_http_body(body)
+ post_body = @api_client.object_to_http_body(opts[:'body'])
auth_names = ['PureCloud Auth']
data, status_code, headers = @api_client.call_api(:PATCH, path,
:header_params => header_params,
@@ -588,70 +447,9 @@
:body => post_body,
:auth_names => auth_names,
:return_type => 'UserPresence')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: PresenceApi#patch_user_id_presences_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
- end
- return data, status_code, headers
- end
-
- # Get a user's Primary UserPresence
- #
- # @param user_id User ID
- # @param [Hash] opts the optional parameters
- # @return [UserPresence]
- def get_user_id_primarypresence(user_id, opts = {})
- data, status_code, headers = get_user_id_primarypresence_with_http_info(user_id, opts)
- return data
- end
-
- # Get a user's Primary UserPresence
- #
- # @param user_id User ID
- # @param [Hash] opts the optional parameters
- # @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
- def get_user_id_primarypresence_with_http_info(user_id, opts = {})
- if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: PresenceApi#get_user_id_primarypresence ..."
- end
-
- # verify the required parameter 'user_id' is set
- fail "Missing the required parameter 'user_id' when calling get_user_id_primarypresence" if user_id.nil?
-
- # resource path
- path = "/api/v2/users/{userId}/primarypresence".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
-
- # query parameters
- query_params = {}
-
- # header parameters
- header_params = {}
-
- # HTTP header 'Accept' (if needed)
- _header_accept = ['application/json']
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
-
- # HTTP header 'Content-Type'
- _header_content_type = ['application/json']
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
-
- # form parameters
- form_params = {}
-
- # http body (model)
- post_body = nil
-
-
- auth_names = ['PureCloud Auth']
- data, status_code, headers = @api_client.call_api(:GET, path,
- :header_params => header_params,
- :query_params => query_params,
- :form_params => form_params,
- :body => post_body,
- :auth_names => auth_names,
- :return_type => 'UserPresence')
- if @api_client.config.debugging
- @api_client.config.logger.debug "API called: PresenceApi#get_user_id_primarypresence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
end
end