Package org.openapitools.client.api

Class ContestControllerApi

java.lang.Object

org.openapitools.client.api.ContestControllerApi

public class ContestControllerApi
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private String	localCustomBaseUrl
private int	localHostIndex
private ApiClient	localVarApiClient

Constructor Summary

Constructors

Constructor	Description
ContestControllerApi()
ContestControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ContestDTO	createContest(ContestDTO contestDTO)	This endpoint will create a new contest.
okhttp3.Call	createContestAsync(ContestDTO contestDTO, ApiCallback<ContestDTO> _callback)	This endpoint will create a new contest.
okhttp3.Call	createContestCall(ContestDTO contestDTO, ApiCallback _callback)	Build call for createContest
private okhttp3.Call	createContestValidateBeforeCall(ContestDTO contestDTO, ApiCallback _callback)
ApiResponse<ContestDTO>	createContestWithHttpInfo(ContestDTO contestDTO)	This endpoint will create a new contest.
void	deleteAllContests()	This method will delete all contests.
okhttp3.Call	deleteAllContestsAsync(ApiCallback<Void> _callback)	This method will delete all contests.
okhttp3.Call	deleteAllContestsCall(ApiCallback _callback)	Build call for deleteAllContests
private okhttp3.Call	deleteAllContestsValidateBeforeCall(ApiCallback _callback)
ApiResponse<Void>	deleteAllContestsWithHttpInfo()	This method will delete all contests.
void	deleteContest(Integer contestId)	This method will delete the specified contest.
okhttp3.Call	deleteContestAsync(Integer contestId, ApiCallback<Void> _callback)	This method will delete the specified contest.
okhttp3.Call	deleteContestCall(Integer contestId, ApiCallback _callback)	Build call for deleteContest
private okhttp3.Call	deleteContestValidateBeforeCall(Integer contestId, ApiCallback _callback)
ApiResponse<Void>	deleteContestWithHttpInfo(Integer contestId)	This method will delete the specified contest.
void	doesContestExist(Integer contestId)	This method simply checks whether the contest exists.
okhttp3.Call	doesContestExistAsync(Integer contestId, ApiCallback<Void> _callback)	This method simply checks whether the contest exists.
okhttp3.Call	doesContestExistCall(Integer contestId, ApiCallback _callback)	Build call for doesContestExist
private okhttp3.Call	doesContestExistValidateBeforeCall(Integer contestId, ApiCallback _callback)
ApiResponse<Void>	doesContestExistWithHttpInfo(Integer contestId)	This method simply checks whether the contest exists.
ApiClient	getApiClient()
ContestDTO	getContest(Integer contestId)	Returns the specified contest.
okhttp3.Call	getContestAsync(Integer contestId, ApiCallback<ContestDTO> _callback)	Returns the specified contest.
okhttp3.Call	getContestCall(Integer contestId, ApiCallback _callback)	Build call for getContest
ContestListDTO	getContests(Integer offset, Integer limit)	This endpoint will return a collection of contests based on the paging values assigned
okhttp3.Call	getContestsAsync(Integer offset, Integer limit, ApiCallback<ContestListDTO> _callback)	This endpoint will return a collection of contests based on the paging values assigned (asynchronously)
okhttp3.Call	getContestsCall(Integer offset, Integer limit, ApiCallback _callback)	Build call for getContests
private okhttp3.Call	getContestsValidateBeforeCall(Integer offset, Integer limit, ApiCallback _callback)
ApiResponse<ContestListDTO>	getContestsWithHttpInfo(Integer offset, Integer limit)	This endpoint will return a collection of contests based on the paging values assigned
private okhttp3.Call	getContestValidateBeforeCall(Integer contestId, ApiCallback _callback)
ApiResponse<ContestDTO>	getContestWithHttpInfo(Integer contestId)	Returns the specified contest.
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	updateContest(Integer contestId, ContestDTO contestDTO)	Update an existing contest -- perhaps to schedule it or report scores.
okhttp3.Call	updateContestAsync(Integer contestId, ContestDTO contestDTO, ApiCallback<Void> _callback)	Update an existing contest -- perhaps to schedule it or report scores.
okhttp3.Call	updateContestCall(Integer contestId, ContestDTO contestDTO, ApiCallback _callback)	Build call for updateContest
private okhttp3.Call	updateContestValidateBeforeCall(Integer contestId, ContestDTO contestDTO, ApiCallback _callback)
ApiResponse<Void>	updateContestWithHttpInfo(Integer contestId, ContestDTO contestDTO)	Update an existing contest -- perhaps to schedule it or report scores.

Methods inherited from class java.lang.Object

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

Field Details

localVarApiClient

private ApiClient localVarApiClient

localHostIndex

private int localHostIndex

localCustomBaseUrl

private String localCustomBaseUrl

Constructor Details

ContestControllerApi

public ContestControllerApi()

ContestControllerApi

public ContestControllerApi(ApiClient apiClient)

Method Details

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)

createContestCall

public okhttp3.Call createContestCall(ContestDTO contestDTO,
 ApiCallback _callback)
                               throws ApiException

Build call for createContest

Parameters:

contestDTO - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createContestValidateBeforeCall

private okhttp3.Call createContestValidateBeforeCall(ContestDTO contestDTO,
 ApiCallback _callback)
                                              throws ApiException

Throws:

ApiException

createContest

public ContestDTO createContest(ContestDTO contestDTO)
                         throws ApiException

This endpoint will create a new contest. Home and Away teams are required, id is ignored, and most other fields are optional.

Parameters:

contestDTO - (required)

Returns:

ContestDTO

Throws:

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

createContestWithHttpInfo

public ApiResponse<ContestDTO> createContestWithHttpInfo(ContestDTO contestDTO)
                                                  throws ApiException

This endpoint will create a new contest. Home and Away teams are required, id is ignored, and most other fields are optional.

Parameters:

contestDTO - (required)

Returns:

ApiResponse<ContestDTO>

Throws:

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

createContestAsync

public okhttp3.Call createContestAsync(ContestDTO contestDTO,
 ApiCallback<ContestDTO> _callback)
                                throws ApiException

This endpoint will create a new contest. Home and Away teams are required, id is ignored, and most other fields are optional. (asynchronously)

Parameters:

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

deleteAllContestsCall

public okhttp3.Call deleteAllContestsCall(ApiCallback _callback)
                                   throws ApiException

Build call for deleteAllContests

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAllContestsValidateBeforeCall

private okhttp3.Call deleteAllContestsValidateBeforeCall(ApiCallback _callback)
                                                  throws ApiException

Throws:

ApiException

deleteAllContests

public void deleteAllContests()
                       throws ApiException

This method will delete all contests.

Throws:

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

deleteAllContestsWithHttpInfo

public ApiResponse<Void> deleteAllContestsWithHttpInfo()
                                                throws ApiException

This method will delete all contests.

Returns:

ApiResponse<Void>

Throws:

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

deleteAllContestsAsync

public okhttp3.Call deleteAllContestsAsync(ApiCallback<Void> _callback)
                                    throws ApiException

This method will delete all contests. (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

deleteContestCall

public okhttp3.Call deleteContestCall(Integer contestId,
 ApiCallback _callback)
                               throws ApiException

Build call for deleteContest

Parameters:

contestId - id of contest (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteContestValidateBeforeCall

private okhttp3.Call deleteContestValidateBeforeCall(Integer contestId,
 ApiCallback _callback)
                                              throws ApiException

Throws:

ApiException

deleteContest

public void deleteContest(Integer contestId)
                   throws ApiException

This method will delete the specified contest. There is no error if the ID does not exist. There will only be an error when we fail to delete it.

Parameters:

contestId - id of contest (required)

Throws:

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

deleteContestWithHttpInfo

public ApiResponse<Void> deleteContestWithHttpInfo(Integer contestId)
                                            throws ApiException

This method will delete the specified contest. There is no error if the ID does not exist. There will only be an error when we fail to delete it.

Parameters:

contestId - id of contest (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteContestAsync

public okhttp3.Call deleteContestAsync(Integer contestId,
 ApiCallback<Void> _callback)
                                throws ApiException

This method will delete the specified contest. There is no error if the ID does not exist. There will only be an error when we fail to delete it. (asynchronously)

Parameters:

contestId - id of contest (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

doesContestExistCall

public okhttp3.Call doesContestExistCall(Integer contestId,
 ApiCallback _callback)
                                  throws ApiException

Build call for doesContestExist

Parameters:

contestId - id of contest (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

doesContestExistValidateBeforeCall

private okhttp3.Call doesContestExistValidateBeforeCall(Integer contestId,
 ApiCallback _callback)
                                                 throws ApiException

Throws:

ApiException

doesContestExist

public void doesContestExist(Integer contestId)
                      throws ApiException

This method simply checks whether the contest exists.

Parameters:

contestId - id of contest (required)

Throws:

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

doesContestExistWithHttpInfo

public ApiResponse<Void> doesContestExistWithHttpInfo(Integer contestId)
                                               throws ApiException

This method simply checks whether the contest exists.

Parameters:

contestId - id of contest (required)

Returns:

ApiResponse<Void>

Throws:

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

doesContestExistAsync

public okhttp3.Call doesContestExistAsync(Integer contestId,
 ApiCallback<Void> _callback)
                                   throws ApiException

This method simply checks whether the contest exists. (asynchronously)

Parameters:

contestId - id of contest (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

getContestCall

public okhttp3.Call getContestCall(Integer contestId,
 ApiCallback _callback)
                            throws ApiException

Build call for getContest

Parameters:

contestId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getContestValidateBeforeCall

private okhttp3.Call getContestValidateBeforeCall(Integer contestId,
 ApiCallback _callback)
                                           throws ApiException

Throws:

ApiException

getContest

public ContestDTO getContest(Integer contestId)
                      throws ApiException

Returns the specified contest.

Parameters:

contestId - (required)

Returns:

ContestDTO

Throws:

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

getContestWithHttpInfo

public ApiResponse<ContestDTO> getContestWithHttpInfo(Integer contestId)
                                               throws ApiException

Returns the specified contest.

Parameters:

contestId - (required)

Returns:

ApiResponse<ContestDTO>

Throws:

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

getContestAsync

public okhttp3.Call getContestAsync(Integer contestId,
 ApiCallback<ContestDTO> _callback)
                             throws ApiException

Returns the specified contest. (asynchronously)

Parameters:

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

getContestsCall

public okhttp3.Call getContestsCall(Integer offset,
 Integer limit,
 ApiCallback _callback)
                             throws ApiException

Build call for getContests

Parameters:

offset - optional, server will set to \"no offset\" if not supplied or 0 (optional, default to 0)

limit - optional, server will set to no limit if not supplied or 0 (optional, default to 0)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getContestsValidateBeforeCall

private okhttp3.Call getContestsValidateBeforeCall(Integer offset,
 Integer limit,
 ApiCallback _callback)
                                            throws ApiException

Throws:

ApiException

getContests

public ContestListDTO getContests(Integer offset,
 Integer limit)
                           throws ApiException

This endpoint will return a collection of contests based on the paging values assigned

Parameters:

offset - optional, server will set to \"no offset\" if not supplied or 0 (optional, default to 0)

limit - optional, server will set to no limit if not supplied or 0 (optional, default to 0)

Returns:

ContestListDTO

Throws:

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

getContestsWithHttpInfo

public ApiResponse<ContestListDTO> getContestsWithHttpInfo(Integer offset,
 Integer limit)
                                                    throws ApiException

This endpoint will return a collection of contests based on the paging values assigned

Parameters:

offset - optional, server will set to \"no offset\" if not supplied or 0 (optional, default to 0)

limit - optional, server will set to no limit if not supplied or 0 (optional, default to 0)

Returns:

ApiResponse<ContestListDTO>

Throws:

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

getContestsAsync

public okhttp3.Call getContestsAsync(Integer offset,
 Integer limit,
 ApiCallback<ContestListDTO> _callback)
                              throws ApiException

This endpoint will return a collection of contests based on the paging values assigned (asynchronously)

Parameters:

offset - optional, server will set to \"no offset\" if not supplied or 0 (optional, default to 0)

limit - optional, server will set to no limit if not supplied or 0 (optional, default to 0)

_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

updateContestCall

public okhttp3.Call updateContestCall(Integer contestId,
 ContestDTO contestDTO,
 ApiCallback _callback)
                               throws ApiException

Build call for updateContest

Parameters:

contestId - id of contest (required)

contestDTO - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateContestValidateBeforeCall

private okhttp3.Call updateContestValidateBeforeCall(Integer contestId,
 ContestDTO contestDTO,
 ApiCallback _callback)
                                              throws ApiException

Throws:

ApiException

updateContest

public void updateContest(Integer contestId,
 ContestDTO contestDTO)
                   throws ApiException

Update an existing contest -- perhaps to schedule it or report scores.

Parameters:

contestId - id of contest (required)

contestDTO - (required)

Throws:

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

updateContestWithHttpInfo

public ApiResponse<Void> updateContestWithHttpInfo(Integer contestId,
 ContestDTO contestDTO)
                                            throws ApiException

Update an existing contest -- perhaps to schedule it or report scores.

Parameters:

contestId - id of contest (required)

contestDTO - (required)

Returns:

ApiResponse<Void>

Throws:

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

updateContestAsync

public okhttp3.Call updateContestAsync(Integer contestId,
 ContestDTO contestDTO,
 ApiCallback<Void> _callback)
                                throws ApiException

Update an existing contest -- perhaps to schedule it or report scores. (asynchronously)

Parameters:

contestId - id of contest (required)

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