lib/purecloud/api/search_api.rb in purecloud-0.44.1 vs lib/purecloud/api/search_api.rb in purecloud-0.45.1
- old
+ new
@@ -24,36 +24,39 @@
@api_client = api_client
end
# Search using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [Array<String>] :expand
# @return [GroupsSearchResponse]
- def get_search(opts = {})
- data, status_code, headers = get_search_with_http_info(opts)
+ def get_search(q64, opts = {})
+ data, status_code, headers = get_search_with_http_info(q64, opts)
return data
end
# Search using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [Array<String>] :expand
# @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
- def get_search_with_http_info(opts = {})
+ 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/groups/search".sub('{format}','json')
# query parameters
query_params = {}
- query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+ query_params[:'q64'] = q64
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
@@ -85,36 +88,39 @@
return data, status_code, headers
end
# Search using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [Array<String>] :expand
# @return [LocationsSearchResponse]
- def get_search_0(opts = {})
- data, status_code, headers = get_search_0_with_http_info(opts)
+ def get_search_0(q64, opts = {})
+ data, status_code, headers = get_search_0_with_http_info(q64, opts)
return data
end
# Search using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [Array<String>] :expand
# @return [Array<(LocationsSearchResponse, Fixnum, Hash)>] LocationsSearchResponse data, response status code and response headers
- def get_search_0_with_http_info(opts = {})
+ 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/locations/search".sub('{format}','json')
# query parameters
query_params = {}
- query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+ query_params[:'q64'] = q64
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
@@ -146,38 +152,41 @@
return data, status_code, headers
end
# Search using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [Array<String>] :expand
# @option opts [BOOLEAN] :profile (default to true)
# @return [JsonNodeSearchResponse]
- def get_search_1(opts = {})
- data, status_code, headers = get_search_1_with_http_info(opts)
+ def get_search_1(q64, opts = {})
+ data, status_code, headers = get_search_1_with_http_info(q64, opts)
return data
end
# Search using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [Array<String>] :expand
# @option opts [BOOLEAN] :profile
# @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
- def get_search_1_with_http_info(opts = {})
+ 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/search".sub('{format}','json')
# query parameters
query_params = {}
- query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+ 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 = {}
@@ -210,36 +219,39 @@
return data, status_code, headers
end
# Search using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [Array<String>] :expand
# @return [UsersSearchResponse]
- def get_search_2(opts = {})
- data, status_code, headers = get_search_2_with_http_info(opts)
+ def get_search_2(q64, opts = {})
+ data, status_code, headers = get_search_2_with_http_info(q64, opts)
return data
end
# Search using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [Array<String>] :expand
# @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
- def get_search_2_with_http_info(opts = {})
+ 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/users/search".sub('{format}','json')
# query parameters
query_params = {}
- query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+ query_params[:'q64'] = q64
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
# header parameters
header_params = {}
@@ -271,36 +283,39 @@
return data, status_code, headers
end
# Suggest using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [BOOLEAN] :profile (default to true)
# @return [JsonNodeSearchResponse]
- def get_suggest(opts = {})
- data, status_code, headers = get_suggest_with_http_info(opts)
+ def get_suggest(q64, opts = {})
+ data, status_code, headers = get_suggest_with_http_info(q64, opts)
return data
end
# Suggest using q64
#
+ # @param q64
# @param [Hash] opts the optional parameters
- # @option opts [String] :q64
# @option opts [BOOLEAN] :profile
# @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
- def get_suggest_with_http_info(opts = {})
+ 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'] = opts[:'q64'] if opts[:'q64']
+ query_params[:'q64'] = q64
query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
# header parameters
header_params = {}
@@ -332,28 +347,31 @@
return data, status_code, headers
end
# Search
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [GroupSearchRequest] :body Search request options
# @return [GroupsSearchResponse]
- def post_search(opts = {})
- data, status_code, headers = post_search_with_http_info(opts)
+ def post_search(body, opts = {})
+ data, status_code, headers = post_search_with_http_info(body, opts)
return data
end
# Search
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [GroupSearchRequest] :body Search request options
# @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
- def post_search_with_http_info(opts = {})
+ 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/groups/search".sub('{format}','json')
# query parameters
query_params = {}
@@ -371,11 +389,11 @@
# form parameters
form_params = {}
# http body (model)
- post_body = @api_client.object_to_http_body(opts[:'body'])
+ 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,
@@ -389,28 +407,31 @@
return data, status_code, headers
end
# Search
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [LocationSearchRequest] :body Search request options
# @return [LocationsSearchResponse]
- def post_search_0(opts = {})
- data, status_code, headers = post_search_0_with_http_info(opts)
+ def post_search_0(body, opts = {})
+ data, status_code, headers = post_search_0_with_http_info(body, opts)
return data
end
# Search
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [LocationSearchRequest] :body Search request options
# @return [Array<(LocationsSearchResponse, Fixnum, Hash)>] LocationsSearchResponse data, response status code and response headers
- def post_search_0_with_http_info(opts = {})
+ 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/locations/search".sub('{format}','json')
# query parameters
query_params = {}
@@ -428,11 +449,11 @@
# form parameters
form_params = {}
# http body (model)
- post_body = @api_client.object_to_http_body(opts[:'body'])
+ 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,
@@ -446,30 +467,33 @@
return data, status_code, headers
end
# Search
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [SearchRequest] :body Search request options
# @option opts [BOOLEAN] :profile (default to true)
# @return [JsonNodeSearchResponse]
- def post_search_1(opts = {})
- data, status_code, headers = post_search_1_with_http_info(opts)
+ def post_search_1(body, opts = {})
+ data, status_code, headers = post_search_1_with_http_info(body, opts)
return data
end
# Search
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [SearchRequest] :body Search request options
# @option opts [BOOLEAN] :profile
# @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
- def post_search_1_with_http_info(opts = {})
+ 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/search".sub('{format}','json')
# query parameters
query_params = {}
@@ -488,11 +512,11 @@
# form parameters
form_params = {}
# http body (model)
- post_body = @api_client.object_to_http_body(opts[:'body'])
+ 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,
@@ -506,28 +530,31 @@
return data, status_code, headers
end
# Search
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [UserSearchRequest] :body Search request options
# @return [UsersSearchResponse]
- def post_search_2(opts = {})
- data, status_code, headers = post_search_2_with_http_info(opts)
+ def post_search_2(body, opts = {})
+ data, status_code, headers = post_search_2_with_http_info(body, opts)
return data
end
# Search
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [UserSearchRequest] :body Search request options
# @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
- def post_search_2_with_http_info(opts = {})
+ 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/users/search".sub('{format}','json')
# query parameters
query_params = {}
@@ -545,11 +572,11 @@
# form parameters
form_params = {}
# http body (model)
- post_body = @api_client.object_to_http_body(opts[:'body'])
+ 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,
@@ -563,30 +590,33 @@
return data, status_code, headers
end
# Suggest
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [SuggestSearchRequest] :body Search request options
# @option opts [BOOLEAN] :profile (default to true)
# @return [JsonNodeSearchResponse]
- def post_suggest(opts = {})
- data, status_code, headers = post_suggest_with_http_info(opts)
+ def post_suggest(body, opts = {})
+ data, status_code, headers = post_suggest_with_http_info(body, opts)
return data
end
# Suggest
#
+ # @param body Search request options
# @param [Hash] opts the optional parameters
- # @option opts [SuggestSearchRequest] :body Search request options
# @option opts [BOOLEAN] :profile
# @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
- def post_suggest_with_http_info(opts = {})
+ 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 = {}
@@ -605,10 +635,10 @@
# form parameters
form_params = {}
# http body (model)
- post_body = @api_client.object_to_http_body(opts[:'body'])
+ 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,