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

Class ApiScopesApi

java.lang.Object

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

public class ApiScopesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiScopesApi()
ApiScopesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ScopeListDTO	apisApiIdScopesGet(String apiId, String ifNoneMatch) Get a list of scopes of an API This operation can be used to retrieve a list of scopes belonging to an API by providing the id of the API.
com.squareup.okhttp.Call	apisApiIdScopesGetAsync(String apiId, String ifNoneMatch, ApiCallback<ScopeListDTO> callback) Get a list of scopes of an API (asynchronously) This operation can be used to retrieve a list of scopes belonging to an API by providing the id of the API.
com.squareup.okhttp.Call	apisApiIdScopesGetCall(String apiId, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdScopesGet
ApiResponse<ScopeListDTO>	apisApiIdScopesGetWithHttpInfo(String apiId, String ifNoneMatch) Get a list of scopes of an API This operation can be used to retrieve a list of scopes belonging to an API by providing the id of the API.
void	apisApiIdScopesNameDelete(String apiId, String name, String ifMatch) Delete a scope of an API This operation can be used to delete a scope associated with an API.
com.squareup.okhttp.Call	apisApiIdScopesNameDeleteAsync(String apiId, String name, String ifMatch, ApiCallback<Void> callback) Delete a scope of an API (asynchronously) This operation can be used to delete a scope associated with an API.
com.squareup.okhttp.Call	apisApiIdScopesNameDeleteCall(String apiId, String name, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdScopesNameDelete
ApiResponse<Void>	apisApiIdScopesNameDeleteWithHttpInfo(String apiId, String name, String ifMatch) Delete a scope of an API This operation can be used to delete a scope associated with an API.
ScopeDTO	apisApiIdScopesNameGet(String apiId, String name, String ifNoneMatch) Get a scope of an API This operation can be used to retrieve a particular scope's metadata associated with an API.
com.squareup.okhttp.Call	apisApiIdScopesNameGetAsync(String apiId, String name, String ifNoneMatch, ApiCallback<ScopeDTO> callback) Get a scope of an API (asynchronously) This operation can be used to retrieve a particular scope's metadata associated with an API.
com.squareup.okhttp.Call	apisApiIdScopesNameGetCall(String apiId, String name, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdScopesNameGet
ApiResponse<ScopeDTO>	apisApiIdScopesNameGetWithHttpInfo(String apiId, String name, String ifNoneMatch) Get a scope of an API This operation can be used to retrieve a particular scope's metadata associated with an API.
ScopeDTO	apisApiIdScopesNamePut(String apiId, String name, ScopeDTO body, String ifMatch) Update a Scope of an API This operation can be used to update scope of an API
com.squareup.okhttp.Call	apisApiIdScopesNamePutAsync(String apiId, String name, ScopeDTO body, String ifMatch, ApiCallback<ScopeDTO> callback) Update a Scope of an API (asynchronously) This operation can be used to update scope of an API
com.squareup.okhttp.Call	apisApiIdScopesNamePutCall(String apiId, String name, ScopeDTO body, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdScopesNamePut
ApiResponse<ScopeDTO>	apisApiIdScopesNamePutWithHttpInfo(String apiId, String name, ScopeDTO body, String ifMatch) Update a Scope of an API This operation can be used to update scope of an API
ScopeDTO	apisApiIdScopesPost(String apiId, ScopeDTO body, String ifMatch) Add a new scope to an API This operation can be used to add a new scope to an API.
com.squareup.okhttp.Call	apisApiIdScopesPostAsync(String apiId, ScopeDTO body, String ifMatch, ApiCallback<ScopeDTO> callback) Add a new scope to an API (asynchronously) This operation can be used to add a new scope to an API.
com.squareup.okhttp.Call	apisApiIdScopesPostCall(String apiId, ScopeDTO body, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdScopesPost
ApiResponse<ScopeDTO>	apisApiIdScopesPostWithHttpInfo(String apiId, ScopeDTO body, String ifMatch) Add a new scope to an API This operation can be used to add a new scope to an API.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiScopesApi

public ApiScopesApi()

ApiScopesApi

public ApiScopesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdScopesGetCall

public com.squareup.okhttp.Call apisApiIdScopesGetCall(String apiId,
                                                       String ifNoneMatch,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for apisApiIdScopesGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdScopesGet

public ScopeListDTO apisApiIdScopesGet(String apiId,
                                       String ifNoneMatch)
                                throws ApiException

Get a list of scopes of an API This operation can be used to retrieve a list of scopes belonging to an API by providing the id of the API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ScopeListDTO

Throws:

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

apisApiIdScopesGetWithHttpInfo

public ApiResponse<ScopeListDTO> apisApiIdScopesGetWithHttpInfo(String apiId,
                                                                String ifNoneMatch)
                                                         throws ApiException

Get a list of scopes of an API This operation can be used to retrieve a list of scopes belonging to an API by providing the id of the API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<ScopeListDTO>

Throws:

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

apisApiIdScopesGetAsync

public com.squareup.okhttp.Call apisApiIdScopesGetAsync(String apiId,
                                                        String ifNoneMatch,
                                                        ApiCallback<ScopeListDTO> callback)
                                                 throws ApiException

Get a list of scopes of an API (asynchronously) This operation can be used to retrieve a list of scopes belonging to an API by providing the id of the API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

apisApiIdScopesNameDeleteCall

public com.squareup.okhttp.Call apisApiIdScopesNameDeleteCall(String apiId,
                                                              String name,
                                                              String ifMatch,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for apisApiIdScopesNameDelete

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdScopesNameDelete

public void apisApiIdScopesNameDelete(String apiId,
                                      String name,
                                      String ifMatch)
                               throws ApiException

Delete a scope of an API This operation can be used to delete a scope associated with an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Throws:

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

apisApiIdScopesNameDeleteWithHttpInfo

public ApiResponse<Void> apisApiIdScopesNameDeleteWithHttpInfo(String apiId,
                                                               String name,
                                                               String ifMatch)
                                                        throws ApiException

Delete a scope of an API This operation can be used to delete a scope associated with an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisApiIdScopesNameDeleteAsync

public com.squareup.okhttp.Call apisApiIdScopesNameDeleteAsync(String apiId,
                                                               String name,
                                                               String ifMatch,
                                                               ApiCallback<Void> callback)
                                                        throws ApiException

Delete a scope of an API (asynchronously) This operation can be used to delete a scope associated with an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

ifMatch - Validator for conditional requests; based on ETag. (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

apisApiIdScopesNameGetCall

public com.squareup.okhttp.Call apisApiIdScopesNameGetCall(String apiId,
                                                           String name,
                                                           String ifNoneMatch,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for apisApiIdScopesNameGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdScopesNameGet

public ScopeDTO apisApiIdScopesNameGet(String apiId,
                                       String name,
                                       String ifNoneMatch)
                                throws ApiException

Get a scope of an API This operation can be used to retrieve a particular scope's metadata associated with an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ScopeDTO

Throws:

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

apisApiIdScopesNameGetWithHttpInfo

public ApiResponse<ScopeDTO> apisApiIdScopesNameGetWithHttpInfo(String apiId,
                                                                String name,
                                                                String ifNoneMatch)
                                                         throws ApiException

Get a scope of an API This operation can be used to retrieve a particular scope's metadata associated with an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<ScopeDTO>

Throws:

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

apisApiIdScopesNameGetAsync

public com.squareup.okhttp.Call apisApiIdScopesNameGetAsync(String apiId,
                                                            String name,
                                                            String ifNoneMatch,
                                                            ApiCallback<ScopeDTO> callback)
                                                     throws ApiException

Get a scope of an API (asynchronously) This operation can be used to retrieve a particular scope's metadata associated with an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

apisApiIdScopesNamePutCall

public com.squareup.okhttp.Call apisApiIdScopesNamePutCall(String apiId,
                                                           String name,
                                                           ScopeDTO body,
                                                           String ifMatch,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for apisApiIdScopesNamePut

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdScopesNamePut

public ScopeDTO apisApiIdScopesNamePut(String apiId,
                                       String name,
                                       ScopeDTO body,
                                       String ifMatch)
                                throws ApiException

Update a Scope of an API This operation can be used to update scope of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ScopeDTO

Throws:

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

apisApiIdScopesNamePutWithHttpInfo

public ApiResponse<ScopeDTO> apisApiIdScopesNamePutWithHttpInfo(String apiId,
                                                                String name,
                                                                ScopeDTO body,
                                                                String ifMatch)
                                                         throws ApiException

Update a Scope of an API This operation can be used to update scope of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<ScopeDTO>

Throws:

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

apisApiIdScopesNamePutAsync

public com.squareup.okhttp.Call apisApiIdScopesNamePutAsync(String apiId,
                                                            String name,
                                                            ScopeDTO body,
                                                            String ifMatch,
                                                            ApiCallback<ScopeDTO> callback)
                                                     throws ApiException

Update a Scope of an API (asynchronously) This operation can be used to update scope of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

name - Scope name (required)

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

ifMatch - Validator for conditional requests; based on ETag. (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

apisApiIdScopesPostCall

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

Build call for apisApiIdScopesPost

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdScopesPost

public ScopeDTO apisApiIdScopesPost(String apiId,
                                    ScopeDTO body,
                                    String ifMatch)
                             throws ApiException

Add a new scope to an API This operation can be used to add a new scope to an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ScopeDTO

Throws:

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

apisApiIdScopesPostWithHttpInfo

public ApiResponse<ScopeDTO> apisApiIdScopesPostWithHttpInfo(String apiId,
                                                             ScopeDTO body,
                                                             String ifMatch)
                                                      throws ApiException

Add a new scope to an API This operation can be used to add a new scope to an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<ScopeDTO>

Throws:

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

apisApiIdScopesPostAsync

public com.squareup.okhttp.Call apisApiIdScopesPostAsync(String apiId,
                                                         ScopeDTO body,
                                                         String ifMatch,
                                                         ApiCallback<ScopeDTO> callback)
                                                  throws ApiException

Add a new scope to an API (asynchronously) This operation can be used to add a new scope to an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

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

ifMatch - Validator for conditional requests; based on ETag. (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