lib/purecloud/api/search_api.rb in purecloud-0.60.1 vs lib/purecloud/api/search_api.rb in purecloud-0.61.1
- old
+ new
@@ -154,11 +154,11 @@
# Search using the q64 value returned from a previous search.
#
# @param q64 q64
# @param [Hash] opts the optional parameters
- # @option opts [Array<String>] :expand expand
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
# @option opts [BOOLEAN] :profile profile (default to true)
# @return [JsonNodeSearchResponse]
def get_search_1(q64, opts = {})
data, status_code, headers = get_search_1_with_http_info(q64, opts)
return data
@@ -166,11 +166,11 @@
# Search using the q64 value returned from a previous search.
#
# @param q64 q64
# @param [Hash] opts the optional parameters
- # @option opts [Array<String>] :expand expand
+ # @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
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 ..."
@@ -281,14 +281,79 @@
@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 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]
+ def get_search_3(q64, opts = {})
+ data, status_code, headers = get_search_3_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
+ 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/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_3\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]
def get_suggest(q64, opts = {})
data, status_code, headers = get_suggest_with_http_info(q64, opts)
return data
@@ -296,10 +361,11 @@
# 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
def get_suggest_with_http_info(q64, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: SearchApi#get_suggest ..."
@@ -312,10 +378,11 @@
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 = {}
@@ -584,9 +651,69 @@
: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_2\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]
+ def post_search_3(body, opts = {})
+ data, status_code, headers = post_search_3_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
+ 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/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_3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Suggest resources.