io.qase.client.api

Class ProjectsApi

java.lang.Object

io.qase.client.api.ProjectsApi

public class ProjectsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProjectsApi()
ProjectsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ProjectCodeResponse	createProject(ProjectCreate projectCreate) Create new project.
okhttp3.Call	createProjectAsync(ProjectCreate projectCreate, ApiCallback<ProjectCodeResponse> _callback) Create new project.
okhttp3.Call	createProjectCall(ProjectCreate projectCreate, ApiCallback _callback) Build call for createProject
ApiResponse<ProjectCodeResponse>	createProjectWithHttpInfo(ProjectCreate projectCreate) Create new project.
Response	deleteProject(String code) Delete Project by code.
okhttp3.Call	deleteProjectAsync(String code, ApiCallback<Response> _callback) Delete Project by code.
okhttp3.Call	deleteProjectCall(String code, ApiCallback _callback) Build call for deleteProject
ApiResponse<Response>	deleteProjectWithHttpInfo(String code) Delete Project by code.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
ProjectResponse	getProject(String code) Get Project by code.
okhttp3.Call	getProjectAsync(String code, ApiCallback<ProjectResponse> _callback) Get Project by code.
okhttp3.Call	getProjectCall(String code, ApiCallback _callback) Build call for getProject
ProjectListResponse	getProjects(Integer limit, Integer offset) Get All Projects.
okhttp3.Call	getProjectsAsync(Integer limit, Integer offset, ApiCallback<ProjectListResponse> _callback) Get All Projects.
okhttp3.Call	getProjectsCall(Integer limit, Integer offset, ApiCallback _callback) Build call for getProjects
ApiResponse<ProjectListResponse>	getProjectsWithHttpInfo(Integer limit, Integer offset) Get All Projects.
ApiResponse<ProjectResponse>	getProjectWithHttpInfo(String code) Get Project by code.
Response	grantAccessToProject(String code, ProjectAccess projectAccess) Grant access to project by code.
okhttp3.Call	grantAccessToProjectAsync(String code, ProjectAccess projectAccess, ApiCallback<Response> _callback) Grant access to project by code.
okhttp3.Call	grantAccessToProjectCall(String code, ProjectAccess projectAccess, ApiCallback _callback) Build call for grantAccessToProject
ApiResponse<Response>	grantAccessToProjectWithHttpInfo(String code, ProjectAccess projectAccess) Grant access to project by code.
Response	revokeAccessToProject(String code, ProjectAccess projectAccess) Revoke access to project by code.
okhttp3.Call	revokeAccessToProjectAsync(String code, ProjectAccess projectAccess, ApiCallback<Response> _callback) Revoke access to project by code.
okhttp3.Call	revokeAccessToProjectCall(String code, ProjectAccess projectAccess, ApiCallback _callback) Build call for revokeAccessToProject
ApiResponse<Response>	revokeAccessToProjectWithHttpInfo(String code, ProjectAccess projectAccess) Revoke access to project by code.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectsApi

public ProjectsApi()

ProjectsApi

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

createProjectCall

public okhttp3.Call createProjectCall(ProjectCreate projectCreate,
                                      ApiCallback _callback)
                               throws QaseException

Build call for createProject

Parameters:

projectCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createProject

public ProjectCodeResponse createProject(ProjectCreate projectCreate)
                                  throws QaseException

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

Parameters:

projectCreate - (required)

Returns:

ProjectCodeResponse

Throws:

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

createProjectWithHttpInfo

public ApiResponse<ProjectCodeResponse> createProjectWithHttpInfo(ProjectCreate projectCreate)
                                                           throws QaseException

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

Parameters:

projectCreate - (required)

Returns:

ApiResponse<ProjectCodeResponse>

Throws:

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

createProjectAsync

public okhttp3.Call createProjectAsync(ProjectCreate projectCreate,
                                       ApiCallback<ProjectCodeResponse> _callback)
                                throws QaseException

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

Parameters:

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

deleteProjectCall

public okhttp3.Call deleteProjectCall(String code,
                                      ApiCallback _callback)
                               throws QaseException

Build call for deleteProject

Parameters:

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

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

deleteProject

public Response deleteProject(String code)
                       throws QaseException

Delete Project by code. This method allows to delete a specific project.

Parameters:

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

Returns:

Response

Throws:

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

deleteProjectWithHttpInfo

public ApiResponse<Response> deleteProjectWithHttpInfo(String code)
                                                throws QaseException

Delete Project by code. This method allows to delete a specific project.

Parameters:

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

Returns:

ApiResponse<Response>

Throws:

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

deleteProjectAsync

public okhttp3.Call deleteProjectAsync(String code,
                                       ApiCallback<Response> _callback)
                                throws QaseException

Delete Project by code. (asynchronously) This method allows to delete a specific project.

Parameters:

code - Code of project, where to search entities. (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

getProjectCall

public okhttp3.Call getProjectCall(String code,
                                   ApiCallback _callback)
                            throws QaseException

Build call for getProject

Parameters:

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

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getProject

public ProjectResponse getProject(String code)
                           throws QaseException

Get Project by code. This method allows to retrieve a specific project.

Parameters:

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

Returns:

ProjectResponse

Throws:

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

getProjectWithHttpInfo

public ApiResponse<ProjectResponse> getProjectWithHttpInfo(String code)
                                                    throws QaseException

Get Project by code. This method allows to retrieve a specific project.

Parameters:

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

Returns:

ApiResponse<ProjectResponse>

Throws:

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

getProjectAsync

public okhttp3.Call getProjectAsync(String code,
                                    ApiCallback<ProjectResponse> _callback)
                             throws QaseException

Get Project by code. (asynchronously) This method allows to retrieve a specific project.

Parameters:

code - Code of project, where to search entities. (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

getProjectsCall

public okhttp3.Call getProjectsCall(Integer limit,
                                    Integer offset,
                                    ApiCallback _callback)
                             throws QaseException

Build call for getProjects

Parameters:

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

getProjects

public ProjectListResponse getProjects(Integer limit,
                                       Integer offset)
                                throws QaseException

Get All Projects. This method allows to retrieve all projects available for your account. You can limit and offset params to paginate.

Parameters:

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

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

Returns:

ProjectListResponse

Throws:

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

getProjectsWithHttpInfo

public ApiResponse<ProjectListResponse> getProjectsWithHttpInfo(Integer limit,
                                                                Integer offset)
                                                         throws QaseException

Get All Projects. This method allows to retrieve all projects available for your account. You can limit and offset params to paginate.

Parameters:

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

Throws:

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

getProjectsAsync

public okhttp3.Call getProjectsAsync(Integer limit,
                                     Integer offset,
                                     ApiCallback<ProjectListResponse> _callback)
                              throws QaseException

Get All Projects. (asynchronously) This method allows to retrieve all projects available for your account. You can limit and offset params to paginate.

Parameters:

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

grantAccessToProjectCall

public okhttp3.Call grantAccessToProjectCall(String code,
                                             ProjectAccess projectAccess,
                                             ApiCallback _callback)
                                      throws QaseException

Build call for grantAccessToProject

Parameters:

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

projectAccess - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

grantAccessToProject

public Response grantAccessToProject(String code,
                                     ProjectAccess projectAccess)
                              throws QaseException

Grant access to project by code. This method allows to grant access to a specific project.

Parameters:

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

projectAccess - (required)

Returns:

Response

Throws:

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

grantAccessToProjectWithHttpInfo

public ApiResponse<Response> grantAccessToProjectWithHttpInfo(String code,
                                                              ProjectAccess projectAccess)
                                                       throws QaseException

Grant access to project by code. This method allows to grant access to a specific project.

Parameters:

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

projectAccess - (required)

Returns:

ApiResponse<Response>

Throws:

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

grantAccessToProjectAsync

public okhttp3.Call grantAccessToProjectAsync(String code,
                                              ProjectAccess projectAccess,
                                              ApiCallback<Response> _callback)
                                       throws QaseException

Grant access to project by code. (asynchronously) This method allows to grant access to a specific project.

Parameters:

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

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

revokeAccessToProjectCall

public okhttp3.Call revokeAccessToProjectCall(String code,
                                              ProjectAccess projectAccess,
                                              ApiCallback _callback)
                                       throws QaseException

Build call for revokeAccessToProject

Parameters:

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

projectAccess - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

revokeAccessToProject

public Response revokeAccessToProject(String code,
                                      ProjectAccess projectAccess)
                               throws QaseException

Revoke access to project by code. This method allows to revoke access to a specific project.

Parameters:

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

projectAccess - (required)

Returns:

Response

Throws:

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

revokeAccessToProjectWithHttpInfo

public ApiResponse<Response> revokeAccessToProjectWithHttpInfo(String code,
                                                               ProjectAccess projectAccess)
                                                        throws QaseException

Revoke access to project by code. This method allows to revoke access to a specific project.

Parameters:

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

projectAccess - (required)

Returns:

ApiResponse<Response>

Throws:

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

revokeAccessToProjectAsync

public okhttp3.Call revokeAccessToProjectAsync(String code,
                                               ProjectAccess projectAccess,
                                               ApiCallback<Response> _callback)
                                        throws QaseException

Revoke access to project by code. (asynchronously) This method allows to revoke access to a specific project.

Parameters:

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

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