Package ai.reveng.api

Class FunctionsBlockCommentsApi

java.lang.Object

ai.reveng.api.FunctionsBlockCommentsApi

public class FunctionsBlockCommentsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
FunctionsBlockCommentsApi()
FunctionsBlockCommentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BaseResponseBlockCommentsGenerationForFunctionResponse	generateBlockCommentsForBlockInFunction(Integer functionId, Block block)	Generate block comments for a specific block in a function
okhttp3.Call	generateBlockCommentsForBlockInFunctionAsync(Integer functionId, Block block, ApiCallback<BaseResponseBlockCommentsGenerationForFunctionResponse> _callback)	Generate block comments for a specific block in a function (asynchronously)
okhttp3.Call	generateBlockCommentsForBlockInFunctionCall(Integer functionId, Block block, ApiCallback _callback)	Build call for generateBlockCommentsForBlockInFunction
ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse>	generateBlockCommentsForBlockInFunctionWithHttpInfo(Integer functionId, Block block)	Generate block comments for a specific block in a function
BaseResponseBlockCommentsGenerationForFunctionResponse	generateBlockCommentsForFunction(Integer functionId)	Generate block comments for a function
okhttp3.Call	generateBlockCommentsForFunctionAsync(Integer functionId, ApiCallback<BaseResponseBlockCommentsGenerationForFunctionResponse> _callback)	Generate block comments for a function (asynchronously)
okhttp3.Call	generateBlockCommentsForFunctionCall(Integer functionId, ApiCallback _callback)	Build call for generateBlockCommentsForFunction
ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse>	generateBlockCommentsForFunctionWithHttpInfo(Integer functionId)	Generate block comments for a function
BaseResponseBlockCommentsOverviewGenerationResponse	generateOverviewCommentForFunction(Integer functionId)	Generate overview comment for a function
okhttp3.Call	generateOverviewCommentForFunctionAsync(Integer functionId, ApiCallback<BaseResponseBlockCommentsOverviewGenerationResponse> _callback)	Generate overview comment for a function (asynchronously)
okhttp3.Call	generateOverviewCommentForFunctionCall(Integer functionId, ApiCallback _callback)	Build call for generateOverviewCommentForFunction
ApiResponse<BaseResponseBlockCommentsOverviewGenerationResponse>	generateOverviewCommentForFunctionWithHttpInfo(Integer functionId)	Generate overview comment for a function
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionsBlockCommentsApi

public FunctionsBlockCommentsApi()

FunctionsBlockCommentsApi

public FunctionsBlockCommentsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

generateBlockCommentsForBlockInFunctionCall

public okhttp3.Call generateBlockCommentsForBlockInFunctionCall(@Nonnull
 Integer functionId,
 @Nonnull
 Block block,
 ApiCallback _callback)
                                                         throws ApiException

Build call for generateBlockCommentsForBlockInFunction

Parameters:

functionId - (required)

block - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateBlockCommentsForBlockInFunction

public BaseResponseBlockCommentsGenerationForFunctionResponse generateBlockCommentsForBlockInFunction(@Nonnull
 Integer functionId,
 @Nonnull
 Block block)
                                                                                               throws ApiException

Generate block comments for a specific block in a function

Parameters:

functionId - (required)

block - (required)

Returns:

BaseResponseBlockCommentsGenerationForFunctionResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateBlockCommentsForBlockInFunctionWithHttpInfo

public ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse> generateBlockCommentsForBlockInFunctionWithHttpInfo(@Nonnull
 Integer functionId,
 @Nonnull
 Block block)
                                                                                                                        throws ApiException

Generate block comments for a specific block in a function

Parameters:

functionId - (required)

block - (required)

Returns:

ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateBlockCommentsForBlockInFunctionAsync

public okhttp3.Call generateBlockCommentsForBlockInFunctionAsync(@Nonnull
 Integer functionId,
 @Nonnull
 Block block,
 ApiCallback<BaseResponseBlockCommentsGenerationForFunctionResponse> _callback)
                                                          throws ApiException

Generate block comments for a specific block in a function (asynchronously)

Parameters:

functionId - (required)

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateBlockCommentsForFunctionCall

public okhttp3.Call generateBlockCommentsForFunctionCall(@Nonnull
 Integer functionId,
 ApiCallback _callback)
                                                  throws ApiException

Build call for generateBlockCommentsForFunction

Parameters:

functionId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateBlockCommentsForFunction

public BaseResponseBlockCommentsGenerationForFunctionResponse generateBlockCommentsForFunction(@Nonnull
 Integer functionId)
                                                                                        throws ApiException

Generate block comments for a function

Parameters:

functionId - (required)

Returns:

BaseResponseBlockCommentsGenerationForFunctionResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateBlockCommentsForFunctionWithHttpInfo

public ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse> generateBlockCommentsForFunctionWithHttpInfo(@Nonnull
 Integer functionId)
                                                                                                                 throws ApiException

Generate block comments for a function

Parameters:

functionId - (required)

Returns:

ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateBlockCommentsForFunctionAsync

public okhttp3.Call generateBlockCommentsForFunctionAsync(@Nonnull
 Integer functionId,
 ApiCallback<BaseResponseBlockCommentsGenerationForFunctionResponse> _callback)
                                                   throws ApiException

Generate block comments for a function (asynchronously)

Parameters:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateOverviewCommentForFunctionCall

public okhttp3.Call generateOverviewCommentForFunctionCall(@Nonnull
 Integer functionId,
 ApiCallback _callback)
                                                    throws ApiException

Build call for generateOverviewCommentForFunction

Parameters:

functionId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateOverviewCommentForFunction

public BaseResponseBlockCommentsOverviewGenerationResponse generateOverviewCommentForFunction(@Nonnull
 Integer functionId)
                                                                                       throws ApiException

Generate overview comment for a function

Parameters:

functionId - (required)

Returns:

BaseResponseBlockCommentsOverviewGenerationResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateOverviewCommentForFunctionWithHttpInfo

public ApiResponse<BaseResponseBlockCommentsOverviewGenerationResponse> generateOverviewCommentForFunctionWithHttpInfo(@Nonnull
 Integer functionId)
                                                                                                                throws ApiException

Generate overview comment for a function

Parameters:

functionId - (required)

Returns:

ApiResponse<BaseResponseBlockCommentsOverviewGenerationResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

generateOverviewCommentForFunctionAsync

public okhttp3.Call generateOverviewCommentForFunctionAsync(@Nonnull
 Integer functionId,
 ApiCallback<BaseResponseBlockCommentsOverviewGenerationResponse> _callback)
                                                     throws ApiException

Generate overview comment for a function (asynchronously)

Parameters:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-