lib/purecloud/api/routing_api.rb in purecloud-0.68.1 vs lib/purecloud/api/routing_api.rb in purecloud-0.69.1
- old
+ new
@@ -1085,44 +1085,41 @@
@api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Get recent conversations that are still active
+ # Get Estimated Wait Time
#
- # @param queue_id Queue ID
+ # @param queue_id queueId
# @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size (default to 25)
- # @option opts [Integer] :page_number Page number (default to 1)
- # @return [ConversationEntityListing]
- def get_queues_queue_id_conversations(queue_id, opts = {})
- data, status_code, headers = get_queues_queue_id_conversations_with_http_info(queue_id, opts)
+ # @option opts [String] :conversation_id conversationId
+ # @return [EstimatedWaitTimePredictions]
+ def get_queues_queue_id_estimatedwaittime(queue_id, opts = {})
+ data, status_code, headers = get_queues_queue_id_estimatedwaittime_with_http_info(queue_id, opts)
return data
end
- # Get recent conversations that are still active
+ # Get Estimated Wait Time
#
- # @param queue_id Queue ID
+ # @param queue_id queueId
# @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size
- # @option opts [Integer] :page_number Page number
- # @return [Array<(ConversationEntityListing, Fixnum, Hash)>] ConversationEntityListing data, response status code and response headers
- def get_queues_queue_id_conversations_with_http_info(queue_id, opts = {})
+ # @option opts [String] :conversation_id conversationId
+ # @return [Array<(EstimatedWaitTimePredictions, Fixnum, Hash)>] EstimatedWaitTimePredictions data, response status code and response headers
+ def get_queues_queue_id_estimatedwaittime_with_http_info(queue_id, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations ..."
+ @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_estimatedwaittime ..."
end
# verify the required parameter 'queue_id' is set
- fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations" if queue_id.nil?
+ fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_estimatedwaittime" if queue_id.nil?
# resource path
- local_var_path = "/api/v2/routing/queues/{queueId}/conversations".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
+ local_var_path = "/api/v2/routing/queues/{queueId}/estimatedwaittime".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
# query parameters
query_params = {}
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+ query_params[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -1144,312 +1141,50 @@
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
- :return_type => 'ConversationEntityListing')
+ :return_type => 'EstimatedWaitTimePredictions')
if @api_client.config.debugging
- @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_estimatedwaittime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Get recent callback conversations that are still active
- #
- # @param queue_id Queue ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size (default to 25)
- # @option opts [Integer] :page_number Page number (default to 1)
- # @return [CallbackConversationEntityListing]
- def get_queues_queue_id_conversations_callbacks(queue_id, opts = {})
- data, status_code, headers = get_queues_queue_id_conversations_callbacks_with_http_info(queue_id, opts)
- return data
- end
-
- # Get recent callback conversations that are still active
- #
- # @param queue_id Queue ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size
- # @option opts [Integer] :page_number Page number
- # @return [Array<(CallbackConversationEntityListing, Fixnum, Hash)>] CallbackConversationEntityListing data, response status code and response headers
- def get_queues_queue_id_conversations_callbacks_with_http_info(queue_id, opts = {})
- if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations_callbacks ..."
- end
-
- # verify the required parameter 'queue_id' is set
- fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations_callbacks" if queue_id.nil?
-
- # resource path
- local_var_path = "/api/v2/routing/queues/{queueId}/conversations/callbacks".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
-
- # query parameters
- query_params = {}
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
-
- # 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, local_var_path,
- :header_params => header_params,
- :query_params => query_params,
- :form_params => form_params,
- :body => post_body,
- :auth_names => auth_names,
- :return_type => 'CallbackConversationEntityListing')
- if @api_client.config.debugging
- @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations_callbacks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
- end
- return data, status_code, headers
- end
-
- # Get recent call conversations that are still active
- #
- # @param queue_id Queue ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size (default to 25)
- # @option opts [Integer] :page_number Page number (default to 1)
- # @return [CallConversationEntityListing]
- def get_queues_queue_id_conversations_calls(queue_id, opts = {})
- data, status_code, headers = get_queues_queue_id_conversations_calls_with_http_info(queue_id, opts)
- return data
- end
-
- # Get recent call conversations that are still active
- #
- # @param queue_id Queue ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size
- # @option opts [Integer] :page_number Page number
- # @return [Array<(CallConversationEntityListing, Fixnum, Hash)>] CallConversationEntityListing data, response status code and response headers
- def get_queues_queue_id_conversations_calls_with_http_info(queue_id, opts = {})
- if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations_calls ..."
- end
-
- # verify the required parameter 'queue_id' is set
- fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations_calls" if queue_id.nil?
-
- # resource path
- local_var_path = "/api/v2/routing/queues/{queueId}/conversations/calls".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
-
- # query parameters
- query_params = {}
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
-
- # 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, local_var_path,
- :header_params => header_params,
- :query_params => query_params,
- :form_params => form_params,
- :body => post_body,
- :auth_names => auth_names,
- :return_type => 'CallConversationEntityListing')
- if @api_client.config.debugging
- @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
- end
- return data, status_code, headers
- end
-
- # Get recent chat conversations that are still active
- #
- # @param queue_id Queue ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size (default to 25)
- # @option opts [Integer] :page_number Page number (default to 1)
- # @return [ChatConversationEntityListing]
- def get_queues_queue_id_conversations_chats(queue_id, opts = {})
- data, status_code, headers = get_queues_queue_id_conversations_chats_with_http_info(queue_id, opts)
- return data
- end
-
- # Get recent chat conversations that are still active
- #
- # @param queue_id Queue ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size
- # @option opts [Integer] :page_number Page number
- # @return [Array<(ChatConversationEntityListing, Fixnum, Hash)>] ChatConversationEntityListing data, response status code and response headers
- def get_queues_queue_id_conversations_chats_with_http_info(queue_id, opts = {})
- if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations_chats ..."
- end
-
- # verify the required parameter 'queue_id' is set
- fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations_chats" if queue_id.nil?
-
- # resource path
- local_var_path = "/api/v2/routing/queues/{queueId}/conversations/chats".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
-
- # query parameters
- query_params = {}
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
-
- # 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, local_var_path,
- :header_params => header_params,
- :query_params => query_params,
- :form_params => form_params,
- :body => post_body,
- :auth_names => auth_names,
- :return_type => 'ChatConversationEntityListing')
- if @api_client.config.debugging
- @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations_chats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
- end
- return data, status_code, headers
- end
-
- # Get recent email conversations that are still active
- #
- # @param queue_id Queue ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size (default to 25)
- # @option opts [Integer] :page_number Page number (default to 1)
- # @return [EmailConversationEntityListing]
- def get_queues_queue_id_conversations_emails(queue_id, opts = {})
- data, status_code, headers = get_queues_queue_id_conversations_emails_with_http_info(queue_id, opts)
- return data
- end
-
- # Get recent email conversations that are still active
- #
- # @param queue_id Queue ID
- # @param [Hash] opts the optional parameters
- # @option opts [Integer] :page_size Page size
- # @option opts [Integer] :page_number Page number
- # @return [Array<(EmailConversationEntityListing, Fixnum, Hash)>] EmailConversationEntityListing data, response status code and response headers
- def get_queues_queue_id_conversations_emails_with_http_info(queue_id, opts = {})
- if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations_emails ..."
- end
-
- # verify the required parameter 'queue_id' is set
- fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations_emails" if queue_id.nil?
-
- # resource path
- local_var_path = "/api/v2/routing/queues/{queueId}/conversations/emails".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
-
- # query parameters
- query_params = {}
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
-
- # 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, local_var_path,
- :header_params => header_params,
- :query_params => query_params,
- :form_params => form_params,
- :body => post_body,
- :auth_names => auth_names,
- :return_type => 'EmailConversationEntityListing')
- if @api_client.config.debugging
- @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
- end
- return data, status_code, headers
- end
-
# Get Estimated Wait Time
#
# @param queue_id queueId
+ # @param media_type mediaType
# @param [Hash] opts the optional parameters
- # @option opts [String] :conversation_id conversationId
# @return [EstimatedWaitTimePredictions]
- def get_queues_queue_id_estimatedwaittime(queue_id, opts = {})
- data, status_code, headers = get_queues_queue_id_estimatedwaittime_with_http_info(queue_id, opts)
+ def get_queues_queue_id_mediatypes_mediatype_estimatedwaittime(queue_id, media_type, opts = {})
+ data, status_code, headers = get_queues_queue_id_mediatypes_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts)
return data
end
# Get Estimated Wait Time
#
# @param queue_id queueId
+ # @param media_type mediaType
# @param [Hash] opts the optional parameters
- # @option opts [String] :conversation_id conversationId
# @return [Array<(EstimatedWaitTimePredictions, Fixnum, Hash)>] EstimatedWaitTimePredictions data, response status code and response headers
- def get_queues_queue_id_estimatedwaittime_with_http_info(queue_id, opts = {})
+ def get_queues_queue_id_mediatypes_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_estimatedwaittime ..."
+ @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime ..."
end
# verify the required parameter 'queue_id' is set
- fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_estimatedwaittime" if queue_id.nil?
+ fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_mediatypes_mediatype_estimatedwaittime" if queue_id.nil?
+ # verify the required parameter 'media_type' is set
+ fail "Missing the required parameter 'media_type' when calling get_queues_queue_id_mediatypes_mediatype_estimatedwaittime" if media_type.nil?
+
# resource path
- local_var_path = "/api/v2/routing/queues/{queueId}/estimatedwaittime".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
+ local_var_path = "/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'mediaType' + '}', media_type.to_s)
# query parameters
query_params = {}
- query_params[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -1473,11 +1208,11 @@
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'EstimatedWaitTimePredictions')
if @api_client.config.debugging
- @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_estimatedwaittime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Get the members of this queue
@@ -2709,21 +2444,21 @@
# Create a wrap-up code
#
# @param body WrapupCode
# @param [Hash] opts the optional parameters
- # @return [CallableTimeSet]
+ # @return [WrapupCode]
def post_wrapupcodes(body, opts = {})
data, status_code, headers = post_wrapupcodes_with_http_info(body, opts)
return data
end
# Create a wrap-up code
#
# @param body WrapupCode
# @param [Hash] opts the optional parameters
- # @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers
+ # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers
def post_wrapupcodes_with_http_info(body, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: RoutingApi#post_wrapupcodes ..."
end
@@ -2758,10 +2493,10 @@
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
- :return_type => 'CallableTimeSet')
+ :return_type => 'WrapupCode')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RoutingApi#post_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end