com.codedx.client.api

Class ActionsApi

java.lang.Object

com.codedx.client.api.ActionsApi

public class ActionsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ActionsApi()
ActionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	clearSeverityOverride(java.lang.Integer findingId) Severity Override [Clear] Allows severity overrides for findings to be cleared.
com.squareup.okhttp.Call	clearSeverityOverrideAsync(java.lang.Integer findingId, ApiCallback<java.lang.Void> callback) Severity Override [Clear] (asynchronously) Allows severity overrides for findings to be cleared.
com.squareup.okhttp.Call	clearSeverityOverrideCall(java.lang.Integer findingId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for clearSeverityOverride
ApiResponse<java.lang.Void>	clearSeverityOverrideWithHttpInfo(java.lang.Integer findingId) Severity Override [Clear] Allows severity overrides for findings to be cleared.
ApiClient	getApiClient()
void	overrideSeverity(java.lang.Integer findingId, SeverityOverride severity) Severity Override [Set] Allows severities for findings to be overridden.
com.squareup.okhttp.Call	overrideSeverityAsync(java.lang.Integer findingId, SeverityOverride severity, ApiCallback<java.lang.Void> callback) Severity Override [Set] (asynchronously) Allows severities for findings to be overridden.
com.squareup.okhttp.Call	overrideSeverityCall(java.lang.Integer findingId, SeverityOverride severity, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for overrideSeverity
ApiResponse<java.lang.Void>	overrideSeverityWithHttpInfo(java.lang.Integer findingId, SeverityOverride severity) Severity Override [Set] Allows severities for findings to be overridden.
void	postComment(java.lang.Integer findingId, PostComment content) Post Comment Post a new comment on a finding
com.squareup.okhttp.Call	postCommentAsync(java.lang.Integer findingId, PostComment content, ApiCallback<java.lang.Void> callback) Post Comment (asynchronously) Post a new comment on a finding
com.squareup.okhttp.Call	postCommentCall(java.lang.Integer findingId, PostComment content, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postComment
ApiResponse<java.lang.Void>	postCommentWithHttpInfo(java.lang.Integer findingId, PostComment content) Post Comment Post a new comment on a finding
void	setApiClient(ApiClient apiClient)
Job	setBulkStatus(java.lang.Integer projectId, SetStatusBulk bulkStatusUpdate) Bulk Status Update Allows bulk updating of triage statuses of multiple findings, controlled by a filter.
com.squareup.okhttp.Call	setBulkStatusAsync(java.lang.Integer projectId, SetStatusBulk bulkStatusUpdate, ApiCallback<Job> callback) Bulk Status Update (asynchronously) Allows bulk updating of triage statuses of multiple findings, controlled by a filter.
com.squareup.okhttp.Call	setBulkStatusCall(java.lang.Integer projectId, SetStatusBulk bulkStatusUpdate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for setBulkStatus
ApiResponse<Job>	setBulkStatusWithHttpInfo(java.lang.Integer projectId, SetStatusBulk bulkStatusUpdate) Bulk Status Update Allows bulk updating of triage statuses of multiple findings, controlled by a filter.
void	setStatus(java.lang.Integer findingId, SetStatus status) Status Update Allows changing of the triage status of a single finding.
com.squareup.okhttp.Call	setStatusAsync(java.lang.Integer findingId, SetStatus status, ApiCallback<java.lang.Void> callback) Status Update (asynchronously) Allows changing of the triage status of a single finding.
com.squareup.okhttp.Call	setStatusCall(java.lang.Integer findingId, SetStatus status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for setStatus
ApiResponse<java.lang.Void>	setStatusWithHttpInfo(java.lang.Integer findingId, SetStatus status) Status Update Allows changing of the triage status of a single finding.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionsApi

public ActionsApi()

ActionsApi

public ActionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

clearSeverityOverrideCall

public com.squareup.okhttp.Call clearSeverityOverrideCall(java.lang.Integer findingId,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for clearSeverityOverride

Parameters:

findingId - The finding ID. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

clearSeverityOverride

public void clearSeverityOverride(java.lang.Integer findingId)
                           throws ApiException

Severity Override [Clear] Allows severity overrides for findings to be cleared.

Parameters:

findingId - The finding ID. (required)

Throws:

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

clearSeverityOverrideWithHttpInfo

public ApiResponse<java.lang.Void> clearSeverityOverrideWithHttpInfo(java.lang.Integer findingId)
                                                              throws ApiException

Severity Override [Clear] Allows severity overrides for findings to be cleared.

Parameters:

findingId - The finding ID. (required)

Returns:

ApiResponse<Void>

Throws:

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

clearSeverityOverrideAsync

public com.squareup.okhttp.Call clearSeverityOverrideAsync(java.lang.Integer findingId,
                                                           ApiCallback<java.lang.Void> callback)
                                                    throws ApiException

Severity Override [Clear] (asynchronously) Allows severity overrides for findings to be cleared.

Parameters:

findingId - The finding 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

overrideSeverityCall

public com.squareup.okhttp.Call overrideSeverityCall(java.lang.Integer findingId,
                                                     SeverityOverride severity,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for overrideSeverity

Parameters:

findingId - The finding ID. (required)

severity - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

overrideSeverity

public void overrideSeverity(java.lang.Integer findingId,
                             SeverityOverride severity)
                      throws ApiException

Severity Override [Set] Allows severities for findings to be overridden.

Parameters:

findingId - The finding ID. (required)

severity - (optional)

Throws:

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

overrideSeverityWithHttpInfo

public ApiResponse<java.lang.Void> overrideSeverityWithHttpInfo(java.lang.Integer findingId,
                                                                SeverityOverride severity)
                                                         throws ApiException

Severity Override [Set] Allows severities for findings to be overridden.

Parameters:

findingId - The finding ID. (required)

severity - (optional)

Returns:

ApiResponse<Void>

Throws:

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

overrideSeverityAsync

public com.squareup.okhttp.Call overrideSeverityAsync(java.lang.Integer findingId,
                                                      SeverityOverride severity,
                                                      ApiCallback<java.lang.Void> callback)
                                               throws ApiException

Severity Override [Set] (asynchronously) Allows severities for findings to be overridden.

Parameters:

findingId - The finding ID. (required)

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

postCommentCall

public com.squareup.okhttp.Call postCommentCall(java.lang.Integer findingId,
                                                PostComment content,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for postComment

Parameters:

findingId - The finding ID. (required)

content - `content` should be a string containing the raw markdown content of the new comment (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postComment

public void postComment(java.lang.Integer findingId,
                        PostComment content)
                 throws ApiException

Post Comment Post a new comment on a finding

Parameters:

findingId - The finding ID. (required)

content - `content` should be a string containing the raw markdown content of the new comment (required)

Throws:

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

postCommentWithHttpInfo

public ApiResponse<java.lang.Void> postCommentWithHttpInfo(java.lang.Integer findingId,
                                                           PostComment content)
                                                    throws ApiException

Post Comment Post a new comment on a finding

Parameters:

findingId - The finding ID. (required)

content - `content` should be a string containing the raw markdown content of the new comment (required)

Returns:

ApiResponse<Void>

Throws:

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

postCommentAsync

public com.squareup.okhttp.Call postCommentAsync(java.lang.Integer findingId,
                                                 PostComment content,
                                                 ApiCallback<java.lang.Void> callback)
                                          throws ApiException

Post Comment (asynchronously) Post a new comment on a finding

Parameters:

findingId - The finding ID. (required)

content - `content` should be a string containing the raw markdown content of the new comment (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

setBulkStatusCall

public com.squareup.okhttp.Call setBulkStatusCall(java.lang.Integer projectId,
                                                  SetStatusBulk bulkStatusUpdate,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for setBulkStatus

Parameters:

projectId - The ID of the project. (required)

bulkStatusUpdate - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

setBulkStatus

public Job setBulkStatus(java.lang.Integer projectId,
                         SetStatusBulk bulkStatusUpdate)
                  throws ApiException

Bulk Status Update Allows bulk updating of triage statuses of multiple findings, controlled by a filter. Detailed information regarding statuses can be obtained from the [Project Statuses](#/Projects/getStatuses) endpoint.

Parameters:

projectId - The ID of the project. (required)

bulkStatusUpdate - (optional)

Returns:

Job

Throws:

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

setBulkStatusWithHttpInfo

public ApiResponse<Job> setBulkStatusWithHttpInfo(java.lang.Integer projectId,
                                                  SetStatusBulk bulkStatusUpdate)
                                           throws ApiException

Bulk Status Update Allows bulk updating of triage statuses of multiple findings, controlled by a filter. Detailed information regarding statuses can be obtained from the [Project Statuses](#/Projects/getStatuses) endpoint.

Parameters:

projectId - The ID of the project. (required)

bulkStatusUpdate - (optional)

Returns:

ApiResponse<Job>

Throws:

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

setBulkStatusAsync

public com.squareup.okhttp.Call setBulkStatusAsync(java.lang.Integer projectId,
                                                   SetStatusBulk bulkStatusUpdate,
                                                   ApiCallback<Job> callback)
                                            throws ApiException

Bulk Status Update (asynchronously) Allows bulk updating of triage statuses of multiple findings, controlled by a filter. Detailed information regarding statuses can be obtained from the [Project Statuses](#/Projects/getStatuses) endpoint.

Parameters:

projectId - The ID of the project. (required)

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

setStatusCall

public com.squareup.okhttp.Call setStatusCall(java.lang.Integer findingId,
                                              SetStatus status,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException

Build call for setStatus

Parameters:

findingId - The finding ID. (required)

status - `status` should be a valid status ID (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

setStatus

public void setStatus(java.lang.Integer findingId,
                      SetStatus status)
               throws ApiException

Status Update Allows changing of the triage status of a single finding. Detailed information regarding statuses can be obtained from the [Project Statuses](#/Projects/getStatuses) endpoint.

Parameters:

findingId - The finding ID. (required)

status - `status` should be a valid status ID (required)

Throws:

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

setStatusWithHttpInfo

public ApiResponse<java.lang.Void> setStatusWithHttpInfo(java.lang.Integer findingId,
                                                         SetStatus status)
                                                  throws ApiException

Status Update Allows changing of the triage status of a single finding. Detailed information regarding statuses can be obtained from the [Project Statuses](#/Projects/getStatuses) endpoint.

Parameters:

findingId - The finding ID. (required)

status - `status` should be a valid status ID (required)

Returns:

ApiResponse<Void>

Throws:

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

setStatusAsync

public com.squareup.okhttp.Call setStatusAsync(java.lang.Integer findingId,
                                               SetStatus status,
                                               ApiCallback<java.lang.Void> callback)
                                        throws ApiException

Status Update (asynchronously) Allows changing of the triage status of a single finding. Detailed information regarding statuses can be obtained from the [Project Statuses](#/Projects/getStatuses) endpoint.

Parameters:

findingId - The finding ID. (required)

status - `status` should be a valid status 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