Class TeamsApi

java.lang.Object

com.boldsign.api.TeamsApi

public class TeamsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
TeamsApi()
TeamsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
TeamCreated	createTeam(CreateTeamRequest createTeamRequest)	Create Team.
okhttp3.Call	createTeamAsync(CreateTeamRequest createTeamRequest, ApiCallback<TeamCreated> _callback)	Create Team.
okhttp3.Call	createTeamCall(CreateTeamRequest createTeamRequest, ApiCallback _callback)	Build call for createTeam
ApiResponse<TeamCreated>	createTeamWithHttpInfo(CreateTeamRequest createTeamRequest)	Create Team.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
TeamResponse	getTeam(String teamId)	Get Team details.
okhttp3.Call	getTeamAsync(String teamId, ApiCallback<TeamResponse> _callback)	Get Team details.
okhttp3.Call	getTeamCall(String teamId, ApiCallback _callback)	Build call for getTeam
ApiResponse<TeamResponse>	getTeamWithHttpInfo(String teamId)	Get Team details.
TeamListResponse	listTeams(Integer page, Integer pageSize, String searchKey)	List Teams.
okhttp3.Call	listTeamsAsync(Integer page, Integer pageSize, String searchKey, ApiCallback<TeamListResponse> _callback)	List Teams.
okhttp3.Call	listTeamsCall(Integer page, Integer pageSize, String searchKey, ApiCallback _callback)	Build call for listTeams
ApiResponse<TeamListResponse>	listTeamsWithHttpInfo(Integer page, Integer pageSize, String searchKey)	List Teams.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	updateTeam(TeamUpdateRequest teamUpdateRequest)	Update Team.
okhttp3.Call	updateTeamAsync(TeamUpdateRequest teamUpdateRequest, ApiCallback<Void> _callback)	Update Team.
okhttp3.Call	updateTeamCall(TeamUpdateRequest teamUpdateRequest, ApiCallback _callback)	Build call for updateTeam
ApiResponse<Void>	updateTeamWithHttpInfo(TeamUpdateRequest teamUpdateRequest)	Update Team.

Methods inherited from class java.lang.Object

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

Constructor Details

TeamsApi

public TeamsApi()

TeamsApi

public TeamsApi(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)

createTeamCall

public okhttp3.Call createTeamCall(CreateTeamRequest createTeamRequest,
 ApiCallback _callback)
                            throws ApiException

Build call for createTeam

Parameters:

createTeamRequest - team creation. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

createTeam

public TeamCreated createTeam(CreateTeamRequest createTeamRequest)
                       throws ApiException

Create Team.

Parameters:

createTeamRequest - team creation. (required)

Returns:

TeamCreated

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	OK	-
401	Unauthorized	-
403	Forbidden	-

createTeamWithHttpInfo

public ApiResponse<TeamCreated> createTeamWithHttpInfo(CreateTeamRequest createTeamRequest)
                                                throws ApiException

Create Team.

Parameters:

createTeamRequest - team creation. (required)

Returns:

ApiResponse<TeamCreated>

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	OK	-
401	Unauthorized	-
403	Forbidden	-

createTeamAsync

public okhttp3.Call createTeamAsync(CreateTeamRequest createTeamRequest,
 ApiCallback<TeamCreated> _callback)
                             throws ApiException

Create Team. (asynchronously)

Parameters:

createTeamRequest - team creation. (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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

getTeamCall

public okhttp3.Call getTeamCall(String teamId,
 ApiCallback _callback)
                         throws ApiException

Build call for getTeam

Parameters:

teamId - Team Id. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

getTeam

public TeamResponse getTeam(String teamId)
                     throws ApiException

Get Team details.

Parameters:

teamId - Team Id. (required)

Returns:

TeamResponse

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	OK	-
401	Unauthorized	-
403	Forbidden	-

getTeamWithHttpInfo

public ApiResponse<TeamResponse> getTeamWithHttpInfo(String teamId)
                                              throws ApiException

Get Team details.

Parameters:

teamId - Team Id. (required)

Returns:

ApiResponse<TeamResponse>

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	OK	-
401	Unauthorized	-
403	Forbidden	-

getTeamAsync

public okhttp3.Call getTeamAsync(String teamId,
 ApiCallback<TeamResponse> _callback)
                          throws ApiException

Get Team details. (asynchronously)

Parameters:

teamId - Team Id. (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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

listTeamsCall

public okhttp3.Call listTeamsCall(Integer page,
 Integer pageSize,
 String searchKey,
 ApiCallback _callback)
                           throws ApiException

Build call for listTeams

Parameters:

page - Page index specified in get team list request. (required)

pageSize - Page size specified in get team list request. (optional, default to 10)

searchKey - Teams can be listed by the search key (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

listTeams

public TeamListResponse listTeams(Integer page,
 Integer pageSize,
 String searchKey)
                           throws ApiException

List Teams.

Parameters:

page - Page index specified in get team list request. (required)

pageSize - Page size specified in get team list request. (optional, default to 10)

searchKey - Teams can be listed by the search key (optional)

Returns:

TeamListResponse

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	OK	-
401	Unauthorized	-
403	Forbidden	-

listTeamsWithHttpInfo

public ApiResponse<TeamListResponse> listTeamsWithHttpInfo(Integer page,
 Integer pageSize,
 String searchKey)
                                                    throws ApiException

List Teams.

Parameters:

page - Page index specified in get team list request. (required)

pageSize - Page size specified in get team list request. (optional, default to 10)

searchKey - Teams can be listed by the search key (optional)

Returns:

ApiResponse<TeamListResponse>

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	OK	-
401	Unauthorized	-
403	Forbidden	-

listTeamsAsync

public okhttp3.Call listTeamsAsync(Integer page,
 Integer pageSize,
 String searchKey,
 ApiCallback<TeamListResponse> _callback)
                            throws ApiException

List Teams. (asynchronously)

Parameters:

page - Page index specified in get team list request. (required)

pageSize - Page size specified in get team list request. (optional, default to 10)

searchKey - Teams can be listed by the search key (optional)

_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	OK	-
401	Unauthorized	-
403	Forbidden	-

updateTeamCall

public okhttp3.Call updateTeamCall(TeamUpdateRequest teamUpdateRequest,
 ApiCallback _callback)
                            throws ApiException

Build call for updateTeam

Parameters:

teamUpdateRequest - update team. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

updateTeam

public void updateTeam(TeamUpdateRequest teamUpdateRequest)
                throws ApiException

Update Team.

Parameters:

teamUpdateRequest - update team. (required)

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	OK	-
401	Unauthorized	-
403	Forbidden	-

updateTeamWithHttpInfo

public ApiResponse<Void> updateTeamWithHttpInfo(TeamUpdateRequest teamUpdateRequest)
                                         throws ApiException

Update Team.

Parameters:

teamUpdateRequest - update team. (required)

Returns:

ApiResponse<Void>

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	OK	-
401	Unauthorized	-
403	Forbidden	-

updateTeamAsync

public okhttp3.Call updateTeamAsync(TeamUpdateRequest teamUpdateRequest,
 ApiCallback<Void> _callback)
                             throws ApiException

Update Team. (asynchronously)

Parameters:

teamUpdateRequest - update team. (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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-