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

Class WebhooksApi

java.lang.Object

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

public class WebhooksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WebhooksApi()
WebhooksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
WebhookSubscriptionListDTO	getAllWebhooksOfAPI(String applicationId, String apiId, String xWSO2Tenant) Get available web hook subscriptions for a given application.
okhttp3.Call	getAllWebhooksOfAPIAsync(String applicationId, String apiId, String xWSO2Tenant, ApiCallback<WebhookSubscriptionListDTO> _callback) Get available web hook subscriptions for a given application.
okhttp3.Call	getAllWebhooksOfAPICall(String applicationId, String apiId, String xWSO2Tenant, ApiCallback _callback) Build call for getAllWebhooksOfAPI
ApiResponse<WebhookSubscriptionListDTO>	getAllWebhooksOfAPIWithHttpInfo(String applicationId, String apiId, String xWSO2Tenant) Get available web hook subscriptions for a given application.
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

WebhooksApi

public WebhooksApi()

WebhooksApi

public WebhooksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAllWebhooksOfAPICall

public okhttp3.Call getAllWebhooksOfAPICall(String applicationId,
                                            String apiId,
                                            String xWSO2Tenant,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getAllWebhooksOfAPI

Parameters:

applicationId - **Application Identifier** consisting of the UUID of the Application. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllWebhooksOfAPI

public WebhookSubscriptionListDTO getAllWebhooksOfAPI(String applicationId,
                                                      String apiId,
                                                      String xWSO2Tenant)
                                               throws ApiException

Get available web hook subscriptions for a given application. This operation will provide a list of web hook topic subscriptions for a given application. If the api id is provided results will be filtered by the api Id.

Parameters:

applicationId - **Application Identifier** consisting of the UUID of the Application. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

Returns:

WebhookSubscriptionListDTO

Throws:

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

getAllWebhooksOfAPIWithHttpInfo

public ApiResponse<WebhookSubscriptionListDTO> getAllWebhooksOfAPIWithHttpInfo(String applicationId,
                                                                               String apiId,
                                                                               String xWSO2Tenant)
                                                                        throws ApiException

Get available web hook subscriptions for a given application. This operation will provide a list of web hook topic subscriptions for a given application. If the api id is provided results will be filtered by the api Id.

Parameters:

applicationId - **Application Identifier** consisting of the UUID of the Application. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

Returns:

ApiResponse<WebhookSubscriptionListDTO>

Throws:

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

getAllWebhooksOfAPIAsync

public okhttp3.Call getAllWebhooksOfAPIAsync(String applicationId,
                                             String apiId,
                                             String xWSO2Tenant,
                                             ApiCallback<WebhookSubscriptionListDTO> _callback)
                                      throws ApiException

Get available web hook subscriptions for a given application. (asynchronously) This operation will provide a list of web hook topic subscriptions for a given application. If the api id is provided results will be filtered by the api Id.

Parameters:

applicationId - **Application Identifier** consisting of the UUID of the Application. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (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