class PureCloud::SuggestApi
Attributes
Public Class Methods
# File lib/purecloud/api/suggest_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Search using the q64 value returned from a previous search.
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @option opts [BOOLEAN] :profile profile (default to true) @return [JsonNodeSearchResponse]
# File lib/purecloud/api/suggest_api.rb, line 34 def get_search(q64, opts = {}) data, status_code, headers = get_search_with_http_info(q64, opts) return data end
Search using the q64 value returned from a previous search.
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @option opts [BOOLEAN] :profile profile @return [Array<(JsonNodeSearchResponse
, Fixnum, Hash)>] JsonNodeSearchResponse
data, response status code and response headers
# File lib/purecloud/api/suggest_api.rb, line 46 def get_search_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SuggestApi#get_search ..." end # verify the required parameter 'q64' is set fail "Missing the required parameter 'q64' when calling get_search" if q64.nil? # resource path local_var_path = "/api/v2/search".sub('{format}','json') # query parameters query_params = {} query_params[:'q64'] = q64 query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] query_params[:'profile'] = opts[:'profile'] if opts[:'profile'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'JsonNodeSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SuggestApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Suggest resources using the q64 value returned from a previous suggest query.
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @option opts [BOOLEAN] :profile profile (default to true) @return [JsonNodeSearchResponse]
# File lib/purecloud/api/suggest_api.rb, line 101 def get_suggest(q64, opts = {}) data, status_code, headers = get_suggest_with_http_info(q64, opts) return data end
Suggest resources using the q64 value returned from a previous suggest query.
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @option opts [BOOLEAN] :profile profile @return [Array<(JsonNodeSearchResponse
, Fixnum, Hash)>] JsonNodeSearchResponse
data, response status code and response headers
# File lib/purecloud/api/suggest_api.rb, line 113 def get_suggest_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SuggestApi#get_suggest ..." end # verify the required parameter 'q64' is set fail "Missing the required parameter 'q64' when calling get_suggest" if q64.nil? # resource path local_var_path = "/api/v2/search/suggest".sub('{format}','json') # query parameters query_params = {} query_params[:'q64'] = q64 query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] query_params[:'profile'] = opts[:'profile'] if opts[:'profile'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'JsonNodeSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SuggestApi#get_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search resources.
@param body Search request options @param [Hash] opts the optional parameters @option opts [BOOLEAN] :profile profile (default to true) @return [JsonNodeSearchResponse]
# File lib/purecloud/api/suggest_api.rb, line 167 def post_search(body, opts = {}) data, status_code, headers = post_search_with_http_info(body, opts) return data end
Search resources.
@param body Search request options @param [Hash] opts the optional parameters @option opts [BOOLEAN] :profile profile @return [Array<(JsonNodeSearchResponse
, Fixnum, Hash)>] JsonNodeSearchResponse
data, response status code and response headers
# File lib/purecloud/api/suggest_api.rb, line 178 def post_search_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SuggestApi#post_search ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_search" if body.nil? # resource path local_var_path = "/api/v2/search".sub('{format}','json') # query parameters query_params = {} query_params[:'profile'] = opts[:'profile'] if opts[:'profile'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(: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 => 'JsonNodeSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SuggestApi#post_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Suggest resources.
@param body Search request options @param [Hash] opts the optional parameters @option opts [BOOLEAN] :profile profile (default to true) @return [JsonNodeSearchResponse]
# File lib/purecloud/api/suggest_api.rb, line 230 def post_suggest(body, opts = {}) data, status_code, headers = post_suggest_with_http_info(body, opts) return data end
Suggest resources.
@param body Search request options @param [Hash] opts the optional parameters @option opts [BOOLEAN] :profile profile @return [Array<(JsonNodeSearchResponse
, Fixnum, Hash)>] JsonNodeSearchResponse
data, response status code and response headers
# File lib/purecloud/api/suggest_api.rb, line 241 def post_suggest_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SuggestApi#post_suggest ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_suggest" if body.nil? # resource path local_var_path = "/api/v2/search/suggest".sub('{format}','json') # query parameters query_params = {} query_params[:'profile'] = opts[:'profile'] if opts[:'profile'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(: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 => 'JsonNodeSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SuggestApi#post_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end