Package app.kntrl.client.openapi.api

Class AuthorisationApi

java.lang.Object

app.kntrl.client.openapi.api.AuthorisationApi

public class AuthorisationApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
AuthorisationApi()
AuthorisationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AuthorizeRes	authorize(AuthorizeReq authorizeReq)	(Backend API) authorize session Validates token and executes rate limiter.
okhttp3.Call	authorizeAsync(AuthorizeReq authorizeReq, ApiCallback<AuthorizeRes> _callback)	(Backend API) authorize session (asynchronously) Validates token and executes rate limiter.
okhttp3.Call	authorizeCall(AuthorizeReq authorizeReq, ApiCallback _callback)	Build call for authorize
ApiResponse<AuthorizeRes>	authorizeWithHttpInfo(AuthorizeReq authorizeReq)	(Backend API) authorize session Validates token and executes rate limiter.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
AuthorizeRes	limit(RateLimiterReq rateLimiterReq)	(Backend API) validate by rate-limiter Executes rate limiter if no authorisation is required.
okhttp3.Call	limitAsync(RateLimiterReq rateLimiterReq, ApiCallback<AuthorizeRes> _callback)	(Backend API) validate by rate-limiter (asynchronously) Executes rate limiter if no authorisation is required.
okhttp3.Call	limitCall(RateLimiterReq rateLimiterReq, ApiCallback _callback)	Build call for limit
ApiResponse<AuthorizeRes>	limitWithHttpInfo(RateLimiterReq rateLimiterReq)	(Backend API) validate by rate-limiter Executes rate limiter if no authorisation is required.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.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

AuthorisationApi

public AuthorisationApi()

AuthorisationApi

public AuthorisationApi(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 java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

authorizeCall

public okhttp3.Call authorizeCall(AuthorizeReq authorizeReq,
                                  ApiCallback _callback)
                           throws ApiException

Build call for authorize

Parameters:

authorizeReq - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

authorize

public AuthorizeRes authorize(AuthorizeReq authorizeReq)
                       throws ApiException

(Backend API) authorize session Validates token and executes rate limiter. This API should be called by backend.

Parameters:

authorizeReq - (required)

Returns:

AuthorizeRes

Throws:

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

authorizeWithHttpInfo

public ApiResponse<AuthorizeRes> authorizeWithHttpInfo(AuthorizeReq authorizeReq)
                                                throws ApiException

(Backend API) authorize session Validates token and executes rate limiter. This API should be called by backend.

Parameters:

authorizeReq - (required)

Returns:

ApiResponse<AuthorizeRes>

Throws:

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

authorizeAsync

public okhttp3.Call authorizeAsync(AuthorizeReq authorizeReq,
                                   ApiCallback<AuthorizeRes> _callback)
                            throws ApiException

(Backend API) authorize session (asynchronously) Validates token and executes rate limiter. This API should be called by backend.

Parameters:

authorizeReq - (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

limitCall

public okhttp3.Call limitCall(RateLimiterReq rateLimiterReq,
                              ApiCallback _callback)
                       throws ApiException

Build call for limit

Parameters:

rateLimiterReq - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

limit

public AuthorizeRes limit(RateLimiterReq rateLimiterReq)
                   throws ApiException

(Backend API) validate by rate-limiter Executes rate limiter if no authorisation is required. Otherwise, this works similarly to /authorise.

Parameters:

rateLimiterReq - (required)

Returns:

AuthorizeRes

Throws:

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

limitWithHttpInfo

public ApiResponse<AuthorizeRes> limitWithHttpInfo(RateLimiterReq rateLimiterReq)
                                            throws ApiException

(Backend API) validate by rate-limiter Executes rate limiter if no authorisation is required. Otherwise, this works similarly to /authorise.

Parameters:

rateLimiterReq - (required)

Returns:

ApiResponse<AuthorizeRes>

Throws:

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

limitAsync

public okhttp3.Call limitAsync(RateLimiterReq rateLimiterReq,
                               ApiCallback<AuthorizeRes> _callback)
                        throws ApiException

(Backend API) validate by rate-limiter (asynchronously) Executes rate limiter if no authorisation is required. Otherwise, this works similarly to /authorise.

Parameters:

rateLimiterReq - (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