Package software.xdev.brevo.api

Class ProcessApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.ProcessApi

public class ProcessApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.brevo.client.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
ProcessApi()
ProcessApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
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
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.

Methods inherited from class software.xdev.brevo.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

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

getProcess

public GetProcess getProcess(@Nonnull
 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(@Nonnull
 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(@Nullable
 Long limit,
 @Nullable
 Long offset,
 @Nullable
 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(@Nullable
 Long limit,
 @Nullable
 Long offset,
 @Nullable
 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

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.