Package software.xdev.brevo.api

Class AccountApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.AccountApi

public class AccountApi
extends BaseApi

Field Summary

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

apiClient

Constructor Summary

Constructors

Constructor	Description
AccountApi()
AccountApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
GetAccount	getAccount()	Get your account information, plan and credits details
GetAccount	getAccount(Map<String,String> additionalHeaders)	Get your account information, plan and credits details
GetAccountActivity	getAccountActivity(String startDate, String endDate, String email, Long limit, Long offset)	Get user activity logs
GetAccountActivity	getAccountActivity(String startDate, String endDate, String email, Long limit, Long offset, Map<String,String> additionalHeaders)	Get user activity logs
<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

AccountApi

public AccountApi()

AccountApi

public AccountApi(ApiClient apiClient)

Method Details

getAccount

public GetAccount getAccount()
                      throws ApiException

Get your account information, plan and credits details

Returns:

GetAccount

Throws:

ApiException - if fails to make API call

getAccount

public GetAccount getAccount(Map<String,String> additionalHeaders)
                      throws ApiException

Get your account information, plan and credits details

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

GetAccount

Throws:

ApiException - if fails to make API call

getAccountActivity

public GetAccountActivity getAccountActivity(@Nullable
 String startDate,
 @Nullable
 String endDate,
 @Nullable
 String email,
 @Nullable
 Long limit,
 @Nullable
 Long offset)
                                      throws ApiException

Get user activity logs

Parameters:

startDate - Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional)

endDate - Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional)

email - Enter the user's email address to filter their activity in the account. (optional)

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document in the page. (optional, default to 0)

Returns:

GetAccountActivity

Throws:

ApiException - if fails to make API call

getAccountActivity

public GetAccountActivity getAccountActivity(@Nullable
 String startDate,
 @Nullable
 String endDate,
 @Nullable
 String email,
 @Nullable
 Long limit,
 @Nullable
 Long offset,
 Map<String,String> additionalHeaders)
                                      throws ApiException

Get user activity logs

Parameters:

startDate - Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional)

endDate - Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional)

email - Enter the user's email address to filter their activity in the account. (optional)

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document in the page. (optional, default to 0)

additionalHeaders - additionalHeaders for this call

Returns:

GetAccountActivity

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.