lib/purecloud/api/routing_api.rb in purecloud-0.35.1 vs lib/purecloud/api/routing_api.rb in purecloud-0.36.1

- old
+ new

@@ -1,37 +1,61 @@ +=begin +PureCloud API + +PureCloud API + +OpenAPI spec version: v1 +Contact: chuck.pulfer@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 + +=end + require "uri" module PureCloud class RoutingApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end - # Query for queue observations + # Delete a route # + # @param domain email domain + # @param id route ID # @param [Hash] opts the optional parameters - # @option opts [ObservationQuery] :body query - # @return [ObservationQueryResponse] - def post_queues_observations_query(opts = {}) - data, status_code, headers = post_queues_observations_query_with_http_info(opts) + # @return [String] + def delete_email_domains_domain_routes_id(domain, id, opts = {}) + data, status_code, headers = delete_email_domains_domain_routes_id_with_http_info(domain, id, opts) return data end - # Query for queue observations + # Delete a route # + # @param domain email domain + # @param id route ID # @param [Hash] opts the optional parameters - # @option opts [ObservationQuery] :body query - # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers - def post_queues_observations_query_with_http_info(opts = {}) + # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers + def delete_email_domains_domain_routes_id_with_http_info(domain, id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_observations_query ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_domain_routes_id ..." end + # verify the required parameter 'domain' is set + fail "Missing the required parameter 'domain' when calling delete_email_domains_domain_routes_id" if domain.nil? + + # verify the required parameter 'id' is set + fail "Missing the required parameter 'id' when calling delete_email_domains_domain_routes_id" if id.nil? + # resource path - path = "/api/v2/analytics/queues/observations/query".sub('{format}','json') + local_var_path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters @@ -47,47 +71,51 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'ObservationQueryResponse') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#post_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get domains + # Delete a domain # + # @param id domain ID # @param [Hash] opts the optional parameters - # @return [InboundDomainEntityListing] - def get_email_domains(opts = {}) - data, status_code, headers = get_email_domains_with_http_info(opts) + # @return [String] + def delete_email_domains_id(id, opts = {}) + data, status_code, headers = delete_email_domains_id_with_http_info(id, opts) return data end - # Get domains + # Delete a domain # + # @param id domain ID # @param [Hash] opts the optional parameters - # @return [Array<(InboundDomainEntityListing, Fixnum, Hash)>] InboundDomainEntityListing data, response status code and response headers - def get_email_domains_with_http_info(opts = {}) + # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers + def delete_email_domains_id_with_http_info(id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_id ..." end + # verify the required parameter 'id' is set + fail "Missing the required parameter 'id' when calling delete_email_domains_id" if id.nil? + # resource path - path = "/api/v2/routing/email/domains".sub('{format}','json') + local_var_path = "/api/v2/routing/email/domains/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters @@ -105,50 +133,55 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'InboundDomainEntityListing') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Create a domain + # Delete a queue # + # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [InboundDomain] :body Domain - # @return [InboundDomain] - def post_email_domains(opts = {}) - data, status_code, headers = post_email_domains_with_http_info(opts) + # @option opts [BOOLEAN] :force_delete + # @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 - # Create a domain + # Delete a queue # + # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [InboundDomain] :body Domain - # @return [Array<(InboundDomain, Fixnum, Hash)>] InboundDomain data, response status code and response headers - def post_email_domains_with_http_info(opts = {}) + # @option opts [BOOLEAN] :force_delete + # @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#post_email_domains ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id ..." end + # verify the required parameter 'queue_id' is set + fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id" if queue_id.nil? + # resource path - path = "/api/v2/routing/email/domains".sub('{format}','json') + local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} + query_params[:'forceDelete'] = opts[:'force_delete'] if opts[:'force_delete'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -161,52 +194,56 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + data, status_code, headers = @api_client.call_api(:DELETE, 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') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#post_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get routes + # Delete queue member # - # @param domain email domain + # @param queue_id Queue ID + # @param member_id Member ID # @param [Hash] opts the optional parameters - # @return [InboundRouteEntityListing] - def get_email_domains_domain_routes(domain, opts = {}) - data, status_code, headers = get_email_domains_domain_routes_with_http_info(domain, opts) + # @return [String] + def delete_queues_queue_id_users_member_id(queue_id, member_id, opts = {}) + data, status_code, headers = delete_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts) return data end - # Get routes + # Delete queue member # - # @param domain email domain + # @param queue_id Queue ID + # @param member_id Member ID # @param [Hash] opts the optional parameters - # @return [Array<(InboundRouteEntityListing, Fixnum, Hash)>] InboundRouteEntityListing data, response status code and response headers - def get_email_domains_domain_routes_with_http_info(domain, opts = {}) + # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers + def delete_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domain_routes ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id_users_member_id ..." end - # verify the required parameter 'domain' is set - fail "Missing the required parameter 'domain' when calling get_email_domains_domain_routes" if domain.nil? + # verify the required parameter 'queue_id' is set + fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id_users_member_id" if queue_id.nil? + # verify the required parameter 'member_id' is set + fail "Missing the required parameter 'member_id' when calling delete_queues_queue_id_users_member_id" if member_id.nil? + # resource path - path = "/api/v2/routing/email/domains/{domain}/routes".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s) + local_var_path = "/api/v2/routing/queues/{queueId}/users/{memberId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s) # query parameters query_params = {} # header parameters @@ -224,52 +261,54 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'InboundRouteEntityListing') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domain_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id_users_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Create a route + # Delete a wrap-up code from a queue # - # @param domain email domain + # @param queue_id Queue ID + # @param code_id Code ID # @param [Hash] opts the optional parameters - # @option opts [InboundRoute] :body Route - # @return [InboundRoute] - def post_email_domains_domain_routes(domain, opts = {}) - data, status_code, headers = post_email_domains_domain_routes_with_http_info(domain, opts) + # @return [String] + def delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id, opts = {}) + data, status_code, headers = delete_queues_queue_id_wrapupcodes_code_id_with_http_info(queue_id, code_id, opts) return data end - # Create a route + # Delete a wrap-up code from a queue # - # @param domain email domain + # @param queue_id Queue ID + # @param code_id Code ID # @param [Hash] opts the optional parameters - # @option opts [InboundRoute] :body Route - # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers - def post_email_domains_domain_routes_with_http_info(domain, opts = {}) + # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers + def delete_queues_queue_id_wrapupcodes_code_id_with_http_info(queue_id, code_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#post_email_domains_domain_routes ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id_wrapupcodes_code_id ..." end - # verify the required parameter 'domain' is set - fail "Missing the required parameter 'domain' when calling post_email_domains_domain_routes" if domain.nil? + # verify the required parameter 'queue_id' is set + fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id_wrapupcodes_code_id" if queue_id.nil? + # verify the required parameter 'code_id' is set + fail "Missing the required parameter 'code_id' when calling delete_queues_queue_id_wrapupcodes_code_id" if code_id.nil? + # resource path - path = "/api/v2/routing/email/domains/{domain}/routes".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s) + local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters @@ -285,57 +324,51 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'InboundRoute') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#post_email_domains_domain_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get a route + # Delete Routing Skill # - # @param domain email domain - # @param id route ID + # @param skill_id Skill ID # @param [Hash] opts the optional parameters - # @return [InboundRoute] - def get_email_domains_domain_routes_id(domain, id, opts = {}) - data, status_code, headers = get_email_domains_domain_routes_id_with_http_info(domain, id, opts) + # @return [String] + def delete_skills_skill_id(skill_id, opts = {}) + data, status_code, headers = delete_skills_skill_id_with_http_info(skill_id, opts) return data end - # Get a route + # Delete Routing Skill # - # @param domain email domain - # @param id route ID + # @param skill_id Skill ID # @param [Hash] opts the optional parameters - # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers - def get_email_domains_domain_routes_id_with_http_info(domain, id, opts = {}) + # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers + def delete_skills_skill_id_with_http_info(skill_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domain_routes_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_skills_skill_id ..." end - # verify the required parameter 'domain' is set - fail "Missing the required parameter 'domain' when calling get_email_domains_domain_routes_id" if domain.nil? + # verify the required parameter 'skill_id' is set + fail "Missing the required parameter 'skill_id' when calling delete_skills_skill_id" if skill_id.nil? - # verify the required parameter 'id' is set - fail "Missing the required parameter 'id' when calling get_email_domains_domain_routes_id" if id.nil? - # resource path - path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s) + local_var_path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s) # query parameters query_params = {} # header parameters @@ -353,57 +386,54 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'InboundRoute') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_skills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Update a route + # Remove routing skill from user # - # @param domain email domain - # @param id route ID + # @param user_id User ID + # @param skill_id # @param [Hash] opts the optional parameters - # @option opts [InboundRoute] :body Route - # @return [InboundRoute] - def put_email_domains_domain_routes_id(domain, id, opts = {}) - data, status_code, headers = put_email_domains_domain_routes_id_with_http_info(domain, id, opts) + # @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 - # Update a route + # Remove routing skill from user # - # @param domain email domain - # @param id route ID + # @param user_id User ID + # @param skill_id # @param [Hash] opts the optional parameters - # @option opts [InboundRoute] :body Route - # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers - def put_email_domains_domain_routes_id_with_http_info(domain, id, opts = {}) + # @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#put_email_domains_domain_routes_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_user_id_routingskills_skill_id ..." end - # verify the required parameter 'domain' is set - fail "Missing the required parameter 'domain' when calling put_email_domains_domain_routes_id" if domain.nil? + # verify the required parameter 'user_id' is set + fail "Missing the required parameter 'user_id' when calling delete_user_id_routingskills_skill_id" if user_id.nil? - # verify the required parameter 'id' is set - fail "Missing the required parameter 'id' when calling put_email_domains_domain_routes_id" if id.nil? + # verify the required parameter 'skill_id' is set + fail "Missing the required parameter 'skill_id' when calling delete_user_id_routingskills_skill_id" if skill_id.nil? # resource path - path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s) + local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s) # query parameters query_params = {} # header parameters @@ -419,57 +449,46 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PUT, path, + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'InboundRoute') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#put_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_user_id_routingskills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete a route + # Delete utilization settings and revert to system defaults. # - # @param domain email domain - # @param id route ID # @param [Hash] opts the optional parameters # @return [String] - def delete_email_domains_domain_routes_id(domain, id, opts = {}) - data, status_code, headers = delete_email_domains_domain_routes_id_with_http_info(domain, id, opts) + def delete_utilization(opts = {}) + data, status_code, headers = delete_utilization_with_http_info(opts) return data end - # Delete a route + # Delete utilization settings and revert to system defaults. # - # @param domain email domain - # @param id route ID # @param [Hash] opts the optional parameters # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_email_domains_domain_routes_id_with_http_info(domain, id, opts = {}) + def delete_utilization_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_domain_routes_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_utilization ..." end - # verify the required parameter 'domain' is set - fail "Missing the required parameter 'domain' when calling delete_email_domains_domain_routes_id" if domain.nil? - - # verify the required parameter 'id' is set - fail "Missing the required parameter 'id' when calling delete_email_domains_domain_routes_id" if id.nil? - # resource path - path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s) + local_var_path = "/api/v2/routing/utilization".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -487,50 +506,49 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete a domain + # Delete wrap-up code # - # @param id domain ID + # @param code_id Wrapup Code ID # @param [Hash] opts the optional parameters # @return [String] - def delete_email_domains_id(id, opts = {}) - data, status_code, headers = delete_email_domains_id_with_http_info(id, opts) + def delete_wrapupcodes_code_id(code_id, opts = {}) + data, status_code, headers = delete_wrapupcodes_code_id_with_http_info(code_id, opts) return data end - # Delete a domain + # Delete wrap-up code # - # @param id domain ID + # @param code_id Wrapup Code ID # @param [Hash] opts the optional parameters # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_email_domains_id_with_http_info(id, opts = {}) + def delete_wrapupcodes_code_id_with_http_info(code_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#delete_wrapupcodes_code_id ..." end - # verify the required parameter 'id' is set - fail "Missing the required parameter 'id' when calling delete_email_domains_id" if id.nil? + # verify the required parameter 'code_id' is set + fail "Missing the required parameter 'code_id' when calling delete_wrapupcodes_code_id" if code_id.nil? # resource path - path = "/api/v2/routing/email/domains/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) + local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters @@ -548,45 +566,44 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#delete_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get email setup + # Get domains # # @param [Hash] opts the optional parameters - # @return [EmailSetup] - def get_email_setup(opts = {}) - data, status_code, headers = get_email_setup_with_http_info(opts) + # @return [InboundDomainEntityListing] + def get_email_domains(opts = {}) + data, status_code, headers = get_email_domains_with_http_info(opts) return data end - # Get email setup + # Get domains # # @param [Hash] opts the optional parameters - # @return [Array<(EmailSetup, Fixnum, Hash)>] EmailSetup data, response status code and response headers - def get_email_setup_with_http_info(opts = {}) + # @return [Array<(InboundDomainEntityListing, Fixnum, Hash)>] InboundDomainEntityListing data, response status code and response headers + def get_email_domains_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_email_setup ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains ..." end # resource path - path = "/api/v2/routing/email/setup".sub('{format}','json') + local_var_path = "/api/v2/routing/email/domains".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -604,63 +621,52 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + 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 => 'EmailSetup') + :return_type => 'InboundDomainEntityListing') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_email_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @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 list of queues. + # Get routes # + # @param domain email domain # @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] :name Name - # @option opts [BOOLEAN] :active Active - # @return [QueueEntityListing] - def get_queues(opts = {}) - data, status_code, headers = get_queues_with_http_info(opts) + # @return [InboundRouteEntityListing] + def get_email_domains_domain_routes(domain, opts = {}) + data, status_code, headers = get_email_domains_domain_routes_with_http_info(domain, opts) return data end - # Get list of queues. + # Get routes # + # @param domain email domain # @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] :name Name - # @option opts [BOOLEAN] :active Active - # @return [Array<(QueueEntityListing, Fixnum, Hash)>] QueueEntityListing data, response status code and response headers - def get_queues_with_http_info(opts = {}) + # @return [Array<(InboundRouteEntityListing, Fixnum, Hash)>] InboundRouteEntityListing data, response status code and response headers + def get_email_domains_domain_routes_with_http_info(domain, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_queues ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domain_routes ..." end + # verify the required parameter 'domain' is set + fail "Missing the required parameter 'domain' when calling get_email_domains_domain_routes" if domain.nil? + # resource path - path = "/api/v2/routing/queues".sub('{format}','json') + local_var_path = "/api/v2/routing/email/domains/{domain}/routes".sub('{format}','json').sub('{' + 'domain' + '}', domain.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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by'] - query_params[:'name'] = opts[:'name'] if opts[:'name'] - query_params[:'active'] = opts[:'active'] if opts[:'active'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -675,47 +681,54 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + 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 => 'QueueEntityListing') + :return_type => 'InboundRouteEntityListing') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domain_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Create queue + # Get a route # + # @param domain email domain + # @param id route ID # @param [Hash] opts the optional parameters - # @option opts [Queue] :body Queue - # @return [Queue] - def post_queues(opts = {}) - data, status_code, headers = post_queues_with_http_info(opts) + # @return [InboundRoute] + def get_email_domains_domain_routes_id(domain, id, opts = {}) + data, status_code, headers = get_email_domains_domain_routes_id_with_http_info(domain, id, opts) return data end - # Create queue + # Get a route # + # @param domain email domain + # @param id route ID # @param [Hash] opts the optional parameters - # @option opts [Queue] :body Queue - # @return [Array<(Queue, Fixnum, Hash)>] Queue data, response status code and response headers - def post_queues_with_http_info(opts = {}) + # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers + def get_email_domains_domain_routes_id_with_http_info(domain, id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#post_queues ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domain_routes_id ..." end + # verify the required parameter 'domain' is set + fail "Missing the required parameter 'domain' when calling get_email_domains_domain_routes_id" if domain.nil? + + # verify the required parameter 'id' is set + fail "Missing the required parameter 'id' when calling get_email_domains_domain_routes_id" if id.nil? + # resource path - path = "/api/v2/routing/queues".sub('{format}','json') + local_var_path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters @@ -731,52 +744,46 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + 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 => 'Queue') + :return_type => 'InboundRoute') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#post_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get details about this queue. + # Get email setup # - # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @return [Queue] - def get_queues_queue_id(queue_id, opts = {}) - data, status_code, headers = get_queues_queue_id_with_http_info(queue_id, opts) + # @return [EmailSetup] + def get_email_setup(opts = {}) + data, status_code, headers = get_email_setup_with_http_info(opts) return data end - # Get details about this queue. + # Get email setup # - # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @return [Array<(Queue, Fixnum, Hash)>] Queue data, response status code and response headers - def get_queues_queue_id_with_http_info(queue_id, opts = {}) + # @return [Array<(EmailSetup, Fixnum, Hash)>] EmailSetup data, response status code and response headers + def get_email_setup_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_email_setup ..." end - # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id" if queue_id.nil? - # resource path - path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) + local_var_path = "/api/v2/routing/email/setup".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -794,55 +801,62 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + 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 => 'Queue') + :return_type => 'EmailSetup') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#get_email_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Update a queue + # Get list of queues. # - # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [Queue] :body Queue - # @return [Queue] - def put_queues_queue_id(queue_id, opts = {}) - data, status_code, headers = put_queues_queue_id_with_http_info(queue_id, opts) + # @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] :name Name + # @option opts [BOOLEAN] :active Active + # @return [QueueEntityListing] + def get_queues(opts = {}) + data, status_code, headers = get_queues_with_http_info(opts) return data end - # Update a queue + # Get list of queues. # - # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [Queue] :body Queue - # @return [Array<(Queue, Fixnum, Hash)>] Queue data, response status code and response headers - def put_queues_queue_id_with_http_info(queue_id, opts = {}) + # @option opts [Integer] :page_size Page size + # @option opts [Integer] :page_number Page number + # @option opts [String] :sort_by Sort by + # @option opts [String] :name Name + # @option opts [BOOLEAN] :active Active + # @return [Array<(QueueEntityListing, Fixnum, Hash)>] QueueEntityListing data, response status code and response headers + def get_queues_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#put_queues_queue_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_queues ..." end - # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling put_queues_queue_id" if queue_id.nil? - # resource path - path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) + local_var_path = "/api/v2/routing/queues".sub('{format}','json') # 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[:'name'] = opts[:'name'] if opts[:'name'] + query_params[:'active'] = opts[:'active'] if opts[:'active'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -855,58 +869,54 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PUT, path, + 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 => 'Queue') + :return_type => 'QueueEntityListing') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#put_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#get_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete a queue + # Get details about this queue. # # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [BOOLEAN] :force_delete - # @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 [Queue] + def get_queues_queue_id(queue_id, opts = {}) + data, status_code, headers = get_queues_queue_id_with_http_info(queue_id, opts) return data end - # Delete a queue + # Get details about this queue. # # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [BOOLEAN] :force_delete - # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_queues_queue_id_with_http_info(queue_id, opts = {}) + # @return [Array<(Queue, Fixnum, Hash)>] Queue data, response status code and response headers + def get_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 ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id ..." end # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id" if queue_id.nil? + fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id" if queue_id.nil? # resource path - path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) + local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} - query_params[:'forceDelete'] = opts[:'force_delete'] if opts[:'force_delete'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -921,21 +931,20 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + 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 => 'String') + :return_type => 'Queue') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @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 Estimated Wait Time @@ -962,11 +971,11 @@ # 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? # resource path - path = "/api/v2/routing/queues/{queueId}/estimatedwaittime".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[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id'] @@ -985,13 +994,12 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + 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, @@ -1004,15 +1012,15 @@ # Get the members of this queue # # @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 [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 + # @option opts [BOOLEAN] :direct_members Only get users that are direct members of the queue (default to false) # @return [QueueMember] 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 @@ -1034,11 +1042,11 @@ # verify the required parameter 'queue_id' is set fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_users" if queue_id.nil? # resource path - path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) + local_var_path = "/api/v2/routing/queues/{queueId}/users".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'] @@ -1061,13 +1069,12 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + 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, @@ -1076,43 +1083,43 @@ @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 - # Bulk add or delete up to 100 queue members + # Get the wrap-up codes for a queue # # @param queue_id Queue ID + # @param code_id Code ID # @param [Hash] opts the optional parameters - # @option opts [Array<QueueMember>] :body Queue Members - # @option opts [BOOLEAN] :delete True to delete queue members - # @return [QueueMember] - def post_queues_queue_id_users(queue_id, opts = {}) - data, status_code, headers = post_queues_queue_id_users_with_http_info(queue_id, opts) + # @return [WrapupCode] + 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 - # Bulk add or delete up to 100 queue members + # Get the wrap-up codes for a queue # # @param queue_id Queue ID + # @param code_id Code ID # @param [Hash] opts the optional parameters - # @option opts [Array<QueueMember>] :body Queue Members - # @option opts [BOOLEAN] :delete True to delete queue members - # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers - def post_queues_queue_id_users_with_http_info(queue_id, opts = {}) + # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode 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#post_queues_queue_id_users ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_wrapupcodes ..." end # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling post_queues_queue_id_users" if queue_id.nil? + fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_wrapupcodes" if queue_id.nil? + # verify the required parameter 'code_id' is set + fail "Missing the required parameter 'code_id' when calling get_queues_queue_id_wrapupcodes" if code_id.nil? + # resource path - path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) + local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} - query_params[:'delete'] = opts[:'delete'] if opts[:'delete'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -1125,57 +1132,55 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + 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 => 'QueueMember') + :return_type => 'WrapupCode') 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}" + @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 - # Join or unjoin a set of users for a queue + # Get the list of routing skills. # - # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [Array<QueueMember>] :body Queue Members - # @return [QueueMember] - def patch_queues_queue_id_users(queue_id, opts = {}) - data, status_code, headers = patch_queues_queue_id_users_with_http_info(queue_id, opts) + # @option opts [Integer] :page_size Page size (default to 25) + # @option opts [Integer] :page_number Page number (default to 1) + # @return [SkillEntityListing] + def get_skills(opts = {}) + data, status_code, headers = get_skills_with_http_info(opts) return data end - # Join or unjoin a set of users for a queue + # Get the list of routing skills. # - # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [Array<QueueMember>] :body Queue Members - # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers - def patch_queues_queue_id_users_with_http_info(queue_id, opts = {}) + # @option opts [Integer] :page_size Page size + # @option opts [Integer] :page_number Page number + # @return [Array<(SkillEntityListing, Fixnum, Hash)>] SkillEntityListing data, response status code and response headers + def get_skills_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#patch_queues_queue_id_users ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_skills ..." end - # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling patch_queues_queue_id_users" if queue_id.nil? - # resource path - path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) + local_var_path = "/api/v2/routing/skills".sub('{format}','json') # 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) @@ -1188,57 +1193,51 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PATCH, path, + 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 => 'QueueMember') + :return_type => 'SkillEntityListing') 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}" + @api_client.config.logger.debug "API called: RoutingApi#get_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete queue member + # Get Routing Skill # - # @param queue_id Queue ID - # @param member_id Member ID + # @param skill_id Skill ID # @param [Hash] opts the optional parameters - # @return [String] - def delete_queues_queue_id_users_member_id(queue_id, member_id, opts = {}) - data, status_code, headers = delete_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts) + # @return [RoutingSkill] + def get_skills_skill_id(skill_id, opts = {}) + data, status_code, headers = get_skills_skill_id_with_http_info(skill_id, opts) return data end - # Delete queue member + # Get Routing Skill # - # @param queue_id Queue ID - # @param member_id Member ID + # @param skill_id Skill ID # @param [Hash] opts the optional parameters - # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts = {}) + # @return [Array<(RoutingSkill, Fixnum, Hash)>] RoutingSkill data, response status code and response headers + def get_skills_skill_id_with_http_info(skill_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id_users_member_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_skills_skill_id ..." end - # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id_users_member_id" if queue_id.nil? + # verify the required parameter 'skill_id' is set + fail "Missing the required parameter 'skill_id' when calling get_skills_skill_id" if skill_id.nil? - # verify the required parameter 'member_id' is set - fail "Missing the required parameter 'member_id' when calling delete_queues_queue_id_users_member_id" if member_id.nil? - # resource path - path = "/api/v2/routing/queues/{queueId}/users/{memberId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s) + local_var_path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s) # query parameters query_params = {} # header parameters @@ -1256,60 +1255,65 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + 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 => 'String') + :return_type => 'RoutingSkill') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id_users_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#get_skills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Update the ring number of joined status for a User in a Queue + # List routing skills for user # - # @param queue_id Queue ID - # @param member_id Member ID + # @param user_id User ID # @param [Hash] opts the optional parameters - # @option opts [QueueMember] :body Queue Member - # @return [QueueMember] - def patch_queues_queue_id_users_member_id(queue_id, member_id, opts = {}) - data, status_code, headers = patch_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts) + # @option opts [Integer] :page_size Page size (default to 25) + # @option opts [Integer] :page_number Page number (default to 1) + # @option opts [String] :sort_order Ascending or descending sort order (default to ASC) + # @return [UserSkillEntityListing] + def get_user_id_routingskills(user_id, opts = {}) + data, status_code, headers = get_user_id_routingskills_with_http_info(user_id, opts) return data end - # Update the ring number of joined status for a User in a Queue + # List routing skills for user # - # @param queue_id Queue ID - # @param member_id Member ID + # @param user_id User ID # @param [Hash] opts the optional parameters - # @option opts [QueueMember] :body Queue Member - # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers - def patch_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts = {}) + # @option opts [Integer] :page_size Page size + # @option opts [Integer] :page_number Page number + # @option opts [String] :sort_order Ascending or descending sort order + # @return [Array<(UserSkillEntityListing, Fixnum, Hash)>] UserSkillEntityListing data, response status code and response headers + def get_user_id_routingskills_with_http_info(user_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#patch_queues_queue_id_users_member_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_user_id_routingskills ..." end - # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling patch_queues_queue_id_users_member_id" if queue_id.nil? + # verify the required parameter 'user_id' is set + fail "Missing the required parameter 'user_id' when calling get_user_id_routingskills" if user_id.nil? - # verify the required parameter 'member_id' is set - fail "Missing the required parameter 'member_id' when calling patch_queues_queue_id_users_member_id" if member_id.nil? + if opts[:'sort_order'] && !['[ascending', 'descending]'].include?(opts[:'sort_order']) + fail 'invalid value for "sort_order", must be one of [ascending, descending]' + end # resource path - path = "/api/v2/routing/queues/{queueId}/users/{memberId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s) + local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -1322,57 +1326,46 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PATCH, path, + 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 => 'QueueMember') + :return_type => 'UserSkillEntityListing') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#patch_queues_queue_id_users_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#get_user_id_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get the wrap-up codes for a queue + # Get the utilization settings. # - # @param queue_id Queue ID - # @param code_id Code ID # @param [Hash] opts the optional parameters - # @return [WrapupCode] - 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 [Utilization] + def get_utilization(opts = {}) + data, status_code, headers = get_utilization_with_http_info(opts) return data end - # Get the wrap-up codes for a queue + # Get the utilization settings. # - # @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 - def get_queues_queue_id_wrapupcodes_with_http_info(queue_id, code_id, opts = {}) + # @return [Array<(Utilization, Fixnum, Hash)>] Utilization data, response status code and response headers + def get_utilization_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_wrapupcodes ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_utilization ..." end - # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_wrapupcodes" if queue_id.nil? - - # verify the required parameter 'code_id' is set - fail "Missing the required parameter 'code_id' when calling get_queues_queue_id_wrapupcodes" if code_id.nil? - # resource path - path = "/api/v2/routing/queues/{queueId}/wrapupcodes".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'codeId' + '}', code_id.to_s) + local_var_path = "/api/v2/routing/utilization".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -1390,60 +1383,56 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + 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 => 'WrapupCode') + :return_type => 'Utilization') 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}" + @api_client.config.logger.debug "API called: RoutingApi#get_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Add up to 100 wrap-up codes to a queue + # Get list of wrapup codes. # - # @param queue_id Queue ID - # @param code_id Code ID # @param [Hash] opts the optional parameters - # @option opts [Array<WrapupCode>] :body - # @return [WrapupCode] - def post_queues_queue_id_wrapupcodes(queue_id, code_id, opts = {}) - data, status_code, headers = post_queues_queue_id_wrapupcodes_with_http_info(queue_id, code_id, opts) + # @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) + # @return [WrapupCodeEntityListing] + def get_wrapupcodes(opts = {}) + data, status_code, headers = get_wrapupcodes_with_http_info(opts) return data end - # Add up to 100 wrap-up codes to a queue + # Get list of wrapup codes. # - # @param queue_id Queue ID - # @param code_id Code ID # @param [Hash] opts the optional parameters - # @option opts [Array<WrapupCode>] :body - # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers - def post_queues_queue_id_wrapupcodes_with_http_info(queue_id, code_id, opts = {}) + # @option opts [Integer] :page_size Page size + # @option opts [Integer] :page_number Page number + # @option opts [String] :sort_by Sort by + # @return [Array<(WrapupCodeEntityListing, Fixnum, Hash)>] WrapupCodeEntityListing data, response status code and response headers + def get_wrapupcodes_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_queue_id_wrapupcodes ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_wrapupcodes ..." end - # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling post_queues_queue_id_wrapupcodes" if queue_id.nil? - - # verify the required parameter 'code_id' is set - fail "Missing the required parameter 'code_id' when calling post_queues_queue_id_wrapupcodes" if code_id.nil? - # resource path - path = "/api/v2/routing/queues/{queueId}/wrapupcodes".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'codeId' + '}', code_id.to_s) + local_var_path = "/api/v2/routing/wrapupcodes".sub('{format}','json') # 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'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -1456,57 +1445,51 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + 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 => 'WrapupCode') + :return_type => 'WrapupCodeEntityListing') 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}" + @api_client.config.logger.debug "API called: RoutingApi#get_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete a wrap-up code from a queue + # Get details about this wrap-up code. # - # @param queue_id Queue ID - # @param code_id Code ID + # @param code_id Wrapup Code ID # @param [Hash] opts the optional parameters - # @return [String] - def delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id, opts = {}) - data, status_code, headers = delete_queues_queue_id_wrapupcodes_code_id_with_http_info(queue_id, code_id, opts) + # @return [WrapupCode] + def get_wrapupcodes_code_id(code_id, opts = {}) + data, status_code, headers = get_wrapupcodes_code_id_with_http_info(code_id, opts) return data end - # Delete a wrap-up code from a queue + # Get details about this wrap-up code. # - # @param queue_id Queue ID - # @param code_id Code ID + # @param code_id Wrapup Code ID # @param [Hash] opts the optional parameters - # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_queues_queue_id_wrapupcodes_code_id_with_http_info(queue_id, code_id, opts = {}) + # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers + def get_wrapupcodes_code_id_with_http_info(code_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#delete_queues_queue_id_wrapupcodes_code_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#get_wrapupcodes_code_id ..." end - # verify the required parameter 'queue_id' is set - fail "Missing the required parameter 'queue_id' when calling delete_queues_queue_id_wrapupcodes_code_id" if queue_id.nil? - # verify the required parameter 'code_id' is set - fail "Missing the required parameter 'code_id' when calling delete_queues_queue_id_wrapupcodes_code_id" if code_id.nil? + fail "Missing the required parameter 'code_id' when calling get_wrapupcodes_code_id" if code_id.nil? # resource path - path = "/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'codeId' + '}', code_id.to_s) + local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters @@ -1524,54 +1507,54 @@ form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + 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 => 'String') + :return_type => 'WrapupCode') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_queues_queue_id_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#get_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get the list of routing skills. + # Join or unjoin a set of users for a queue # + # @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 [SkillEntityListing] - def get_skills(opts = {}) - data, status_code, headers = get_skills_with_http_info(opts) + # @option opts [Array<QueueMember>] :body Queue Members + # @return [QueueMember] + def patch_queues_queue_id_users(queue_id, opts = {}) + data, status_code, headers = patch_queues_queue_id_users_with_http_info(queue_id, opts) return data end - # Get the list of routing skills. + # Join or unjoin a set of users for a queue # + # @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<(SkillEntityListing, Fixnum, Hash)>] SkillEntityListing data, response status code and response headers - def get_skills_with_http_info(opts = {}) + # @option opts [Array<QueueMember>] :body Queue Members + # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers + def patch_queues_queue_id_users_with_http_info(queue_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_skills ..." + @api_client.config.logger.debug "Calling API: RoutingApi#patch_queues_queue_id_users ..." end + # verify the required parameter 'queue_id' is set + fail "Missing the required parameter 'queue_id' when calling patch_queues_queue_id_users" if queue_id.nil? + # resource path - path = "/api/v2/routing/skills".sub('{format}','json') + local_var_path = "/api/v2/routing/queues/{queueId}/users".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) @@ -1584,49 +1567,58 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'SkillEntityListing') + :return_type => 'QueueMember') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @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 - # Create Skill + # Update the ring number of joined status for a User in a Queue # + # @param queue_id Queue ID + # @param member_id Member ID # @param [Hash] opts the optional parameters - # @option opts [RoutingSkill] :body Skill - # @return [RoutingSkill] - def post_skills(opts = {}) - data, status_code, headers = post_skills_with_http_info(opts) + # @option opts [QueueMember] :body Queue Member + # @return [QueueMember] + def patch_queues_queue_id_users_member_id(queue_id, member_id, opts = {}) + data, status_code, headers = patch_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts) return data end - # Create Skill + # Update the ring number of joined status for a User in a Queue # + # @param queue_id Queue ID + # @param member_id Member ID # @param [Hash] opts the optional parameters - # @option opts [RoutingSkill] :body Skill - # @return [Array<(RoutingSkill, Fixnum, Hash)>] RoutingSkill data, response status code and response headers - def post_skills_with_http_info(opts = {}) + # @option opts [QueueMember] :body Queue Member + # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers + def patch_queues_queue_id_users_member_id_with_http_info(queue_id, member_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#post_skills ..." + @api_client.config.logger.debug "Calling API: RoutingApi#patch_queues_queue_id_users_member_id ..." end + # verify the required parameter 'queue_id' is set + fail "Missing the required parameter 'queue_id' when calling patch_queues_queue_id_users_member_id" if queue_id.nil? + + # verify the required parameter 'member_id' is set + fail "Missing the required parameter 'member_id' when calling patch_queues_queue_id_users_member_id" if member_id.nil? + # resource path - path = "/api/v2/routing/skills".sub('{format}','json') + local_var_path = "/api/v2/routing/queues/{queueId}/users/{memberId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s) # query parameters query_params = {} # header parameters @@ -1644,50 +1636,46 @@ form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'RoutingSkill') + :return_type => 'QueueMember') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#post_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#patch_queues_queue_id_users_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get Routing Skill + # Create a domain # - # @param skill_id Skill ID # @param [Hash] opts the optional parameters - # @return [RoutingSkill] - def get_skills_skill_id(skill_id, opts = {}) - data, status_code, headers = get_skills_skill_id_with_http_info(skill_id, opts) + # @option opts [InboundDomain] :body Domain + # @return [InboundDomain] + def post_email_domains(opts = {}) + data, status_code, headers = post_email_domains_with_http_info(opts) return data end - # Get Routing Skill + # Create a domain # - # @param skill_id Skill ID # @param [Hash] opts the optional parameters - # @return [Array<(RoutingSkill, Fixnum, Hash)>] RoutingSkill data, response status code and response headers - def get_skills_skill_id_with_http_info(skill_id, opts = {}) + # @option opts [InboundDomain] :body Domain + # @return [Array<(InboundDomain, Fixnum, Hash)>] InboundDomain data, response status code and response headers + def post_email_domains_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_skills_skill_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_email_domains ..." end - # verify the required parameter 'skill_id' is set - fail "Missing the required parameter 'skill_id' when calling get_skills_skill_id" if skill_id.nil? - # resource path - path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s) + local_var_path = "/api/v2/routing/email/domains".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -1703,54 +1691,53 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'RoutingSkill') + :return_type => 'InboundDomain') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_skills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#post_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Update Routing Skill + # Create a route # - # @param skill_id Skill ID + # @param domain email domain # @param [Hash] opts the optional parameters - # @option opts [RoutingSkill] :body Skill - # @return [RoutingSkill] - def put_skills_skill_id(skill_id, opts = {}) - data, status_code, headers = put_skills_skill_id_with_http_info(skill_id, opts) + # @option opts [InboundRoute] :body Route + # @return [InboundRoute] + def post_email_domains_domain_routes(domain, opts = {}) + data, status_code, headers = post_email_domains_domain_routes_with_http_info(domain, opts) return data end - # Update Routing Skill + # Create a route # - # @param skill_id Skill ID + # @param domain email domain # @param [Hash] opts the optional parameters - # @option opts [RoutingSkill] :body Skill - # @return [Array<(RoutingSkill, Fixnum, Hash)>] RoutingSkill data, response status code and response headers - def put_skills_skill_id_with_http_info(skill_id, opts = {}) + # @option opts [InboundRoute] :body Route + # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers + def post_email_domains_domain_routes_with_http_info(domain, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#put_skills_skill_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_email_domains_domain_routes ..." end - # verify the required parameter 'skill_id' is set - fail "Missing the required parameter 'skill_id' when calling put_skills_skill_id" if skill_id.nil? + # verify the required parameter 'domain' is set + fail "Missing the required parameter 'domain' when calling post_email_domains_domain_routes" if domain.nil? # resource path - path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s) + local_var_path = "/api/v2/routing/email/domains/{domain}/routes".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s) # query parameters query_params = {} # header parameters @@ -1768,50 +1755,46 @@ form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PUT, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'RoutingSkill') + :return_type => 'InboundRoute') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#put_skills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#post_email_domains_domain_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete Routing Skill + # Create queue # - # @param skill_id Skill ID # @param [Hash] opts the optional parameters - # @return [String] - def delete_skills_skill_id(skill_id, opts = {}) - data, status_code, headers = delete_skills_skill_id_with_http_info(skill_id, opts) + # @option opts [Queue] :body Queue + # @return [Queue] + def post_queues(opts = {}) + data, status_code, headers = post_queues_with_http_info(opts) return data end - # Delete Routing Skill + # Create queue # - # @param skill_id Skill ID # @param [Hash] opts the optional parameters - # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_skills_skill_id_with_http_info(skill_id, opts = {}) + # @option opts [Queue] :body Queue + # @return [Array<(Queue, Fixnum, Hash)>] Queue data, response status code and response headers + def post_queues_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#delete_skills_skill_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_queues ..." end - # verify the required parameter 'skill_id' is set - fail "Missing the required parameter 'skill_id' when calling delete_skills_skill_id" if skill_id.nil? - # resource path - path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s) + local_var_path = "/api/v2/routing/queues".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -1827,47 +1810,48 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'String') + :return_type => 'Queue') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_skills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#post_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get the utilization settings. + # Query for queue observations # # @param [Hash] opts the optional parameters - # @return [Utilization] - def get_utilization(opts = {}) - data, status_code, headers = get_utilization_with_http_info(opts) + # @option opts [ObservationQuery] :body query + # @return [ObservationQueryResponse] + def post_queues_observations_query(opts = {}) + data, status_code, headers = post_queues_observations_query_with_http_info(opts) return data end - # Get the utilization settings. + # Query for queue observations # # @param [Hash] opts the optional parameters - # @return [Array<(Utilization, Fixnum, Hash)>] Utilization data, response status code and response headers - def get_utilization_with_http_info(opts = {}) + # @option opts [ObservationQuery] :body query + # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers + def post_queues_observations_query_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_utilization ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_observations_query ..." end # resource path - path = "/api/v2/routing/utilization".sub('{format}','json') + local_var_path = "/api/v2/analytics/queues/observations/query".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -1883,52 +1867,59 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'Utilization') + :return_type => 'ObservationQueryResponse') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#post_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Update the utilization settings. + # Bulk add or delete up to 100 queue members # + # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [Utilization] :body utilization - # @return [Utilization] - def put_utilization(opts = {}) - data, status_code, headers = put_utilization_with_http_info(opts) + # @option opts [Array<QueueMember>] :body Queue Members + # @option opts [BOOLEAN] :delete True to delete queue members (default to false) + # @return [QueueMember] + def post_queues_queue_id_users(queue_id, opts = {}) + data, status_code, headers = post_queues_queue_id_users_with_http_info(queue_id, opts) return data end - # Update the utilization settings. + # Bulk add or delete up to 100 queue members # + # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @option opts [Utilization] :body utilization - # @return [Array<(Utilization, Fixnum, Hash)>] Utilization data, response status code and response headers - def put_utilization_with_http_info(opts = {}) + # @option opts [Array<QueueMember>] :body Queue Members + # @option opts [BOOLEAN] :delete True to delete queue members + # @return [Array<(QueueMember, Fixnum, Hash)>] QueueMember data, response status code and response headers + def post_queues_queue_id_users_with_http_info(queue_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#put_utilization ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_queue_id_users ..." end + # verify the required parameter 'queue_id' is set + fail "Missing the required parameter 'queue_id' when calling post_queues_queue_id_users" if queue_id.nil? + # resource path - path = "/api/v2/routing/utilization".sub('{format}','json') + local_var_path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} + query_params[:'delete'] = opts[:'delete'] if opts[:'delete'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -1943,45 +1934,56 @@ form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PUT, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'Utilization') + :return_type => 'QueueMember') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#put_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @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 - # Delete utilization settings and revert to system defaults. + # Add up to 100 wrap-up codes to a queue # + # @param queue_id Queue ID + # @param code_id Code ID # @param [Hash] opts the optional parameters - # @return [String] - def delete_utilization(opts = {}) - data, status_code, headers = delete_utilization_with_http_info(opts) + # @option opts [Array<WrapupCode>] :body + # @return [WrapupCode] + def post_queues_queue_id_wrapupcodes(queue_id, code_id, opts = {}) + data, status_code, headers = post_queues_queue_id_wrapupcodes_with_http_info(queue_id, code_id, opts) return data end - # Delete utilization settings and revert to system defaults. + # Add up to 100 wrap-up codes to a queue # + # @param queue_id Queue ID + # @param code_id Code ID # @param [Hash] opts the optional parameters - # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_utilization_with_http_info(opts = {}) + # @option opts [Array<WrapupCode>] :body + # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers + def post_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#delete_utilization ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_queues_queue_id_wrapupcodes ..." end + # verify the required parameter 'queue_id' is set + fail "Missing the required parameter 'queue_id' when calling post_queues_queue_id_wrapupcodes" if queue_id.nil? + + # verify the required parameter 'code_id' is set + fail "Missing the required parameter 'code_id' when calling post_queues_queue_id_wrapupcodes" if code_id.nil? + # resource path - path = "/api/v2/routing/utilization".sub('{format}','json') + local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters @@ -1997,59 +1999,51 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'String') + :return_type => 'WrapupCode') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @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 - # Get list of wrapup codes. + # Create Skill # # @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 - # @return [WrapupCodeEntityListing] - def get_wrapupcodes(opts = {}) - data, status_code, headers = get_wrapupcodes_with_http_info(opts) + # @option opts [RoutingSkill] :body Skill + # @return [RoutingSkill] + def post_skills(opts = {}) + data, status_code, headers = post_skills_with_http_info(opts) return data end - # Get list of wrapup codes. + # Create Skill # # @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 - # @return [Array<(WrapupCodeEntityListing, Fixnum, Hash)>] WrapupCodeEntityListing data, response status code and response headers - def get_wrapupcodes_with_http_info(opts = {}) + # @option opts [RoutingSkill] :body Skill + # @return [Array<(RoutingSkill, Fixnum, Hash)>] RoutingSkill data, response status code and response headers + def post_skills_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_wrapupcodes ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_skills ..." end # resource path - path = "/api/v2/routing/wrapupcodes".sub('{format}','json') + local_var_path = "/api/v2/routing/skills".sub('{format}','json') # 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'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -2062,49 +2056,53 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'WrapupCodeEntityListing') + :return_type => 'RoutingSkill') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#post_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Create a wrap-up code + # Add routing skill to user # + # @param user_id User ID # @param [Hash] opts the optional parameters - # @option opts [WrapupCode] :body WrapupCode - # @return [CallableTimeSet] - def post_wrapupcodes(opts = {}) - data, status_code, headers = post_wrapupcodes_with_http_info(opts) + # @option opts [UserRoutingSkill] :body Skill + # @return [UserRoutingSkill] + def post_user_id_routingskills(user_id, opts = {}) + data, status_code, headers = post_user_id_routingskills_with_http_info(user_id, opts) return data end - # Create a wrap-up code + # Add routing skill to user # + # @param user_id User ID # @param [Hash] opts the optional parameters - # @option opts [WrapupCode] :body WrapupCode - # @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers - def post_wrapupcodes_with_http_info(opts = {}) + # @option opts [UserRoutingSkill] :body Skill + # @return [Array<(UserRoutingSkill, Fixnum, Hash)>] UserRoutingSkill data, response status code and response headers + def post_user_id_routingskills_with_http_info(user_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#post_wrapupcodes ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_user_id_routingskills ..." end + # verify the required parameter 'user_id' is set + fail "Missing the required parameter 'user_id' when calling post_user_id_routingskills" if user_id.nil? + # resource path - path = "/api/v2/routing/wrapupcodes".sub('{format}','json') + local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters @@ -2122,50 +2120,46 @@ form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'CallableTimeSet') + :return_type => 'UserRoutingSkill') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#post_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#post_user_id_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get details about this wrap-up code. + # Create a wrap-up code # - # @param code_id Wrapup Code ID # @param [Hash] opts the optional parameters - # @return [WrapupCode] - def get_wrapupcodes_code_id(code_id, opts = {}) - data, status_code, headers = get_wrapupcodes_code_id_with_http_info(code_id, opts) + # @option opts [WrapupCode] :body WrapupCode + # @return [CallableTimeSet] + def post_wrapupcodes(opts = {}) + data, status_code, headers = post_wrapupcodes_with_http_info(opts) return data end - # Get details about this wrap-up code. + # Create a wrap-up code # - # @param code_id Wrapup Code ID # @param [Hash] opts the optional parameters - # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers - def get_wrapupcodes_code_id_with_http_info(code_id, opts = {}) + # @option opts [WrapupCode] :body WrapupCode + # @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers + def post_wrapupcodes_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_wrapupcodes_code_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#post_wrapupcodes ..." end - # verify the required parameter 'code_id' is set - fail "Missing the required parameter 'code_id' when calling get_wrapupcodes_code_id" if code_id.nil? - # resource path - path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) + local_var_path = "/api/v2/routing/wrapupcodes".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -2181,54 +2175,58 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'WrapupCode') + :return_type => 'CallableTimeSet') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @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 - # Update wrap-up code + # Update a route # - # @param code_id Wrapup Code ID + # @param domain email domain + # @param id route ID # @param [Hash] opts the optional parameters - # @option opts [WrapupCode] :body WrapupCode - # @return [WrapupCode] - def put_wrapupcodes_code_id(code_id, opts = {}) - data, status_code, headers = put_wrapupcodes_code_id_with_http_info(code_id, opts) + # @option opts [InboundRoute] :body Route + # @return [InboundRoute] + def put_email_domains_domain_routes_id(domain, id, opts = {}) + data, status_code, headers = put_email_domains_domain_routes_id_with_http_info(domain, id, opts) return data end - # Update wrap-up code + # Update a route # - # @param code_id Wrapup Code ID + # @param domain email domain + # @param id route ID # @param [Hash] opts the optional parameters - # @option opts [WrapupCode] :body WrapupCode - # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers - def put_wrapupcodes_code_id_with_http_info(code_id, opts = {}) + # @option opts [InboundRoute] :body Route + # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers + def put_email_domains_domain_routes_id_with_http_info(domain, id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#put_wrapupcodes_code_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#put_email_domains_domain_routes_id ..." end - # verify the required parameter 'code_id' is set - fail "Missing the required parameter 'code_id' when calling put_wrapupcodes_code_id" if code_id.nil? + # verify the required parameter 'domain' is set + fail "Missing the required parameter 'domain' when calling put_email_domains_domain_routes_id" if domain.nil? + # verify the required parameter 'id' is set + fail "Missing the required parameter 'id' when calling put_email_domains_domain_routes_id" if id.nil? + # resource path - path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) + local_var_path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters @@ -2246,50 +2244,51 @@ form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PUT, path, + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'WrapupCode') + :return_type => 'InboundRoute') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#put_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#put_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete wrap-up code + # Update a queue # - # @param code_id Wrapup Code ID + # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @return [String] - def delete_wrapupcodes_code_id(code_id, opts = {}) - data, status_code, headers = delete_wrapupcodes_code_id_with_http_info(code_id, opts) + # @option opts [Queue] :body Queue + # @return [Queue] + def put_queues_queue_id(queue_id, opts = {}) + data, status_code, headers = put_queues_queue_id_with_http_info(queue_id, opts) return data end - # Delete wrap-up code + # Update a queue # - # @param code_id Wrapup Code ID + # @param queue_id Queue ID # @param [Hash] opts the optional parameters - # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_wrapupcodes_code_id_with_http_info(code_id, opts = {}) + # @option opts [Queue] :body Queue + # @return [Array<(Queue, Fixnum, Hash)>] Queue data, response status code and response headers + def put_queues_queue_id_with_http_info(queue_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#delete_wrapupcodes_code_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#put_queues_queue_id ..." end - # verify the required parameter 'code_id' is set - fail "Missing the required parameter 'code_id' when calling delete_wrapupcodes_code_id" if code_id.nil? + # verify the required parameter 'queue_id' is set + fail "Missing the required parameter 'queue_id' when calling put_queues_queue_id" if queue_id.nil? # resource path - path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) + local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s) # query parameters query_params = {} # header parameters @@ -2305,68 +2304,56 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'String') + :return_type => 'Queue') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#put_queues_queue_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # List routing skills for user + # Update Routing Skill # - # @param user_id User ID + # @param skill_id Skill 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_order Ascending or descending sort order - # @return [UserSkillEntityListing] - def get_user_id_routingskills(user_id, opts = {}) - data, status_code, headers = get_user_id_routingskills_with_http_info(user_id, opts) + # @option opts [RoutingSkill] :body Skill + # @return [RoutingSkill] + def put_skills_skill_id(skill_id, opts = {}) + data, status_code, headers = put_skills_skill_id_with_http_info(skill_id, opts) return data end - # List routing skills for user + # Update Routing Skill # - # @param user_id User ID + # @param skill_id Skill 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_order Ascending or descending sort order - # @return [Array<(UserSkillEntityListing, Fixnum, Hash)>] UserSkillEntityListing data, response status code and response headers - def get_user_id_routingskills_with_http_info(user_id, opts = {}) + # @option opts [RoutingSkill] :body Skill + # @return [Array<(RoutingSkill, Fixnum, Hash)>] RoutingSkill data, response status code and response headers + def put_skills_skill_id_with_http_info(skill_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#get_user_id_routingskills ..." + @api_client.config.logger.debug "Calling API: RoutingApi#put_skills_skill_id ..." end - # verify the required parameter 'user_id' is set - fail "Missing the required parameter 'user_id' when calling get_user_id_routingskills" if user_id.nil? + # verify the required parameter 'skill_id' is set + fail "Missing the required parameter 'skill_id' when calling put_skills_skill_id" if skill_id.nil? - if opts[:'sort_order'] && !['[ascending', 'descending]'].include?(opts[:'sort_order']) - fail 'invalid value for "sort_order", must be one of [ascending, descending]' - end - # resource path - path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) + local_var_path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -2379,54 +2366,48 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'UserSkillEntityListing') + :return_type => 'RoutingSkill') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#get_user_id_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#put_skills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Add routing skill to user + # Update the utilization settings. # - # @param user_id User ID # @param [Hash] opts the optional parameters - # @option opts [UserRoutingSkill] :body Skill - # @return [UserRoutingSkill] - def post_user_id_routingskills(user_id, opts = {}) - data, status_code, headers = post_user_id_routingskills_with_http_info(user_id, opts) + # @option opts [Utilization] :body utilization + # @return [Utilization] + def put_utilization(opts = {}) + data, status_code, headers = put_utilization_with_http_info(opts) return data end - # Add routing skill to user + # Update the utilization settings. # - # @param user_id User ID # @param [Hash] opts the optional parameters - # @option opts [UserRoutingSkill] :body Skill - # @return [Array<(UserRoutingSkill, Fixnum, Hash)>] UserRoutingSkill data, response status code and response headers - def post_user_id_routingskills_with_http_info(user_id, opts = {}) + # @option opts [Utilization] :body utilization + # @return [Array<(Utilization, Fixnum, Hash)>] Utilization data, response status code and response headers + def put_utilization_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#post_user_id_routingskills ..." + @api_client.config.logger.debug "Calling API: RoutingApi#put_utilization ..." end - # verify the required parameter 'user_id' is set - fail "Missing the required parameter 'user_id' when calling post_user_id_routingskills" if user_id.nil? - # resource path - path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) + local_var_path = "/api/v2/routing/utilization".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -2444,55 +2425,51 @@ form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:POST, path, + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'UserRoutingSkill') + :return_type => 'Utilization') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#post_user_id_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#put_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Remove routing skill from user + # Update wrap-up code # - # @param user_id User ID - # @param skill_id + # @param code_id Wrapup Code ID # @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) + # @option opts [WrapupCode] :body WrapupCode + # @return [WrapupCode] + def put_wrapupcodes_code_id(code_id, opts = {}) + data, status_code, headers = put_wrapupcodes_code_id_with_http_info(code_id, opts) return data end - # Remove routing skill from user + # Update wrap-up code # - # @param user_id User ID - # @param skill_id + # @param code_id Wrapup Code ID # @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 = {}) + # @option opts [WrapupCode] :body WrapupCode + # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers + def put_wrapupcodes_code_id_with_http_info(code_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: RoutingApi#delete_user_id_routingskills_skill_id ..." + @api_client.config.logger.debug "Calling API: RoutingApi#put_wrapupcodes_code_id ..." end - # verify the required parameter 'user_id' is set - fail "Missing the required parameter 'user_id' when calling delete_user_id_routingskills_skill_id" if user_id.nil? + # verify the required parameter 'code_id' is set + fail "Missing the required parameter 'code_id' when calling put_wrapupcodes_code_id" if code_id.nil? - # verify the required parameter 'skill_id' is set - fail "Missing the required parameter 'skill_id' when calling delete_user_id_routingskills_skill_id" if skill_id.nil? - # resource path - path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s) + local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s) # query parameters query_params = {} # header parameters @@ -2508,27 +2485,22 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) - auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'String') + :return_type => 'WrapupCode') if @api_client.config.debugging - @api_client.config.logger.debug "API called: RoutingApi#delete_user_id_routingskills_skill_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: RoutingApi#put_wrapupcodes_code_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end - - - -