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, PostRequestBodyDTO postRequestBodyDTO, String replyTo) Add an API Comment
okhttp3.Call	addCommentToAPIAsync(String apiId, PostRequestBodyDTO postRequestBodyDTO, String replyTo, ApiCallback<CommentDTO> _callback) Add an API Comment (asynchronously)
okhttp3.Call	addCommentToAPICall(String apiId, PostRequestBodyDTO postRequestBodyDTO, String replyTo, ApiCallback _callback) Build call for addCommentToAPI
ApiResponse<CommentDTO>	addCommentToAPIWithHttpInfo(String apiId, PostRequestBodyDTO postRequestBodyDTO, String replyTo) Add an API Comment
void	deleteComment(String commentId, String apiId, String ifMatch) Delete an API Comment Remove a Comment
okhttp3.Call	deleteCommentAsync(String commentId, String apiId, String ifMatch, ApiCallback<Void> _callback) Delete an API Comment (asynchronously) Remove a Comment
okhttp3.Call	deleteCommentCall(String commentId, String apiId, String ifMatch, ApiCallback _callback) Build call for deleteComment
ApiResponse<Void>	deleteCommentWithHttpInfo(String commentId, String apiId, String ifMatch) Delete an API Comment Remove a Comment
CommentDTO	editCommentOfAPI(String commentId, String apiId, PatchRequestBodyDTO patchRequestBodyDTO) Edit a comment Edit the individual comment
okhttp3.Call	editCommentOfAPIAsync(String commentId, String apiId, PatchRequestBodyDTO patchRequestBodyDTO, ApiCallback<CommentDTO> _callback) Edit a comment (asynchronously) Edit the individual comment
okhttp3.Call	editCommentOfAPICall(String commentId, String apiId, PatchRequestBodyDTO patchRequestBodyDTO, ApiCallback _callback) Build call for editCommentOfAPI
ApiResponse<CommentDTO>	editCommentOfAPIWithHttpInfo(String commentId, String apiId, PatchRequestBodyDTO patchRequestBodyDTO) Edit a comment Edit the individual comment
CommentListDTO	getAllCommentsOfAPI(String apiId, String xWSO2Tenant, Integer limit, Integer offset, Boolean includeCommenterInfo) Retrieve API Comments Get a list of Comments that are already added to APIs
okhttp3.Call	getAllCommentsOfAPIAsync(String apiId, String xWSO2Tenant, Integer limit, Integer offset, Boolean includeCommenterInfo, ApiCallback<CommentListDTO> _callback) Retrieve API Comments (asynchronously) Get a list of Comments that are already added to APIs
okhttp3.Call	getAllCommentsOfAPICall(String apiId, String xWSO2Tenant, Integer limit, Integer offset, Boolean includeCommenterInfo, ApiCallback _callback) Build call for getAllCommentsOfAPI
ApiResponse<CommentListDTO>	getAllCommentsOfAPIWithHttpInfo(String apiId, String xWSO2Tenant, Integer limit, Integer offset, Boolean includeCommenterInfo) 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, Boolean includeCommenterInfo, Integer replyLimit, Integer replyOffset) Get Details of an API Comment Get the individual comment given by a username for a certain API.
okhttp3.Call	getCommentOfAPIAsync(String commentId, String apiId, String xWSO2Tenant, String ifNoneMatch, Boolean includeCommenterInfo, Integer replyLimit, Integer replyOffset, ApiCallback<CommentDTO> _callback) Get Details of an API Comment (asynchronously) Get the individual comment given by a username for a certain API.
okhttp3.Call	getCommentOfAPICall(String commentId, String apiId, String xWSO2Tenant, String ifNoneMatch, Boolean includeCommenterInfo, Integer replyLimit, Integer replyOffset, ApiCallback _callback) Build call for getCommentOfAPI
ApiResponse<CommentDTO>	getCommentOfAPIWithHttpInfo(String commentId, String apiId, String xWSO2Tenant, String ifNoneMatch, Boolean includeCommenterInfo, Integer replyLimit, Integer replyOffset) Get Details of an API Comment Get the individual comment given by a username for a certain API.
CommentListDTO	getRepliesOfComment(String commentId, String apiId, String xWSO2Tenant, Integer limit, Integer offset, String ifNoneMatch, Boolean includeCommenterInfo) Get replies of a comment Get replies of a comment
okhttp3.Call	getRepliesOfCommentAsync(String commentId, String apiId, String xWSO2Tenant, Integer limit, Integer offset, String ifNoneMatch, Boolean includeCommenterInfo, ApiCallback<CommentListDTO> _callback) Get replies of a comment (asynchronously) Get replies of a comment
okhttp3.Call	getRepliesOfCommentCall(String commentId, String apiId, String xWSO2Tenant, Integer limit, Integer offset, String ifNoneMatch, Boolean includeCommenterInfo, ApiCallback _callback) Build call for getRepliesOfComment
ApiResponse<CommentListDTO>	getRepliesOfCommentWithHttpInfo(String commentId, String apiId, String xWSO2Tenant, Integer limit, Integer offset, String ifNoneMatch, Boolean includeCommenterInfo) Get replies of a comment Get replies of a comment
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 okhttp3.Call addCommentToAPICall(String apiId,
                                        PostRequestBodyDTO postRequestBodyDTO,
                                        String replyTo,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for addCommentToAPI

Parameters:

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

postRequestBodyDTO - (required)

replyTo - ID of the parent comment. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addCommentToAPI

public CommentDTO addCommentToAPI(String apiId,
                                  PostRequestBodyDTO postRequestBodyDTO,
                                  String replyTo)
                           throws ApiException

Add an API Comment

Parameters:

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

postRequestBodyDTO - (required)

replyTo - ID of the parent comment. (optional)

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,
                                                           PostRequestBodyDTO postRequestBodyDTO,
                                                           String replyTo)
                                                    throws ApiException

Add an API Comment

Parameters:

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

postRequestBodyDTO - (required)

replyTo - ID of the parent comment. (optional)

Returns:

ApiResponse<CommentDTO>

Throws:

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

addCommentToAPIAsync

public okhttp3.Call addCommentToAPIAsync(String apiId,
                                         PostRequestBodyDTO postRequestBodyDTO,
                                         String replyTo,
                                         ApiCallback<CommentDTO> _callback)
                                  throws ApiException

Add an API Comment (asynchronously)

Parameters:

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

postRequestBodyDTO - (required)

replyTo - ID of the parent comment. (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

deleteCommentCall

public okhttp3.Call deleteCommentCall(String commentId,
                                      String apiId,
                                      String ifMatch,
                                      ApiCallback _callback)
                               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)

_callback - Callback for upload/download progress

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 okhttp3.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

editCommentOfAPICall

public okhttp3.Call editCommentOfAPICall(String commentId,
                                         String apiId,
                                         PatchRequestBodyDTO patchRequestBodyDTO,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for editCommentOfAPI

Parameters:

commentId - Comment Id (required)

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

patchRequestBodyDTO - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

editCommentOfAPI

public CommentDTO editCommentOfAPI(String commentId,
                                   String apiId,
                                   PatchRequestBodyDTO patchRequestBodyDTO)
                            throws ApiException

Edit a comment Edit the individual comment

Parameters:

commentId - Comment Id (required)

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

patchRequestBodyDTO - (required)

Returns:

CommentDTO

Throws:

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

editCommentOfAPIWithHttpInfo

public ApiResponse<CommentDTO> editCommentOfAPIWithHttpInfo(String commentId,
                                                            String apiId,
                                                            PatchRequestBodyDTO patchRequestBodyDTO)
                                                     throws ApiException

Edit a comment Edit the individual comment

Parameters:

commentId - Comment Id (required)

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

patchRequestBodyDTO - (required)

Returns:

ApiResponse<CommentDTO>

Throws:

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

editCommentOfAPIAsync

public okhttp3.Call editCommentOfAPIAsync(String commentId,
                                          String apiId,
                                          PatchRequestBodyDTO patchRequestBodyDTO,
                                          ApiCallback<CommentDTO> _callback)
                                   throws ApiException

Edit a comment (asynchronously) Edit the individual comment

Parameters:

commentId - Comment Id (required)

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

patchRequestBodyDTO - (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

getAllCommentsOfAPICall

public okhttp3.Call getAllCommentsOfAPICall(String apiId,
                                            String xWSO2Tenant,
                                            Integer limit,
                                            Integer offset,
                                            Boolean includeCommenterInfo,
                                            ApiCallback _callback)
                                     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 retrieved 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)

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

_callback - Callback for upload/download progress

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,
                                          Boolean includeCommenterInfo)
                                   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 retrieved 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)

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

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,
                                                                   Boolean includeCommenterInfo)
                                                            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 retrieved 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)

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

Returns:

ApiResponse<CommentListDTO>

Throws:

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

getAllCommentsOfAPIAsync

public okhttp3.Call getAllCommentsOfAPIAsync(String apiId,
                                             String xWSO2Tenant,
                                             Integer limit,
                                             Integer offset,
                                             Boolean includeCommenterInfo,
                                             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 retrieved 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)

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

_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 okhttp3.Call getCommentOfAPICall(String commentId,
                                        String apiId,
                                        String xWSO2Tenant,
                                        String ifNoneMatch,
                                        Boolean includeCommenterInfo,
                                        Integer replyLimit,
                                        Integer replyOffset,
                                        ApiCallback _callback)
                                 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 retrieved from. (optional)

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

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

replyLimit - Maximum size of replies array to return. (optional, default to 25)

replyOffset - Starting point within the complete list of replies. (optional, default to 0)

_callback - Callback for upload/download progress

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,
                                  Boolean includeCommenterInfo,
                                  Integer replyLimit,
                                  Integer replyOffset)
                           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 retrieved from. (optional)

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

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

replyLimit - Maximum size of replies array to return. (optional, default to 25)

replyOffset - Starting point within the complete list of replies. (optional, default to 0)

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,
                                                           Boolean includeCommenterInfo,
                                                           Integer replyLimit,
                                                           Integer replyOffset)
                                                    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 retrieved from. (optional)

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

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

replyLimit - Maximum size of replies array to return. (optional, default to 25)

replyOffset - Starting point within the complete list of replies. (optional, default to 0)

Returns:

ApiResponse<CommentDTO>

Throws:

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

getCommentOfAPIAsync

public okhttp3.Call getCommentOfAPIAsync(String commentId,
                                         String apiId,
                                         String xWSO2Tenant,
                                         String ifNoneMatch,
                                         Boolean includeCommenterInfo,
                                         Integer replyLimit,
                                         Integer replyOffset,
                                         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 retrieved from. (optional)

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

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

replyLimit - Maximum size of replies array to return. (optional, default to 25)

replyOffset - Starting point within the complete list of replies. (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

getRepliesOfCommentCall

public okhttp3.Call getRepliesOfCommentCall(String commentId,
                                            String apiId,
                                            String xWSO2Tenant,
                                            Integer limit,
                                            Integer offset,
                                            String ifNoneMatch,
                                            Boolean includeCommenterInfo,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getRepliesOfComment

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 retrieved 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)

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

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getRepliesOfComment

public CommentListDTO getRepliesOfComment(String commentId,
                                          String apiId,
                                          String xWSO2Tenant,
                                          Integer limit,
                                          Integer offset,
                                          String ifNoneMatch,
                                          Boolean includeCommenterInfo)
                                   throws ApiException

Get replies of a comment Get replies of a comment

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 retrieved 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)

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

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

Returns:

CommentListDTO

Throws:

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

getRepliesOfCommentWithHttpInfo

public ApiResponse<CommentListDTO> getRepliesOfCommentWithHttpInfo(String commentId,
                                                                   String apiId,
                                                                   String xWSO2Tenant,
                                                                   Integer limit,
                                                                   Integer offset,
                                                                   String ifNoneMatch,
                                                                   Boolean includeCommenterInfo)
                                                            throws ApiException

Get replies of a comment Get replies of a comment

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 retrieved 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)

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

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

Returns:

ApiResponse<CommentListDTO>

Throws:

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

getRepliesOfCommentAsync

public okhttp3.Call getRepliesOfCommentAsync(String commentId,
                                             String apiId,
                                             String xWSO2Tenant,
                                             Integer limit,
                                             Integer offset,
                                             String ifNoneMatch,
                                             Boolean includeCommenterInfo,
                                             ApiCallback<CommentListDTO> _callback)
                                      throws ApiException

Get replies of a comment (asynchronously) Get replies of a comment

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 retrieved 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)

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

includeCommenterInfo - Whether we need to display commentor details. (optional, default to false)

_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