Package com.mypurecloud.sdk.v2.api

Class SuggestApi

java.lang.Object

com.mypurecloud.sdk.v2.api.SuggestApi

public class SuggestApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SuggestApi()
SuggestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
JsonNodeSearchResponse	getSearch(GetSearchRequest request)	Search using the q64 value returned from a previous search.
ApiResponse<JsonNodeSearchResponse>	getSearch(ApiRequest<Void> request)	Search using the q64 value returned from a previous search.
JsonNodeSearchResponse	getSearch(String q64, List<String> expand, Boolean profile)	Search using the q64 value returned from a previous search.
JsonNodeSearchResponse	getSearchSuggest(GetSearchSuggestRequest request)	Suggest resources using the q64 value returned from a previous suggest query.
ApiResponse<JsonNodeSearchResponse>	getSearchSuggest(ApiRequest<Void> request)	Suggest resources using the q64 value returned from a previous suggest query.
JsonNodeSearchResponse	getSearchSuggest(String q64, List<String> expand, Boolean profile)	Suggest resources using the q64 value returned from a previous suggest query.
ApiResponse<JsonNodeSearchResponse>	getSearchSuggestWithHttpInfo(String q64, List<String> expand, Boolean profile)	Suggest resources using the q64 value returned from a previous suggest query.
ApiResponse<JsonNodeSearchResponse>	getSearchWithHttpInfo(String q64, List<String> expand, Boolean profile)	Search using the q64 value returned from a previous search.
JsonNodeSearchResponse	postSearch(PostSearchRequest request)	Search resources.
ApiResponse<JsonNodeSearchResponse>	postSearch(ApiRequest<SearchRequest> request)	Search resources.
JsonNodeSearchResponse	postSearch(SearchRequest body, Boolean profile)	Search resources.
JsonNodeSearchResponse	postSearchSuggest(PostSearchSuggestRequest request)	Suggest resources.
ApiResponse<JsonNodeSearchResponse>	postSearchSuggest(ApiRequest<SuggestSearchRequest> request)	Suggest resources.
JsonNodeSearchResponse	postSearchSuggest(SuggestSearchRequest body, Boolean profile)	Suggest resources.
ApiResponse<JsonNodeSearchResponse>	postSearchSuggestWithHttpInfo(SuggestSearchRequest body, Boolean profile)	Suggest resources.
ApiResponse<JsonNodeSearchResponse>	postSearchWithHttpInfo(SearchRequest body, Boolean profile)	Search resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SuggestApi

public SuggestApi()

SuggestApi

public SuggestApi(ApiClient apiClient)

Method Details

getSearch

public JsonNodeSearchResponse getSearch(String q64,
 List<String> expand,
 Boolean profile)
                                 throws IOException,
ApiException

Search using the q64 value returned from a previous search.

Parameters:

q64 - q64 (required)

expand - Which fields, if any, to expand (optional)

profile - profile (optional, default to true)

Returns:

JsonNodeSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getSearchWithHttpInfo

public ApiResponse<JsonNodeSearchResponse> getSearchWithHttpInfo(String q64,
 List<String> expand,
 Boolean profile)
                                                          throws IOException

Search using the q64 value returned from a previous search.

Parameters:

q64 - q64 (required)

expand - Which fields, if any, to expand (optional)

profile - profile (optional, default to true)

Returns:

JsonNodeSearchResponse

Throws:

IOException - if the request fails to be processed

getSearch

public JsonNodeSearchResponse getSearch(GetSearchRequest request)
                                 throws IOException,
ApiException

Search using the q64 value returned from a previous search.

Parameters:

request - The request object

Returns:

JsonNodeSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getSearch

public ApiResponse<JsonNodeSearchResponse> getSearch(ApiRequest<Void> request)
                                              throws IOException

Search using the q64 value returned from a previous search.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getSearchSuggest

public JsonNodeSearchResponse getSearchSuggest(String q64,
 List<String> expand,
 Boolean profile)
                                        throws IOException,
ApiException

Suggest resources using the q64 value returned from a previous suggest query.

Parameters:

q64 - q64 (required)

expand - Which fields, if any, to expand (optional)

profile - profile (optional, default to true)

Returns:

JsonNodeSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getSearchSuggestWithHttpInfo

public ApiResponse<JsonNodeSearchResponse> getSearchSuggestWithHttpInfo(String q64,
 List<String> expand,
 Boolean profile)
                                                                 throws IOException

Suggest resources using the q64 value returned from a previous suggest query.

Parameters:

q64 - q64 (required)

expand - Which fields, if any, to expand (optional)

profile - profile (optional, default to true)

Returns:

JsonNodeSearchResponse

Throws:

IOException - if the request fails to be processed

getSearchSuggest

public JsonNodeSearchResponse getSearchSuggest(GetSearchSuggestRequest request)
                                        throws IOException,
ApiException

Suggest resources using the q64 value returned from a previous suggest query.

Parameters:

request - The request object

Returns:

JsonNodeSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getSearchSuggest

public ApiResponse<JsonNodeSearchResponse> getSearchSuggest(ApiRequest<Void> request)
                                                     throws IOException

Suggest resources using the q64 value returned from a previous suggest query.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postSearch

public JsonNodeSearchResponse postSearch(SearchRequest body,
 Boolean profile)
                                  throws IOException,
ApiException

Search resources.

Parameters:

body - Search request options (required)

profile - profile (optional, default to true)

Returns:

JsonNodeSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postSearchWithHttpInfo

public ApiResponse<JsonNodeSearchResponse> postSearchWithHttpInfo(SearchRequest body,
 Boolean profile)
                                                           throws IOException

Search resources.

Parameters:

body - Search request options (required)

profile - profile (optional, default to true)

Returns:

JsonNodeSearchResponse

Throws:

IOException - if the request fails to be processed

postSearch

public JsonNodeSearchResponse postSearch(PostSearchRequest request)
                                  throws IOException,
ApiException

Search resources.

Parameters:

request - The request object

Returns:

JsonNodeSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postSearch

public ApiResponse<JsonNodeSearchResponse> postSearch(ApiRequest<SearchRequest> request)
                                               throws IOException

Search resources.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postSearchSuggest

public JsonNodeSearchResponse postSearchSuggest(SuggestSearchRequest body,
 Boolean profile)
                                         throws IOException,
ApiException

Suggest resources.

Parameters:

body - Search request options (required)

profile - profile (optional, default to true)

Returns:

JsonNodeSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postSearchSuggestWithHttpInfo

public ApiResponse<JsonNodeSearchResponse> postSearchSuggestWithHttpInfo(SuggestSearchRequest body,
 Boolean profile)
                                                                  throws IOException

Suggest resources.

Parameters:

body - Search request options (required)

profile - profile (optional, default to true)

Returns:

JsonNodeSearchResponse

Throws:

IOException - if the request fails to be processed

postSearchSuggest

public JsonNodeSearchResponse postSearchSuggest(PostSearchSuggestRequest request)
                                         throws IOException,
ApiException

Suggest resources.

Parameters:

request - The request object

Returns:

JsonNodeSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postSearchSuggest

public ApiResponse<JsonNodeSearchResponse> postSearchSuggest(ApiRequest<SuggestSearchRequest> request)
                                                      throws IOException

Suggest resources.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed