lib/purecloud/api/presence_api.rb in purecloud-0.36.1 vs lib/purecloud/api/presence_api.rb in purecloud-0.37.1
- old
+ new
@@ -1,18 +1,18 @@
=begin
-PureCloud API
+PureCloud Platform API
-PureCloud API
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
-OpenAPI spec version: v1
-Contact: chuck.pulfer@inin.com
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@inin.com
Generated by: https://github.com/swagger-api/swagger-codegen.git
License: ININ
http://www.inin.com
-Terms of Service: http://www.inin.com
+Terms of Service: https://developer.mypurecloud.com/tos
=end
require "uri"
@@ -206,37 +206,37 @@
end
# Get a user's Presence
#
# @param user_id user Id
- # @param source source
+ # @param source_id 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)
+ def get_user_id_presences_source_id(user_id, source_id, opts = {})
+ data, status_code, headers = get_user_id_presences_source_id_with_http_info(user_id, source_id, opts)
return data
end
# Get a user's Presence
#
# @param user_id user Id
- # @param source source
+ # @param source_id 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 = {})
+ def get_user_id_presences_source_id_with_http_info(user_id, source_id, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: PresenceApi#get_user_id_presences_source ..."
+ @api_client.config.logger.debug "Calling API: PresenceApi#get_user_id_presences_source_id ..."
end
# verify the required parameter 'user_id' is set
- fail "Missing the required parameter 'user_id' when calling get_user_id_presences_source" if user_id.nil?
+ fail "Missing the required parameter 'user_id' when calling get_user_id_presences_source_id" if user_id.nil?
- # verify the required parameter 'source' is set
- fail "Missing the required parameter 'source' when calling get_user_id_presences_source" if source.nil?
+ # verify the required parameter 'source_id' is set
+ fail "Missing the required parameter 'source_id' when calling get_user_id_presences_source_id" if source_id.nil?
# resource path
- local_var_path = "/api/v2/users/{userId}/presences/{source}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'source' + '}', source.to_s)
+ local_var_path = "/api/v2/users/{userId}/presences/{sourceId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'sourceId' + '}', source_id.to_s)
# query parameters
query_params = {}
# header parameters
@@ -263,47 +263,47 @@
: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_presences_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ @api_client.config.logger.debug "API called: PresenceApi#get_user_id_presences_source_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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 source_id Source
# @param [Hash] opts the optional parameters
# @option opts [UserPresence] :body
# @return [UserPresence]
- 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)
+ def patch_user_id_presences_source_id(user_id, source_id, opts = {})
+ data, status_code, headers = patch_user_id_presences_source_id_with_http_info(user_id, source_id, opts)
return data
end
# 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 source_id 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 patch_user_id_presences_source_with_http_info(user_id, source, opts = {})
+ def patch_user_id_presences_source_id_with_http_info(user_id, source_id, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: PresenceApi#patch_user_id_presences_source ..."
+ @api_client.config.logger.debug "Calling API: PresenceApi#patch_user_id_presences_source_id ..."
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?
+ fail "Missing the required parameter 'user_id' when calling patch_user_id_presences_source_id" 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 'source_id' is set
+ fail "Missing the required parameter 'source_id' when calling patch_user_id_presences_source_id" if source_id.nil?
# resource path
- local_var_path = "/api/v2/users/{userId}/presences/{source}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'source' + '}', source.to_s)
+ local_var_path = "/api/v2/users/{userId}/presences/{sourceId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'sourceId' + '}', source_id.to_s)
# query parameters
query_params = {}
# header parameters
@@ -330,10 +330,10 @@
: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#patch_user_id_presences_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ @api_client.config.logger.debug "API called: PresenceApi#patch_user_id_presences_source_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Create an OrganizationPresence