FunctionsBlockCommentsApi.java

/*
 * RevEng.AI API
 * RevEng.AI is an AI-powered binary analysis platform for reverse engineering and malware analysis. It provides similarity search across executable binaries and functions, AI-driven decompilation, dynamic execution analysis, firmware unpacking, and integration with external threat intelligence sources like VirusTotal.
 *
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package ai.reveng.api;

import ai.reveng.invoker.ApiCallback;
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.ApiResponse;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.Pair;
import ai.reveng.invoker.ProgressRequestBody;
import ai.reveng.invoker.ProgressResponseBody;

import com.google.gson.reflect.TypeToken;

import java.io.IOException;


import ai.reveng.model.BaseResponse;
import ai.reveng.model.BaseResponseBlockCommentsGenerationForFunctionResponse;
import ai.reveng.model.BaseResponseBlockCommentsOverviewGenerationResponse;
import ai.reveng.model.Block;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class FunctionsBlockCommentsApi {
    private ApiClient localVarApiClient;
    private int localHostIndex;
    private String localCustomBaseUrl;

    public FunctionsBlockCommentsApi() {
        this(Configuration.getDefaultApiClient());
    }

    public FunctionsBlockCommentsApi(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    public ApiClient getApiClient() {
        return localVarApiClient;
    }

    public void setApiClient(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    public int getHostIndex() {
        return localHostIndex;
    }

    public void setHostIndex(int hostIndex) {
        this.localHostIndex = hostIndex;
    }

    public String getCustomBaseUrl() {
        return localCustomBaseUrl;
    }

    public void setCustomBaseUrl(String customBaseUrl) {
        this.localCustomBaseUrl = customBaseUrl;
    }

    /**
     * Build call for generateBlockCommentsForBlockInFunction
     * @param functionId  (required)
     * @param block  (required)
     * @param _callback Callback for upload/download progress
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public okhttp3.Call generateBlockCommentsForBlockInFunctionCall(@javax.annotation.Nonnull Integer functionId, @javax.annotation.Nonnull Block block, final ApiCallback _callback) throws ApiException {
        String basePath = null;
        // Operation Servers
        String[] localBasePaths = new String[] {  };

        // Determine Base Path to Use
        if (localCustomBaseUrl != null){
            basePath = localCustomBaseUrl;
        } else if ( localBasePaths.length > 0 ) {
            basePath = localBasePaths[localHostIndex];
        } else {
            basePath = null;
        }

        Object localVarPostBody = block;

        // create path and map variables
        String localVarPath = "/v2/functions/{function_id}/block-comments/single"
            .replace("{" + "function_id" + "}", localVarApiClient.escapeString(functionId.toString()));

        List<Pair> localVarQueryParams = new ArrayList<Pair>();
        List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
        Map<String, String> localVarHeaderParams = new HashMap<String, String>();
        Map<String, String> localVarCookieParams = new HashMap<String, String>();
        Map<String, Object> localVarFormParams = new HashMap<String, Object>();

        final String[] localVarAccepts = {
            "application/json"
        };
        final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
        if (localVarAccept != null) {
            localVarHeaderParams.put("Accept", localVarAccept);
        }

        final String[] localVarContentTypes = {
            "application/json"
        };
        final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
        if (localVarContentType != null) {
            localVarHeaderParams.put("Content-Type", localVarContentType);
        }

        String[] localVarAuthNames = new String[] { "APIKey" };
        return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call generateBlockCommentsForBlockInFunctionValidateBeforeCall(@javax.annotation.Nonnull Integer functionId, @javax.annotation.Nonnull Block block, final ApiCallback _callback) throws ApiException {
        // verify the required parameter 'functionId' is set
        if (functionId == null) {
            throw new ApiException("Missing the required parameter 'functionId' when calling generateBlockCommentsForBlockInFunction(Async)");
        }

        // verify the required parameter 'block' is set
        if (block == null) {
            throw new ApiException("Missing the required parameter 'block' when calling generateBlockCommentsForBlockInFunction(Async)");
        }

        return generateBlockCommentsForBlockInFunctionCall(functionId, block, _callback);

    }

    /**
     * Generate block comments for a specific block in a function
     * 
     * @param functionId  (required)
     * @param block  (required)
     * @return BaseResponseBlockCommentsGenerationForFunctionResponse
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public BaseResponseBlockCommentsGenerationForFunctionResponse generateBlockCommentsForBlockInFunction(@javax.annotation.Nonnull Integer functionId, @javax.annotation.Nonnull Block block) throws ApiException {
        ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse> localVarResp = generateBlockCommentsForBlockInFunctionWithHttpInfo(functionId, block);
        return localVarResp.getData();
    }

    /**
     * Generate block comments for a specific block in a function
     * 
     * @param functionId  (required)
     * @param block  (required)
     * @return ApiResponse&lt;BaseResponseBlockCommentsGenerationForFunctionResponse&gt;
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse> generateBlockCommentsForBlockInFunctionWithHttpInfo(@javax.annotation.Nonnull Integer functionId, @javax.annotation.Nonnull Block block) throws ApiException {
        okhttp3.Call localVarCall = generateBlockCommentsForBlockInFunctionValidateBeforeCall(functionId, block, null);
        Type localVarReturnType = new TypeToken<BaseResponseBlockCommentsGenerationForFunctionResponse>(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Generate block comments for a specific block in a function (asynchronously)
     * 
     * @param functionId  (required)
     * @param block  (required)
     * @param _callback The callback to be executed when the API call finishes
     * @return The request call
     * @throws ApiException If fail to process the API call, e.g. serializing the request body object
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public okhttp3.Call generateBlockCommentsForBlockInFunctionAsync(@javax.annotation.Nonnull Integer functionId, @javax.annotation.Nonnull Block block, final ApiCallback<BaseResponseBlockCommentsGenerationForFunctionResponse> _callback) throws ApiException {

        okhttp3.Call localVarCall = generateBlockCommentsForBlockInFunctionValidateBeforeCall(functionId, block, _callback);
        Type localVarReturnType = new TypeToken<BaseResponseBlockCommentsGenerationForFunctionResponse>(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for generateBlockCommentsForFunction
     * @param functionId  (required)
     * @param _callback Callback for upload/download progress
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public okhttp3.Call generateBlockCommentsForFunctionCall(@javax.annotation.Nonnull Integer functionId, final ApiCallback _callback) throws ApiException {
        String basePath = null;
        // Operation Servers
        String[] localBasePaths = new String[] {  };

        // Determine Base Path to Use
        if (localCustomBaseUrl != null){
            basePath = localCustomBaseUrl;
        } else if ( localBasePaths.length > 0 ) {
            basePath = localBasePaths[localHostIndex];
        } else {
            basePath = null;
        }

        Object localVarPostBody = null;

        // create path and map variables
        String localVarPath = "/v2/functions/{function_id}/block-comments"
            .replace("{" + "function_id" + "}", localVarApiClient.escapeString(functionId.toString()));

        List<Pair> localVarQueryParams = new ArrayList<Pair>();
        List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
        Map<String, String> localVarHeaderParams = new HashMap<String, String>();
        Map<String, String> localVarCookieParams = new HashMap<String, String>();
        Map<String, Object> localVarFormParams = new HashMap<String, Object>();

        final String[] localVarAccepts = {
            "application/json"
        };
        final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
        if (localVarAccept != null) {
            localVarHeaderParams.put("Accept", localVarAccept);
        }

        final String[] localVarContentTypes = {
        };
        final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
        if (localVarContentType != null) {
            localVarHeaderParams.put("Content-Type", localVarContentType);
        }

        String[] localVarAuthNames = new String[] { "APIKey" };
        return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call generateBlockCommentsForFunctionValidateBeforeCall(@javax.annotation.Nonnull Integer functionId, final ApiCallback _callback) throws ApiException {
        // verify the required parameter 'functionId' is set
        if (functionId == null) {
            throw new ApiException("Missing the required parameter 'functionId' when calling generateBlockCommentsForFunction(Async)");
        }

        return generateBlockCommentsForFunctionCall(functionId, _callback);

    }

    /**
     * Generate block comments for a function
     * 
     * @param functionId  (required)
     * @return BaseResponseBlockCommentsGenerationForFunctionResponse
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public BaseResponseBlockCommentsGenerationForFunctionResponse generateBlockCommentsForFunction(@javax.annotation.Nonnull Integer functionId) throws ApiException {
        ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse> localVarResp = generateBlockCommentsForFunctionWithHttpInfo(functionId);
        return localVarResp.getData();
    }

    /**
     * Generate block comments for a function
     * 
     * @param functionId  (required)
     * @return ApiResponse&lt;BaseResponseBlockCommentsGenerationForFunctionResponse&gt;
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public ApiResponse<BaseResponseBlockCommentsGenerationForFunctionResponse> generateBlockCommentsForFunctionWithHttpInfo(@javax.annotation.Nonnull Integer functionId) throws ApiException {
        okhttp3.Call localVarCall = generateBlockCommentsForFunctionValidateBeforeCall(functionId, null);
        Type localVarReturnType = new TypeToken<BaseResponseBlockCommentsGenerationForFunctionResponse>(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Generate block comments for a function (asynchronously)
     * 
     * @param functionId  (required)
     * @param _callback The callback to be executed when the API call finishes
     * @return The request call
     * @throws ApiException If fail to process the API call, e.g. serializing the request body object
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public okhttp3.Call generateBlockCommentsForFunctionAsync(@javax.annotation.Nonnull Integer functionId, final ApiCallback<BaseResponseBlockCommentsGenerationForFunctionResponse> _callback) throws ApiException {

        okhttp3.Call localVarCall = generateBlockCommentsForFunctionValidateBeforeCall(functionId, _callback);
        Type localVarReturnType = new TypeToken<BaseResponseBlockCommentsGenerationForFunctionResponse>(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for generateOverviewCommentForFunction
     * @param functionId  (required)
     * @param _callback Callback for upload/download progress
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public okhttp3.Call generateOverviewCommentForFunctionCall(@javax.annotation.Nonnull Integer functionId, final ApiCallback _callback) throws ApiException {
        String basePath = null;
        // Operation Servers
        String[] localBasePaths = new String[] {  };

        // Determine Base Path to Use
        if (localCustomBaseUrl != null){
            basePath = localCustomBaseUrl;
        } else if ( localBasePaths.length > 0 ) {
            basePath = localBasePaths[localHostIndex];
        } else {
            basePath = null;
        }

        Object localVarPostBody = null;

        // create path and map variables
        String localVarPath = "/v2/functions/{function_id}/block-comments/overview"
            .replace("{" + "function_id" + "}", localVarApiClient.escapeString(functionId.toString()));

        List<Pair> localVarQueryParams = new ArrayList<Pair>();
        List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
        Map<String, String> localVarHeaderParams = new HashMap<String, String>();
        Map<String, String> localVarCookieParams = new HashMap<String, String>();
        Map<String, Object> localVarFormParams = new HashMap<String, Object>();

        final String[] localVarAccepts = {
            "application/json"
        };
        final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
        if (localVarAccept != null) {
            localVarHeaderParams.put("Accept", localVarAccept);
        }

        final String[] localVarContentTypes = {
        };
        final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
        if (localVarContentType != null) {
            localVarHeaderParams.put("Content-Type", localVarContentType);
        }

        String[] localVarAuthNames = new String[] { "APIKey" };
        return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call generateOverviewCommentForFunctionValidateBeforeCall(@javax.annotation.Nonnull Integer functionId, final ApiCallback _callback) throws ApiException {
        // verify the required parameter 'functionId' is set
        if (functionId == null) {
            throw new ApiException("Missing the required parameter 'functionId' when calling generateOverviewCommentForFunction(Async)");
        }

        return generateOverviewCommentForFunctionCall(functionId, _callback);

    }

    /**
     * Generate overview comment for a function
     * 
     * @param functionId  (required)
     * @return BaseResponseBlockCommentsOverviewGenerationResponse
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public BaseResponseBlockCommentsOverviewGenerationResponse generateOverviewCommentForFunction(@javax.annotation.Nonnull Integer functionId) throws ApiException {
        ApiResponse<BaseResponseBlockCommentsOverviewGenerationResponse> localVarResp = generateOverviewCommentForFunctionWithHttpInfo(functionId);
        return localVarResp.getData();
    }

    /**
     * Generate overview comment for a function
     * 
     * @param functionId  (required)
     * @return ApiResponse&lt;BaseResponseBlockCommentsOverviewGenerationResponse&gt;
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public ApiResponse<BaseResponseBlockCommentsOverviewGenerationResponse> generateOverviewCommentForFunctionWithHttpInfo(@javax.annotation.Nonnull Integer functionId) throws ApiException {
        okhttp3.Call localVarCall = generateOverviewCommentForFunctionValidateBeforeCall(functionId, null);
        Type localVarReturnType = new TypeToken<BaseResponseBlockCommentsOverviewGenerationResponse>(){}.getType();
        return localVarApiClient.execute(localVarCall, localVarReturnType);
    }

    /**
     * Generate overview comment for a function (asynchronously)
     * 
     * @param functionId  (required)
     * @param _callback The callback to be executed when the API call finishes
     * @return The request call
     * @throws ApiException If fail to process the API call, e.g. serializing the request body object
     * @http.response.details
     <table border="1">
       <caption>Response Details</caption>
        <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
        <tr><td> 200 </td><td> Successful Response </td><td>  -  </td></tr>
        <tr><td> 422 </td><td> Invalid request parameters </td><td>  -  </td></tr>
     </table>
     */
    public okhttp3.Call generateOverviewCommentForFunctionAsync(@javax.annotation.Nonnull Integer functionId, final ApiCallback<BaseResponseBlockCommentsOverviewGenerationResponse> _callback) throws ApiException {

        okhttp3.Call localVarCall = generateOverviewCommentForFunctionValidateBeforeCall(functionId, _callback);
        Type localVarReturnType = new TypeToken<BaseResponseBlockCommentsOverviewGenerationResponse>(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
}