com.adaptris.permissions.security.access.pe.api

Class DataTenantsApi

java.lang.Object

com.adaptris.permissions.security.access.pe.api.DataTenantsApi

public class DataTenantsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DataTenantsApi()
DataTenantsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DataTenantData	create(DataTenantData body) Creates data tenants with hierarchy
com.squareup.okhttp.Call	createAsync(DataTenantData body, ApiCallback<DataTenantData> callback) Creates data tenants with hierarchy (asynchronously)
ApiResponse<DataTenantData>	createWithHttpInfo(DataTenantData body) Creates data tenants with hierarchy
ApiClient	getApiClient()
java.util.List<DataTenantData>	search(java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String code, java.lang.String parentCode, java.lang.Boolean withChildren, java.lang.String email) Lists data tenants to which user has access to
com.squareup.okhttp.Call	searchAsync(java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String code, java.lang.String parentCode, java.lang.Boolean withChildren, java.lang.String email, ApiCallback<java.util.List<DataTenantData>> callback) Lists data tenants to which user has access to (asynchronously)
ApiResponse<java.util.List<DataTenantData>>	searchWithHttpInfo(java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String code, java.lang.String parentCode, java.lang.Boolean withChildren, java.lang.String email) Lists data tenants to which user has access to
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTenantsApi

public DataTenantsApi()

DataTenantsApi

public DataTenantsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

create

public DataTenantData create(DataTenantData body)
                      throws ApiException

Creates data tenants with hierarchy

Parameters:

body - (optional)

Returns:

DataTenantData

Throws:

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

createWithHttpInfo

public ApiResponse<DataTenantData> createWithHttpInfo(DataTenantData body)
                                               throws ApiException

Creates data tenants with hierarchy

Parameters:

body - (optional)

Returns:

ApiResponse<DataTenantData>

Throws:

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

createAsync

public com.squareup.okhttp.Call createAsync(DataTenantData body,
                                            ApiCallback<DataTenantData> callback)
                                     throws ApiException

Creates data tenants with hierarchy (asynchronously)

Parameters:

body - (optional)

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

search

public java.util.List<DataTenantData> search(java.lang.Integer page,
                                             java.lang.Integer size,
                                             java.lang.String sortOn,
                                             java.lang.String sortDir,
                                             java.lang.String code,
                                             java.lang.String parentCode,
                                             java.lang.Boolean withChildren,
                                             java.lang.String email)
                                      throws ApiException

Lists data tenants to which user has access to

Parameters:

page - Page number (optional, default to 0)

size - Page size (optional, default to 10)

sortOn - Sort column (optional)

sortDir - Sort direction (optional, default to ASC)

code - Tenant code (optional)

parentCode - Parent code (optional)

withChildren - Should be permissions returned together with children permission, works if only one permission returned (optional)

email - Search for tenants assigned to the user. Available for privileged executor. (optional)

Returns:

List<DataTenantData>

Throws:

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

searchWithHttpInfo

public ApiResponse<java.util.List<DataTenantData>> searchWithHttpInfo(java.lang.Integer page,
                                                                      java.lang.Integer size,
                                                                      java.lang.String sortOn,
                                                                      java.lang.String sortDir,
                                                                      java.lang.String code,
                                                                      java.lang.String parentCode,
                                                                      java.lang.Boolean withChildren,
                                                                      java.lang.String email)
                                                               throws ApiException

Lists data tenants to which user has access to

Parameters:

page - Page number (optional, default to 0)

size - Page size (optional, default to 10)

sortOn - Sort column (optional)

sortDir - Sort direction (optional, default to ASC)

code - Tenant code (optional)

parentCode - Parent code (optional)

withChildren - Should be permissions returned together with children permission, works if only one permission returned (optional)

email - Search for tenants assigned to the user. Available for privileged executor. (optional)

Returns:

ApiResponse<List<DataTenantData>>

Throws:

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

searchAsync

public com.squareup.okhttp.Call searchAsync(java.lang.Integer page,
                                            java.lang.Integer size,
                                            java.lang.String sortOn,
                                            java.lang.String sortDir,
                                            java.lang.String code,
                                            java.lang.String parentCode,
                                            java.lang.Boolean withChildren,
                                            java.lang.String email,
                                            ApiCallback<java.util.List<DataTenantData>> callback)
                                     throws ApiException

Lists data tenants to which user has access to (asynchronously)

Parameters:

page - Page number (optional, default to 0)

size - Page size (optional, default to 10)

sortOn - Sort column (optional)

sortDir - Sort direction (optional, default to ASC)

code - Tenant code (optional)

parentCode - Parent code (optional)

withChildren - Should be permissions returned together with children permission, works if only one permission returned (optional)

email - Search for tenants assigned to the user. Available for privileged executor. (optional)

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