com.configcat.publicapi.java.client.api

Class PermissionGroupsApi

java.lang.Object

com.configcat.publicapi.java.client.api.PermissionGroupsApi

public class PermissionGroupsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PermissionGroupsApi()
PermissionGroupsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
PermissionGroupModel	createPermissionGroup(java.util.UUID productId, CreatePermissionGroupRequest createPermissionGroupRequest) Create Permission Group This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
okhttp3.Call	createPermissionGroupAsync(java.util.UUID productId, CreatePermissionGroupRequest createPermissionGroupRequest, ApiCallback<PermissionGroupModel> _callback) Create Permission Group (asynchronously) This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
okhttp3.Call	createPermissionGroupCall(java.util.UUID productId, CreatePermissionGroupRequest createPermissionGroupRequest, ApiCallback _callback) Build call for createPermissionGroup
ApiResponse<PermissionGroupModel>	createPermissionGroupWithHttpInfo(java.util.UUID productId, CreatePermissionGroupRequest createPermissionGroupRequest) Create Permission Group This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
void	deletePermissionGroup(java.lang.Long permissionGroupId) Delete Permission Group This endpoint removes a Permission Group identified by the `permissionGroupId` parameter.
okhttp3.Call	deletePermissionGroupAsync(java.lang.Long permissionGroupId, ApiCallback<java.lang.Void> _callback) Delete Permission Group (asynchronously) This endpoint removes a Permission Group identified by the `permissionGroupId` parameter.
okhttp3.Call	deletePermissionGroupCall(java.lang.Long permissionGroupId, ApiCallback _callback) Build call for deletePermissionGroup
ApiResponse<java.lang.Void>	deletePermissionGroupWithHttpInfo(java.lang.Long permissionGroupId) Delete Permission Group This endpoint removes a Permission Group identified by the `permissionGroupId` parameter.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
PermissionGroupModel	getPermissionGroup(java.lang.Long permissionGroupId) Get Permission Group This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.
okhttp3.Call	getPermissionGroupAsync(java.lang.Long permissionGroupId, ApiCallback<PermissionGroupModel> _callback) Get Permission Group (asynchronously) This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.
okhttp3.Call	getPermissionGroupCall(java.lang.Long permissionGroupId, ApiCallback _callback) Build call for getPermissionGroup
java.util.List<PermissionGroupModel>	getPermissionGroups(java.util.UUID productId) List Permission Groups This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
okhttp3.Call	getPermissionGroupsAsync(java.util.UUID productId, ApiCallback<java.util.List<PermissionGroupModel>> _callback) List Permission Groups (asynchronously) This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
okhttp3.Call	getPermissionGroupsCall(java.util.UUID productId, ApiCallback _callback) Build call for getPermissionGroups
ApiResponse<java.util.List<PermissionGroupModel>>	getPermissionGroupsWithHttpInfo(java.util.UUID productId) List Permission Groups This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
ApiResponse<PermissionGroupModel>	getPermissionGroupWithHttpInfo(java.lang.Long permissionGroupId) Get Permission Group This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
PermissionGroupModel	updatePermissionGroup(java.lang.Long permissionGroupId, UpdatePermissionGroupRequest updatePermissionGroupRequest) Update Permission Group This endpoint updates a Permission Group identified by the `permissionGroupId` parameter.
okhttp3.Call	updatePermissionGroupAsync(java.lang.Long permissionGroupId, UpdatePermissionGroupRequest updatePermissionGroupRequest, ApiCallback<PermissionGroupModel> _callback) Update Permission Group (asynchronously) This endpoint updates a Permission Group identified by the `permissionGroupId` parameter.
okhttp3.Call	updatePermissionGroupCall(java.lang.Long permissionGroupId, UpdatePermissionGroupRequest updatePermissionGroupRequest, ApiCallback _callback) Build call for updatePermissionGroup
ApiResponse<PermissionGroupModel>	updatePermissionGroupWithHttpInfo(java.lang.Long permissionGroupId, UpdatePermissionGroupRequest updatePermissionGroupRequest) Update Permission Group This endpoint updates a Permission Group identified by the `permissionGroupId` parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionGroupsApi

public PermissionGroupsApi()

PermissionGroupsApi

public PermissionGroupsApi(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 java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

createPermissionGroupCall

public okhttp3.Call createPermissionGroupCall(java.util.UUID productId,
                                              CreatePermissionGroupRequest createPermissionGroupRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for createPermissionGroup

Parameters:

productId - The identifier of the Product. (required)

createPermissionGroupRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createPermissionGroup

public PermissionGroupModel createPermissionGroup(java.util.UUID productId,
                                                  CreatePermissionGroupRequest createPermissionGroupRequest)
                                           throws ApiException

Create Permission Group This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

createPermissionGroupRequest - (required)

Returns:

PermissionGroupModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createPermissionGroupWithHttpInfo

public ApiResponse<PermissionGroupModel> createPermissionGroupWithHttpInfo(java.util.UUID productId,
                                                                           CreatePermissionGroupRequest createPermissionGroupRequest)
                                                                    throws ApiException

Create Permission Group This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

createPermissionGroupRequest - (required)

Returns:

ApiResponse<PermissionGroupModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createPermissionGroupAsync

public okhttp3.Call createPermissionGroupAsync(java.util.UUID productId,
                                               CreatePermissionGroupRequest createPermissionGroupRequest,
                                               ApiCallback<PermissionGroupModel> _callback)
                                        throws ApiException

Create Permission Group (asynchronously) This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deletePermissionGroupCall

public okhttp3.Call deletePermissionGroupCall(java.lang.Long permissionGroupId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for deletePermissionGroup

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deletePermissionGroup

public void deletePermissionGroup(java.lang.Long permissionGroupId)
                           throws ApiException

Delete Permission Group This endpoint removes a Permission Group identified by the `permissionGroupId` parameter.

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

Throws:

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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deletePermissionGroupWithHttpInfo

public ApiResponse<java.lang.Void> deletePermissionGroupWithHttpInfo(java.lang.Long permissionGroupId)
                                                              throws ApiException

Delete Permission Group This endpoint removes a Permission Group identified by the `permissionGroupId` parameter.

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deletePermissionGroupAsync

public okhttp3.Call deletePermissionGroupAsync(java.lang.Long permissionGroupId,
                                               ApiCallback<java.lang.Void> _callback)
                                        throws ApiException

Delete Permission Group (asynchronously) This endpoint removes a Permission Group identified by the `permissionGroupId` parameter.

Parameters:

permissionGroupId - The identifier of the Permission Group. (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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPermissionGroupCall

public okhttp3.Call getPermissionGroupCall(java.lang.Long permissionGroupId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getPermissionGroup

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the permission group data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPermissionGroup

public PermissionGroupModel getPermissionGroup(java.lang.Long permissionGroupId)
                                        throws ApiException

Get Permission Group This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

Returns:

PermissionGroupModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the permission group data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPermissionGroupWithHttpInfo

public ApiResponse<PermissionGroupModel> getPermissionGroupWithHttpInfo(java.lang.Long permissionGroupId)
                                                                 throws ApiException

Get Permission Group This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

Returns:

ApiResponse<PermissionGroupModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the permission group data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPermissionGroupAsync

public okhttp3.Call getPermissionGroupAsync(java.lang.Long permissionGroupId,
                                            ApiCallback<PermissionGroupModel> _callback)
                                     throws ApiException

Get Permission Group (asynchronously) This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.

Parameters:

permissionGroupId - The identifier of the Permission Group. (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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the permission group data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPermissionGroupsCall

public okhttp3.Call getPermissionGroupsCall(java.util.UUID productId,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getPermissionGroups

Parameters:

productId - The identifier of the Product. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPermissionGroups

public java.util.List<PermissionGroupModel> getPermissionGroups(java.util.UUID productId)
                                                         throws ApiException

List Permission Groups This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

Returns:

List<PermissionGroupModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPermissionGroupsWithHttpInfo

public ApiResponse<java.util.List<PermissionGroupModel>> getPermissionGroupsWithHttpInfo(java.util.UUID productId)
                                                                                  throws ApiException

List Permission Groups This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (required)

Returns:

ApiResponse<List<PermissionGroupModel>>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPermissionGroupsAsync

public okhttp3.Call getPermissionGroupsAsync(java.util.UUID productId,
                                             ApiCallback<java.util.List<PermissionGroupModel>> _callback)
                                      throws ApiException

List Permission Groups (asynchronously) This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Parameters:

productId - The identifier of the Product. (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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updatePermissionGroupCall

public okhttp3.Call updatePermissionGroupCall(java.lang.Long permissionGroupId,
                                              UpdatePermissionGroupRequest updatePermissionGroupRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for updatePermissionGroup

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

updatePermissionGroupRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updatePermissionGroup

public PermissionGroupModel updatePermissionGroup(java.lang.Long permissionGroupId,
                                                  UpdatePermissionGroupRequest updatePermissionGroupRequest)
                                           throws ApiException

Update Permission Group This endpoint updates a Permission Group identified by the `permissionGroupId` parameter.

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

updatePermissionGroupRequest - (required)

Returns:

PermissionGroupModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updatePermissionGroupWithHttpInfo

public ApiResponse<PermissionGroupModel> updatePermissionGroupWithHttpInfo(java.lang.Long permissionGroupId,
                                                                           UpdatePermissionGroupRequest updatePermissionGroupRequest)
                                                                    throws ApiException

Update Permission Group This endpoint updates a Permission Group identified by the `permissionGroupId` parameter.

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

updatePermissionGroupRequest - (required)

Returns:

ApiResponse<PermissionGroupModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updatePermissionGroupAsync

public okhttp3.Call updatePermissionGroupAsync(java.lang.Long permissionGroupId,
                                               UpdatePermissionGroupRequest updatePermissionGroupRequest,
                                               ApiCallback<PermissionGroupModel> _callback)
                                        throws ApiException

Update Permission Group (asynchronously) This endpoint updates a Permission Group identified by the `permissionGroupId` parameter.

Parameters:

permissionGroupId - The identifier of the Permission Group. (required)

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-