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

Class ApplicationsApi

java.lang.Object

org.wso2.am.integration.clients.store.api.v1.ApplicationsApi

public class ApplicationsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApplicationsApi()
ApplicationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	applicationsApplicationIdDelete(String applicationId, String ifMatch) Remove an application This operation can be used to remove an application specifying its id.
com.squareup.okhttp.Call	applicationsApplicationIdDeleteAsync(String applicationId, String ifMatch, ApiCallback<Void> callback) Remove an application (asynchronously) This operation can be used to remove an application specifying its id.
com.squareup.okhttp.Call	applicationsApplicationIdDeleteCall(String applicationId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for applicationsApplicationIdDelete
ApiResponse<Void>	applicationsApplicationIdDeleteWithHttpInfo(String applicationId, String ifMatch) Remove an application This operation can be used to remove an application specifying its id.
ApplicationDTO	applicationsApplicationIdGet(String applicationId, String ifNoneMatch) Get details of an application This operation can be used to retrieve details of an individual application specifying the application id in the URI.
com.squareup.okhttp.Call	applicationsApplicationIdGetAsync(String applicationId, String ifNoneMatch, ApiCallback<ApplicationDTO> callback) Get details of an application (asynchronously) This operation can be used to retrieve details of an individual application specifying the application id in the URI.
com.squareup.okhttp.Call	applicationsApplicationIdGetCall(String applicationId, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for applicationsApplicationIdGet
ApiResponse<ApplicationDTO>	applicationsApplicationIdGetWithHttpInfo(String applicationId, String ifNoneMatch) Get details of an application This operation can be used to retrieve details of an individual application specifying the application id in the URI.
ApplicationDTO	applicationsApplicationIdPut(String applicationId, ApplicationDTO body, String ifMatch) Update an application This operation can be used to update an application.
com.squareup.okhttp.Call	applicationsApplicationIdPutAsync(String applicationId, ApplicationDTO body, String ifMatch, ApiCallback<ApplicationDTO> callback) Update an application (asynchronously) This operation can be used to update an application.
com.squareup.okhttp.Call	applicationsApplicationIdPutCall(String applicationId, ApplicationDTO body, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for applicationsApplicationIdPut
ApiResponse<ApplicationDTO>	applicationsApplicationIdPutWithHttpInfo(String applicationId, ApplicationDTO body, String ifMatch) Update an application This operation can be used to update an application.
ApplicationListDTO	applicationsGet(String groupId, String query, String sortBy, String sortOrder, Integer limit, Integer offset, String ifNoneMatch) Retrieve/Search applications This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.
com.squareup.okhttp.Call	applicationsGetAsync(String groupId, String query, String sortBy, String sortOrder, Integer limit, Integer offset, String ifNoneMatch, ApiCallback<ApplicationListDTO> callback) Retrieve/Search applications (asynchronously) This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.
com.squareup.okhttp.Call	applicationsGetCall(String groupId, String query, String sortBy, String sortOrder, Integer limit, Integer offset, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for applicationsGet
ApiResponse<ApplicationListDTO>	applicationsGetWithHttpInfo(String groupId, String query, String sortBy, String sortOrder, Integer limit, Integer offset, String ifNoneMatch) Retrieve/Search applications This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.
ApplicationDTO	applicationsPost(ApplicationDTO body) Create a new application This operation can be used to create a new application specifying the details of the application in the payload.
com.squareup.okhttp.Call	applicationsPostAsync(ApplicationDTO body, ApiCallback<ApplicationDTO> callback) Create a new application (asynchronously) This operation can be used to create a new application specifying the details of the application in the payload.
com.squareup.okhttp.Call	applicationsPostCall(ApplicationDTO body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for applicationsPost
ApiResponse<ApplicationDTO>	applicationsPostWithHttpInfo(ApplicationDTO body) Create a new application This operation can be used to create a new application specifying the details of the application in the payload.
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

ApplicationsApi

public ApplicationsApi()

ApplicationsApi

public ApplicationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

applicationsApplicationIdDeleteCall

public com.squareup.okhttp.Call applicationsApplicationIdDeleteCall(String applicationId,
                                                                    String ifMatch,
                                                                    ProgressResponseBody.ProgressListener progressListener,
                                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                             throws ApiException

Build call for applicationsApplicationIdDelete

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (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

applicationsApplicationIdDelete

public void applicationsApplicationIdDelete(String applicationId,
                                            String ifMatch)
                                     throws ApiException

Remove an application This operation can be used to remove an application specifying its id.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (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

applicationsApplicationIdDeleteWithHttpInfo

public ApiResponse<Void> applicationsApplicationIdDeleteWithHttpInfo(String applicationId,
                                                                     String ifMatch)
                                                              throws ApiException

Remove an application This operation can be used to remove an application specifying its id.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (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

applicationsApplicationIdDeleteAsync

public com.squareup.okhttp.Call applicationsApplicationIdDeleteAsync(String applicationId,
                                                                     String ifMatch,
                                                                     ApiCallback<Void> callback)
                                                              throws ApiException

Remove an application (asynchronously) This operation can be used to remove an application specifying its id.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (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

applicationsApplicationIdGetCall

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

Build call for applicationsApplicationIdGet

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (required)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

applicationsApplicationIdGet

public ApplicationDTO applicationsApplicationIdGet(String applicationId,
                                                   String ifNoneMatch)
                                            throws ApiException

Get details of an application This operation can be used to retrieve details of an individual application specifying the application id in the URI.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (required)

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

Returns:

ApplicationDTO

Throws:

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

applicationsApplicationIdGetWithHttpInfo

public ApiResponse<ApplicationDTO> applicationsApplicationIdGetWithHttpInfo(String applicationId,
                                                                            String ifNoneMatch)
                                                                     throws ApiException

Get details of an application This operation can be used to retrieve details of an individual application specifying the application id in the URI.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (required)

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

Returns:

ApiResponse<ApplicationDTO>

Throws:

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

applicationsApplicationIdGetAsync

public com.squareup.okhttp.Call applicationsApplicationIdGetAsync(String applicationId,
                                                                  String ifNoneMatch,
                                                                  ApiCallback<ApplicationDTO> callback)
                                                           throws ApiException

Get details of an application (asynchronously) This operation can be used to retrieve details of an individual application specifying the application id in the URI.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (required)

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

applicationsApplicationIdPutCall

public com.squareup.okhttp.Call applicationsApplicationIdPutCall(String applicationId,
                                                                 ApplicationDTO body,
                                                                 String ifMatch,
                                                                 ProgressResponseBody.ProgressListener progressListener,
                                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                          throws ApiException

Build call for applicationsApplicationIdPut

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (required)

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

applicationsApplicationIdPut

public ApplicationDTO applicationsApplicationIdPut(String applicationId,
                                                   ApplicationDTO body,
                                                   String ifMatch)
                                            throws ApiException

Update an application This operation can be used to update an application. Upon succesfull you will retrieve the updated application as the response.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (required)

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

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

Returns:

ApplicationDTO

Throws:

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

applicationsApplicationIdPutWithHttpInfo

public ApiResponse<ApplicationDTO> applicationsApplicationIdPutWithHttpInfo(String applicationId,
                                                                            ApplicationDTO body,
                                                                            String ifMatch)
                                                                     throws ApiException

Update an application This operation can be used to update an application. Upon succesfull you will retrieve the updated application as the response.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (required)

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

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

Returns:

ApiResponse<ApplicationDTO>

Throws:

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

applicationsApplicationIdPutAsync

public com.squareup.okhttp.Call applicationsApplicationIdPutAsync(String applicationId,
                                                                  ApplicationDTO body,
                                                                  String ifMatch,
                                                                  ApiCallback<ApplicationDTO> callback)
                                                           throws ApiException

Update an application (asynchronously) This operation can be used to update an application. Upon succesfull you will retrieve the updated application as the response.

Parameters:

applicationId - Application Identifier consisting of the UUID of the Application. (required)

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

applicationsGetCall

public com.squareup.okhttp.Call applicationsGetCall(String groupId,
                                                    String query,
                                                    String sortBy,
                                                    String sortOrder,
                                                    Integer limit,
                                                    Integer offset,
                                                    String ifNoneMatch,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for applicationsGet

Parameters:

groupId - Application Group Id (optional)

query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)

sortBy - (optional)

sortOrder - (optional)

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)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

applicationsGet

public ApplicationListDTO applicationsGet(String groupId,
                                          String query,
                                          String sortBy,
                                          String sortOrder,
                                          Integer limit,
                                          Integer offset,
                                          String ifNoneMatch)
                                   throws ApiException

Retrieve/Search applications This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.

Parameters:

groupId - Application Group Id (optional)

query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)

sortBy - (optional)

sortOrder - (optional)

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)

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

Returns:

ApplicationListDTO

Throws:

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

applicationsGetWithHttpInfo

public ApiResponse<ApplicationListDTO> applicationsGetWithHttpInfo(String groupId,
                                                                   String query,
                                                                   String sortBy,
                                                                   String sortOrder,
                                                                   Integer limit,
                                                                   Integer offset,
                                                                   String ifNoneMatch)
                                                            throws ApiException

Retrieve/Search applications This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.

Parameters:

groupId - Application Group Id (optional)

query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)

sortBy - (optional)

sortOrder - (optional)

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)

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

Returns:

ApiResponse<ApplicationListDTO>

Throws:

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

applicationsGetAsync

public com.squareup.okhttp.Call applicationsGetAsync(String groupId,
                                                     String query,
                                                     String sortBy,
                                                     String sortOrder,
                                                     Integer limit,
                                                     Integer offset,
                                                     String ifNoneMatch,
                                                     ApiCallback<ApplicationListDTO> callback)
                                              throws ApiException

Retrieve/Search applications (asynchronously) This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.

Parameters:

groupId - Application Group Id (optional)

query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)

sortBy - (optional)

sortOrder - (optional)

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)

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

applicationsPostCall

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

Build call for applicationsPost

Parameters:

body - Application object that is to be created. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

applicationsPost

public ApplicationDTO applicationsPost(ApplicationDTO body)
                                throws ApiException

Create a new application This operation can be used to create a new application specifying the details of the application in the payload.

Parameters:

body - Application object that is to be created. (required)

Returns:

ApplicationDTO

Throws:

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

applicationsPostWithHttpInfo

public ApiResponse<ApplicationDTO> applicationsPostWithHttpInfo(ApplicationDTO body)
                                                         throws ApiException

Create a new application This operation can be used to create a new application specifying the details of the application in the payload.

Parameters:

body - Application object that is to be created. (required)

Returns:

ApiResponse<ApplicationDTO>

Throws:

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

applicationsPostAsync

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

Create a new application (asynchronously) This operation can be used to create a new application specifying the details of the application in the payload.

Parameters:

body - Application object that is to be created. (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