com.mailslurp.apis

Class UserControllerApi

java.lang.Object

com.mailslurp.apis.UserControllerApi

public class UserControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UserControllerApi()
UserControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
String	getJsonPropertyAsString(String property, Object body) Utility function to extract properties from JSON objects in language where this is cumbersome.
okhttp3.Call	getJsonPropertyAsStringAsync(String property, Object body, ApiCallback<String> _callback) (asynchronously) Utility function to extract properties from JSON objects in language where this is cumbersome.
okhttp3.Call	getJsonPropertyAsStringCall(String property, Object body, ApiCallback _callback) Build call for getJsonPropertyAsString
ApiResponse<String>	getJsonPropertyAsStringWithHttpInfo(String property, Object body) Utility function to extract properties from JSON objects in language where this is cumbersome.
UserInfoDto	getUserInfo() Get account information for your user
okhttp3.Call	getUserInfoAsync(ApiCallback<UserInfoDto> _callback) (asynchronously) Get account information for your user
okhttp3.Call	getUserInfoCall(ApiCallback _callback) Build call for getUserInfo
ApiResponse<UserInfoDto>	getUserInfoWithHttpInfo() Get account information for your user
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserControllerApi

public UserControllerApi()

UserControllerApi

public UserControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getJsonPropertyAsStringCall

public okhttp3.Call getJsonPropertyAsStringCall(String property,
                                                Object body,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for getJsonPropertyAsString

Parameters:

property - JSON property name or dot separated path selector such as `a.b.c` (required)

body - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getJsonPropertyAsString

public String getJsonPropertyAsString(String property,
                                      Object body)
                               throws ApiException

Utility function to extract properties from JSON objects in language where this is cumbersome.

Parameters:

property - JSON property name or dot separated path selector such as `a.b.c` (required)

body - (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getJsonPropertyAsStringWithHttpInfo

public ApiResponse<String> getJsonPropertyAsStringWithHttpInfo(String property,
                                                               Object body)
                                                        throws ApiException

Utility function to extract properties from JSON objects in language where this is cumbersome.

Parameters:

property - JSON property name or dot separated path selector such as `a.b.c` (required)

body - (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getJsonPropertyAsStringAsync

public okhttp3.Call getJsonPropertyAsStringAsync(String property,
                                                 Object body,
                                                 ApiCallback<String> _callback)
                                          throws ApiException

(asynchronously) Utility function to extract properties from JSON objects in language where this is cumbersome.

Parameters:

property - JSON property name or dot separated path selector such as `a.b.c` (required)

body - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getUserInfoCall

public okhttp3.Call getUserInfoCall(ApiCallback _callback)
                             throws ApiException

Build call for getUserInfo

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getUserInfo

public UserInfoDto getUserInfo()
                        throws ApiException

Get account information for your user

Returns:

UserInfoDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getUserInfoWithHttpInfo

public ApiResponse<UserInfoDto> getUserInfoWithHttpInfo()
                                                 throws ApiException

Get account information for your user

Returns:

ApiResponse<UserInfoDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getUserInfoAsync

public okhttp3.Call getUserInfoAsync(ApiCallback<UserInfoDto> _callback)
                              throws ApiException

(asynchronously) Get account information for your user

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-