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

Class TenantsApi

java.lang.Object

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

public class TenantsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TenantsApi()
TenantsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
GrantData	assignOrUpdateGrant(java.lang.String tenantCode, GrantData body)
com.squareup.okhttp.Call	assignOrUpdateGrantAsync(java.lang.String tenantCode, GrantData body, ApiCallback<GrantData> callback) (asynchronously)
ApiResponse<GrantData>	assignOrUpdateGrantWithHttpInfo(java.lang.String tenantCode, GrantData body)
void	create(CreateTenantData body) Creates a tenant and makes the user calling owner of it
com.squareup.okhttp.Call	createAsync(CreateTenantData body, ApiCallback<java.lang.Void> callback) Creates a tenant and makes the user calling owner of it (asynchronously)
ApiResponse<java.lang.Void>	createWithHttpInfo(CreateTenantData body) Creates a tenant and makes the user calling owner of it
void	delete(java.lang.String tenantCode, java.lang.Boolean cascade)
com.squareup.okhttp.Call	deleteAsync(java.lang.String tenantCode, java.lang.Boolean cascade, ApiCallback<java.lang.Void> callback) (asynchronously)
void	deleteGrant(java.lang.String tenantCode, java.lang.Long grantId)
com.squareup.okhttp.Call	deleteGrantAsync(java.lang.String tenantCode, java.lang.Long grantId, ApiCallback<java.lang.Void> callback) (asynchronously)
ApiResponse<java.lang.Void>	deleteGrantWithHttpInfo(java.lang.String tenantCode, java.lang.Long grantId)
ApiResponse<java.lang.Void>	deleteWithHttpInfo(java.lang.String tenantCode, java.lang.Boolean cascade)
PagedTenantData	find(java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String name, java.lang.String code, java.lang.String codeOrName, java.lang.String country, java.lang.Boolean current, java.lang.Boolean all, java.lang.Boolean ownerOnly, java.lang.String type, java.lang.String attrName, java.lang.String attrValue, java.lang.String email) Searches for tenants of current user
com.squareup.okhttp.Call	findAsync(java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String name, java.lang.String code, java.lang.String codeOrName, java.lang.String country, java.lang.Boolean current, java.lang.Boolean all, java.lang.Boolean ownerOnly, java.lang.String type, java.lang.String attrName, java.lang.String attrValue, java.lang.String email, ApiCallback<PagedTenantData> callback) Searches for tenants of current user (asynchronously)
ApiResponse<PagedTenantData>	findWithHttpInfo(java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String name, java.lang.String code, java.lang.String codeOrName, java.lang.String country, java.lang.Boolean current, java.lang.Boolean all, java.lang.Boolean ownerOnly, java.lang.String type, java.lang.String attrName, java.lang.String attrValue, java.lang.String email) Searches for tenants of current user
ApiClient	getApiClient()
PagedGrantData	grants_0(java.lang.String tenantCode, java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String email, java.lang.Boolean current, java.lang.Boolean direct) Search for grants of tenant.
com.squareup.okhttp.Call	grants_0Async(java.lang.String tenantCode, java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String email, java.lang.Boolean current, java.lang.Boolean direct, ApiCallback<PagedGrantData> callback) Search for grants of tenant.
ApiResponse<PagedGrantData>	grants_0WithHttpInfo(java.lang.String tenantCode, java.lang.Integer page, java.lang.Integer size, java.lang.String sortOn, java.lang.String sortDir, java.lang.String email, java.lang.Boolean current, java.lang.Boolean direct) Search for grants of tenant.
GrantData	grants_1(java.lang.String tenantCode) Returns requesting user grants for tenant
com.squareup.okhttp.Call	grants_1Async(java.lang.String tenantCode, ApiCallback<GrantData> callback) Returns requesting user grants for tenant (asynchronously)
ApiResponse<GrantData>	grants_1WithHttpInfo(java.lang.String tenantCode) Returns requesting user grants for tenant
GrantData	grants()
com.squareup.okhttp.Call	grantsAsync(ApiCallback<GrantData> callback) (asynchronously)
ApiResponse<GrantData>	grantsWithHttpInfo()
TenantData	register(RegisterTenantData body) Registers a tenant and makes defined user an owner of it
com.squareup.okhttp.Call	registerAsync(RegisterTenantData body, ApiCallback<TenantData> callback) Registers a tenant and makes defined user an owner of it (asynchronously)
ApiResponse<TenantData>	registerWithHttpInfo(RegisterTenantData body) Registers a tenant and makes defined user an owner of it
void	setApiClient(ApiClient apiClient)
void	update(java.lang.String tenantCode, TenantData body) Updates a tenant, so e.g.
com.squareup.okhttp.Call	updateAsync(java.lang.String tenantCode, TenantData body, ApiCallback<java.lang.Void> callback) Updates a tenant, so e.g.
ApiResponse<java.lang.Void>	updateWithHttpInfo(java.lang.String tenantCode, TenantData body) Updates a tenant, so e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantsApi

public TenantsApi()

TenantsApi

public TenantsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

assignOrUpdateGrant

public GrantData assignOrUpdateGrant(java.lang.String tenantCode,
                                     GrantData body)
                              throws ApiException

Parameters:

tenantCode - (required)

body - (optional)

Returns:

GrantData

Throws:

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

assignOrUpdateGrantWithHttpInfo

public ApiResponse<GrantData> assignOrUpdateGrantWithHttpInfo(java.lang.String tenantCode,
                                                              GrantData body)
                                                       throws ApiException

Parameters:

tenantCode - (required)

body - (optional)

Returns:

ApiResponse<GrantData>

Throws:

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

assignOrUpdateGrantAsync

public com.squareup.okhttp.Call assignOrUpdateGrantAsync(java.lang.String tenantCode,
                                                         GrantData body,
                                                         ApiCallback<GrantData> callback)
                                                  throws ApiException

(asynchronously)

Parameters:

tenantCode - (required)

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

create

public void create(CreateTenantData body)
            throws ApiException

Creates a tenant and makes the user calling owner of it

Parameters:

body - (optional)

Throws:

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

createWithHttpInfo

public ApiResponse<java.lang.Void> createWithHttpInfo(CreateTenantData body)
                                               throws ApiException

Creates a tenant and makes the user calling owner of it

Parameters:

body - (optional)

Returns:

ApiResponse<Void>

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(CreateTenantData body,
                                            ApiCallback<java.lang.Void> callback)
                                     throws ApiException

Creates a tenant and makes the user calling owner of it (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

delete

public void delete(java.lang.String tenantCode,
                   java.lang.Boolean cascade)
            throws ApiException

Parameters:

tenantCode - (required)

cascade - If set to true it will also remove all children (optional, default to false)

Throws:

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

deleteWithHttpInfo

public ApiResponse<java.lang.Void> deleteWithHttpInfo(java.lang.String tenantCode,
                                                      java.lang.Boolean cascade)
                                               throws ApiException

Parameters:

tenantCode - (required)

cascade - If set to true it will also remove all children (optional, default to false)

Returns:

ApiResponse<Void>

Throws:

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

deleteAsync

public com.squareup.okhttp.Call deleteAsync(java.lang.String tenantCode,
                                            java.lang.Boolean cascade,
                                            ApiCallback<java.lang.Void> callback)
                                     throws ApiException

(asynchronously)

Parameters:

tenantCode - (required)

cascade - If set to true it will also remove all children (optional, default to false)

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

deleteGrant

public void deleteGrant(java.lang.String tenantCode,
                        java.lang.Long grantId)
                 throws ApiException

Parameters:

tenantCode - (required)

grantId - (required)

Throws:

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

deleteGrantWithHttpInfo

public ApiResponse<java.lang.Void> deleteGrantWithHttpInfo(java.lang.String tenantCode,
                                                           java.lang.Long grantId)
                                                    throws ApiException

Parameters:

tenantCode - (required)

grantId - (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteGrantAsync

public com.squareup.okhttp.Call deleteGrantAsync(java.lang.String tenantCode,
                                                 java.lang.Long grantId,
                                                 ApiCallback<java.lang.Void> callback)
                                          throws ApiException

(asynchronously)

Parameters:

tenantCode - (required)

grantId - (required)

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

find

public PagedTenantData find(java.lang.Integer page,
                            java.lang.Integer size,
                            java.lang.String sortOn,
                            java.lang.String sortDir,
                            java.lang.String name,
                            java.lang.String code,
                            java.lang.String codeOrName,
                            java.lang.String country,
                            java.lang.Boolean current,
                            java.lang.Boolean all,
                            java.lang.Boolean ownerOnly,
                            java.lang.String type,
                            java.lang.String attrName,
                            java.lang.String attrValue,
                            java.lang.String email)
                     throws ApiException

Searches for tenants of current user

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)

name - Tenant name (optional)

code - Tenant code (optional)

codeOrName - Tenant code or name (optional)

country - Iso country code (optional)

current - Only tenants which date ranges are valid for current date (optional, default to true)

all - Set to true to disable user assigned tenants filter (optional)

ownerOnly - Filter by user owned tenants (not working when 'all' set to true) (optional, default to false)

type - Select filter type. HUB - tenant in hub meaning, DATA - tenant which is related to data permissions (optional, default to HUB)

attrName - (optional)

attrValue - (optional)

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

Returns:

PagedTenantData

Throws:

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

findWithHttpInfo

public ApiResponse<PagedTenantData> findWithHttpInfo(java.lang.Integer page,
                                                     java.lang.Integer size,
                                                     java.lang.String sortOn,
                                                     java.lang.String sortDir,
                                                     java.lang.String name,
                                                     java.lang.String code,
                                                     java.lang.String codeOrName,
                                                     java.lang.String country,
                                                     java.lang.Boolean current,
                                                     java.lang.Boolean all,
                                                     java.lang.Boolean ownerOnly,
                                                     java.lang.String type,
                                                     java.lang.String attrName,
                                                     java.lang.String attrValue,
                                                     java.lang.String email)
                                              throws ApiException

Searches for tenants of current user

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)

name - Tenant name (optional)

code - Tenant code (optional)

codeOrName - Tenant code or name (optional)

country - Iso country code (optional)

current - Only tenants which date ranges are valid for current date (optional, default to true)

all - Set to true to disable user assigned tenants filter (optional)

ownerOnly - Filter by user owned tenants (not working when 'all' set to true) (optional, default to false)

type - Select filter type. HUB - tenant in hub meaning, DATA - tenant which is related to data permissions (optional, default to HUB)

attrName - (optional)

attrValue - (optional)

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

Returns:

ApiResponse<PagedTenantData>

Throws:

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

findAsync

public com.squareup.okhttp.Call findAsync(java.lang.Integer page,
                                          java.lang.Integer size,
                                          java.lang.String sortOn,
                                          java.lang.String sortDir,
                                          java.lang.String name,
                                          java.lang.String code,
                                          java.lang.String codeOrName,
                                          java.lang.String country,
                                          java.lang.Boolean current,
                                          java.lang.Boolean all,
                                          java.lang.Boolean ownerOnly,
                                          java.lang.String type,
                                          java.lang.String attrName,
                                          java.lang.String attrValue,
                                          java.lang.String email,
                                          ApiCallback<PagedTenantData> callback)
                                   throws ApiException

Searches for tenants of current user (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)

name - Tenant name (optional)

code - Tenant code (optional)

codeOrName - Tenant code or name (optional)

country - Iso country code (optional)

current - Only tenants which date ranges are valid for current date (optional, default to true)

all - Set to true to disable user assigned tenants filter (optional)

ownerOnly - Filter by user owned tenants (not working when 'all' set to true) (optional, default to false)

type - Select filter type. HUB - tenant in hub meaning, DATA - tenant which is related to data permissions (optional, default to HUB)

attrName - (optional)

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

grants

public GrantData grants()
                 throws ApiException

Returns:

GrantData

Throws:

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

grantsWithHttpInfo

public ApiResponse<GrantData> grantsWithHttpInfo()
                                          throws ApiException

Returns:

ApiResponse<GrantData>

Throws:

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

grantsAsync

public com.squareup.okhttp.Call grantsAsync(ApiCallback<GrantData> callback)
                                     throws ApiException

(asynchronously)

Parameters:

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

grants_0

public PagedGrantData grants_0(java.lang.String tenantCode,
                               java.lang.Integer page,
                               java.lang.Integer size,
                               java.lang.String sortOn,
                               java.lang.String sortDir,
                               java.lang.String email,
                               java.lang.Boolean current,
                               java.lang.Boolean direct)
                        throws ApiException

Search for grants of tenant. Requires owner role of grant

Parameters:

tenantCode - Code of tenant (required)

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)

email - Email name (optional)

current - Should only return current grants with valid dates (optional, default to true)

direct - Return grants assigned to this tenant by inheritance (optional, default to false)

Returns:

PagedGrantData

Throws:

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

grants_0WithHttpInfo

public ApiResponse<PagedGrantData> grants_0WithHttpInfo(java.lang.String tenantCode,
                                                        java.lang.Integer page,
                                                        java.lang.Integer size,
                                                        java.lang.String sortOn,
                                                        java.lang.String sortDir,
                                                        java.lang.String email,
                                                        java.lang.Boolean current,
                                                        java.lang.Boolean direct)
                                                 throws ApiException

Search for grants of tenant. Requires owner role of grant

Parameters:

tenantCode - Code of tenant (required)

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)

email - Email name (optional)

current - Should only return current grants with valid dates (optional, default to true)

direct - Return grants assigned to this tenant by inheritance (optional, default to false)

Returns:

ApiResponse<PagedGrantData>

Throws:

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

grants_0Async

public com.squareup.okhttp.Call grants_0Async(java.lang.String tenantCode,
                                              java.lang.Integer page,
                                              java.lang.Integer size,
                                              java.lang.String sortOn,
                                              java.lang.String sortDir,
                                              java.lang.String email,
                                              java.lang.Boolean current,
                                              java.lang.Boolean direct,
                                              ApiCallback<PagedGrantData> callback)
                                       throws ApiException

Search for grants of tenant. Requires owner role of grant (asynchronously)

Parameters:

tenantCode - Code of tenant (required)

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)

email - Email name (optional)

current - Should only return current grants with valid dates (optional, default to true)

direct - Return grants assigned to this tenant by inheritance (optional, default to false)

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

grants_1

public GrantData grants_1(java.lang.String tenantCode)
                   throws ApiException

Returns requesting user grants for tenant

Parameters:

tenantCode - (required)

Returns:

GrantData

Throws:

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

grants_1WithHttpInfo

public ApiResponse<GrantData> grants_1WithHttpInfo(java.lang.String tenantCode)
                                            throws ApiException

Returns requesting user grants for tenant

Parameters:

tenantCode - (required)

Returns:

ApiResponse<GrantData>

Throws:

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

grants_1Async

public com.squareup.okhttp.Call grants_1Async(java.lang.String tenantCode,
                                              ApiCallback<GrantData> callback)
                                       throws ApiException

Returns requesting user grants for tenant (asynchronously)

Parameters:

tenantCode - (required)

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

register

public TenantData register(RegisterTenantData body)
                    throws ApiException

Registers a tenant and makes defined user an owner of it

Parameters:

body - (optional)

Returns:

TenantData

Throws:

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

registerWithHttpInfo

public ApiResponse<TenantData> registerWithHttpInfo(RegisterTenantData body)
                                             throws ApiException

Registers a tenant and makes defined user an owner of it

Parameters:

body - (optional)

Returns:

ApiResponse<TenantData>

Throws:

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

registerAsync

public com.squareup.okhttp.Call registerAsync(RegisterTenantData body,
                                              ApiCallback<TenantData> callback)
                                       throws ApiException

Registers a tenant and makes defined user an owner of it (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

update

public void update(java.lang.String tenantCode,
                   TenantData body)
            throws ApiException

Updates a tenant, so e.g. allows to set parent of tenant

Parameters:

tenantCode - (required)

body - (optional)

Throws:

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

updateWithHttpInfo

public ApiResponse<java.lang.Void> updateWithHttpInfo(java.lang.String tenantCode,
                                                      TenantData body)
                                               throws ApiException

Updates a tenant, so e.g. allows to set parent of tenant

Parameters:

tenantCode - (required)

body - (optional)

Returns:

ApiResponse<Void>

Throws:

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

updateAsync

public com.squareup.okhttp.Call updateAsync(java.lang.String tenantCode,
                                            TenantData body,
                                            ApiCallback<java.lang.Void> callback)
                                     throws ApiException

Updates a tenant, so e.g. allows to set parent of tenant (asynchronously)

Parameters:

tenantCode - (required)

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