io.qase.client.api

Class MilestonesApi

java.lang.Object

io.qase.client.api.MilestonesApi

public class MilestonesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MilestonesApi()
MilestonesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IdResponse	createMilestone(String code, MilestoneCreate milestoneCreate) Create a new milestone.
okhttp3.Call	createMilestoneAsync(String code, MilestoneCreate milestoneCreate, ApiCallback<IdResponse> _callback) Create a new milestone.
okhttp3.Call	createMilestoneCall(String code, MilestoneCreate milestoneCreate, ApiCallback _callback) Build call for createMilestone
ApiResponse<IdResponse>	createMilestoneWithHttpInfo(String code, MilestoneCreate milestoneCreate) Create a new milestone.
IdResponse	deleteMilestone(String code, Integer id) Delete milestone.
okhttp3.Call	deleteMilestoneAsync(String code, Integer id, ApiCallback<IdResponse> _callback) Delete milestone.
okhttp3.Call	deleteMilestoneCall(String code, Integer id, ApiCallback _callback) Build call for deleteMilestone
ApiResponse<IdResponse>	deleteMilestoneWithHttpInfo(String code, Integer id) Delete milestone.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
MilestoneResponse	getMilestone(String code, Integer id) Get a specific milestone.
okhttp3.Call	getMilestoneAsync(String code, Integer id, ApiCallback<MilestoneResponse> _callback) Get a specific milestone.
okhttp3.Call	getMilestoneCall(String code, Integer id, ApiCallback _callback) Build call for getMilestone
MilestoneListResponse	getMilestones(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset) Get all milestones.
okhttp3.Call	getMilestonesAsync(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset, ApiCallback<MilestoneListResponse> _callback) Get all milestones.
okhttp3.Call	getMilestonesCall(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset, ApiCallback _callback) Build call for getMilestones
ApiResponse<MilestoneListResponse>	getMilestonesWithHttpInfo(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset) Get all milestones.
ApiResponse<MilestoneResponse>	getMilestoneWithHttpInfo(String code, Integer id) Get a specific milestone.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
IdResponse	updateMilestone(String code, Integer id, MilestoneUpdate milestoneUpdate) Update milestone.
okhttp3.Call	updateMilestoneAsync(String code, Integer id, MilestoneUpdate milestoneUpdate, ApiCallback<IdResponse> _callback) Update milestone.
okhttp3.Call	updateMilestoneCall(String code, Integer id, MilestoneUpdate milestoneUpdate, ApiCallback _callback) Build call for updateMilestone
ApiResponse<IdResponse>	updateMilestoneWithHttpInfo(String code, Integer id, MilestoneUpdate milestoneUpdate) Update milestone.

Methods inherited from class java.lang.Object

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

Constructor Detail

MilestonesApi

public MilestonesApi()

MilestonesApi

public MilestonesApi(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 String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createMilestoneCall

public okhttp3.Call createMilestoneCall(String code,
                                        MilestoneCreate milestoneCreate,
                                        ApiCallback _callback)
                                 throws QaseException

Build call for createMilestone

Parameters:

code - Code of project, where to search entities. (required)

milestoneCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createMilestone

public IdResponse createMilestone(String code,
                                  MilestoneCreate milestoneCreate)
                           throws QaseException

Create a new milestone. This method allows to create a milestone in selected project.

Parameters:

code - Code of project, where to search entities. (required)

milestoneCreate - (required)

Returns:

IdResponse

Throws:

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

createMilestoneWithHttpInfo

public ApiResponse<IdResponse> createMilestoneWithHttpInfo(String code,
                                                           MilestoneCreate milestoneCreate)
                                                    throws QaseException

Create a new milestone. This method allows to create a milestone in selected project.

Parameters:

code - Code of project, where to search entities. (required)

milestoneCreate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

createMilestoneAsync

public okhttp3.Call createMilestoneAsync(String code,
                                         MilestoneCreate milestoneCreate,
                                         ApiCallback<IdResponse> _callback)
                                  throws QaseException

Create a new milestone. (asynchronously) This method allows to create a milestone in selected project.

Parameters:

code - Code of project, where to search entities. (required)

milestoneCreate - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

deleteMilestoneCall

public okhttp3.Call deleteMilestoneCall(String code,
                                        Integer id,
                                        ApiCallback _callback)
                                 throws QaseException

Build call for deleteMilestone

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

deleteMilestone

public IdResponse deleteMilestone(String code,
                                  Integer id)
                           throws QaseException

Delete milestone. This method completely deletes a milestone from repository.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

Returns:

IdResponse

Throws:

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

deleteMilestoneWithHttpInfo

public ApiResponse<IdResponse> deleteMilestoneWithHttpInfo(String code,
                                                           Integer id)
                                                    throws QaseException

Delete milestone. This method completely deletes a milestone from repository.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

deleteMilestoneAsync

public okhttp3.Call deleteMilestoneAsync(String code,
                                         Integer id,
                                         ApiCallback<IdResponse> _callback)
                                  throws QaseException

Delete milestone. (asynchronously) This method completely deletes a milestone from repository.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

getMilestoneCall

public okhttp3.Call getMilestoneCall(String code,
                                     Integer id,
                                     ApiCallback _callback)
                              throws QaseException

Build call for getMilestone

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getMilestone

public MilestoneResponse getMilestone(String code,
                                      Integer id)
                               throws QaseException

Get a specific milestone. This method allows to retrieve a specific milestone.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

Returns:

MilestoneResponse

Throws:

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

getMilestoneWithHttpInfo

public ApiResponse<MilestoneResponse> getMilestoneWithHttpInfo(String code,
                                                               Integer id)
                                                        throws QaseException

Get a specific milestone. This method allows to retrieve a specific milestone.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

Returns:

ApiResponse<MilestoneResponse>

Throws:

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

getMilestoneAsync

public okhttp3.Call getMilestoneAsync(String code,
                                      Integer id,
                                      ApiCallback<MilestoneResponse> _callback)
                               throws QaseException

Get a specific milestone. (asynchronously) This method allows to retrieve a specific milestone.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

getMilestonesCall

public okhttp3.Call getMilestonesCall(String code,
                                      GetMilestonesFiltersParameter filters,
                                      Integer limit,
                                      Integer offset,
                                      ApiCallback _callback)
                               throws QaseException

Build call for getMilestones

Parameters:

code - Code of project, where to search entities. (required)

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getMilestones

public MilestoneListResponse getMilestones(String code,
                                           GetMilestonesFiltersParameter filters,
                                           Integer limit,
                                           Integer offset)
                                    throws QaseException

Get all milestones. This method allows to retrieve all milestones stored in selected project.

Parameters:

code - Code of project, where to search entities. (required)

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

Returns:

MilestoneListResponse

Throws:

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

getMilestonesWithHttpInfo

public ApiResponse<MilestoneListResponse> getMilestonesWithHttpInfo(String code,
                                                                    GetMilestonesFiltersParameter filters,
                                                                    Integer limit,
                                                                    Integer offset)
                                                             throws QaseException

Get all milestones. This method allows to retrieve all milestones stored in selected project.

Parameters:

code - Code of project, where to search entities. (required)

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

Returns:

ApiResponse<MilestoneListResponse>

Throws:

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

getMilestonesAsync

public okhttp3.Call getMilestonesAsync(String code,
                                       GetMilestonesFiltersParameter filters,
                                       Integer limit,
                                       Integer offset,
                                       ApiCallback<MilestoneListResponse> _callback)
                                throws QaseException

Get all milestones. (asynchronously) This method allows to retrieve all milestones stored in selected project.

Parameters:

code - Code of project, where to search entities. (required)

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

updateMilestoneCall

public okhttp3.Call updateMilestoneCall(String code,
                                        Integer id,
                                        MilestoneUpdate milestoneUpdate,
                                        ApiCallback _callback)
                                 throws QaseException

Build call for updateMilestone

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

milestoneUpdate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updateMilestone

public IdResponse updateMilestone(String code,
                                  Integer id,
                                  MilestoneUpdate milestoneUpdate)
                           throws QaseException

Update milestone. This method updates a milestone.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

milestoneUpdate - (required)

Returns:

IdResponse

Throws:

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

updateMilestoneWithHttpInfo

public ApiResponse<IdResponse> updateMilestoneWithHttpInfo(String code,
                                                           Integer id,
                                                           MilestoneUpdate milestoneUpdate)
                                                    throws QaseException

Update milestone. This method updates a milestone.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

milestoneUpdate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

updateMilestoneAsync

public okhttp3.Call updateMilestoneAsync(String code,
                                         Integer id,
                                         MilestoneUpdate milestoneUpdate,
                                         ApiCallback<IdResponse> _callback)
                                  throws QaseException

Update milestone. (asynchronously) This method updates a milestone.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

milestoneUpdate - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object