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

Class SettingsApi

java.lang.Object

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

public class SettingsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SettingsApi()
SettingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
EnvironmentListDTO	settingsGatewayEnvironmentsGet(String apiId) Get all gateway environments This operation can be used to retrieve the list of gateway environments available.
com.squareup.okhttp.Call	settingsGatewayEnvironmentsGetAsync(String apiId, ApiCallback<EnvironmentListDTO> callback) Get all gateway environments (asynchronously) This operation can be used to retrieve the list of gateway environments available.
com.squareup.okhttp.Call	settingsGatewayEnvironmentsGetCall(String apiId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for settingsGatewayEnvironmentsGet
ApiResponse<EnvironmentListDTO>	settingsGatewayEnvironmentsGetWithHttpInfo(String apiId) Get all gateway environments This operation can be used to retrieve the list of gateway environments available.
SettingsDTO	settingsGet() Retreive publisher settings Retreive publisher settings
com.squareup.okhttp.Call	settingsGetAsync(ApiCallback<SettingsDTO> callback) Retreive publisher settings (asynchronously) Retreive publisher settings
com.squareup.okhttp.Call	settingsGetCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for settingsGet
ApiResponse<SettingsDTO>	settingsGetWithHttpInfo() Retreive publisher settings Retreive publisher settings

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsApi

public SettingsApi()

SettingsApi

public SettingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

settingsGatewayEnvironmentsGetCall

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

Build call for settingsGatewayEnvironmentsGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

settingsGatewayEnvironmentsGet

public EnvironmentListDTO settingsGatewayEnvironmentsGet(String apiId)
                                                  throws ApiException

Get all gateway environments This operation can be used to retrieve the list of gateway environments available.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

Returns:

EnvironmentListDTO

Throws:

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

settingsGatewayEnvironmentsGetWithHttpInfo

public ApiResponse<EnvironmentListDTO> settingsGatewayEnvironmentsGetWithHttpInfo(String apiId)
                                                                           throws ApiException

Get all gateway environments This operation can be used to retrieve the list of gateway environments available.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

Returns:

ApiResponse<EnvironmentListDTO>

Throws:

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

settingsGatewayEnvironmentsGetAsync

public com.squareup.okhttp.Call settingsGatewayEnvironmentsGetAsync(String apiId,
                                                                    ApiCallback<EnvironmentListDTO> callback)
                                                             throws ApiException

Get all gateway environments (asynchronously) This operation can be used to retrieve the list of gateway environments available.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (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

settingsGetCall

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

Build call for settingsGet

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

settingsGet

public SettingsDTO settingsGet()
                        throws ApiException

Retreive publisher settings Retreive publisher settings

Returns:

SettingsDTO

Throws:

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

settingsGetWithHttpInfo

public ApiResponse<SettingsDTO> settingsGetWithHttpInfo()
                                                 throws ApiException

Retreive publisher settings Retreive publisher settings

Returns:

ApiResponse<SettingsDTO>

Throws:

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

settingsGetAsync

public com.squareup.okhttp.Call settingsGetAsync(ApiCallback<SettingsDTO> callback)
                                          throws ApiException

Retreive publisher settings (asynchronously) Retreive publisher settings

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