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

Class ExternalStoresApi

java.lang.Object

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

public class ExternalStoresApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ExternalStoresApi()
ExternalStoresApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ExternalStoreDTO	getAllExternalStores() Retrieve external store list to publish an API Retrieve external stores list configured to publish an API
com.squareup.okhttp.Call	getAllExternalStoresAsync(ApiCallback<ExternalStoreDTO> callback) Retrieve external store list to publish an API (asynchronously) Retrieve external stores list configured to publish an API
com.squareup.okhttp.Call	getAllExternalStoresCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllExternalStores
ApiResponse<ExternalStoreDTO>	getAllExternalStoresWithHttpInfo() Retrieve external store list to publish an API Retrieve external stores list configured to publish an API
APIExternalStoreListDTO	getAllPublishedExternalStoresByAPI(String apiId, String ifNoneMatch) Get the list of external stores which an API is published to This operation can be used to retrieve a list of external stores which an API is published to by providing the id of the API.
com.squareup.okhttp.Call	getAllPublishedExternalStoresByAPIAsync(String apiId, String ifNoneMatch, ApiCallback<APIExternalStoreListDTO> callback) Get the list of external stores which an API is published to (asynchronously) This operation can be used to retrieve a list of external stores which an API is published to by providing the id of the API.
com.squareup.okhttp.Call	getAllPublishedExternalStoresByAPICall(String apiId, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllPublishedExternalStoresByAPI
ApiResponse<APIExternalStoreListDTO>	getAllPublishedExternalStoresByAPIWithHttpInfo(String apiId, String ifNoneMatch) Get the list of external stores which an API is published to This operation can be used to retrieve a list of external stores which an API is published to by providing the id of the API.
ApiClient	getApiClient()
APIExternalStoreListDTO	publishAPIToExternalStores(String apiId, String externalStoreIds, String ifMatch) Publish an API to external stores This operation can be used to publish an API to a list of external stores.
com.squareup.okhttp.Call	publishAPIToExternalStoresAsync(String apiId, String externalStoreIds, String ifMatch, ApiCallback<APIExternalStoreListDTO> callback) Publish an API to external stores (asynchronously) This operation can be used to publish an API to a list of external stores.
com.squareup.okhttp.Call	publishAPIToExternalStoresCall(String apiId, String externalStoreIds, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for publishAPIToExternalStores
ApiResponse<APIExternalStoreListDTO>	publishAPIToExternalStoresWithHttpInfo(String apiId, String externalStoreIds, String ifMatch) Publish an API to external stores This operation can be used to publish an API to a list of external stores.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalStoresApi

public ExternalStoresApi()

ExternalStoresApi

public ExternalStoresApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAllExternalStoresCall

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

Build call for getAllExternalStores

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllExternalStores

public ExternalStoreDTO getAllExternalStores()
                                      throws ApiException

Retrieve external store list to publish an API Retrieve external stores list configured to publish an API

Returns:

ExternalStoreDTO

Throws:

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

getAllExternalStoresWithHttpInfo

public ApiResponse<ExternalStoreDTO> getAllExternalStoresWithHttpInfo()
                                                               throws ApiException

Retrieve external store list to publish an API Retrieve external stores list configured to publish an API

Returns:

ApiResponse<ExternalStoreDTO>

Throws:

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

getAllExternalStoresAsync

public com.squareup.okhttp.Call getAllExternalStoresAsync(ApiCallback<ExternalStoreDTO> callback)
                                                   throws ApiException

Retrieve external store list to publish an API (asynchronously) Retrieve external stores list configured to publish an API

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

getAllPublishedExternalStoresByAPICall

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

Build call for getAllPublishedExternalStoresByAPI

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

getAllPublishedExternalStoresByAPI

public APIExternalStoreListDTO getAllPublishedExternalStoresByAPI(String apiId,
                                                                  String ifNoneMatch)
                                                           throws ApiException

Get the list of external stores which an API is published to This operation can be used to retrieve a list of external stores which an API is published to 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:

APIExternalStoreListDTO

Throws:

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

getAllPublishedExternalStoresByAPIWithHttpInfo

public ApiResponse<APIExternalStoreListDTO> getAllPublishedExternalStoresByAPIWithHttpInfo(String apiId,
                                                                                           String ifNoneMatch)
                                                                                    throws ApiException

Get the list of external stores which an API is published to This operation can be used to retrieve a list of external stores which an API is published to 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<APIExternalStoreListDTO>

Throws:

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

getAllPublishedExternalStoresByAPIAsync

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

Get the list of external stores which an API is published to (asynchronously) This operation can be used to retrieve a list of external stores which an API is published to 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

publishAPIToExternalStoresCall

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

Build call for publishAPIToExternalStores

Parameters:

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

externalStoreIds - External Store Ids of stores which the API needs to be published or 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

publishAPIToExternalStores

public APIExternalStoreListDTO publishAPIToExternalStores(String apiId,
                                                          String externalStoreIds,
                                                          String ifMatch)
                                                   throws ApiException

Publish an API to external stores This operation can be used to publish an API to a list of external stores.

Parameters:

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

externalStoreIds - External Store Ids of stores which the API needs to be published or updated. (required)

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

Returns:

APIExternalStoreListDTO

Throws:

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

publishAPIToExternalStoresWithHttpInfo

public ApiResponse<APIExternalStoreListDTO> publishAPIToExternalStoresWithHttpInfo(String apiId,
                                                                                   String externalStoreIds,
                                                                                   String ifMatch)
                                                                            throws ApiException

Publish an API to external stores This operation can be used to publish an API to a list of external stores.

Parameters:

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

externalStoreIds - External Store Ids of stores which the API needs to be published or updated. (required)

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

Returns:

ApiResponse<APIExternalStoreListDTO>

Throws:

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

publishAPIToExternalStoresAsync

public com.squareup.okhttp.Call publishAPIToExternalStoresAsync(String apiId,
                                                                String externalStoreIds,
                                                                String ifMatch,
                                                                ApiCallback<APIExternalStoreListDTO> callback)
                                                         throws ApiException

Publish an API to external stores (asynchronously) This operation can be used to publish an API to a list of external stores.

Parameters:

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

externalStoreIds - External Store Ids of stores which the API needs to be published or 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