io.qase.client.api

Class SuitesApi

java.lang.Object

io.qase.client.api.SuitesApi

public class SuitesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SuitesApi()
SuitesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IdResponse	createSuite(String code, SuiteCreate suiteCreate) Create a new test suite.
okhttp3.Call	createSuiteAsync(String code, SuiteCreate suiteCreate, ApiCallback<IdResponse> _callback) Create a new test suite.
okhttp3.Call	createSuiteCall(String code, SuiteCreate suiteCreate, ApiCallback _callback) Build call for createSuite
ApiResponse<IdResponse>	createSuiteWithHttpInfo(String code, SuiteCreate suiteCreate) Create a new test suite.
IdResponse	deleteSuite(String code, Integer id, SuiteDelete suiteDelete) Delete test suite.
okhttp3.Call	deleteSuiteAsync(String code, Integer id, SuiteDelete suiteDelete, ApiCallback<IdResponse> _callback) Delete test suite.
okhttp3.Call	deleteSuiteCall(String code, Integer id, SuiteDelete suiteDelete, ApiCallback _callback) Build call for deleteSuite
ApiResponse<IdResponse>	deleteSuiteWithHttpInfo(String code, Integer id, SuiteDelete suiteDelete) Delete test suite.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
SuiteResponse	getSuite(String code, Integer id) Get a specific test suite.
okhttp3.Call	getSuiteAsync(String code, Integer id, ApiCallback<SuiteResponse> _callback) Get a specific test suite.
okhttp3.Call	getSuiteCall(String code, Integer id, ApiCallback _callback) Build call for getSuite
SuiteListResponse	getSuites(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset) Get all test suites.
okhttp3.Call	getSuitesAsync(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset, ApiCallback<SuiteListResponse> _callback) Get all test suites.
okhttp3.Call	getSuitesCall(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset, ApiCallback _callback) Build call for getSuites
ApiResponse<SuiteListResponse>	getSuitesWithHttpInfo(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset) Get all test suites.
ApiResponse<SuiteResponse>	getSuiteWithHttpInfo(String code, Integer id) Get a specific test suite.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
IdResponse	updateSuite(String code, Integer id, SuiteUpdate suiteUpdate) Update test suite.
okhttp3.Call	updateSuiteAsync(String code, Integer id, SuiteUpdate suiteUpdate, ApiCallback<IdResponse> _callback) Update test suite.
okhttp3.Call	updateSuiteCall(String code, Integer id, SuiteUpdate suiteUpdate, ApiCallback _callback) Build call for updateSuite
ApiResponse<IdResponse>	updateSuiteWithHttpInfo(String code, Integer id, SuiteUpdate suiteUpdate) Update test suite.

Methods inherited from class java.lang.Object

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

Constructor Detail

SuitesApi

public SuitesApi()

SuitesApi

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

createSuiteCall

public okhttp3.Call createSuiteCall(String code,
                                    SuiteCreate suiteCreate,
                                    ApiCallback _callback)
                             throws QaseException

Build call for createSuite

Parameters:

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

suiteCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createSuite

public IdResponse createSuite(String code,
                              SuiteCreate suiteCreate)
                       throws QaseException

Create a new test suite. This method is used to create a new test suite through API.

Parameters:

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

suiteCreate - (required)

Returns:

IdResponse

Throws:

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

createSuiteWithHttpInfo

public ApiResponse<IdResponse> createSuiteWithHttpInfo(String code,
                                                       SuiteCreate suiteCreate)
                                                throws QaseException

Create a new test suite. This method is used to create a new test suite through API.

Parameters:

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

suiteCreate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

createSuiteAsync

public okhttp3.Call createSuiteAsync(String code,
                                     SuiteCreate suiteCreate,
                                     ApiCallback<IdResponse> _callback)
                              throws QaseException

Create a new test suite. (asynchronously) This method is used to create a new test suite through API.

Parameters:

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

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

deleteSuiteCall

public okhttp3.Call deleteSuiteCall(String code,
                                    Integer id,
                                    SuiteDelete suiteDelete,
                                    ApiCallback _callback)
                             throws QaseException

Build call for deleteSuite

Parameters:

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

id - Identifier. (required)

suiteDelete - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

deleteSuite

public IdResponse deleteSuite(String code,
                              Integer id,
                              SuiteDelete suiteDelete)
                       throws QaseException

Delete test suite. This method completely deletes a test suite with test cases from repository.

Parameters:

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

id - Identifier. (required)

suiteDelete - (optional)

Returns:

IdResponse

Throws:

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

deleteSuiteWithHttpInfo

public ApiResponse<IdResponse> deleteSuiteWithHttpInfo(String code,
                                                       Integer id,
                                                       SuiteDelete suiteDelete)
                                                throws QaseException

Delete test suite. This method completely deletes a test suite with test cases from repository.

Parameters:

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

id - Identifier. (required)

suiteDelete - (optional)

Returns:

ApiResponse<IdResponse>

Throws:

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

deleteSuiteAsync

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

Delete test suite. (asynchronously) This method completely deletes a test suite with test cases from repository.

Parameters:

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

id - Identifier. (required)

suiteDelete - (optional)

_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

getSuiteCall

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

Build call for getSuite

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

getSuite

public SuiteResponse getSuite(String code,
                              Integer id)
                       throws QaseException

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

Parameters:

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

id - Identifier. (required)

Returns:

SuiteResponse

Throws:

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

getSuiteWithHttpInfo

public ApiResponse<SuiteResponse> getSuiteWithHttpInfo(String code,
                                                       Integer id)
                                                throws QaseException

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

Parameters:

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

id - Identifier. (required)

Returns:

ApiResponse<SuiteResponse>

Throws:

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

getSuiteAsync

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

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

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

getSuitesCall

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

Build call for getSuites

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

getSuites

public SuiteListResponse getSuites(String code,
                                   GetMilestonesFiltersParameter filters,
                                   Integer limit,
                                   Integer offset)
                            throws QaseException

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

SuiteListResponse

Throws:

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

getSuitesWithHttpInfo

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

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

Throws:

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

getSuitesAsync

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

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

updateSuiteCall

public okhttp3.Call updateSuiteCall(String code,
                                    Integer id,
                                    SuiteUpdate suiteUpdate,
                                    ApiCallback _callback)
                             throws QaseException

Build call for updateSuite

Parameters:

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

id - Identifier. (required)

suiteUpdate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updateSuite

public IdResponse updateSuite(String code,
                              Integer id,
                              SuiteUpdate suiteUpdate)
                       throws QaseException

Update test suite. This method is used to update a test suite through API.

Parameters:

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

id - Identifier. (required)

suiteUpdate - (required)

Returns:

IdResponse

Throws:

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

updateSuiteWithHttpInfo

public ApiResponse<IdResponse> updateSuiteWithHttpInfo(String code,
                                                       Integer id,
                                                       SuiteUpdate suiteUpdate)
                                                throws QaseException

Update test suite. This method is used to update a test suite through API.

Parameters:

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

id - Identifier. (required)

suiteUpdate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

updateSuiteAsync

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

Update test suite. (asynchronously) This method is used to update a test suite through API.

Parameters:

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

id - Identifier. (required)

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