=begin PureCloud Platform API With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more. OpenAPI spec version: v2 Contact: DeveloperEvangelists@inin.com Generated by: https://github.com/swagger-api/swagger-codegen.git License: ININ http://www.inin.com Terms of Service: https://developer.mypurecloud.com/tos =end require "uri" module PureCloud class SearchApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Search using q64 # # @param [Hash] opts the optional parameters # @option opts [String] :q64 # @option opts [Array] :expand # @return [GroupsSearchResponse] def get_search(opts = {}) data, status_code, headers = get_search_with_http_info(opts) return data end # Search using q64 # # @param [Hash] opts the optional parameters # @option opts [String] :q64 # @option opts [Array] :expand # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers def get_search_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search ..." end # 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[:'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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Search using q64 # # @param [Hash] opts the optional parameters # @option opts [String] :q64 # @option opts [Array] :expand # @return [GroupsSearchResponse] def get_search_0(opts = {}) data, status_code, headers = get_search_0_with_http_info(opts) return data end # Search using q64 # # @param [Hash] opts the optional parameters # @option opts [String] :q64 # @option opts [Array] :expand # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers def get_search_0_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_0 ..." end # 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[:'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 using q64 # # @param [Hash] opts the optional parameters # @option opts [String] :q64 # @option opts [Array] :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) return data end # Search using q64 # # @param [Hash] opts the optional parameters # @option opts [String] :q64 # @option opts [Array] :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 = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_1 ..." end # 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[:'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_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Search using q64 # # @param [Hash] opts the optional parameters # @option opts [String] :q64 # @option opts [Array] :expand # @return [UsersSearchResponse] def get_search_2(opts = {}) data, status_code, headers = get_search_2_with_http_info(opts) return data end # Search using q64 # # @param [Hash] opts the optional parameters # @option opts [String] :q64 # @option opts [Array] :expand # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers def get_search_2_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_search_2 ..." end # 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[:'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_2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Suggest using 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) return data end # Suggest using 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 = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#get_suggest ..." end # 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[:'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 # # @param [Hash] opts the optional parameters # @option opts [SearchRequest] :body Search request options # @return [GroupsSearchResponse] def post_search(opts = {}) data, status_code, headers = post_search_with_http_info(opts) return data end # Search # # @param [Hash] opts the optional parameters # @option opts [SearchRequest] :body Search request options # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers def post_search_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search ..." end # 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(opts[:'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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Search # # @param [Hash] opts the optional parameters # @option opts [SearchRequest] :body Search request options # @return [GroupsSearchResponse] def post_search_0(opts = {}) data, status_code, headers = post_search_0_with_http_info(opts) return data end # Search # # @param [Hash] opts the optional parameters # @option opts [SearchRequest] :body Search request options # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers def post_search_0_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_0 ..." end # 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(opts[:'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 # # @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) return data end # Search # # @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 = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_1 ..." end # 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(opts[:'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_1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Search # # @param [Hash] opts the optional parameters # @option opts [SearchRequest] :body Search request options # @return [UsersSearchResponse] def post_search_2(opts = {}) data, status_code, headers = post_search_2_with_http_info(opts) return data end # Search # # @param [Hash] opts the optional parameters # @option opts [SearchRequest] :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 = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_search_2 ..." end # 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(opts[:'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_2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Suggest # # @param [Hash] opts the optional parameters # @option opts [SearchRequest] :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) return data end # Suggest # # @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_suggest_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SearchApi#post_suggest ..." end # 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(opts[:'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 end end