sibApi

Class ProcessApi

java.lang.Object

sibApi.ProcessApi

public class ProcessApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProcessApi()
ProcessApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
GetProcess	getProcess(Long processId) Return the informations for a process
com.squareup.okhttp.Call	getProcessAsync(Long processId, ApiCallback<GetProcess> callback) Return the informations for a process (asynchronously)
com.squareup.okhttp.Call	getProcessCall(Long processId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getProcess
GetProcesses	getProcesses(Long limit, Long offset, String sort) Return all the processes for your account
com.squareup.okhttp.Call	getProcessesAsync(Long limit, Long offset, String sort, ApiCallback<GetProcesses> callback) Return all the processes for your account (asynchronously)
com.squareup.okhttp.Call	getProcessesCall(Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getProcesses
ApiResponse<GetProcesses>	getProcessesWithHttpInfo(Long limit, Long offset, String sort) Return all the processes for your account
ApiResponse<GetProcess>	getProcessWithHttpInfo(Long processId) Return the informations for a process
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessApi

public ProcessApi()

ProcessApi

public ProcessApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getProcessCall

public com.squareup.okhttp.Call getProcessCall(Long processId,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for getProcess

Parameters:

processId - Id of the process (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getProcess

public GetProcess getProcess(Long processId)
                      throws ApiException

Return the informations for a process

Parameters:

processId - Id of the process (required)

Returns:

GetProcess

Throws:

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

getProcessWithHttpInfo

public ApiResponse<GetProcess> getProcessWithHttpInfo(Long processId)
                                               throws ApiException

Return the informations for a process

Parameters:

processId - Id of the process (required)

Returns:

ApiResponse<GetProcess>

Throws:

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

getProcessAsync

public com.squareup.okhttp.Call getProcessAsync(Long processId,
                                                ApiCallback<GetProcess> callback)
                                         throws ApiException

Return the informations for a process (asynchronously)

Parameters:

processId - Id of the process (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

getProcessesCall

public com.squareup.okhttp.Call getProcessesCall(Long limit,
                                                 Long offset,
                                                 String sort,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for getProcesses

Parameters:

limit - Number limitation for the result returned (optional, default to 10)

offset - Beginning point in the list to retrieve from. (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getProcesses

public GetProcesses getProcesses(Long limit,
                                 Long offset,
                                 String sort)
                          throws ApiException

Return all the processes for your account

Parameters:

limit - Number limitation for the result returned (optional, default to 10)

offset - Beginning point in the list to retrieve from. (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetProcesses

Throws:

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

getProcessesWithHttpInfo

public ApiResponse<GetProcesses> getProcessesWithHttpInfo(Long limit,
                                                          Long offset,
                                                          String sort)
                                                   throws ApiException

Return all the processes for your account

Parameters:

limit - Number limitation for the result returned (optional, default to 10)

offset - Beginning point in the list to retrieve from. (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

ApiResponse<GetProcesses>

Throws:

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

getProcessesAsync

public com.squareup.okhttp.Call getProcessesAsync(Long limit,
                                                  Long offset,
                                                  String sort,
                                                  ApiCallback<GetProcesses> callback)
                                           throws ApiException

Return all the processes for your account (asynchronously)

Parameters:

limit - Number limitation for the result returned (optional, default to 10)

offset - Beginning point in the list to retrieve from. (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

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