com.docdoku.api.services

Class RolesApi

java.lang.Object

com.docdoku.api.services.RolesApi

public class RolesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RolesApi()
RolesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
RoleDTO	createRole(String workspaceId, RoleDTO body) Create a new role
com.squareup.okhttp.Call	createRoleAsync(String workspaceId, RoleDTO body, ApiCallback<RoleDTO> callback) Create a new role (asynchronously)
ApiResponse<RoleDTO>	createRoleWithHttpInfo(String workspaceId, RoleDTO body) Create a new role
void	deleteRole(String workspaceId, String roleName) Delete a role
com.squareup.okhttp.Call	deleteRoleAsync(String workspaceId, String roleName, ApiCallback<Void> callback) Delete a role (asynchronously)
ApiResponse<Void>	deleteRoleWithHttpInfo(String workspaceId, String roleName) Delete a role
ApiClient	getApiClient()
List<RoleDTO>	getRolesInUseInWorkspace(String workspaceId) Get roles in use in given workspace
com.squareup.okhttp.Call	getRolesInUseInWorkspaceAsync(String workspaceId, ApiCallback<List<RoleDTO>> callback) Get roles in use in given workspace (asynchronously)
ApiResponse<List<RoleDTO>>	getRolesInUseInWorkspaceWithHttpInfo(String workspaceId) Get roles in use in given workspace
List<RoleDTO>	getRolesInWorkspace(String workspaceId) Get roles in given workspace
com.squareup.okhttp.Call	getRolesInWorkspaceAsync(String workspaceId, ApiCallback<List<RoleDTO>> callback) Get roles in given workspace (asynchronously)
ApiResponse<List<RoleDTO>>	getRolesInWorkspaceWithHttpInfo(String workspaceId) Get roles in given workspace
void	setApiClient(ApiClient apiClient)
RoleDTO	updateRole(String workspaceId, String roleName, RoleDTO body) Update a role
com.squareup.okhttp.Call	updateRoleAsync(String workspaceId, String roleName, RoleDTO body, ApiCallback<RoleDTO> callback) Update a role (asynchronously)
ApiResponse<RoleDTO>	updateRoleWithHttpInfo(String workspaceId, String roleName, RoleDTO body) Update a role

Methods inherited from class java.lang.Object

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

Constructor Detail

RolesApi

public RolesApi()

RolesApi

public RolesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getRolesInWorkspace

public List<RoleDTO> getRolesInWorkspace(String workspaceId)
                                  throws ApiException

Get roles in given workspace

Parameters:

workspaceId - Workspace id

Returns:

List

Throws:

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

getRolesInWorkspaceWithHttpInfo

public ApiResponse<List<RoleDTO>> getRolesInWorkspaceWithHttpInfo(String workspaceId)
                                                           throws ApiException

Get roles in given workspace

Parameters:

workspaceId - Workspace id

Returns:

ApiResponse>

Throws:

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

getRolesInWorkspaceAsync

public com.squareup.okhttp.Call getRolesInWorkspaceAsync(String workspaceId,
                                                         ApiCallback<List<RoleDTO>> callback)
                                                  throws ApiException

Get roles in given workspace (asynchronously)

Parameters:

workspaceId - Workspace id

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

Returns:

The request call

Throws:

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

createRole

public RoleDTO createRole(String workspaceId,
                          RoleDTO body)
                   throws ApiException

Create a new role

Parameters:

workspaceId - Workspace id

body - Role to create

Returns:

RoleDTO

Throws:

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

createRoleWithHttpInfo

public ApiResponse<RoleDTO> createRoleWithHttpInfo(String workspaceId,
                                                   RoleDTO body)
                                            throws ApiException

Create a new role

Parameters:

workspaceId - Workspace id

body - Role to create

Returns:

ApiResponse

Throws:

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

createRoleAsync

public com.squareup.okhttp.Call createRoleAsync(String workspaceId,
                                                RoleDTO body,
                                                ApiCallback<RoleDTO> callback)
                                         throws ApiException

Create a new role (asynchronously)

Parameters:

workspaceId - Workspace id

body - Role to create

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

Returns:

The request call

Throws:

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

getRolesInUseInWorkspace

public List<RoleDTO> getRolesInUseInWorkspace(String workspaceId)
                                       throws ApiException

Get roles in use in given workspace

Parameters:

workspaceId - Workspace id

Returns:

List

Throws:

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

getRolesInUseInWorkspaceWithHttpInfo

public ApiResponse<List<RoleDTO>> getRolesInUseInWorkspaceWithHttpInfo(String workspaceId)
                                                                throws ApiException

Get roles in use in given workspace

Parameters:

workspaceId - Workspace id

Returns:

ApiResponse>

Throws:

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

getRolesInUseInWorkspaceAsync

public com.squareup.okhttp.Call getRolesInUseInWorkspaceAsync(String workspaceId,
                                                              ApiCallback<List<RoleDTO>> callback)
                                                       throws ApiException

Get roles in use in given workspace (asynchronously)

Parameters:

workspaceId - Workspace id

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

Returns:

The request call

Throws:

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

updateRole

public RoleDTO updateRole(String workspaceId,
                          String roleName,
                          RoleDTO body)
                   throws ApiException

Update a role

Parameters:

workspaceId - Workspace id

roleName - Role name

body - Role to update

Returns:

RoleDTO

Throws:

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

updateRoleWithHttpInfo

public ApiResponse<RoleDTO> updateRoleWithHttpInfo(String workspaceId,
                                                   String roleName,
                                                   RoleDTO body)
                                            throws ApiException

Update a role

Parameters:

workspaceId - Workspace id

roleName - Role name

body - Role to update

Returns:

ApiResponse

Throws:

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

updateRoleAsync

public com.squareup.okhttp.Call updateRoleAsync(String workspaceId,
                                                String roleName,
                                                RoleDTO body,
                                                ApiCallback<RoleDTO> callback)
                                         throws ApiException

Update a role (asynchronously)

Parameters:

workspaceId - Workspace id

roleName - Role name

body - Role to update

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

Returns:

The request call

Throws:

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

deleteRole

public void deleteRole(String workspaceId,
                       String roleName)
                throws ApiException

Delete a role

Parameters:

workspaceId - Workspace id

roleName - Role name

Throws:

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

deleteRoleWithHttpInfo

public ApiResponse<Void> deleteRoleWithHttpInfo(String workspaceId,
                                                String roleName)
                                         throws ApiException

Delete a role

Parameters:

workspaceId - Workspace id

roleName - Role name

Returns:

ApiResponse

Throws:

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

deleteRoleAsync

public com.squareup.okhttp.Call deleteRoleAsync(String workspaceId,
                                                String roleName,
                                                ApiCallback<Void> callback)
                                         throws ApiException

Delete a role (asynchronously)

Parameters:

workspaceId - Workspace id

roleName - Role name

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

Returns:

The request call

Throws:

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