io.qase.client.api

Class CasesApi

java.lang.Object

io.qase.client.api.CasesApi

public class CasesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CasesApi()
CasesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IdResponse	createCase(String code, TestCaseCreate testCaseCreate) Create a new test case.
okhttp3.Call	createCaseAsync(String code, TestCaseCreate testCaseCreate, ApiCallback<IdResponse> _callback) Create a new test case.
okhttp3.Call	createCaseCall(String code, TestCaseCreate testCaseCreate, ApiCallback _callback) Build call for createCase
ApiResponse<IdResponse>	createCaseWithHttpInfo(String code, TestCaseCreate testCaseCreate) Create a new test case.
IdResponse	deleteCase(String code, Integer id) Delete test case.
okhttp3.Call	deleteCaseAsync(String code, Integer id, ApiCallback<IdResponse> _callback) Delete test case.
okhttp3.Call	deleteCaseCall(String code, Integer id, ApiCallback _callback) Build call for deleteCase
ApiResponse<IdResponse>	deleteCaseWithHttpInfo(String code, Integer id) Delete test case.
ApiClient	getApiClient()
TestCaseResponse	getCase(String code, Integer id) Get a specific test case.
okhttp3.Call	getCaseAsync(String code, Integer id, ApiCallback<TestCaseResponse> _callback) Get a specific test case.
okhttp3.Call	getCaseCall(String code, Integer id, ApiCallback _callback) Build call for getCase
TestCaseListResponse	getCases(String code, GetCasesFiltersParameter filters, Integer limit, Integer offset) Get all test cases.
okhttp3.Call	getCasesAsync(String code, GetCasesFiltersParameter filters, Integer limit, Integer offset, ApiCallback<TestCaseListResponse> _callback) Get all test cases.
okhttp3.Call	getCasesCall(String code, GetCasesFiltersParameter filters, Integer limit, Integer offset, ApiCallback _callback) Build call for getCases
ApiResponse<TestCaseListResponse>	getCasesWithHttpInfo(String code, GetCasesFiltersParameter filters, Integer limit, Integer offset) Get all test cases.
ApiResponse<TestCaseResponse>	getCaseWithHttpInfo(String code, Integer id) Get a specific test case.
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
IdResponse	updateCase(String code, Integer id, TestCaseUpdate testCaseUpdate) Update test case.
okhttp3.Call	updateCaseAsync(String code, Integer id, TestCaseUpdate testCaseUpdate, ApiCallback<IdResponse> _callback) Update test case.
okhttp3.Call	updateCaseCall(String code, Integer id, TestCaseUpdate testCaseUpdate, ApiCallback _callback) Build call for updateCase
ApiResponse<IdResponse>	updateCaseWithHttpInfo(String code, Integer id, TestCaseUpdate testCaseUpdate) Update test case.

Methods inherited from class java.lang.Object

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

Constructor Detail

CasesApi

public CasesApi()

CasesApi

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

createCaseCall

public okhttp3.Call createCaseCall(String code,
                                   TestCaseCreate testCaseCreate,
                                   ApiCallback _callback)
                            throws QaseException

Build call for createCase

Parameters:

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

testCaseCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createCase

public IdResponse createCase(String code,
                             TestCaseCreate testCaseCreate)
                      throws QaseException

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

Parameters:

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

testCaseCreate - (required)

Returns:

IdResponse

Throws:

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

createCaseWithHttpInfo

public ApiResponse<IdResponse> createCaseWithHttpInfo(String code,
                                                      TestCaseCreate testCaseCreate)
                                               throws QaseException

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

Parameters:

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

testCaseCreate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

createCaseAsync

public okhttp3.Call createCaseAsync(String code,
                                    TestCaseCreate testCaseCreate,
                                    ApiCallback<IdResponse> _callback)
                             throws QaseException

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

Parameters:

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

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

deleteCaseCall

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

Build call for deleteCase

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

deleteCase

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

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

deleteCaseWithHttpInfo

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

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

deleteCaseAsync

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

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

getCaseCall

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

Build call for getCase

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

getCase

public TestCaseResponse getCase(String code,
                                Integer id)
                         throws QaseException

Get a specific test case. This method allows to retrieve a specific test case.

Parameters:

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

id - Identifier. (required)

Returns:

TestCaseResponse

Throws:

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

getCaseWithHttpInfo

public ApiResponse<TestCaseResponse> getCaseWithHttpInfo(String code,
                                                         Integer id)
                                                  throws QaseException

Get a specific test case. This method allows to retrieve a specific test case.

Parameters:

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

id - Identifier. (required)

Returns:

ApiResponse<TestCaseResponse>

Throws:

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

getCaseAsync

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

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

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

getCasesCall

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

Build call for getCases

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

getCases

public TestCaseListResponse getCases(String code,
                                     GetCasesFiltersParameter filters,
                                     Integer limit,
                                     Integer offset)
                              throws QaseException

Get all test cases. This method allows to retrieve all test cases 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:

TestCaseListResponse

Throws:

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

getCasesWithHttpInfo

public ApiResponse<TestCaseListResponse> getCasesWithHttpInfo(String code,
                                                              GetCasesFiltersParameter filters,
                                                              Integer limit,
                                                              Integer offset)
                                                       throws QaseException

Get all test cases. This method allows to retrieve all test cases 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<TestCaseListResponse>

Throws:

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

getCasesAsync

public okhttp3.Call getCasesAsync(String code,
                                  GetCasesFiltersParameter filters,
                                  Integer limit,
                                  Integer offset,
                                  ApiCallback<TestCaseListResponse> _callback)
                           throws QaseException

Get all test cases. (asynchronously) This method allows to retrieve all test cases 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

updateCaseCall

public okhttp3.Call updateCaseCall(String code,
                                   Integer id,
                                   TestCaseUpdate testCaseUpdate,
                                   ApiCallback _callback)
                            throws QaseException

Build call for updateCase

Parameters:

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

id - Identifier. (required)

testCaseUpdate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updateCase

public IdResponse updateCase(String code,
                             Integer id,
                             TestCaseUpdate testCaseUpdate)
                      throws QaseException

Update test case. This method updates a test case.

Parameters:

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

id - Identifier. (required)

testCaseUpdate - (required)

Returns:

IdResponse

Throws:

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

updateCaseWithHttpInfo

public ApiResponse<IdResponse> updateCaseWithHttpInfo(String code,
                                                      Integer id,
                                                      TestCaseUpdate testCaseUpdate)
                                               throws QaseException

Update test case. This method updates a test case.

Parameters:

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

id - Identifier. (required)

testCaseUpdate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

updateCaseAsync

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

Update test case. (asynchronously) This method updates a test case.

Parameters:

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

id - Identifier. (required)

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