Package ai.reveng.api

Class ReportsApi

java.lang.Object

ai.reveng.api.ReportsApi

public class ReportsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ReportsApi()
ReportsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
GeneratePDFOutputBody	createPdfReport(Long analysisId)	Start PDF report generation Starts an asynchronous PDF report generation workflow for the given analysis.
okhttp3.Call	createPdfReportAsync(Long analysisId, ApiCallback<GeneratePDFOutputBody> _callback)	Start PDF report generation (asynchronously) Starts an asynchronous PDF report generation workflow for the given analysis.
okhttp3.Call	createPdfReportCall(Long analysisId, ApiCallback _callback)	Build call for createPdfReport
ApiResponse<GeneratePDFOutputBody>	createPdfReportWithHttpInfo(Long analysisId)	Start PDF report generation Starts an asynchronous PDF report generation workflow for the given analysis.
void	downloadPdfReport(Long analysisId, String taskId)	Download generated PDF report Streams the rendered PDF report.
okhttp3.Call	downloadPdfReportAsync(Long analysisId, String taskId, ApiCallback<Void> _callback)	Download generated PDF report (asynchronously) Streams the rendered PDF report.
okhttp3.Call	downloadPdfReportCall(Long analysisId, String taskId, ApiCallback _callback)	Build call for downloadPdfReport
ApiResponse<Void>	downloadPdfReportWithHttpInfo(Long analysisId, String taskId)	Download generated PDF report Streams the rendered PDF report.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
WorkflowProgress	getPdfReportStatus(Long analysisId, String taskId)	Get PDF report workflow status Returns live workflow progress for the given task.
okhttp3.Call	getPdfReportStatusAsync(Long analysisId, String taskId, ApiCallback<WorkflowProgress> _callback)	Get PDF report workflow status (asynchronously) Returns live workflow progress for the given task.
okhttp3.Call	getPdfReportStatusCall(Long analysisId, String taskId, ApiCallback _callback)	Build call for getPdfReportStatus
ApiResponse<WorkflowProgress>	getPdfReportStatusWithHttpInfo(Long analysisId, String taskId)	Get PDF report workflow status Returns live workflow progress for the given task.
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

ReportsApi

public ReportsApi()

ReportsApi

public ReportsApi(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)

createPdfReportCall

public okhttp3.Call createPdfReportCall(@Nonnull
 Long analysisId,
 ApiCallback _callback)
                                 throws ApiException

Build call for createPdfReport

Parameters:

analysisId - Analysis ID (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
202	Accepted	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

createPdfReport

public GeneratePDFOutputBody createPdfReport(@Nonnull
 Long analysisId)
                                      throws ApiException

Start PDF report generation Starts an asynchronous PDF report generation workflow for the given analysis. Returns a deterministic task_id used to poll status and download the resulting PDF. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `409` [`ANALYSIS_NOT_READY`](/errors/ANALYSIS_NOT_READY) — Analysis Not Ready

Parameters:

analysisId - Analysis ID (required)

Returns:

GeneratePDFOutputBody

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
202	Accepted	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

createPdfReportWithHttpInfo

public ApiResponse<GeneratePDFOutputBody> createPdfReportWithHttpInfo(@Nonnull
 Long analysisId)
                                                               throws ApiException

Start PDF report generation Starts an asynchronous PDF report generation workflow for the given analysis. Returns a deterministic task_id used to poll status and download the resulting PDF. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `409` [`ANALYSIS_NOT_READY`](/errors/ANALYSIS_NOT_READY) — Analysis Not Ready

Parameters:

analysisId - Analysis ID (required)

Returns:

ApiResponse<GeneratePDFOutputBody>

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
202	Accepted	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

createPdfReportAsync

public okhttp3.Call createPdfReportAsync(@Nonnull
 Long analysisId,
 ApiCallback<GeneratePDFOutputBody> _callback)
                                  throws ApiException

Start PDF report generation (asynchronously) Starts an asynchronous PDF report generation workflow for the given analysis. Returns a deterministic task_id used to poll status and download the resulting PDF. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `409` [`ANALYSIS_NOT_READY`](/errors/ANALYSIS_NOT_READY) — Analysis Not Ready

Parameters:

analysisId - Analysis ID (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
202	Accepted	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

downloadPdfReportCall

public okhttp3.Call downloadPdfReportCall(@Nonnull
 Long analysisId,
 @Nonnull
 String taskId,
 ApiCallback _callback)
                                   throws ApiException

Build call for downloadPdfReport

Parameters:

analysisId - Analysis ID (required)

taskId - Task ID returned by the create endpoint (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	OK	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

downloadPdfReport

public void downloadPdfReport(@Nonnull
 Long analysisId,
 @Nonnull
 String taskId)
                       throws ApiException

Download generated PDF report Streams the rendered PDF report. Returns 409 when the workflow is still running and 404 when the task does not exist or the caller is not authorised to see it. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `409` [`ANALYSIS_NOT_READY`](/errors/ANALYSIS_NOT_READY) — Analysis Not Ready - `500` [`REPORT_RENDER_FAILED`](/errors/REPORT_RENDER_FAILED) — Report Render Failed

Parameters:

analysisId - Analysis ID (required)

taskId - Task ID returned by the create endpoint (required)

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	OK	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

downloadPdfReportWithHttpInfo

public ApiResponse<Void> downloadPdfReportWithHttpInfo(@Nonnull
 Long analysisId,
 @Nonnull
 String taskId)
                                                throws ApiException

Download generated PDF report Streams the rendered PDF report. Returns 409 when the workflow is still running and 404 when the task does not exist or the caller is not authorised to see it. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `409` [`ANALYSIS_NOT_READY`](/errors/ANALYSIS_NOT_READY) — Analysis Not Ready - `500` [`REPORT_RENDER_FAILED`](/errors/REPORT_RENDER_FAILED) — Report Render Failed

Parameters:

analysisId - Analysis ID (required)

taskId - Task ID returned by the create endpoint (required)

Returns:

ApiResponse<Void>

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	OK	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

downloadPdfReportAsync

public okhttp3.Call downloadPdfReportAsync(@Nonnull
 Long analysisId,
 @Nonnull
 String taskId,
 ApiCallback<Void> _callback)
                                    throws ApiException

Download generated PDF report (asynchronously) Streams the rendered PDF report. Returns 409 when the workflow is still running and 404 when the task does not exist or the caller is not authorised to see it. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `409` [`ANALYSIS_NOT_READY`](/errors/ANALYSIS_NOT_READY) — Analysis Not Ready - `500` [`REPORT_RENDER_FAILED`](/errors/REPORT_RENDER_FAILED) — Report Render Failed

Parameters:

analysisId - Analysis ID (required)

taskId - Task ID returned by the create 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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-

getPdfReportStatusCall

public okhttp3.Call getPdfReportStatusCall(@Nonnull
 Long analysisId,
 @Nonnull
 String taskId,
 ApiCallback _callback)
                                    throws ApiException

Build call for getPdfReportStatus

Parameters:

analysisId - Analysis ID (required)

taskId - Task ID returned by the create endpoint (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	OK	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
500	Internal Server Error	-

getPdfReportStatus

public WorkflowProgress getPdfReportStatus(@Nonnull
 Long analysisId,
 @Nonnull
 String taskId)
                                    throws ApiException

Get PDF report workflow status Returns live workflow progress for the given task. Returns 404 when the task does not exist or the caller is not authorised to see it. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found

Parameters:

analysisId - Analysis ID (required)

taskId - Task ID returned by the create endpoint (required)

Returns:

WorkflowProgress

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	OK	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
500	Internal Server Error	-

getPdfReportStatusWithHttpInfo

public ApiResponse<WorkflowProgress> getPdfReportStatusWithHttpInfo(@Nonnull
 Long analysisId,
 @Nonnull
 String taskId)
                                                             throws ApiException

Get PDF report workflow status Returns live workflow progress for the given task. Returns 404 when the task does not exist or the caller is not authorised to see it. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found

Parameters:

analysisId - Analysis ID (required)

taskId - Task ID returned by the create endpoint (required)

Returns:

ApiResponse<WorkflowProgress>

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	OK	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
500	Internal Server Error	-

getPdfReportStatusAsync

public okhttp3.Call getPdfReportStatusAsync(@Nonnull
 Long analysisId,
 @Nonnull
 String taskId,
 ApiCallback<WorkflowProgress> _callback)
                                     throws ApiException

Get PDF report workflow status (asynchronously) Returns live workflow progress for the given task. Returns 404 when the task does not exist or the caller is not authorised to see it. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found

Parameters:

analysisId - Analysis ID (required)

taskId - Task ID returned by the create 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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
500	Internal Server Error	-