Package software.xdev.brevo.api

Class EventApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.EventApi

public class EventApi
extends BaseApi

Field Summary

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

apiClient

Constructor Summary

Constructors

Constructor	Description
EventApi()
EventApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	createEvent(Event event)	Create an event Create an event to track a contact's interaction.
void	createEvent(Event event, Map<String,String> additionalHeaders)	Create an event Create an event to track a contact's interaction.
<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

EventApi

public EventApi()

EventApi

public EventApi(ApiClient apiClient)

Method Details

createEvent

public void createEvent(@Nonnull
 Event event)
                 throws ApiException

Create an event Create an event to track a contact's interaction.

Parameters:

event - (required)

Throws:

ApiException - if fails to make API call

createEvent

public void createEvent(@Nonnull
 Event event,
 Map<String,String> additionalHeaders)
                 throws ApiException

Create an event Create an event to track a contact's interaction.

Parameters:

event - (required)

additionalHeaders - additionalHeaders for this call

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.