lib/purecloud/api/routing_api.rb in purecloud-0.50.1 vs lib/purecloud/api/routing_api.rb in purecloud-0.51.1

- old
+ new

@@ -151,22 +151,22 @@ # Delete a queue # # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [BOOLEAN] :force_delete + # @option opts [BOOLEAN] :force_delete forceDelete # @return [String] def delete_queues_queue_id(queue_id, opts = {}) data, status_code, headers = delete_queues_queue_id_with_http_info(queue_id, opts) return data end # Delete a queue # # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [BOOLEAN] :force_delete + # @option opts [BOOLEAN] :force_delete forceDelete # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers def delete_queues_queue_id_with_http_info(queue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id ..." end @@ -403,22 +403,22 @@ end # Remove routing skill from user # # @param user_id User ID - # @param skill_id + # @param skill_id skillId # @param [Hash] opts the optional parameters # @return [String] def delete_user_id_routingskills_skill_id(user_id, skill_id, opts = {}) data, status_code, headers = delete_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, opts) return data end # Remove routing skill from user # # @param user_id User ID - # @param skill_id + # @param skill_id skillId # @param [Hash] opts the optional parameters # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers def delete_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#delete_user_id_routingskills_skill_id ..." @@ -635,10 +635,70 @@ @api_client.config.logger.debug "API called: RoutingApi#get_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end + # Get domain + # + # @param domain_id domain ID + # @param [Hash] opts the optional parameters + # @return [InboundDomain] + def get_email_domains_domain_id(domain_id, opts = {}) + data, status_code, headers = get_email_domains_domain_id_with_http_info(domain_id, opts) + return data + end + + # Get domain + # + # @param domain_id domain ID + # @param [Hash] opts the optional parameters + # @return [Array<(InboundDomain, Fixnum, Hash)>] InboundDomain data, response status code and response headers + def get_email_domains_domain_id_with_http_info(domain_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domain_id ..." + end + + # verify the required parameter 'domain_id' is set + fail "Missing the required parameter 'domain_id' when calling get_email_domains_domain_id" if domain_id.nil? + + # resource path + local_var_path = "/api/v2/routing/email/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_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, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'InboundDomain') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domain_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Get routes # # @param domain_name email domain # @param [Hash] opts the optional parameters # @return [InboundRouteEntityListing] @@ -951,11 +1011,11 @@ # # @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] + # @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) return data end @@ -963,11 +1023,11 @@ # # @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 + # @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 = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations ..." end @@ -1004,11 +1064,11 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'CallConversationEntityListing') + :return_type => 'ConversationEntityListing') 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}" end return data, status_code, headers end @@ -1345,13 +1405,19 @@ # @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) # @option opts [String] :sort_by Sort by (default to name) - # @option opts [String] :expand expand - # @option opts [BOOLEAN] :direct_members Only get users that are direct members of the queue (default to false) - # @return [QueueMember] + # @option opts [Array<String>] :expand Which fields, if any, to expand. + # @option opts [BOOLEAN] :joined Filter by joined status + # @option opts [String] :name Filter by queue member name + # @option opts [Array<String>] :profile_skills Filter by profile skill + # @option opts [Array<String>] :skills Filter by skill + # @option opts [Array<String>] :languages Filter by language + # @option opts [Array<String>] :routing_status Filter by routing status + # @option opts [Array<String>] :presence Filter by presence + # @return [QueueMemberEntityListing] def get_queues_queue_id_users(queue_id, opts = {}) data, status_code, headers = get_queues_queue_id_users_with_http_info(queue_id, opts) return data end @@ -1360,13 +1426,19 @@ # @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 # @option opts [String] :sort_by Sort by - # @option opts [String] :expand expand - # @option opts [BOOLEAN] :direct_members Only get users that are direct members of the queue - # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers + # @option opts [Array<String>] :expand Which fields, if any, to expand. + # @option opts [BOOLEAN] :joined Filter by joined status + # @option opts [String] :name Filter by queue member name + # @option opts [Array<String>] :profile_skills Filter by profile skill + # @option opts [Array<String>] :skills Filter by skill + # @option opts [Array<String>] :languages Filter by language + # @option opts [Array<String>] :routing_status Filter by routing status + # @option opts [Array<String>] :presence Filter by presence + # @return [Array<(QueueMemberEntityListing, Fixnum, Hash)>] QueueMemberEntityListing data, response status code and response headers def get_queues_queue_id_users_with_http_info(queue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_users ..." end @@ -1379,12 +1451,18 @@ # 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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by'] - query_params[:'expand'] = opts[:'expand'] if opts[:'expand'] - query_params[:'directMembers'] = opts[:'direct_members'] if opts[:'direct_members'] + query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] + query_params[:'joined'] = opts[:'joined'] if opts[:'joined'] + query_params[:'name'] = opts[:'name'] if opts[:'name'] + query_params[:'profileSkills'] = @api_client.build_collection_param(opts[:'profile_skills'], :multi) if opts[:'profile_skills'] + query_params[:'skills'] = @api_client.build_collection_param(opts[:'skills'], :multi) if opts[:'skills'] + query_params[:'languages'] = @api_client.build_collection_param(opts[:'languages'], :multi) if opts[:'languages'] + query_params[:'routingStatus'] = @api_client.build_collection_param(opts[:'routing_status'], :multi) if opts[:'routing_status'] + query_params[:'presence'] = @api_client.build_collection_param(opts[:'presence'], :multi) if opts[:'presence'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -1406,11 +1484,11 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'QueueMember') + :return_type => 'QueueMemberEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end @@ -1418,22 +1496,22 @@ # Get the wrap-up codes for a queue # # @param queue_id Queue ID # @param code_id Code ID # @param [Hash] opts the optional parameters - # @return [WrapupCode] + # @return [WrapupCodeEntityListing] def get_queues_queue_id_wrapupcodes(queue_id, code_id, opts = {}) data, status_code, headers = get_queues_queue_id_wrapupcodes_with_http_info(queue_id, code_id, opts) return data end # Get the wrap-up codes for a queue # # @param queue_id Queue ID # @param code_id Code ID # @param [Hash] opts the optional parameters - # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers + # @return [Array<(WrapupCodeEntityListing, Fixnum, Hash)>] WrapupCodeEntityListing data, response status code and response headers def get_queues_queue_id_wrapupcodes_with_http_info(queue_id, code_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_wrapupcodes ..." end @@ -1471,11 +1549,11 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'WrapupCode') + :return_type => 'WrapupCodeEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end @@ -1856,22 +1934,22 @@ # Join or unjoin a set of users for a queue # # @param queue_id Queue ID # @param body Queue Members # @param [Hash] opts the optional parameters - # @return [QueueMember] + # @return [QueueMemberEntityListing] def patch_queues_queue_id_users(queue_id, body, opts = {}) data, status_code, headers = patch_queues_queue_id_users_with_http_info(queue_id, body, opts) return data end # Join or unjoin a set of users for a queue # # @param queue_id Queue ID # @param body Queue Members # @param [Hash] opts the optional parameters - # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers + # @return [Array<(QueueMemberEntityListing, Fixnum, Hash)>] QueueMemberEntityListing data, response status code and response headers def patch_queues_queue_id_users_with_http_info(queue_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#patch_queues_queue_id_users ..." end @@ -1909,11 +1987,11 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'QueueMember') + :return_type => 'QueueMemberEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#patch_queues_queue_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end @@ -2237,11 +2315,11 @@ # # @param queue_id Queue ID # @param body Queue Members # @param [Hash] opts the optional parameters # @option opts [BOOLEAN] :delete True to delete queue members (default to false) - # @return [QueueMember] + # @return [String] def post_queues_queue_id_users(queue_id, body, opts = {}) data, status_code, headers = post_queues_queue_id_users_with_http_info(queue_id, body, opts) return data end @@ -2249,11 +2327,11 @@ # # @param queue_id Queue ID # @param body Queue Members # @param [Hash] opts the optional parameters # @option opts [BOOLEAN] :delete True to delete queue members - # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers + # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers def post_queues_queue_id_users_with_http_info(queue_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_queue_id_users ..." end @@ -2292,11 +2370,11 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'QueueMember') + :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_queues_queue_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end @@ -2305,11 +2383,11 @@ # # @param queue_id Queue ID # @param code_id Code ID # @param body List of wrapup codes # @param [Hash] opts the optional parameters - # @return [WrapupCode] + # @return [Array<WrapupCode>] def post_queues_queue_id_wrapupcodes(queue_id, code_id, body, opts = {}) data, status_code, headers = post_queues_queue_id_wrapupcodes_with_http_info(queue_id, code_id, body, opts) return data end @@ -2317,11 +2395,11 @@ # # @param queue_id Queue ID # @param code_id Code ID # @param body List of wrapup codes # @param [Hash] opts the optional parameters - # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers + # @return [Array<(Array<WrapupCode>, Fixnum, Hash)>] Array<WrapupCode> data, response status code and response headers def post_queues_queue_id_wrapupcodes_with_http_info(queue_id, code_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_queue_id_wrapupcodes ..." end @@ -2362,11 +2440,11 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'WrapupCode') + :return_type => 'Array<WrapupCode>') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutingApi#post_queues_queue_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end @@ -2692,11 +2770,11 @@ end # Update routing skill proficiency or state. # # @param user_id User ID - # @param skill_id + # @param skill_id skillId # @param body Skill # @param [Hash] opts the optional parameters # @return [UserRoutingSkill] def put_user_id_routingskills_skill_id(user_id, skill_id, body, opts = {}) data, status_code, headers = put_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, body, opts) @@ -2704,10 +2782,10 @@ end # Update routing skill proficiency or state. # # @param user_id User ID - # @param skill_id + # @param skill_id skillId # @param body Skill # @param [Hash] opts the optional parameters # @return [Array<(UserRoutingSkill, Fixnum, Hash)>] UserRoutingSkill data, response status code and response headers def put_user_id_routingskills_skill_id_with_http_info(user_id, skill_id, body, opts = {}) if @api_client.config.debugging