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

Class ApiEndpointsApi

java.lang.Object

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

public class ApiEndpointsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ApiEndpointsApi()
ApiEndpointsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
APIEndpointDTO	addApiEndpoint(String apiId, APIEndpointDTO apIEndpointDTO)	Add an Endpoint This operation can be used to add an endpoint to an API.
okhttp3.Call	addApiEndpointAsync(String apiId, APIEndpointDTO apIEndpointDTO, ApiCallback<APIEndpointDTO> _callback)	Add an Endpoint (asynchronously) This operation can be used to add an endpoint to an API.
okhttp3.Call	addApiEndpointCall(String apiId, APIEndpointDTO apIEndpointDTO, ApiCallback _callback)	Build call for addApiEndpoint
ApiResponse<APIEndpointDTO>	addApiEndpointWithHttpInfo(String apiId, APIEndpointDTO apIEndpointDTO)	Add an Endpoint This operation can be used to add an endpoint to an API.
void	deleteApiEndpoint(String apiId, String endpointId)	Delete an Endpoint This operation can be used to delete a API endpoint.
okhttp3.Call	deleteApiEndpointAsync(String apiId, String endpointId, ApiCallback<Void> _callback)	Delete an Endpoint (asynchronously) This operation can be used to delete a API endpoint.
okhttp3.Call	deleteApiEndpointCall(String apiId, String endpointId, ApiCallback _callback)	Build call for deleteApiEndpoint
ApiResponse<Void>	deleteApiEndpointWithHttpInfo(String apiId, String endpointId)	Delete an Endpoint This operation can be used to delete a API endpoint.
ApiClient	getApiClient()
APIEndpointDTO	getApiEndpoint(String apiId, String endpointId)	Get an Endpoint This operation can be used to get an endpoint of an API by UUID.
okhttp3.Call	getApiEndpointAsync(String apiId, String endpointId, ApiCallback<APIEndpointDTO> _callback)	Get an Endpoint (asynchronously) This operation can be used to get an endpoint of an API by UUID.
okhttp3.Call	getApiEndpointCall(String apiId, String endpointId, ApiCallback _callback)	Build call for getApiEndpoint
APIEndpointListDTO	getApiEndpoints(String apiId, Integer limit, Integer offset)	Get all API Endpoints This operation can be used to get all the available endpoints of an API.
okhttp3.Call	getApiEndpointsAsync(String apiId, Integer limit, Integer offset, ApiCallback<APIEndpointListDTO> _callback)	Get all API Endpoints (asynchronously) This operation can be used to get all the available endpoints of an API.
okhttp3.Call	getApiEndpointsCall(String apiId, Integer limit, Integer offset, ApiCallback _callback)	Build call for getApiEndpoints
ApiResponse<APIEndpointListDTO>	getApiEndpointsWithHttpInfo(String apiId, Integer limit, Integer offset)	Get all API Endpoints This operation can be used to get all the available endpoints of an API.
ApiResponse<APIEndpointDTO>	getApiEndpointWithHttpInfo(String apiId, String endpointId)	Get an Endpoint This operation can be used to get an endpoint of an API by UUID.
void	setApiClient(ApiClient apiClient)
APIEndpointDTO	updateApiEndpoint(String apiId, String endpointId, APIEndpointDTO apIEndpointDTO)	Update an Endpoint This operation can be used to update a API endpoint.
okhttp3.Call	updateApiEndpointAsync(String apiId, String endpointId, APIEndpointDTO apIEndpointDTO, ApiCallback<APIEndpointDTO> _callback)	Update an Endpoint (asynchronously) This operation can be used to update a API endpoint.
okhttp3.Call	updateApiEndpointCall(String apiId, String endpointId, APIEndpointDTO apIEndpointDTO, ApiCallback _callback)	Build call for updateApiEndpoint
ApiResponse<APIEndpointDTO>	updateApiEndpointWithHttpInfo(String apiId, String endpointId, APIEndpointDTO apIEndpointDTO)	Update an Endpoint This operation can be used to update a API endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiEndpointsApi

public ApiEndpointsApi()

ApiEndpointsApi

public ApiEndpointsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addApiEndpointCall

public okhttp3.Call addApiEndpointCall(String apiId,
                                       APIEndpointDTO apIEndpointDTO,
                                       ApiCallback _callback)
                                throws ApiException

Build call for addApiEndpoint

Parameters:

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

apIEndpointDTO - Endpoint object that needs to be added (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addApiEndpoint

public APIEndpointDTO addApiEndpoint(String apiId,
                                     APIEndpointDTO apIEndpointDTO)
                              throws ApiException

Add an Endpoint This operation can be used to add an endpoint to an API.

Parameters:

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

apIEndpointDTO - Endpoint object that needs to be added (required)

Returns:

APIEndpointDTO

Throws:

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

addApiEndpointWithHttpInfo

public ApiResponse<APIEndpointDTO> addApiEndpointWithHttpInfo(String apiId,
                                                              APIEndpointDTO apIEndpointDTO)
                                                       throws ApiException

Add an Endpoint This operation can be used to add an endpoint to an API.

Parameters:

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

apIEndpointDTO - Endpoint object that needs to be added (required)

Returns:

ApiResponse<APIEndpointDTO>

Throws:

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

addApiEndpointAsync

public okhttp3.Call addApiEndpointAsync(String apiId,
                                        APIEndpointDTO apIEndpointDTO,
                                        ApiCallback<APIEndpointDTO> _callback)
                                 throws ApiException

Add an Endpoint (asynchronously) This operation can be used to add an endpoint to an API.

Parameters:

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

apIEndpointDTO - Endpoint object that needs to be added (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

deleteApiEndpointCall

public okhttp3.Call deleteApiEndpointCall(String apiId,
                                          String endpointId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for deleteApiEndpoint

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteApiEndpoint

public void deleteApiEndpoint(String apiId,
                              String endpointId)
                       throws ApiException

Delete an Endpoint This operation can be used to delete a API endpoint.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

Throws:

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

deleteApiEndpointWithHttpInfo

public ApiResponse<Void> deleteApiEndpointWithHttpInfo(String apiId,
                                                       String endpointId)
                                                throws ApiException

Delete an Endpoint This operation can be used to delete a API endpoint.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteApiEndpointAsync

public okhttp3.Call deleteApiEndpointAsync(String apiId,
                                           String endpointId,
                                           ApiCallback<Void> _callback)
                                    throws ApiException

Delete an Endpoint (asynchronously) This operation can be used to delete a API endpoint.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (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

getApiEndpointCall

public okhttp3.Call getApiEndpointCall(String apiId,
                                       String endpointId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getApiEndpoint

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getApiEndpoint

public APIEndpointDTO getApiEndpoint(String apiId,
                                     String endpointId)
                              throws ApiException

Get an Endpoint This operation can be used to get an endpoint of an API by UUID.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

Returns:

APIEndpointDTO

Throws:

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

getApiEndpointWithHttpInfo

public ApiResponse<APIEndpointDTO> getApiEndpointWithHttpInfo(String apiId,
                                                              String endpointId)
                                                       throws ApiException

Get an Endpoint This operation can be used to get an endpoint of an API by UUID.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

Returns:

ApiResponse<APIEndpointDTO>

Throws:

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

getApiEndpointAsync

public okhttp3.Call getApiEndpointAsync(String apiId,
                                        String endpointId,
                                        ApiCallback<APIEndpointDTO> _callback)
                                 throws ApiException

Get an Endpoint (asynchronously) This operation can be used to get an endpoint of an API by UUID.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (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

getApiEndpointsCall

public okhttp3.Call getApiEndpointsCall(String apiId,
                                        Integer limit,
                                        Integer offset,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getApiEndpoints

Parameters:

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

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)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getApiEndpoints

public APIEndpointListDTO getApiEndpoints(String apiId,
                                          Integer limit,
                                          Integer offset)
                                   throws ApiException

Get all API Endpoints This operation can be used to get all the available endpoints of an API.

Parameters:

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

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)

Returns:

APIEndpointListDTO

Throws:

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

getApiEndpointsWithHttpInfo

public ApiResponse<APIEndpointListDTO> getApiEndpointsWithHttpInfo(String apiId,
                                                                   Integer limit,
                                                                   Integer offset)
                                                            throws ApiException

Get all API Endpoints This operation can be used to get all the available endpoints of an API.

Parameters:

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

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)

Returns:

ApiResponse<APIEndpointListDTO>

Throws:

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

getApiEndpointsAsync

public okhttp3.Call getApiEndpointsAsync(String apiId,
                                         Integer limit,
                                         Integer offset,
                                         ApiCallback<APIEndpointListDTO> _callback)
                                  throws ApiException

Get all API Endpoints (asynchronously) This operation can be used to get all the available endpoints of an API.

Parameters:

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

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)

_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

updateApiEndpointCall

public okhttp3.Call updateApiEndpointCall(String apiId,
                                          String endpointId,
                                          APIEndpointDTO apIEndpointDTO,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for updateApiEndpoint

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

apIEndpointDTO - API Endpoint object with updated details (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateApiEndpoint

public APIEndpointDTO updateApiEndpoint(String apiId,
                                        String endpointId,
                                        APIEndpointDTO apIEndpointDTO)
                                 throws ApiException

Update an Endpoint This operation can be used to update a API endpoint.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

apIEndpointDTO - API Endpoint object with updated details (optional)

Returns:

APIEndpointDTO

Throws:

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

updateApiEndpointWithHttpInfo

public ApiResponse<APIEndpointDTO> updateApiEndpointWithHttpInfo(String apiId,
                                                                 String endpointId,
                                                                 APIEndpointDTO apIEndpointDTO)
                                                          throws ApiException

Update an Endpoint This operation can be used to update a API endpoint.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

apIEndpointDTO - API Endpoint object with updated details (optional)

Returns:

ApiResponse<APIEndpointDTO>

Throws:

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

updateApiEndpointAsync

public okhttp3.Call updateApiEndpointAsync(String apiId,
                                           String endpointId,
                                           APIEndpointDTO apIEndpointDTO,
                                           ApiCallback<APIEndpointDTO> _callback)
                                    throws ApiException

Update an Endpoint (asynchronously) This operation can be used to update a API endpoint.

Parameters:

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

endpointId - **Endpoint ID** consisting of the **UUID** of the Endpoint**. (required)

apIEndpointDTO - API Endpoint object with updated details (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