Package software.xdev.brevo.api

Class ProcessApi

java.lang.Object

software.xdev.brevo.api.ProcessApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class ProcessApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ProcessApi()
ProcessApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
GetProcess	getProcess(Long processId)	Return the informations for a process
GetProcess	getProcess(Long processId, Map<String,String> additionalHeaders)	Return the informations for a process
GetProcesses	getProcesses(Long limit, Long offset, String sort)	Return all the processes for your account
GetProcesses	getProcesses(Long limit, Long offset, String sort, Map<String,String> additionalHeaders)	Return all the processes for your account
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessApi

public ProcessApi()

ProcessApi

public ProcessApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

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 fails to make API call

getProcess

public GetProcess getProcess(Long processId,
 Map<String,String> additionalHeaders)
                      throws ApiException

Return the informations for a process

Parameters:

processId - Id of the process (required)

additionalHeaders - additionalHeaders for this call

Returns:

GetProcess

Throws:

ApiException - if fails to make API call

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 fails to make API call

getProcesses

public GetProcesses getProcesses(Long limit,
 Long offset,
 String sort,
 Map<String,String> additionalHeaders)
                          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)

additionalHeaders - additionalHeaders for this call

Returns:

GetProcesses

Throws:

ApiException - if fails to make API call