org.wso2.am.integration.clients.admin.api

Class AlertSubscriptionsApi

java.lang.Object

org.wso2.am.integration.clients.admin.api.AlertSubscriptionsApi

public class AlertSubscriptionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AlertSubscriptionsApi()
AlertSubscriptionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
AlertsSubscriptionDTO	getSubscribedAlertTypes() Get the list of API Admin alert types subscribed by the user.
com.squareup.okhttp.Call	getSubscribedAlertTypesAsync(ApiCallback<AlertsSubscriptionDTO> callback) Get the list of API Admin alert types subscribed by the user.
com.squareup.okhttp.Call	getSubscribedAlertTypesCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSubscribedAlertTypes
ApiResponse<AlertsSubscriptionDTO>	getSubscribedAlertTypesWithHttpInfo() Get the list of API Admin alert types subscribed by the user.
void	setApiClient(ApiClient apiClient)
AlertsSubscriptionDTO	subscribeToAlerts(AlertsSubscriptionDTO body) Subscribe to an admin alert.
com.squareup.okhttp.Call	subscribeToAlertsAsync(AlertsSubscriptionDTO body, ApiCallback<AlertsSubscriptionDTO> callback) Subscribe to an admin alert.
com.squareup.okhttp.Call	subscribeToAlertsCall(AlertsSubscriptionDTO body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subscribeToAlerts
ApiResponse<AlertsSubscriptionDTO>	subscribeToAlertsWithHttpInfo(AlertsSubscriptionDTO body) Subscribe to an admin alert.
void	unsubscribeAllAlerts() Unsubscribe user from all the admin alert types.
com.squareup.okhttp.Call	unsubscribeAllAlertsAsync(ApiCallback<Void> callback) Unsubscribe user from all the admin alert types.
com.squareup.okhttp.Call	unsubscribeAllAlertsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for unsubscribeAllAlerts
ApiResponse<Void>	unsubscribeAllAlertsWithHttpInfo() Unsubscribe user from all the admin alert types.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertSubscriptionsApi

public AlertSubscriptionsApi()

AlertSubscriptionsApi

public AlertSubscriptionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSubscribedAlertTypesCall

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

Build call for getSubscribedAlertTypes

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSubscribedAlertTypes

public AlertsSubscriptionDTO getSubscribedAlertTypes()
                                              throws ApiException

Get the list of API Admin alert types subscribed by the user. This operation is used to get the list of subscribed alert types by the user.

Returns:

AlertsSubscriptionDTO

Throws:

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

getSubscribedAlertTypesWithHttpInfo

public ApiResponse<AlertsSubscriptionDTO> getSubscribedAlertTypesWithHttpInfo()
                                                                       throws ApiException

Get the list of API Admin alert types subscribed by the user. This operation is used to get the list of subscribed alert types by the user.

Returns:

ApiResponse<AlertsSubscriptionDTO>

Throws:

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

getSubscribedAlertTypesAsync

public com.squareup.okhttp.Call getSubscribedAlertTypesAsync(ApiCallback<AlertsSubscriptionDTO> callback)
                                                      throws ApiException

Get the list of API Admin alert types subscribed by the user. (asynchronously) This operation is used to get the list of subscribed alert types by the user.

Parameters:

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

subscribeToAlertsCall

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

Build call for subscribeToAlerts

Parameters:

body - The alerts list and the email list to subscribe. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subscribeToAlerts

public AlertsSubscriptionDTO subscribeToAlerts(AlertsSubscriptionDTO body)
                                        throws ApiException

Subscribe to an admin alert. This operation is used to subscribe to admin alerts

Parameters:

body - The alerts list and the email list to subscribe. (required)

Returns:

AlertsSubscriptionDTO

Throws:

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

subscribeToAlertsWithHttpInfo

public ApiResponse<AlertsSubscriptionDTO> subscribeToAlertsWithHttpInfo(AlertsSubscriptionDTO body)
                                                                 throws ApiException

Subscribe to an admin alert. This operation is used to subscribe to admin alerts

Parameters:

body - The alerts list and the email list to subscribe. (required)

Returns:

ApiResponse<AlertsSubscriptionDTO>

Throws:

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

subscribeToAlertsAsync

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

Subscribe to an admin alert. (asynchronously) This operation is used to subscribe to admin alerts

Parameters:

body - The alerts list and the email list to subscribe. (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

unsubscribeAllAlertsCall

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

Build call for unsubscribeAllAlerts

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

unsubscribeAllAlerts

public void unsubscribeAllAlerts()
                          throws ApiException

Unsubscribe user from all the admin alert types. This operation is used to unsubscribe the respective user from all the admin alert types.

Throws:

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

unsubscribeAllAlertsWithHttpInfo

public ApiResponse<Void> unsubscribeAllAlertsWithHttpInfo()
                                                   throws ApiException

Unsubscribe user from all the admin alert types. This operation is used to unsubscribe the respective user from all the admin alert types.

Returns:

ApiResponse<Void>

Throws:

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

unsubscribeAllAlertsAsync

public com.squareup.okhttp.Call unsubscribeAllAlertsAsync(ApiCallback<Void> callback)
                                                   throws ApiException

Unsubscribe user from all the admin alert types. (asynchronously) This operation is used to unsubscribe the respective user from all the admin alert types.

Parameters:

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