class PureCloud::SearchApi
Attributes
Public Class Methods
# File lib/purecloud/api/search_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Search documentation using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @return [DocumentationSearchResponse]
# File lib/purecloud/api/search_api.rb, line 32 def get_search(q64, opts = {}) data, status_code, headers = get_search_with_http_info(q64, opts) return data end
Search groups using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [GroupsSearchResponse]
# File lib/purecloud/api/search_api.rb, line 94 def get_search_0(q64, opts = {}) data, status_code, headers = get_search_0_with_http_info(q64, opts) return data end
Search groups using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [Array<(GroupsSearchResponse
, Fixnum, Hash)>] GroupsSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 105 def get_search_0_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_0 ..." end # verify the required parameter 'q64' is set fail "Missing the required parameter 'q64' when calling get_search_0" if q64.nil? # resource path local_var_path = "/api/v2/groups/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'] # 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 => 'GroupsSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#get_search_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search locations using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [LocationsSearchResponse]
# File lib/purecloud/api/search_api.rb, line 158 def get_search_1(q64, opts = {}) data, status_code, headers = get_search_1_with_http_info(q64, opts) return data end
Search locations using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [Array<(LocationsSearchResponse
, Fixnum, Hash)>] LocationsSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 169 def get_search_1_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_1 ..." end # verify the required parameter 'q64' is set fail "Missing the required parameter 'q64' when calling get_search_1" if q64.nil? # resource path local_var_path = "/api/v2/locations/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'] # 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 => 'LocationsSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#get_search_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers 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 (default to true) @return [JsonNodeSearchResponse]
# File lib/purecloud/api/search_api.rb, line 223 def get_search_2(q64, opts = {}) data, status_code, headers = get_search_2_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/search_api.rb, line 235 def get_search_2_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_2 ..." end # verify the required parameter 'q64' is set fail "Missing the required parameter 'q64' when calling get_search_2" 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: SearchApi#get_search_2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search users using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [UsersSearchResponse]
# File lib/purecloud/api/search_api.rb, line 289 def get_search_3(q64, opts = {}) data, status_code, headers = get_search_3_with_http_info(q64, opts) return data end
Search users using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [Array<(UsersSearchResponse
, Fixnum, Hash)>] UsersSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 300 def get_search_3_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_3 ..." end # verify the required parameter 'q64' is set fail "Missing the required parameter 'q64' when calling get_search_3" if q64.nil? # resource path local_var_path = "/api/v2/users/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'] # 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 => 'UsersSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#get_search_3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search voicemails using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [VoicemailsSearchResponse]
# File lib/purecloud/api/search_api.rb, line 353 def get_search_4(q64, opts = {}) data, status_code, headers = get_search_4_with_http_info(q64, opts) return data end
Search voicemails using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [Array<(VoicemailsSearchResponse
, Fixnum, Hash)>] VoicemailsSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 364 def get_search_4_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_4 ..." end # verify the required parameter 'q64' is set fail "Missing the required parameter 'q64' when calling get_search_4" if q64.nil? # resource path local_var_path = "/api/v2/voicemail/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'] # 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 => 'VoicemailsSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#get_search_4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search documentation using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @return [Array<(DocumentationSearchResponse
, Fixnum, Hash)>] DocumentationSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 42 def get_search_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#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/documentation/search".sub('{format}','json') # query parameters query_params = {} query_params[:'q64'] = q64 # 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 => 'DocumentationSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#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/search_api.rb, line 418 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/search_api.rb, line 430 def get_suggest_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#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: SearchApi#get_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search documentation
@param body Search request options @param [Hash] opts the optional parameters @return [DocumentationSearchResponse]
# File lib/purecloud/api/search_api.rb, line 483 def post_search(body, opts = {}) data, status_code, headers = post_search_with_http_info(body, opts) return data end
Search groups
@param body Search request options @param [Hash] opts the optional parameters @return [GroupsSearchResponse]
# File lib/purecloud/api/search_api.rb, line 543 def post_search_0(body, opts = {}) data, status_code, headers = post_search_0_with_http_info(body, opts) return data end
Search groups
@param body Search request options @param [Hash] opts the optional parameters @return [Array<(GroupsSearchResponse
, Fixnum, Hash)>] GroupsSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 553 def post_search_0_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_0 ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_search_0" if body.nil? # resource path local_var_path = "/api/v2/groups/search".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @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 => 'GroupsSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#post_search_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search locations
@param body Search request options @param [Hash] opts the optional parameters @return [LocationsSearchResponse]
# File lib/purecloud/api/search_api.rb, line 603 def post_search_1(body, opts = {}) data, status_code, headers = post_search_1_with_http_info(body, opts) return data end
Search locations
@param body Search request options @param [Hash] opts the optional parameters @return [Array<(LocationsSearchResponse
, Fixnum, Hash)>] LocationsSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 613 def post_search_1_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_1 ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_search_1" if body.nil? # resource path local_var_path = "/api/v2/locations/search".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @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 => 'LocationsSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#post_search_1\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/search_api.rb, line 664 def post_search_2(body, opts = {}) data, status_code, headers = post_search_2_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/search_api.rb, line 675 def post_search_2_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_2 ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_search_2" 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: SearchApi#post_search_2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search users
@param body Search request options @param [Hash] opts the optional parameters @return [UsersSearchResponse]
# File lib/purecloud/api/search_api.rb, line 726 def post_search_3(body, opts = {}) data, status_code, headers = post_search_3_with_http_info(body, opts) return data end
Search users
@param body Search request options @param [Hash] opts the optional parameters @return [Array<(UsersSearchResponse
, Fixnum, Hash)>] UsersSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 736 def post_search_3_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_3 ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_search_3" if body.nil? # resource path local_var_path = "/api/v2/users/search".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @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 => 'UsersSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#post_search_3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search voicemails
@param body Search request options @param [Hash] opts the optional parameters @return [VoicemailsSearchResponse]
# File lib/purecloud/api/search_api.rb, line 786 def post_search_4(body, opts = {}) data, status_code, headers = post_search_4_with_http_info(body, opts) return data end
Search voicemails
@param body Search request options @param [Hash] opts the optional parameters @return [Array<(VoicemailsSearchResponse
, Fixnum, Hash)>] VoicemailsSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 796 def post_search_4_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_4 ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_search_4" if body.nil? # resource path local_var_path = "/api/v2/voicemail/search".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @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 => 'VoicemailsSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#post_search_4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search documentation
@param body Search request options @param [Hash] opts the optional parameters @return [Array<(DocumentationSearchResponse
, Fixnum, Hash)>] DocumentationSearchResponse
data, response status code and response headers
# File lib/purecloud/api/search_api.rb, line 493 def post_search_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#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/documentation/search".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @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 => 'DocumentationSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: SearchApi#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/search_api.rb, line 847 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/search_api.rb, line 858 def post_suggest_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#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: SearchApi#post_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end