Package software.xdev.brevo.api

Class AccountApi

java.lang.Object

software.xdev.brevo.api.AccountApi

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

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, Long limit, Long offset)	Get user activity logs
GetAccountActivity	getAccountActivity(String startDate, String endDate, Long limit, Long offset, Map<String,String> additionalHeaders)	Get user activity logs
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

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

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

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(String startDate,
 String endDate,
 Long limit,
 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)

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(String startDate,
 String endDate,
 Long limit,
 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)

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