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

Class CommentsApi

java.lang.Object

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

public class CommentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CommentsApi()
CommentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CommentDTO	addCommentToAPI(String apiId, CommentDTO body) Add an API comment
com.squareup.okhttp.Call	addCommentToAPIAsync(String apiId, CommentDTO body, ApiCallback<CommentDTO> callback) Add an API comment (asynchronously)
com.squareup.okhttp.Call	addCommentToAPICall(String apiId, CommentDTO body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for addCommentToAPI
ApiResponse<CommentDTO>	addCommentToAPIWithHttpInfo(String apiId, CommentDTO body) Add an API comment
void	deleteComment(String commentId, String apiId, String ifMatch) Delete an API comment Remove a Comment
com.squareup.okhttp.Call	deleteCommentAsync(String commentId, String apiId, String ifMatch, ApiCallback<Void> callback) Delete an API comment (asynchronously) Remove a Comment
com.squareup.okhttp.Call	deleteCommentCall(String commentId, String apiId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteComment
ApiResponse<Void>	deleteCommentWithHttpInfo(String commentId, String apiId, String ifMatch) Delete an API comment Remove a Comment
CommentListDTO	getAllCommentsOfAPI(String apiId, String xWSO2Tenant, Integer limit, Integer offset) Retrieve API comments Get a list of Comments that are already added to APIs
com.squareup.okhttp.Call	getAllCommentsOfAPIAsync(String apiId, String xWSO2Tenant, Integer limit, Integer offset, ApiCallback<CommentListDTO> callback) Retrieve API comments (asynchronously) Get a list of Comments that are already added to APIs
com.squareup.okhttp.Call	getAllCommentsOfAPICall(String apiId, String xWSO2Tenant, Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllCommentsOfAPI
ApiResponse<CommentListDTO>	getAllCommentsOfAPIWithHttpInfo(String apiId, String xWSO2Tenant, Integer limit, Integer offset) Retrieve API comments Get a list of Comments that are already added to APIs
ApiClient	getApiClient()
CommentDTO	getCommentOfAPI(String commentId, String apiId, String xWSO2Tenant, String ifNoneMatch) Get details of an API comment Get the individual comment given by a username for a certain API.
com.squareup.okhttp.Call	getCommentOfAPIAsync(String commentId, String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<CommentDTO> callback) Get details of an API comment (asynchronously) Get the individual comment given by a username for a certain API.
com.squareup.okhttp.Call	getCommentOfAPICall(String commentId, String apiId, String xWSO2Tenant, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getCommentOfAPI
ApiResponse<CommentDTO>	getCommentOfAPIWithHttpInfo(String commentId, String apiId, String xWSO2Tenant, String ifNoneMatch) Get details of an API comment Get the individual comment given by a username for a certain API.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentsApi

public CommentsApi()

CommentsApi

public CommentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addCommentToAPICall

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

Build call for addCommentToAPI

Parameters:

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

body - Comment object that should to be added (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addCommentToAPI

public CommentDTO addCommentToAPI(String apiId,
                                  CommentDTO body)
                           throws ApiException

Add an API comment

Parameters:

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

body - Comment object that should to be added (required)

Returns:

CommentDTO

Throws:

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

addCommentToAPIWithHttpInfo

public ApiResponse<CommentDTO> addCommentToAPIWithHttpInfo(String apiId,
                                                           CommentDTO body)
                                                    throws ApiException

Add an API comment

Parameters:

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

body - Comment object that should to be added (required)

Returns:

ApiResponse<CommentDTO>

Throws:

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

addCommentToAPIAsync

public com.squareup.okhttp.Call addCommentToAPIAsync(String apiId,
                                                     CommentDTO body,
                                                     ApiCallback<CommentDTO> callback)
                                              throws ApiException

Add an API comment (asynchronously)

Parameters:

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

body - Comment object that should 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

deleteCommentCall

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

Build call for deleteComment

Parameters:

commentId - Comment Id (required)

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

deleteComment

public void deleteComment(String commentId,
                          String apiId,
                          String ifMatch)
                   throws ApiException

Delete an API comment Remove a Comment

Parameters:

commentId - Comment Id (required)

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

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

Throws:

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

deleteCommentWithHttpInfo

public ApiResponse<Void> deleteCommentWithHttpInfo(String commentId,
                                                   String apiId,
                                                   String ifMatch)
                                            throws ApiException

Delete an API comment Remove a Comment

Parameters:

commentId - Comment Id (required)

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

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

Returns:

ApiResponse<Void>

Throws:

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

deleteCommentAsync

public com.squareup.okhttp.Call deleteCommentAsync(String commentId,
                                                   String apiId,
                                                   String ifMatch,
                                                   ApiCallback<Void> callback)
                                            throws ApiException

Delete an API comment (asynchronously) Remove a Comment

Parameters:

commentId - Comment Id (required)

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

getAllCommentsOfAPICall

public com.squareup.okhttp.Call getAllCommentsOfAPICall(String apiId,
                                                        String xWSO2Tenant,
                                                        Integer limit,
                                                        Integer offset,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for getAllCommentsOfAPI

Parameters:

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

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

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)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllCommentsOfAPI

public CommentListDTO getAllCommentsOfAPI(String apiId,
                                          String xWSO2Tenant,
                                          Integer limit,
                                          Integer offset)
                                   throws ApiException

Retrieve API comments Get a list of Comments that are already added to APIs

Parameters:

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

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

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:

CommentListDTO

Throws:

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

getAllCommentsOfAPIWithHttpInfo

public ApiResponse<CommentListDTO> getAllCommentsOfAPIWithHttpInfo(String apiId,
                                                                   String xWSO2Tenant,
                                                                   Integer limit,
                                                                   Integer offset)
                                                            throws ApiException

Retrieve API comments Get a list of Comments that are already added to APIs

Parameters:

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

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

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<CommentListDTO>

Throws:

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

getAllCommentsOfAPIAsync

public com.squareup.okhttp.Call getAllCommentsOfAPIAsync(String apiId,
                                                         String xWSO2Tenant,
                                                         Integer limit,
                                                         Integer offset,
                                                         ApiCallback<CommentListDTO> callback)
                                                  throws ApiException

Retrieve API comments (asynchronously) Get a list of Comments that are already added to APIs

Parameters:

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

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

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

getCommentOfAPICall

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

Build call for getCommentOfAPI

Parameters:

commentId - Comment Id (required)

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

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCommentOfAPI

public CommentDTO getCommentOfAPI(String commentId,
                                  String apiId,
                                  String xWSO2Tenant,
                                  String ifNoneMatch)
                           throws ApiException

Get details of an API comment Get the individual comment given by a username for a certain API.

Parameters:

commentId - Comment Id (required)

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

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

CommentDTO

Throws:

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

getCommentOfAPIWithHttpInfo

public ApiResponse<CommentDTO> getCommentOfAPIWithHttpInfo(String commentId,
                                                           String apiId,
                                                           String xWSO2Tenant,
                                                           String ifNoneMatch)
                                                    throws ApiException

Get details of an API comment Get the individual comment given by a username for a certain API.

Parameters:

commentId - Comment Id (required)

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

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<CommentDTO>

Throws:

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

getCommentOfAPIAsync

public com.squareup.okhttp.Call getCommentOfAPIAsync(String commentId,
                                                     String apiId,
                                                     String xWSO2Tenant,
                                                     String ifNoneMatch,
                                                     ApiCallback<CommentDTO> callback)
                                              throws ApiException

Get details of an API comment (asynchronously) Get the individual comment given by a username for a certain API.

Parameters:

commentId - Comment Id (required)

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

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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