io.qase.client.api

Class PlansApi

java.lang.Object

io.qase.client.api.PlansApi

public class PlansApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PlansApi()
PlansApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IdResponse	createPlan(String code, PlanCreate planCreate) Create a new plan.
okhttp3.Call	createPlanAsync(String code, PlanCreate planCreate, ApiCallback<IdResponse> _callback) Create a new plan.
okhttp3.Call	createPlanCall(String code, PlanCreate planCreate, ApiCallback _callback) Build call for createPlan
ApiResponse<IdResponse>	createPlanWithHttpInfo(String code, PlanCreate planCreate) Create a new plan.
IdResponse	deletePlan(String code, Integer id) Delete plan.
okhttp3.Call	deletePlanAsync(String code, Integer id, ApiCallback<IdResponse> _callback) Delete plan.
okhttp3.Call	deletePlanCall(String code, Integer id, ApiCallback _callback) Build call for deletePlan
ApiResponse<IdResponse>	deletePlanWithHttpInfo(String code, Integer id) Delete plan.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
PlanResponse	getPlan(String code, Integer id) Get a specific plan.
okhttp3.Call	getPlanAsync(String code, Integer id, ApiCallback<PlanResponse> _callback) Get a specific plan.
okhttp3.Call	getPlanCall(String code, Integer id, ApiCallback _callback) Build call for getPlan
PlanListResponse	getPlans(String code, Integer limit, Integer offset) Get all plans.
okhttp3.Call	getPlansAsync(String code, Integer limit, Integer offset, ApiCallback<PlanListResponse> _callback) Get all plans.
okhttp3.Call	getPlansCall(String code, Integer limit, Integer offset, ApiCallback _callback) Build call for getPlans
ApiResponse<PlanListResponse>	getPlansWithHttpInfo(String code, Integer limit, Integer offset) Get all plans.
ApiResponse<PlanResponse>	getPlanWithHttpInfo(String code, Integer id) Get a specific plan.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
IdResponse	updatePlan(String code, Integer id, PlanUpdate planUpdate) Update plan.
okhttp3.Call	updatePlanAsync(String code, Integer id, PlanUpdate planUpdate, ApiCallback<IdResponse> _callback) Update plan.
okhttp3.Call	updatePlanCall(String code, Integer id, PlanUpdate planUpdate, ApiCallback _callback) Build call for updatePlan
ApiResponse<IdResponse>	updatePlanWithHttpInfo(String code, Integer id, PlanUpdate planUpdate) Update plan.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlansApi

public PlansApi()

PlansApi

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

createPlanCall

public okhttp3.Call createPlanCall(String code,
                                   PlanCreate planCreate,
                                   ApiCallback _callback)
                            throws QaseException

Build call for createPlan

Parameters:

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

planCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createPlan

public IdResponse createPlan(String code,
                             PlanCreate planCreate)
                      throws QaseException

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

Parameters:

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

planCreate - (required)

Returns:

IdResponse

Throws:

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

createPlanWithHttpInfo

public ApiResponse<IdResponse> createPlanWithHttpInfo(String code,
                                                      PlanCreate planCreate)
                                               throws QaseException

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

Parameters:

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

planCreate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

createPlanAsync

public okhttp3.Call createPlanAsync(String code,
                                    PlanCreate planCreate,
                                    ApiCallback<IdResponse> _callback)
                             throws QaseException

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

Parameters:

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

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

deletePlanCall

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

Build call for deletePlan

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

deletePlan

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

Delete plan. This method completely deletes a plan 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

deletePlanWithHttpInfo

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

Delete plan. This method completely deletes a plan 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

deletePlanAsync

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

Delete plan. (asynchronously) This method completely deletes a plan 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

getPlanCall

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

Build call for getPlan

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

getPlan

public PlanResponse getPlan(String code,
                            Integer id)
                     throws QaseException

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

Parameters:

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

id - Identifier. (required)

Returns:

PlanResponse

Throws:

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

getPlanWithHttpInfo

public ApiResponse<PlanResponse> getPlanWithHttpInfo(String code,
                                                     Integer id)
                                              throws QaseException

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

Parameters:

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

id - Identifier. (required)

Returns:

ApiResponse<PlanResponse>

Throws:

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

getPlanAsync

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

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

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

getPlansCall

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

Build call for getPlans

Parameters:

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

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

getPlans

public PlanListResponse getPlans(String code,
                                 Integer limit,
                                 Integer offset)
                          throws QaseException

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

Parameters:

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

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

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

Returns:

PlanListResponse

Throws:

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

getPlansWithHttpInfo

public ApiResponse<PlanListResponse> getPlansWithHttpInfo(String code,
                                                          Integer limit,
                                                          Integer offset)
                                                   throws QaseException

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

Parameters:

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

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<PlanListResponse>

Throws:

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

getPlansAsync

public okhttp3.Call getPlansAsync(String code,
                                  Integer limit,
                                  Integer offset,
                                  ApiCallback<PlanListResponse> _callback)
                           throws QaseException

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

Parameters:

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

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

updatePlanCall

public okhttp3.Call updatePlanCall(String code,
                                   Integer id,
                                   PlanUpdate planUpdate,
                                   ApiCallback _callback)
                            throws QaseException

Build call for updatePlan

Parameters:

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

id - Identifier. (required)

planUpdate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updatePlan

public IdResponse updatePlan(String code,
                             Integer id,
                             PlanUpdate planUpdate)
                      throws QaseException

Update plan. This method updates a plan.

Parameters:

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

id - Identifier. (required)

planUpdate - (required)

Returns:

IdResponse

Throws:

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

updatePlanWithHttpInfo

public ApiResponse<IdResponse> updatePlanWithHttpInfo(String code,
                                                      Integer id,
                                                      PlanUpdate planUpdate)
                                               throws QaseException

Update plan. This method updates a plan.

Parameters:

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

id - Identifier. (required)

planUpdate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

updatePlanAsync

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

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

Parameters:

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

id - Identifier. (required)

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