com.docdoku.api.services

Class AuthApi

java.lang.Object

com.docdoku.api.services.AuthApi

public class AuthApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AuthApi()
AuthApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
OAuthProviderPublicDTO	getProvider(Integer id) Get OAuth provider details
com.squareup.okhttp.Call	getProviderAsync(Integer id, ApiCallback<OAuthProviderPublicDTO> callback) Get OAuth provider details (asynchronously)
List<OAuthProviderPublicDTO>	getProviders() Get registered OAuth providers
com.squareup.okhttp.Call	getProvidersAsync(ApiCallback<List<OAuthProviderPublicDTO>> callback) Get registered OAuth providers (asynchronously)
ApiResponse<List<OAuthProviderPublicDTO>>	getProvidersWithHttpInfo() Get registered OAuth providers
ApiResponse<OAuthProviderPublicDTO>	getProviderWithHttpInfo(Integer id) Get OAuth provider details
AccountDTO	login(LoginRequestDTO body) Try to authenticate with credentials
com.squareup.okhttp.Call	loginAsync(LoginRequestDTO body, ApiCallback<AccountDTO> callback) Try to authenticate with credentials (asynchronously)
ApiResponse<AccountDTO>	loginWithHttpInfo(LoginRequestDTO body) Try to authenticate with credentials
void	logout() Log out connected user
com.squareup.okhttp.Call	logoutAsync(ApiCallback<Void> callback) Log out connected user (asynchronously)
ApiResponse<Void>	logoutWithHttpInfo() Log out connected user
AccountDTO	oAuthLogin(OAuthLoginRequestDTO body) Try to authenticate with OAuth
com.squareup.okhttp.Call	oAuthLoginAsync(OAuthLoginRequestDTO body, ApiCallback<AccountDTO> callback) Try to authenticate with OAuth (asynchronously)
ApiResponse<AccountDTO>	oAuthLoginWithHttpInfo(OAuthLoginRequestDTO body) Try to authenticate with OAuth
void	sendPasswordRecover(PasswordRecoverDTO body) Recover account password
com.squareup.okhttp.Call	sendPasswordRecoverAsync(PasswordRecoverDTO body, ApiCallback<Void> callback) Recover account password (asynchronously)
ApiResponse<Void>	sendPasswordRecoverWithHttpInfo(PasswordRecoverDTO body) Recover account password
void	sendPasswordRecovery(PasswordRecoveryRequestDTO body) Send password recovery request
com.squareup.okhttp.Call	sendPasswordRecoveryAsync(PasswordRecoveryRequestDTO body, ApiCallback<Void> callback) Send password recovery request (asynchronously)
ApiResponse<Void>	sendPasswordRecoveryWithHttpInfo(PasswordRecoveryRequestDTO body) Send password recovery request
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthApi

public AuthApi()

AuthApi

public AuthApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

login

public AccountDTO login(LoginRequestDTO body)
                 throws ApiException

Try to authenticate with credentials

Parameters:

body - Login request

Returns:

AccountDTO

Throws:

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

loginWithHttpInfo

public ApiResponse<AccountDTO> loginWithHttpInfo(LoginRequestDTO body)
                                          throws ApiException

Try to authenticate with credentials

Parameters:

body - Login request

Returns:

ApiResponse

Throws:

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

loginAsync

public com.squareup.okhttp.Call loginAsync(LoginRequestDTO body,
                                           ApiCallback<AccountDTO> callback)
                                    throws ApiException

Try to authenticate with credentials (asynchronously)

Parameters:

body - Login request

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

logout

public void logout()
            throws ApiException

Log out connected user

Throws:

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

logoutWithHttpInfo

public ApiResponse<Void> logoutWithHttpInfo()
                                     throws ApiException

Log out connected user

Returns:

ApiResponse

Throws:

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

logoutAsync

public com.squareup.okhttp.Call logoutAsync(ApiCallback<Void> callback)
                                     throws ApiException

Log out connected user (asynchronously)

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

oAuthLogin

public AccountDTO oAuthLogin(OAuthLoginRequestDTO body)
                      throws ApiException

Try to authenticate with OAuth

Parameters:

body - OAuth login request

Returns:

AccountDTO

Throws:

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

oAuthLoginWithHttpInfo

public ApiResponse<AccountDTO> oAuthLoginWithHttpInfo(OAuthLoginRequestDTO body)
                                               throws ApiException

Try to authenticate with OAuth

Parameters:

body - OAuth login request

Returns:

ApiResponse

Throws:

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

oAuthLoginAsync

public com.squareup.okhttp.Call oAuthLoginAsync(OAuthLoginRequestDTO body,
                                                ApiCallback<AccountDTO> callback)
                                         throws ApiException

Try to authenticate with OAuth (asynchronously)

Parameters:

body - OAuth login request

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

getProviders

public List<OAuthProviderPublicDTO> getProviders()
                                          throws ApiException

Get registered OAuth providers

Returns:

List

Throws:

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

getProvidersWithHttpInfo

public ApiResponse<List<OAuthProviderPublicDTO>> getProvidersWithHttpInfo()
                                                                   throws ApiException

Get registered OAuth providers

Returns:

ApiResponse>

Throws:

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

getProvidersAsync

public com.squareup.okhttp.Call getProvidersAsync(ApiCallback<List<OAuthProviderPublicDTO>> callback)
                                           throws ApiException

Get registered OAuth providers (asynchronously)

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

getProvider

public OAuthProviderPublicDTO getProvider(Integer id)
                                   throws ApiException

Get OAuth provider details

Parameters:

id - Provider id

Returns:

OAuthProviderPublicDTO

Throws:

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

getProviderWithHttpInfo

public ApiResponse<OAuthProviderPublicDTO> getProviderWithHttpInfo(Integer id)
                                                            throws ApiException

Get OAuth provider details

Parameters:

id - Provider id

Returns:

ApiResponse

Throws:

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

getProviderAsync

public com.squareup.okhttp.Call getProviderAsync(Integer id,
                                                 ApiCallback<OAuthProviderPublicDTO> callback)
                                          throws ApiException

Get OAuth provider details (asynchronously)

Parameters:

id - Provider id

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

sendPasswordRecover

public void sendPasswordRecover(PasswordRecoverDTO body)
                         throws ApiException

Recover account password

Parameters:

body - Password recovery process

Throws:

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

sendPasswordRecoverWithHttpInfo

public ApiResponse<Void> sendPasswordRecoverWithHttpInfo(PasswordRecoverDTO body)
                                                  throws ApiException

Recover account password

Parameters:

body - Password recovery process

Returns:

ApiResponse

Throws:

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

sendPasswordRecoverAsync

public com.squareup.okhttp.Call sendPasswordRecoverAsync(PasswordRecoverDTO body,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException

Recover account password (asynchronously)

Parameters:

body - Password recovery process

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

sendPasswordRecovery

public void sendPasswordRecovery(PasswordRecoveryRequestDTO body)
                          throws ApiException

Send password recovery request

Parameters:

body - Password recovery request

Throws:

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

sendPasswordRecoveryWithHttpInfo

public ApiResponse<Void> sendPasswordRecoveryWithHttpInfo(PasswordRecoveryRequestDTO body)
                                                   throws ApiException

Send password recovery request

Parameters:

body - Password recovery request

Returns:

ApiResponse

Throws:

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

sendPasswordRecoveryAsync

public com.squareup.okhttp.Call sendPasswordRecoveryAsync(PasswordRecoveryRequestDTO body,
                                                          ApiCallback<Void> callback)
                                                   throws ApiException

Send password recovery request (asynchronously)

Parameters:

body - Password recovery request

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