ai.thirdwatch.api

Class LoginApi

java.lang.Object

ai.thirdwatch.api.LoginApi

public class LoginApi
extends Object

Constructor Summary

Constructors

Constructor and Description
LoginApi()
LoginApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
EventResponse	login(Login JSON) Use login to record when a user attempts to log in.
com.squareup.okhttp.Call	loginAsync(Login JSON, ApiCallback<EventResponse> callback) Use login to record when a user attempts to log in.
com.squareup.okhttp.Call	loginCall(Login JSON, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for login
ApiResponse<EventResponse>	loginWithHttpInfo(Login JSON) Use login to record when a user attempts to log in.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginApi

public LoginApi()

LoginApi

public LoginApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

loginCall

public com.squareup.okhttp.Call loginCall(Login JSON,
                                          ProgressResponseBody.ProgressListener progressListener,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                   throws ApiException

Build call for login

Parameters:

JSON - Pass login status to thirdwatch. Only `_userID` is required field. But this should contain login info. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

login

public EventResponse login(Login JSON)
                    throws ApiException

Use login to record when a user attempts to log in.

Parameters:

JSON - Pass login status to thirdwatch. Only `_userID` is required field. But this should contain login info. (required)

Returns:

EventResponse

Throws:

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

loginWithHttpInfo

public ApiResponse<EventResponse> loginWithHttpInfo(Login JSON)
                                             throws ApiException

Use login to record when a user attempts to log in.

Parameters:

JSON - Pass login status to thirdwatch. Only `_userID` is required field. But this should contain login info. (required)

Returns:

ApiResponse<EventResponse>

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(Login JSON,
                                           ApiCallback<EventResponse> callback)
                                    throws ApiException

Use login to record when a user attempts to log in. (asynchronously)

Parameters:

JSON - Pass login status to thirdwatch. Only `_userID` is required field. But this should contain login info. (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