org.wso2.am.integration.clients.publisher.api.v1

Class ScopesApi

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.ScopesApi

public class ScopesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ScopesApi()
ScopesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ScopeDTO	addSharedScope(ScopeDTO body) Add a new Shared Scope This operation can be used to add a new Shared Scope.
com.squareup.okhttp.Call	addSharedScopeAsync(ScopeDTO body, ApiCallback<ScopeDTO> callback) Add a new Shared Scope (asynchronously) This operation can be used to add a new Shared Scope.
com.squareup.okhttp.Call	addSharedScopeCall(ScopeDTO body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for addSharedScope
ApiResponse<ScopeDTO>	addSharedScopeWithHttpInfo(ScopeDTO body) Add a new Shared Scope This operation can be used to add a new Shared Scope.
void	deleteSharedScope(String scopeId) Delete a Shared Scope This operation can be used to delete a Shared Scope proving the Id of the scope.
com.squareup.okhttp.Call	deleteSharedScopeAsync(String scopeId, ApiCallback<Void> callback) Delete a Shared Scope (asynchronously) This operation can be used to delete a Shared Scope proving the Id of the scope.
com.squareup.okhttp.Call	deleteSharedScopeCall(String scopeId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteSharedScope
ApiResponse<Void>	deleteSharedScopeWithHttpInfo(String scopeId) Delete a Shared Scope This operation can be used to delete a Shared Scope proving the Id of the scope.
ApiClient	getApiClient()
ScopeDTO	getSharedScope(String scopeId) Get a Shared Scope by Scope Id This operation can be used to retrieve details of a Shared Scope by a given scope Id.
com.squareup.okhttp.Call	getSharedScopeAsync(String scopeId, ApiCallback<ScopeDTO> callback) Get a Shared Scope by Scope Id (asynchronously) This operation can be used to retrieve details of a Shared Scope by a given scope Id.
com.squareup.okhttp.Call	getSharedScopeCall(String scopeId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSharedScope
ScopeListDTO	getSharedScopes(Integer limit, Integer offset) Get all available Shared Scopes This operation can be used to get all the available Shared Scopes.
com.squareup.okhttp.Call	getSharedScopesAsync(Integer limit, Integer offset, ApiCallback<ScopeListDTO> callback) Get all available Shared Scopes (asynchronously) This operation can be used to get all the available Shared Scopes.
com.squareup.okhttp.Call	getSharedScopesCall(Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSharedScopes
ApiResponse<ScopeListDTO>	getSharedScopesWithHttpInfo(Integer limit, Integer offset) Get all available Shared Scopes This operation can be used to get all the available Shared Scopes.
SharedScopeUsageDTO	getSharedScopeUsages(String scopeId) Get usages of a Shared Scope by Scope Id This operation can be used to retrieve usages of a Shared Scope by a given scope Id.
com.squareup.okhttp.Call	getSharedScopeUsagesAsync(String scopeId, ApiCallback<SharedScopeUsageDTO> callback) Get usages of a Shared Scope by Scope Id (asynchronously) This operation can be used to retrieve usages of a Shared Scope by a given scope Id.
com.squareup.okhttp.Call	getSharedScopeUsagesCall(String scopeId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSharedScopeUsages
ApiResponse<SharedScopeUsageDTO>	getSharedScopeUsagesWithHttpInfo(String scopeId) Get usages of a Shared Scope by Scope Id This operation can be used to retrieve usages of a Shared Scope by a given scope Id.
ApiResponse<ScopeDTO>	getSharedScopeWithHttpInfo(String scopeId) Get a Shared Scope by Scope Id This operation can be used to retrieve details of a Shared Scope by a given scope Id.
void	setApiClient(ApiClient apiClient)
ScopeDTO	updateSharedScope(String scopeId, ScopeDTO body) Update a Shared Scope This operation can be used to update a Shared Scope by a given scope Id.
com.squareup.okhttp.Call	updateSharedScopeAsync(String scopeId, ScopeDTO body, ApiCallback<ScopeDTO> callback) Update a Shared Scope (asynchronously) This operation can be used to update a Shared Scope by a given scope Id.
com.squareup.okhttp.Call	updateSharedScopeCall(String scopeId, ScopeDTO body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateSharedScope
ApiResponse<ScopeDTO>	updateSharedScopeWithHttpInfo(String scopeId, ScopeDTO body) Update a Shared Scope This operation can be used to update a Shared Scope by a given scope Id.
void	validateScope(String scopeId) Check given scope name is already exist Using this operation, user can check a given scope name exists or not.
com.squareup.okhttp.Call	validateScopeAsync(String scopeId, ApiCallback<Void> callback) Check given scope name is already exist (asynchronously) Using this operation, user can check a given scope name exists or not.
com.squareup.okhttp.Call	validateScopeCall(String scopeId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validateScope
ApiResponse<Void>	validateScopeWithHttpInfo(String scopeId) Check given scope name is already exist Using this operation, user can check a given scope name exists or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopesApi

public ScopesApi()

ScopesApi

public ScopesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addSharedScopeCall

public com.squareup.okhttp.Call addSharedScopeCall(ScopeDTO body,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for addSharedScope

Parameters:

body - Scope object that needs to be added (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addSharedScope

public ScopeDTO addSharedScope(ScopeDTO body)
                        throws ApiException

Add a new Shared Scope This operation can be used to add a new Shared Scope.

Parameters:

body - Scope object that needs to be added (required)

Returns:

ScopeDTO

Throws:

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

addSharedScopeWithHttpInfo

public ApiResponse<ScopeDTO> addSharedScopeWithHttpInfo(ScopeDTO body)
                                                 throws ApiException

Add a new Shared Scope This operation can be used to add a new Shared Scope.

Parameters:

body - Scope object that needs to be added (required)

Returns:

ApiResponse<ScopeDTO>

Throws:

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

addSharedScopeAsync

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

Add a new Shared Scope (asynchronously) This operation can be used to add a new Shared Scope.

Parameters:

body - Scope object that needs to be added (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

deleteSharedScopeCall

public com.squareup.okhttp.Call deleteSharedScopeCall(String scopeId,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for deleteSharedScope

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteSharedScope

public void deleteSharedScope(String scopeId)
                       throws ApiException

Delete a Shared Scope This operation can be used to delete a Shared Scope proving the Id of the scope.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

Throws:

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

deleteSharedScopeWithHttpInfo

public ApiResponse<Void> deleteSharedScopeWithHttpInfo(String scopeId)
                                                throws ApiException

Delete a Shared Scope This operation can be used to delete a Shared Scope proving the Id of the scope.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteSharedScopeAsync

public com.squareup.okhttp.Call deleteSharedScopeAsync(String scopeId,
                                                       ApiCallback<Void> callback)
                                                throws ApiException

Delete a Shared Scope (asynchronously) This operation can be used to delete a Shared Scope proving the Id of the scope.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (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

getSharedScopeCall

public com.squareup.okhttp.Call getSharedScopeCall(String scopeId,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getSharedScope

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSharedScope

public ScopeDTO getSharedScope(String scopeId)
                        throws ApiException

Get a Shared Scope by Scope Id This operation can be used to retrieve details of a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

Returns:

ScopeDTO

Throws:

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

getSharedScopeWithHttpInfo

public ApiResponse<ScopeDTO> getSharedScopeWithHttpInfo(String scopeId)
                                                 throws ApiException

Get a Shared Scope by Scope Id This operation can be used to retrieve details of a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

Returns:

ApiResponse<ScopeDTO>

Throws:

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

getSharedScopeAsync

public com.squareup.okhttp.Call getSharedScopeAsync(String scopeId,
                                                    ApiCallback<ScopeDTO> callback)
                                             throws ApiException

Get a Shared Scope by Scope Id (asynchronously) This operation can be used to retrieve details of a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (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

getSharedScopeUsagesCall

public com.squareup.okhttp.Call getSharedScopeUsagesCall(String scopeId,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for getSharedScopeUsages

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSharedScopeUsages

public SharedScopeUsageDTO getSharedScopeUsages(String scopeId)
                                         throws ApiException

Get usages of a Shared Scope by Scope Id This operation can be used to retrieve usages of a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

Returns:

SharedScopeUsageDTO

Throws:

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

getSharedScopeUsagesWithHttpInfo

public ApiResponse<SharedScopeUsageDTO> getSharedScopeUsagesWithHttpInfo(String scopeId)
                                                                  throws ApiException

Get usages of a Shared Scope by Scope Id This operation can be used to retrieve usages of a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

Returns:

ApiResponse<SharedScopeUsageDTO>

Throws:

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

getSharedScopeUsagesAsync

public com.squareup.okhttp.Call getSharedScopeUsagesAsync(String scopeId,
                                                          ApiCallback<SharedScopeUsageDTO> callback)
                                                   throws ApiException

Get usages of a Shared Scope by Scope Id (asynchronously) This operation can be used to retrieve usages of a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (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

getSharedScopesCall

public com.squareup.okhttp.Call getSharedScopesCall(Integer limit,
                                                    Integer offset,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getSharedScopes

Parameters:

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)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSharedScopes

public ScopeListDTO getSharedScopes(Integer limit,
                                    Integer offset)
                             throws ApiException

Get all available Shared Scopes This operation can be used to get all the available Shared Scopes.

Parameters:

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:

ScopeListDTO

Throws:

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

getSharedScopesWithHttpInfo

public ApiResponse<ScopeListDTO> getSharedScopesWithHttpInfo(Integer limit,
                                                             Integer offset)
                                                      throws ApiException

Get all available Shared Scopes This operation can be used to get all the available Shared Scopes.

Parameters:

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<ScopeListDTO>

Throws:

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

getSharedScopesAsync

public com.squareup.okhttp.Call getSharedScopesAsync(Integer limit,
                                                     Integer offset,
                                                     ApiCallback<ScopeListDTO> callback)
                                              throws ApiException

Get all available Shared Scopes (asynchronously) This operation can be used to get all the available Shared Scopes.

Parameters:

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

updateSharedScopeCall

public com.squareup.okhttp.Call updateSharedScopeCall(String scopeId,
                                                      ScopeDTO body,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for updateSharedScope

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

body - Scope object that needs to be updated (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateSharedScope

public ScopeDTO updateSharedScope(String scopeId,
                                  ScopeDTO body)
                           throws ApiException

Update a Shared Scope This operation can be used to update a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

body - Scope object that needs to be updated (required)

Returns:

ScopeDTO

Throws:

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

updateSharedScopeWithHttpInfo

public ApiResponse<ScopeDTO> updateSharedScopeWithHttpInfo(String scopeId,
                                                           ScopeDTO body)
                                                    throws ApiException

Update a Shared Scope This operation can be used to update a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

body - Scope object that needs to be updated (required)

Returns:

ApiResponse<ScopeDTO>

Throws:

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

updateSharedScopeAsync

public com.squareup.okhttp.Call updateSharedScopeAsync(String scopeId,
                                                       ScopeDTO body,
                                                       ApiCallback<ScopeDTO> callback)
                                                throws ApiException

Update a Shared Scope (asynchronously) This operation can be used to update a Shared Scope by a given scope Id.

Parameters:

scopeId - Scope Id consisting the UUID of the shared scope (required)

body - Scope object that needs to be updated (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

validateScopeCall

public com.squareup.okhttp.Call validateScopeCall(String scopeId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for validateScope

Parameters:

scopeId - Scope name (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

validateScope

public void validateScope(String scopeId)
                   throws ApiException

Check given scope name is already exist Using this operation, user can check a given scope name exists or not.

Parameters:

scopeId - Scope name (required)

Throws:

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

validateScopeWithHttpInfo

public ApiResponse<Void> validateScopeWithHttpInfo(String scopeId)
                                            throws ApiException

Check given scope name is already exist Using this operation, user can check a given scope name exists or not.

Parameters:

scopeId - Scope name (required)

Returns:

ApiResponse<Void>

Throws:

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

validateScopeAsync

public com.squareup.okhttp.Call validateScopeAsync(String scopeId,
                                                   ApiCallback<Void> callback)
                                            throws ApiException

Check given scope name is already exist (asynchronously) Using this operation, user can check a given scope name exists or not.

Parameters:

scopeId - Scope name (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