Class TenantsApi


  • public class TenantsApi
    extends Object
    • Constructor Detail

      • TenantsApi

        public TenantsApi()
      • TenantsApi

        public TenantsApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • getTenantExistenceCall

        public okhttp3.Call getTenantExistenceCall​(String tenantDomain,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for getTenantExistence
        Parameters:
        tenantDomain - The domain of a specific tenant (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getTenantExistence

        public void getTenantExistence​(String tenantDomain)
                                throws ApiException
        Check Whether the Given Tenant already Exists Using this operation, user can check whether a given tenant exists or not.
        Parameters:
        tenantDomain - The domain of a specific tenant (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getTenantExistenceWithHttpInfo

        public ApiResponse<Void> getTenantExistenceWithHttpInfo​(String tenantDomain)
                                                         throws ApiException
        Check Whether the Given Tenant already Exists Using this operation, user can check whether a given tenant exists or not.
        Parameters:
        tenantDomain - The domain of a specific tenant (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getTenantExistenceAsync

        public okhttp3.Call getTenantExistenceAsync​(String tenantDomain,
                                                    ApiCallback<Void> _callback)
                                             throws ApiException
        Check Whether the Given Tenant already Exists (asynchronously) Using this operation, user can check whether a given tenant exists or not.
        Parameters:
        tenantDomain - The domain of a specific tenant (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
      • getTenantsByStateCall

        public okhttp3.Call getTenantsByStateCall​(String state,
                                                  Integer limit,
                                                  Integer offset,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for getTenantsByState
        Parameters:
        state - The state represents the current state of the tenant Supported states are [active, inactive] (optional, default to active)
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getTenantsByState

        public TenantListDTO getTenantsByState​(String state,
                                               Integer limit,
                                               Integer offset)
                                        throws ApiException
        Get Tenants by State This operation is to get tenants by state
        Parameters:
        state - The state represents the current state of the tenant Supported states are [active, inactive] (optional, default to active)
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        Returns:
        TenantListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getTenantsByStateWithHttpInfo

        public ApiResponse<TenantListDTO> getTenantsByStateWithHttpInfo​(String state,
                                                                        Integer limit,
                                                                        Integer offset)
                                                                 throws ApiException
        Get Tenants by State This operation is to get tenants by state
        Parameters:
        state - The state represents the current state of the tenant Supported states are [active, inactive] (optional, default to active)
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        Returns:
        ApiResponse<TenantListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getTenantsByStateAsync

        public okhttp3.Call getTenantsByStateAsync​(String state,
                                                   Integer limit,
                                                   Integer offset,
                                                   ApiCallback<TenantListDTO> _callback)
                                            throws ApiException
        Get Tenants by State (asynchronously) This operation is to get tenants by state
        Parameters:
        state - The state represents the current state of the tenant Supported states are [active, inactive] (optional, default to active)
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        _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