Class AuthApi.APIloginRequest

  • Enclosing class:
    AuthApi

    public class AuthApi.APIloginRequest
    extends Object
    • Method Detail

      • loginInformation

        public AuthApi.APIloginRequest loginInformation​(LoginInformation loginInformation)
        Set loginInformation
        Parameters:
        loginInformation - (optional)
        Returns:
        APIloginRequest
      • buildCall

        public okhttp3.Call buildCall​(ApiCallback _callback)
                               throws ApiException
        Build call for login
        Parameters:
        _callback - ApiCallback API callback
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 successful login * Set-Cookie -
        401 Unauthorized -
        420 too many requests -
        0 Internal Server Error -
      • execute

        public AuthenticationToken execute()
                                    throws ApiException
        Execute login request
        Returns:
        AuthenticationToken
        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 successful login * Set-Cookie -
        401 Unauthorized -
        420 too many requests -
        0 Internal Server Error -
      • executeWithHttpInfo

        public ApiResponse<AuthenticationToken> executeWithHttpInfo()
                                                             throws ApiException
        Execute login request with HTTP info returned
        Returns:
        ApiResponse<AuthenticationToken>
        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 successful login * Set-Cookie -
        401 Unauthorized -
        420 too many requests -
        0 Internal Server Error -
      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<AuthenticationToken> _callback)
                                  throws ApiException
        Execute login request (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
        Http Response Details:
        Status Code Description Response Headers
        200 successful login * Set-Cookie -
        401 Unauthorized -
        420 too many requests -
        0 Internal Server Error -